blob: 5300126c36658b3be27affab8bd2fa25efbcdb89 [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 Everett3d8118d2024-01-30 16:58:47 +00001682#if defined(MBEDTLS_THREADING_C)
1683 PSA_THREADING_CHK_RET(mbedtls_mutex_lock(
1684 &mbedtls_threading_key_slot_mutex));
1685#endif
Ryan Everettb69118e2024-01-02 15:54:32 +00001686 status = psa_reserve_free_key_slot(&volatile_key_id, p_slot);
Ryan Everett3d8118d2024-01-30 16:58:47 +00001687#if defined(MBEDTLS_THREADING_C)
1688 PSA_THREADING_CHK_RET(mbedtls_mutex_unlock(
1689 &mbedtls_threading_key_slot_mutex));
1690#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001691 if (status != PSA_SUCCESS) {
1692 return status;
1693 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001694 slot = *p_slot;
1695
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001696 /* We're storing the declared bit-size of the key. It's up to each
1697 * creation mechanism to verify that this information is correct.
1698 * It's automatically correct for mechanisms that use the bit-size as
Gilles Peskineb46bef22019-07-30 21:32:04 +02001699 * an input (generate, device) but not for those where the bit-size
Ronald Cronc4d1b512020-07-31 11:26:37 +02001700 * is optional (import, copy). In case of a volatile key, assign it the
1701 * volatile key identifier associated to the slot returned to contain its
1702 * definition. */
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001703
1704 slot->attr = attributes->core;
Gilles Peskine449bd832023-01-11 14:50:10 +01001705 if (PSA_KEY_LIFETIME_IS_VOLATILE(slot->attr.lifetime)) {
Ronald Cronc4d1b512020-07-31 11:26:37 +02001706#if !defined(MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER)
1707 slot->attr.id = volatile_key_id;
1708#else
1709 slot->attr.id.key_id = volatile_key_id;
1710#endif
1711 }
Gilles Peskinec744d992019-07-30 17:26:54 +02001712
Gilles Peskine91e8c332019-08-02 19:19:39 +02001713 /* Erase external-only flags from the internal copy. To access
Gilles Peskine013f5472019-08-07 15:42:14 +02001714 * external-only flags, query `attributes`. Thanks to the check
1715 * in psa_validate_key_attributes(), this leaves the dual-use
Ryan Everettb69118e2024-01-02 15:54:32 +00001716 * flags and any internal flag that psa_reserve_free_key_slot()
Gilles Peskine013f5472019-08-07 15:42:14 +02001717 * may have set. */
1718 slot->attr.flags &= ~MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY;
Gilles Peskine91e8c332019-08-02 19:19:39 +02001719
Gilles Peskinecbaff462019-07-12 23:46:04 +02001720#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001721 /* For a key in a secure element, we need to do three things
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001722 * when creating or registering a persistent key:
Gilles Peskine60450a42019-07-25 11:32:45 +02001723 * create the key file in internal storage, create the
1724 * key inside the secure element, and update the driver's
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001725 * persistent data. This is done by starting a transaction that will
1726 * encompass these three actions.
1727 * For registering a volatile key, we just need to find an appropriate
1728 * slot number inside the SE. Since the key is designated volatile, creating
1729 * a transaction is not required. */
Gilles Peskine60450a42019-07-25 11:32:45 +02001730 /* The first thing to do is to find a slot number for the new key.
1731 * We save the slot number in persistent storage as part of the
1732 * transaction data. It will be needed to recover if the power
1733 * fails during the key creation process, to clean up on the secure
1734 * element side after restarting. Obtaining a slot number from the
1735 * secure element driver updates its persistent state, but we do not yet
1736 * save the driver's persistent state, so that if the power fails,
Gilles Peskinefc762652019-07-22 19:30:34 +02001737 * we can roll back to a state where the key doesn't exist. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001738 if (*p_drv != NULL) {
Ronald Cronea0f8a62020-11-25 17:52:23 +01001739 psa_key_slot_number_t slot_number;
Gilles Peskine449bd832023-01-11 14:50:10 +01001740 status = psa_find_se_slot_for_key(attributes, method, *p_drv,
1741 &slot_number);
1742 if (status != PSA_SUCCESS) {
1743 return status;
1744 }
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001745
Gilles Peskine449bd832023-01-11 14:50:10 +01001746 if (!PSA_KEY_LIFETIME_IS_VOLATILE(attributes->core.lifetime)) {
1747 psa_crypto_prepare_transaction(PSA_CRYPTO_TRANSACTION_CREATE_KEY);
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001748 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001749 psa_crypto_transaction.key.slot = slot_number;
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001750 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskine449bd832023-01-11 14:50:10 +01001751 status = psa_crypto_save_transaction();
1752 if (status != PSA_SUCCESS) {
1753 (void) psa_crypto_stop_transaction();
1754 return status;
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001755 }
Gilles Peskine66be51c2019-07-25 18:02:52 +02001756 }
Ronald Cronea0f8a62020-11-25 17:52:23 +01001757
1758 status = psa_copy_key_material_into_slot(
Gilles Peskine449bd832023-01-11 14:50:10 +01001759 slot, (uint8_t *) (&slot_number), sizeof(slot_number));
Darryl Green0c6575a2018-11-07 16:05:30 +00001760 }
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001761
Gilles Peskine449bd832023-01-11 14:50:10 +01001762 if (*p_drv == NULL && method == PSA_KEY_CREATION_REGISTER) {
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001763 /* Key registration only makes sense with a secure element. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001764 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001765 }
Gilles Peskinecbaff462019-07-12 23:46:04 +02001766#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1767
Gilles Peskine449bd832023-01-11 14:50:10 +01001768 return PSA_SUCCESS;
Darryl Green0c6575a2018-11-07 16:05:30 +00001769}
Gilles Peskine4747d192019-04-17 15:05:45 +02001770
1771/** Finalize the creation of a key once its key material has been set.
1772 *
1773 * This entails writing the key to persistent storage.
1774 *
1775 * If this function fails, call psa_fail_key_creation().
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001776 * See the documentation of psa_start_key_creation() for the intended use
1777 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001778 *
Ryan Everettb69118e2024-01-02 15:54:32 +00001779 * If the finalization succeeds, the function sets the key slot's state to
1780 * PSA_SLOT_FULL, and the key slot can no longer be accessed as part of the
1781 * key creation process.
Ronald Cron50972942020-11-14 11:28:25 +01001782 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001783 * \param[in,out] slot Pointer to the slot with key material.
1784 * \param[in] driver The secure element driver for the key,
1785 * or NULL for a transparent key.
Ronald Cron81709fc2020-11-14 12:10:32 +01001786 * \param[out] key On success, identifier of the key. Note that the
1787 * key identifier is also stored in the key slot.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001788 *
1789 * \retval #PSA_SUCCESS
Ronald Croncf56a0a2020-08-04 09:51:30 +02001790 * The key was successfully created.
Gilles Peskineed733552023-02-14 19:21:09 +01001791 * \retval #PSA_ERROR_INSUFFICIENT_MEMORY \emptydescription
1792 * \retval #PSA_ERROR_INSUFFICIENT_STORAGE \emptydescription
1793 * \retval #PSA_ERROR_ALREADY_EXISTS \emptydescription
1794 * \retval #PSA_ERROR_DATA_INVALID \emptydescription
1795 * \retval #PSA_ERROR_DATA_CORRUPT \emptydescription
1796 * \retval #PSA_ERROR_STORAGE_FAILURE \emptydescription
gabor-mezei-arm452b0a32020-11-09 17:42:55 +01001797 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001798 * \return If this function fails, the key slot is an invalid state.
1799 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001800 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001801static psa_status_t psa_finish_key_creation(
1802 psa_key_slot_t *slot,
Ronald Cron81709fc2020-11-14 12:10:32 +01001803 psa_se_drv_table_entry_t *driver,
1804 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02001805{
1806 psa_status_t status = PSA_SUCCESS;
Gilles Peskine30afafd2019-04-25 13:47:40 +02001807 (void) slot;
Gilles Peskine011e4282019-06-26 18:34:38 +02001808 (void) driver;
Gilles Peskine4747d192019-04-17 15:05:45 +02001809
Ryan Everett91ffe5b2024-01-23 20:05:42 +00001810#if defined(MBEDTLS_THREADING_C)
1811 PSA_THREADING_CHK_RET(mbedtls_mutex_lock(
1812 &mbedtls_threading_key_slot_mutex));
1813#endif
1814
Gilles Peskine4747d192019-04-17 15:05:45 +02001815#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001816 if (!PSA_KEY_LIFETIME_IS_VOLATILE(slot->attr.lifetime)) {
Gilles Peskine1df83d42019-07-23 16:13:14 +02001817#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001818 if (driver != NULL) {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001819 psa_se_key_data_storage_t data;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001820 psa_key_slot_number_t slot_number =
Gilles Peskine449bd832023-01-11 14:50:10 +01001821 psa_key_slot_get_slot_number(slot);
Ronald Cronea0f8a62020-11-25 17:52:23 +01001822
Tom Cosgrove6ef9bb32023-03-08 14:19:51 +00001823 MBEDTLS_STATIC_ASSERT(sizeof(slot_number) ==
1824 sizeof(data.slot_number),
1825 "Slot number size does not match psa_se_key_data_storage_t");
1826
Gilles Peskine449bd832023-01-11 14:50:10 +01001827 memcpy(&data.slot_number, &slot_number, sizeof(slot_number));
1828 status = psa_save_persistent_key(&slot->attr,
1829 (uint8_t *) &data,
1830 sizeof(data));
1831 } else
Gilles Peskine1df83d42019-07-23 16:13:14 +02001832#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1833 {
Steven Cooreman40120f62020-10-29 11:42:22 +01001834 /* Key material is saved in export representation in the slot, so
1835 * just pass the slot buffer for storage. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001836 status = psa_save_persistent_key(&slot->attr,
1837 slot->key.data,
1838 slot->key.bytes);
Gilles Peskine1df83d42019-07-23 16:13:14 +02001839 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001840 }
Darryl Green0c6575a2018-11-07 16:05:30 +00001841#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
1842
Gilles Peskinecbaff462019-07-12 23:46:04 +02001843#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001844 /* Finish the transaction for a key creation. This does not
1845 * happen when registering an existing key. Detect this case
1846 * by checking whether a transaction is in progress (actual
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001847 * creation of a persistent key in a secure element requires a transaction,
1848 * but registration or volatile key creation doesn't use one). */
Gilles Peskine449bd832023-01-11 14:50:10 +01001849 if (driver != NULL &&
1850 psa_crypto_transaction.unknown.type == PSA_CRYPTO_TRANSACTION_CREATE_KEY) {
1851 status = psa_save_se_persistent_data(driver);
1852 if (status != PSA_SUCCESS) {
1853 psa_destroy_persistent_key(slot->attr.id);
Ryan Everett91ffe5b2024-01-23 20:05:42 +00001854
1855#if defined(MBEDTLS_THREADING_C)
1856 PSA_THREADING_CHK_RET(mbedtls_mutex_unlock(
1857 &mbedtls_threading_key_slot_mutex));
1858#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001859 return status;
Gilles Peskinecbaff462019-07-12 23:46:04 +02001860 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001861 status = psa_crypto_stop_transaction();
Gilles Peskinecbaff462019-07-12 23:46:04 +02001862 }
1863#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1864
Gilles Peskine449bd832023-01-11 14:50:10 +01001865 if (status == PSA_SUCCESS) {
Ronald Cron81709fc2020-11-14 12:10:32 +01001866 *key = slot->attr.id;
Ryan Everettb69118e2024-01-02 15:54:32 +00001867 status = psa_key_slot_state_transition(slot, PSA_SLOT_FILLING,
1868 PSA_SLOT_FULL);
Gilles Peskine449bd832023-01-11 14:50:10 +01001869 if (status != PSA_SUCCESS) {
Ronald Cron81709fc2020-11-14 12:10:32 +01001870 *key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01001871 }
Ronald Cron81709fc2020-11-14 12:10:32 +01001872 }
Ronald Cron50972942020-11-14 11:28:25 +01001873
Ryan Everett91ffe5b2024-01-23 20:05:42 +00001874#if defined(MBEDTLS_THREADING_C)
1875 PSA_THREADING_CHK_RET(mbedtls_mutex_unlock(
1876 &mbedtls_threading_key_slot_mutex));
1877#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001878 return status;
Gilles Peskine4747d192019-04-17 15:05:45 +02001879}
1880
1881/** Abort the creation of a key.
1882 *
1883 * You may call this function after calling psa_start_key_creation(),
1884 * or after psa_finish_key_creation() fails. In other circumstances, this
1885 * function may not clean up persistent storage.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001886 * See the documentation of psa_start_key_creation() for the intended use
Ryan Everettb69118e2024-01-02 15:54:32 +00001887 * of this function. Sets the slot's state to PSA_SLOT_EMPTY.
Gilles Peskine4747d192019-04-17 15:05:45 +02001888 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001889 * \param[in,out] slot Pointer to the slot with key material.
1890 * \param[in] driver The secure element driver for the key,
1891 * or NULL for a transparent key.
Gilles Peskine4747d192019-04-17 15:05:45 +02001892 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001893static void psa_fail_key_creation(psa_key_slot_t *slot,
1894 psa_se_drv_table_entry_t *driver)
Gilles Peskine4747d192019-04-17 15:05:45 +02001895{
Gilles Peskine011e4282019-06-26 18:34:38 +02001896 (void) driver;
1897
Gilles Peskine449bd832023-01-11 14:50:10 +01001898 if (slot == NULL) {
Gilles Peskine4747d192019-04-17 15:05:45 +02001899 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01001900 }
Gilles Peskine011e4282019-06-26 18:34:38 +02001901
Ryan Everettb7101442024-01-23 20:09:49 +00001902#if defined(MBEDTLS_THREADING_C)
1903 mbedtls_mutex_lock(&mbedtls_threading_key_slot_mutex);
1904#endif
1905
Gilles Peskine011e4282019-06-26 18:34:38 +02001906#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001907 /* TODO: If the key has already been created in the secure
Gilles Peskine011e4282019-06-26 18:34:38 +02001908 * element, and the failure happened later (when saving metadata
1909 * to internal storage), we need to destroy the key in the secure
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001910 * element.
1911 * https://github.com/ARMmbed/mbed-crypto/issues/217
1912 */
Gilles Peskinefc762652019-07-22 19:30:34 +02001913
Gilles Peskined7729582019-08-05 15:55:54 +02001914 /* Abort the ongoing transaction if any (there may not be one if
1915 * the creation process failed before starting one, or if the
1916 * key creation is a registration of a key in a secure element).
1917 * Earlier functions must already have done what it takes to undo any
1918 * partial creation. All that's left is to update the transaction data
1919 * itself. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001920 (void) psa_crypto_stop_transaction();
Gilles Peskine011e4282019-06-26 18:34:38 +02001921#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1922
Gilles Peskine449bd832023-01-11 14:50:10 +01001923 psa_wipe_key_slot(slot);
Ryan Everettb7101442024-01-23 20:09:49 +00001924
1925#if defined(MBEDTLS_THREADING_C)
1926 mbedtls_mutex_unlock(&mbedtls_threading_key_slot_mutex);
1927#endif
Gilles Peskine4747d192019-04-17 15:05:45 +02001928}
1929
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001930/** Validate optional attributes during key creation.
1931 *
1932 * Some key attributes are optional during key creation. If they are
1933 * specified in the attributes structure, check that they are consistent
1934 * with the data in the slot.
1935 *
1936 * This function should be called near the end of key creation, after
1937 * the slot in memory is fully populated but before saving persistent data.
1938 */
1939static psa_status_t psa_validate_optional_attributes(
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001940 const psa_key_slot_t *slot,
Gilles Peskine449bd832023-01-11 14:50:10 +01001941 const psa_key_attributes_t *attributes)
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001942{
Gilles Peskine449bd832023-01-11 14:50:10 +01001943 if (attributes->core.type != 0) {
1944 if (attributes->core.type != slot->attr.type) {
1945 return PSA_ERROR_INVALID_ARGUMENT;
1946 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001947 }
1948
Gilles Peskine449bd832023-01-11 14:50:10 +01001949 if (attributes->domain_parameters_size != 0) {
Valerio Settib2bcedb2023-07-10 11:24:00 +02001950#if (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) && \
1951 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01001952 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
1953 if (PSA_KEY_TYPE_IS_RSA(slot->attr.type)) {
Steven Cooremana2371e52020-07-28 14:30:39 +02001954 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman75b74362020-07-28 14:30:13 +02001955 mbedtls_mpi actual, required;
Steven Cooreman6d839f02020-07-30 11:36:45 +02001956 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooremana01795d2020-07-24 22:48:15 +02001957
Ronald Cron90857082020-11-25 14:58:33 +01001958 psa_status_t status = mbedtls_psa_rsa_load_representation(
Gilles Peskine449bd832023-01-11 14:50:10 +01001959 slot->attr.type,
1960 slot->key.data,
1961 slot->key.bytes,
1962 &rsa);
1963 if (status != PSA_SUCCESS) {
1964 return status;
1965 }
Steven Cooreman75b74362020-07-28 14:30:13 +02001966
Gilles Peskine449bd832023-01-11 14:50:10 +01001967 mbedtls_mpi_init(&actual);
1968 mbedtls_mpi_init(&required);
1969 ret = mbedtls_rsa_export(rsa,
1970 NULL, NULL, NULL, NULL, &actual);
1971 mbedtls_rsa_free(rsa);
1972 mbedtls_free(rsa);
1973 if (ret != 0) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001974 goto rsa_exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001975 }
1976 ret = mbedtls_mpi_read_binary(&required,
1977 attributes->domain_parameters,
1978 attributes->domain_parameters_size);
1979 if (ret != 0) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001980 goto rsa_exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001981 }
1982 if (mbedtls_mpi_cmp_mpi(&actual, &required) != 0) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001983 ret = MBEDTLS_ERR_RSA_BAD_INPUT_DATA;
Gilles Peskine449bd832023-01-11 14:50:10 +01001984 }
1985rsa_exit:
1986 mbedtls_mpi_free(&actual);
1987 mbedtls_mpi_free(&required);
1988 if (ret != 0) {
1989 return mbedtls_to_psa_error(ret);
1990 }
1991 } else
Valerio Settib2bcedb2023-07-10 11:24:00 +02001992#endif /* (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) &&
1993 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) ||
John Durkop9814fa22020-11-04 12:28:15 -08001994 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001995 {
Gilles Peskine449bd832023-01-11 14:50:10 +01001996 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001997 }
1998 }
1999
Gilles Peskine449bd832023-01-11 14:50:10 +01002000 if (attributes->core.bits != 0) {
2001 if (attributes->core.bits != slot->attr.bits) {
2002 return PSA_ERROR_INVALID_ARGUMENT;
2003 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002004 }
2005
Gilles Peskine449bd832023-01-11 14:50:10 +01002006 return PSA_SUCCESS;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002007}
2008
Gilles Peskine449bd832023-01-11 14:50:10 +01002009psa_status_t psa_import_key(const psa_key_attributes_t *attributes,
2010 const uint8_t *data,
2011 size_t data_length,
2012 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02002013{
2014 psa_status_t status;
2015 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002016 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002017 size_t bits;
Archanad8a83dc2021-06-14 10:04:16 +05302018 size_t storage_size = data_length;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002019
Ronald Cron81709fc2020-11-14 12:10:32 +01002020 *key = MBEDTLS_SVC_KEY_ID_INIT;
2021
Gilles Peskine0f84d622019-09-12 19:03:13 +02002022 /* Reject zero-length symmetric keys (including raw data key objects).
2023 * This also rejects any key which might be encoded as an empty string,
2024 * which is never valid. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002025 if (data_length == 0) {
2026 return PSA_ERROR_INVALID_ARGUMENT;
2027 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02002028
Archana449608b2021-09-08 15:36:05 +05302029 /* Ensure that the bytes-to-bits conversion cannot overflow. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002030 if (data_length > SIZE_MAX / 8) {
2031 return PSA_ERROR_NOT_SUPPORTED;
2032 }
Archana6ed4bda2021-08-04 10:47:15 +05302033
Gilles Peskine449bd832023-01-11 14:50:10 +01002034 status = psa_start_key_creation(PSA_KEY_CREATION_IMPORT, attributes,
2035 &slot, &driver);
2036 if (status != PSA_SUCCESS) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002037 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002038 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002039
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002040 /* In the case of a transparent key or an opaque key stored in local
Archana449608b2021-09-08 15:36:05 +05302041 * storage ( thus not in the case of importing a key in a secure element
2042 * with storage ( MBEDTLS_PSA_CRYPTO_SE_C ) ),we have to allocate a
2043 * buffer to hold the imported key material. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002044 if (slot->key.data == NULL) {
2045 if (psa_key_lifetime_is_external(attributes->core.lifetime)) {
Archana449608b2021-09-08 15:36:05 +05302046 status = psa_driver_wrapper_get_key_buffer_size_from_key_data(
Gilles Peskine449bd832023-01-11 14:50:10 +01002047 attributes, data, data_length, &storage_size);
2048 if (status != PSA_SUCCESS) {
Archanad8a83dc2021-06-14 10:04:16 +05302049 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002050 }
Archanad8a83dc2021-06-14 10:04:16 +05302051 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002052 status = psa_allocate_buffer_to_slot(slot, storage_size);
2053 if (status != PSA_SUCCESS) {
Gilles Peskineb46bef22019-07-30 21:32:04 +02002054 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002055 }
Gilles Peskine5d309672019-07-12 23:47:28 +02002056 }
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002057
2058 bits = slot->attr.bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01002059 status = psa_driver_wrapper_import_key(attributes,
2060 data, data_length,
2061 slot->key.data,
2062 slot->key.bytes,
2063 &slot->key.bytes, &bits);
2064 if (status != PSA_SUCCESS) {
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002065 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002066 }
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002067
Gilles Peskine449bd832023-01-11 14:50:10 +01002068 if (slot->attr.bits == 0) {
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002069 slot->attr.bits = (psa_key_bits_t) bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01002070 } else if (bits != slot->attr.bits) {
Steven Cooremanac3434f2021-01-15 17:36:02 +01002071 status = PSA_ERROR_INVALID_ARGUMENT;
2072 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02002073 }
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01002074
Archana6ed4bda2021-08-04 10:47:15 +05302075 /* Enforce a size limit, and in particular ensure that the bit
2076 * size fits in its representation type.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01002077 if (bits > PSA_MAX_KEY_BITS) {
Archana6ed4bda2021-08-04 10:47:15 +05302078 status = PSA_ERROR_NOT_SUPPORTED;
2079 goto exit;
2080 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002081 status = psa_validate_optional_attributes(slot, attributes);
2082 if (status != PSA_SUCCESS) {
Gilles Peskine18017402019-07-24 20:25:59 +02002083 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002084 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002085
Gilles Peskine449bd832023-01-11 14:50:10 +01002086 status = psa_finish_key_creation(slot, driver, key);
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002087exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002088 if (status != PSA_SUCCESS) {
2089 psa_fail_key_creation(slot, driver);
2090 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002091
Gilles Peskine449bd832023-01-11 14:50:10 +01002092 return status;
Gilles Peskine4747d192019-04-17 15:05:45 +02002093}
2094
Gilles Peskined7729582019-08-05 15:55:54 +02002095#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2096psa_status_t mbedtls_psa_register_se_key(
Gilles Peskine449bd832023-01-11 14:50:10 +01002097 const psa_key_attributes_t *attributes)
Gilles Peskined7729582019-08-05 15:55:54 +02002098{
2099 psa_status_t status;
2100 psa_key_slot_t *slot = NULL;
2101 psa_se_drv_table_entry_t *driver = NULL;
Ronald Croncf56a0a2020-08-04 09:51:30 +02002102 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskined7729582019-08-05 15:55:54 +02002103
2104 /* Leaving attributes unspecified is not currently supported.
2105 * It could make sense to query the key type and size from the
2106 * secure element, but not all secure elements support this
2107 * and the driver HAL doesn't currently support it. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002108 if (psa_get_key_type(attributes) == PSA_KEY_TYPE_NONE) {
2109 return PSA_ERROR_NOT_SUPPORTED;
2110 }
2111 if (psa_get_key_bits(attributes) == 0) {
2112 return PSA_ERROR_NOT_SUPPORTED;
2113 }
Gilles Peskined7729582019-08-05 15:55:54 +02002114
Gilles Peskine449bd832023-01-11 14:50:10 +01002115 status = psa_start_key_creation(PSA_KEY_CREATION_REGISTER, attributes,
2116 &slot, &driver);
2117 if (status != PSA_SUCCESS) {
Gilles Peskined7729582019-08-05 15:55:54 +02002118 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002119 }
Gilles Peskined7729582019-08-05 15:55:54 +02002120
Gilles Peskine449bd832023-01-11 14:50:10 +01002121 status = psa_finish_key_creation(slot, driver, &key);
Gilles Peskined7729582019-08-05 15:55:54 +02002122
2123exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002124 if (status != PSA_SUCCESS) {
2125 psa_fail_key_creation(slot, driver);
2126 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002127
Gilles Peskined7729582019-08-05 15:55:54 +02002128 /* Registration doesn't keep the key in RAM. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002129 psa_close_key(key);
2130 return status;
Gilles Peskined7729582019-08-05 15:55:54 +02002131}
2132#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2133
Gilles Peskine449bd832023-01-11 14:50:10 +01002134psa_status_t psa_copy_key(mbedtls_svc_key_id_t source_key,
2135 const psa_key_attributes_t *specified_attributes,
2136 mbedtls_svc_key_id_t *target_key)
Gilles Peskinef603c712019-01-19 13:40:11 +01002137{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002138 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01002139 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinef603c712019-01-19 13:40:11 +01002140 psa_key_slot_t *source_slot = NULL;
2141 psa_key_slot_t *target_slot = NULL;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002142 psa_key_attributes_t actual_attributes = *specified_attributes;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002143 psa_se_drv_table_entry_t *driver = NULL;
Archana8a180362021-07-05 02:18:48 +05302144 size_t storage_size = 0;
Gilles Peskinef603c712019-01-19 13:40:11 +01002145
Ronald Cron81709fc2020-11-14 12:10:32 +01002146 *target_key = MBEDTLS_SVC_KEY_ID_INIT;
2147
Archana8a180362021-07-05 02:18:48 +05302148 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002149 source_key, &source_slot, PSA_KEY_USAGE_COPY, 0);
2150 if (status != PSA_SUCCESS) {
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002151 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002152 }
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002153
Gilles Peskine449bd832023-01-11 14:50:10 +01002154 status = psa_validate_optional_attributes(source_slot,
2155 specified_attributes);
2156 if (status != PSA_SUCCESS) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002157 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002158 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002159
Archana9d17bf42021-09-10 06:22:44 +05302160 /* The target key type and number of bits have been validated by
2161 * psa_validate_optional_attributes() to be either equal to zero or
2162 * equal to the ones of the source key. So it is safe to inherit
2163 * them from the source key now."
Archana374fe5b2021-09-08 15:50:28 +05302164 * */
Archana9d17bf42021-09-10 06:22:44 +05302165 actual_attributes.core.bits = source_slot->attr.bits;
2166 actual_attributes.core.type = source_slot->attr.type;
Archana374fe5b2021-09-08 15:50:28 +05302167
2168
Gilles Peskine449bd832023-01-11 14:50:10 +01002169 status = psa_restrict_key_policy(source_slot->attr.type,
2170 &actual_attributes.core.policy,
2171 &source_slot->attr.policy);
2172 if (status != PSA_SUCCESS) {
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002173 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002174 }
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002175
Gilles Peskine449bd832023-01-11 14:50:10 +01002176 status = psa_start_key_creation(PSA_KEY_CREATION_COPY, &actual_attributes,
2177 &target_slot, &driver);
2178 if (status != PSA_SUCCESS) {
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002179 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002180 }
2181 if (PSA_KEY_LIFETIME_GET_LOCATION(target_slot->attr.lifetime) !=
2182 PSA_KEY_LIFETIME_GET_LOCATION(source_slot->attr.lifetime)) {
Archana8a180362021-07-05 02:18:48 +05302183 /*
Archana9d17bf42021-09-10 06:22:44 +05302184 * If the source and target keys are stored in different locations,
Archana8a180362021-07-05 02:18:48 +05302185 * the source key would need to be exported as plaintext and re-imported
2186 * in the other location. This has security implications which have not
Archana449608b2021-09-08 15:36:05 +05302187 * been fully mapped. For now, this can be achieved through
Archana8a180362021-07-05 02:18:48 +05302188 * appropriate API invocations from the application, if needed.
2189 * */
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002190 status = PSA_ERROR_NOT_SUPPORTED;
2191 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002192 }
Archana8a180362021-07-05 02:18:48 +05302193 /*
2194 * When the source and target keys are within the same location,
Archana449608b2021-09-08 15:36:05 +05302195 * - For transparent keys it is a blind copy without any driver invocation,
Archana8a180362021-07-05 02:18:48 +05302196 * - For opaque keys this translates to an invocation of the drivers'
2197 * copy_key entry point through the dispatch layer.
2198 * */
Gilles Peskine449bd832023-01-11 14:50:10 +01002199 if (psa_key_lifetime_is_external(actual_attributes.core.lifetime)) {
2200 status = psa_driver_wrapper_get_key_buffer_size(&actual_attributes,
2201 &storage_size);
2202 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302203 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002204 }
Archana374fe5b2021-09-08 15:50:28 +05302205
Gilles Peskine449bd832023-01-11 14:50:10 +01002206 status = psa_allocate_buffer_to_slot(target_slot, storage_size);
2207 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302208 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002209 }
Archana374fe5b2021-09-08 15:50:28 +05302210
Gilles Peskine449bd832023-01-11 14:50:10 +01002211 status = psa_driver_wrapper_copy_key(&actual_attributes,
2212 source_slot->key.data,
2213 source_slot->key.bytes,
2214 target_slot->key.data,
2215 target_slot->key.bytes,
2216 &target_slot->key.bytes);
2217 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302218 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002219 }
2220 } else {
2221 status = psa_copy_key_material_into_slot(target_slot,
Archana9d17bf42021-09-10 06:22:44 +05302222 source_slot->key.data,
Gilles Peskine449bd832023-01-11 14:50:10 +01002223 source_slot->key.bytes);
2224 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302225 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002226 }
Archana8a180362021-07-05 02:18:48 +05302227 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002228 status = psa_finish_key_creation(target_slot, driver, target_key);
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002229exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002230 if (status != PSA_SUCCESS) {
2231 psa_fail_key_creation(target_slot, driver);
2232 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002233
Ryan Everett1b70a072024-01-04 10:32:49 +00002234 unlock_status = psa_unregister_read(source_slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02002235
Gilles Peskine449bd832023-01-11 14:50:10 +01002236 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskinef603c712019-01-19 13:40:11 +01002237}
2238
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02002239
2240
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01002241/****************************************************************/
Gilles Peskine20035e32018-02-03 22:44:14 +01002242/* Message digests */
2243/****************************************************************/
2244
Gilles Peskine449bd832023-01-11 14:50:10 +01002245psa_status_t psa_hash_abort(psa_hash_operation_t *operation)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002246{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002247 /* Aborting a non-active operation is allowed */
Gilles Peskine449bd832023-01-11 14:50:10 +01002248 if (operation->id == 0) {
2249 return PSA_SUCCESS;
2250 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002251
Gilles Peskine449bd832023-01-11 14:50:10 +01002252 psa_status_t status = psa_driver_wrapper_hash_abort(operation);
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002253 operation->id = 0;
2254
Gilles Peskine449bd832023-01-11 14:50:10 +01002255 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002256}
2257
Gilles Peskine449bd832023-01-11 14:50:10 +01002258psa_status_t psa_hash_setup(psa_hash_operation_t *operation,
2259 psa_algorithm_t alg)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002260{
Dave Rodgman685b6a72021-06-24 11:49:14 +01002261 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002262
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002263 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002264 if (operation->id != 0) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002265 status = PSA_ERROR_BAD_STATE;
2266 goto exit;
2267 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002268
Gilles Peskine449bd832023-01-11 14:50:10 +01002269 if (!PSA_ALG_IS_HASH(alg)) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002270 status = PSA_ERROR_INVALID_ARGUMENT;
2271 goto exit;
2272 }
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002273
Steven Cooremanb6bf4bb2021-03-15 19:00:14 +01002274 /* Ensure all of the context is zeroized, since PSA_HASH_OPERATION_INIT only
2275 * directly zeroes the int-sized dummy member of the context union. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002276 memset(&operation->ctx, 0, sizeof(operation->ctx));
Steven Cooreman893232f2021-03-15 12:23:37 +01002277
Gilles Peskine449bd832023-01-11 14:50:10 +01002278 status = psa_driver_wrapper_hash_setup(operation, alg);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002279
2280exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002281 if (status != PSA_SUCCESS) {
2282 psa_hash_abort(operation);
2283 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002284
2285 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002286}
2287
Gilles Peskine449bd832023-01-11 14:50:10 +01002288psa_status_t psa_hash_update(psa_hash_operation_t *operation,
2289 const uint8_t *input,
2290 size_t input_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002291{
Dave Rodgman685b6a72021-06-24 11:49:14 +01002292 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2293
Gilles Peskine449bd832023-01-11 14:50:10 +01002294 if (operation->id == 0) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002295 status = PSA_ERROR_BAD_STATE;
2296 goto exit;
2297 }
Gilles Peskine94e44542018-07-12 16:58:43 +02002298
Steven Cooremanc8288352021-03-04 14:02:19 +01002299 /* Don't require hash implementations to behave correctly on a
2300 * zero-length input, which may have an invalid pointer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002301 if (input_length == 0) {
2302 return PSA_SUCCESS;
2303 }
Steven Cooremanc8288352021-03-04 14:02:19 +01002304
Gilles Peskine449bd832023-01-11 14:50:10 +01002305 status = psa_driver_wrapper_hash_update(operation, input, input_length);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002306
2307exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002308 if (status != PSA_SUCCESS) {
2309 psa_hash_abort(operation);
2310 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002311
Gilles Peskine449bd832023-01-11 14:50:10 +01002312 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002313}
2314
Gilles Peskine449bd832023-01-11 14:50:10 +01002315psa_status_t psa_hash_finish(psa_hash_operation_t *operation,
2316 uint8_t *hash,
2317 size_t hash_size,
2318 size_t *hash_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002319{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002320 *hash_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002321 if (operation->id == 0) {
2322 return PSA_ERROR_BAD_STATE;
2323 }
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002324
Steven Cooreman1e582352021-02-18 17:24:37 +01002325 psa_status_t status = psa_driver_wrapper_hash_finish(
Gilles Peskine449bd832023-01-11 14:50:10 +01002326 operation, hash, hash_size, hash_length);
2327 psa_hash_abort(operation);
2328 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002329}
2330
Gilles Peskine449bd832023-01-11 14:50:10 +01002331psa_status_t psa_hash_verify(psa_hash_operation_t *operation,
2332 const uint8_t *hash,
2333 size_t hash_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002334{
Ronald Cron69a63422021-10-18 09:47:58 +02002335 uint8_t actual_hash[PSA_HASH_MAX_SIZE];
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002336 size_t actual_hash_length;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002337 psa_status_t status = psa_hash_finish(
Gilles Peskine449bd832023-01-11 14:50:10 +01002338 operation,
2339 actual_hash, sizeof(actual_hash),
2340 &actual_hash_length);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002341
Gilles Peskine449bd832023-01-11 14:50:10 +01002342 if (status != PSA_SUCCESS) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002343 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002344 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002345
Gilles Peskine449bd832023-01-11 14:50:10 +01002346 if (actual_hash_length != hash_length) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002347 status = PSA_ERROR_INVALID_SIGNATURE;
2348 goto exit;
2349 }
2350
Dave Rodgman78701152023-08-29 14:20:18 +01002351 if (mbedtls_ct_memcmp(hash, actual_hash, actual_hash_length) != 0) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002352 status = PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01002353 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002354
2355exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002356 mbedtls_platform_zeroize(actual_hash, sizeof(actual_hash));
2357 if (status != PSA_SUCCESS) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002358 psa_hash_abort(operation);
Gilles Peskine449bd832023-01-11 14:50:10 +01002359 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002360
Gilles Peskine449bd832023-01-11 14:50:10 +01002361 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002362}
2363
Gilles Peskine449bd832023-01-11 14:50:10 +01002364psa_status_t psa_hash_compute(psa_algorithm_t alg,
2365 const uint8_t *input, size_t input_length,
2366 uint8_t *hash, size_t hash_size,
2367 size_t *hash_length)
Gilles Peskine0a749c82019-11-28 19:33:58 +01002368{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002369 *hash_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002370 if (!PSA_ALG_IS_HASH(alg)) {
2371 return PSA_ERROR_INVALID_ARGUMENT;
2372 }
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002373
Gilles Peskine449bd832023-01-11 14:50:10 +01002374 return psa_driver_wrapper_hash_compute(alg, input, input_length,
2375 hash, hash_size, hash_length);
Gilles Peskine0a749c82019-11-28 19:33:58 +01002376}
2377
Gilles Peskine449bd832023-01-11 14:50:10 +01002378psa_status_t psa_hash_compare(psa_algorithm_t alg,
2379 const uint8_t *input, size_t input_length,
2380 const uint8_t *hash, size_t hash_length)
Gilles Peskine0a749c82019-11-28 19:33:58 +01002381{
Ronald Cron69a63422021-10-18 09:47:58 +02002382 uint8_t actual_hash[PSA_HASH_MAX_SIZE];
Steven Cooreman84d670d2021-02-18 16:22:53 +01002383 size_t actual_hash_length;
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002384
Gilles Peskine449bd832023-01-11 14:50:10 +01002385 if (!PSA_ALG_IS_HASH(alg)) {
2386 return PSA_ERROR_INVALID_ARGUMENT;
2387 }
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002388
Steven Cooreman1e582352021-02-18 17:24:37 +01002389 psa_status_t status = psa_driver_wrapper_hash_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01002390 alg, input, input_length,
2391 actual_hash, sizeof(actual_hash),
2392 &actual_hash_length);
2393 if (status != PSA_SUCCESS) {
Gilles Peskine60aebec2021-12-13 12:33:18 +01002394 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002395 }
2396 if (actual_hash_length != hash_length) {
Gilles Peskine60aebec2021-12-13 12:33:18 +01002397 status = PSA_ERROR_INVALID_SIGNATURE;
2398 goto exit;
2399 }
Dave Rodgman78701152023-08-29 14:20:18 +01002400 if (mbedtls_ct_memcmp(hash, actual_hash, actual_hash_length) != 0) {
Gilles Peskine60aebec2021-12-13 12:33:18 +01002401 status = PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01002402 }
Gilles Peskine60aebec2021-12-13 12:33:18 +01002403
2404exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002405 mbedtls_platform_zeroize(actual_hash, sizeof(actual_hash));
2406 return status;
Gilles Peskine0a749c82019-11-28 19:33:58 +01002407}
2408
Gilles Peskine449bd832023-01-11 14:50:10 +01002409psa_status_t psa_hash_clone(const psa_hash_operation_t *source_operation,
2410 psa_hash_operation_t *target_operation)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002411{
Gilles Peskine449bd832023-01-11 14:50:10 +01002412 if (source_operation->id == 0 ||
2413 target_operation->id != 0) {
2414 return PSA_ERROR_BAD_STATE;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002415 }
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002416
Gilles Peskine449bd832023-01-11 14:50:10 +01002417 psa_status_t status = psa_driver_wrapper_hash_clone(source_operation,
2418 target_operation);
2419 if (status != PSA_SUCCESS) {
2420 psa_hash_abort(target_operation);
2421 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002422
Gilles Peskine449bd832023-01-11 14:50:10 +01002423 return status;
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002424}
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002425
2426
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002427/****************************************************************/
Gilles Peskine8c9def32018-02-08 10:02:12 +01002428/* MAC */
2429/****************************************************************/
2430
Gilles Peskine449bd832023-01-11 14:50:10 +01002431psa_status_t psa_mac_abort(psa_mac_operation_t *operation)
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002432{
Steven Cooremane6804192021-03-19 18:28:56 +01002433 /* Aborting a non-active operation is allowed */
Gilles Peskine449bd832023-01-11 14:50:10 +01002434 if (operation->id == 0) {
2435 return PSA_SUCCESS;
2436 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002437
Gilles Peskine449bd832023-01-11 14:50:10 +01002438 psa_status_t status = psa_driver_wrapper_mac_abort(operation);
Steven Cooreman72f736a2021-05-07 14:14:37 +02002439 operation->mac_size = 0;
2440 operation->is_sign = 0;
Steven Cooremane6804192021-03-19 18:28:56 +01002441 operation->id = 0;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002442
Gilles Peskine449bd832023-01-11 14:50:10 +01002443 return status;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002444}
2445
Ronald Cron2dff3b22021-06-17 16:33:22 +02002446static psa_status_t psa_mac_finalize_alg_and_key_validation(
2447 psa_algorithm_t alg,
Ronald Cron79bdd822021-06-17 16:46:44 +02002448 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01002449 uint8_t *mac_size)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002450{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002451 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002452 psa_key_type_t key_type = psa_get_key_type(attributes);
2453 size_t key_bits = psa_get_key_bits(attributes);
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002454
Gilles Peskine449bd832023-01-11 14:50:10 +01002455 if (!PSA_ALG_IS_MAC(alg)) {
2456 return PSA_ERROR_INVALID_ARGUMENT;
2457 }
Steven Cooremane6804192021-03-19 18:28:56 +01002458
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002459 /* Validate the combination of key type and algorithm */
Gilles Peskine449bd832023-01-11 14:50:10 +01002460 status = psa_mac_key_can_do(alg, key_type);
2461 if (status != PSA_SUCCESS) {
2462 return status;
2463 }
Steven Cooreman15472f82021-03-02 16:16:22 +01002464
Steven Cooremand1a68f12021-05-10 11:13:41 +02002465 /* Get the output length for the algorithm and key combination */
Gilles Peskine449bd832023-01-11 14:50:10 +01002466 *mac_size = PSA_MAC_LENGTH(key_type, key_bits, alg);
Steven Cooreman15472f82021-03-02 16:16:22 +01002467
Gilles Peskine449bd832023-01-11 14:50:10 +01002468 if (*mac_size < 4) {
Steven Cooreman15472f82021-03-02 16:16:22 +01002469 /* A very short MAC is too short for security since it can be
2470 * brute-forced. Ancient protocols with 32-bit MACs do exist,
2471 * so we make this our minimum, even though 32 bits is still
2472 * too small for security. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002473 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman15472f82021-03-02 16:16:22 +01002474 }
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02002475
Gilles Peskine449bd832023-01-11 14:50:10 +01002476 if (*mac_size > PSA_MAC_LENGTH(key_type, key_bits,
2477 PSA_ALG_FULL_LENGTH_MAC(alg))) {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002478 /* It's impossible to "truncate" to a larger length than the full length
2479 * of the algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002480 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002481 }
2482
Gilles Peskine449bd832023-01-11 14:50:10 +01002483 if (*mac_size > PSA_MAC_MAX_SIZE) {
Gilles Peskinea9b6c802022-03-16 13:54:49 +01002484 /* PSA_MAC_LENGTH returns the correct length even for a MAC algorithm
2485 * that is disabled in the compile-time configuration. The result can
2486 * therefore be larger than PSA_MAC_MAX_SIZE, which does take the
2487 * configuration into account. In this case, force a return of
2488 * PSA_ERROR_NOT_SUPPORTED here. Otherwise psa_mac_verify(), or
2489 * psa_mac_compute(mac_size=PSA_MAC_MAX_SIZE), would return
2490 * PSA_ERROR_BUFFER_TOO_SMALL for an unsupported algorithm whose MAC size
2491 * is larger than PSA_MAC_MAX_SIZE, which is misleading and which breaks
2492 * systematically generated tests. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002493 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea9b6c802022-03-16 13:54:49 +01002494 }
2495
Gilles Peskine449bd832023-01-11 14:50:10 +01002496 return PSA_SUCCESS;
Ronald Cron2dff3b22021-06-17 16:33:22 +02002497}
2498
Gilles Peskine449bd832023-01-11 14:50:10 +01002499static psa_status_t psa_mac_setup(psa_mac_operation_t *operation,
2500 mbedtls_svc_key_id_t key,
2501 psa_algorithm_t alg,
2502 int is_sign)
Gilles Peskinee59236f2018-01-27 23:32:46 +01002503{
2504 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2505 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman54648242021-06-24 11:49:45 +01002506 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002507 psa_key_attributes_t attributes;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002508
2509 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002510 if (operation->id != 0) {
Dave Rodgman54648242021-06-24 11:49:45 +01002511 status = PSA_ERROR_BAD_STATE;
2512 goto exit;
2513 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002514
2515 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002516 key,
2517 &slot,
2518 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
2519 alg);
2520 if (status != PSA_SUCCESS) {
Dave Rodgman54648242021-06-24 11:49:45 +01002521 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002522 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002523
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002524 attributes = (psa_key_attributes_t) {
Gilles Peskine8c9def32018-02-08 10:02:12 +01002525 .core = slot->attr
2526 };
2527
Gilles Peskine449bd832023-01-11 14:50:10 +01002528 status = psa_mac_finalize_alg_and_key_validation(alg, &attributes,
2529 &operation->mac_size);
2530 if (status != PSA_SUCCESS) {
Gilles Peskine8c9def32018-02-08 10:02:12 +01002531 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002532 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002533
2534 operation->is_sign = is_sign;
Steven Cooremane6804192021-03-19 18:28:56 +01002535 /* Dispatch the MAC setup call with validated input */
Gilles Peskine449bd832023-01-11 14:50:10 +01002536 if (is_sign) {
2537 status = psa_driver_wrapper_mac_sign_setup(operation,
2538 &attributes,
2539 slot->key.data,
2540 slot->key.bytes,
2541 alg);
2542 } else {
2543 status = psa_driver_wrapper_mac_verify_setup(operation,
2544 &attributes,
2545 slot->key.data,
2546 slot->key.bytes,
2547 alg);
Gilles Peskine8c9def32018-02-08 10:02:12 +01002548 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002549
Gilles Peskinefbfac682018-07-08 20:51:54 +02002550exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002551 if (status != PSA_SUCCESS) {
2552 psa_mac_abort(operation);
2553 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002554
Ryan Everett1b70a072024-01-04 10:32:49 +00002555 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02002556
Gilles Peskine449bd832023-01-11 14:50:10 +01002557 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002558}
2559
Gilles Peskine449bd832023-01-11 14:50:10 +01002560psa_status_t psa_mac_sign_setup(psa_mac_operation_t *operation,
2561 mbedtls_svc_key_id_t key,
2562 psa_algorithm_t alg)
Gilles Peskine89167cb2018-07-08 20:12:23 +02002563{
Gilles Peskine449bd832023-01-11 14:50:10 +01002564 return psa_mac_setup(operation, key, alg, 1);
Gilles Peskine89167cb2018-07-08 20:12:23 +02002565}
2566
Gilles Peskine449bd832023-01-11 14:50:10 +01002567psa_status_t psa_mac_verify_setup(psa_mac_operation_t *operation,
2568 mbedtls_svc_key_id_t key,
2569 psa_algorithm_t alg)
Gilles Peskine89167cb2018-07-08 20:12:23 +02002570{
Gilles Peskine449bd832023-01-11 14:50:10 +01002571 return psa_mac_setup(operation, key, alg, 0);
Gilles Peskine89167cb2018-07-08 20:12:23 +02002572}
2573
Gilles Peskine449bd832023-01-11 14:50:10 +01002574psa_status_t psa_mac_update(psa_mac_operation_t *operation,
2575 const uint8_t *input,
2576 size_t input_length)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002577{
Gilles Peskine449bd832023-01-11 14:50:10 +01002578 if (operation->id == 0) {
2579 return PSA_ERROR_BAD_STATE;
2580 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002581
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002582 /* Don't require hash implementations to behave correctly on a
2583 * zero-length input, which may have an invalid pointer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002584 if (input_length == 0) {
2585 return PSA_SUCCESS;
2586 }
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03002587
Gilles Peskine449bd832023-01-11 14:50:10 +01002588 psa_status_t status = psa_driver_wrapper_mac_update(operation,
2589 input, input_length);
2590 if (status != PSA_SUCCESS) {
2591 psa_mac_abort(operation);
2592 }
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002593
Gilles Peskine449bd832023-01-11 14:50:10 +01002594 return status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002595}
2596
Gilles Peskine449bd832023-01-11 14:50:10 +01002597psa_status_t psa_mac_sign_finish(psa_mac_operation_t *operation,
2598 uint8_t *mac,
2599 size_t mac_size,
2600 size_t *mac_length)
mohammad16036df908f2018-04-02 08:34:15 -07002601{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002602 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2603 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002604
Gilles Peskine449bd832023-01-11 14:50:10 +01002605 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002606 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002607 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002608 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002609
Gilles Peskine449bd832023-01-11 14:50:10 +01002610 if (!operation->is_sign) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002611 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002612 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002613 }
Steven Cooreman72f736a2021-05-07 14:14:37 +02002614
Steven Cooreman8af5c5c2021-05-11 11:09:13 +02002615 /* Sanity check. This will guarantee that mac_size != 0 (and so mac != NULL)
2616 * once all the error checks are done. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002617 if (operation->mac_size == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002618 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002619 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002620 }
Steven Cooreman8af5c5c2021-05-11 11:09:13 +02002621
Gilles Peskine449bd832023-01-11 14:50:10 +01002622 if (mac_size < operation->mac_size) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002623 status = PSA_ERROR_BUFFER_TOO_SMALL;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002624 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002625 }
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002626
Gilles Peskine449bd832023-01-11 14:50:10 +01002627 status = psa_driver_wrapper_mac_sign_finish(operation,
2628 mac, operation->mac_size,
2629 mac_length);
Steven Cooreman72f736a2021-05-07 14:14:37 +02002630
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002631exit:
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002632 /* In case of success, set the potential excess room in the output buffer
2633 * to an invalid value, to avoid potentially leaking a longer MAC.
2634 * In case of error, set the output length and content to a safe default,
2635 * such that in case the caller misses an error check, the output would be
2636 * an unachievable MAC.
2637 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002638 if (status != PSA_SUCCESS) {
Steven Cooreman72f736a2021-05-07 14:14:37 +02002639 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002640 operation->mac_size = 0;
Steven Cooreman72f736a2021-05-07 14:14:37 +02002641 }
mohammad16036df908f2018-04-02 08:34:15 -07002642
Paul Elliottdc42ca82023-02-24 18:11:59 +00002643 psa_wipe_tag_output_buffer(mac, status, mac_size, *mac_length);
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002644
Gilles Peskine449bd832023-01-11 14:50:10 +01002645 abort_status = psa_mac_abort(operation);
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002646
Gilles Peskine449bd832023-01-11 14:50:10 +01002647 return status == PSA_SUCCESS ? abort_status : status;
mohammad16036df908f2018-04-02 08:34:15 -07002648}
2649
Gilles Peskine449bd832023-01-11 14:50:10 +01002650psa_status_t psa_mac_verify_finish(psa_mac_operation_t *operation,
2651 const uint8_t *mac,
2652 size_t mac_length)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002653{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002654 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2655 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002656
Gilles Peskine449bd832023-01-11 14:50:10 +01002657 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002658 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002659 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002660 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002661
Gilles Peskine449bd832023-01-11 14:50:10 +01002662 if (operation->is_sign) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002663 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002664 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002665 }
Steven Cooreman72f736a2021-05-07 14:14:37 +02002666
Gilles Peskine449bd832023-01-11 14:50:10 +01002667 if (operation->mac_size != mac_length) {
Steven Cooreman72f736a2021-05-07 14:14:37 +02002668 status = PSA_ERROR_INVALID_SIGNATURE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002669 goto exit;
Steven Cooreman72f736a2021-05-07 14:14:37 +02002670 }
2671
Gilles Peskine449bd832023-01-11 14:50:10 +01002672 status = psa_driver_wrapper_mac_verify_finish(operation,
2673 mac, mac_length);
Steven Cooreman72f736a2021-05-07 14:14:37 +02002674
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002675exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002676 abort_status = psa_mac_abort(operation);
mohammad16036df908f2018-04-02 08:34:15 -07002677
Gilles Peskine449bd832023-01-11 14:50:10 +01002678 return status == PSA_SUCCESS ? abort_status : status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002679}
2680
Gilles Peskine449bd832023-01-11 14:50:10 +01002681static psa_status_t psa_mac_compute_internal(mbedtls_svc_key_id_t key,
2682 psa_algorithm_t alg,
2683 const uint8_t *input,
2684 size_t input_length,
2685 uint8_t *mac,
2686 size_t mac_size,
2687 size_t *mac_length,
2688 int is_sign)
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002689{
2690 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron51131b52021-06-17 17:17:20 +02002691 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2692 psa_key_slot_t *slot;
2693 uint8_t operation_mac_size = 0;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002694 psa_key_attributes_t attributes;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002695
Ronald Cron51131b52021-06-17 17:17:20 +02002696 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002697 key,
2698 &slot,
2699 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
2700 alg);
2701 if (status != PSA_SUCCESS) {
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002702 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002703 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002704
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002705 attributes = (psa_key_attributes_t) {
Ronald Cron51131b52021-06-17 17:17:20 +02002706 .core = slot->attr
2707 };
2708
Gilles Peskine449bd832023-01-11 14:50:10 +01002709 status = psa_mac_finalize_alg_and_key_validation(alg, &attributes,
2710 &operation_mac_size);
2711 if (status != PSA_SUCCESS) {
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002712 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002713 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002714
Gilles Peskine449bd832023-01-11 14:50:10 +01002715 if (mac_size < operation_mac_size) {
Ronald Cron51131b52021-06-17 17:17:20 +02002716 status = PSA_ERROR_BUFFER_TOO_SMALL;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002717 goto exit;
Ronald Cron51131b52021-06-17 17:17:20 +02002718 }
2719
2720 status = psa_driver_wrapper_mac_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01002721 &attributes,
2722 slot->key.data, slot->key.bytes,
2723 alg,
2724 input, input_length,
2725 mac, operation_mac_size, mac_length);
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002726
2727exit:
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002728 /* In case of success, set the potential excess room in the output buffer
2729 * to an invalid value, to avoid potentially leaking a longer MAC.
2730 * In case of error, set the output length and content to a safe default,
2731 * such that in case the caller misses an error check, the output would be
2732 * an unachievable MAC.
2733 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002734 if (status != PSA_SUCCESS) {
Ronald Cron51131b52021-06-17 17:17:20 +02002735 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002736 operation_mac_size = 0;
Ronald Cron51131b52021-06-17 17:17:20 +02002737 }
Paul Elliottdc42ca82023-02-24 18:11:59 +00002738
2739 psa_wipe_tag_output_buffer(mac, status, mac_size, *mac_length);
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002740
Ryan Everett1b70a072024-01-04 10:32:49 +00002741 unlock_status = psa_unregister_read(slot);
Ronald Cron51131b52021-06-17 17:17:20 +02002742
Gilles Peskine449bd832023-01-11 14:50:10 +01002743 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002744}
2745
Gilles Peskine449bd832023-01-11 14:50:10 +01002746psa_status_t psa_mac_compute(mbedtls_svc_key_id_t key,
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002747 psa_algorithm_t alg,
2748 const uint8_t *input,
2749 size_t input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002750 uint8_t *mac,
2751 size_t mac_size,
2752 size_t *mac_length)
2753{
2754 return psa_mac_compute_internal(key, alg,
2755 input, input_length,
2756 mac, mac_size, mac_length, 1);
2757}
2758
2759psa_status_t psa_mac_verify(mbedtls_svc_key_id_t key,
2760 psa_algorithm_t alg,
2761 const uint8_t *input,
2762 size_t input_length,
2763 const uint8_t *mac,
2764 size_t mac_length)
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002765{
2766 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Crona587cbc2021-06-18 14:51:29 +02002767 uint8_t actual_mac[PSA_MAC_MAX_SIZE];
2768 size_t actual_mac_length;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002769
Gilles Peskine449bd832023-01-11 14:50:10 +01002770 status = psa_mac_compute_internal(key, alg,
2771 input, input_length,
2772 actual_mac, sizeof(actual_mac),
2773 &actual_mac_length, 0);
2774 if (status != PSA_SUCCESS) {
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002775 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002776 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002777
Gilles Peskine449bd832023-01-11 14:50:10 +01002778 if (mac_length != actual_mac_length) {
Ronald Crona587cbc2021-06-18 14:51:29 +02002779 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002780 goto exit;
Ronald Crona587cbc2021-06-18 14:51:29 +02002781 }
Dave Rodgman78701152023-08-29 14:20:18 +01002782 if (mbedtls_ct_memcmp(mac, actual_mac, actual_mac_length) != 0) {
Ronald Crona587cbc2021-06-18 14:51:29 +02002783 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002784 goto exit;
Ronald Crona587cbc2021-06-18 14:51:29 +02002785 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002786
2787exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002788 mbedtls_platform_zeroize(actual_mac, sizeof(actual_mac));
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002789
Gilles Peskine449bd832023-01-11 14:50:10 +01002790 return status;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002791}
Gilles Peskinee59236f2018-01-27 23:32:46 +01002792
Gilles Peskinee59236f2018-01-27 23:32:46 +01002793/****************************************************************/
2794/* Asymmetric cryptography */
2795/****************************************************************/
2796
Gilles Peskine449bd832023-01-11 14:50:10 +01002797static psa_status_t psa_sign_verify_check_alg(int input_is_message,
2798 psa_algorithm_t alg)
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002799{
Gilles Peskine449bd832023-01-11 14:50:10 +01002800 if (input_is_message) {
2801 if (!PSA_ALG_IS_SIGN_MESSAGE(alg)) {
2802 return PSA_ERROR_INVALID_ARGUMENT;
2803 }
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002804
Gilles Peskine449bd832023-01-11 14:50:10 +01002805 if (PSA_ALG_IS_SIGN_HASH(alg)) {
2806 if (!PSA_ALG_IS_HASH(PSA_ALG_SIGN_GET_HASH(alg))) {
2807 return PSA_ERROR_INVALID_ARGUMENT;
2808 }
2809 }
2810 } else {
2811 if (!PSA_ALG_IS_SIGN_HASH(alg)) {
2812 return PSA_ERROR_INVALID_ARGUMENT;
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002813 }
2814 }
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002815
Gilles Peskine449bd832023-01-11 14:50:10 +01002816 return PSA_SUCCESS;
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002817}
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002818
Gilles Peskine449bd832023-01-11 14:50:10 +01002819static psa_status_t psa_sign_internal(mbedtls_svc_key_id_t key,
2820 int input_is_message,
2821 psa_algorithm_t alg,
2822 const uint8_t *input,
2823 size_t input_length,
2824 uint8_t *signature,
2825 size_t signature_size,
2826 size_t *signature_length)
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002827{
2828 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2829 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2830 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002831 psa_key_attributes_t attributes;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002832
2833 *signature_length = 0;
2834
Gilles Peskine449bd832023-01-11 14:50:10 +01002835 status = psa_sign_verify_check_alg(input_is_message, alg);
2836 if (status != PSA_SUCCESS) {
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002837 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002838 }
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002839
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002840 /* Immediately reject a zero-length signature buffer. This guarantees
gabor-mezei-arm12b4f342021-05-05 13:54:55 +02002841 * that signature must be a valid pointer. (On the other hand, the input
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002842 * buffer can in principle be empty since it doesn't actually have
2843 * to be a hash.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01002844 if (signature_size == 0) {
2845 return PSA_ERROR_BUFFER_TOO_SMALL;
2846 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002847
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002848 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002849 key, &slot,
2850 input_is_message ? PSA_KEY_USAGE_SIGN_MESSAGE :
2851 PSA_KEY_USAGE_SIGN_HASH,
2852 alg);
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002853
Gilles Peskine449bd832023-01-11 14:50:10 +01002854 if (status != PSA_SUCCESS) {
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002855 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002856 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002857
Gilles Peskine449bd832023-01-11 14:50:10 +01002858 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002859 status = PSA_ERROR_INVALID_ARGUMENT;
2860 goto exit;
2861 }
2862
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002863 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01002864 .core = slot->attr
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002865 };
2866
Gilles Peskine449bd832023-01-11 14:50:10 +01002867 if (input_is_message) {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002868 status = psa_driver_wrapper_sign_message(
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002869 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002870 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002871 signature, signature_size, signature_length);
2872 } else {
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002873
2874 status = psa_driver_wrapper_sign_hash(
2875 &attributes, slot->key.data, slot->key.bytes,
2876 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002877 signature, signature_size, signature_length);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002878 }
2879
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002880
2881exit:
Paul Elliott59200a22023-02-21 15:07:40 +00002882 psa_wipe_tag_output_buffer(signature, status, signature_size,
2883 *signature_length);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002884
Ryan Everett1b70a072024-01-04 10:32:49 +00002885 unlock_status = psa_unregister_read(slot);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002886
Gilles Peskine449bd832023-01-11 14:50:10 +01002887 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002888}
2889
Gilles Peskine449bd832023-01-11 14:50:10 +01002890static psa_status_t psa_verify_internal(mbedtls_svc_key_id_t key,
2891 int input_is_message,
2892 psa_algorithm_t alg,
2893 const uint8_t *input,
2894 size_t input_length,
2895 const uint8_t *signature,
2896 size_t signature_length)
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002897{
2898 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2899 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2900 psa_key_slot_t *slot;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002901
Gilles Peskine449bd832023-01-11 14:50:10 +01002902 status = psa_sign_verify_check_alg(input_is_message, alg);
2903 if (status != PSA_SUCCESS) {
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002904 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002905 }
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002906
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002907 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002908 key, &slot,
2909 input_is_message ? PSA_KEY_USAGE_VERIFY_MESSAGE :
2910 PSA_KEY_USAGE_VERIFY_HASH,
2911 alg);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002912
Gilles Peskine449bd832023-01-11 14:50:10 +01002913 if (status != PSA_SUCCESS) {
2914 return status;
2915 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002916
2917 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01002918 .core = slot->attr
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002919 };
2920
Gilles Peskine449bd832023-01-11 14:50:10 +01002921 if (input_is_message) {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002922 status = psa_driver_wrapper_verify_message(
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002923 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002924 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002925 signature, signature_length);
2926 } else {
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002927 status = psa_driver_wrapper_verify_hash(
2928 &attributes, slot->key.data, slot->key.bytes,
2929 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002930 signature, signature_length);
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002931 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002932
Ryan Everett1b70a072024-01-04 10:32:49 +00002933 unlock_status = psa_unregister_read(slot);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002934
Gilles Peskine449bd832023-01-11 14:50:10 +01002935 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002936
2937}
2938
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002939psa_status_t psa_sign_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002940 const psa_key_attributes_t *attributes,
2941 const uint8_t *key_buffer,
2942 size_t key_buffer_size,
2943 psa_algorithm_t alg,
2944 const uint8_t *input,
2945 size_t input_length,
2946 uint8_t *signature,
2947 size_t signature_size,
Gilles Peskine449bd832023-01-11 14:50:10 +01002948 size_t *signature_length)
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002949{
2950 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002951
Gilles Peskine449bd832023-01-11 14:50:10 +01002952 if (PSA_ALG_IS_SIGN_HASH(alg)) {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002953 size_t hash_length;
2954 uint8_t hash[PSA_HASH_MAX_SIZE];
2955
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002956 status = psa_driver_wrapper_hash_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01002957 PSA_ALG_SIGN_GET_HASH(alg),
2958 input, input_length,
2959 hash, sizeof(hash), &hash_length);
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002960
Gilles Peskine449bd832023-01-11 14:50:10 +01002961 if (status != PSA_SUCCESS) {
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002962 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002963 }
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002964
2965 return psa_driver_wrapper_sign_hash(
Gilles Peskine449bd832023-01-11 14:50:10 +01002966 attributes, key_buffer, key_buffer_size,
2967 alg, hash, hash_length,
2968 signature, signature_size, signature_length);
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002969 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002970
Gilles Peskine449bd832023-01-11 14:50:10 +01002971 return PSA_ERROR_NOT_SUPPORTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002972}
2973
Gilles Peskine449bd832023-01-11 14:50:10 +01002974psa_status_t psa_sign_message(mbedtls_svc_key_id_t key,
2975 psa_algorithm_t alg,
2976 const uint8_t *input,
2977 size_t input_length,
2978 uint8_t *signature,
2979 size_t signature_size,
2980 size_t *signature_length)
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002981{
2982 return psa_sign_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002983 key, 1, alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002984 signature, signature_size, signature_length);
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002985}
2986
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002987psa_status_t psa_verify_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002988 const psa_key_attributes_t *attributes,
2989 const uint8_t *key_buffer,
2990 size_t key_buffer_size,
2991 psa_algorithm_t alg,
2992 const uint8_t *input,
2993 size_t input_length,
2994 const uint8_t *signature,
Gilles Peskine449bd832023-01-11 14:50:10 +01002995 size_t signature_length)
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002996{
2997 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002998
Gilles Peskine449bd832023-01-11 14:50:10 +01002999 if (PSA_ALG_IS_SIGN_HASH(alg)) {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02003000 size_t hash_length;
3001 uint8_t hash[PSA_HASH_MAX_SIZE];
3002
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003003 status = psa_driver_wrapper_hash_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01003004 PSA_ALG_SIGN_GET_HASH(alg),
3005 input, input_length,
3006 hash, sizeof(hash), &hash_length);
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003007
Gilles Peskine449bd832023-01-11 14:50:10 +01003008 if (status != PSA_SUCCESS) {
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003009 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01003010 }
gabor-mezei-armf9820f92021-05-03 16:26:20 +02003011
3012 return psa_driver_wrapper_verify_hash(
Gilles Peskine449bd832023-01-11 14:50:10 +01003013 attributes, key_buffer, key_buffer_size,
3014 alg, hash, hash_length,
3015 signature, signature_length);
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003016 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003017
Gilles Peskine449bd832023-01-11 14:50:10 +01003018 return PSA_ERROR_NOT_SUPPORTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003019}
3020
Gilles Peskine449bd832023-01-11 14:50:10 +01003021psa_status_t psa_verify_message(mbedtls_svc_key_id_t key,
3022 psa_algorithm_t alg,
3023 const uint8_t *input,
3024 size_t input_length,
3025 const uint8_t *signature,
3026 size_t signature_length)
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003027{
3028 return psa_verify_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02003029 key, 1, alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003030 signature, signature_length);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003031}
3032
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02003033psa_status_t psa_sign_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01003034 const psa_key_attributes_t *attributes,
3035 const uint8_t *key_buffer, size_t key_buffer_size,
3036 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003037 uint8_t *signature, size_t signature_size, size_t *signature_length)
Gilles Peskinee59236f2018-01-27 23:32:46 +01003038{
Gilles Peskine449bd832023-01-11 14:50:10 +01003039 if (attributes->core.type == PSA_KEY_TYPE_RSA_KEY_PAIR) {
3040 if (PSA_ALG_IS_RSA_PKCS1V15_SIGN(alg) ||
3041 PSA_ALG_IS_RSA_PSS(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003042#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003043 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
3044 return mbedtls_psa_rsa_sign_hash(
3045 attributes,
3046 key_buffer, key_buffer_size,
3047 alg, hash, hash_length,
3048 signature, signature_size, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01003049#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
3050 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003051 } else {
3052 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanacda8342020-07-24 23:09:52 +02003053 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003054 } else if (PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3055 if (PSA_ALG_IS_ECDSA(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003056#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003057 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3058 return mbedtls_psa_ecdsa_sign_hash(
3059 attributes,
3060 key_buffer, key_buffer_size,
3061 alg, hash, hash_length,
3062 signature, signature_size, signature_length);
Gilles Peskinee59236f2018-01-27 23:32:46 +01003063#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3064 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003065 } else {
3066 return PSA_ERROR_INVALID_ARGUMENT;
Ronald Cron4501c982021-03-19 20:09:32 +01003067 }
Ronald Cron8a494f32021-02-17 09:49:51 +01003068 }
Ronald Cron4501c982021-03-19 20:09:32 +01003069
Gilles Peskine449bd832023-01-11 14:50:10 +01003070 (void) key_buffer;
3071 (void) key_buffer_size;
3072 (void) hash;
3073 (void) hash_length;
3074 (void) signature;
3075 (void) signature_size;
3076 (void) signature_length;
Ronald Cron4501c982021-03-19 20:09:32 +01003077
Gilles Peskine449bd832023-01-11 14:50:10 +01003078 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron18659932020-12-08 16:32:23 +01003079}
Gilles Peskinee59236f2018-01-27 23:32:46 +01003080
Gilles Peskine449bd832023-01-11 14:50:10 +01003081psa_status_t psa_sign_hash(mbedtls_svc_key_id_t key,
3082 psa_algorithm_t alg,
3083 const uint8_t *hash,
3084 size_t hash_length,
3085 uint8_t *signature,
3086 size_t signature_size,
3087 size_t *signature_length)
Gilles Peskinee59236f2018-01-27 23:32:46 +01003088{
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003089 return psa_sign_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02003090 key, 0, alg, hash, hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003091 signature, signature_size, signature_length);
itayzafrir5c753392018-05-08 11:18:38 +03003092}
3093
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02003094psa_status_t psa_verify_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01003095 const psa_key_attributes_t *attributes,
3096 const uint8_t *key_buffer, size_t key_buffer_size,
3097 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003098 const uint8_t *signature, size_t signature_length)
itayzafrir5c753392018-05-08 11:18:38 +03003099{
Gilles Peskine449bd832023-01-11 14:50:10 +01003100 if (PSA_KEY_TYPE_IS_RSA(attributes->core.type)) {
3101 if (PSA_ALG_IS_RSA_PKCS1V15_SIGN(alg) ||
3102 PSA_ALG_IS_RSA_PSS(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003103#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003104 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
3105 return mbedtls_psa_rsa_verify_hash(
3106 attributes,
3107 key_buffer, key_buffer_size,
3108 alg, hash, hash_length,
3109 signature, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01003110#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
3111 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003112 } else {
3113 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanacda8342020-07-24 23:09:52 +02003114 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003115 } else if (PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3116 if (PSA_ALG_IS_ECDSA(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003117#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003118 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3119 return mbedtls_psa_ecdsa_verify_hash(
3120 attributes,
3121 key_buffer, key_buffer_size,
3122 alg, hash, hash_length,
3123 signature, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01003124#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3125 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003126 } else {
3127 return PSA_ERROR_INVALID_ARGUMENT;
Ronald Cron4501c982021-03-19 20:09:32 +01003128 }
Ronald Cron8a494f32021-02-17 09:49:51 +01003129 }
Ronald Cron4501c982021-03-19 20:09:32 +01003130
Gilles Peskine449bd832023-01-11 14:50:10 +01003131 (void) key_buffer;
3132 (void) key_buffer_size;
3133 (void) hash;
3134 (void) hash_length;
3135 (void) signature;
3136 (void) signature_length;
Ronald Cron4501c982021-03-19 20:09:32 +01003137
Gilles Peskine449bd832023-01-11 14:50:10 +01003138 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron18659932020-12-08 16:32:23 +01003139}
3140
Gilles Peskine449bd832023-01-11 14:50:10 +01003141psa_status_t psa_verify_hash(mbedtls_svc_key_id_t key,
3142 psa_algorithm_t alg,
3143 const uint8_t *hash,
3144 size_t hash_length,
3145 const uint8_t *signature,
3146 size_t signature_length)
itayzafrir5c753392018-05-08 11:18:38 +03003147{
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003148 return psa_verify_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02003149 key, 0, alg, hash, hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003150 signature, signature_length);
Gilles Peskinee59236f2018-01-27 23:32:46 +01003151}
3152
Gilles Peskine449bd832023-01-11 14:50:10 +01003153psa_status_t psa_asymmetric_encrypt(mbedtls_svc_key_id_t key,
3154 psa_algorithm_t alg,
3155 const uint8_t *input,
3156 size_t input_length,
3157 const uint8_t *salt,
3158 size_t salt_length,
3159 uint8_t *output,
3160 size_t output_size,
3161 size_t *output_length)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003162{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003163 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003164 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003165 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003166 psa_key_attributes_t attributes;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003167
Darryl Green5cc689a2018-07-24 15:34:10 +01003168 (void) input;
3169 (void) input_length;
3170 (void) salt;
3171 (void) output;
3172 (void) output_size;
3173
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003174 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003175
Gilles Peskine449bd832023-01-11 14:50:10 +01003176 if (!PSA_ALG_IS_RSA_OAEP(alg) && salt_length != 0) {
3177 return PSA_ERROR_INVALID_ARGUMENT;
3178 }
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003179
Valerio Setti5bb454a2024-01-15 10:43:16 +01003180 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01003181 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg);
3182 if (status != PSA_SUCCESS) {
3183 return status;
3184 }
3185 if (!(PSA_KEY_TYPE_IS_PUBLIC_KEY(slot->attr.type) ||
3186 PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type))) {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003187 status = PSA_ERROR_INVALID_ARGUMENT;
3188 goto exit;
3189 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003190
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003191 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01003192 .core = slot->attr
Przemyslaw Stekiel19e61422021-12-09 11:09:11 +01003193 };
Steven Cooremana2371e52020-07-28 14:30:39 +02003194
Przemyslaw Stekiel19e61422021-12-09 11:09:11 +01003195 status = psa_driver_wrapper_asymmetric_encrypt(
3196 &attributes, slot->key.data, slot->key.bytes,
3197 alg, input, input_length, salt, salt_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003198 output, output_size, output_length);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003199exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00003200 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003201
Gilles Peskine449bd832023-01-11 14:50:10 +01003202 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003203}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003204
Gilles Peskine449bd832023-01-11 14:50:10 +01003205psa_status_t psa_asymmetric_decrypt(mbedtls_svc_key_id_t key,
3206 psa_algorithm_t alg,
3207 const uint8_t *input,
3208 size_t input_length,
3209 const uint8_t *salt,
3210 size_t salt_length,
3211 uint8_t *output,
3212 size_t output_size,
3213 size_t *output_length)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003214{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003215 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003216 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003217 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003218 psa_key_attributes_t attributes;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003219
Darryl Green5cc689a2018-07-24 15:34:10 +01003220 (void) input;
3221 (void) input_length;
3222 (void) salt;
3223 (void) output;
3224 (void) output_size;
3225
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003226 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003227
Gilles Peskine449bd832023-01-11 14:50:10 +01003228 if (!PSA_ALG_IS_RSA_OAEP(alg) && salt_length != 0) {
3229 return PSA_ERROR_INVALID_ARGUMENT;
3230 }
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003231
Valerio Setti5bb454a2024-01-15 10:43:16 +01003232 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01003233 key, &slot, PSA_KEY_USAGE_DECRYPT, alg);
3234 if (status != PSA_SUCCESS) {
3235 return status;
3236 }
3237 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003238 status = PSA_ERROR_INVALID_ARGUMENT;
3239 goto exit;
3240 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003241
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003242 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01003243 .core = slot->attr
Przemyslaw Stekiel8d45c002021-12-13 08:58:19 +01003244 };
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003245
Przemyslaw Stekiel8d45c002021-12-13 08:58:19 +01003246 status = psa_driver_wrapper_asymmetric_decrypt(
3247 &attributes, slot->key.data, slot->key.bytes,
3248 alg, input, input_length, salt, salt_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003249 output, output_size, output_length);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003250
3251exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00003252 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003253
Gilles Peskine449bd832023-01-11 14:50:10 +01003254 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003255}
Gilles Peskinee59236f2018-01-27 23:32:46 +01003256
Paul Elliott9fe12f62022-11-30 19:16:02 +00003257/****************************************************************/
3258/* Asymmetric interruptible cryptography */
3259/****************************************************************/
3260
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003261static uint32_t psa_interruptible_max_ops = PSA_INTERRUPTIBLE_MAX_OPS_UNLIMITED;
3262
Paul Elliott9fe12f62022-11-30 19:16:02 +00003263void psa_interruptible_set_max_ops(uint32_t max_ops)
3264{
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003265 psa_interruptible_max_ops = max_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003266}
3267
3268uint32_t psa_interruptible_get_max_ops(void)
3269{
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003270 return psa_interruptible_max_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003271}
3272
Paul Elliott9fe12f62022-11-30 19:16:02 +00003273uint32_t psa_sign_hash_get_num_ops(
3274 const psa_sign_hash_interruptible_operation_t *operation)
3275{
Paul Elliott296ede92022-12-15 17:00:30 +00003276 return operation->num_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003277}
3278
3279uint32_t psa_verify_hash_get_num_ops(
3280 const psa_verify_hash_interruptible_operation_t *operation)
3281{
Paul Elliott296ede92022-12-15 17:00:30 +00003282 return operation->num_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003283}
3284
Paul Elliott59ad9452022-12-18 15:09:02 +00003285static psa_status_t psa_sign_hash_abort_internal(
3286 psa_sign_hash_interruptible_operation_t *operation)
3287{
3288 if (operation->id == 0) {
3289 /* The object has (apparently) been initialized but it is not (yet)
3290 * in use. It's ok to call abort on such an object, and there's
3291 * nothing to do. */
3292 return PSA_SUCCESS;
3293 }
3294
3295 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3296
3297 status = psa_driver_wrapper_sign_hash_abort(operation);
3298
3299 operation->id = 0;
3300
Paul Elliotte6145dc2023-02-07 12:51:21 +00003301 /* Do not clear either the error_occurred or num_ops elements here as they
3302 * only want to be cleared by the application calling abort, not by abort
3303 * being called at completion of an operation. */
3304
Paul Elliott59ad9452022-12-18 15:09:02 +00003305 return status;
3306}
3307
Paul Elliott9fe12f62022-11-30 19:16:02 +00003308psa_status_t psa_sign_hash_start(
3309 psa_sign_hash_interruptible_operation_t *operation,
3310 mbedtls_svc_key_id_t key, psa_algorithm_t alg,
3311 const uint8_t *hash, size_t hash_length)
3312{
3313 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3314 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3315 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003316 psa_key_attributes_t attributes;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003317
Paul Elliottc9774412023-02-06 15:14:07 +00003318 /* Check that start has not been previously called, or operation has not
3319 * previously errored. */
3320 if (operation->id != 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003321 return PSA_ERROR_BAD_STATE;
3322 }
3323
Paul Elliott9fe12f62022-11-30 19:16:02 +00003324 status = psa_sign_verify_check_alg(0, alg);
3325 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003326 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003327 return status;
3328 }
3329
3330 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
3331 PSA_KEY_USAGE_SIGN_HASH,
3332 alg);
3333
3334 if (status != PSA_SUCCESS) {
3335 goto exit;
3336 }
3337
3338 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
3339 status = PSA_ERROR_INVALID_ARGUMENT;
3340 goto exit;
3341 }
3342
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003343 attributes = (psa_key_attributes_t) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003344 .core = slot->attr
3345 };
3346
Paul Elliott296ede92022-12-15 17:00:30 +00003347 /* Ensure ops count gets reset, in case of operation re-use. */
3348 operation->num_ops = 0;
3349
Paul Elliott9fe12f62022-11-30 19:16:02 +00003350 status = psa_driver_wrapper_sign_hash_start(operation, &attributes,
3351 slot->key.data,
3352 slot->key.bytes, alg,
3353 hash, hash_length);
3354exit:
3355
3356 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003357 operation->error_occurred = 1;
Paul Elliott59ad9452022-12-18 15:09:02 +00003358 psa_sign_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003359 }
3360
Ryan Everett1b70a072024-01-04 10:32:49 +00003361 unlock_status = psa_unregister_read(slot);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003362
Paul Elliottc9774412023-02-06 15:14:07 +00003363 if (unlock_status != PSA_SUCCESS) {
3364 operation->error_occurred = 1;
3365 }
Paul Elliott9fe12f62022-11-30 19:16:02 +00003366
Paul Elliottc9774412023-02-06 15:14:07 +00003367 return (status == PSA_SUCCESS) ? unlock_status : status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003368}
3369
3370
3371psa_status_t psa_sign_hash_complete(
3372 psa_sign_hash_interruptible_operation_t *operation,
3373 uint8_t *signature, size_t signature_size,
3374 size_t *signature_length)
3375{
3376 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3377
3378 *signature_length = 0;
3379
Paul Elliottc9774412023-02-06 15:14:07 +00003380 /* Check that start has been called first, and that operation has not
3381 * previously errored. */
3382 if (operation->id == 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003383 status = PSA_ERROR_BAD_STATE;
3384 goto exit;
3385 }
3386
Paul Elliott096abc42023-02-03 18:33:23 +00003387 /* Immediately reject a zero-length signature buffer. This guarantees that
3388 * signature must be a valid pointer. */
Paul Elliott9fe12f62022-11-30 19:16:02 +00003389 if (signature_size == 0) {
3390 status = PSA_ERROR_BUFFER_TOO_SMALL;
3391 goto exit;
3392 }
3393
3394 status = psa_driver_wrapper_sign_hash_complete(operation, signature,
3395 signature_size,
3396 signature_length);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003397
Paul Elliott296ede92022-12-15 17:00:30 +00003398 /* Update ops count with work done. */
Paul Elliottde1114c2023-02-07 12:43:11 +00003399 operation->num_ops = psa_driver_wrapper_sign_hash_get_num_ops(operation);
Paul Elliott296ede92022-12-15 17:00:30 +00003400
Paul Elliottebe225c2023-02-10 14:32:53 +00003401exit:
3402
Paul Elliott59200a22023-02-21 15:07:40 +00003403 psa_wipe_tag_output_buffer(signature, status, signature_size,
3404 *signature_length);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003405
Paul Elliott53bb3122023-02-10 14:22:22 +00003406 if (status != PSA_OPERATION_INCOMPLETE) {
Paul Elliottc9774412023-02-06 15:14:07 +00003407 if (status != PSA_SUCCESS) {
3408 operation->error_occurred = 1;
3409 }
3410
Paul Elliott59ad9452022-12-18 15:09:02 +00003411 psa_sign_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003412 }
3413
3414 return status;
3415}
3416
3417psa_status_t psa_sign_hash_abort(
3418 psa_sign_hash_interruptible_operation_t *operation)
3419{
Paul Elliott59ad9452022-12-18 15:09:02 +00003420 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3421
3422 status = psa_sign_hash_abort_internal(operation);
3423
3424 /* We clear the number of ops done here, so that it is not cleared when
3425 * the operation fails or succeeds, only on manual abort. */
3426 operation->num_ops = 0;
3427
Paul Elliottc9774412023-02-06 15:14:07 +00003428 /* Likewise, failure state. */
3429 operation->error_occurred = 0;
3430
Paul Elliott59ad9452022-12-18 15:09:02 +00003431 return status;
3432}
3433
3434static psa_status_t psa_verify_hash_abort_internal(
3435 psa_verify_hash_interruptible_operation_t *operation)
3436{
Paul Elliott9fe12f62022-11-30 19:16:02 +00003437 if (operation->id == 0) {
3438 /* The object has (apparently) been initialized but it is not (yet)
3439 * in use. It's ok to call abort on such an object, and there's
3440 * nothing to do. */
3441 return PSA_SUCCESS;
3442 }
3443
Paul Elliott59ad9452022-12-18 15:09:02 +00003444 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3445
3446 status = psa_driver_wrapper_verify_hash_abort(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003447
3448 operation->id = 0;
3449
Paul Elliotte6145dc2023-02-07 12:51:21 +00003450 /* Do not clear either the error_occurred or num_ops elements here as they
3451 * only want to be cleared by the application calling abort, not by abort
3452 * being called at completion of an operation. */
3453
Paul Elliott59ad9452022-12-18 15:09:02 +00003454 return status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003455}
3456
3457psa_status_t psa_verify_hash_start(
3458 psa_verify_hash_interruptible_operation_t *operation,
3459 mbedtls_svc_key_id_t key, psa_algorithm_t alg,
3460 const uint8_t *hash, size_t hash_length,
3461 const uint8_t *signature, size_t signature_length)
3462{
3463 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3464 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3465 psa_key_slot_t *slot;
3466
Paul Elliottc9774412023-02-06 15:14:07 +00003467 /* Check that start has not been previously called, or operation has not
3468 * previously errored. */
3469 if (operation->id != 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003470 return PSA_ERROR_BAD_STATE;
3471 }
3472
3473 status = psa_sign_verify_check_alg(0, alg);
3474 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003475 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003476 return status;
3477 }
3478
3479 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
3480 PSA_KEY_USAGE_VERIFY_HASH,
3481 alg);
3482
3483 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003484 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003485 return status;
3486 }
3487
3488 psa_key_attributes_t attributes = {
3489 .core = slot->attr
3490 };
3491
Paul Elliott296ede92022-12-15 17:00:30 +00003492 /* Ensure ops count gets reset, in case of operation re-use. */
3493 operation->num_ops = 0;
3494
Paul Elliott9fe12f62022-11-30 19:16:02 +00003495 status = psa_driver_wrapper_verify_hash_start(operation, &attributes,
3496 slot->key.data,
3497 slot->key.bytes,
3498 alg, hash, hash_length,
3499 signature, signature_length);
3500
3501 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003502 operation->error_occurred = 1;
Paul Elliott59ad9452022-12-18 15:09:02 +00003503 psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003504 }
3505
Ryan Everett1b70a072024-01-04 10:32:49 +00003506 unlock_status = psa_unregister_read(slot);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003507
Paul Elliottc9774412023-02-06 15:14:07 +00003508 if (unlock_status != PSA_SUCCESS) {
3509 operation->error_occurred = 1;
3510 }
Paul Elliott9fe12f62022-11-30 19:16:02 +00003511
Paul Elliottc9774412023-02-06 15:14:07 +00003512 return (status == PSA_SUCCESS) ? unlock_status : status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003513}
3514
3515psa_status_t psa_verify_hash_complete(
3516 psa_verify_hash_interruptible_operation_t *operation)
3517{
3518 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3519
Paul Elliottc9774412023-02-06 15:14:07 +00003520 /* Check that start has been called first, and that operation has not
3521 * previously errored. */
3522 if (operation->id == 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003523 status = PSA_ERROR_BAD_STATE;
3524 goto exit;
3525 }
3526
3527 status = psa_driver_wrapper_verify_hash_complete(operation);
3528
Paul Elliott296ede92022-12-15 17:00:30 +00003529 /* Update ops count with work done. */
Paul Elliottde1114c2023-02-07 12:43:11 +00003530 operation->num_ops = psa_driver_wrapper_verify_hash_get_num_ops(
Paul Elliott296ede92022-12-15 17:00:30 +00003531 operation);
3532
Paul Elliottebe225c2023-02-10 14:32:53 +00003533exit:
3534
Paul Elliott9fe12f62022-11-30 19:16:02 +00003535 if (status != PSA_OPERATION_INCOMPLETE) {
Paul Elliottc9774412023-02-06 15:14:07 +00003536 if (status != PSA_SUCCESS) {
3537 operation->error_occurred = 1;
3538 }
3539
Paul Elliott59ad9452022-12-18 15:09:02 +00003540 psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003541 }
3542
3543 return status;
3544}
3545
3546psa_status_t psa_verify_hash_abort(
3547 psa_verify_hash_interruptible_operation_t *operation)
3548{
Paul Elliott59ad9452022-12-18 15:09:02 +00003549 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003550
Paul Elliott59ad9452022-12-18 15:09:02 +00003551 status = psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003552
Paul Elliott59ad9452022-12-18 15:09:02 +00003553 /* We clear the number of ops done here, so that it is not cleared when
3554 * the operation fails or succeeds, only on manual abort. */
3555 operation->num_ops = 0;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003556
Paul Elliottc9774412023-02-06 15:14:07 +00003557 /* Likewise, failure state. */
3558 operation->error_occurred = 0;
3559
Paul Elliott59ad9452022-12-18 15:09:02 +00003560 return status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003561}
3562
Paul Elliott588f8ed2022-12-02 18:10:26 +00003563/****************************************************************/
3564/* Asymmetric interruptible cryptography internal */
3565/* implementations */
3566/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003567
Paul Elliott588f8ed2022-12-02 18:10:26 +00003568void mbedtls_psa_interruptible_set_max_ops(uint32_t max_ops)
3569{
Paul Elliott7cc4e812023-01-10 17:14:11 +00003570
Paul Elliott588f8ed2022-12-02 18:10:26 +00003571#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3572 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3573 defined(MBEDTLS_ECP_RESTARTABLE)
3574
3575 /* Internal implementation uses zero to indicate infinite number max ops,
3576 * therefore avoid this value, and set to minimum possible. */
3577 if (max_ops == 0) {
3578 max_ops = 1;
3579 }
3580
Paul Elliott588f8ed2022-12-02 18:10:26 +00003581 mbedtls_ecp_set_max_ops(max_ops);
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003582#else
3583 (void) max_ops;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003584#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3585 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3586 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3587}
3588
Paul Elliott588f8ed2022-12-02 18:10:26 +00003589uint32_t mbedtls_psa_sign_hash_get_num_ops(
Paul Elliottf8e5b562023-02-19 18:43:45 +00003590 const mbedtls_psa_sign_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
3605uint32_t mbedtls_psa_verify_hash_get_num_ops(
Paul Elliottf8e5b562023-02-19 18:43:45 +00003606 const mbedtls_psa_verify_hash_interruptible_operation_t *operation)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003607{
3608 #if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3609 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3610 defined(MBEDTLS_ECP_RESTARTABLE)
3611
Paul Elliott93d9ca82023-02-15 18:14:21 +00003612 return operation->num_ops;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003613#else
3614 (void) operation;
3615 return 0;
3616#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3617 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3618 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3619}
3620
3621psa_status_t mbedtls_psa_sign_hash_start(
3622 mbedtls_psa_sign_hash_interruptible_operation_t *operation,
3623 const psa_key_attributes_t *attributes, const uint8_t *key_buffer,
3624 size_t key_buffer_size, psa_algorithm_t alg,
3625 const uint8_t *hash, size_t hash_length)
3626{
3627 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott0290a762023-02-09 14:30:24 +00003628 size_t required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003629
Paul Elliott068fe072023-01-16 13:59:15 +00003630 if (!PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3631 return PSA_ERROR_NOT_SUPPORTED;
3632 }
3633
3634 if (!PSA_ALG_IS_ECDSA(alg)) {
Paul Elliott813f9cd2023-02-05 15:28:46 +00003635 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott068fe072023-01-16 13:59:15 +00003636 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003637
3638#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Paul Elliott068fe072023-01-16 13:59:15 +00003639 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3640 defined(MBEDTLS_ECP_RESTARTABLE)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003641
Paul Elliotta1c94092023-02-15 16:38:04 +00003642 mbedtls_ecdsa_restart_init(&operation->restart_ctx);
3643
Paul Elliott93d9ca82023-02-15 18:14:21 +00003644 /* Ensure num_ops is zero'ed in case of context re-use. */
3645 operation->num_ops = 0;
3646
Paul Elliott068fe072023-01-16 13:59:15 +00003647 status = mbedtls_psa_ecp_load_representation(attributes->core.type,
3648 attributes->core.bits,
3649 key_buffer,
3650 key_buffer_size,
3651 &operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003652
Paul Elliott068fe072023-01-16 13:59:15 +00003653 if (status != PSA_SUCCESS) {
3654 return status;
3655 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003656
Paul Elliott1bc59df2023-02-05 13:41:57 +00003657 operation->coordinate_bytes = PSA_BITS_TO_BYTES(
Paul Elliottc569fc22023-02-10 13:02:54 +00003658 operation->ctx->grp.nbits);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003659
Paul Elliott068fe072023-01-16 13:59:15 +00003660 psa_algorithm_t hash_alg = PSA_ALG_SIGN_GET_HASH(alg);
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02003661 operation->md_alg = mbedtls_md_type_from_psa_alg(hash_alg);
Paul Elliott068fe072023-01-16 13:59:15 +00003662 operation->alg = alg;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003663
Paul Elliott0290a762023-02-09 14:30:24 +00003664 /* We only need to store the same length of hash as the private key size
3665 * here, it would be truncated by the internal implementation anyway. */
3666 required_hash_length = (hash_length < operation->coordinate_bytes ?
3667 hash_length : operation->coordinate_bytes);
3668
Paul Elliottba70ad42023-02-15 18:23:53 +00003669 if (required_hash_length > sizeof(operation->hash)) {
3670 /* Shouldn't happen, but better safe than sorry. */
3671 return PSA_ERROR_CORRUPTION_DETECTED;
3672 }
3673
Paul Elliott0290a762023-02-09 14:30:24 +00003674 memcpy(operation->hash, hash, required_hash_length);
3675 operation->hash_length = required_hash_length;
Paul Elliott068fe072023-01-16 13:59:15 +00003676
3677 return PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003678
3679#else
Paul Elliott068fe072023-01-16 13:59:15 +00003680 (void) operation;
3681 (void) key_buffer;
3682 (void) key_buffer_size;
3683 (void) alg;
3684 (void) hash;
3685 (void) hash_length;
3686 (void) status;
Paul Elliott0290a762023-02-09 14:30:24 +00003687 (void) required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003688
Paul Elliott068fe072023-01-16 13:59:15 +00003689 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003690#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3691 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3692 * defined( MBEDTLS_ECP_RESTARTABLE ) */
Paul Elliott588f8ed2022-12-02 18:10:26 +00003693}
3694
3695psa_status_t mbedtls_psa_sign_hash_complete(
3696 mbedtls_psa_sign_hash_interruptible_operation_t *operation,
3697 uint8_t *signature, size_t signature_size,
3698 size_t *signature_length)
3699{
Paul Elliott588f8ed2022-12-02 18:10:26 +00003700#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3701 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3702 defined(MBEDTLS_ECP_RESTARTABLE)
3703
Paul Elliotta1c94092023-02-15 16:38:04 +00003704 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott1243f932023-02-07 11:21:10 +00003705 mbedtls_mpi r;
3706 mbedtls_mpi s;
3707
Paul Elliott46845252023-02-03 14:59:11 +00003708 mbedtls_mpi_init(&r);
3709 mbedtls_mpi_init(&s);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003710
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003711 /* Ensure max_ops is set to the current value (or default). */
3712 mbedtls_psa_interruptible_set_max_ops(psa_interruptible_get_max_ops());
3713
Paul Elliotta1c94092023-02-15 16:38:04 +00003714 if (signature_size < 2 * operation->coordinate_bytes) {
3715 status = PSA_ERROR_BUFFER_TOO_SMALL;
3716 goto exit;
3717 }
3718
Paul Elliott588f8ed2022-12-02 18:10:26 +00003719 if (PSA_ALG_ECDSA_IS_DETERMINISTIC(operation->alg)) {
Paul Elliott46845252023-02-03 14:59:11 +00003720
Paul Elliott588f8ed2022-12-02 18:10:26 +00003721#if defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3722 status = mbedtls_to_psa_error(
3723 mbedtls_ecdsa_sign_det_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 operation->md_alg,
3730 mbedtls_psa_get_random,
3731 MBEDTLS_PSA_RANDOM_STATE,
3732 &operation->restart_ctx));
3733#else /* defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Paul Elliott724bd252023-02-08 12:35:08 +00003734 status = PSA_ERROR_NOT_SUPPORTED;
3735 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003736#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
3737 } else {
Paul Elliott588f8ed2022-12-02 18:10:26 +00003738 status = mbedtls_to_psa_error(
3739 mbedtls_ecdsa_sign_restartable(&operation->ctx->grp,
Paul Elliott46845252023-02-03 14:59:11 +00003740 &r,
3741 &s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003742 &operation->ctx->d,
3743 operation->hash,
3744 operation->hash_length,
3745 mbedtls_psa_get_random,
3746 MBEDTLS_PSA_RANDOM_STATE,
3747 mbedtls_psa_get_random,
3748 MBEDTLS_PSA_RANDOM_STATE,
3749 &operation->restart_ctx));
3750 }
3751
Paul Elliottf8e5b562023-02-19 18:43:45 +00003752 /* Hide the fact that the restart context only holds a delta of number of
3753 * ops done during the last operation, not an absolute value. */
3754 operation->num_ops += operation->restart_ctx.ecp.ops_done;
3755
Paul Elliott724bd252023-02-08 12:35:08 +00003756 if (status == PSA_SUCCESS) {
Paul Elliott588f8ed2022-12-02 18:10:26 +00003757 status = mbedtls_to_psa_error(
Paul Elliott46845252023-02-03 14:59:11 +00003758 mbedtls_mpi_write_binary(&r,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003759 signature,
Paul Elliott1bc59df2023-02-05 13:41:57 +00003760 operation->coordinate_bytes)
3761 );
Paul Elliott588f8ed2022-12-02 18:10:26 +00003762
3763 if (status != PSA_SUCCESS) {
Paul Elliott724bd252023-02-08 12:35:08 +00003764 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003765 }
3766
3767 status = mbedtls_to_psa_error(
Paul Elliott46845252023-02-03 14:59:11 +00003768 mbedtls_mpi_write_binary(&s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003769 signature +
Paul Elliott1bc59df2023-02-05 13:41:57 +00003770 operation->coordinate_bytes,
3771 operation->coordinate_bytes)
3772 );
Paul Elliott588f8ed2022-12-02 18:10:26 +00003773
3774 if (status != PSA_SUCCESS) {
Paul Elliott724bd252023-02-08 12:35:08 +00003775 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003776 }
3777
Paul Elliott1bc59df2023-02-05 13:41:57 +00003778 *signature_length = operation->coordinate_bytes * 2;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003779
Paul Elliott724bd252023-02-08 12:35:08 +00003780 status = PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003781 }
Paul Elliott724bd252023-02-08 12:35:08 +00003782
3783exit:
3784
3785 mbedtls_mpi_free(&r);
3786 mbedtls_mpi_free(&s);
3787 return status;
3788
Paul Elliott588f8ed2022-12-02 18:10:26 +00003789 #else
3790
3791 (void) operation;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003792 (void) signature;
3793 (void) signature_size;
3794 (void) signature_length;
3795
3796 return PSA_ERROR_NOT_SUPPORTED;
3797
3798#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3799 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3800 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3801}
3802
3803psa_status_t mbedtls_psa_sign_hash_abort(
3804 mbedtls_psa_sign_hash_interruptible_operation_t *operation)
3805{
3806
3807#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3808 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3809 defined(MBEDTLS_ECP_RESTARTABLE)
3810
3811 if (operation->ctx) {
3812 mbedtls_ecdsa_free(operation->ctx);
3813 mbedtls_free(operation->ctx);
Paul Elliottf9c91a72023-02-05 18:06:38 +00003814 operation->ctx = NULL;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003815 }
3816
3817 mbedtls_ecdsa_restart_free(&operation->restart_ctx);
3818
Paul Elliott93d9ca82023-02-15 18:14:21 +00003819 operation->num_ops = 0;
3820
Paul Elliott588f8ed2022-12-02 18:10:26 +00003821 return PSA_SUCCESS;
3822
3823#else
3824
3825 (void) operation;
3826
3827 return PSA_ERROR_NOT_SUPPORTED;
3828
3829#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3830 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3831 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3832}
3833
3834psa_status_t mbedtls_psa_verify_hash_start(
3835 mbedtls_psa_verify_hash_interruptible_operation_t *operation,
3836 const psa_key_attributes_t *attributes,
3837 const uint8_t *key_buffer, size_t key_buffer_size,
3838 psa_algorithm_t alg,
3839 const uint8_t *hash, size_t hash_length,
3840 const uint8_t *signature, size_t signature_length)
3841{
3842 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott1bc59df2023-02-05 13:41:57 +00003843 size_t coordinate_bytes = 0;
Paul Elliott0290a762023-02-09 14:30:24 +00003844 size_t required_hash_length = 0;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003845
Paul Elliott068fe072023-01-16 13:59:15 +00003846 if (!PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3847 return PSA_ERROR_NOT_SUPPORTED;
3848 }
3849
3850 if (!PSA_ALG_IS_ECDSA(alg)) {
Paul Elliott813f9cd2023-02-05 15:28:46 +00003851 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott068fe072023-01-16 13:59:15 +00003852 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003853
3854#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Paul Elliott068fe072023-01-16 13:59:15 +00003855 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3856 defined(MBEDTLS_ECP_RESTARTABLE)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003857
Paul Elliotta1c94092023-02-15 16:38:04 +00003858 mbedtls_ecdsa_restart_init(&operation->restart_ctx);
3859 mbedtls_mpi_init(&operation->r);
3860 mbedtls_mpi_init(&operation->s);
3861
Paul Elliott93d9ca82023-02-15 18:14:21 +00003862 /* Ensure num_ops is zero'ed in case of context re-use. */
3863 operation->num_ops = 0;
3864
Paul Elliott068fe072023-01-16 13:59:15 +00003865 status = mbedtls_psa_ecp_load_representation(attributes->core.type,
3866 attributes->core.bits,
3867 key_buffer,
3868 key_buffer_size,
3869 &operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003870
Paul Elliott068fe072023-01-16 13:59:15 +00003871 if (status != PSA_SUCCESS) {
3872 return status;
3873 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003874
Paul Elliottc569fc22023-02-10 13:02:54 +00003875 coordinate_bytes = PSA_BITS_TO_BYTES(operation->ctx->grp.nbits);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003876
Paul Elliott1bc59df2023-02-05 13:41:57 +00003877 if (signature_length != 2 * coordinate_bytes) {
Paul Elliott068fe072023-01-16 13:59:15 +00003878 return PSA_ERROR_INVALID_SIGNATURE;
3879 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003880
Paul Elliott068fe072023-01-16 13:59:15 +00003881 status = mbedtls_to_psa_error(
3882 mbedtls_mpi_read_binary(&operation->r,
3883 signature,
Paul Elliott1bc59df2023-02-05 13:41:57 +00003884 coordinate_bytes));
Paul Elliott588f8ed2022-12-02 18:10:26 +00003885
Paul Elliott068fe072023-01-16 13:59:15 +00003886 if (status != PSA_SUCCESS) {
3887 return status;
3888 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003889
Paul Elliott068fe072023-01-16 13:59:15 +00003890 status = mbedtls_to_psa_error(
3891 mbedtls_mpi_read_binary(&operation->s,
3892 signature +
Paul Elliott1bc59df2023-02-05 13:41:57 +00003893 coordinate_bytes,
3894 coordinate_bytes));
Paul Elliott588f8ed2022-12-02 18:10:26 +00003895
Paul Elliott068fe072023-01-16 13:59:15 +00003896 if (status != PSA_SUCCESS) {
3897 return status;
3898 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003899
Paul Elliott2c9843f2023-02-15 17:32:42 +00003900 status = mbedtls_psa_ecp_load_public_part(operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003901
Paul Elliott2c9843f2023-02-15 17:32:42 +00003902 if (status != PSA_SUCCESS) {
3903 return status;
Paul Elliott068fe072023-01-16 13:59:15 +00003904 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003905
Paul Elliott0290a762023-02-09 14:30:24 +00003906 /* We only need to store the same length of hash as the private key size
3907 * here, it would be truncated by the internal implementation anyway. */
3908 required_hash_length = (hash_length < coordinate_bytes ? hash_length :
3909 coordinate_bytes);
3910
Paul Elliottba70ad42023-02-15 18:23:53 +00003911 if (required_hash_length > sizeof(operation->hash)) {
3912 /* Shouldn't happen, but better safe than sorry. */
3913 return PSA_ERROR_CORRUPTION_DETECTED;
3914 }
3915
Paul Elliott0290a762023-02-09 14:30:24 +00003916 memcpy(operation->hash, hash, required_hash_length);
3917 operation->hash_length = required_hash_length;
Paul Elliott068fe072023-01-16 13:59:15 +00003918
3919 return PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003920#else
Paul Elliott068fe072023-01-16 13:59:15 +00003921 (void) operation;
3922 (void) key_buffer;
3923 (void) key_buffer_size;
3924 (void) alg;
3925 (void) hash;
3926 (void) hash_length;
3927 (void) signature;
3928 (void) signature_length;
3929 (void) status;
Paul Elliott1243f932023-02-07 11:21:10 +00003930 (void) coordinate_bytes;
Paul Elliott0290a762023-02-09 14:30:24 +00003931 (void) required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003932
Paul Elliott068fe072023-01-16 13:59:15 +00003933 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003934#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3935 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3936 * defined( MBEDTLS_ECP_RESTARTABLE ) */
Paul Elliott588f8ed2022-12-02 18:10:26 +00003937}
3938
3939psa_status_t mbedtls_psa_verify_hash_complete(
3940 mbedtls_psa_verify_hash_interruptible_operation_t *operation)
3941{
3942
3943#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3944 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3945 defined(MBEDTLS_ECP_RESTARTABLE)
3946
Paul Elliottf8e5b562023-02-19 18:43:45 +00003947 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3948
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003949 /* Ensure max_ops is set to the current value (or default). */
3950 mbedtls_psa_interruptible_set_max_ops(psa_interruptible_get_max_ops());
3951
Paul Elliottf8e5b562023-02-19 18:43:45 +00003952 status = mbedtls_to_psa_error(
Paul Elliott588f8ed2022-12-02 18:10:26 +00003953 mbedtls_ecdsa_verify_restartable(&operation->ctx->grp,
3954 operation->hash,
3955 operation->hash_length,
3956 &operation->ctx->Q,
3957 &operation->r,
3958 &operation->s,
3959 &operation->restart_ctx));
3960
Paul Elliottf8e5b562023-02-19 18:43:45 +00003961 /* Hide the fact that the restart context only holds a delta of number of
3962 * ops done during the last operation, not an absolute value. */
3963 operation->num_ops += operation->restart_ctx.ecp.ops_done;
3964
3965 return status;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003966#else
3967 (void) operation;
3968
3969 return PSA_ERROR_NOT_SUPPORTED;
3970
3971#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3972 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3973 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3974}
3975
3976psa_status_t mbedtls_psa_verify_hash_abort(
3977 mbedtls_psa_verify_hash_interruptible_operation_t *operation)
3978{
3979
3980#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3981 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3982 defined(MBEDTLS_ECP_RESTARTABLE)
3983
3984 if (operation->ctx) {
3985 mbedtls_ecdsa_free(operation->ctx);
3986 mbedtls_free(operation->ctx);
Paul Elliottf9c91a72023-02-05 18:06:38 +00003987 operation->ctx = NULL;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003988 }
3989
3990 mbedtls_ecdsa_restart_free(&operation->restart_ctx);
3991
Paul Elliott93d9ca82023-02-15 18:14:21 +00003992 operation->num_ops = 0;
3993
Paul Elliott588f8ed2022-12-02 18:10:26 +00003994 mbedtls_mpi_free(&operation->r);
3995 mbedtls_mpi_free(&operation->s);
3996
3997 return PSA_SUCCESS;
3998
3999#else
4000 (void) operation;
4001
4002 return PSA_ERROR_NOT_SUPPORTED;
4003
4004#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
4005 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
4006 * defined( MBEDTLS_ECP_RESTARTABLE ) */
4007}
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004008
mohammad1603503973b2018-03-12 15:59:30 +02004009/****************************************************************/
4010/* Symmetric cryptography */
4011/****************************************************************/
4012
Gilles Peskine449bd832023-01-11 14:50:10 +01004013static psa_status_t psa_cipher_setup(psa_cipher_operation_t *operation,
4014 mbedtls_svc_key_id_t key,
4015 psa_algorithm_t alg,
4016 mbedtls_operation_t cipher_operation)
Ronald Cronab99ac22020-10-01 16:38:28 +02004017{
4018 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4019 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman54648242021-06-24 11:49:45 +01004020 psa_key_slot_t *slot = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01004021 psa_key_usage_t usage = (cipher_operation == MBEDTLS_ENCRYPT ?
4022 PSA_KEY_USAGE_ENCRYPT :
4023 PSA_KEY_USAGE_DECRYPT);
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004024 psa_key_attributes_t attributes;
Ronald Cronab99ac22020-10-01 16:38:28 +02004025
4026 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004027 if (operation->id != 0) {
Dave Rodgman54648242021-06-24 11:49:45 +01004028 status = PSA_ERROR_BAD_STATE;
4029 goto exit;
4030 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004031
Gilles Peskine449bd832023-01-11 14:50:10 +01004032 if (!PSA_ALG_IS_CIPHER(alg)) {
Dave Rodgman54648242021-06-24 11:49:45 +01004033 status = PSA_ERROR_INVALID_ARGUMENT;
4034 goto exit;
4035 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004036
Gilles Peskine449bd832023-01-11 14:50:10 +01004037 status = psa_get_and_lock_key_slot_with_policy(key, &slot, usage, alg);
4038 if (status != PSA_SUCCESS) {
Ronald Cronab99ac22020-10-01 16:38:28 +02004039 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004040 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004041
Ronald Cron49fafa92021-03-10 08:34:23 +01004042 /* Initialize the operation struct members, except for id. The id member
Ronald Cronab99ac22020-10-01 16:38:28 +02004043 * is used to indicate to psa_cipher_abort that there are resources to free,
Ronald Cron49fafa92021-03-10 08:34:23 +01004044 * so we only set it (in the driver wrapper) after resources have been
4045 * allocated/initialized. */
Ronald Cronab99ac22020-10-01 16:38:28 +02004046 operation->iv_set = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004047 if (alg == PSA_ALG_ECB_NO_PADDING) {
Ronald Cronab99ac22020-10-01 16:38:28 +02004048 operation->iv_required = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004049 } else {
Ronald Cronab99ac22020-10-01 16:38:28 +02004050 operation->iv_required = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004051 }
4052 operation->default_iv_length = PSA_CIPHER_IV_LENGTH(slot->attr.type, alg);
Ronald Cronab99ac22020-10-01 16:38:28 +02004053
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004054 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004055 .core = slot->attr
Ronald Crona4af55f2020-12-14 14:36:06 +01004056 };
4057
Ronald Cronab99ac22020-10-01 16:38:28 +02004058 /* Try doing the operation through a driver before using software fallback. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004059 if (cipher_operation == MBEDTLS_ENCRYPT) {
4060 status = psa_driver_wrapper_cipher_encrypt_setup(operation,
4061 &attributes,
4062 slot->key.data,
4063 slot->key.bytes,
4064 alg);
4065 } else {
4066 status = psa_driver_wrapper_cipher_decrypt_setup(operation,
4067 &attributes,
4068 slot->key.data,
4069 slot->key.bytes,
4070 alg);
4071 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004072
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004073exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004074 if (status != PSA_SUCCESS) {
4075 psa_cipher_abort(operation);
4076 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004077
Ryan Everett1b70a072024-01-04 10:32:49 +00004078 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02004079
Gilles Peskine449bd832023-01-11 14:50:10 +01004080 return (status == PSA_SUCCESS) ? unlock_status : status;
mohammad1603503973b2018-03-12 15:59:30 +02004081}
4082
Gilles Peskine449bd832023-01-11 14:50:10 +01004083psa_status_t psa_cipher_encrypt_setup(psa_cipher_operation_t *operation,
4084 mbedtls_svc_key_id_t key,
4085 psa_algorithm_t alg)
mohammad16038481e742018-03-18 13:57:31 +02004086{
Gilles Peskine449bd832023-01-11 14:50:10 +01004087 return psa_cipher_setup(operation, key, alg, MBEDTLS_ENCRYPT);
mohammad16038481e742018-03-18 13:57:31 +02004088}
4089
Gilles Peskine449bd832023-01-11 14:50:10 +01004090psa_status_t psa_cipher_decrypt_setup(psa_cipher_operation_t *operation,
4091 mbedtls_svc_key_id_t key,
4092 psa_algorithm_t alg)
mohammad16038481e742018-03-18 13:57:31 +02004093{
Gilles Peskine449bd832023-01-11 14:50:10 +01004094 return psa_cipher_setup(operation, key, alg, MBEDTLS_DECRYPT);
mohammad16038481e742018-03-18 13:57:31 +02004095}
4096
Gilles Peskine449bd832023-01-11 14:50:10 +01004097psa_status_t psa_cipher_generate_iv(psa_cipher_operation_t *operation,
4098 uint8_t *iv,
4099 size_t iv_size,
4100 size_t *iv_length)
mohammad1603503973b2018-03-12 15:59:30 +02004101{
Ronald Cron6d051732020-10-01 14:10:20 +02004102 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2fb90522021-07-05 12:31:44 +02004103 uint8_t local_iv[PSA_CIPHER_IV_MAX_SIZE];
Sergeybef1f632023-03-06 15:25:06 -07004104 size_t default_iv_length = 0;
Ronald Cron5618a392021-03-26 09:52:26 +01004105
Gilles Peskine449bd832023-01-11 14:50:10 +01004106 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004107 status = PSA_ERROR_BAD_STATE;
4108 goto exit;
Ronald Cronc45b4af2020-09-29 16:18:05 +02004109 }
4110
Gilles Peskine449bd832023-01-11 14:50:10 +01004111 if (operation->iv_set || !operation->iv_required) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004112 status = PSA_ERROR_BAD_STATE;
4113 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004114 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004115
Ronald Cron2fb90522021-07-05 12:31:44 +02004116 default_iv_length = operation->default_iv_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01004117 if (iv_size < default_iv_length) {
Ronald Cron5618a392021-03-26 09:52:26 +01004118 status = PSA_ERROR_BUFFER_TOO_SMALL;
4119 goto exit;
4120 }
Gilles Peskinee553c652018-06-04 16:22:46 +02004121
Gilles Peskine449bd832023-01-11 14:50:10 +01004122 if (default_iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Ronald Cron2fb90522021-07-05 12:31:44 +02004123 status = PSA_ERROR_GENERIC_ERROR;
4124 goto exit;
4125 }
4126
Gilles Peskine449bd832023-01-11 14:50:10 +01004127 status = psa_generate_random(local_iv, default_iv_length);
4128 if (status != PSA_SUCCESS) {
Ronald Cron5618a392021-03-26 09:52:26 +01004129 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004130 }
Ronald Cron5618a392021-03-26 09:52:26 +01004131
Gilles Peskine449bd832023-01-11 14:50:10 +01004132 status = psa_driver_wrapper_cipher_set_iv(operation,
4133 local_iv, default_iv_length);
Ronald Cron5618a392021-03-26 09:52:26 +01004134
4135exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004136 if (status == PSA_SUCCESS) {
4137 memcpy(iv, local_iv, default_iv_length);
Ronald Cron2fb90522021-07-05 12:31:44 +02004138 *iv_length = default_iv_length;
Steven Cooreman7df02922020-09-09 15:28:49 +02004139 operation->iv_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004140 } else {
Ronald Cron2fb90522021-07-05 12:31:44 +02004141 *iv_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004142 psa_cipher_abort(operation);
Ronald Cron2fb90522021-07-05 12:31:44 +02004143 }
Ronald Cron6d051732020-10-01 14:10:20 +02004144
Gilles Peskine449bd832023-01-11 14:50:10 +01004145 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004146}
4147
Gilles Peskine449bd832023-01-11 14:50:10 +01004148psa_status_t psa_cipher_set_iv(psa_cipher_operation_t *operation,
4149 const uint8_t *iv,
4150 size_t iv_length)
mohammad1603503973b2018-03-12 15:59:30 +02004151{
Ronald Cron6d051732020-10-01 14:10:20 +02004152 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronc45b4af2020-09-29 16:18:05 +02004153
Gilles Peskine449bd832023-01-11 14:50:10 +01004154 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004155 status = PSA_ERROR_BAD_STATE;
4156 goto exit;
4157 }
Ronald Cronc45b4af2020-09-29 16:18:05 +02004158
Gilles Peskine449bd832023-01-11 14:50:10 +01004159 if (operation->iv_set || !operation->iv_required) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004160 status = PSA_ERROR_BAD_STATE;
4161 goto exit;
4162 }
Ronald Crona0d68172021-03-26 10:15:08 +01004163
Gilles Peskine449bd832023-01-11 14:50:10 +01004164 if (iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004165 status = PSA_ERROR_INVALID_ARGUMENT;
4166 goto exit;
4167 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004168
Gilles Peskine449bd832023-01-11 14:50:10 +01004169 status = psa_driver_wrapper_cipher_set_iv(operation,
4170 iv,
4171 iv_length);
Steven Cooremand3feccd2020-09-01 15:56:14 +02004172
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004173exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004174 if (status == PSA_SUCCESS) {
itayzafrir534bd7c2018-08-02 13:56:32 +03004175 operation->iv_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004176 } else {
4177 psa_cipher_abort(operation);
4178 }
4179 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004180}
4181
Gilles Peskine449bd832023-01-11 14:50:10 +01004182psa_status_t psa_cipher_update(psa_cipher_operation_t *operation,
4183 const uint8_t *input,
4184 size_t input_length,
4185 uint8_t *output,
4186 size_t output_size,
4187 size_t *output_length)
mohammad1603503973b2018-03-12 15:59:30 +02004188{
Steven Cooremanffecb7b2020-08-25 15:13:13 +02004189 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron6d051732020-10-01 14:10:20 +02004190
Gilles Peskine449bd832023-01-11 14:50:10 +01004191 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004192 status = PSA_ERROR_BAD_STATE;
4193 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004194 }
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004195
Gilles Peskine449bd832023-01-11 14:50:10 +01004196 if (operation->iv_required && !operation->iv_set) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004197 status = PSA_ERROR_BAD_STATE;
4198 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004199 }
Jaeden Ameroab439972019-02-15 14:12:05 +00004200
Gilles Peskine449bd832023-01-11 14:50:10 +01004201 status = psa_driver_wrapper_cipher_update(operation,
4202 input,
4203 input_length,
4204 output,
4205 output_size,
4206 output_length);
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004207
4208exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004209 if (status != PSA_SUCCESS) {
4210 psa_cipher_abort(operation);
4211 }
Ronald Cron6d051732020-10-01 14:10:20 +02004212
Gilles Peskine449bd832023-01-11 14:50:10 +01004213 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004214}
4215
Gilles Peskine449bd832023-01-11 14:50:10 +01004216psa_status_t psa_cipher_finish(psa_cipher_operation_t *operation,
4217 uint8_t *output,
4218 size_t output_size,
4219 size_t *output_length)
mohammad1603503973b2018-03-12 15:59:30 +02004220{
David Saadab4ecc272019-02-14 13:48:10 +02004221 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Ronald Cron6d051732020-10-01 14:10:20 +02004222
Gilles Peskine449bd832023-01-11 14:50:10 +01004223 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004224 status = PSA_ERROR_BAD_STATE;
4225 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004226 }
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004227
Gilles Peskine449bd832023-01-11 14:50:10 +01004228 if (operation->iv_required && !operation->iv_set) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004229 status = PSA_ERROR_BAD_STATE;
4230 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004231 }
Moran Pekerbed71a22018-04-22 20:19:20 +03004232
Gilles Peskine449bd832023-01-11 14:50:10 +01004233 status = psa_driver_wrapper_cipher_finish(operation,
4234 output,
4235 output_size,
4236 output_length);
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004237
4238exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004239 if (status == PSA_SUCCESS) {
4240 return psa_cipher_abort(operation);
4241 } else {
Steven Cooremanef8575e2020-09-11 11:44:50 +02004242 *output_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004243 (void) psa_cipher_abort(operation);
Janos Follath315b51c2018-07-09 16:04:51 +01004244
Gilles Peskine449bd832023-01-11 14:50:10 +01004245 return status;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004246 }
mohammad1603503973b2018-03-12 15:59:30 +02004247}
4248
Gilles Peskine449bd832023-01-11 14:50:10 +01004249psa_status_t psa_cipher_abort(psa_cipher_operation_t *operation)
Gilles Peskinee553c652018-06-04 16:22:46 +02004250{
Gilles Peskine449bd832023-01-11 14:50:10 +01004251 if (operation->id == 0) {
Steven Cooremana07b9972020-09-10 14:54:14 +02004252 /* The object has (apparently) been initialized but it is not (yet)
Gilles Peskine81736312018-06-26 15:04:31 +02004253 * in use. It's ok to call abort on such an object, and there's
4254 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004255 return PSA_SUCCESS;
Gilles Peskine81736312018-06-26 15:04:31 +02004256 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004257
Gilles Peskine449bd832023-01-11 14:50:10 +01004258 psa_driver_wrapper_cipher_abort(operation);
Gilles Peskinee553c652018-06-04 16:22:46 +02004259
Ronald Cron49fafa92021-03-10 08:34:23 +01004260 operation->id = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004261 operation->iv_set = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004262 operation->iv_required = 0;
Moran Peker41deec42018-04-04 15:43:05 +03004263
Gilles Peskine449bd832023-01-11 14:50:10 +01004264 return PSA_SUCCESS;
mohammad1603503973b2018-03-12 15:59:30 +02004265}
4266
Gilles Peskine449bd832023-01-11 14:50:10 +01004267psa_status_t psa_cipher_encrypt(mbedtls_svc_key_id_t key,
4268 psa_algorithm_t alg,
4269 const uint8_t *input,
4270 size_t input_length,
4271 uint8_t *output,
4272 size_t output_size,
4273 size_t *output_length)
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004274{
4275 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004276 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron23919522021-07-08 19:00:07 +02004277 psa_key_slot_t *slot = NULL;
Ronald Cronc6e6f502021-07-09 18:44:58 +02004278 uint8_t local_iv[PSA_CIPHER_IV_MAX_SIZE];
4279 size_t default_iv_length = 0;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004280 psa_key_attributes_t attributes;
gabor-mezei-arm6f4e5bb2021-06-25 15:21:11 +02004281
Gilles Peskine449bd832023-01-11 14:50:10 +01004282 if (!PSA_ALG_IS_CIPHER(alg)) {
Ronald Cron23919522021-07-08 19:00:07 +02004283 status = PSA_ERROR_INVALID_ARGUMENT;
4284 goto exit;
4285 }
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004286
Gilles Peskine449bd832023-01-11 14:50:10 +01004287 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
4288 PSA_KEY_USAGE_ENCRYPT,
4289 alg);
4290 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004291 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004292 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004293
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004294 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004295 .core = slot->attr
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004296 };
4297
Gilles Peskine449bd832023-01-11 14:50:10 +01004298 default_iv_length = PSA_CIPHER_IV_LENGTH(slot->attr.type, alg);
4299 if (default_iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Ronald Cronc6e6f502021-07-09 18:44:58 +02004300 status = PSA_ERROR_GENERIC_ERROR;
4301 goto exit;
4302 }
4303
Gilles Peskine449bd832023-01-11 14:50:10 +01004304 if (default_iv_length > 0) {
4305 if (output_size < default_iv_length) {
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004306 status = PSA_ERROR_BUFFER_TOO_SMALL;
4307 goto exit;
4308 }
4309
Gilles Peskine449bd832023-01-11 14:50:10 +01004310 status = psa_generate_random(local_iv, default_iv_length);
4311 if (status != PSA_SUCCESS) {
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004312 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004313 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004314 }
4315
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004316 status = psa_driver_wrapper_cipher_encrypt(
4317 &attributes, slot->key.data, slot->key.bytes,
Ronald Cronc6e6f502021-07-09 18:44:58 +02004318 alg, local_iv, default_iv_length, input, input_length,
Ronald Cronafbc7ed2023-01-24 16:02:04 +01004319 psa_crypto_buffer_offset(output, default_iv_length),
Gilles Peskine449bd832023-01-11 14:50:10 +01004320 output_size - default_iv_length, output_length);
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004321
4322exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00004323 unlock_status = psa_unregister_read(slot);
Gilles Peskine449bd832023-01-11 14:50:10 +01004324 if (status == PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004325 status = unlock_status;
Ronald Cronc6e6f502021-07-09 18:44:58 +02004326 }
Ronald Cron23919522021-07-08 19:00:07 +02004327
Gilles Peskine449bd832023-01-11 14:50:10 +01004328 if (status == PSA_SUCCESS) {
4329 if (default_iv_length > 0) {
4330 memcpy(output, local_iv, default_iv_length);
4331 }
4332 *output_length += default_iv_length;
4333 } else {
4334 *output_length = 0;
4335 }
4336
4337 return status;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004338}
4339
Gilles Peskine449bd832023-01-11 14:50:10 +01004340psa_status_t psa_cipher_decrypt(mbedtls_svc_key_id_t key,
4341 psa_algorithm_t alg,
4342 const uint8_t *input,
4343 size_t input_length,
4344 uint8_t *output,
4345 size_t output_size,
4346 size_t *output_length)
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004347{
4348 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004349 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron23919522021-07-08 19:00:07 +02004350 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004351 psa_key_attributes_t attributes;
gabor-mezei-arm6f4e5bb2021-06-25 15:21:11 +02004352
Gilles Peskine449bd832023-01-11 14:50:10 +01004353 if (!PSA_ALG_IS_CIPHER(alg)) {
Ronald Cron23919522021-07-08 19:00:07 +02004354 status = PSA_ERROR_INVALID_ARGUMENT;
4355 goto exit;
4356 }
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004357
Gilles Peskine449bd832023-01-11 14:50:10 +01004358 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
4359 PSA_KEY_USAGE_DECRYPT,
4360 alg);
4361 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004362 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004363 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004364
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004365 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004366 .core = slot->attr
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004367 };
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004368
Gilles Peskine449bd832023-01-11 14:50:10 +01004369 if (alg == PSA_ALG_CCM_STAR_NO_TAG &&
4370 input_length < PSA_BLOCK_CIPHER_BLOCK_LENGTH(slot->attr.type)) {
Mateusz Starzyk594215b2021-10-14 12:23:06 +02004371 status = PSA_ERROR_INVALID_ARGUMENT;
4372 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004373 } else if (input_length < PSA_CIPHER_IV_LENGTH(slot->attr.type, alg)) {
gabor-mezei-arm258ae072021-06-25 15:25:38 +02004374 status = PSA_ERROR_INVALID_ARGUMENT;
4375 goto exit;
4376 }
4377
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004378 status = psa_driver_wrapper_cipher_decrypt(
4379 &attributes, slot->key.data, slot->key.bytes,
4380 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004381 output, output_size, output_length);
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004382
gabor-mezei-arm258ae072021-06-25 15:25:38 +02004383exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00004384 unlock_status = psa_unregister_read(slot);
Gilles Peskine449bd832023-01-11 14:50:10 +01004385 if (status == PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004386 status = unlock_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01004387 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004388
Gilles Peskine449bd832023-01-11 14:50:10 +01004389 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004390 *output_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004391 }
Ronald Cron23919522021-07-08 19:00:07 +02004392
Gilles Peskine449bd832023-01-11 14:50:10 +01004393 return status;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004394}
4395
4396
mohammad16035955c982018-04-26 00:53:03 +03004397/****************************************************************/
4398/* AEAD */
4399/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004400
Paul Elliottbaff51c2021-09-28 17:44:45 +01004401/* Helper function to get the base algorithm from its variants. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004402static psa_algorithm_t psa_aead_get_base_algorithm(psa_algorithm_t alg)
Paul Elliottbaff51c2021-09-28 17:44:45 +01004403{
Gilles Peskine449bd832023-01-11 14:50:10 +01004404 return PSA_ALG_AEAD_WITH_DEFAULT_LENGTH_TAG(alg);
Paul Elliottbaff51c2021-09-28 17:44:45 +01004405}
4406
4407/* Helper function to perform common nonce length checks. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004408static psa_status_t psa_aead_check_nonce_length(psa_algorithm_t alg,
4409 size_t nonce_length)
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004410{
Gilles Peskine449bd832023-01-11 14:50:10 +01004411 psa_algorithm_t base_alg = psa_aead_get_base_algorithm(alg);
Paul Elliottbaff51c2021-09-28 17:44:45 +01004412
Gilles Peskine449bd832023-01-11 14:50:10 +01004413 switch (base_alg) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004414#if defined(PSA_WANT_ALG_GCM)
4415 case PSA_ALG_GCM:
4416 /* Not checking max nonce size here as GCM spec allows almost
Gilles Peskine449bd832023-01-11 14:50:10 +01004417 * arbitrarily large nonces. Please note that we do not generally
4418 * recommend the usage of nonces of greater length than
4419 * PSA_AEAD_NONCE_MAX_SIZE, as large nonces are hashed to a shorter
4420 * size, which can then lead to collisions if you encrypt a very
4421 * large number of messages.*/
4422 if (nonce_length != 0) {
4423 return PSA_SUCCESS;
4424 }
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004425 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004426#endif /* PSA_WANT_ALG_GCM */
4427#if defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004428 case PSA_ALG_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01004429 if (nonce_length >= 7 && nonce_length <= 13) {
4430 return PSA_SUCCESS;
4431 }
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004432 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004433#endif /* PSA_WANT_ALG_CCM */
4434#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004435 case PSA_ALG_CHACHA20_POLY1305:
Gilles Peskine449bd832023-01-11 14:50:10 +01004436 if (nonce_length == 12) {
4437 return PSA_SUCCESS;
4438 } else if (nonce_length == 8) {
4439 return PSA_ERROR_NOT_SUPPORTED;
4440 }
Bence Szépkúti6d48e202021-11-15 20:04:15 +01004441 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004442#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004443 default:
Przemek Stekiel4c499272022-09-27 13:55:37 +02004444 (void) nonce_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01004445 return PSA_ERROR_NOT_SUPPORTED;
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004446 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004447
Gilles Peskine449bd832023-01-11 14:50:10 +01004448 return PSA_ERROR_INVALID_ARGUMENT;
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004449}
4450
Gilles Peskine449bd832023-01-11 14:50:10 +01004451static psa_status_t psa_aead_check_algorithm(psa_algorithm_t alg)
Bence Szépkútiaa3a6e42022-01-13 16:26:03 +01004452{
Gilles Peskine449bd832023-01-11 14:50:10 +01004453 if (!PSA_ALG_IS_AEAD(alg) || PSA_ALG_IS_WILDCARD(alg)) {
4454 return PSA_ERROR_INVALID_ARGUMENT;
4455 }
Bence Szépkúti08f34652021-12-08 21:07:13 +01004456
Gilles Peskine449bd832023-01-11 14:50:10 +01004457 return PSA_SUCCESS;
Bence Szépkúti08f34652021-12-08 21:07:13 +01004458}
4459
Gilles Peskine449bd832023-01-11 14:50:10 +01004460psa_status_t psa_aead_encrypt(mbedtls_svc_key_id_t key,
4461 psa_algorithm_t alg,
4462 const uint8_t *nonce,
4463 size_t nonce_length,
4464 const uint8_t *additional_data,
4465 size_t additional_data_length,
4466 const uint8_t *plaintext,
4467 size_t plaintext_length,
4468 uint8_t *ciphertext,
4469 size_t ciphertext_size,
4470 size_t *ciphertext_length)
mohammad16035955c982018-04-26 00:53:03 +03004471{
Ronald Cron215633c2021-03-16 17:15:37 +01004472 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4473 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02004474
mohammad1603f08a5502018-06-03 15:05:47 +03004475 *ciphertext_length = 0;
mohammad1603e58e6842018-05-09 04:58:32 -07004476
Gilles Peskine449bd832023-01-11 14:50:10 +01004477 status = psa_aead_check_algorithm(alg);
4478 if (status != PSA_SUCCESS) {
4479 return status;
4480 }
Steven Cooremanea7ab132021-03-17 16:28:00 +01004481
Ronald Cron9a986162021-03-26 12:40:07 +01004482 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01004483 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg);
4484 if (status != PSA_SUCCESS) {
4485 return status;
4486 }
mohammad16035955c982018-04-26 00:53:03 +03004487
Ronald Cron215633c2021-03-16 17:15:37 +01004488 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01004489 .core = slot->attr
Ronald Cron215633c2021-03-16 17:15:37 +01004490 };
mohammad16035955c982018-04-26 00:53:03 +03004491
Gilles Peskine449bd832023-01-11 14:50:10 +01004492 status = psa_aead_check_nonce_length(alg, nonce_length);
4493 if (status != PSA_SUCCESS) {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004494 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004495 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004496
Ronald Cronde822812021-03-17 16:08:20 +01004497 status = psa_driver_wrapper_aead_encrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01004498 &attributes, slot->key.data, slot->key.bytes,
4499 alg,
4500 nonce, nonce_length,
4501 additional_data, additional_data_length,
4502 plaintext, plaintext_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004503 ciphertext, ciphertext_size, ciphertext_length);
Gilles Peskine2d277862018-06-18 15:41:12 +02004504
Gilles Peskine449bd832023-01-11 14:50:10 +01004505 if (status != PSA_SUCCESS && ciphertext_size != 0) {
4506 memset(ciphertext, 0, ciphertext_size);
4507 }
Gilles Peskine2d277862018-06-18 15:41:12 +02004508
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004509exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00004510 psa_unregister_read(slot);
mohammad16035955c982018-04-26 00:53:03 +03004511
Gilles Peskine449bd832023-01-11 14:50:10 +01004512 return status;
Gilles Peskineee652a32018-06-01 19:23:52 +02004513}
4514
Gilles Peskine449bd832023-01-11 14:50:10 +01004515psa_status_t psa_aead_decrypt(mbedtls_svc_key_id_t key,
4516 psa_algorithm_t alg,
4517 const uint8_t *nonce,
4518 size_t nonce_length,
4519 const uint8_t *additional_data,
4520 size_t additional_data_length,
4521 const uint8_t *ciphertext,
4522 size_t ciphertext_length,
4523 uint8_t *plaintext,
4524 size_t plaintext_size,
4525 size_t *plaintext_length)
mohammad16035955c982018-04-26 00:53:03 +03004526{
Ronald Cron215633c2021-03-16 17:15:37 +01004527 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4528 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02004529
Gilles Peskineee652a32018-06-01 19:23:52 +02004530 *plaintext_length = 0;
mohammad16039e5a5152018-04-26 12:07:35 +03004531
Gilles Peskine449bd832023-01-11 14:50:10 +01004532 status = psa_aead_check_algorithm(alg);
4533 if (status != PSA_SUCCESS) {
4534 return status;
4535 }
Steven Cooremanea7ab132021-03-17 16:28:00 +01004536
Ronald Cron9a986162021-03-26 12:40:07 +01004537 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01004538 key, &slot, PSA_KEY_USAGE_DECRYPT, alg);
4539 if (status != PSA_SUCCESS) {
4540 return status;
4541 }
mohammad16035955c982018-04-26 00:53:03 +03004542
Ronald Cron215633c2021-03-16 17:15:37 +01004543 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01004544 .core = slot->attr
Ronald Cron215633c2021-03-16 17:15:37 +01004545 };
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004546
Gilles Peskine449bd832023-01-11 14:50:10 +01004547 status = psa_aead_check_nonce_length(alg, nonce_length);
4548 if (status != PSA_SUCCESS) {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004549 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004550 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004551
Ronald Cronde822812021-03-17 16:08:20 +01004552 status = psa_driver_wrapper_aead_decrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01004553 &attributes, slot->key.data, slot->key.bytes,
4554 alg,
4555 nonce, nonce_length,
4556 additional_data, additional_data_length,
4557 ciphertext, ciphertext_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004558 plaintext, plaintext_size, plaintext_length);
Gilles Peskinea40d7742018-06-01 16:28:30 +02004559
Gilles Peskine449bd832023-01-11 14:50:10 +01004560 if (status != PSA_SUCCESS && plaintext_size != 0) {
4561 memset(plaintext, 0, plaintext_size);
4562 }
mohammad160360a64d02018-06-03 17:20:42 +03004563
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004564exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00004565 psa_unregister_read(slot);
Ronald Cron215633c2021-03-16 17:15:37 +01004566
Gilles Peskine449bd832023-01-11 14:50:10 +01004567 return status;
mohammad16035955c982018-04-26 00:53:03 +03004568}
4569
Gilles Peskine449bd832023-01-11 14:50:10 +01004570static psa_status_t psa_validate_tag_length(psa_algorithm_t alg)
4571{
4572 const uint8_t tag_len = PSA_ALG_AEAD_GET_TAG_LENGTH(alg);
Andrzej Kurekf8816012021-12-19 17:00:12 +01004573
Gilles Peskine449bd832023-01-11 14:50:10 +01004574 switch (PSA_ALG_AEAD_WITH_SHORTENED_TAG(alg, 0)) {
Przemek Stekiel86679c72022-10-06 17:06:56 +02004575#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004576 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004577 /* CCM allows the following tag lengths: 4, 6, 8, 10, 12, 14, 16.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004578 if (tag_len < 4 || tag_len > 16 || tag_len % 2) {
4579 return PSA_ERROR_INVALID_ARGUMENT;
4580 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01004581 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02004582#endif /* PSA_WANT_ALG_CCM */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004583
Przemek Stekiel86679c72022-10-06 17:06:56 +02004584#if defined(PSA_WANT_ALG_GCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004585 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_GCM, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004586 /* GCM allows the following tag lengths: 4, 8, 12, 13, 14, 15, 16. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004587 if (tag_len != 4 && tag_len != 8 && (tag_len < 12 || tag_len > 16)) {
4588 return PSA_ERROR_INVALID_ARGUMENT;
4589 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01004590 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02004591#endif /* PSA_WANT_ALG_GCM */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004592
Przemek Stekiel86679c72022-10-06 17:06:56 +02004593#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Gilles Peskine449bd832023-01-11 14:50:10 +01004594 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CHACHA20_POLY1305, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004595 /* We only support the default tag length. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004596 if (tag_len != 16) {
4597 return PSA_ERROR_INVALID_ARGUMENT;
4598 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01004599 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02004600#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004601
4602 default:
4603 (void) tag_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004604 return PSA_ERROR_NOT_SUPPORTED;
Andrzej Kurekf8816012021-12-19 17:00:12 +01004605 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004606 return PSA_SUCCESS;
Andrzej Kurekf8816012021-12-19 17:00:12 +01004607}
4608
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004609/* Set the key for a multipart authenticated operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004610static psa_status_t psa_aead_setup(psa_aead_operation_t *operation,
4611 int is_encrypt,
4612 mbedtls_svc_key_id_t key,
4613 psa_algorithm_t alg)
Paul Elliottc2b71442021-06-24 18:17:52 +01004614{
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004615 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4616 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
4617 psa_key_slot_t *slot = NULL;
4618 psa_key_usage_t key_usage = 0;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004619 psa_key_attributes_t attributes;
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004620
Gilles Peskine449bd832023-01-11 14:50:10 +01004621 status = psa_aead_check_algorithm(alg);
4622 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004623 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004624 }
Paul Elliottc2b71442021-06-24 18:17:52 +01004625
Gilles Peskine449bd832023-01-11 14:50:10 +01004626 if (operation->id != 0) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004627 status = PSA_ERROR_BAD_STATE;
4628 goto exit;
Paul Elliottc2b71442021-06-24 18:17:52 +01004629 }
4630
Gilles Peskine449bd832023-01-11 14:50:10 +01004631 if (operation->nonce_set || operation->lengths_set ||
4632 operation->ad_started || operation->body_started) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004633 status = PSA_ERROR_BAD_STATE;
4634 goto exit;
Paul Elliottc2b71442021-06-24 18:17:52 +01004635 }
4636
Gilles Peskine449bd832023-01-11 14:50:10 +01004637 if (is_encrypt) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004638 key_usage = PSA_KEY_USAGE_ENCRYPT;
Gilles Peskine449bd832023-01-11 14:50:10 +01004639 } else {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004640 key_usage = PSA_KEY_USAGE_DECRYPT;
Gilles Peskine449bd832023-01-11 14:50:10 +01004641 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004642
Gilles Peskine449bd832023-01-11 14:50:10 +01004643 status = psa_get_and_lock_key_slot_with_policy(key, &slot, key_usage,
4644 alg);
4645 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004646 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004647 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004648
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004649 attributes = (psa_key_attributes_t) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004650 .core = slot->attr
4651 };
4652
Gilles Peskine449bd832023-01-11 14:50:10 +01004653 if ((status = psa_validate_tag_length(alg)) != PSA_SUCCESS) {
Przemek Stekiel6ab50762022-10-08 17:54:30 +02004654 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004655 }
Przemek Stekiel6ab50762022-10-08 17:54:30 +02004656
Gilles Peskine449bd832023-01-11 14:50:10 +01004657 if (is_encrypt) {
4658 status = psa_driver_wrapper_aead_encrypt_setup(operation,
4659 &attributes,
4660 slot->key.data,
4661 slot->key.bytes,
4662 alg);
4663 } else {
4664 status = psa_driver_wrapper_aead_decrypt_setup(operation,
4665 &attributes,
4666 slot->key.data,
4667 slot->key.bytes,
4668 alg);
4669 }
4670 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004671 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004672 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004673
Gilles Peskine449bd832023-01-11 14:50:10 +01004674 operation->key_type = psa_get_key_type(&attributes);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004675
4676exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00004677 unlock_status = psa_unregister_read(slot);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004678
Gilles Peskine449bd832023-01-11 14:50:10 +01004679 if (status == PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004680 status = unlock_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01004681 operation->alg = psa_aead_get_base_algorithm(alg);
Paul Elliottd9343f22021-08-23 18:59:49 +01004682 operation->is_encrypt = is_encrypt;
Gilles Peskine449bd832023-01-11 14:50:10 +01004683 } else {
4684 psa_aead_abort(operation);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004685 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004686
Gilles Peskine449bd832023-01-11 14:50:10 +01004687 return status;
Paul Elliottc2b71442021-06-24 18:17:52 +01004688}
4689
Paul Elliott302ff6b2021-04-20 18:10:30 +01004690/* Set the key for a multipart authenticated encryption operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004691psa_status_t psa_aead_encrypt_setup(psa_aead_operation_t *operation,
4692 mbedtls_svc_key_id_t key,
4693 psa_algorithm_t alg)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004694{
Gilles Peskine449bd832023-01-11 14:50:10 +01004695 return psa_aead_setup(operation, 1, key, alg);
Paul Elliott302ff6b2021-04-20 18:10:30 +01004696}
4697
4698/* Set the key for a multipart authenticated decryption operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004699psa_status_t psa_aead_decrypt_setup(psa_aead_operation_t *operation,
4700 mbedtls_svc_key_id_t key,
4701 psa_algorithm_t alg)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004702{
Gilles Peskine449bd832023-01-11 14:50:10 +01004703 return psa_aead_setup(operation, 0, key, alg);
Paul Elliott302ff6b2021-04-20 18:10:30 +01004704}
4705
4706/* Generate a random nonce / IV for multipart AEAD operation */
Gilles Peskine449bd832023-01-11 14:50:10 +01004707psa_status_t psa_aead_generate_nonce(psa_aead_operation_t *operation,
4708 uint8_t *nonce,
4709 size_t nonce_size,
4710 size_t *nonce_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004711{
4712 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Croncae59092021-11-26 18:53:58 +01004713 uint8_t local_nonce[PSA_AEAD_NONCE_MAX_SIZE];
Sergeybef1f632023-03-06 15:25:06 -07004714 size_t required_nonce_size = 0;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004715
Paul Elliott8eb9daf2021-06-04 16:42:21 +01004716 *nonce_length = 0;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004717
Gilles Peskine449bd832023-01-11 14:50:10 +01004718 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004719 status = PSA_ERROR_BAD_STATE;
4720 goto exit;
4721 }
4722
Gilles Peskine449bd832023-01-11 14:50:10 +01004723 if (operation->nonce_set || !operation->is_encrypt) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004724 status = PSA_ERROR_BAD_STATE;
4725 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004726 }
4727
Paul Elliotte193ea82021-10-01 13:00:16 +01004728 /* For CCM, this size may not be correct according to the PSA
4729 * specification. The PSA Crypto 1.0.1 specification states:
4730 *
4731 * CCM encodes the plaintext length pLen in L octets, with L the smallest
4732 * integer >= 2 where pLen < 2^(8L). The nonce length is then 15 - L bytes.
4733 *
4734 * However this restriction that L has to be the smallest integer is not
4735 * applied in practice, and it is not implementable here since the
4736 * plaintext length may or may not be known at this time. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004737 required_nonce_size = PSA_AEAD_NONCE_LENGTH(operation->key_type,
4738 operation->alg);
4739 if (nonce_size < required_nonce_size) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004740 status = PSA_ERROR_BUFFER_TOO_SMALL;
4741 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004742 }
4743
Gilles Peskine449bd832023-01-11 14:50:10 +01004744 status = psa_generate_random(local_nonce, required_nonce_size);
4745 if (status != PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004746 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004747 }
Paul Elliott302ff6b2021-04-20 18:10:30 +01004748
Gilles Peskine449bd832023-01-11 14:50:10 +01004749 status = psa_aead_set_nonce(operation, local_nonce, required_nonce_size);
Paul Elliott302ff6b2021-04-20 18:10:30 +01004750
Paul Elliott39dc6b82021-05-11 19:16:09 +01004751exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004752 if (status == PSA_SUCCESS) {
4753 memcpy(nonce, local_nonce, required_nonce_size);
Paul Elliott39dc6b82021-05-11 19:16:09 +01004754 *nonce_length = required_nonce_size;
Gilles Peskine449bd832023-01-11 14:50:10 +01004755 } else {
4756 psa_aead_abort(operation);
Ronald Croncae59092021-11-26 18:53:58 +01004757 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01004758
Gilles Peskine449bd832023-01-11 14:50:10 +01004759 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004760}
4761
4762/* Set the nonce for a multipart authenticated encryption or decryption
4763 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004764psa_status_t psa_aead_set_nonce(psa_aead_operation_t *operation,
4765 const uint8_t *nonce,
4766 size_t nonce_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004767{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004768 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4769
Gilles Peskine449bd832023-01-11 14:50:10 +01004770 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004771 status = PSA_ERROR_BAD_STATE;
4772 goto exit;
4773 }
4774
Gilles Peskine449bd832023-01-11 14:50:10 +01004775 if (operation->nonce_set) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004776 status = PSA_ERROR_BAD_STATE;
4777 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004778 }
4779
Gilles Peskine449bd832023-01-11 14:50:10 +01004780 status = psa_aead_check_nonce_length(operation->alg, nonce_length);
4781 if (status != PSA_SUCCESS) {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004782 status = PSA_ERROR_INVALID_ARGUMENT;
4783 goto exit;
Paul Elliott4ed1ed12021-09-27 18:09:28 +01004784 }
Paul Elliott1a98aca2021-05-20 18:24:07 +01004785
Gilles Peskine449bd832023-01-11 14:50:10 +01004786 status = psa_driver_wrapper_aead_set_nonce(operation, nonce,
4787 nonce_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004788
Paul Elliott39dc6b82021-05-11 19:16:09 +01004789exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004790 if (status == PSA_SUCCESS) {
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004791 operation->nonce_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004792 } else {
4793 psa_aead_abort(operation);
4794 }
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004795
Gilles Peskine449bd832023-01-11 14:50:10 +01004796 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004797}
4798
4799/* Declare the lengths of the message and additional data for multipart AEAD. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004800psa_status_t psa_aead_set_lengths(psa_aead_operation_t *operation,
4801 size_t ad_length,
4802 size_t plaintext_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004803{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004804 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4805
Gilles Peskine449bd832023-01-11 14:50:10 +01004806 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004807 status = PSA_ERROR_BAD_STATE;
4808 goto exit;
4809 }
4810
Gilles Peskine449bd832023-01-11 14:50:10 +01004811 if (operation->lengths_set || operation->ad_started ||
4812 operation->body_started) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004813 status = PSA_ERROR_BAD_STATE;
4814 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004815 }
4816
Gilles Peskine449bd832023-01-11 14:50:10 +01004817 switch (operation->alg) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004818#if defined(PSA_WANT_ALG_GCM)
4819 case PSA_ALG_GCM:
4820 /* Lengths can only be too large for GCM if size_t is bigger than 32
Gilles Peskine449bd832023-01-11 14:50:10 +01004821 * bits. Without the guard this code will generate warnings on 32bit
4822 * builds. */
Paul Elliott325d3742021-09-27 17:56:28 +01004823#if SIZE_MAX > UINT32_MAX
Gilles Peskine449bd832023-01-11 14:50:10 +01004824 if (((uint64_t) ad_length) >> 61 != 0 ||
4825 ((uint64_t) plaintext_length) > 0xFFFFFFFE0ull) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004826 status = PSA_ERROR_INVALID_ARGUMENT;
4827 goto exit;
4828 }
Paul Elliott325d3742021-09-27 17:56:28 +01004829#endif
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004830 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004831#endif /* PSA_WANT_ALG_GCM */
4832#if defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004833 case PSA_ALG_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01004834 if (ad_length > 0xFF00) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004835 status = PSA_ERROR_INVALID_ARGUMENT;
4836 goto exit;
4837 }
4838 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004839#endif /* PSA_WANT_ALG_CCM */
4840#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004841 case PSA_ALG_CHACHA20_POLY1305:
4842 /* No length restrictions for ChaChaPoly. */
4843 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004844#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004845 default:
4846 break;
4847 }
Paul Elliott325d3742021-09-27 17:56:28 +01004848
Gilles Peskine449bd832023-01-11 14:50:10 +01004849 status = psa_driver_wrapper_aead_set_lengths(operation, ad_length,
4850 plaintext_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004851
Paul Elliott39dc6b82021-05-11 19:16:09 +01004852exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004853 if (status == PSA_SUCCESS) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01004854 operation->ad_remaining = ad_length;
4855 operation->body_remaining = plaintext_length;
Paul Elliott39dc6b82021-05-11 19:16:09 +01004856 operation->lengths_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004857 } else {
4858 psa_aead_abort(operation);
Paul Elliottee4ffe02021-05-20 17:25:06 +01004859 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01004860
Gilles Peskine449bd832023-01-11 14:50:10 +01004861 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004862}
Paul Elliott3d7d52c2021-09-01 10:33:14 +01004863
4864/* Pass additional data to an active multipart AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004865psa_status_t psa_aead_update_ad(psa_aead_operation_t *operation,
4866 const uint8_t *input,
4867 size_t input_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004868{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004869 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4870
Gilles Peskine449bd832023-01-11 14:50:10 +01004871 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004872 status = PSA_ERROR_BAD_STATE;
4873 goto exit;
4874 }
4875
Gilles Peskine449bd832023-01-11 14:50:10 +01004876 if (!operation->nonce_set || operation->body_started) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004877 status = PSA_ERROR_BAD_STATE;
4878 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004879 }
4880
Gilles Peskine449bd832023-01-11 14:50:10 +01004881 if (operation->lengths_set) {
4882 if (operation->ad_remaining < input_length) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01004883 status = PSA_ERROR_INVALID_ARGUMENT;
4884 goto exit;
4885 }
4886
4887 operation->ad_remaining -= input_length;
4888 }
Paul Elliotte193ea82021-10-01 13:00:16 +01004889#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004890 else if (operation->alg == PSA_ALG_CCM) {
Paul Elliotte193ea82021-10-01 13:00:16 +01004891 status = PSA_ERROR_BAD_STATE;
4892 goto exit;
4893 }
4894#endif /* PSA_WANT_ALG_CCM */
Paul Elliottee4ffe02021-05-20 17:25:06 +01004895
Gilles Peskine449bd832023-01-11 14:50:10 +01004896 status = psa_driver_wrapper_aead_update_ad(operation, input,
4897 input_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004898
Paul Elliott39dc6b82021-05-11 19:16:09 +01004899exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004900 if (status == PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004901 operation->ad_started = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004902 } else {
4903 psa_aead_abort(operation);
4904 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01004905
Gilles Peskine449bd832023-01-11 14:50:10 +01004906 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004907}
4908
4909/* Encrypt or decrypt a message fragment in an active multipart AEAD
4910 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004911psa_status_t psa_aead_update(psa_aead_operation_t *operation,
4912 const uint8_t *input,
4913 size_t input_length,
4914 uint8_t *output,
4915 size_t output_size,
4916 size_t *output_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004917{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004918 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004919
4920 *output_length = 0;
4921
Gilles Peskine449bd832023-01-11 14:50:10 +01004922 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004923 status = PSA_ERROR_BAD_STATE;
4924 goto exit;
4925 }
4926
Gilles Peskine449bd832023-01-11 14:50:10 +01004927 if (!operation->nonce_set) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004928 status = PSA_ERROR_BAD_STATE;
4929 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004930 }
4931
Gilles Peskine449bd832023-01-11 14:50:10 +01004932 if (operation->lengths_set) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01004933 /* Additional data length was supplied, but not all the additional
4934 data was supplied.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004935 if (operation->ad_remaining != 0) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01004936 status = PSA_ERROR_INVALID_ARGUMENT;
4937 goto exit;
4938 }
4939
4940 /* Too much data provided. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004941 if (operation->body_remaining < input_length) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01004942 status = PSA_ERROR_INVALID_ARGUMENT;
4943 goto exit;
4944 }
4945
4946 operation->body_remaining -= input_length;
4947 }
Paul Elliotte193ea82021-10-01 13:00:16 +01004948#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004949 else if (operation->alg == PSA_ALG_CCM) {
Paul Elliotte193ea82021-10-01 13:00:16 +01004950 status = PSA_ERROR_BAD_STATE;
4951 goto exit;
4952 }
4953#endif /* PSA_WANT_ALG_CCM */
Paul Elliottee4ffe02021-05-20 17:25:06 +01004954
Gilles Peskine449bd832023-01-11 14:50:10 +01004955 status = psa_driver_wrapper_aead_update(operation, input, input_length,
4956 output, output_size,
4957 output_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004958
Paul Elliott39dc6b82021-05-11 19:16:09 +01004959exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004960 if (status == PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004961 operation->body_started = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004962 } else {
4963 psa_aead_abort(operation);
4964 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01004965
Gilles Peskine449bd832023-01-11 14:50:10 +01004966 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004967}
4968
Gilles Peskine449bd832023-01-11 14:50:10 +01004969static psa_status_t psa_aead_final_checks(const psa_aead_operation_t *operation)
Paul Elliottad53dcc2021-06-23 08:50:14 +01004970{
Gilles Peskine449bd832023-01-11 14:50:10 +01004971 if (operation->id == 0 || !operation->nonce_set) {
4972 return PSA_ERROR_BAD_STATE;
4973 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01004974
Gilles Peskine449bd832023-01-11 14:50:10 +01004975 if (operation->lengths_set && (operation->ad_remaining != 0 ||
4976 operation->body_remaining != 0)) {
4977 return PSA_ERROR_INVALID_ARGUMENT;
4978 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01004979
Gilles Peskine449bd832023-01-11 14:50:10 +01004980 return PSA_SUCCESS;
Paul Elliottad53dcc2021-06-23 08:50:14 +01004981}
4982
Paul Elliott302ff6b2021-04-20 18:10:30 +01004983/* Finish encrypting a message in a multipart AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004984psa_status_t psa_aead_finish(psa_aead_operation_t *operation,
4985 uint8_t *ciphertext,
4986 size_t ciphertext_size,
4987 size_t *ciphertext_length,
4988 uint8_t *tag,
4989 size_t tag_size,
4990 size_t *tag_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004991{
Paul Elliott39dc6b82021-05-11 19:16:09 +01004992 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4993
Paul Elliott302ff6b2021-04-20 18:10:30 +01004994 *ciphertext_length = 0;
Paul Elliottf88a5652021-06-22 17:53:45 +01004995 *tag_length = tag_size;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004996
Gilles Peskine449bd832023-01-11 14:50:10 +01004997 status = psa_aead_final_checks(operation);
4998 if (status != PSA_SUCCESS) {
Paul Elliottad53dcc2021-06-23 08:50:14 +01004999 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005000 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01005001
Gilles Peskine449bd832023-01-11 14:50:10 +01005002 if (!operation->is_encrypt) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005003 status = PSA_ERROR_BAD_STATE;
5004 goto exit;
5005 }
5006
Gilles Peskine449bd832023-01-11 14:50:10 +01005007 status = psa_driver_wrapper_aead_finish(operation, ciphertext,
5008 ciphertext_size,
5009 ciphertext_length,
5010 tag, tag_size, tag_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005011
Paul Elliott39dc6b82021-05-11 19:16:09 +01005012exit:
Paul Elliottdc42ca82023-02-24 18:11:59 +00005013
5014
Paul Elliottf47b0952021-05-21 18:02:33 +01005015 /* In case the operation fails and the user fails to check for failure or
Paul Elliott4c916e82021-09-19 18:34:50 +01005016 * the zero tag size, make sure the tag is set to something implausible.
5017 * Even if the operation succeeds, make sure we clear the rest of the
5018 * buffer to prevent potential leakage of anything previously placed in
5019 * the same buffer.*/
Paul Elliottdc42ca82023-02-24 18:11:59 +00005020 psa_wipe_tag_output_buffer(tag, status, tag_size, *tag_length);
Paul Elliottf47b0952021-05-21 18:02:33 +01005021
Gilles Peskine449bd832023-01-11 14:50:10 +01005022 psa_aead_abort(operation);
Paul Elliott39dc6b82021-05-11 19:16:09 +01005023
Gilles Peskine449bd832023-01-11 14:50:10 +01005024 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005025}
5026
5027/* Finish authenticating and decrypting a message in a multipart AEAD
5028 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01005029psa_status_t psa_aead_verify(psa_aead_operation_t *operation,
5030 uint8_t *plaintext,
5031 size_t plaintext_size,
5032 size_t *plaintext_length,
5033 const uint8_t *tag,
5034 size_t tag_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005035{
Paul Elliott39dc6b82021-05-11 19:16:09 +01005036 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5037
Paul Elliott302ff6b2021-04-20 18:10:30 +01005038 *plaintext_length = 0;
5039
Gilles Peskine449bd832023-01-11 14:50:10 +01005040 status = psa_aead_final_checks(operation);
5041 if (status != PSA_SUCCESS) {
Paul Elliottad53dcc2021-06-23 08:50:14 +01005042 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005043 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01005044
Gilles Peskine449bd832023-01-11 14:50:10 +01005045 if (operation->is_encrypt) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005046 status = PSA_ERROR_BAD_STATE;
5047 goto exit;
5048 }
5049
Gilles Peskine449bd832023-01-11 14:50:10 +01005050 status = psa_driver_wrapper_aead_verify(operation, plaintext,
5051 plaintext_size,
5052 plaintext_length,
5053 tag, tag_length);
Paul Elliott39dc6b82021-05-11 19:16:09 +01005054
5055exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005056 psa_aead_abort(operation);
Paul Elliott39dc6b82021-05-11 19:16:09 +01005057
Gilles Peskine449bd832023-01-11 14:50:10 +01005058 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005059}
5060
5061/* Abort an AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005062psa_status_t psa_aead_abort(psa_aead_operation_t *operation)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005063{
5064 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5065
Gilles Peskine449bd832023-01-11 14:50:10 +01005066 if (operation->id == 0) {
Paul Elliott302ff6b2021-04-20 18:10:30 +01005067 /* The object has (apparently) been initialized but it is not (yet)
5068 * in use. It's ok to call abort on such an object, and there's
5069 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005070 return PSA_SUCCESS;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005071 }
5072
Gilles Peskine449bd832023-01-11 14:50:10 +01005073 status = psa_driver_wrapper_aead_abort(operation);
Paul Elliott302ff6b2021-04-20 18:10:30 +01005074
Gilles Peskine449bd832023-01-11 14:50:10 +01005075 memset(operation, 0, sizeof(*operation));
Paul Elliott302ff6b2021-04-20 18:10:30 +01005076
Gilles Peskine449bd832023-01-11 14:50:10 +01005077 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005078}
5079
Gilles Peskinee59236f2018-01-27 23:32:46 +01005080/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02005081/* Generators */
5082/****************************************************************/
5083
Przemek Stekiel69c46792022-06-10 12:59:51 +02005084#if defined(BUILTIN_ALG_ANY_HKDF) || \
John Durkop07cc04a2020-11-16 22:08:34 -08005085 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005086 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) || \
Kusumit Ghoderaoaf0b5342023-05-03 11:58:46 +05305087 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS) || \
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305088 defined(PSA_HAVE_SOFT_PBKDF2)
John Durkop07cc04a2020-11-16 22:08:34 -08005089#define AT_LEAST_ONE_BUILTIN_KDF
Steven Cooreman094a77e2021-05-06 17:58:36 +02005090#endif /* At least one builtin KDF */
5091
Przemek Stekiel69c46792022-06-10 12:59:51 +02005092#if defined(BUILTIN_ALG_ANY_HKDF) || \
Steven Cooreman094a77e2021-05-06 17:58:36 +02005093 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5094 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
5095static psa_status_t psa_key_derivation_start_hmac(
5096 psa_mac_operation_t *operation,
5097 psa_algorithm_t hash_alg,
5098 const uint8_t *hmac_key,
Gilles Peskine449bd832023-01-11 14:50:10 +01005099 size_t hmac_key_length)
Steven Cooreman094a77e2021-05-06 17:58:36 +02005100{
5101 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5102 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01005103 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
5104 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(hmac_key_length));
5105 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_HASH);
Steven Cooreman094a77e2021-05-06 17:58:36 +02005106
Steven Cooreman72f736a2021-05-07 14:14:37 +02005107 operation->is_sign = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005108 operation->mac_size = PSA_HASH_LENGTH(hash_alg);
Steven Cooreman72f736a2021-05-07 14:14:37 +02005109
Gilles Peskine449bd832023-01-11 14:50:10 +01005110 status = psa_driver_wrapper_mac_sign_setup(operation,
5111 &attributes,
5112 hmac_key, hmac_key_length,
5113 PSA_ALG_HMAC(hash_alg));
Steven Cooreman094a77e2021-05-06 17:58:36 +02005114
Gilles Peskine449bd832023-01-11 14:50:10 +01005115 psa_reset_key_attributes(&attributes);
5116 return status;
Steven Cooreman094a77e2021-05-06 17:58:36 +02005117}
5118#endif /* KDF algorithms reliant on HMAC */
John Durkop07cc04a2020-11-16 22:08:34 -08005119
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005120#define HKDF_STATE_INIT 0 /* no input yet */
5121#define HKDF_STATE_STARTED 1 /* got salt */
5122#define HKDF_STATE_KEYED 2 /* got key */
5123#define HKDF_STATE_OUTPUT 3 /* output started */
5124
Gilles Peskinecbe66502019-05-16 16:59:18 +02005125static psa_algorithm_t psa_key_derivation_get_kdf_alg(
Gilles Peskine449bd832023-01-11 14:50:10 +01005126 const psa_key_derivation_operation_t *operation)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005127{
Gilles Peskine449bd832023-01-11 14:50:10 +01005128 if (PSA_ALG_IS_KEY_AGREEMENT(operation->alg)) {
5129 return PSA_ALG_KEY_AGREEMENT_GET_KDF(operation->alg);
5130 } else {
5131 return operation->alg;
5132 }
Gilles Peskine969c5d62019-01-16 15:53:06 +01005133}
5134
Gilles Peskine449bd832023-01-11 14:50:10 +01005135psa_status_t psa_key_derivation_abort(psa_key_derivation_operation_t *operation)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005136{
5137 psa_status_t status = PSA_SUCCESS;
Gilles Peskine449bd832023-01-11 14:50:10 +01005138 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
5139 if (kdf_alg == 0) {
Gilles Peskineeab56e42018-07-12 17:12:33 +02005140 /* The object has (apparently) been initialized but it is not
5141 * in use. It's ok to call abort on such an object, and there's
5142 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005143 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02005144#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01005145 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
5146 mbedtls_free(operation->ctx.hkdf.info);
5147 status = psa_mac_abort(&operation->ctx.hkdf.hmac);
5148 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02005149#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08005150#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5151 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005152 if (PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
5153 /* TLS-1.2 PSK-to-MS KDF uses the same core as TLS-1.2 PRF */
5154 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
5155 if (operation->ctx.tls12_prf.secret != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005156 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.secret,
Gilles Peskine449bd832023-01-11 14:50:10 +01005157 operation->ctx.tls12_prf.secret_length);
Steven Cooremana6df6042021-04-29 19:32:25 +02005158 }
5159
Gilles Peskine449bd832023-01-11 14:50:10 +01005160 if (operation->ctx.tls12_prf.seed != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005161 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.seed,
Gilles Peskine449bd832023-01-11 14:50:10 +01005162 operation->ctx.tls12_prf.seed_length);
Janos Follath6a1d2622019-06-11 10:37:28 +01005163 }
5164
Gilles Peskine449bd832023-01-11 14:50:10 +01005165 if (operation->ctx.tls12_prf.label != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005166 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.label,
Gilles Peskine449bd832023-01-11 14:50:10 +01005167 operation->ctx.tls12_prf.label_length);
Janos Follath6a1d2622019-06-11 10:37:28 +01005168 }
Przemek Stekiel6c764412022-11-22 14:05:12 +01005169#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005170 if (operation->ctx.tls12_prf.other_secret != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005171 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.other_secret,
Gilles Peskine449bd832023-01-11 14:50:10 +01005172 operation->ctx.tls12_prf.other_secret_length);
Przemek Stekiele3ee2212022-04-07 14:29:56 +02005173 }
Przemek Stekiel6c764412022-11-22 14:05:12 +01005174#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Steven Cooremana6df6042021-04-29 19:32:25 +02005175 status = PSA_SUCCESS;
Janos Follath6a1d2622019-06-11 10:37:28 +01005176
5177 /* We leave the fields Ai and output_block to be erased safely by the
5178 * mbedtls_platform_zeroize() in the end of this function. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005179 } else
John Durkop07cc04a2020-11-16 22:08:34 -08005180#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
5181 * defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005182#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005183 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
5184 mbedtls_platform_zeroize(operation->ctx.tls12_ecjpake_to_pms.data,
5185 sizeof(operation->ctx.tls12_ecjpake_to_pms.data));
5186 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005187#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS) */
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305188#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05305189 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305190 if (operation->ctx.pbkdf2.salt != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005191 mbedtls_zeroize_and_free(operation->ctx.pbkdf2.salt,
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305192 operation->ctx.pbkdf2.salt_length);
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305193 }
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305194
5195 status = PSA_SUCCESS;
5196 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305197#endif /* defined(PSA_HAVE_SOFT_PBKDF2) */
Gilles Peskineeab56e42018-07-12 17:12:33 +02005198 {
5199 status = PSA_ERROR_BAD_STATE;
5200 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005201 mbedtls_platform_zeroize(operation, sizeof(*operation));
5202 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005203}
5204
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005205psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskine449bd832023-01-11 14:50:10 +01005206 size_t *capacity)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005207{
Gilles Peskine449bd832023-01-11 14:50:10 +01005208 if (operation->alg == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005209 /* This is a blank key derivation operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005210 return PSA_ERROR_BAD_STATE;
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005211 }
5212
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005213 *capacity = operation->capacity;
Gilles Peskine449bd832023-01-11 14:50:10 +01005214 return PSA_SUCCESS;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005215}
5216
Gilles Peskine449bd832023-01-11 14:50:10 +01005217psa_status_t psa_key_derivation_set_capacity(psa_key_derivation_operation_t *operation,
5218 size_t capacity)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005219{
Gilles Peskine449bd832023-01-11 14:50:10 +01005220 if (operation->alg == 0) {
5221 return PSA_ERROR_BAD_STATE;
5222 }
5223 if (capacity > operation->capacity) {
5224 return PSA_ERROR_INVALID_ARGUMENT;
5225 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005226 operation->capacity = capacity;
Gilles Peskine449bd832023-01-11 14:50:10 +01005227 return PSA_SUCCESS;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005228}
5229
Przemek Stekiel69c46792022-06-10 12:59:51 +02005230#if defined(BUILTIN_ALG_ANY_HKDF)
Przemek Stekiel03d948c2022-05-19 11:45:20 +02005231/* Read some bytes from an HKDF-based operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005232static psa_status_t psa_key_derivation_hkdf_read(psa_hkdf_key_derivation_t *hkdf,
5233 psa_algorithm_t kdf_alg,
5234 uint8_t *output,
5235 size_t output_length)
Gilles Peskinebef7f142018-07-12 17:22:21 +02005236{
Gilles Peskine449bd832023-01-11 14:50:10 +01005237 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
5238 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Steven Cooremand1ed1d92021-04-29 19:11:25 +02005239 size_t hmac_output_length;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005240 psa_status_t status;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005241#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01005242 const uint8_t last_block = PSA_ALG_IS_HKDF_EXTRACT(kdf_alg) ? 0 : 0xff;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005243#else
5244 const uint8_t last_block = 0xff;
5245#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskinebef7f142018-07-12 17:22:21 +02005246
Gilles Peskine449bd832023-01-11 14:50:10 +01005247 if (hkdf->state < HKDF_STATE_KEYED ||
5248 (!hkdf->info_set
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005249#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01005250 && !PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005251#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01005252 )) {
5253 return PSA_ERROR_BAD_STATE;
5254 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005255 hkdf->state = HKDF_STATE_OUTPUT;
5256
Gilles Peskine449bd832023-01-11 14:50:10 +01005257 while (output_length != 0) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005258 /* Copy what remains of the current block */
5259 uint8_t n = hash_length - hkdf->offset_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005260 if (n > output_length) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005261 n = (uint8_t) output_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01005262 }
5263 memcpy(output, hkdf->output_block + hkdf->offset_in_block, n);
Gilles Peskinebef7f142018-07-12 17:22:21 +02005264 output += n;
5265 output_length -= n;
5266 hkdf->offset_in_block += n;
Gilles Peskine449bd832023-01-11 14:50:10 +01005267 if (output_length == 0) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005268 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01005269 }
Przemek Stekiel03d948c2022-05-19 11:45:20 +02005270 /* We can't be wanting more output after the last block, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005271 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005272 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02005273 * object was corrupted or if this function is called directly
5274 * inside the library. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005275 if (hkdf->block_number == last_block) {
5276 return PSA_ERROR_BAD_STATE;
5277 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02005278
5279 /* We need a new block */
5280 ++hkdf->block_number;
5281 hkdf->offset_in_block = 0;
Steven Cooremand1ed1d92021-04-29 19:11:25 +02005282
Gilles Peskine449bd832023-01-11 14:50:10 +01005283 status = psa_key_derivation_start_hmac(&hkdf->hmac,
5284 hash_alg,
5285 hkdf->prk,
5286 hash_length);
5287 if (status != PSA_SUCCESS) {
5288 return status;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005289 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005290
5291 if (hkdf->block_number != 1) {
5292 status = psa_mac_update(&hkdf->hmac,
5293 hkdf->output_block,
5294 hash_length);
5295 if (status != PSA_SUCCESS) {
5296 return status;
5297 }
5298 }
5299 status = psa_mac_update(&hkdf->hmac,
5300 hkdf->info,
5301 hkdf->info_length);
5302 if (status != PSA_SUCCESS) {
5303 return status;
5304 }
5305 status = psa_mac_update(&hkdf->hmac,
5306 &hkdf->block_number, 1);
5307 if (status != PSA_SUCCESS) {
5308 return status;
5309 }
5310 status = psa_mac_sign_finish(&hkdf->hmac,
5311 hkdf->output_block,
5312 sizeof(hkdf->output_block),
5313 &hmac_output_length);
5314 if (status != PSA_SUCCESS) {
5315 return status;
5316 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02005317 }
5318
Gilles Peskine449bd832023-01-11 14:50:10 +01005319 return PSA_SUCCESS;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005320}
Przemek Stekiel69c46792022-06-10 12:59:51 +02005321#endif /* BUILTIN_ALG_ANY_HKDF */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005322
John Durkop07cc04a2020-11-16 22:08:34 -08005323#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5324 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follath7742fee2019-06-17 12:58:10 +01005325static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
5326 psa_tls12_prf_key_derivation_t *tls12_prf,
Gilles Peskine449bd832023-01-11 14:50:10 +01005327 psa_algorithm_t alg)
Janos Follath7742fee2019-06-17 12:58:10 +01005328{
Gilles Peskine449bd832023-01-11 14:50:10 +01005329 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(alg);
5330 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Steven Cooremana6df6042021-04-29 19:32:25 +02005331 psa_mac_operation_t hmac = PSA_MAC_OPERATION_INIT;
5332 size_t hmac_output_length;
Janos Follathea29bfb2019-06-19 12:21:20 +01005333 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005334
Janos Follath7742fee2019-06-17 12:58:10 +01005335 /* We can't be wanting more output after block 0xff, otherwise
5336 * the capacity check in psa_key_derivation_output_bytes() would have
5337 * prevented this call. It could happen only if the operation
5338 * object was corrupted or if this function is called directly
5339 * inside the library. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005340 if (tls12_prf->block_number == 0xff) {
5341 return PSA_ERROR_CORRUPTION_DETECTED;
5342 }
Janos Follath7742fee2019-06-17 12:58:10 +01005343
5344 /* We need a new block */
5345 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01005346 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01005347
5348 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
5349 *
5350 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
5351 *
5352 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
5353 * HMAC_hash(secret, A(2) + seed) +
5354 * HMAC_hash(secret, A(3) + seed) + ...
5355 *
5356 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01005357 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01005358 *
Janos Follathea29bfb2019-06-19 12:21:20 +01005359 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01005360 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01005361 * is currently extracted as `output_block` and where i is
5362 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01005363 */
5364
Gilles Peskine449bd832023-01-11 14:50:10 +01005365 status = psa_key_derivation_start_hmac(&hmac,
5366 hash_alg,
5367 tls12_prf->secret,
5368 tls12_prf->secret_length);
5369 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005370 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005371 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005372
5373 /* Calculate A(i) where i = tls12_prf->block_number. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005374 if (tls12_prf->block_number == 1) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005375 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
5376 * the variable seed and in this instance means it in the context of the
5377 * P_hash function, where seed = label + seed.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01005378 status = psa_mac_update(&hmac,
5379 tls12_prf->label,
5380 tls12_prf->label_length);
5381 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005382 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005383 }
5384 status = psa_mac_update(&hmac,
5385 tls12_prf->seed,
5386 tls12_prf->seed_length);
5387 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005388 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005389 }
5390 } else {
Janos Follathea29bfb2019-06-19 12:21:20 +01005391 /* A(i) = HMAC_hash(secret, A(i-1)) */
Gilles Peskine449bd832023-01-11 14:50:10 +01005392 status = psa_mac_update(&hmac, tls12_prf->Ai, hash_length);
5393 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005394 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005395 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005396 }
5397
Gilles Peskine449bd832023-01-11 14:50:10 +01005398 status = psa_mac_sign_finish(&hmac,
5399 tls12_prf->Ai, hash_length,
5400 &hmac_output_length);
5401 if (hmac_output_length != hash_length) {
Steven Cooremana6df6042021-04-29 19:32:25 +02005402 status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01005403 }
5404 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005405 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005406 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005407
5408 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
Gilles Peskine449bd832023-01-11 14:50:10 +01005409 status = psa_key_derivation_start_hmac(&hmac,
5410 hash_alg,
5411 tls12_prf->secret,
5412 tls12_prf->secret_length);
5413 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005414 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005415 }
5416 status = psa_mac_update(&hmac, tls12_prf->Ai, hash_length);
5417 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005418 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005419 }
5420 status = psa_mac_update(&hmac, tls12_prf->label, tls12_prf->label_length);
5421 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005422 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005423 }
5424 status = psa_mac_update(&hmac, tls12_prf->seed, tls12_prf->seed_length);
5425 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005426 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005427 }
5428 status = psa_mac_sign_finish(&hmac,
5429 tls12_prf->output_block, hash_length,
5430 &hmac_output_length);
5431 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005432 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005433 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005434
Janos Follath7742fee2019-06-17 12:58:10 +01005435
5436cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01005437 cleanup_status = psa_mac_abort(&hmac);
5438 if (status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005439 status = cleanup_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01005440 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005441
Gilles Peskine449bd832023-01-11 14:50:10 +01005442 return status;
Janos Follath7742fee2019-06-17 12:58:10 +01005443}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005444
Janos Follath844eb0e2019-06-19 12:10:49 +01005445static psa_status_t psa_key_derivation_tls12_prf_read(
5446 psa_tls12_prf_key_derivation_t *tls12_prf,
5447 psa_algorithm_t alg,
5448 uint8_t *output,
Gilles Peskine449bd832023-01-11 14:50:10 +01005449 size_t output_length)
Janos Follath844eb0e2019-06-19 12:10:49 +01005450{
Gilles Peskine449bd832023-01-11 14:50:10 +01005451 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH(alg);
5452 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Janos Follath844eb0e2019-06-19 12:10:49 +01005453 psa_status_t status;
5454 uint8_t offset, length;
5455
Gilles Peskine449bd832023-01-11 14:50:10 +01005456 switch (tls12_prf->state) {
Gilles Peskineb1edaec2021-06-11 22:41:46 +02005457 case PSA_TLS12_PRF_STATE_LABEL_SET:
5458 tls12_prf->state = PSA_TLS12_PRF_STATE_OUTPUT;
5459 break;
5460 case PSA_TLS12_PRF_STATE_OUTPUT:
5461 break;
5462 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005463 return PSA_ERROR_BAD_STATE;
Gilles Peskineb1edaec2021-06-11 22:41:46 +02005464 }
5465
Gilles Peskine449bd832023-01-11 14:50:10 +01005466 while (output_length != 0) {
Janos Follath844eb0e2019-06-19 12:10:49 +01005467 /* Check if we have fully processed the current block. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005468 if (tls12_prf->left_in_block == 0) {
5469 status = psa_key_derivation_tls12_prf_generate_next_block(tls12_prf,
5470 alg);
5471 if (status != PSA_SUCCESS) {
5472 return status;
5473 }
Janos Follath844eb0e2019-06-19 12:10:49 +01005474
5475 continue;
5476 }
5477
Gilles Peskine449bd832023-01-11 14:50:10 +01005478 if (tls12_prf->left_in_block > output_length) {
Janos Follath844eb0e2019-06-19 12:10:49 +01005479 length = (uint8_t) output_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01005480 } else {
Janos Follath844eb0e2019-06-19 12:10:49 +01005481 length = tls12_prf->left_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005482 }
Janos Follath844eb0e2019-06-19 12:10:49 +01005483
5484 offset = hash_length - tls12_prf->left_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005485 memcpy(output, tls12_prf->output_block + offset, length);
Janos Follath844eb0e2019-06-19 12:10:49 +01005486 output += length;
5487 output_length -= length;
5488 tls12_prf->left_in_block -= length;
5489 }
5490
Gilles Peskine449bd832023-01-11 14:50:10 +01005491 return PSA_SUCCESS;
Janos Follath844eb0e2019-06-19 12:10:49 +01005492}
John Durkop07cc04a2020-11-16 22:08:34 -08005493#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
5494 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskinebef7f142018-07-12 17:22:21 +02005495
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005496#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
5497static psa_status_t psa_key_derivation_tls12_ecjpake_to_pms_read(
5498 psa_tls12_ecjpake_to_pms_t *ecjpake,
5499 uint8_t *output,
Gilles Peskine449bd832023-01-11 14:50:10 +01005500 size_t output_length)
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005501{
5502 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Andrzej Kurek5603efd2022-09-26 10:49:16 -04005503 size_t output_size = 0;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005504
Gilles Peskine449bd832023-01-11 14:50:10 +01005505 if (output_length != 32) {
5506 return PSA_ERROR_INVALID_ARGUMENT;
5507 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005508
Gilles Peskine449bd832023-01-11 14:50:10 +01005509 status = psa_hash_compute(PSA_ALG_SHA_256, ecjpake->data,
5510 PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE, output, output_length,
5511 &output_size);
5512 if (status != PSA_SUCCESS) {
5513 return status;
5514 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005515
Gilles Peskine449bd832023-01-11 14:50:10 +01005516 if (output_size != output_length) {
5517 return PSA_ERROR_GENERIC_ERROR;
5518 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005519
Gilles Peskine449bd832023-01-11 14:50:10 +01005520 return PSA_SUCCESS;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005521}
5522#endif
5523
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305524#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305525static psa_status_t psa_key_derivation_pbkdf2_generate_block(
5526 psa_pbkdf2_key_derivation_t *pbkdf2,
5527 psa_algorithm_t prf_alg,
5528 uint8_t prf_output_length,
5529 psa_key_attributes_t *attributes)
5530{
5531 psa_status_t status;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305532 psa_mac_operation_t mac_operation = PSA_MAC_OPERATION_INIT;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305533 size_t mac_output_length;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305534 uint8_t U_i[PSA_MAC_MAX_SIZE];
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305535 uint8_t *U_accumulator = pbkdf2->output_block;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305536 uint64_t i;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305537 uint8_t block_counter[4];
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305538
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305539 mac_operation.is_sign = 1;
5540 mac_operation.mac_size = prf_output_length;
5541 MBEDTLS_PUT_UINT32_BE(pbkdf2->block_number, block_counter, 0);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305542
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305543 status = psa_driver_wrapper_mac_sign_setup(&mac_operation,
5544 attributes,
5545 pbkdf2->password,
5546 pbkdf2->password_length,
5547 prf_alg);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305548 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305549 goto cleanup;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305550 }
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305551 status = psa_mac_update(&mac_operation, pbkdf2->salt, pbkdf2->salt_length);
5552 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305553 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305554 }
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305555 status = psa_mac_update(&mac_operation, block_counter, sizeof(block_counter));
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305556 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305557 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305558 }
5559 status = psa_mac_sign_finish(&mac_operation, U_i, sizeof(U_i),
5560 &mac_output_length);
5561 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305562 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305563 }
5564
5565 if (mac_output_length != prf_output_length) {
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305566 status = PSA_ERROR_CORRUPTION_DETECTED;
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305567 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305568 }
5569
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305570 memcpy(U_accumulator, U_i, prf_output_length);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305571
5572 for (i = 1; i < pbkdf2->input_cost; i++) {
Kusumit Ghoderao4536bb62023-06-22 15:42:59 +05305573 /* We are passing prf_output_length as mac_size because the driver
5574 * function directly sets mac_output_length as mac_size upon success.
Kusumit Ghoderao5f3345a2023-07-27 21:21:38 +05305575 * See https://github.com/Mbed-TLS/mbedtls/issues/7801 */
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305576 status = psa_driver_wrapper_mac_compute(attributes,
5577 pbkdf2->password,
5578 pbkdf2->password_length,
5579 prf_alg, U_i, prf_output_length,
Kusumit Ghoderao4536bb62023-06-22 15:42:59 +05305580 U_i, prf_output_length,
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305581 &mac_output_length);
5582 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305583 goto cleanup;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305584 }
5585
Kusumit Ghoderao109ee3d2023-06-08 16:36:45 +05305586 mbedtls_xor(U_accumulator, U_accumulator, U_i, prf_output_length);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305587 }
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305588
5589cleanup:
5590 /* Zeroise buffers to clear sensitive data from memory. */
5591 mbedtls_platform_zeroize(U_i, PSA_MAC_MAX_SIZE);
5592 return status;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305593}
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05305594
5595static psa_status_t psa_key_derivation_pbkdf2_read(
5596 psa_pbkdf2_key_derivation_t *pbkdf2,
5597 psa_algorithm_t kdf_alg,
5598 uint8_t *output,
5599 size_t output_length)
5600{
5601 psa_status_t status;
5602 psa_algorithm_t prf_alg;
5603 uint8_t prf_output_length;
5604 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
5605 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(pbkdf2->password_length));
5606 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
5607
5608 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
5609 prf_alg = PSA_ALG_HMAC(PSA_ALG_PBKDF2_HMAC_GET_HASH(kdf_alg));
5610 prf_output_length = PSA_HASH_LENGTH(prf_alg);
5611 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
Kusumit Ghoderaoa2520a52023-06-22 15:42:19 +05305612 } else if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
5613 prf_alg = PSA_ALG_CMAC;
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05305614 prf_output_length = PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC);
Kusumit Ghoderaoa2520a52023-06-22 15:42:19 +05305615 psa_set_key_type(&attributes, PSA_KEY_TYPE_AES);
Kusumit Ghoderaod9ec1af2023-06-08 20:19:51 +05305616 } else {
5617 return PSA_ERROR_INVALID_ARGUMENT;
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05305618 }
5619
5620 switch (pbkdf2->state) {
5621 case PSA_PBKDF2_STATE_PASSWORD_SET:
5622 /* Initially we need a new block so bytes_used is equal to block size*/
5623 pbkdf2->bytes_used = prf_output_length;
5624 pbkdf2->state = PSA_PBKDF2_STATE_OUTPUT;
5625 break;
5626 case PSA_PBKDF2_STATE_OUTPUT:
5627 break;
5628 default:
5629 return PSA_ERROR_BAD_STATE;
5630 }
5631
5632 while (output_length != 0) {
5633 uint8_t n = prf_output_length - pbkdf2->bytes_used;
5634 if (n > output_length) {
5635 n = (uint8_t) output_length;
5636 }
5637 memcpy(output, pbkdf2->output_block + pbkdf2->bytes_used, n);
5638 output += n;
5639 output_length -= n;
5640 pbkdf2->bytes_used += n;
5641
5642 if (output_length == 0) {
5643 break;
5644 }
5645
5646 /* We need a new block */
5647 pbkdf2->bytes_used = 0;
5648 pbkdf2->block_number++;
5649
5650 status = psa_key_derivation_pbkdf2_generate_block(pbkdf2, prf_alg,
5651 prf_output_length,
5652 &attributes);
5653 if (status != PSA_SUCCESS) {
5654 return status;
5655 }
5656 }
5657
5658 return PSA_SUCCESS;
5659}
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305660#endif /* PSA_HAVE_SOFT_PBKDF2 */
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305661
Janos Follath6c6c8fc2019-06-17 12:38:20 +01005662psa_status_t psa_key_derivation_output_bytes(
5663 psa_key_derivation_operation_t *operation,
5664 uint8_t *output,
Gilles Peskine449bd832023-01-11 14:50:10 +01005665 size_t output_length)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005666{
5667 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01005668 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
Gilles Peskineeab56e42018-07-12 17:12:33 +02005669
Gilles Peskine449bd832023-01-11 14:50:10 +01005670 if (operation->alg == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005671 /* This is a blank operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005672 return PSA_ERROR_BAD_STATE;
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005673 }
5674
Gilles Peskine449bd832023-01-11 14:50:10 +01005675 if (output_length > operation->capacity) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005676 operation->capacity = 0;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005677 /* Go through the error path to wipe all confidential data now
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005678 * that the operation object is useless. */
David Saadab4ecc272019-02-14 13:48:10 +02005679 status = PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005680 goto exit;
5681 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005682 if (output_length == 0 && operation->capacity == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005683 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005684 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02005685 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
5686 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005687 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02005688 * output_length > 0. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005689 return PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005690 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005691 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005692
Przemek Stekiel69c46792022-06-10 12:59:51 +02005693#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01005694 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
5695 status = psa_key_derivation_hkdf_read(&operation->ctx.hkdf, kdf_alg,
5696 output, output_length);
5697 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02005698#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08005699#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5700 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005701 if (PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
5702 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
5703 status = psa_key_derivation_tls12_prf_read(&operation->ctx.tls12_prf,
5704 kdf_alg, output,
5705 output_length);
5706 } else
John Durkop07cc04a2020-11-16 22:08:34 -08005707#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
5708 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005709#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005710 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005711 status = psa_key_derivation_tls12_ecjpake_to_pms_read(
Gilles Peskine449bd832023-01-11 14:50:10 +01005712 &operation->ctx.tls12_ecjpake_to_pms, output, output_length);
5713 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005714#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305715#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05305716 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05305717 status = psa_key_derivation_pbkdf2_read(&operation->ctx.pbkdf2, kdf_alg,
5718 output, output_length);
Kusumit Ghoderao056f0c52023-05-03 15:58:34 +05305719 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305720#endif /* PSA_HAVE_SOFT_PBKDF2 */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005721
Gilles Peskineeab56e42018-07-12 17:12:33 +02005722 {
Steven Cooreman74afe472021-02-10 17:19:22 +01005723 (void) kdf_alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01005724 return PSA_ERROR_BAD_STATE;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005725 }
5726
5727exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005728 if (status != PSA_SUCCESS) {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005729 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005730 * This allows us to differentiate between exhausted operations and
5731 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
5732 * operations. */
5733 psa_algorithm_t alg = operation->alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01005734 psa_key_derivation_abort(operation);
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005735 operation->alg = alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01005736 memset(output, '!', output_length);
Gilles Peskineeab56e42018-07-12 17:12:33 +02005737 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005738 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005739}
5740
David Brown7807bf72021-02-09 16:28:23 -07005741#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01005742static void psa_des_set_key_parity(uint8_t *data, size_t data_size)
Gilles Peskine08542d82018-07-19 17:05:42 +02005743{
Gilles Peskine449bd832023-01-11 14:50:10 +01005744 if (data_size >= 8) {
5745 mbedtls_des_key_set_parity(data);
5746 }
5747 if (data_size >= 16) {
5748 mbedtls_des_key_set_parity(data + 8);
5749 }
5750 if (data_size >= 24) {
5751 mbedtls_des_key_set_parity(data + 16);
5752 }
Gilles Peskine08542d82018-07-19 17:05:42 +02005753}
David Brown7807bf72021-02-09 16:28:23 -07005754#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine08542d82018-07-19 17:05:42 +02005755
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005756/*
Gilles Peskine449bd832023-01-11 14:50:10 +01005757 * ECC keys on a Weierstrass elliptic curve require the generation
5758 * of a private key which is an integer
5759 * in the range [1, N - 1], where N is the boundary of the private key domain:
5760 * N is the prime p for Diffie-Hellman, or the order of the
5761 * curve’s base point for ECC.
5762 *
5763 * Let m be the bit size of N, such that 2^m > N >= 2^(m-1).
5764 * This function generates the private key using the following process:
5765 *
5766 * 1. Draw a byte string of length ceiling(m/8) bytes.
5767 * 2. If m is not a multiple of 8, set the most significant
5768 * (8 * ceiling(m/8) - m) bits of the first byte in the string to zero.
5769 * 3. Convert the string to integer k by decoding it as a big-endian byte string.
5770 * 4. If k > N - 2, discard the result and return to step 1.
5771 * 5. Output k + 1 as the private key.
5772 *
5773 * This method allows compliance to NIST standards, specifically the methods titled
5774 * Key-Pair Generation by Testing Candidates in the following publications:
5775 * - NIST Special Publication 800-56A: Recommendation for Pair-Wise Key-Establishment
5776 * Schemes Using Discrete Logarithm Cryptography [SP800-56A] §5.6.1.1.4 for
5777 * Diffie-Hellman keys.
5778 *
5779 * - [SP800-56A] §5.6.1.2.2 or FIPS Publication 186-4: Digital Signature
5780 * Standard (DSS) [FIPS186-4] §B.4.2 for elliptic curve keys.
5781 *
5782 * Note: Function allocates memory for *data buffer, so given *data should be
5783 * always NULL.
5784 */
Valerio Setti86587ab2023-06-27 13:09:30 +02005785#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE)
5786#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE)
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01005787static psa_status_t psa_generate_derived_ecc_key_weierstrass_helper(
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005788 psa_key_slot_t *slot,
5789 size_t bits,
5790 psa_key_derivation_operation_t *operation,
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005791 uint8_t **data
5792 )
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005793{
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005794 unsigned key_out_of_range = 1;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005795 mbedtls_mpi k;
5796 mbedtls_mpi diff_N_2;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005797 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Przemek Stekiela81aed22022-03-01 15:13:30 +01005798 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01005799 size_t m;
5800 size_t m_bytes;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005801
Gilles Peskine449bd832023-01-11 14:50:10 +01005802 mbedtls_mpi_init(&k);
5803 mbedtls_mpi_init(&diff_N_2);
Przemyslaw Stekiel1dfd1222021-11-18 13:35:00 +01005804
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005805 psa_ecc_family_t curve = PSA_KEY_TYPE_ECC_GET_FAMILY(
Gilles Peskine449bd832023-01-11 14:50:10 +01005806 slot->attr.type);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005807 mbedtls_ecp_group_id grp_id =
Valerio Settid36c3132023-12-21 14:03:51 +01005808 mbedtls_ecc_group_from_psa(curve, bits);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005809
Gilles Peskine449bd832023-01-11 14:50:10 +01005810 if (grp_id == MBEDTLS_ECP_DP_NONE) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005811 ret = MBEDTLS_ERR_ASN1_INVALID_DATA;
Przemyslaw Stekiel871a3362021-12-02 08:46:39 +01005812 goto cleanup;
5813 }
5814
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005815 mbedtls_ecp_group ecp_group;
Gilles Peskine449bd832023-01-11 14:50:10 +01005816 mbedtls_ecp_group_init(&ecp_group);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005817
Gilles Peskine449bd832023-01-11 14:50:10 +01005818 MBEDTLS_MPI_CHK(mbedtls_ecp_group_load(&ecp_group, grp_id));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005819
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005820 /* N is the boundary of the private key domain (ecp_group.N). */
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005821 /* Let m be the bit size of N. */
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01005822 m = ecp_group.nbits;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005823
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01005824 m_bytes = PSA_BITS_TO_BYTES(m);
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005825
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005826 /* Calculate N - 2 - it will be needed later. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005827 MBEDTLS_MPI_CHK(mbedtls_mpi_sub_int(&diff_N_2, &ecp_group.N, 2));
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005828
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005829 /* Note: This function is always called with *data == NULL and it
5830 * allocates memory for the data buffer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005831 *data = mbedtls_calloc(1, m_bytes);
5832 if (*data == NULL) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005833 ret = MBEDTLS_ERR_ASN1_ALLOC_FAILED;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005834 goto cleanup;
5835 }
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005836
Gilles Peskine449bd832023-01-11 14:50:10 +01005837 while (key_out_of_range) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005838 /* 1. Draw a byte string of length ceiling(m/8) bytes. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005839 if ((status = psa_key_derivation_output_bytes(operation, *data, m_bytes)) != 0) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005840 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005841 }
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005842
5843 /* 2. If m is not a multiple of 8 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005844 if (m % 8 != 0) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005845 /* Set the most significant
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005846 * (8 * ceiling(m/8) - m) bits of the first byte in
5847 * the string to zero.
5848 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005849 uint8_t clear_bit_mask = (1 << (m % 8)) - 1;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005850 (*data)[0] &= clear_bit_mask;
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005851 }
5852
5853 /* 3. Convert the string to integer k by decoding it as a
Gilles Peskine449bd832023-01-11 14:50:10 +01005854 * big-endian byte string.
5855 */
5856 MBEDTLS_MPI_CHK(mbedtls_mpi_read_binary(&k, *data, m_bytes));
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005857
5858 /* 4. If k > N - 2, discard the result and return to step 1.
Gilles Peskine449bd832023-01-11 14:50:10 +01005859 * Result of comparison is returned. When it indicates error
5860 * then this function is called again.
5861 */
5862 MBEDTLS_MPI_CHK(mbedtls_mpi_lt_mpi_ct(&diff_N_2, &k, &key_out_of_range));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005863 }
5864
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005865 /* 5. Output k + 1 as the private key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005866 MBEDTLS_MPI_CHK(mbedtls_mpi_add_int(&k, &k, 1));
5867 MBEDTLS_MPI_CHK(mbedtls_mpi_write_binary(&k, *data, m_bytes));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005868cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01005869 if (ret != 0) {
5870 status = mbedtls_to_psa_error(ret);
5871 }
5872 if (status != PSA_SUCCESS) {
5873 mbedtls_free(*data);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005874 *data = NULL;
5875 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005876 mbedtls_mpi_free(&k);
5877 mbedtls_mpi_free(&diff_N_2);
5878 return status;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005879}
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005880
5881/* ECC keys on a Montgomery elliptic curve draws a byte string whose length
5882 * is determined by the curve, and sets the mandatory bits accordingly. That is:
5883 *
5884 * - Curve25519 (PSA_ECC_FAMILY_MONTGOMERY, 255 bits):
5885 * draw a 32-byte string and process it as specified in
5886 * Elliptic Curves for Security [RFC7748] §5.
5887 *
5888 * - Curve448 (PSA_ECC_FAMILY_MONTGOMERY, 448 bits):
5889 * draw a 56-byte string and process it as specified in [RFC7748] §5.
5890 *
5891 * Note: Function allocates memory for *data buffer, so given *data should be
5892 * always NULL.
5893 */
5894
5895static psa_status_t psa_generate_derived_ecc_key_montgomery_helper(
5896 size_t bits,
5897 psa_key_derivation_operation_t *operation,
5898 uint8_t **data
5899 )
5900{
5901 size_t output_length;
Przemek Stekiela81aed22022-03-01 15:13:30 +01005902 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005903
Gilles Peskine449bd832023-01-11 14:50:10 +01005904 switch (bits) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005905 case 255:
5906 output_length = 32;
5907 break;
5908 case 448:
5909 output_length = 56;
5910 break;
5911 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005912 return PSA_ERROR_INVALID_ARGUMENT;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005913 break;
5914 }
5915
Gilles Peskine449bd832023-01-11 14:50:10 +01005916 *data = mbedtls_calloc(1, output_length);
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005917
Gilles Peskine449bd832023-01-11 14:50:10 +01005918 if (*data == NULL) {
5919 return PSA_ERROR_INSUFFICIENT_MEMORY;
5920 }
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005921
Gilles Peskine449bd832023-01-11 14:50:10 +01005922 status = psa_key_derivation_output_bytes(operation, *data, output_length);
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005923
Gilles Peskine449bd832023-01-11 14:50:10 +01005924 if (status != PSA_SUCCESS) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005925 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01005926 }
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005927
Gilles Peskine449bd832023-01-11 14:50:10 +01005928 switch (bits) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005929 case 255:
5930 (*data)[0] &= 248;
5931 (*data)[31] &= 127;
5932 (*data)[31] |= 64;
5933 break;
5934 case 448:
5935 (*data)[0] &= 252;
5936 (*data)[55] |= 128;
5937 break;
5938 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005939 return PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005940 break;
5941 }
5942
5943 return status;
5944}
Valerio Setti86587ab2023-06-27 13:09:30 +02005945#else /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE */
5946static psa_status_t psa_generate_derived_ecc_key_weierstrass_helper(
5947 psa_key_slot_t *slot, size_t bits,
5948 psa_key_derivation_operation_t *operation, uint8_t **data)
5949{
5950 (void) slot;
5951 (void) bits;
5952 (void) operation;
5953 (void) data;
5954 return PSA_ERROR_NOT_SUPPORTED;
5955}
5956
5957static psa_status_t psa_generate_derived_ecc_key_montgomery_helper(
5958 size_t bits, psa_key_derivation_operation_t *operation, uint8_t **data)
5959{
5960 (void) bits;
5961 (void) operation;
5962 (void) data;
5963 return PSA_ERROR_NOT_SUPPORTED;
5964}
5965#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE */
5966#endif /* PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE */
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005967
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01005968static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005969 psa_key_slot_t *slot,
5970 size_t bits,
Gilles Peskine449bd832023-01-11 14:50:10 +01005971 psa_key_derivation_operation_t *operation)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005972{
5973 uint8_t *data = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01005974 size_t bytes = PSA_BITS_TO_BYTES(bits);
Archanad8a83dc2021-06-14 10:04:16 +05305975 size_t storage_size = bytes;
Przemek Stekiela81aed22022-03-01 15:13:30 +01005976 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01005977 psa_key_attributes_t attributes;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005978
Gilles Peskine449bd832023-01-11 14:50:10 +01005979 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(slot->attr.type)) {
5980 return PSA_ERROR_INVALID_ARGUMENT;
5981 }
Gilles Peskineeab56e42018-07-12 17:12:33 +02005982
Valerio Setti8ffdb5d2023-06-20 13:14:08 +02005983#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE) || \
Valerio Settidd24f292023-06-26 12:21:17 +02005984 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE)
Gilles Peskine449bd832023-01-11 14:50:10 +01005985 if (PSA_KEY_TYPE_IS_ECC(slot->attr.type)) {
5986 psa_ecc_family_t curve = PSA_KEY_TYPE_ECC_GET_FAMILY(slot->attr.type);
5987 if (PSA_ECC_FAMILY_IS_WEIERSTRASS(curve)) {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01005988 /* Weierstrass elliptic curve */
Gilles Peskine449bd832023-01-11 14:50:10 +01005989 status = psa_generate_derived_ecc_key_weierstrass_helper(slot, bits, operation, &data);
5990 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005991 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005992 }
5993 } else {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01005994 /* Montgomery elliptic curve */
Gilles Peskine449bd832023-01-11 14:50:10 +01005995 status = psa_generate_derived_ecc_key_montgomery_helper(bits, operation, &data);
5996 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01005997 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005998 }
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01005999 }
Przemyslaw Stekiel1dfd1222021-11-18 13:35:00 +01006000 } else
Valerio Setti8ffdb5d2023-06-20 13:14:08 +02006001#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE) ||
Valerio Settidd24f292023-06-26 12:21:17 +02006002 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE) */
Gilles Peskine449bd832023-01-11 14:50:10 +01006003 if (key_type_is_raw_bytes(slot->attr.type)) {
6004 if (bits % 8 != 0) {
6005 return PSA_ERROR_INVALID_ARGUMENT;
6006 }
6007 data = mbedtls_calloc(1, bytes);
6008 if (data == NULL) {
6009 return PSA_ERROR_INSUFFICIENT_MEMORY;
6010 }
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01006011
Gilles Peskine449bd832023-01-11 14:50:10 +01006012 status = psa_key_derivation_output_bytes(operation, data, bytes);
6013 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01006014 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006015 }
David Brown12ca5032021-02-11 11:02:00 -07006016#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01006017 if (slot->attr.type == PSA_KEY_TYPE_DES) {
6018 psa_des_set_key_parity(data, bytes);
6019 }
Przemek Stekielf110dc02022-03-01 14:48:05 +01006020#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES) */
Gilles Peskine449bd832023-01-11 14:50:10 +01006021 } else {
6022 return PSA_ERROR_NOT_SUPPORTED;
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01006023 }
Ronald Crondd04d422020-11-28 15:14:42 +01006024
Ronald Cronbf33c932020-11-28 18:06:53 +01006025 slot->attr.bits = (psa_key_bits_t) bits;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01006026 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01006027 .core = slot->attr
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01006028 };
6029
Gilles Peskine449bd832023-01-11 14:50:10 +01006030 if (psa_key_lifetime_is_external(attributes.core.lifetime)) {
6031 status = psa_driver_wrapper_get_key_buffer_size(&attributes,
6032 &storage_size);
6033 if (status != PSA_SUCCESS) {
Archanad8a83dc2021-06-14 10:04:16 +05306034 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006035 }
Archanad8a83dc2021-06-14 10:04:16 +05306036 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006037 status = psa_allocate_buffer_to_slot(slot, storage_size);
6038 if (status != PSA_SUCCESS) {
Archanad8a83dc2021-06-14 10:04:16 +05306039 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006040 }
Archanad8a83dc2021-06-14 10:04:16 +05306041
Gilles Peskine449bd832023-01-11 14:50:10 +01006042 status = psa_driver_wrapper_import_key(&attributes,
6043 data, bytes,
6044 slot->key.data,
6045 slot->key.bytes,
6046 &slot->key.bytes, &bits);
6047 if (bits != slot->attr.bits) {
Ronald Cronbf33c932020-11-28 18:06:53 +01006048 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine449bd832023-01-11 14:50:10 +01006049 }
Gilles Peskineeab56e42018-07-12 17:12:33 +02006050
6051exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01006052 mbedtls_free(data);
6053 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02006054}
6055
Gilles Peskine449bd832023-01-11 14:50:10 +01006056psa_status_t psa_key_derivation_output_key(const psa_key_attributes_t *attributes,
6057 psa_key_derivation_operation_t *operation,
6058 mbedtls_svc_key_id_t *key)
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006059{
6060 psa_status_t status;
6061 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02006062 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine0f84d622019-09-12 19:03:13 +02006063
Ronald Cron81709fc2020-11-14 12:10:32 +01006064 *key = MBEDTLS_SVC_KEY_ID_INIT;
6065
Gilles Peskine0f84d622019-09-12 19:03:13 +02006066 /* Reject any attempt to create a zero-length key so that we don't
6067 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006068 if (psa_get_key_bits(attributes) == 0) {
6069 return PSA_ERROR_INVALID_ARGUMENT;
6070 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02006071
Gilles Peskine449bd832023-01-11 14:50:10 +01006072 if (operation->alg == PSA_ALG_NONE) {
6073 return PSA_ERROR_BAD_STATE;
6074 }
Dave Rodgmand69da6c2021-11-16 10:32:48 +00006075
Gilles Peskine449bd832023-01-11 14:50:10 +01006076 if (!operation->can_output_key) {
6077 return PSA_ERROR_NOT_PERMITTED;
6078 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02006079
Gilles Peskine449bd832023-01-11 14:50:10 +01006080 status = psa_start_key_creation(PSA_KEY_CREATION_DERIVE, attributes,
6081 &slot, &driver);
Gilles Peskinef4ee6622019-07-24 13:44:30 +02006082#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006083 if (driver != NULL) {
Gilles Peskinef4ee6622019-07-24 13:44:30 +02006084 /* Deriving a key in a secure element is not implemented yet. */
6085 status = PSA_ERROR_NOT_SUPPORTED;
6086 }
6087#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine449bd832023-01-11 14:50:10 +01006088 if (status == PSA_SUCCESS) {
6089 status = psa_generate_derived_key_internal(slot,
6090 attributes->core.bits,
6091 operation);
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006092 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006093 if (status == PSA_SUCCESS) {
6094 status = psa_finish_key_creation(slot, driver, key);
6095 }
6096 if (status != PSA_SUCCESS) {
6097 psa_fail_key_creation(slot, driver);
6098 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02006099
Gilles Peskine449bd832023-01-11 14:50:10 +01006100 return status;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006101}
6102
Gilles Peskineeab56e42018-07-12 17:12:33 +02006103
6104
6105/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02006106/* Key derivation */
6107/****************************************************************/
6108
Steven Cooreman932ffb72021-02-15 12:14:32 +01006109#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006110static int is_kdf_alg_supported(psa_algorithm_t kdf_alg)
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006111{
6112#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006113 if (PSA_ALG_IS_HKDF(kdf_alg)) {
6114 return 1;
6115 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006116#endif
Przemek Stekielb57a44b2022-06-06 08:33:45 +02006117#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006118 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6119 return 1;
6120 }
Przemek Stekielb57a44b2022-06-06 08:33:45 +02006121#endif
6122#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006123 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
6124 return 1;
6125 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006126#endif
6127#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006128 if (PSA_ALG_IS_TLS12_PRF(kdf_alg)) {
6129 return 1;
6130 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006131#endif
6132#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006133 if (PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
6134 return 1;
6135 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006136#endif
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006137#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006138 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
6139 return 1;
6140 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006141#endif
Kusumit Ghoderaod132cac2023-05-03 12:00:27 +05306142#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
6143 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
6144 return 1;
6145 }
6146#endif
Kusumit Ghoderao2cd64962023-06-22 15:38:57 +05306147#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128)
6148 if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
6149 return 1;
6150 }
6151#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006152 return 0;
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006153}
6154
Gilles Peskine449bd832023-01-11 14:50:10 +01006155static psa_status_t psa_hash_try_support(psa_algorithm_t alg)
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006156{
6157 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01006158 psa_status_t status = psa_hash_setup(&operation, alg);
6159 psa_hash_abort(&operation);
6160 return status;
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006161}
6162
Kusumit Ghoderao86e83dd2023-12-01 16:38:26 +05306163static psa_status_t psa_key_derivation_set_maximum_capacity(
6164 psa_key_derivation_operation_t *operation,
6165 psa_algorithm_t kdf_alg)
6166{
6167#if defined(PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS)
6168 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
6169 operation->capacity = PSA_HASH_LENGTH(PSA_ALG_SHA_256);
6170 return PSA_SUCCESS;
6171 }
6172#endif
6173#if defined(PSA_WANT_ALG_PBKDF2_AES_CMAC_PRF_128)
6174 if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
6175#if (SIZE_MAX > UINT32_MAX)
Kusumit Ghoderao7d4db632023-12-07 16:17:46 +05306176 operation->capacity = UINT32_MAX * (size_t) PSA_MAC_LENGTH(
Kusumit Ghoderaod3f70d32023-12-06 16:20:04 +05306177 PSA_KEY_TYPE_AES,
6178 128U,
6179 PSA_ALG_CMAC);
Kusumit Ghoderao86e83dd2023-12-01 16:38:26 +05306180#else
6181 operation->capacity = SIZE_MAX;
6182#endif
6183 return PSA_SUCCESS;
6184 }
6185#endif /* PSA_WANT_ALG_PBKDF2_AES_CMAC_PRF_128 */
6186
6187 /* After this point, if kdf_alg is not valid then value of hash_alg may be
6188 * invalid or meaningless but it does not affect this function */
6189 psa_algorithm_t hash_alg = PSA_ALG_GET_HASH(kdf_alg);
6190 size_t hash_size = PSA_HASH_LENGTH(hash_alg);
Kusumit Ghoderaod3f70d32023-12-06 16:20:04 +05306191 if (hash_size == 0) {
6192 return PSA_ERROR_NOT_SUPPORTED;
6193 }
Kusumit Ghoderao86e83dd2023-12-01 16:38:26 +05306194
6195 /* Make sure that hash_alg is a supported hash algorithm. Otherwise
6196 * we might fail later, which is somewhat unfriendly and potentially
6197 * risk-prone. */
6198 psa_status_t status = psa_hash_try_support(hash_alg);
6199 if (status != PSA_SUCCESS) {
6200 return status;
6201 }
6202
6203#if defined(PSA_WANT_ALG_HKDF)
6204 if (PSA_ALG_IS_HKDF(kdf_alg)) {
6205 operation->capacity = 255 * hash_size;
6206 } else
6207#endif
6208#if defined(PSA_WANT_ALG_HKDF_EXTRACT)
6209 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6210 operation->capacity = hash_size;
6211 } else
6212#endif
6213#if defined(PSA_WANT_ALG_HKDF_EXPAND)
6214 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
6215 operation->capacity = 255 * hash_size;
6216 } else
6217#endif
6218#if defined(PSA_WANT_ALG_TLS12_PRF)
6219 if (PSA_ALG_IS_TLS12_PRF(kdf_alg) &&
6220 (hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384)) {
6221 operation->capacity = SIZE_MAX;
6222 } else
6223#endif
6224#if defined(PSA_WANT_ALG_TLS12_PSK_TO_MS)
6225 if (PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg) &&
6226 (hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384)) {
6227 /* Master Secret is always 48 bytes
6228 * https://datatracker.ietf.org/doc/html/rfc5246.html#section-8.1 */
6229 operation->capacity = 48U;
6230 } else
6231#endif
6232#if defined(PSA_WANT_ALG_PBKDF2_HMAC)
6233 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
6234#if (SIZE_MAX > UINT32_MAX)
6235 operation->capacity = UINT32_MAX * hash_size;
6236#else
6237 operation->capacity = SIZE_MAX;
6238#endif
6239 } else
6240#endif /* PSA_WANT_ALG_PBKDF2_HMAC */
6241 {
Kusumit Ghoderaod3f70d32023-12-06 16:20:04 +05306242 (void) hash_size;
Kusumit Ghoderao86e83dd2023-12-01 16:38:26 +05306243 status = PSA_ERROR_NOT_SUPPORTED;
6244 }
6245 return status;
6246}
6247
Gilles Peskine969c5d62019-01-16 15:53:06 +01006248static psa_status_t psa_key_derivation_setup_kdf(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006249 psa_key_derivation_operation_t *operation,
Gilles Peskine449bd832023-01-11 14:50:10 +01006250 psa_algorithm_t kdf_alg)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006251{
Janos Follath5fe19732019-06-20 15:09:30 +01006252 /* Make sure that operation->ctx is properly zero-initialised. (Macro
6253 * initialisers for this union leave some bytes unspecified.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01006254 memset(&operation->ctx, 0, sizeof(operation->ctx));
Janos Follath5fe19732019-06-20 15:09:30 +01006255
Gilles Peskine969c5d62019-01-16 15:53:06 +01006256 /* Make sure that kdf_alg is a supported key derivation algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006257 if (!is_kdf_alg_supported(kdf_alg)) {
6258 return PSA_ERROR_NOT_SUPPORTED;
6259 }
John Durkop07cc04a2020-11-16 22:08:34 -08006260
Kusumit Ghoderao86e83dd2023-12-01 16:38:26 +05306261 psa_status_t status = psa_key_derivation_set_maximum_capacity(operation,
6262 kdf_alg);
Kusumit Ghoderao5f3a9382023-09-13 16:28:12 +05306263 return status;
Gilles Peskine969c5d62019-01-16 15:53:06 +01006264}
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006265
Gilles Peskine449bd832023-01-11 14:50:10 +01006266static psa_status_t psa_key_agreement_try_support(psa_algorithm_t alg)
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006267{
6268#if defined(PSA_WANT_ALG_ECDH)
Gilles Peskine449bd832023-01-11 14:50:10 +01006269 if (alg == PSA_ALG_ECDH) {
6270 return PSA_SUCCESS;
6271 }
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006272#endif
Przemek Stekielfb3dd542022-12-01 14:59:15 +01006273#if defined(PSA_WANT_ALG_FFDH)
6274 if (alg == PSA_ALG_FFDH) {
6275 return PSA_SUCCESS;
6276 }
6277#endif
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006278 (void) alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01006279 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006280}
Gilles Peskinebb3814c2022-12-16 01:12:12 +01006281
6282static int psa_key_derivation_allows_free_form_secret_input(
6283 psa_algorithm_t kdf_alg)
6284{
6285#if defined(PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS)
6286 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
6287 return 0;
6288 }
6289#endif
6290 (void) kdf_alg;
6291 return 1;
6292}
John Durkop07cc04a2020-11-16 22:08:34 -08006293#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01006294
Gilles Peskine449bd832023-01-11 14:50:10 +01006295psa_status_t psa_key_derivation_setup(psa_key_derivation_operation_t *operation,
6296 psa_algorithm_t alg)
Gilles Peskine969c5d62019-01-16 15:53:06 +01006297{
6298 psa_status_t status;
6299
Gilles Peskine449bd832023-01-11 14:50:10 +01006300 if (operation->alg != 0) {
6301 return PSA_ERROR_BAD_STATE;
Gilles Peskine969c5d62019-01-16 15:53:06 +01006302 }
Gilles Peskine969c5d62019-01-16 15:53:06 +01006303
Gilles Peskine449bd832023-01-11 14:50:10 +01006304 if (PSA_ALG_IS_RAW_KEY_AGREEMENT(alg)) {
6305 return PSA_ERROR_INVALID_ARGUMENT;
6306 } else if (PSA_ALG_IS_KEY_AGREEMENT(alg)) {
6307#if defined(AT_LEAST_ONE_BUILTIN_KDF)
6308 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF(alg);
6309 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE(alg);
6310 status = psa_key_agreement_try_support(ka_alg);
6311 if (status != PSA_SUCCESS) {
6312 return status;
6313 }
Gilles Peskinebb3814c2022-12-16 01:12:12 +01006314 if (!psa_key_derivation_allows_free_form_secret_input(kdf_alg)) {
6315 return PSA_ERROR_INVALID_ARGUMENT;
6316 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006317 status = psa_key_derivation_setup_kdf(operation, kdf_alg);
6318#else
6319 return PSA_ERROR_NOT_SUPPORTED;
6320#endif /* AT_LEAST_ONE_BUILTIN_KDF */
6321 } else if (PSA_ALG_IS_KEY_DERIVATION(alg)) {
6322#if defined(AT_LEAST_ONE_BUILTIN_KDF)
6323 status = psa_key_derivation_setup_kdf(operation, alg);
6324#else
6325 return PSA_ERROR_NOT_SUPPORTED;
6326#endif /* AT_LEAST_ONE_BUILTIN_KDF */
6327 } else {
6328 return PSA_ERROR_INVALID_ARGUMENT;
6329 }
6330
6331 if (status == PSA_SUCCESS) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006332 operation->alg = alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01006333 }
6334 return status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006335}
6336
Przemek Stekiel69c46792022-06-10 12:59:51 +02006337#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006338static psa_status_t psa_hkdf_input(psa_hkdf_key_derivation_t *hkdf,
6339 psa_algorithm_t kdf_alg,
6340 psa_key_derivation_step_t step,
6341 const uint8_t *data,
6342 size_t data_length)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006343{
Gilles Peskine449bd832023-01-11 14:50:10 +01006344 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006345 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006346 switch (step) {
Gilles Peskine03410b52019-05-16 16:05:19 +02006347 case PSA_KEY_DERIVATION_INPUT_SALT:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006348#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006349 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
6350 return PSA_ERROR_INVALID_ARGUMENT;
6351 }
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006352#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND */
Gilles Peskine449bd832023-01-11 14:50:10 +01006353 if (hkdf->state != HKDF_STATE_INIT) {
6354 return PSA_ERROR_BAD_STATE;
6355 } else {
6356 status = psa_key_derivation_start_hmac(&hkdf->hmac,
6357 hash_alg,
6358 data, data_length);
6359 if (status != PSA_SUCCESS) {
6360 return status;
6361 }
Steven Cooremand1ed1d92021-04-29 19:11:25 +02006362 hkdf->state = HKDF_STATE_STARTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01006363 return PSA_SUCCESS;
Steven Cooremand1ed1d92021-04-29 19:11:25 +02006364 }
Gilles Peskine03410b52019-05-16 16:05:19 +02006365 case PSA_KEY_DERIVATION_INPUT_SECRET:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006366#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006367 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
Przemek Stekiel2fb0dcd2022-05-19 10:34:37 +02006368 /* We shouldn't be in different state as HKDF_EXPAND only allows
6369 * two inputs: SECRET (this case) and INFO which does not modify
6370 * the state. It could happen only if the hkdf
6371 * object was corrupted. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006372 if (hkdf->state != HKDF_STATE_INIT) {
6373 return PSA_ERROR_BAD_STATE;
6374 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006375
Przemek Stekiel2fb0dcd2022-05-19 10:34:37 +02006376 /* Allow only input that fits expected prk size */
Gilles Peskine449bd832023-01-11 14:50:10 +01006377 if (data_length != PSA_HASH_LENGTH(hash_alg)) {
6378 return PSA_ERROR_INVALID_ARGUMENT;
6379 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006380
Gilles Peskine449bd832023-01-11 14:50:10 +01006381 memcpy(hkdf->prk, data, data_length);
6382 } else
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006383#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND */
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006384 {
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006385 /* HKDF: If no salt was provided, use an empty salt.
6386 * HKDF-EXTRACT: salt is mandatory. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006387 if (hkdf->state == HKDF_STATE_INIT) {
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006388#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006389 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6390 return PSA_ERROR_BAD_STATE;
6391 }
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006392#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01006393 status = psa_key_derivation_start_hmac(&hkdf->hmac,
6394 hash_alg,
6395 NULL, 0);
6396 if (status != PSA_SUCCESS) {
6397 return status;
6398 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006399 hkdf->state = HKDF_STATE_STARTED;
6400 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006401 if (hkdf->state != HKDF_STATE_STARTED) {
6402 return PSA_ERROR_BAD_STATE;
6403 }
6404 status = psa_mac_update(&hkdf->hmac,
6405 data, data_length);
6406 if (status != PSA_SUCCESS) {
6407 return status;
6408 }
6409 status = psa_mac_sign_finish(&hkdf->hmac,
6410 hkdf->prk,
6411 sizeof(hkdf->prk),
6412 &data_length);
6413 if (status != PSA_SUCCESS) {
6414 return status;
6415 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006416 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006417
Gilles Peskine2b522db2019-04-12 15:11:49 +02006418 hkdf->state = HKDF_STATE_KEYED;
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006419 hkdf->block_number = 0;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006420#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006421 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006422 /* The only block of output is the PRK. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006423 memcpy(hkdf->output_block, hkdf->prk, PSA_HASH_LENGTH(hash_alg));
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006424 hkdf->offset_in_block = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01006425 } else
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006426#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006427 {
6428 /* Block 0 is empty, and the next block will be
6429 * generated by psa_key_derivation_hkdf_read(). */
Gilles Peskine449bd832023-01-11 14:50:10 +01006430 hkdf->offset_in_block = PSA_HASH_LENGTH(hash_alg);
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006431 }
6432
Gilles Peskine449bd832023-01-11 14:50:10 +01006433 return PSA_SUCCESS;
Gilles Peskine03410b52019-05-16 16:05:19 +02006434 case PSA_KEY_DERIVATION_INPUT_INFO:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006435#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006436 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6437 return PSA_ERROR_INVALID_ARGUMENT;
6438 }
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006439#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Przemek Stekielcde3f782022-06-03 16:12:27 +02006440#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006441 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg) &&
6442 hkdf->state == HKDF_STATE_INIT) {
6443 return PSA_ERROR_BAD_STATE;
6444 }
Przemek Stekielcde3f782022-06-03 16:12:27 +02006445#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01006446 if (hkdf->state == HKDF_STATE_OUTPUT) {
6447 return PSA_ERROR_BAD_STATE;
6448 }
6449 if (hkdf->info_set) {
6450 return PSA_ERROR_BAD_STATE;
6451 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006452 hkdf->info_length = data_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01006453 if (data_length != 0) {
6454 hkdf->info = mbedtls_calloc(1, data_length);
6455 if (hkdf->info == NULL) {
6456 return PSA_ERROR_INSUFFICIENT_MEMORY;
6457 }
6458 memcpy(hkdf->info, data, data_length);
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006459 }
6460 hkdf->info_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01006461 return PSA_SUCCESS;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006462 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006463 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006464 }
6465}
Przemek Stekiel69c46792022-06-10 12:59:51 +02006466#endif /* BUILTIN_ALG_ANY_HKDF */
Janos Follathb03233e2019-06-11 15:30:30 +01006467
John Durkop07cc04a2020-11-16 22:08:34 -08006468#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
6469 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006470static psa_status_t psa_tls12_prf_set_seed(psa_tls12_prf_key_derivation_t *prf,
6471 const uint8_t *data,
6472 size_t data_length)
Janos Follathf08e2652019-06-13 09:05:41 +01006473{
Gilles Peskine449bd832023-01-11 14:50:10 +01006474 if (prf->state != PSA_TLS12_PRF_STATE_INIT) {
6475 return PSA_ERROR_BAD_STATE;
6476 }
Janos Follathf08e2652019-06-13 09:05:41 +01006477
Gilles Peskine449bd832023-01-11 14:50:10 +01006478 if (data_length != 0) {
6479 prf->seed = mbedtls_calloc(1, data_length);
6480 if (prf->seed == NULL) {
6481 return PSA_ERROR_INSUFFICIENT_MEMORY;
6482 }
Janos Follathf08e2652019-06-13 09:05:41 +01006483
Gilles Peskine449bd832023-01-11 14:50:10 +01006484 memcpy(prf->seed, data, data_length);
Janos Follathd6dce9f2019-07-04 09:11:38 +01006485 prf->seed_length = data_length;
6486 }
Janos Follathf08e2652019-06-13 09:05:41 +01006487
Gilles Peskine43f958b2020-12-13 14:55:14 +01006488 prf->state = PSA_TLS12_PRF_STATE_SEED_SET;
Janos Follathf08e2652019-06-13 09:05:41 +01006489
Gilles Peskine449bd832023-01-11 14:50:10 +01006490 return PSA_SUCCESS;
Janos Follathf08e2652019-06-13 09:05:41 +01006491}
6492
Gilles Peskine449bd832023-01-11 14:50:10 +01006493static psa_status_t psa_tls12_prf_set_key(psa_tls12_prf_key_derivation_t *prf,
6494 const uint8_t *data,
6495 size_t data_length)
Janos Follath81550542019-06-13 14:26:34 +01006496{
Gilles Peskine449bd832023-01-11 14:50:10 +01006497 if (prf->state != PSA_TLS12_PRF_STATE_SEED_SET &&
6498 prf->state != PSA_TLS12_PRF_STATE_OTHER_KEY_SET) {
6499 return PSA_ERROR_BAD_STATE;
6500 }
Janos Follath81550542019-06-13 14:26:34 +01006501
Gilles Peskine449bd832023-01-11 14:50:10 +01006502 if (data_length != 0) {
6503 prf->secret = mbedtls_calloc(1, data_length);
6504 if (prf->secret == NULL) {
6505 return PSA_ERROR_INSUFFICIENT_MEMORY;
6506 }
Steven Cooremana6df6042021-04-29 19:32:25 +02006507
Gilles Peskine449bd832023-01-11 14:50:10 +01006508 memcpy(prf->secret, data, data_length);
Steven Cooremana6df6042021-04-29 19:32:25 +02006509 prf->secret_length = data_length;
6510 }
Janos Follath81550542019-06-13 14:26:34 +01006511
Gilles Peskine43f958b2020-12-13 14:55:14 +01006512 prf->state = PSA_TLS12_PRF_STATE_KEY_SET;
Janos Follath81550542019-06-13 14:26:34 +01006513
Gilles Peskine449bd832023-01-11 14:50:10 +01006514 return PSA_SUCCESS;
Janos Follath81550542019-06-13 14:26:34 +01006515}
6516
Gilles Peskine449bd832023-01-11 14:50:10 +01006517static psa_status_t psa_tls12_prf_set_label(psa_tls12_prf_key_derivation_t *prf,
6518 const uint8_t *data,
6519 size_t data_length)
Janos Follath63028dd2019-06-13 09:15:47 +01006520{
Gilles Peskine449bd832023-01-11 14:50:10 +01006521 if (prf->state != PSA_TLS12_PRF_STATE_KEY_SET) {
6522 return PSA_ERROR_BAD_STATE;
6523 }
Janos Follath63028dd2019-06-13 09:15:47 +01006524
Gilles Peskine449bd832023-01-11 14:50:10 +01006525 if (data_length != 0) {
6526 prf->label = mbedtls_calloc(1, data_length);
6527 if (prf->label == NULL) {
6528 return PSA_ERROR_INSUFFICIENT_MEMORY;
6529 }
Janos Follath63028dd2019-06-13 09:15:47 +01006530
Gilles Peskine449bd832023-01-11 14:50:10 +01006531 memcpy(prf->label, data, data_length);
Janos Follathd6dce9f2019-07-04 09:11:38 +01006532 prf->label_length = data_length;
6533 }
Janos Follath63028dd2019-06-13 09:15:47 +01006534
Gilles Peskine43f958b2020-12-13 14:55:14 +01006535 prf->state = PSA_TLS12_PRF_STATE_LABEL_SET;
Janos Follath63028dd2019-06-13 09:15:47 +01006536
Gilles Peskine449bd832023-01-11 14:50:10 +01006537 return PSA_SUCCESS;
Janos Follath63028dd2019-06-13 09:15:47 +01006538}
6539
Gilles Peskine449bd832023-01-11 14:50:10 +01006540static psa_status_t psa_tls12_prf_input(psa_tls12_prf_key_derivation_t *prf,
6541 psa_key_derivation_step_t step,
6542 const uint8_t *data,
6543 size_t data_length)
Janos Follathb03233e2019-06-11 15:30:30 +01006544{
Gilles Peskine449bd832023-01-11 14:50:10 +01006545 switch (step) {
Janos Follathf08e2652019-06-13 09:05:41 +01006546 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskine449bd832023-01-11 14:50:10 +01006547 return psa_tls12_prf_set_seed(prf, data, data_length);
Janos Follath81550542019-06-13 14:26:34 +01006548 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006549 return psa_tls12_prf_set_key(prf, data, data_length);
Janos Follath63028dd2019-06-13 09:15:47 +01006550 case PSA_KEY_DERIVATION_INPUT_LABEL:
Gilles Peskine449bd832023-01-11 14:50:10 +01006551 return psa_tls12_prf_set_label(prf, data, data_length);
Janos Follathb03233e2019-06-11 15:30:30 +01006552 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006553 return PSA_ERROR_INVALID_ARGUMENT;
Janos Follathb03233e2019-06-11 15:30:30 +01006554 }
6555}
John Durkop07cc04a2020-11-16 22:08:34 -08006556#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
6557 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
6558
6559#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
6560static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
6561 psa_tls12_prf_key_derivation_t *prf,
John Durkop07cc04a2020-11-16 22:08:34 -08006562 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006563 size_t data_length)
John Durkop07cc04a2020-11-16 22:08:34 -08006564{
6565 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006566 const size_t pms_len = (prf->state == PSA_TLS12_PRF_STATE_OTHER_KEY_SET ?
6567 4 + data_length + prf->other_secret_length :
6568 4 + 2 * data_length);
John Durkop07cc04a2020-11-16 22:08:34 -08006569
Gilles Peskine449bd832023-01-11 14:50:10 +01006570 if (data_length > PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE) {
6571 return PSA_ERROR_INVALID_ARGUMENT;
6572 }
John Durkop07cc04a2020-11-16 22:08:34 -08006573
Gilles Peskine449bd832023-01-11 14:50:10 +01006574 uint8_t *pms = mbedtls_calloc(1, pms_len);
6575 if (pms == NULL) {
6576 return PSA_ERROR_INSUFFICIENT_MEMORY;
6577 }
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02006578 uint8_t *cur = pms;
6579
6580 /* pure-PSK:
6581 * Quoting RFC 4279, Section 2:
John Durkop07cc04a2020-11-16 22:08:34 -08006582 *
6583 * The premaster secret is formed as follows: if the PSK is N octets
6584 * long, concatenate a uint16 with the value N, N zero octets, a second
6585 * uint16 with the value N, and the PSK itself.
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02006586 *
6587 * mixed-PSK:
6588 * In a DHE-PSK, RSA-PSK, ECDHE-PSK the premaster secret is formed as
6589 * follows: concatenate a uint16 with the length of the other secret,
6590 * the other secret itself, uint16 with the length of PSK, and the
6591 * PSK itself.
6592 * For details please check:
6593 * - RFC 4279, Section 4 for the definition of RSA-PSK,
6594 * - RFC 4279, Section 3 for the definition of DHE-PSK,
6595 * - RFC 5489 for the definition of ECDHE-PSK.
John Durkop07cc04a2020-11-16 22:08:34 -08006596 */
6597
Gilles Peskine449bd832023-01-11 14:50:10 +01006598 if (prf->state == PSA_TLS12_PRF_STATE_OTHER_KEY_SET) {
6599 *cur++ = MBEDTLS_BYTE_1(prf->other_secret_length);
6600 *cur++ = MBEDTLS_BYTE_0(prf->other_secret_length);
6601 if (prf->other_secret_length != 0) {
6602 memcpy(cur, prf->other_secret, prf->other_secret_length);
6603 mbedtls_platform_zeroize(prf->other_secret, prf->other_secret_length);
Przemek Stekiel2503f7e2022-04-12 12:08:01 +02006604 cur += prf->other_secret_length;
6605 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006606 } else {
6607 *cur++ = MBEDTLS_BYTE_1(data_length);
6608 *cur++ = MBEDTLS_BYTE_0(data_length);
6609 memset(cur, 0, data_length);
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02006610 cur += data_length;
6611 }
6612
Gilles Peskine449bd832023-01-11 14:50:10 +01006613 *cur++ = MBEDTLS_BYTE_1(data_length);
6614 *cur++ = MBEDTLS_BYTE_0(data_length);
6615 memcpy(cur, data, data_length);
John Durkop07cc04a2020-11-16 22:08:34 -08006616 cur += data_length;
6617
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00006618 status = psa_tls12_prf_set_key(prf, pms, (size_t) (cur - pms));
John Durkop07cc04a2020-11-16 22:08:34 -08006619
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01006620 mbedtls_zeroize_and_free(pms, pms_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01006621 return status;
John Durkop07cc04a2020-11-16 22:08:34 -08006622}
Janos Follath6660f0e2019-06-17 08:44:03 +01006623
Przemek Stekiele47201b2022-04-19 13:53:28 +02006624static psa_status_t psa_tls12_prf_psk_to_ms_set_other_key(
6625 psa_tls12_prf_key_derivation_t *prf,
6626 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006627 size_t data_length)
Przemek Stekiele47201b2022-04-19 13:53:28 +02006628{
Gilles Peskine449bd832023-01-11 14:50:10 +01006629 if (prf->state != PSA_TLS12_PRF_STATE_SEED_SET) {
6630 return PSA_ERROR_BAD_STATE;
Przemek Stekiele47201b2022-04-19 13:53:28 +02006631 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006632
6633 if (data_length != 0) {
6634 prf->other_secret = mbedtls_calloc(1, data_length);
6635 if (prf->other_secret == NULL) {
6636 return PSA_ERROR_INSUFFICIENT_MEMORY;
6637 }
6638
6639 memcpy(prf->other_secret, data, data_length);
6640 prf->other_secret_length = data_length;
6641 } else {
Przemek Stekiele47201b2022-04-19 13:53:28 +02006642 prf->other_secret_length = 0;
6643 }
6644
6645 prf->state = PSA_TLS12_PRF_STATE_OTHER_KEY_SET;
6646
Gilles Peskine449bd832023-01-11 14:50:10 +01006647 return PSA_SUCCESS;
Przemek Stekiele47201b2022-04-19 13:53:28 +02006648}
6649
Janos Follath6660f0e2019-06-17 08:44:03 +01006650static psa_status_t psa_tls12_prf_psk_to_ms_input(
6651 psa_tls12_prf_key_derivation_t *prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01006652 psa_key_derivation_step_t step,
6653 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006654 size_t data_length)
Janos Follath6660f0e2019-06-17 08:44:03 +01006655{
Gilles Peskine449bd832023-01-11 14:50:10 +01006656 switch (step) {
Przemek Stekiele47201b2022-04-19 13:53:28 +02006657 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006658 return psa_tls12_prf_psk_to_ms_set_key(prf,
6659 data, data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02006660 break;
6661 case PSA_KEY_DERIVATION_INPUT_OTHER_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006662 return psa_tls12_prf_psk_to_ms_set_other_key(prf,
6663 data,
6664 data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02006665 break;
6666 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006667 return psa_tls12_prf_input(prf, step, data, data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02006668 break;
Janos Follath6660f0e2019-06-17 08:44:03 +01006669
Przemek Stekiele47201b2022-04-19 13:53:28 +02006670 }
Janos Follath6660f0e2019-06-17 08:44:03 +01006671}
John Durkop07cc04a2020-11-16 22:08:34 -08006672#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006673
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006674#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
6675static psa_status_t psa_tls12_ecjpake_to_pms_input(
6676 psa_tls12_ecjpake_to_pms_t *ecjpake,
Andrzej Kurek702776f2022-09-16 06:22:44 -04006677 psa_key_derivation_step_t step,
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006678 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006679 size_t data_length)
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006680{
Gilles Peskine449bd832023-01-11 14:50:10 +01006681 if (data_length != PSA_TLS12_ECJPAKE_TO_PMS_INPUT_SIZE ||
6682 step != PSA_KEY_DERIVATION_INPUT_SECRET) {
6683 return PSA_ERROR_INVALID_ARGUMENT;
Andrzej Kurek5603efd2022-09-26 10:49:16 -04006684 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006685
6686 /* Check if the passed point is in an uncompressed form */
Gilles Peskine449bd832023-01-11 14:50:10 +01006687 if (data[0] != 0x04) {
6688 return PSA_ERROR_INVALID_ARGUMENT;
6689 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006690
6691 /* Only K.X has to be extracted - bytes 1 to 32 inclusive. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006692 memcpy(ecjpake->data, data + 1, PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE);
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006693
Gilles Peskine449bd832023-01-11 14:50:10 +01006694 return PSA_SUCCESS;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006695}
6696#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306697
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306698#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306699static psa_status_t psa_pbkdf2_set_input_cost(
6700 psa_pbkdf2_key_derivation_t *pbkdf2,
6701 psa_key_derivation_step_t step,
6702 uint64_t data)
6703{
6704 if (step != PSA_KEY_DERIVATION_INPUT_COST) {
6705 return PSA_ERROR_INVALID_ARGUMENT;
6706 }
6707
6708 if (pbkdf2->state != PSA_PBKDF2_STATE_INIT) {
6709 return PSA_ERROR_BAD_STATE;
6710 }
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05306711
Kusumit Ghoderaoe66a8ad2023-05-24 12:30:43 +05306712 if (data > PSA_VENDOR_PBKDF2_MAX_ITERATIONS) {
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05306713 return PSA_ERROR_NOT_SUPPORTED;
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306714 }
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05306715
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306716 if (data == 0) {
6717 return PSA_ERROR_INVALID_ARGUMENT;
6718 }
Kusumit Ghoderaoe66a8ad2023-05-24 12:30:43 +05306719
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306720 pbkdf2->input_cost = data;
6721 pbkdf2->state = PSA_PBKDF2_STATE_INPUT_COST_SET;
6722
6723 return PSA_SUCCESS;
6724}
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306725
6726static psa_status_t psa_pbkdf2_set_salt(psa_pbkdf2_key_derivation_t *pbkdf2,
6727 const uint8_t *data,
6728 size_t data_length)
6729{
Gilles Peskineead17662023-08-20 22:02:51 +02006730 if (pbkdf2->state == PSA_PBKDF2_STATE_INPUT_COST_SET) {
6731 pbkdf2->state = PSA_PBKDF2_STATE_SALT_SET;
6732 } else if (pbkdf2->state == PSA_PBKDF2_STATE_SALT_SET) {
6733 /* Appending to existing salt. No state change. */
6734 } else {
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306735 return PSA_ERROR_BAD_STATE;
6736 }
6737
Gilles Peskineca57d782023-07-20 19:08:06 +02006738 if (data_length == 0) {
Gilles Peskineead17662023-08-20 22:02:51 +02006739 /* Appending an empty string, nothing to do. */
6740 } else {
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306741 uint8_t *next_salt;
Kusumit Ghoderaob538bb72023-05-24 12:32:14 +05306742
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306743 next_salt = mbedtls_calloc(1, data_length + pbkdf2->salt_length);
6744 if (next_salt == NULL) {
Kusumit Ghoderaod0422f32023-05-08 15:56:19 +05306745 return PSA_ERROR_INSUFFICIENT_MEMORY;
6746 }
6747
Gilles Peskineead17662023-08-20 22:02:51 +02006748 if (pbkdf2->salt_length != 0) {
6749 memcpy(next_salt, pbkdf2->salt, pbkdf2->salt_length);
6750 }
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306751 memcpy(next_salt + pbkdf2->salt_length, data, data_length);
Kusumit Ghoderaod0422f32023-05-08 15:56:19 +05306752 pbkdf2->salt_length += data_length;
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306753 mbedtls_free(pbkdf2->salt);
6754 pbkdf2->salt = next_salt;
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306755 }
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306756 return PSA_SUCCESS;
6757}
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306758
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05306759#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306760static psa_status_t psa_pbkdf2_hmac_set_password(psa_algorithm_t hash_alg,
Kusumit Ghoderaoaac9a582023-05-24 14:19:17 +05306761 const uint8_t *input,
6762 size_t input_len,
6763 uint8_t *output,
Kusumit Ghoderao91f99f52023-05-24 22:21:48 +05306764 size_t *output_len)
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306765{
6766 psa_status_t status = PSA_SUCCESS;
6767 if (input_len > PSA_HASH_BLOCK_LENGTH(hash_alg)) {
6768 status = psa_hash_compute(hash_alg, input, input_len, output,
Kusumit Ghoderao91f99f52023-05-24 22:21:48 +05306769 PSA_HMAC_MAX_HASH_BLOCK_SIZE, output_len);
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306770 } else {
6771 memcpy(output, input, input_len);
Kusumit Ghoderao91f99f52023-05-24 22:21:48 +05306772 *output_len = PSA_HASH_BLOCK_LENGTH(hash_alg);
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306773 }
6774 return status;
6775}
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05306776#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC */
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306777
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05306778#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128)
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306779static psa_status_t psa_pbkdf2_cmac_set_password(const uint8_t *input,
6780 size_t input_len,
6781 uint8_t *output,
6782 size_t *output_len)
6783{
6784 psa_status_t status = PSA_SUCCESS;
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306785 if (input_len != PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC)) {
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306786 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Kusumit Ghoderao3fde8fe2023-06-27 10:41:43 +05306787 uint8_t zeros[16] = { 0 };
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306788 psa_set_key_type(&attributes, PSA_KEY_TYPE_AES);
6789 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(sizeof(zeros)));
6790 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306791 /* Passing PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC) as
Kusumit Ghoderao5f3345a2023-07-27 21:21:38 +05306792 * mac_size as the driver function sets mac_output_length = mac_size
6793 * on success. See https://github.com/Mbed-TLS/mbedtls/issues/7801 */
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306794 status = psa_driver_wrapper_mac_compute(&attributes,
6795 zeros, sizeof(zeros),
6796 PSA_ALG_CMAC, input, input_len,
6797 output,
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306798 PSA_MAC_LENGTH(PSA_KEY_TYPE_AES,
6799 128U,
6800 PSA_ALG_CMAC),
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306801 output_len);
6802 } else {
6803 memcpy(output, input, input_len);
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306804 *output_len = PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC);
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306805 }
6806 return status;
6807}
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05306808#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128 */
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306809
6810static psa_status_t psa_pbkdf2_set_password(psa_pbkdf2_key_derivation_t *pbkdf2,
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306811 psa_algorithm_t kdf_alg,
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306812 const uint8_t *data,
6813 size_t data_length)
6814{
Kusumit Ghoderaoaac9a582023-05-24 14:19:17 +05306815 psa_status_t status = PSA_SUCCESS;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306816 if (pbkdf2->state != PSA_PBKDF2_STATE_SALT_SET) {
6817 return PSA_ERROR_BAD_STATE;
6818 }
6819
Kusumit Ghoderaof3e696d2023-07-28 13:30:50 +05306820#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306821 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
6822 psa_algorithm_t hash_alg = PSA_ALG_PBKDF2_HMAC_GET_HASH(kdf_alg);
6823 status = psa_pbkdf2_hmac_set_password(hash_alg, data, data_length,
6824 pbkdf2->password,
6825 &pbkdf2->password_length);
Kusumit Ghoderaof3e696d2023-07-28 13:30:50 +05306826 } else
6827#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC */
6828#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128)
6829 if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306830 status = psa_pbkdf2_cmac_set_password(data, data_length,
6831 pbkdf2->password,
6832 &pbkdf2->password_length);
Kusumit Ghoderaof3e696d2023-07-28 13:30:50 +05306833 } else
6834#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128 */
6835 {
6836 return PSA_ERROR_INVALID_ARGUMENT;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306837 }
6838
6839 pbkdf2->state = PSA_PBKDF2_STATE_PASSWORD_SET;
6840
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306841 return status;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306842}
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05306843
6844static psa_status_t psa_pbkdf2_input(psa_pbkdf2_key_derivation_t *pbkdf2,
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306845 psa_algorithm_t kdf_alg,
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05306846 psa_key_derivation_step_t step,
6847 const uint8_t *data,
6848 size_t data_length)
6849{
6850 switch (step) {
6851 case PSA_KEY_DERIVATION_INPUT_SALT:
6852 return psa_pbkdf2_set_salt(pbkdf2, data, data_length);
6853 case PSA_KEY_DERIVATION_INPUT_PASSWORD:
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306854 return psa_pbkdf2_set_password(pbkdf2, kdf_alg, data, data_length);
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05306855 default:
6856 return PSA_ERROR_INVALID_ARGUMENT;
6857 }
6858}
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306859#endif /* PSA_HAVE_SOFT_PBKDF2 */
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306860
Gilles Peskineb8965192019-09-24 16:21:10 +02006861/** Check whether the given key type is acceptable for the given
6862 * input step of a key derivation.
6863 *
6864 * Secret inputs must have the type #PSA_KEY_TYPE_DERIVE.
6865 * Non-secret inputs must have the type #PSA_KEY_TYPE_RAW_DATA.
6866 * Both secret and non-secret inputs can alternatively have the type
6867 * #PSA_KEY_TYPE_NONE, which is never the type of a key object, meaning
6868 * that the input was passed as a buffer rather than via a key object.
6869 */
Gilles Peskine224b0d62019-09-23 18:13:17 +02006870static int psa_key_derivation_check_input_type(
6871 psa_key_derivation_step_t step,
Gilles Peskine449bd832023-01-11 14:50:10 +01006872 psa_key_type_t key_type)
Gilles Peskine224b0d62019-09-23 18:13:17 +02006873{
Gilles Peskine449bd832023-01-11 14:50:10 +01006874 switch (step) {
Gilles Peskine224b0d62019-09-23 18:13:17 +02006875 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006876 if (key_type == PSA_KEY_TYPE_DERIVE) {
6877 return PSA_SUCCESS;
6878 }
6879 if (key_type == PSA_KEY_TYPE_NONE) {
6880 return PSA_SUCCESS;
6881 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02006882 break;
Przemek Stekiela7695a22022-04-07 15:39:01 +02006883 case PSA_KEY_DERIVATION_INPUT_OTHER_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006884 if (key_type == PSA_KEY_TYPE_DERIVE) {
6885 return PSA_SUCCESS;
6886 }
6887 if (key_type == PSA_KEY_TYPE_NONE) {
6888 return PSA_SUCCESS;
6889 }
Przemek Stekiela7695a22022-04-07 15:39:01 +02006890 break;
Gilles Peskine224b0d62019-09-23 18:13:17 +02006891 case PSA_KEY_DERIVATION_INPUT_LABEL:
6892 case PSA_KEY_DERIVATION_INPUT_SALT:
6893 case PSA_KEY_DERIVATION_INPUT_INFO:
6894 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskine449bd832023-01-11 14:50:10 +01006895 if (key_type == PSA_KEY_TYPE_RAW_DATA) {
6896 return PSA_SUCCESS;
6897 }
6898 if (key_type == PSA_KEY_TYPE_NONE) {
6899 return PSA_SUCCESS;
6900 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02006901 break;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306902 case PSA_KEY_DERIVATION_INPUT_PASSWORD:
6903 if (key_type == PSA_KEY_TYPE_PASSWORD) {
6904 return PSA_SUCCESS;
6905 }
6906 if (key_type == PSA_KEY_TYPE_DERIVE) {
6907 return PSA_SUCCESS;
6908 }
6909 if (key_type == PSA_KEY_TYPE_NONE) {
6910 return PSA_SUCCESS;
6911 }
6912 break;
Gilles Peskine224b0d62019-09-23 18:13:17 +02006913 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006914 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine224b0d62019-09-23 18:13:17 +02006915}
6916
Janos Follathb80a94e2019-06-12 15:54:46 +01006917static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006918 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01006919 psa_key_derivation_step_t step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02006920 psa_key_type_t key_type,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01006921 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006922 size_t data_length)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006923{
Gilles Peskine46d7faf2019-09-23 19:22:55 +02006924 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006925 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
Gilles Peskine46d7faf2019-09-23 19:22:55 +02006926
Gilles Peskine449bd832023-01-11 14:50:10 +01006927 status = psa_key_derivation_check_input_type(step, key_type);
6928 if (status != PSA_SUCCESS) {
Gilles Peskine224b0d62019-09-23 18:13:17 +02006929 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006930 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02006931
Przemek Stekiel69c46792022-06-10 12:59:51 +02006932#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006933 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
6934 status = psa_hkdf_input(&operation->ctx.hkdf, kdf_alg,
6935 step, data, data_length);
6936 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02006937#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08006938#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006939 if (PSA_ALG_IS_TLS12_PRF(kdf_alg)) {
6940 status = psa_tls12_prf_input(&operation->ctx.tls12_prf,
6941 step, data, data_length);
6942 } else
John Durkop07cc04a2020-11-16 22:08:34 -08006943#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF */
6944#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006945 if (PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
6946 status = psa_tls12_prf_psk_to_ms_input(&operation->ctx.tls12_prf,
6947 step, data, data_length);
6948 } else
John Durkop07cc04a2020-11-16 22:08:34 -08006949#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006950#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006951 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006952 status = psa_tls12_ecjpake_to_pms_input(
Gilles Peskine449bd832023-01-11 14:50:10 +01006953 &operation->ctx.tls12_ecjpake_to_pms, step, data, data_length);
6954 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006955#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306956#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05306957 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306958 status = psa_pbkdf2_input(&operation->ctx.pbkdf2, kdf_alg,
6959 step, data, data_length);
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05306960 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306961#endif /* PSA_HAVE_SOFT_PBKDF2 */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006962 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006963 /* This can't happen unless the operation object was not initialized */
Steven Cooreman74afe472021-02-10 17:19:22 +01006964 (void) data;
6965 (void) data_length;
6966 (void) kdf_alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01006967 return PSA_ERROR_BAD_STATE;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006968 }
6969
Gilles Peskine224b0d62019-09-23 18:13:17 +02006970exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01006971 if (status != PSA_SUCCESS) {
6972 psa_key_derivation_abort(operation);
6973 }
6974 return status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006975}
6976
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05306977static psa_status_t psa_key_derivation_input_integer_internal(
6978 psa_key_derivation_operation_t *operation,
6979 psa_key_derivation_step_t step,
6980 uint64_t value)
6981{
6982 psa_status_t status;
6983 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
6984
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306985#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05306986 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306987 status = psa_pbkdf2_set_input_cost(
6988 &operation->ctx.pbkdf2, step, value);
6989 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306990#endif /* PSA_HAVE_SOFT_PBKDF2 */
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05306991 {
Kusumit Ghoderao3a18dee2023-04-07 16:16:27 +05306992 (void) step;
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05306993 (void) value;
6994 (void) kdf_alg;
Kusumit Ghoderaoa14ae5a2023-04-19 14:16:26 +05306995 status = PSA_ERROR_INVALID_ARGUMENT;
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05306996 }
6997
6998 if (status != PSA_SUCCESS) {
6999 psa_key_derivation_abort(operation);
7000 }
7001 return status;
7002}
7003
Janos Follath51f4a0f2019-06-14 11:35:55 +01007004psa_status_t psa_key_derivation_input_bytes(
7005 psa_key_derivation_operation_t *operation,
7006 psa_key_derivation_step_t step,
7007 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01007008 size_t data_length)
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01007009{
Gilles Peskine449bd832023-01-11 14:50:10 +01007010 return psa_key_derivation_input_internal(operation, step,
7011 PSA_KEY_TYPE_NONE,
7012 data, data_length);
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01007013}
7014
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05307015psa_status_t psa_key_derivation_input_integer(
7016 psa_key_derivation_operation_t *operation,
7017 psa_key_derivation_step_t step,
7018 uint64_t value)
7019{
7020 return psa_key_derivation_input_integer_internal(operation, step, value);
7021}
7022
Janos Follath51f4a0f2019-06-14 11:35:55 +01007023psa_status_t psa_key_derivation_input_key(
7024 psa_key_derivation_operation_t *operation,
7025 psa_key_derivation_step_t step,
Gilles Peskine449bd832023-01-11 14:50:10 +01007026 mbedtls_svc_key_id_t key)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007027{
Ronald Cronf95a2b12020-10-22 15:24:49 +02007028 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01007029 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007030 psa_key_slot_t *slot;
Gilles Peskine178c9aa2019-09-24 18:21:06 +02007031
Ronald Cron5c522922020-11-14 16:35:34 +01007032 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01007033 key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg);
7034 if (status != PSA_SUCCESS) {
7035 psa_key_derivation_abort(operation);
7036 return status;
Gilles Peskine593773d2019-09-23 18:17:40 +02007037 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02007038
Kusumit Ghoderao3128c5d2023-05-03 12:27:57 +05307039 /* Passing a key object as a SECRET or PASSWORD input unlocks the
7040 * permission to output to a key object. */
7041 if (step == PSA_KEY_DERIVATION_INPUT_SECRET ||
7042 step == PSA_KEY_DERIVATION_INPUT_PASSWORD) {
Gilles Peskine178c9aa2019-09-24 18:21:06 +02007043 operation->can_output_key = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01007044 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02007045
Gilles Peskine449bd832023-01-11 14:50:10 +01007046 status = psa_key_derivation_input_internal(operation,
7047 step, slot->attr.type,
7048 slot->key.data,
7049 slot->key.bytes);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007050
Ryan Everett1b70a072024-01-04 10:32:49 +00007051 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007052
Gilles Peskine449bd832023-01-11 14:50:10 +01007053 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007054}
Gilles Peskineea0fb492018-07-12 17:17:20 +02007055
7056
7057
7058/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02007059/* Key agreement */
7060/****************************************************************/
7061
Gilles Peskine449bd832023-01-11 14:50:10 +01007062psa_status_t psa_key_agreement_raw_builtin(const psa_key_attributes_t *attributes,
7063 const uint8_t *key_buffer,
7064 size_t key_buffer_size,
7065 psa_algorithm_t alg,
7066 const uint8_t *peer_key,
7067 size_t peer_key_length,
7068 uint8_t *shared_secret,
7069 size_t shared_secret_size,
7070 size_t *shared_secret_length)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02007071{
Gilles Peskine449bd832023-01-11 14:50:10 +01007072 switch (alg) {
John Durkop6ba40d12020-11-10 08:50:04 -08007073#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskine0216fe12019-04-11 21:23:21 +02007074 case PSA_ALG_ECDH:
Gilles Peskine449bd832023-01-11 14:50:10 +01007075 return mbedtls_psa_key_agreement_ecdh(attributes, key_buffer,
7076 key_buffer_size, alg,
7077 peer_key, peer_key_length,
7078 shared_secret,
7079 shared_secret_size,
7080 shared_secret_length);
Gilles Peskine01d718c2018-09-18 12:01:02 +02007081#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Przemek Stekielfb3dd542022-12-01 14:59:15 +01007082
7083#if defined(MBEDTLS_PSA_BUILTIN_ALG_FFDH)
7084 case PSA_ALG_FFDH:
Przemek Stekiel152bb462023-06-01 11:52:39 +02007085 return mbedtls_psa_ffdh_key_agreement(attributes,
Przemek Stekiel359f4622022-12-05 14:11:55 +01007086 peer_key,
7087 peer_key_length,
7088 key_buffer,
7089 key_buffer_size,
7090 shared_secret,
7091 shared_secret_size,
7092 shared_secret_length);
Przemek Stekielfb3dd542022-12-01 14:59:15 +01007093#endif /* MBEDTLS_PSA_BUILTIN_ALG_FFDH */
7094
Gilles Peskine01d718c2018-09-18 12:01:02 +02007095 default:
Aditya Deshpande17845b82022-10-13 17:21:01 +01007096 (void) attributes;
7097 (void) key_buffer;
7098 (void) key_buffer_size;
Gilles Peskine93f85002018-11-16 16:43:31 +01007099 (void) peer_key;
7100 (void) peer_key_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02007101 (void) shared_secret;
7102 (void) shared_secret_size;
7103 (void) shared_secret_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01007104 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine01d718c2018-09-18 12:01:02 +02007105 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02007106}
Gilles Peskine01d718c2018-09-18 12:01:02 +02007107
Aditya Deshpande17845b82022-10-13 17:21:01 +01007108/** Internal function for raw key agreement
7109 * Calls the driver wrapper which will hand off key agreement task
Aditya Deshpande40c05cc2022-10-14 16:41:40 +01007110 * to the driver's implementation if a driver is present.
7111 * Fallback specified in the driver wrapper is built-in raw key agreement
Aditya Deshpande17845b82022-10-13 17:21:01 +01007112 * (psa_key_agreement_raw_builtin).
7113 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007114static psa_status_t psa_key_agreement_raw_internal(psa_algorithm_t alg,
7115 psa_key_slot_t *private_key,
7116 const uint8_t *peer_key,
7117 size_t peer_key_length,
7118 uint8_t *shared_secret,
7119 size_t shared_secret_size,
7120 size_t *shared_secret_length)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02007121{
Gilles Peskine449bd832023-01-11 14:50:10 +01007122 if (!PSA_ALG_IS_RAW_KEY_AGREEMENT(alg)) {
7123 return PSA_ERROR_NOT_SUPPORTED;
7124 }
Aditya Deshpande17845b82022-10-13 17:21:01 +01007125
7126 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01007127 .core = private_key->attr
Aditya Deshpande17845b82022-10-13 17:21:01 +01007128 };
7129
Gilles Peskine449bd832023-01-11 14:50:10 +01007130 return psa_driver_wrapper_key_agreement(&attributes,
7131 private_key->key.data,
7132 private_key->key.bytes, alg,
7133 peer_key, peer_key_length,
7134 shared_secret,
7135 shared_secret_size,
7136 shared_secret_length);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007137}
7138
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02007139/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine01d718c2018-09-18 12:01:02 +02007140 * to potentially free embedded data structures and wipe confidential data.
7141 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007142static psa_status_t psa_key_agreement_internal(psa_key_derivation_operation_t *operation,
7143 psa_key_derivation_step_t step,
7144 psa_key_slot_t *private_key,
7145 const uint8_t *peer_key,
7146 size_t peer_key_length)
Gilles Peskine01d718c2018-09-18 12:01:02 +02007147{
7148 psa_status_t status;
Aditya Deshpande2f7fd762022-11-22 11:10:34 +00007149 uint8_t shared_secret[PSA_RAW_KEY_AGREEMENT_OUTPUT_MAX_SIZE];
Gilles Peskine01d718c2018-09-18 12:01:02 +02007150 size_t shared_secret_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007151 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE(operation->alg);
Gilles Peskine01d718c2018-09-18 12:01:02 +02007152
7153 /* Step 1: run the secret agreement algorithm to generate the shared
7154 * secret. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007155 status = psa_key_agreement_raw_internal(ka_alg,
7156 private_key,
7157 peer_key, peer_key_length,
7158 shared_secret,
7159 sizeof(shared_secret),
7160 &shared_secret_length);
7161 if (status != PSA_SUCCESS) {
Gilles Peskine12313cd2018-06-20 00:20:32 +02007162 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007163 }
Gilles Peskine12313cd2018-06-20 00:20:32 +02007164
Gilles Peskineb0b255c2018-07-06 17:01:38 +02007165 /* Step 2: set up the key derivation to generate key material from
Gilles Peskine224b0d62019-09-23 18:13:17 +02007166 * the shared secret. A shared secret is permitted wherever a key
7167 * of type DERIVE is permitted. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007168 status = psa_key_derivation_input_internal(operation, step,
7169 PSA_KEY_TYPE_DERIVE,
7170 shared_secret,
7171 shared_secret_length);
Gilles Peskine12313cd2018-06-20 00:20:32 +02007172exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007173 mbedtls_platform_zeroize(shared_secret, shared_secret_length);
7174 return status;
Gilles Peskine12313cd2018-06-20 00:20:32 +02007175}
7176
Gilles Peskine449bd832023-01-11 14:50:10 +01007177psa_status_t psa_key_derivation_key_agreement(psa_key_derivation_operation_t *operation,
7178 psa_key_derivation_step_t step,
7179 mbedtls_svc_key_id_t private_key,
7180 const uint8_t *peer_key,
7181 size_t peer_key_length)
Gilles Peskine12313cd2018-06-20 00:20:32 +02007182{
Ronald Cronf95a2b12020-10-22 15:24:49 +02007183 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01007184 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01007185 psa_key_slot_t *slot;
Ronald Cronf95a2b12020-10-22 15:24:49 +02007186
Gilles Peskine449bd832023-01-11 14:50:10 +01007187 if (!PSA_ALG_IS_KEY_AGREEMENT(operation->alg)) {
7188 return PSA_ERROR_INVALID_ARGUMENT;
7189 }
Ronald Cron5c522922020-11-14 16:35:34 +01007190 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01007191 private_key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg);
7192 if (status != PSA_SUCCESS) {
7193 return status;
7194 }
7195 status = psa_key_agreement_internal(operation, step,
7196 slot,
7197 peer_key, peer_key_length);
7198 if (status != PSA_SUCCESS) {
7199 psa_key_derivation_abort(operation);
7200 } else {
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007201 /* If a private key has been added as SECRET, we allow the derived
7202 * key material to be used as a key in PSA Crypto. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007203 if (step == PSA_KEY_DERIVATION_INPUT_SECRET) {
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007204 operation->can_output_key = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01007205 }
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007206 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007207
Ryan Everett1b70a072024-01-04 10:32:49 +00007208 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007209
Gilles Peskine449bd832023-01-11 14:50:10 +01007210 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskineaf3baab2018-06-27 22:55:52 +02007211}
7212
Gilles Peskine449bd832023-01-11 14:50:10 +01007213psa_status_t psa_raw_key_agreement(psa_algorithm_t alg,
7214 mbedtls_svc_key_id_t private_key,
7215 const uint8_t *peer_key,
7216 size_t peer_key_length,
7217 uint8_t *output,
7218 size_t output_size,
7219 size_t *output_length)
Gilles Peskine0216fe12019-04-11 21:23:21 +02007220{
Ronald Cronf95a2b12020-10-22 15:24:49 +02007221 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01007222 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +02007223 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007224 size_t expected_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02007225
Gilles Peskine449bd832023-01-11 14:50:10 +01007226 if (!PSA_ALG_IS_KEY_AGREEMENT(alg)) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007227 status = PSA_ERROR_INVALID_ARGUMENT;
7228 goto exit;
7229 }
Ronald Cron5c522922020-11-14 16:35:34 +01007230 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01007231 private_key, &slot, PSA_KEY_USAGE_DERIVE, alg);
7232 if (status != PSA_SUCCESS) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007233 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007234 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02007235
Gilles Peskine3e561302022-04-14 00:17:15 +02007236 /* PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() is in general an upper bound
7237 * for the output size. The PSA specification only guarantees that this
7238 * function works if output_size >= PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE(...),
7239 * but it might be nice to allow smaller buffers if the output fits.
7240 * At the time of writing this comment, with only ECDH implemented,
7241 * PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() is exact so the point is moot.
7242 * If FFDH is implemented, PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() can easily
7243 * be exact for it as well. */
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007244 expected_length =
Gilles Peskine449bd832023-01-11 14:50:10 +01007245 PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE(slot->attr.type, slot->attr.bits);
7246 if (output_size < expected_length) {
Gilles Peskine3e561302022-04-14 00:17:15 +02007247 status = PSA_ERROR_BUFFER_TOO_SMALL;
7248 goto exit;
7249 }
7250
Gilles Peskine449bd832023-01-11 14:50:10 +01007251 status = psa_key_agreement_raw_internal(alg, slot,
7252 peer_key, peer_key_length,
7253 output, output_size,
7254 output_length);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007255
7256exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007257 if (status != PSA_SUCCESS) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007258 /* If an error happens and is not handled properly, the output
7259 * may be used as a key to protect sensitive data. Arrange for such
7260 * a key to be random, which is likely to result in decryption or
7261 * verification errors. This is better than filling the buffer with
7262 * some constant data such as zeros, which would result in the data
7263 * being protected with a reproducible, easily knowable key.
7264 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007265 psa_generate_random(output, output_size);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007266 *output_length = output_size;
7267 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007268
Ryan Everett1b70a072024-01-04 10:32:49 +00007269 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007270
Gilles Peskine449bd832023-01-11 14:50:10 +01007271 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine0216fe12019-04-11 21:23:21 +02007272}
Gilles Peskine86a440b2018-11-12 18:39:40 +01007273
7274
Gilles Peskine30524eb2020-11-13 17:02:26 +01007275
Gilles Peskine86a440b2018-11-12 18:39:40 +01007276/****************************************************************/
7277/* Random generation */
Gilles Peskine53d991e2018-07-12 01:14:59 +02007278/****************************************************************/
Gilles Peskine12313cd2018-06-20 00:20:32 +02007279
Gilles Peskine672a7712023-04-28 21:00:28 +02007280#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
7281#include "entropy_poll.h"
7282#endif
7283
Gilles Peskine30524eb2020-11-13 17:02:26 +01007284/** Initialize the PSA random generator.
7285 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007286static void mbedtls_psa_random_init(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01007287{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007288#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine449bd832023-01-11 14:50:10 +01007289 memset(rng, 0, sizeof(*rng));
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007290#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
7291
Gilles Peskine30524eb2020-11-13 17:02:26 +01007292 /* Set default configuration if
7293 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007294 if (rng->entropy_init == NULL) {
Gilles Peskine30524eb2020-11-13 17:02:26 +01007295 rng->entropy_init = mbedtls_entropy_init;
Gilles Peskine449bd832023-01-11 14:50:10 +01007296 }
7297 if (rng->entropy_free == NULL) {
Gilles Peskine30524eb2020-11-13 17:02:26 +01007298 rng->entropy_free = mbedtls_entropy_free;
Gilles Peskine449bd832023-01-11 14:50:10 +01007299 }
Gilles Peskine30524eb2020-11-13 17:02:26 +01007300
Gilles Peskine449bd832023-01-11 14:50:10 +01007301 rng->entropy_init(&rng->entropy);
Gilles Peskine30524eb2020-11-13 17:02:26 +01007302#if defined(MBEDTLS_PSA_INJECT_ENTROPY) && \
7303 defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
7304 /* The PSA entropy injection feature depends on using NV seed as an entropy
7305 * source. Add NV seed as an entropy source for PSA entropy injection. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007306 mbedtls_entropy_add_source(&rng->entropy,
7307 mbedtls_nv_seed_poll, NULL,
7308 MBEDTLS_ENTROPY_BLOCK_SIZE,
7309 MBEDTLS_ENTROPY_SOURCE_STRONG);
Gilles Peskine30524eb2020-11-13 17:02:26 +01007310#endif
7311
Gilles Peskine449bd832023-01-11 14:50:10 +01007312 mbedtls_psa_drbg_init(MBEDTLS_PSA_RANDOM_STATE);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007313#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007314}
7315
7316/** Deinitialize the PSA random generator.
7317 */
Valerio Setti83e0de82023-11-24 12:13:05 +01007318static void mbedtls_psa_random_free(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01007319{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007320#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Valerio Setti83e0de82023-11-24 12:13:05 +01007321 memset(rng, 0, sizeof(*rng));
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007322#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Valerio Setti83e0de82023-11-24 12:13:05 +01007323 mbedtls_psa_drbg_free(MBEDTLS_PSA_RANDOM_STATE);
7324 rng->entropy_free(&rng->entropy);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007325#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007326}
7327
7328/** Seed the PSA random generator.
7329 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007330static psa_status_t mbedtls_psa_random_seed(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01007331{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007332#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
7333 /* Do nothing: the external RNG seeds itself. */
7334 (void) rng;
Gilles Peskine449bd832023-01-11 14:50:10 +01007335 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007336#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007337 const unsigned char drbg_seed[] = "PSA";
Gilles Peskine449bd832023-01-11 14:50:10 +01007338 int ret = mbedtls_psa_drbg_seed(&rng->entropy,
7339 drbg_seed, sizeof(drbg_seed) - 1);
7340 return mbedtls_to_psa_error(ret);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007341#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007342}
7343
Gilles Peskine449bd832023-01-11 14:50:10 +01007344psa_status_t psa_generate_random(uint8_t *output,
7345 size_t output_size)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007346{
Gilles Peskinee59236f2018-01-27 23:32:46 +01007347 GUARD_MODULE_INITIALIZED;
7348
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007349#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
7350
7351 size_t output_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007352 psa_status_t status = mbedtls_psa_external_get_random(&global_data.rng,
7353 output, output_size,
7354 &output_length);
7355 if (status != PSA_SUCCESS) {
7356 return status;
7357 }
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007358 /* Breaking up a request into smaller chunks is currently not supported
Tom Cosgrove1797b052022-12-04 17:19:59 +00007359 * for the external RNG interface. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007360 if (output_length != output_size) {
7361 return PSA_ERROR_INSUFFICIENT_ENTROPY;
7362 }
7363 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007364
7365#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
7366
Gilles Peskine449bd832023-01-11 14:50:10 +01007367 while (output_size > 0) {
Gilles Peskine71ddab92021-01-04 21:01:07 +01007368 size_t request_size =
Gilles Peskine449bd832023-01-11 14:50:10 +01007369 (output_size > MBEDTLS_PSA_RANDOM_MAX_REQUEST ?
7370 MBEDTLS_PSA_RANDOM_MAX_REQUEST :
7371 output_size);
7372 int ret = mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE,
7373 output, request_size);
7374 if (ret != 0) {
7375 return mbedtls_to_psa_error(ret);
7376 }
Gilles Peskine71ddab92021-01-04 21:01:07 +01007377 output_size -= request_size;
7378 output += request_size;
Gilles Peskinef181eca2019-08-07 13:49:00 +02007379 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007380 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007381#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskinee59236f2018-01-27 23:32:46 +01007382}
7383
Gilles Peskine8814fc42020-12-14 15:33:44 +01007384/* Wrapper function allowing the classic API to use the PSA RNG.
Gilles Peskine9c3e0602021-01-05 16:03:55 +01007385 *
7386 * `mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE, ...)` calls
7387 * `psa_generate_random(...)`. The state parameter is ignored since the
7388 * PSA API doesn't support passing an explicit state.
7389 *
7390 * In the non-external case, psa_generate_random() calls an
7391 * `mbedtls_xxx_drbg_random` function which has exactly the same signature
7392 * and semantics as mbedtls_psa_get_random(). As an optimization,
7393 * instead of doing this back-and-forth between the PSA API and the
7394 * classic API, psa_crypto_random_impl.h defines `mbedtls_psa_get_random`
7395 * as a constant function pointer to `mbedtls_xxx_drbg_random`.
Gilles Peskine8814fc42020-12-14 15:33:44 +01007396 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007397#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
7398int mbedtls_psa_get_random(void *p_rng,
7399 unsigned char *output,
7400 size_t output_size)
Gilles Peskine8814fc42020-12-14 15:33:44 +01007401{
Gilles Peskine9c3e0602021-01-05 16:03:55 +01007402 /* This function takes a pointer to the RNG state because that's what
7403 * classic mbedtls functions using an RNG expect. The PSA RNG manages
7404 * its own state internally and doesn't let the caller access that state.
7405 * So we just ignore the state parameter, and in practice we'll pass
7406 * NULL. */
Gilles Peskine8814fc42020-12-14 15:33:44 +01007407 (void) p_rng;
Gilles Peskine449bd832023-01-11 14:50:10 +01007408 psa_status_t status = psa_generate_random(output, output_size);
7409 if (status == PSA_SUCCESS) {
7410 return 0;
7411 } else {
7412 return MBEDTLS_ERR_ENTROPY_SOURCE_FAILED;
7413 }
Gilles Peskine8814fc42020-12-14 15:33:44 +01007414}
7415#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
7416
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01007417#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
Gilles Peskine449bd832023-01-11 14:50:10 +01007418psa_status_t mbedtls_psa_inject_entropy(const uint8_t *seed,
7419 size_t seed_size)
Netanel Gonen2bcd3122018-11-19 11:53:02 +02007420{
Gilles Peskine449bd832023-01-11 14:50:10 +01007421 if (global_data.initialized) {
7422 return PSA_ERROR_NOT_PERMITTED;
7423 }
Netanel Gonen21f37cb2018-11-19 11:53:55 +02007424
Gilles Peskine449bd832023-01-11 14:50:10 +01007425 if (((seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM) ||
7426 (seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE)) ||
7427 (seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE)) {
7428 return PSA_ERROR_INVALID_ARGUMENT;
7429 }
Netanel Gonen21f37cb2018-11-19 11:53:55 +02007430
Gilles Peskine449bd832023-01-11 14:50:10 +01007431 return mbedtls_psa_storage_inject_entropy(seed, seed_size);
Netanel Gonen2bcd3122018-11-19 11:53:02 +02007432}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01007433#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02007434
Ronald Cron3772afe2021-02-08 16:10:05 +01007435/** Validate the key type and size for key generation
Ronald Cron01b2aba2020-10-05 09:42:02 +02007436 *
Ronald Cron3772afe2021-02-08 16:10:05 +01007437 * \param type The key type
7438 * \param bits The number of bits of the key
Ronald Cron01b2aba2020-10-05 09:42:02 +02007439 *
7440 * \retval #PSA_SUCCESS
Ronald Cron3772afe2021-02-08 16:10:05 +01007441 * The key type and size are valid.
Ronald Cron01b2aba2020-10-05 09:42:02 +02007442 * \retval #PSA_ERROR_INVALID_ARGUMENT
7443 * The size in bits of the key is not valid.
7444 * \retval #PSA_ERROR_NOT_SUPPORTED
7445 * The type and/or the size in bits of the key or the combination of
7446 * the two is not supported.
7447 */
Ronald Cron3772afe2021-02-08 16:10:05 +01007448static psa_status_t psa_validate_key_type_and_size_for_key_generation(
Gilles Peskine449bd832023-01-11 14:50:10 +01007449 psa_key_type_t type, size_t bits)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007450{
Ronald Cronf3bb7612020-10-02 20:11:59 +02007451 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007452
Gilles Peskine449bd832023-01-11 14:50:10 +01007453 if (key_type_is_raw_bytes(type)) {
7454 status = psa_validate_unstructured_key_bit_size(type, bits);
7455 if (status != PSA_SUCCESS) {
7456 return status;
7457 }
7458 } else
Valerio Settif6d4dfb2023-07-10 10:55:12 +02007459#if defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007460 if (PSA_KEY_TYPE_IS_RSA(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
7461 if (bits > PSA_VENDOR_RSA_MAX_KEY_BITS) {
7462 return PSA_ERROR_NOT_SUPPORTED;
7463 }
Waleed Elmelegyd7bdbbe2023-07-20 16:26:58 +00007464 if (bits < PSA_VENDOR_RSA_GENERATE_MIN_KEY_BITS) {
Waleed Elmelegyab570712023-07-05 16:40:58 +00007465 return PSA_ERROR_NOT_SUPPORTED;
7466 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +02007467
Ronald Cron01b2aba2020-10-05 09:42:02 +02007468 /* Accept only byte-aligned keys, for the same reasons as
7469 * in psa_import_rsa_key(). */
Gilles Peskine449bd832023-01-11 14:50:10 +01007470 if (bits % 8 != 0) {
7471 return PSA_ERROR_NOT_SUPPORTED;
7472 }
7473 } else
Valerio Settif6d4dfb2023-07-10 10:55:12 +02007474#endif /* defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02007475
Valerio Setti6a9d0ee2023-06-21 10:07:21 +02007476#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007477 if (PSA_KEY_TYPE_IS_ECC(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
Ronald Crond81ab562021-02-16 09:01:16 +01007478 /* To avoid empty block, return successfully here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007479 return PSA_SUCCESS;
7480 } else
Valerio Setti6a9d0ee2023-06-21 10:07:21 +02007481#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_GENERATE) */
Przemek Stekielfedd1342022-12-01 15:00:02 +01007482
Valerio Settia55f0422023-07-10 15:34:41 +02007483#if defined(PSA_WANT_KEY_TYPE_DH_KEY_PAIR_GENERATE)
Przemek Stekielfedd1342022-12-01 15:00:02 +01007484 if (PSA_KEY_TYPE_IS_DH(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
Przemek Stekield1cf1ba2023-04-27 12:04:21 +02007485 if (psa_is_dh_key_size_valid(bits) == 0) {
Przemek Stekielfedd1342022-12-01 15:00:02 +01007486 return PSA_ERROR_NOT_SUPPORTED;
7487 }
7488 } else
Valerio Settia55f0422023-07-10 15:34:41 +02007489#endif /* defined(PSA_WANT_KEY_TYPE_DH_KEY_PAIR_GENERATE) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02007490 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007491 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007492 }
7493
Gilles Peskine449bd832023-01-11 14:50:10 +01007494 return PSA_SUCCESS;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007495}
7496
Ronald Cron55ed0592020-10-05 10:30:40 +02007497psa_status_t psa_generate_key_internal(
Ronald Cron2a38a6b2020-10-02 20:02:04 +02007498 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01007499 uint8_t *key_buffer, size_t key_buffer_size, size_t *key_buffer_length)
Ronald Cron01b2aba2020-10-05 09:42:02 +02007500{
7501 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2a38a6b2020-10-02 20:02:04 +02007502 psa_key_type_t type = attributes->core.type;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007503
Gilles Peskine449bd832023-01-11 14:50:10 +01007504 if ((attributes->domain_parameters == NULL) &&
7505 (attributes->domain_parameters_size != 0)) {
7506 return PSA_ERROR_INVALID_ARGUMENT;
7507 }
Ronald Cron01b2aba2020-10-05 09:42:02 +02007508
Gilles Peskine449bd832023-01-11 14:50:10 +01007509 if (key_type_is_raw_bytes(type)) {
7510 status = psa_generate_random(key_buffer, key_buffer_size);
7511 if (status != PSA_SUCCESS) {
7512 return status;
7513 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +02007514
David Brown12ca5032021-02-11 11:02:00 -07007515#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01007516 if (type == PSA_KEY_TYPE_DES) {
7517 psa_des_set_key_parity(key_buffer, key_buffer_size);
7518 }
David Brown8107e312021-02-12 08:08:46 -07007519#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine449bd832023-01-11 14:50:10 +01007520 } else
Gilles Peskinee59236f2018-01-27 23:32:46 +01007521
Valerio Setti76df8c12023-07-11 14:11:28 +02007522#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007523 if (type == PSA_KEY_TYPE_RSA_KEY_PAIR) {
7524 return mbedtls_psa_rsa_generate_key(attributes,
7525 key_buffer,
7526 key_buffer_size,
7527 key_buffer_length);
7528 } else
Valerio Setti76df8c12023-07-11 14:11:28 +02007529#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_GENERATE) */
Gilles Peskinee59236f2018-01-27 23:32:46 +01007530
Valerio Settibfeaf5b2023-06-20 13:27:46 +02007531#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007532 if (PSA_KEY_TYPE_IS_ECC(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
7533 return mbedtls_psa_ecp_generate_key(attributes,
7534 key_buffer,
7535 key_buffer_size,
7536 key_buffer_length);
7537 } else
Valerio Settibfeaf5b2023-06-20 13:27:46 +02007538#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_GENERATE) */
Przemek Stekielfedd1342022-12-01 15:00:02 +01007539
Valerio Settia55f0422023-07-10 15:34:41 +02007540#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_GENERATE)
Przemek Stekielfedd1342022-12-01 15:00:02 +01007541 if (PSA_KEY_TYPE_IS_DH(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
7542 return mbedtls_psa_ffdh_generate_key(attributes,
7543 key_buffer,
7544 key_buffer_size,
7545 key_buffer_length);
7546 } else
Valerio Settia55f0422023-07-10 15:34:41 +02007547#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_GENERATE) */
Steven Cooreman29149862020-08-05 15:43:42 +02007548 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007549 (void) key_buffer_length;
7550 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman29149862020-08-05 15:43:42 +02007551 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01007552
Gilles Peskine449bd832023-01-11 14:50:10 +01007553 return PSA_SUCCESS;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02007554}
Darryl Green0c6575a2018-11-07 16:05:30 +00007555
Gilles Peskine449bd832023-01-11 14:50:10 +01007556psa_status_t psa_generate_key(const psa_key_attributes_t *attributes,
7557 mbedtls_svc_key_id_t *key)
Gilles Peskineff5f0e72019-04-18 12:53:30 +02007558{
7559 psa_status_t status;
7560 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02007561 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cron2b56bc82020-10-05 10:02:26 +02007562 size_t key_buffer_size;
Gilles Peskine11792082019-08-06 18:36:36 +02007563
Ronald Cron81709fc2020-11-14 12:10:32 +01007564 *key = MBEDTLS_SVC_KEY_ID_INIT;
7565
Gilles Peskine0f84d622019-09-12 19:03:13 +02007566 /* Reject any attempt to create a zero-length key so that we don't
7567 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007568 if (psa_get_key_bits(attributes) == 0) {
7569 return PSA_ERROR_INVALID_ARGUMENT;
7570 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02007571
Przemyslaw Stekielc0fe8202021-10-07 11:08:56 +02007572 /* Reject any attempt to create a public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007573 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(attributes->core.type)) {
7574 return PSA_ERROR_INVALID_ARGUMENT;
7575 }
Przemyslaw Stekielc0fe8202021-10-07 11:08:56 +02007576
Gilles Peskine449bd832023-01-11 14:50:10 +01007577 status = psa_start_key_creation(PSA_KEY_CREATION_GENERATE, attributes,
7578 &slot, &driver);
7579 if (status != PSA_SUCCESS) {
Gilles Peskine11792082019-08-06 18:36:36 +02007580 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007581 }
Gilles Peskine11792082019-08-06 18:36:36 +02007582
Ronald Cron977c2472020-10-13 08:32:21 +02007583 /* In the case of a transparent key or an opaque key stored in local
Archana449608b2021-09-08 15:36:05 +05307584 * storage ( thus not in the case of generating a key in a secure element
7585 * with storage ( MBEDTLS_PSA_CRYPTO_SE_C ) ),we have to allocate a
7586 * buffer to hold the generated key material. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007587 if (slot->key.data == NULL) {
7588 if (PSA_KEY_LIFETIME_GET_LOCATION(attributes->core.lifetime) ==
7589 PSA_KEY_LOCATION_LOCAL_STORAGE) {
Ronald Cron3772afe2021-02-08 16:10:05 +01007590 status = psa_validate_key_type_and_size_for_key_generation(
Gilles Peskine449bd832023-01-11 14:50:10 +01007591 attributes->core.type, attributes->core.bits);
7592 if (status != PSA_SUCCESS) {
Ronald Cron3772afe2021-02-08 16:10:05 +01007593 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007594 }
Ronald Cron3772afe2021-02-08 16:10:05 +01007595
7596 key_buffer_size = PSA_EXPORT_KEY_OUTPUT_SIZE(
Gilles Peskine449bd832023-01-11 14:50:10 +01007597 attributes->core.type,
7598 attributes->core.bits);
7599 } else {
Ronald Cron977c2472020-10-13 08:32:21 +02007600 status = psa_driver_wrapper_get_key_buffer_size(
Gilles Peskine449bd832023-01-11 14:50:10 +01007601 attributes, &key_buffer_size);
7602 if (status != PSA_SUCCESS) {
Ronald Cron3772afe2021-02-08 16:10:05 +01007603 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007604 }
Ronald Cron977c2472020-10-13 08:32:21 +02007605 }
Ronald Cron977c2472020-10-13 08:32:21 +02007606
Gilles Peskine449bd832023-01-11 14:50:10 +01007607 status = psa_allocate_buffer_to_slot(slot, key_buffer_size);
7608 if (status != PSA_SUCCESS) {
Ronald Cron977c2472020-10-13 08:32:21 +02007609 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007610 }
Ronald Cron977c2472020-10-13 08:32:21 +02007611 }
7612
Gilles Peskine449bd832023-01-11 14:50:10 +01007613 status = psa_driver_wrapper_generate_key(attributes,
7614 slot->key.data, slot->key.bytes, &slot->key.bytes);
Gilles Peskine11792082019-08-06 18:36:36 +02007615
Gilles Peskine449bd832023-01-11 14:50:10 +01007616 if (status != PSA_SUCCESS) {
7617 psa_remove_key_data_from_memory(slot);
7618 }
Ronald Cron2b56bc82020-10-05 10:02:26 +02007619
Gilles Peskine11792082019-08-06 18:36:36 +02007620exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007621 if (status == PSA_SUCCESS) {
7622 status = psa_finish_key_creation(slot, driver, key);
7623 }
7624 if (status != PSA_SUCCESS) {
7625 psa_fail_key_creation(slot, driver);
7626 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007627
Gilles Peskine449bd832023-01-11 14:50:10 +01007628 return status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007629}
7630
Gilles Peskinee59236f2018-01-27 23:32:46 +01007631/****************************************************************/
7632/* Module setup */
7633/****************************************************************/
7634
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007635#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine5e769522018-11-20 21:59:56 +01007636psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
Gilles Peskine449bd832023-01-11 14:50:10 +01007637 void (* entropy_init)(mbedtls_entropy_context *ctx),
7638 void (* entropy_free)(mbedtls_entropy_context *ctx))
Gilles Peskine5e769522018-11-20 21:59:56 +01007639{
Gilles Peskine449bd832023-01-11 14:50:10 +01007640 if (global_data.rng_state != RNG_NOT_INITIALIZED) {
7641 return PSA_ERROR_BAD_STATE;
7642 }
Gilles Peskine30524eb2020-11-13 17:02:26 +01007643 global_data.rng.entropy_init = entropy_init;
7644 global_data.rng.entropy_free = entropy_free;
Gilles Peskine449bd832023-01-11 14:50:10 +01007645 return PSA_SUCCESS;
Gilles Peskine5e769522018-11-20 21:59:56 +01007646}
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007647#endif /* !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) */
Gilles Peskine5e769522018-11-20 21:59:56 +01007648
Gilles Peskine449bd832023-01-11 14:50:10 +01007649void mbedtls_psa_crypto_free(void)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007650{
Gilles Peskine449bd832023-01-11 14:50:10 +01007651 psa_wipe_all_key_slots();
Valerio Setti83e0de82023-11-24 12:13:05 +01007652 if (global_data.rng_state != RNG_NOT_INITIALIZED) {
7653 mbedtls_psa_random_free(&global_data.rng);
7654 }
Gilles Peskinec6b69072018-11-20 21:42:52 +01007655 /* Wipe all remaining data, including configuration.
7656 * In particular, this sets all state indicator to the value
7657 * indicating "uninitialized". */
Gilles Peskine449bd832023-01-11 14:50:10 +01007658 mbedtls_platform_zeroize(&global_data, sizeof(global_data));
Ronald Cron9ba76912021-04-10 16:57:30 +02007659
7660 /* Terminate drivers */
Gilles Peskine449bd832023-01-11 14:50:10 +01007661 psa_driver_wrapper_free();
Gilles Peskinee59236f2018-01-27 23:32:46 +01007662}
7663
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007664#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
7665/** Recover a transaction that was interrupted by a power failure.
7666 *
7667 * This function is called during initialization, before psa_crypto_init()
7668 * returns. If this function returns a failure status, the initialization
7669 * fails.
7670 */
7671static psa_status_t psa_crypto_recover_transaction(
Gilles Peskine449bd832023-01-11 14:50:10 +01007672 const psa_crypto_transaction_t *transaction)
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007673{
Gilles Peskine449bd832023-01-11 14:50:10 +01007674 switch (transaction->unknown.type) {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007675 case PSA_CRYPTO_TRANSACTION_CREATE_KEY:
7676 case PSA_CRYPTO_TRANSACTION_DESTROY_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01007677 /* TODO - fall through to the failure case until this
7678 * is implemented.
7679 * https://github.com/ARMmbed/mbed-crypto/issues/218
7680 */
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007681 default:
7682 /* We found an unsupported transaction in the storage.
7683 * We don't know what state the storage is in. Give up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007684 return PSA_ERROR_DATA_INVALID;
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007685 }
7686}
7687#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
7688
Gilles Peskine449bd832023-01-11 14:50:10 +01007689psa_status_t psa_crypto_init(void)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007690{
Gilles Peskine66fb1262018-12-10 16:29:04 +01007691 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007692
Gilles Peskinec6b69072018-11-20 21:42:52 +01007693 /* Double initialization is explicitly allowed. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007694 if (global_data.initialized != 0) {
7695 return PSA_SUCCESS;
7696 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01007697
Manuel Pégourié-Gonnard7abdf7e2023-03-09 11:17:43 +01007698 /* Init drivers */
7699 status = psa_driver_wrapper_init();
7700 if (status != PSA_SUCCESS) {
7701 goto exit;
7702 }
7703 global_data.drivers_initialized = 1;
7704
Valerio Setti402cfba2023-11-13 10:24:32 +01007705 status = psa_initialize_key_slots();
7706 if (status != PSA_SUCCESS) {
7707 goto exit;
7708 }
7709
Gilles Peskine30524eb2020-11-13 17:02:26 +01007710 /* Initialize and seed the random generator. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007711 mbedtls_psa_random_init(&global_data.rng);
Gilles Peskinec6b69072018-11-20 21:42:52 +01007712 global_data.rng_state = RNG_INITIALIZED;
Gilles Peskine449bd832023-01-11 14:50:10 +01007713 status = mbedtls_psa_random_seed(&global_data.rng);
7714 if (status != PSA_SUCCESS) {
Gilles Peskinee59236f2018-01-27 23:32:46 +01007715 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007716 }
Gilles Peskinec6b69072018-11-20 21:42:52 +01007717 global_data.rng_state = RNG_SEEDED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007718
Gilles Peskine4b734222019-07-24 15:56:31 +02007719#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007720 status = psa_crypto_load_transaction();
7721 if (status == PSA_SUCCESS) {
7722 status = psa_crypto_recover_transaction(&psa_crypto_transaction);
7723 if (status != PSA_SUCCESS) {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007724 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007725 }
7726 status = psa_crypto_stop_transaction();
7727 } else if (status == PSA_ERROR_DOES_NOT_EXIST) {
Gilles Peskinefc762652019-07-22 19:30:34 +02007728 /* There's no transaction to complete. It's all good. */
7729 status = PSA_SUCCESS;
7730 }
Gilles Peskine4b734222019-07-24 15:56:31 +02007731#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
Gilles Peskinefc762652019-07-22 19:30:34 +02007732
Gilles Peskinec6b69072018-11-20 21:42:52 +01007733 /* All done. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01007734 global_data.initialized = 1;
7735
7736exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007737 if (status != PSA_SUCCESS) {
7738 mbedtls_psa_crypto_free();
7739 }
7740 return status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007741}
7742
Yanray Wangffc3c482023-07-11 12:01:04 +08007743#if defined(PSA_WANT_ALG_SOME_PAKE)
Przemek Stekielca8d2b22023-01-17 16:21:33 +01007744psa_status_t psa_crypto_driver_pake_get_password_len(
7745 const psa_crypto_driver_pake_inputs_t *inputs,
7746 size_t *password_len)
7747{
7748 if (inputs->password_len == 0) {
7749 return PSA_ERROR_BAD_STATE;
7750 }
7751
7752 *password_len = inputs->password_len;
7753
7754 return PSA_SUCCESS;
7755}
7756
7757psa_status_t psa_crypto_driver_pake_get_password(
7758 const psa_crypto_driver_pake_inputs_t *inputs,
7759 uint8_t *buffer, size_t buffer_size, size_t *buffer_length)
7760{
7761 if (inputs->password_len == 0) {
7762 return PSA_ERROR_BAD_STATE;
7763 }
7764
7765 if (buffer_size < inputs->password_len) {
7766 return PSA_ERROR_BUFFER_TOO_SMALL;
7767 }
7768
7769 memcpy(buffer, inputs->password, inputs->password_len);
7770 *buffer_length = inputs->password_len;
7771
7772 return PSA_SUCCESS;
7773}
7774
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007775psa_status_t psa_crypto_driver_pake_get_user_len(
7776 const psa_crypto_driver_pake_inputs_t *inputs,
7777 size_t *user_len)
7778{
7779 if (inputs->user_len == 0) {
7780 return PSA_ERROR_BAD_STATE;
7781 }
7782
7783 *user_len = inputs->user_len;
7784
7785 return PSA_SUCCESS;
7786}
7787
7788psa_status_t psa_crypto_driver_pake_get_user(
7789 const psa_crypto_driver_pake_inputs_t *inputs,
Przemek Stekielc0e62502023-03-14 11:49:36 +01007790 uint8_t *user_id, size_t user_id_size, size_t *user_id_len)
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007791{
7792 if (inputs->user_len == 0) {
7793 return PSA_ERROR_BAD_STATE;
7794 }
7795
Przemek Stekielc0e62502023-03-14 11:49:36 +01007796 if (user_id_size < inputs->user_len) {
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007797 return PSA_ERROR_BUFFER_TOO_SMALL;
7798 }
7799
Przemek Stekielc0e62502023-03-14 11:49:36 +01007800 memcpy(user_id, inputs->user, inputs->user_len);
7801 *user_id_len = inputs->user_len;
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007802
7803 return PSA_SUCCESS;
7804}
7805
7806psa_status_t psa_crypto_driver_pake_get_peer_len(
7807 const psa_crypto_driver_pake_inputs_t *inputs,
7808 size_t *peer_len)
7809{
7810 if (inputs->peer_len == 0) {
7811 return PSA_ERROR_BAD_STATE;
7812 }
7813
7814 *peer_len = inputs->peer_len;
7815
7816 return PSA_SUCCESS;
7817}
7818
7819psa_status_t psa_crypto_driver_pake_get_peer(
7820 const psa_crypto_driver_pake_inputs_t *inputs,
Przemek Stekielc0e62502023-03-14 11:49:36 +01007821 uint8_t *peer_id, size_t peer_id_size, size_t *peer_id_length)
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007822{
7823 if (inputs->peer_len == 0) {
7824 return PSA_ERROR_BAD_STATE;
7825 }
7826
Przemek Stekielc0e62502023-03-14 11:49:36 +01007827 if (peer_id_size < inputs->peer_len) {
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007828 return PSA_ERROR_BUFFER_TOO_SMALL;
7829 }
7830
Przemek Stekielc0e62502023-03-14 11:49:36 +01007831 memcpy(peer_id, inputs->peer, inputs->peer_len);
7832 *peer_id_length = inputs->peer_len;
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007833
7834 return PSA_SUCCESS;
7835}
7836
Przemek Stekielca8d2b22023-01-17 16:21:33 +01007837psa_status_t psa_crypto_driver_pake_get_cipher_suite(
7838 const psa_crypto_driver_pake_inputs_t *inputs,
7839 psa_pake_cipher_suite_t *cipher_suite)
7840{
7841 if (inputs->cipher_suite.algorithm == PSA_ALG_NONE) {
7842 return PSA_ERROR_BAD_STATE;
7843 }
7844
7845 *cipher_suite = inputs->cipher_suite;
7846
7847 return PSA_SUCCESS;
7848}
7849
Neil Armstronga7d08c32022-06-01 18:21:20 +02007850psa_status_t psa_pake_setup(
7851 psa_pake_operation_t *operation,
7852 const psa_pake_cipher_suite_t *cipher_suite)
7853{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007854 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007855
Przemek Stekiel1c3cfb42023-01-26 10:35:02 +01007856 if (operation->stage != PSA_PAKE_OPERATION_STAGE_SETUP) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007857 status = PSA_ERROR_BAD_STATE;
7858 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007859 }
7860
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01007861 if (PSA_ALG_IS_PAKE(cipher_suite->algorithm) == 0 ||
Przemek Stekiel51eac532022-12-07 11:04:51 +01007862 PSA_ALG_IS_HASH(cipher_suite->hash) == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007863 status = PSA_ERROR_INVALID_ARGUMENT;
7864 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007865 }
7866
Przemek Stekiel51eac532022-12-07 11:04:51 +01007867 memset(&operation->data.inputs, 0, sizeof(operation->data.inputs));
7868
Przemek Stekiele12ed362022-12-21 12:54:46 +01007869 operation->alg = cipher_suite->algorithm;
Przemek Stekiel656b2592023-03-22 13:15:33 +01007870 operation->primitive = PSA_PAKE_PRIMITIVE(cipher_suite->type,
7871 cipher_suite->family, cipher_suite->bits);
Przemek Stekiel51eac532022-12-07 11:04:51 +01007872 operation->data.inputs.cipher_suite = *cipher_suite;
7873
Przemek Stekiel4aa99402023-02-27 13:00:57 +01007874#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01007875 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01007876 psa_jpake_computation_stage_t *computation_stage =
Przemek Stekieldde6a912023-01-26 08:46:37 +01007877 &operation->computation_stage.jpake;
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01007878
David Horstmann16f01512023-06-14 17:21:07 +01007879 memset(computation_stage, 0, sizeof(*computation_stage));
David Horstmanne7f21e62023-05-12 18:17:21 +01007880 computation_stage->step = PSA_PAKE_STEP_KEY_SHARE;
Przemek Stekiel80a88492023-02-20 13:32:22 +01007881 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007882#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01007883 {
7884 status = PSA_ERROR_NOT_SUPPORTED;
7885 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01007886 }
7887
Przemek Stekiel1c3cfb42023-01-26 10:35:02 +01007888 operation->stage = PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS;
7889
Przemek Stekiel51eac532022-12-07 11:04:51 +01007890 return PSA_SUCCESS;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007891exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007892 psa_pake_abort(operation);
7893 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02007894}
7895
7896psa_status_t psa_pake_set_password_key(
7897 psa_pake_operation_t *operation,
7898 mbedtls_svc_key_id_t password)
7899{
Neil Armstrong5ae60962022-09-15 11:29:46 +02007900 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel6c764412022-11-22 14:05:12 +01007901 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
7902 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007903 psa_key_attributes_t attributes;
7904 psa_key_type_t type;
Neil Armstrong5ae60962022-09-15 11:29:46 +02007905
Przemek Stekiel51eac532022-12-07 11:04:51 +01007906 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007907 status = PSA_ERROR_BAD_STATE;
7908 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007909 }
7910
Przemek Stekiel6c764412022-11-22 14:05:12 +01007911 status = psa_get_and_lock_key_slot_with_policy(password, &slot,
7912 PSA_KEY_USAGE_DERIVE,
Przemek Stekield5d28a22023-01-26 10:46:05 +01007913 operation->alg);
Neil Armstrong5ae60962022-09-15 11:29:46 +02007914 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007915 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02007916 }
7917
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007918 attributes = (psa_key_attributes_t) {
Przemek Stekiel6c764412022-11-22 14:05:12 +01007919 .core = slot->attr
7920 };
Neil Armstrong5ae60962022-09-15 11:29:46 +02007921
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007922 type = psa_get_key_type(&attributes);
Neil Armstrong5ae60962022-09-15 11:29:46 +02007923
Przemek Stekiel51eac532022-12-07 11:04:51 +01007924 if (type != PSA_KEY_TYPE_PASSWORD &&
7925 type != PSA_KEY_TYPE_PASSWORD_HASH) {
7926 status = PSA_ERROR_INVALID_ARGUMENT;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007927 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007928 }
7929
Przemek Stekiel51eac532022-12-07 11:04:51 +01007930 operation->data.inputs.password = mbedtls_calloc(1, slot->key.bytes);
7931 if (operation->data.inputs.password == NULL) {
Przemek Stekiele12ed362022-12-21 12:54:46 +01007932 status = PSA_ERROR_INSUFFICIENT_MEMORY;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007933 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007934 }
7935
7936 memcpy(operation->data.inputs.password, slot->key.data, slot->key.bytes);
7937 operation->data.inputs.password_len = slot->key.bytes;
Przemek Stekiel9dd24402023-01-26 15:06:09 +01007938 operation->data.inputs.attributes = attributes;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007939exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007940 if (status != PSA_SUCCESS) {
7941 psa_pake_abort(operation);
7942 }
Ryan Everett1b70a072024-01-04 10:32:49 +00007943 unlock_status = psa_unregister_read(slot);
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007944 return (status == PSA_SUCCESS) ? unlock_status : status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02007945}
7946
7947psa_status_t psa_pake_set_user(
7948 psa_pake_operation_t *operation,
7949 const uint8_t *user_id,
7950 size_t user_id_len)
7951{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007952 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007953
7954 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007955 status = PSA_ERROR_BAD_STATE;
7956 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02007957 }
7958
Przemek Stekiel51eac532022-12-07 11:04:51 +01007959 if (user_id_len == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007960 status = PSA_ERROR_INVALID_ARGUMENT;
7961 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02007962 }
7963
Przemek Stekielf309d6b2023-03-10 09:54:45 +01007964 if (operation->data.inputs.user_len != 0) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007965 status = PSA_ERROR_BAD_STATE;
7966 goto exit;
7967 }
7968
Przemek Stekielf309d6b2023-03-10 09:54:45 +01007969 operation->data.inputs.user = mbedtls_calloc(1, user_id_len);
7970 if (operation->data.inputs.user == NULL) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007971 status = PSA_ERROR_INSUFFICIENT_MEMORY;
7972 goto exit;
7973 }
7974
Przemek Stekielf309d6b2023-03-10 09:54:45 +01007975 memcpy(operation->data.inputs.user, user_id, user_id_len);
7976 operation->data.inputs.user_len = user_id_len;
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007977
7978 return PSA_SUCCESS;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007979exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007980 psa_pake_abort(operation);
7981 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02007982}
7983
7984psa_status_t psa_pake_set_peer(
7985 psa_pake_operation_t *operation,
7986 const uint8_t *peer_id,
7987 size_t peer_id_len)
7988{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007989 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007990
7991 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007992 status = PSA_ERROR_BAD_STATE;
7993 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02007994 }
7995
Przemek Stekiel51eac532022-12-07 11:04:51 +01007996 if (peer_id_len == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007997 status = PSA_ERROR_INVALID_ARGUMENT;
7998 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02007999 }
8000
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008001 if (operation->data.inputs.peer_len != 0) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008002 status = PSA_ERROR_BAD_STATE;
8003 goto exit;
8004 }
8005
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008006 operation->data.inputs.peer = mbedtls_calloc(1, peer_id_len);
8007 if (operation->data.inputs.peer == NULL) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008008 status = PSA_ERROR_INSUFFICIENT_MEMORY;
8009 goto exit;
8010 }
8011
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008012 memcpy(operation->data.inputs.peer, peer_id, peer_id_len);
8013 operation->data.inputs.peer_len = peer_id_len;
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008014
8015 return PSA_SUCCESS;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008016exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008017 psa_pake_abort(operation);
8018 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008019}
8020
8021psa_status_t psa_pake_set_role(
8022 psa_pake_operation_t *operation,
8023 psa_pake_role_t role)
8024{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008025 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008026
Przemek Stekiel51eac532022-12-07 11:04:51 +01008027 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008028 status = PSA_ERROR_BAD_STATE;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008029 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008030 }
8031
Przemek Stekiel09104b82023-03-06 14:11:51 +01008032 switch (operation->alg) {
8033#if defined(PSA_WANT_ALG_JPAKE)
8034 case PSA_ALG_JPAKE:
8035 if (role == PSA_PAKE_ROLE_NONE) {
8036 return PSA_SUCCESS;
8037 }
8038 status = PSA_ERROR_INVALID_ARGUMENT;
8039 break;
8040#endif
8041 default:
8042 (void) role;
8043 status = PSA_ERROR_NOT_SUPPORTED;
8044 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008045 }
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008046exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008047 psa_pake_abort(operation);
8048 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008049}
8050
David Horstmanne7f21e62023-05-12 18:17:21 +01008051/* Auxiliary function to convert core computation stage to single driver step. */
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008052#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiel251e86a2023-02-17 14:30:50 +01008053static psa_crypto_driver_pake_step_t convert_jpake_computation_stage_to_driver_step(
Przemek Stekieldde6a912023-01-26 08:46:37 +01008054 psa_jpake_computation_stage_t *stage)
Przemek Stekielb09c4872023-01-17 12:05:38 +01008055{
David Horstmann74a3d8c2023-06-14 18:28:19 +01008056 psa_crypto_driver_pake_step_t key_share_step;
David Horstmann5da95602023-06-08 15:37:12 +01008057 if (stage->round == PSA_JPAKE_FIRST) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008058 int is_x1;
David Horstmann74a3d8c2023-06-14 18:28:19 +01008059
David Horstmann024e5c52023-06-14 15:48:21 +01008060 if (stage->io_mode == PSA_JPAKE_OUTPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008061 is_x1 = (stage->outputs < 1);
8062 } else {
8063 is_x1 = (stage->inputs < 1);
8064 }
8065
David Horstmann74a3d8c2023-06-14 18:28:19 +01008066 key_share_step = is_x1 ?
8067 PSA_JPAKE_X1_STEP_KEY_SHARE :
8068 PSA_JPAKE_X2_STEP_KEY_SHARE;
David Horstmann5da95602023-06-08 15:37:12 +01008069 } else if (stage->round == PSA_JPAKE_SECOND) {
David Horstmann74a3d8c2023-06-14 18:28:19 +01008070 key_share_step = (stage->io_mode == PSA_JPAKE_OUTPUT) ?
8071 PSA_JPAKE_X2S_STEP_KEY_SHARE :
8072 PSA_JPAKE_X4S_STEP_KEY_SHARE;
8073 } else {
8074 return PSA_JPAKE_STEP_INVALID;
Przemek Stekielb09c4872023-01-17 12:05:38 +01008075 }
Agathiyan Bragadeesh387bfa52023-07-17 17:01:33 +01008076 return (psa_crypto_driver_pake_step_t) (key_share_step + stage->step - PSA_PAKE_STEP_KEY_SHARE);
Przemek Stekielb09c4872023-01-17 12:05:38 +01008077}
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008078#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekielb09c4872023-01-17 12:05:38 +01008079
Przemek Stekiel2797d372022-12-22 11:19:22 +01008080static psa_status_t psa_pake_complete_inputs(
8081 psa_pake_operation_t *operation)
8082{
Przemek Stekiel2797d372022-12-22 11:19:22 +01008083 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel18620a32023-01-17 16:34:52 +01008084 /* Create copy of the inputs on stack as inputs share memory
8085 with the driver context which will be setup by the driver. */
8086 psa_crypto_driver_pake_inputs_t inputs = operation->data.inputs;
Przemek Stekiel2797d372022-12-22 11:19:22 +01008087
Przemek Stekielfde11282023-03-13 16:06:09 +01008088 if (inputs.password_len == 0) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01008089 return PSA_ERROR_BAD_STATE;
8090 }
8091
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008092 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekielfde11282023-03-13 16:06:09 +01008093 if (inputs.user_len == 0 || inputs.peer_len == 0) {
8094 return PSA_ERROR_BAD_STATE;
8095 }
Przemek Stekieldff21d32023-02-14 20:09:10 +01008096 }
8097
Przemek Stekiel18620a32023-01-17 16:34:52 +01008098 /* Clear driver context */
8099 mbedtls_platform_zeroize(&operation->data, sizeof(operation->data));
8100
8101 status = psa_driver_wrapper_pake_setup(operation, &inputs);
Przemek Stekiel2797d372022-12-22 11:19:22 +01008102
8103 /* Driver is responsible for creating its own copy of the password. */
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01008104 mbedtls_zeroize_and_free(inputs.password, inputs.password_len);
Przemek Stekiel2797d372022-12-22 11:19:22 +01008105
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008106 /* User and peer are translated to role. */
8107 mbedtls_free(inputs.user);
8108 mbedtls_free(inputs.peer);
8109
Przemek Stekiel2797d372022-12-22 11:19:22 +01008110 if (status == PSA_SUCCESS) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008111#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiel2797d372022-12-22 11:19:22 +01008112 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekield93de322023-02-24 08:39:04 +01008113 operation->stage = PSA_PAKE_OPERATION_STAGE_COMPUTATION;
Przemek Stekiel80a88492023-02-20 13:32:22 +01008114 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008115#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01008116 {
8117 status = PSA_ERROR_NOT_SUPPORTED;
Przemek Stekiel2797d372022-12-22 11:19:22 +01008118 }
Przemek Stekiel2797d372022-12-22 11:19:22 +01008119 }
Przemek Stekiel2797d372022-12-22 11:19:22 +01008120 return status;
8121}
8122
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008123#if defined(PSA_WANT_ALG_JPAKE)
David Horstmanne7f21e62023-05-12 18:17:21 +01008124static psa_status_t psa_jpake_prologue(
Przemek Stekiele12ed362022-12-21 12:54:46 +01008125 psa_pake_operation_t *operation,
David Horstmanne7f21e62023-05-12 18:17:21 +01008126 psa_pake_step_t step,
David Horstmann00ad6bf2023-06-14 15:44:24 +01008127 psa_jpake_io_mode_t io_mode)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008128{
Przemek Stekiele12ed362022-12-21 12:54:46 +01008129 if (step != PSA_PAKE_STEP_KEY_SHARE &&
8130 step != PSA_PAKE_STEP_ZK_PUBLIC &&
8131 step != PSA_PAKE_STEP_ZK_PROOF) {
8132 return PSA_ERROR_INVALID_ARGUMENT;
8133 }
8134
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008135 psa_jpake_computation_stage_t *computation_stage =
8136 &operation->computation_stage.jpake;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008137
David Horstmann5da95602023-06-08 15:37:12 +01008138 if (computation_stage->round != PSA_JPAKE_FIRST &&
8139 computation_stage->round != PSA_JPAKE_SECOND) {
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008140 return PSA_ERROR_BAD_STATE;
8141 }
8142
David Horstmanne7f21e62023-05-12 18:17:21 +01008143 /* Check that the step we are given is the one we were expecting */
8144 if (step != computation_stage->step) {
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008145 return PSA_ERROR_BAD_STATE;
8146 }
8147
David Horstmanne7f21e62023-05-12 18:17:21 +01008148 if (step == PSA_PAKE_STEP_KEY_SHARE &&
8149 computation_stage->inputs == 0 &&
8150 computation_stage->outputs == 0) {
8151 /* Start of the round, so function decides whether we are inputting
8152 * or outputting */
David Horstmann024e5c52023-06-14 15:48:21 +01008153 computation_stage->io_mode = io_mode;
8154 } else if (computation_stage->io_mode != io_mode) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008155 /* Middle of the round so the mode we are in must match the function
8156 * called by the user */
8157 return PSA_ERROR_BAD_STATE;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008158 }
8159
8160 return PSA_SUCCESS;
8161}
8162
David Horstmanne7f21e62023-05-12 18:17:21 +01008163static psa_status_t psa_jpake_epilogue(
8164 psa_pake_operation_t *operation,
David Horstmann00ad6bf2023-06-14 15:44:24 +01008165 psa_jpake_io_mode_t io_mode)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008166{
David Horstmanne7f21e62023-05-12 18:17:21 +01008167 psa_jpake_computation_stage_t *stage =
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008168 &operation->computation_stage.jpake;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008169
David Horstmanne7f21e62023-05-12 18:17:21 +01008170 if (stage->step == PSA_PAKE_STEP_ZK_PROOF) {
8171 /* End of an input/output */
David Horstmann00ad6bf2023-06-14 15:44:24 +01008172 if (io_mode == PSA_JPAKE_INPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008173 stage->inputs++;
David Horstmann246ec5a2023-06-27 10:33:06 +01008174 if (stage->inputs == PSA_JPAKE_EXPECTED_INPUTS(stage->round)) {
David Horstmann024e5c52023-06-14 15:48:21 +01008175 stage->io_mode = PSA_JPAKE_OUTPUT;
David Horstmanne7f21e62023-05-12 18:17:21 +01008176 }
8177 }
David Horstmann00ad6bf2023-06-14 15:44:24 +01008178 if (io_mode == PSA_JPAKE_OUTPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008179 stage->outputs++;
David Horstmann246ec5a2023-06-27 10:33:06 +01008180 if (stage->outputs == PSA_JPAKE_EXPECTED_OUTPUTS(stage->round)) {
David Horstmann024e5c52023-06-14 15:48:21 +01008181 stage->io_mode = PSA_JPAKE_INPUT;
David Horstmanne7f21e62023-05-12 18:17:21 +01008182 }
8183 }
David Horstmann246ec5a2023-06-27 10:33:06 +01008184 if (stage->inputs == PSA_JPAKE_EXPECTED_INPUTS(stage->round) &&
8185 stage->outputs == PSA_JPAKE_EXPECTED_OUTPUTS(stage->round)) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008186 /* End of a round, move to the next round */
8187 stage->inputs = 0;
8188 stage->outputs = 0;
8189 stage->round++;
8190 }
8191 stage->step = PSA_PAKE_STEP_KEY_SHARE;
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008192 } else {
David Horstmanne7f21e62023-05-12 18:17:21 +01008193 stage->step++;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008194 }
Przemek Stekiele12ed362022-12-21 12:54:46 +01008195 return PSA_SUCCESS;
8196}
David Horstmanne7f21e62023-05-12 18:17:21 +01008197
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008198#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008199
Neil Armstronga7d08c32022-06-01 18:21:20 +02008200psa_status_t psa_pake_output(
8201 psa_pake_operation_t *operation,
8202 psa_pake_step_t step,
8203 uint8_t *output,
8204 size_t output_size,
8205 size_t *output_length)
8206{
Przemek Stekiel51eac532022-12-07 11:04:51 +01008207 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008208 psa_crypto_driver_pake_step_t driver_step = PSA_JPAKE_STEP_INVALID;
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008209 *output_length = 0;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008210
8211 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01008212 status = psa_pake_complete_inputs(operation);
8213 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008214 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008215 }
8216 }
8217
8218 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008219 status = PSA_ERROR_BAD_STATE;
8220 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008221 }
8222
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008223 if (output_size == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008224 status = PSA_ERROR_INVALID_ARGUMENT;
8225 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008226 }
8227
Przemek Stekiele12ed362022-12-21 12:54:46 +01008228 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008229#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008230 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008231 status = psa_jpake_prologue(operation, step, PSA_JPAKE_OUTPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008232 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008233 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008234 }
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008235 driver_step = convert_jpake_computation_stage_to_driver_step(
8236 &operation->computation_stage.jpake);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008237 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008238#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008239 default:
Przemek Stekiel80a88492023-02-20 13:32:22 +01008240 (void) step;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008241 status = PSA_ERROR_NOT_SUPPORTED;
8242 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008243 }
8244
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008245 status = psa_driver_wrapper_pake_output(operation, driver_step,
8246 output, output_size, output_length);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008247
8248 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008249 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008250 }
8251
8252 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008253#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008254 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008255 status = psa_jpake_epilogue(operation, PSA_JPAKE_OUTPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008256 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008257 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008258 }
8259 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008260#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008261 default:
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008262 status = PSA_ERROR_NOT_SUPPORTED;
8263 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008264 }
8265
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008266 return PSA_SUCCESS;
8267exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008268 psa_pake_abort(operation);
8269 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008270}
8271
8272psa_status_t psa_pake_input(
8273 psa_pake_operation_t *operation,
8274 psa_pake_step_t step,
8275 const uint8_t *input,
8276 size_t input_length)
8277{
Przemek Stekiel51eac532022-12-07 11:04:51 +01008278 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008279 psa_crypto_driver_pake_step_t driver_step = PSA_JPAKE_STEP_INVALID;
Przemek Stekiel256c75d2023-03-23 14:09:34 +01008280 const size_t max_input_length = (size_t) PSA_PAKE_INPUT_SIZE(operation->alg,
8281 operation->primitive,
8282 step);
Przemek Stekiel51eac532022-12-07 11:04:51 +01008283
8284 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01008285 status = psa_pake_complete_inputs(operation);
8286 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008287 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008288 }
8289 }
8290
8291 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008292 status = PSA_ERROR_BAD_STATE;
8293 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008294 }
8295
Przemek Stekiel256c75d2023-03-23 14:09:34 +01008296 if (input_length == 0 || input_length > max_input_length) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008297 status = PSA_ERROR_INVALID_ARGUMENT;
8298 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008299 }
8300
Przemek Stekiele12ed362022-12-21 12:54:46 +01008301 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008302#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008303 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008304 status = psa_jpake_prologue(operation, step, PSA_JPAKE_INPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008305 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008306 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008307 }
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008308 driver_step = convert_jpake_computation_stage_to_driver_step(
8309 &operation->computation_stage.jpake);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008310 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008311#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008312 default:
Przemek Stekiel80a88492023-02-20 13:32:22 +01008313 (void) step;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008314 status = PSA_ERROR_NOT_SUPPORTED;
8315 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008316 }
8317
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008318 status = psa_driver_wrapper_pake_input(operation, driver_step,
8319 input, input_length);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008320
8321 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008322 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008323 }
8324
8325 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008326#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008327 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008328 status = psa_jpake_epilogue(operation, PSA_JPAKE_INPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008329 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008330 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008331 }
8332 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008333#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008334 default:
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008335 status = PSA_ERROR_NOT_SUPPORTED;
8336 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008337 }
8338
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008339 return PSA_SUCCESS;
8340exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008341 psa_pake_abort(operation);
8342 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008343}
8344
8345psa_status_t psa_pake_get_implicit_key(
8346 psa_pake_operation_t *operation,
8347 psa_key_derivation_operation_t *output)
8348{
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008349 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008350 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel251e86a2023-02-17 14:30:50 +01008351 uint8_t shared_key[MBEDTLS_PSA_JPAKE_BUFFER_SIZE];
Przemek Stekiel0c781802022-11-29 14:53:13 +01008352 size_t shared_key_len = 0;
8353
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008354 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008355 status = PSA_ERROR_BAD_STATE;
8356 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008357 }
8358
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008359#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008360 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008361 psa_jpake_computation_stage_t *computation_stage =
Przemek Stekiel083745e2023-02-23 17:28:23 +01008362 &operation->computation_stage.jpake;
David Horstmann5da95602023-06-08 15:37:12 +01008363 if (computation_stage->round != PSA_JPAKE_FINISHED) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008364 status = PSA_ERROR_BAD_STATE;
8365 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008366 }
Przemek Stekiel80a88492023-02-20 13:32:22 +01008367 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008368#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01008369 {
8370 status = PSA_ERROR_NOT_SUPPORTED;
8371 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008372 }
8373
Przemek Stekiel0c781802022-11-29 14:53:13 +01008374 status = psa_driver_wrapper_pake_get_implicit_key(operation,
8375 shared_key,
Przemek Stekiel6b648622023-02-19 22:55:33 +01008376 sizeof(shared_key),
Przemek Stekiel0c781802022-11-29 14:53:13 +01008377 &shared_key_len);
8378
8379 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008380 goto exit;
Przemek Stekiel0c781802022-11-29 14:53:13 +01008381 }
8382
8383 status = psa_key_derivation_input_bytes(output,
8384 PSA_KEY_DERIVATION_INPUT_SECRET,
8385 shared_key,
8386 shared_key_len);
8387
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008388 mbedtls_platform_zeroize(shared_key, sizeof(shared_key));
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008389exit:
8390 abort_status = psa_pake_abort(operation);
8391 return status == PSA_SUCCESS ? abort_status : status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008392}
8393
8394psa_status_t psa_pake_abort(
8395 psa_pake_operation_t *operation)
8396{
Przemek Stekield69dca92023-01-31 19:59:20 +01008397 psa_status_t status = PSA_SUCCESS;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008398
Przemek Stekield69dca92023-01-31 19:59:20 +01008399 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008400 status = psa_driver_wrapper_pake_abort(operation);
Neil Armstrong5ae60962022-09-15 11:29:46 +02008401 }
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008402
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008403 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
8404 if (operation->data.inputs.password != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01008405 mbedtls_zeroize_and_free(operation->data.inputs.password,
Przemek Stekielaa183422023-03-06 14:21:44 +01008406 operation->data.inputs.password_len);
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008407 }
8408 if (operation->data.inputs.user != NULL) {
8409 mbedtls_free(operation->data.inputs.user);
8410 }
8411 if (operation->data.inputs.peer != NULL) {
8412 mbedtls_free(operation->data.inputs.peer);
8413 }
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008414 }
Przemek Stekield69dca92023-01-31 19:59:20 +01008415 memset(operation, 0, sizeof(psa_pake_operation_t));
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008416
Przemek Stekield69dca92023-01-31 19:59:20 +01008417 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008418}
Tom Cosgrove6d62fac2023-05-10 14:40:05 +01008419#endif /* PSA_WANT_ALG_SOME_PAKE */
Neil Armstronga7d08c32022-06-01 18:21:20 +02008420
Gilles Peskinee59236f2018-01-27 23:32:46 +01008421#endif /* MBEDTLS_PSA_CRYPTO_C */