blob: 67f6eac6f0e35824f47b1237c58b9c13310740e6 [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)
Ryan Everett73feaf22024-02-14 11:36:41 +00001903 /* If the lock operation fails we still wipe the slot.
1904 * Operations will no longer work after a failed lock,
1905 * but we still need to wipe the slot of confidential data. */
Ryan Everettb7101442024-01-23 20:09:49 +00001906 mbedtls_mutex_lock(&mbedtls_threading_key_slot_mutex);
1907#endif
1908
Gilles Peskine011e4282019-06-26 18:34:38 +02001909#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001910 /* TODO: If the key has already been created in the secure
Gilles Peskine011e4282019-06-26 18:34:38 +02001911 * element, and the failure happened later (when saving metadata
1912 * to internal storage), we need to destroy the key in the secure
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001913 * element.
1914 * https://github.com/ARMmbed/mbed-crypto/issues/217
1915 */
Gilles Peskinefc762652019-07-22 19:30:34 +02001916
Gilles Peskined7729582019-08-05 15:55:54 +02001917 /* Abort the ongoing transaction if any (there may not be one if
1918 * the creation process failed before starting one, or if the
1919 * key creation is a registration of a key in a secure element).
1920 * Earlier functions must already have done what it takes to undo any
1921 * partial creation. All that's left is to update the transaction data
1922 * itself. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001923 (void) psa_crypto_stop_transaction();
Gilles Peskine011e4282019-06-26 18:34:38 +02001924#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1925
Gilles Peskine449bd832023-01-11 14:50:10 +01001926 psa_wipe_key_slot(slot);
Ryan Everettb7101442024-01-23 20:09:49 +00001927
1928#if defined(MBEDTLS_THREADING_C)
1929 mbedtls_mutex_unlock(&mbedtls_threading_key_slot_mutex);
1930#endif
Gilles Peskine4747d192019-04-17 15:05:45 +02001931}
1932
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001933/** Validate optional attributes during key creation.
1934 *
1935 * Some key attributes are optional during key creation. If they are
1936 * specified in the attributes structure, check that they are consistent
1937 * with the data in the slot.
1938 *
1939 * This function should be called near the end of key creation, after
1940 * the slot in memory is fully populated but before saving persistent data.
1941 */
1942static psa_status_t psa_validate_optional_attributes(
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001943 const psa_key_slot_t *slot,
Gilles Peskine449bd832023-01-11 14:50:10 +01001944 const psa_key_attributes_t *attributes)
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001945{
Gilles Peskine449bd832023-01-11 14:50:10 +01001946 if (attributes->core.type != 0) {
1947 if (attributes->core.type != slot->attr.type) {
1948 return PSA_ERROR_INVALID_ARGUMENT;
1949 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001950 }
1951
Gilles Peskine449bd832023-01-11 14:50:10 +01001952 if (attributes->domain_parameters_size != 0) {
Valerio Settib2bcedb2023-07-10 11:24:00 +02001953#if (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) && \
1954 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01001955 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
1956 if (PSA_KEY_TYPE_IS_RSA(slot->attr.type)) {
Steven Cooremana2371e52020-07-28 14:30:39 +02001957 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman75b74362020-07-28 14:30:13 +02001958 mbedtls_mpi actual, required;
Steven Cooreman6d839f02020-07-30 11:36:45 +02001959 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooremana01795d2020-07-24 22:48:15 +02001960
Ronald Cron90857082020-11-25 14:58:33 +01001961 psa_status_t status = mbedtls_psa_rsa_load_representation(
Gilles Peskine449bd832023-01-11 14:50:10 +01001962 slot->attr.type,
1963 slot->key.data,
1964 slot->key.bytes,
1965 &rsa);
1966 if (status != PSA_SUCCESS) {
1967 return status;
1968 }
Steven Cooreman75b74362020-07-28 14:30:13 +02001969
Gilles Peskine449bd832023-01-11 14:50:10 +01001970 mbedtls_mpi_init(&actual);
1971 mbedtls_mpi_init(&required);
1972 ret = mbedtls_rsa_export(rsa,
1973 NULL, NULL, NULL, NULL, &actual);
1974 mbedtls_rsa_free(rsa);
1975 mbedtls_free(rsa);
1976 if (ret != 0) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001977 goto rsa_exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001978 }
1979 ret = mbedtls_mpi_read_binary(&required,
1980 attributes->domain_parameters,
1981 attributes->domain_parameters_size);
1982 if (ret != 0) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001983 goto rsa_exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001984 }
1985 if (mbedtls_mpi_cmp_mpi(&actual, &required) != 0) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001986 ret = MBEDTLS_ERR_RSA_BAD_INPUT_DATA;
Gilles Peskine449bd832023-01-11 14:50:10 +01001987 }
1988rsa_exit:
1989 mbedtls_mpi_free(&actual);
1990 mbedtls_mpi_free(&required);
1991 if (ret != 0) {
1992 return mbedtls_to_psa_error(ret);
1993 }
1994 } else
Valerio Settib2bcedb2023-07-10 11:24:00 +02001995#endif /* (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) &&
1996 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) ||
John Durkop9814fa22020-11-04 12:28:15 -08001997 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001998 {
Gilles Peskine449bd832023-01-11 14:50:10 +01001999 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002000 }
2001 }
2002
Gilles Peskine449bd832023-01-11 14:50:10 +01002003 if (attributes->core.bits != 0) {
2004 if (attributes->core.bits != slot->attr.bits) {
2005 return PSA_ERROR_INVALID_ARGUMENT;
2006 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002007 }
2008
Gilles Peskine449bd832023-01-11 14:50:10 +01002009 return PSA_SUCCESS;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002010}
2011
Gilles Peskine449bd832023-01-11 14:50:10 +01002012psa_status_t psa_import_key(const psa_key_attributes_t *attributes,
2013 const uint8_t *data,
2014 size_t data_length,
2015 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02002016{
2017 psa_status_t status;
2018 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002019 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002020 size_t bits;
Archanad8a83dc2021-06-14 10:04:16 +05302021 size_t storage_size = data_length;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002022
Ronald Cron81709fc2020-11-14 12:10:32 +01002023 *key = MBEDTLS_SVC_KEY_ID_INIT;
2024
Gilles Peskine0f84d622019-09-12 19:03:13 +02002025 /* Reject zero-length symmetric keys (including raw data key objects).
2026 * This also rejects any key which might be encoded as an empty string,
2027 * which is never valid. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002028 if (data_length == 0) {
2029 return PSA_ERROR_INVALID_ARGUMENT;
2030 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02002031
Archana449608b2021-09-08 15:36:05 +05302032 /* Ensure that the bytes-to-bits conversion cannot overflow. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002033 if (data_length > SIZE_MAX / 8) {
2034 return PSA_ERROR_NOT_SUPPORTED;
2035 }
Archana6ed4bda2021-08-04 10:47:15 +05302036
Gilles Peskine449bd832023-01-11 14:50:10 +01002037 status = psa_start_key_creation(PSA_KEY_CREATION_IMPORT, attributes,
2038 &slot, &driver);
2039 if (status != PSA_SUCCESS) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002040 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002041 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002042
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002043 /* In the case of a transparent key or an opaque key stored in local
Archana449608b2021-09-08 15:36:05 +05302044 * storage ( thus not in the case of importing a key in a secure element
2045 * with storage ( MBEDTLS_PSA_CRYPTO_SE_C ) ),we have to allocate a
2046 * buffer to hold the imported key material. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002047 if (slot->key.data == NULL) {
2048 if (psa_key_lifetime_is_external(attributes->core.lifetime)) {
Archana449608b2021-09-08 15:36:05 +05302049 status = psa_driver_wrapper_get_key_buffer_size_from_key_data(
Gilles Peskine449bd832023-01-11 14:50:10 +01002050 attributes, data, data_length, &storage_size);
2051 if (status != PSA_SUCCESS) {
Archanad8a83dc2021-06-14 10:04:16 +05302052 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002053 }
Archanad8a83dc2021-06-14 10:04:16 +05302054 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002055 status = psa_allocate_buffer_to_slot(slot, storage_size);
2056 if (status != PSA_SUCCESS) {
Gilles Peskineb46bef22019-07-30 21:32:04 +02002057 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002058 }
Gilles Peskine5d309672019-07-12 23:47:28 +02002059 }
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002060
2061 bits = slot->attr.bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01002062 status = psa_driver_wrapper_import_key(attributes,
2063 data, data_length,
2064 slot->key.data,
2065 slot->key.bytes,
2066 &slot->key.bytes, &bits);
2067 if (status != PSA_SUCCESS) {
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002068 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002069 }
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002070
Gilles Peskine449bd832023-01-11 14:50:10 +01002071 if (slot->attr.bits == 0) {
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002072 slot->attr.bits = (psa_key_bits_t) bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01002073 } else if (bits != slot->attr.bits) {
Steven Cooremanac3434f2021-01-15 17:36:02 +01002074 status = PSA_ERROR_INVALID_ARGUMENT;
2075 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02002076 }
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01002077
Archana6ed4bda2021-08-04 10:47:15 +05302078 /* Enforce a size limit, and in particular ensure that the bit
2079 * size fits in its representation type.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01002080 if (bits > PSA_MAX_KEY_BITS) {
Archana6ed4bda2021-08-04 10:47:15 +05302081 status = PSA_ERROR_NOT_SUPPORTED;
2082 goto exit;
2083 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002084 status = psa_validate_optional_attributes(slot, attributes);
2085 if (status != PSA_SUCCESS) {
Gilles Peskine18017402019-07-24 20:25:59 +02002086 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002087 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002088
Gilles Peskine449bd832023-01-11 14:50:10 +01002089 status = psa_finish_key_creation(slot, driver, key);
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002090exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002091 if (status != PSA_SUCCESS) {
2092 psa_fail_key_creation(slot, driver);
2093 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002094
Gilles Peskine449bd832023-01-11 14:50:10 +01002095 return status;
Gilles Peskine4747d192019-04-17 15:05:45 +02002096}
2097
Gilles Peskined7729582019-08-05 15:55:54 +02002098#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2099psa_status_t mbedtls_psa_register_se_key(
Gilles Peskine449bd832023-01-11 14:50:10 +01002100 const psa_key_attributes_t *attributes)
Gilles Peskined7729582019-08-05 15:55:54 +02002101{
2102 psa_status_t status;
2103 psa_key_slot_t *slot = NULL;
2104 psa_se_drv_table_entry_t *driver = NULL;
Ronald Croncf56a0a2020-08-04 09:51:30 +02002105 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskined7729582019-08-05 15:55:54 +02002106
2107 /* Leaving attributes unspecified is not currently supported.
2108 * It could make sense to query the key type and size from the
2109 * secure element, but not all secure elements support this
2110 * and the driver HAL doesn't currently support it. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002111 if (psa_get_key_type(attributes) == PSA_KEY_TYPE_NONE) {
2112 return PSA_ERROR_NOT_SUPPORTED;
2113 }
2114 if (psa_get_key_bits(attributes) == 0) {
2115 return PSA_ERROR_NOT_SUPPORTED;
2116 }
Gilles Peskined7729582019-08-05 15:55:54 +02002117
Gilles Peskine449bd832023-01-11 14:50:10 +01002118 status = psa_start_key_creation(PSA_KEY_CREATION_REGISTER, attributes,
2119 &slot, &driver);
2120 if (status != PSA_SUCCESS) {
Gilles Peskined7729582019-08-05 15:55:54 +02002121 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002122 }
Gilles Peskined7729582019-08-05 15:55:54 +02002123
Gilles Peskine449bd832023-01-11 14:50:10 +01002124 status = psa_finish_key_creation(slot, driver, &key);
Gilles Peskined7729582019-08-05 15:55:54 +02002125
2126exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002127 if (status != PSA_SUCCESS) {
2128 psa_fail_key_creation(slot, driver);
2129 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002130
Gilles Peskined7729582019-08-05 15:55:54 +02002131 /* Registration doesn't keep the key in RAM. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002132 psa_close_key(key);
2133 return status;
Gilles Peskined7729582019-08-05 15:55:54 +02002134}
2135#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2136
Gilles Peskine449bd832023-01-11 14:50:10 +01002137psa_status_t psa_copy_key(mbedtls_svc_key_id_t source_key,
2138 const psa_key_attributes_t *specified_attributes,
2139 mbedtls_svc_key_id_t *target_key)
Gilles Peskinef603c712019-01-19 13:40:11 +01002140{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002141 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01002142 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinef603c712019-01-19 13:40:11 +01002143 psa_key_slot_t *source_slot = NULL;
2144 psa_key_slot_t *target_slot = NULL;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002145 psa_key_attributes_t actual_attributes = *specified_attributes;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002146 psa_se_drv_table_entry_t *driver = NULL;
Archana8a180362021-07-05 02:18:48 +05302147 size_t storage_size = 0;
Gilles Peskinef603c712019-01-19 13:40:11 +01002148
Ronald Cron81709fc2020-11-14 12:10:32 +01002149 *target_key = MBEDTLS_SVC_KEY_ID_INIT;
2150
Archana8a180362021-07-05 02:18:48 +05302151 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002152 source_key, &source_slot, PSA_KEY_USAGE_COPY, 0);
2153 if (status != PSA_SUCCESS) {
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002154 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002155 }
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002156
Gilles Peskine449bd832023-01-11 14:50:10 +01002157 status = psa_validate_optional_attributes(source_slot,
2158 specified_attributes);
2159 if (status != PSA_SUCCESS) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002160 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002161 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002162
Archana9d17bf42021-09-10 06:22:44 +05302163 /* The target key type and number of bits have been validated by
2164 * psa_validate_optional_attributes() to be either equal to zero or
2165 * equal to the ones of the source key. So it is safe to inherit
2166 * them from the source key now."
Archana374fe5b2021-09-08 15:50:28 +05302167 * */
Archana9d17bf42021-09-10 06:22:44 +05302168 actual_attributes.core.bits = source_slot->attr.bits;
2169 actual_attributes.core.type = source_slot->attr.type;
Archana374fe5b2021-09-08 15:50:28 +05302170
2171
Gilles Peskine449bd832023-01-11 14:50:10 +01002172 status = psa_restrict_key_policy(source_slot->attr.type,
2173 &actual_attributes.core.policy,
2174 &source_slot->attr.policy);
2175 if (status != PSA_SUCCESS) {
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002176 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002177 }
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002178
Gilles Peskine449bd832023-01-11 14:50:10 +01002179 status = psa_start_key_creation(PSA_KEY_CREATION_COPY, &actual_attributes,
2180 &target_slot, &driver);
2181 if (status != PSA_SUCCESS) {
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002182 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002183 }
2184 if (PSA_KEY_LIFETIME_GET_LOCATION(target_slot->attr.lifetime) !=
2185 PSA_KEY_LIFETIME_GET_LOCATION(source_slot->attr.lifetime)) {
Archana8a180362021-07-05 02:18:48 +05302186 /*
Archana9d17bf42021-09-10 06:22:44 +05302187 * If the source and target keys are stored in different locations,
Archana8a180362021-07-05 02:18:48 +05302188 * the source key would need to be exported as plaintext and re-imported
2189 * in the other location. This has security implications which have not
Archana449608b2021-09-08 15:36:05 +05302190 * been fully mapped. For now, this can be achieved through
Archana8a180362021-07-05 02:18:48 +05302191 * appropriate API invocations from the application, if needed.
2192 * */
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002193 status = PSA_ERROR_NOT_SUPPORTED;
2194 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002195 }
Archana8a180362021-07-05 02:18:48 +05302196 /*
2197 * When the source and target keys are within the same location,
Archana449608b2021-09-08 15:36:05 +05302198 * - For transparent keys it is a blind copy without any driver invocation,
Archana8a180362021-07-05 02:18:48 +05302199 * - For opaque keys this translates to an invocation of the drivers'
2200 * copy_key entry point through the dispatch layer.
2201 * */
Gilles Peskine449bd832023-01-11 14:50:10 +01002202 if (psa_key_lifetime_is_external(actual_attributes.core.lifetime)) {
2203 status = psa_driver_wrapper_get_key_buffer_size(&actual_attributes,
2204 &storage_size);
2205 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302206 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002207 }
Archana374fe5b2021-09-08 15:50:28 +05302208
Gilles Peskine449bd832023-01-11 14:50:10 +01002209 status = psa_allocate_buffer_to_slot(target_slot, storage_size);
2210 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302211 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002212 }
Archana374fe5b2021-09-08 15:50:28 +05302213
Gilles Peskine449bd832023-01-11 14:50:10 +01002214 status = psa_driver_wrapper_copy_key(&actual_attributes,
2215 source_slot->key.data,
2216 source_slot->key.bytes,
2217 target_slot->key.data,
2218 target_slot->key.bytes,
2219 &target_slot->key.bytes);
2220 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302221 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002222 }
2223 } else {
2224 status = psa_copy_key_material_into_slot(target_slot,
Archana9d17bf42021-09-10 06:22:44 +05302225 source_slot->key.data,
Gilles Peskine449bd832023-01-11 14:50:10 +01002226 source_slot->key.bytes);
2227 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302228 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002229 }
Archana8a180362021-07-05 02:18:48 +05302230 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002231 status = psa_finish_key_creation(target_slot, driver, target_key);
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002232exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002233 if (status != PSA_SUCCESS) {
2234 psa_fail_key_creation(target_slot, driver);
2235 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002236
Ryan Everett1b70a072024-01-04 10:32:49 +00002237 unlock_status = psa_unregister_read(source_slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02002238
Gilles Peskine449bd832023-01-11 14:50:10 +01002239 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskinef603c712019-01-19 13:40:11 +01002240}
2241
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02002242
2243
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01002244/****************************************************************/
Gilles Peskine20035e32018-02-03 22:44:14 +01002245/* Message digests */
2246/****************************************************************/
2247
Gilles Peskine449bd832023-01-11 14:50:10 +01002248psa_status_t psa_hash_abort(psa_hash_operation_t *operation)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002249{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002250 /* Aborting a non-active operation is allowed */
Gilles Peskine449bd832023-01-11 14:50:10 +01002251 if (operation->id == 0) {
2252 return PSA_SUCCESS;
2253 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002254
Gilles Peskine449bd832023-01-11 14:50:10 +01002255 psa_status_t status = psa_driver_wrapper_hash_abort(operation);
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002256 operation->id = 0;
2257
Gilles Peskine449bd832023-01-11 14:50:10 +01002258 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002259}
2260
Gilles Peskine449bd832023-01-11 14:50:10 +01002261psa_status_t psa_hash_setup(psa_hash_operation_t *operation,
2262 psa_algorithm_t alg)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002263{
Dave Rodgman685b6a72021-06-24 11:49:14 +01002264 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002265
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002266 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002267 if (operation->id != 0) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002268 status = PSA_ERROR_BAD_STATE;
2269 goto exit;
2270 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002271
Gilles Peskine449bd832023-01-11 14:50:10 +01002272 if (!PSA_ALG_IS_HASH(alg)) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002273 status = PSA_ERROR_INVALID_ARGUMENT;
2274 goto exit;
2275 }
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002276
Steven Cooremanb6bf4bb2021-03-15 19:00:14 +01002277 /* Ensure all of the context is zeroized, since PSA_HASH_OPERATION_INIT only
2278 * directly zeroes the int-sized dummy member of the context union. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002279 memset(&operation->ctx, 0, sizeof(operation->ctx));
Steven Cooreman893232f2021-03-15 12:23:37 +01002280
Gilles Peskine449bd832023-01-11 14:50:10 +01002281 status = psa_driver_wrapper_hash_setup(operation, alg);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002282
2283exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002284 if (status != PSA_SUCCESS) {
2285 psa_hash_abort(operation);
2286 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002287
2288 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002289}
2290
Gilles Peskine449bd832023-01-11 14:50:10 +01002291psa_status_t psa_hash_update(psa_hash_operation_t *operation,
2292 const uint8_t *input,
2293 size_t input_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002294{
Dave Rodgman685b6a72021-06-24 11:49:14 +01002295 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2296
Gilles Peskine449bd832023-01-11 14:50:10 +01002297 if (operation->id == 0) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002298 status = PSA_ERROR_BAD_STATE;
2299 goto exit;
2300 }
Gilles Peskine94e44542018-07-12 16:58:43 +02002301
Steven Cooremanc8288352021-03-04 14:02:19 +01002302 /* Don't require hash implementations to behave correctly on a
2303 * zero-length input, which may have an invalid pointer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002304 if (input_length == 0) {
2305 return PSA_SUCCESS;
2306 }
Steven Cooremanc8288352021-03-04 14:02:19 +01002307
Gilles Peskine449bd832023-01-11 14:50:10 +01002308 status = psa_driver_wrapper_hash_update(operation, input, input_length);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002309
2310exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002311 if (status != PSA_SUCCESS) {
2312 psa_hash_abort(operation);
2313 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002314
Gilles Peskine449bd832023-01-11 14:50:10 +01002315 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002316}
2317
Gilles Peskine449bd832023-01-11 14:50:10 +01002318psa_status_t psa_hash_finish(psa_hash_operation_t *operation,
2319 uint8_t *hash,
2320 size_t hash_size,
2321 size_t *hash_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002322{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002323 *hash_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002324 if (operation->id == 0) {
2325 return PSA_ERROR_BAD_STATE;
2326 }
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002327
Steven Cooreman1e582352021-02-18 17:24:37 +01002328 psa_status_t status = psa_driver_wrapper_hash_finish(
Gilles Peskine449bd832023-01-11 14:50:10 +01002329 operation, hash, hash_size, hash_length);
2330 psa_hash_abort(operation);
2331 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002332}
2333
Gilles Peskine449bd832023-01-11 14:50:10 +01002334psa_status_t psa_hash_verify(psa_hash_operation_t *operation,
2335 const uint8_t *hash,
2336 size_t hash_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002337{
Ronald Cron69a63422021-10-18 09:47:58 +02002338 uint8_t actual_hash[PSA_HASH_MAX_SIZE];
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002339 size_t actual_hash_length;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002340 psa_status_t status = psa_hash_finish(
Gilles Peskine449bd832023-01-11 14:50:10 +01002341 operation,
2342 actual_hash, sizeof(actual_hash),
2343 &actual_hash_length);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002344
Gilles Peskine449bd832023-01-11 14:50:10 +01002345 if (status != PSA_SUCCESS) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002346 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002347 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002348
Gilles Peskine449bd832023-01-11 14:50:10 +01002349 if (actual_hash_length != hash_length) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002350 status = PSA_ERROR_INVALID_SIGNATURE;
2351 goto exit;
2352 }
2353
Dave Rodgman78701152023-08-29 14:20:18 +01002354 if (mbedtls_ct_memcmp(hash, actual_hash, actual_hash_length) != 0) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002355 status = PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01002356 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002357
2358exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002359 mbedtls_platform_zeroize(actual_hash, sizeof(actual_hash));
2360 if (status != PSA_SUCCESS) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002361 psa_hash_abort(operation);
Gilles Peskine449bd832023-01-11 14:50:10 +01002362 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002363
Gilles Peskine449bd832023-01-11 14:50:10 +01002364 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002365}
2366
Gilles Peskine449bd832023-01-11 14:50:10 +01002367psa_status_t psa_hash_compute(psa_algorithm_t alg,
2368 const uint8_t *input, size_t input_length,
2369 uint8_t *hash, size_t hash_size,
2370 size_t *hash_length)
Gilles Peskine0a749c82019-11-28 19:33:58 +01002371{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002372 *hash_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002373 if (!PSA_ALG_IS_HASH(alg)) {
2374 return PSA_ERROR_INVALID_ARGUMENT;
2375 }
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002376
Gilles Peskine449bd832023-01-11 14:50:10 +01002377 return psa_driver_wrapper_hash_compute(alg, input, input_length,
2378 hash, hash_size, hash_length);
Gilles Peskine0a749c82019-11-28 19:33:58 +01002379}
2380
Gilles Peskine449bd832023-01-11 14:50:10 +01002381psa_status_t psa_hash_compare(psa_algorithm_t alg,
2382 const uint8_t *input, size_t input_length,
2383 const uint8_t *hash, size_t hash_length)
Gilles Peskine0a749c82019-11-28 19:33:58 +01002384{
Ronald Cron69a63422021-10-18 09:47:58 +02002385 uint8_t actual_hash[PSA_HASH_MAX_SIZE];
Steven Cooreman84d670d2021-02-18 16:22:53 +01002386 size_t actual_hash_length;
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002387
Gilles Peskine449bd832023-01-11 14:50:10 +01002388 if (!PSA_ALG_IS_HASH(alg)) {
2389 return PSA_ERROR_INVALID_ARGUMENT;
2390 }
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002391
Steven Cooreman1e582352021-02-18 17:24:37 +01002392 psa_status_t status = psa_driver_wrapper_hash_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01002393 alg, input, input_length,
2394 actual_hash, sizeof(actual_hash),
2395 &actual_hash_length);
2396 if (status != PSA_SUCCESS) {
Gilles Peskine60aebec2021-12-13 12:33:18 +01002397 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002398 }
2399 if (actual_hash_length != hash_length) {
Gilles Peskine60aebec2021-12-13 12:33:18 +01002400 status = PSA_ERROR_INVALID_SIGNATURE;
2401 goto exit;
2402 }
Dave Rodgman78701152023-08-29 14:20:18 +01002403 if (mbedtls_ct_memcmp(hash, actual_hash, actual_hash_length) != 0) {
Gilles Peskine60aebec2021-12-13 12:33:18 +01002404 status = PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01002405 }
Gilles Peskine60aebec2021-12-13 12:33:18 +01002406
2407exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002408 mbedtls_platform_zeroize(actual_hash, sizeof(actual_hash));
2409 return status;
Gilles Peskine0a749c82019-11-28 19:33:58 +01002410}
2411
Gilles Peskine449bd832023-01-11 14:50:10 +01002412psa_status_t psa_hash_clone(const psa_hash_operation_t *source_operation,
2413 psa_hash_operation_t *target_operation)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002414{
Gilles Peskine449bd832023-01-11 14:50:10 +01002415 if (source_operation->id == 0 ||
2416 target_operation->id != 0) {
2417 return PSA_ERROR_BAD_STATE;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002418 }
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002419
Gilles Peskine449bd832023-01-11 14:50:10 +01002420 psa_status_t status = psa_driver_wrapper_hash_clone(source_operation,
2421 target_operation);
2422 if (status != PSA_SUCCESS) {
2423 psa_hash_abort(target_operation);
2424 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002425
Gilles Peskine449bd832023-01-11 14:50:10 +01002426 return status;
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002427}
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002428
2429
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002430/****************************************************************/
Gilles Peskine8c9def32018-02-08 10:02:12 +01002431/* MAC */
2432/****************************************************************/
2433
Gilles Peskine449bd832023-01-11 14:50:10 +01002434psa_status_t psa_mac_abort(psa_mac_operation_t *operation)
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002435{
Steven Cooremane6804192021-03-19 18:28:56 +01002436 /* Aborting a non-active operation is allowed */
Gilles Peskine449bd832023-01-11 14:50:10 +01002437 if (operation->id == 0) {
2438 return PSA_SUCCESS;
2439 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002440
Gilles Peskine449bd832023-01-11 14:50:10 +01002441 psa_status_t status = psa_driver_wrapper_mac_abort(operation);
Steven Cooreman72f736a2021-05-07 14:14:37 +02002442 operation->mac_size = 0;
2443 operation->is_sign = 0;
Steven Cooremane6804192021-03-19 18:28:56 +01002444 operation->id = 0;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002445
Gilles Peskine449bd832023-01-11 14:50:10 +01002446 return status;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002447}
2448
Ronald Cron2dff3b22021-06-17 16:33:22 +02002449static psa_status_t psa_mac_finalize_alg_and_key_validation(
2450 psa_algorithm_t alg,
Ronald Cron79bdd822021-06-17 16:46:44 +02002451 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01002452 uint8_t *mac_size)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002453{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002454 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002455 psa_key_type_t key_type = psa_get_key_type(attributes);
2456 size_t key_bits = psa_get_key_bits(attributes);
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002457
Gilles Peskine449bd832023-01-11 14:50:10 +01002458 if (!PSA_ALG_IS_MAC(alg)) {
2459 return PSA_ERROR_INVALID_ARGUMENT;
2460 }
Steven Cooremane6804192021-03-19 18:28:56 +01002461
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002462 /* Validate the combination of key type and algorithm */
Gilles Peskine449bd832023-01-11 14:50:10 +01002463 status = psa_mac_key_can_do(alg, key_type);
2464 if (status != PSA_SUCCESS) {
2465 return status;
2466 }
Steven Cooreman15472f82021-03-02 16:16:22 +01002467
Steven Cooremand1a68f12021-05-10 11:13:41 +02002468 /* Get the output length for the algorithm and key combination */
Gilles Peskine449bd832023-01-11 14:50:10 +01002469 *mac_size = PSA_MAC_LENGTH(key_type, key_bits, alg);
Steven Cooreman15472f82021-03-02 16:16:22 +01002470
Gilles Peskine449bd832023-01-11 14:50:10 +01002471 if (*mac_size < 4) {
Steven Cooreman15472f82021-03-02 16:16:22 +01002472 /* A very short MAC is too short for security since it can be
2473 * brute-forced. Ancient protocols with 32-bit MACs do exist,
2474 * so we make this our minimum, even though 32 bits is still
2475 * too small for security. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002476 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman15472f82021-03-02 16:16:22 +01002477 }
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02002478
Gilles Peskine449bd832023-01-11 14:50:10 +01002479 if (*mac_size > PSA_MAC_LENGTH(key_type, key_bits,
2480 PSA_ALG_FULL_LENGTH_MAC(alg))) {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002481 /* It's impossible to "truncate" to a larger length than the full length
2482 * of the algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002483 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002484 }
2485
Gilles Peskine449bd832023-01-11 14:50:10 +01002486 if (*mac_size > PSA_MAC_MAX_SIZE) {
Gilles Peskinea9b6c802022-03-16 13:54:49 +01002487 /* PSA_MAC_LENGTH returns the correct length even for a MAC algorithm
2488 * that is disabled in the compile-time configuration. The result can
2489 * therefore be larger than PSA_MAC_MAX_SIZE, which does take the
2490 * configuration into account. In this case, force a return of
2491 * PSA_ERROR_NOT_SUPPORTED here. Otherwise psa_mac_verify(), or
2492 * psa_mac_compute(mac_size=PSA_MAC_MAX_SIZE), would return
2493 * PSA_ERROR_BUFFER_TOO_SMALL for an unsupported algorithm whose MAC size
2494 * is larger than PSA_MAC_MAX_SIZE, which is misleading and which breaks
2495 * systematically generated tests. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002496 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea9b6c802022-03-16 13:54:49 +01002497 }
2498
Gilles Peskine449bd832023-01-11 14:50:10 +01002499 return PSA_SUCCESS;
Ronald Cron2dff3b22021-06-17 16:33:22 +02002500}
2501
Gilles Peskine449bd832023-01-11 14:50:10 +01002502static psa_status_t psa_mac_setup(psa_mac_operation_t *operation,
2503 mbedtls_svc_key_id_t key,
2504 psa_algorithm_t alg,
2505 int is_sign)
Gilles Peskinee59236f2018-01-27 23:32:46 +01002506{
2507 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2508 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman54648242021-06-24 11:49:45 +01002509 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002510 psa_key_attributes_t attributes;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002511
2512 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002513 if (operation->id != 0) {
Dave Rodgman54648242021-06-24 11:49:45 +01002514 status = PSA_ERROR_BAD_STATE;
2515 goto exit;
2516 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002517
2518 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002519 key,
2520 &slot,
2521 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
2522 alg);
2523 if (status != PSA_SUCCESS) {
Dave Rodgman54648242021-06-24 11:49:45 +01002524 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002525 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002526
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002527 attributes = (psa_key_attributes_t) {
Gilles Peskine8c9def32018-02-08 10:02:12 +01002528 .core = slot->attr
2529 };
2530
Gilles Peskine449bd832023-01-11 14:50:10 +01002531 status = psa_mac_finalize_alg_and_key_validation(alg, &attributes,
2532 &operation->mac_size);
2533 if (status != PSA_SUCCESS) {
Gilles Peskine8c9def32018-02-08 10:02:12 +01002534 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002535 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002536
2537 operation->is_sign = is_sign;
Steven Cooremane6804192021-03-19 18:28:56 +01002538 /* Dispatch the MAC setup call with validated input */
Gilles Peskine449bd832023-01-11 14:50:10 +01002539 if (is_sign) {
2540 status = psa_driver_wrapper_mac_sign_setup(operation,
2541 &attributes,
2542 slot->key.data,
2543 slot->key.bytes,
2544 alg);
2545 } else {
2546 status = psa_driver_wrapper_mac_verify_setup(operation,
2547 &attributes,
2548 slot->key.data,
2549 slot->key.bytes,
2550 alg);
Gilles Peskine8c9def32018-02-08 10:02:12 +01002551 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002552
Gilles Peskinefbfac682018-07-08 20:51:54 +02002553exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002554 if (status != PSA_SUCCESS) {
2555 psa_mac_abort(operation);
2556 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002557
Ryan Everett1b70a072024-01-04 10:32:49 +00002558 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02002559
Gilles Peskine449bd832023-01-11 14:50:10 +01002560 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002561}
2562
Gilles Peskine449bd832023-01-11 14:50:10 +01002563psa_status_t psa_mac_sign_setup(psa_mac_operation_t *operation,
2564 mbedtls_svc_key_id_t key,
2565 psa_algorithm_t alg)
Gilles Peskine89167cb2018-07-08 20:12:23 +02002566{
Gilles Peskine449bd832023-01-11 14:50:10 +01002567 return psa_mac_setup(operation, key, alg, 1);
Gilles Peskine89167cb2018-07-08 20:12:23 +02002568}
2569
Gilles Peskine449bd832023-01-11 14:50:10 +01002570psa_status_t psa_mac_verify_setup(psa_mac_operation_t *operation,
2571 mbedtls_svc_key_id_t key,
2572 psa_algorithm_t alg)
Gilles Peskine89167cb2018-07-08 20:12:23 +02002573{
Gilles Peskine449bd832023-01-11 14:50:10 +01002574 return psa_mac_setup(operation, key, alg, 0);
Gilles Peskine89167cb2018-07-08 20:12:23 +02002575}
2576
Gilles Peskine449bd832023-01-11 14:50:10 +01002577psa_status_t psa_mac_update(psa_mac_operation_t *operation,
2578 const uint8_t *input,
2579 size_t input_length)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002580{
Gilles Peskine449bd832023-01-11 14:50:10 +01002581 if (operation->id == 0) {
2582 return PSA_ERROR_BAD_STATE;
2583 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002584
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002585 /* Don't require hash implementations to behave correctly on a
2586 * zero-length input, which may have an invalid pointer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002587 if (input_length == 0) {
2588 return PSA_SUCCESS;
2589 }
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03002590
Gilles Peskine449bd832023-01-11 14:50:10 +01002591 psa_status_t status = psa_driver_wrapper_mac_update(operation,
2592 input, input_length);
2593 if (status != PSA_SUCCESS) {
2594 psa_mac_abort(operation);
2595 }
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002596
Gilles Peskine449bd832023-01-11 14:50:10 +01002597 return status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002598}
2599
Gilles Peskine449bd832023-01-11 14:50:10 +01002600psa_status_t psa_mac_sign_finish(psa_mac_operation_t *operation,
2601 uint8_t *mac,
2602 size_t mac_size,
2603 size_t *mac_length)
mohammad16036df908f2018-04-02 08:34:15 -07002604{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002605 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2606 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002607
Gilles Peskine449bd832023-01-11 14:50:10 +01002608 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002609 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002610 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002611 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002612
Gilles Peskine449bd832023-01-11 14:50:10 +01002613 if (!operation->is_sign) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002614 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002615 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002616 }
Steven Cooreman72f736a2021-05-07 14:14:37 +02002617
Steven Cooreman8af5c5c2021-05-11 11:09:13 +02002618 /* Sanity check. This will guarantee that mac_size != 0 (and so mac != NULL)
2619 * once all the error checks are done. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002620 if (operation->mac_size == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002621 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002622 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002623 }
Steven Cooreman8af5c5c2021-05-11 11:09:13 +02002624
Gilles Peskine449bd832023-01-11 14:50:10 +01002625 if (mac_size < operation->mac_size) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002626 status = PSA_ERROR_BUFFER_TOO_SMALL;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002627 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002628 }
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002629
Gilles Peskine449bd832023-01-11 14:50:10 +01002630 status = psa_driver_wrapper_mac_sign_finish(operation,
2631 mac, operation->mac_size,
2632 mac_length);
Steven Cooreman72f736a2021-05-07 14:14:37 +02002633
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002634exit:
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002635 /* In case of success, set the potential excess room in the output buffer
2636 * to an invalid value, to avoid potentially leaking a longer MAC.
2637 * In case of error, set the output length and content to a safe default,
2638 * such that in case the caller misses an error check, the output would be
2639 * an unachievable MAC.
2640 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002641 if (status != PSA_SUCCESS) {
Steven Cooreman72f736a2021-05-07 14:14:37 +02002642 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002643 operation->mac_size = 0;
Steven Cooreman72f736a2021-05-07 14:14:37 +02002644 }
mohammad16036df908f2018-04-02 08:34:15 -07002645
Paul Elliottdc42ca82023-02-24 18:11:59 +00002646 psa_wipe_tag_output_buffer(mac, status, mac_size, *mac_length);
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002647
Gilles Peskine449bd832023-01-11 14:50:10 +01002648 abort_status = psa_mac_abort(operation);
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002649
Gilles Peskine449bd832023-01-11 14:50:10 +01002650 return status == PSA_SUCCESS ? abort_status : status;
mohammad16036df908f2018-04-02 08:34:15 -07002651}
2652
Gilles Peskine449bd832023-01-11 14:50:10 +01002653psa_status_t psa_mac_verify_finish(psa_mac_operation_t *operation,
2654 const uint8_t *mac,
2655 size_t mac_length)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002656{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002657 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2658 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002659
Gilles Peskine449bd832023-01-11 14:50:10 +01002660 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002661 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002662 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002663 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002664
Gilles Peskine449bd832023-01-11 14:50:10 +01002665 if (operation->is_sign) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002666 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002667 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002668 }
Steven Cooreman72f736a2021-05-07 14:14:37 +02002669
Gilles Peskine449bd832023-01-11 14:50:10 +01002670 if (operation->mac_size != mac_length) {
Steven Cooreman72f736a2021-05-07 14:14:37 +02002671 status = PSA_ERROR_INVALID_SIGNATURE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002672 goto exit;
Steven Cooreman72f736a2021-05-07 14:14:37 +02002673 }
2674
Gilles Peskine449bd832023-01-11 14:50:10 +01002675 status = psa_driver_wrapper_mac_verify_finish(operation,
2676 mac, mac_length);
Steven Cooreman72f736a2021-05-07 14:14:37 +02002677
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002678exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002679 abort_status = psa_mac_abort(operation);
mohammad16036df908f2018-04-02 08:34:15 -07002680
Gilles Peskine449bd832023-01-11 14:50:10 +01002681 return status == PSA_SUCCESS ? abort_status : status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002682}
2683
Gilles Peskine449bd832023-01-11 14:50:10 +01002684static psa_status_t psa_mac_compute_internal(mbedtls_svc_key_id_t key,
2685 psa_algorithm_t alg,
2686 const uint8_t *input,
2687 size_t input_length,
2688 uint8_t *mac,
2689 size_t mac_size,
2690 size_t *mac_length,
2691 int is_sign)
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002692{
2693 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron51131b52021-06-17 17:17:20 +02002694 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2695 psa_key_slot_t *slot;
2696 uint8_t operation_mac_size = 0;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002697 psa_key_attributes_t attributes;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002698
Ronald Cron51131b52021-06-17 17:17:20 +02002699 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002700 key,
2701 &slot,
2702 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
2703 alg);
2704 if (status != PSA_SUCCESS) {
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002705 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002706 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002707
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002708 attributes = (psa_key_attributes_t) {
Ronald Cron51131b52021-06-17 17:17:20 +02002709 .core = slot->attr
2710 };
2711
Gilles Peskine449bd832023-01-11 14:50:10 +01002712 status = psa_mac_finalize_alg_and_key_validation(alg, &attributes,
2713 &operation_mac_size);
2714 if (status != PSA_SUCCESS) {
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002715 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002716 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002717
Gilles Peskine449bd832023-01-11 14:50:10 +01002718 if (mac_size < operation_mac_size) {
Ronald Cron51131b52021-06-17 17:17:20 +02002719 status = PSA_ERROR_BUFFER_TOO_SMALL;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002720 goto exit;
Ronald Cron51131b52021-06-17 17:17:20 +02002721 }
2722
2723 status = psa_driver_wrapper_mac_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01002724 &attributes,
2725 slot->key.data, slot->key.bytes,
2726 alg,
2727 input, input_length,
2728 mac, operation_mac_size, mac_length);
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002729
2730exit:
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002731 /* In case of success, set the potential excess room in the output buffer
2732 * to an invalid value, to avoid potentially leaking a longer MAC.
2733 * In case of error, set the output length and content to a safe default,
2734 * such that in case the caller misses an error check, the output would be
2735 * an unachievable MAC.
2736 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002737 if (status != PSA_SUCCESS) {
Ronald Cron51131b52021-06-17 17:17:20 +02002738 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002739 operation_mac_size = 0;
Ronald Cron51131b52021-06-17 17:17:20 +02002740 }
Paul Elliottdc42ca82023-02-24 18:11:59 +00002741
2742 psa_wipe_tag_output_buffer(mac, status, mac_size, *mac_length);
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002743
Ryan Everett1b70a072024-01-04 10:32:49 +00002744 unlock_status = psa_unregister_read(slot);
Ronald Cron51131b52021-06-17 17:17:20 +02002745
Gilles Peskine449bd832023-01-11 14:50:10 +01002746 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002747}
2748
Gilles Peskine449bd832023-01-11 14:50:10 +01002749psa_status_t psa_mac_compute(mbedtls_svc_key_id_t key,
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002750 psa_algorithm_t alg,
2751 const uint8_t *input,
2752 size_t input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002753 uint8_t *mac,
2754 size_t mac_size,
2755 size_t *mac_length)
2756{
2757 return psa_mac_compute_internal(key, alg,
2758 input, input_length,
2759 mac, mac_size, mac_length, 1);
2760}
2761
2762psa_status_t psa_mac_verify(mbedtls_svc_key_id_t key,
2763 psa_algorithm_t alg,
2764 const uint8_t *input,
2765 size_t input_length,
2766 const uint8_t *mac,
2767 size_t mac_length)
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002768{
2769 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Crona587cbc2021-06-18 14:51:29 +02002770 uint8_t actual_mac[PSA_MAC_MAX_SIZE];
2771 size_t actual_mac_length;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002772
Gilles Peskine449bd832023-01-11 14:50:10 +01002773 status = psa_mac_compute_internal(key, alg,
2774 input, input_length,
2775 actual_mac, sizeof(actual_mac),
2776 &actual_mac_length, 0);
2777 if (status != PSA_SUCCESS) {
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002778 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002779 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002780
Gilles Peskine449bd832023-01-11 14:50:10 +01002781 if (mac_length != actual_mac_length) {
Ronald Crona587cbc2021-06-18 14:51:29 +02002782 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002783 goto exit;
Ronald Crona587cbc2021-06-18 14:51:29 +02002784 }
Dave Rodgman78701152023-08-29 14:20:18 +01002785 if (mbedtls_ct_memcmp(mac, actual_mac, actual_mac_length) != 0) {
Ronald Crona587cbc2021-06-18 14:51:29 +02002786 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002787 goto exit;
Ronald Crona587cbc2021-06-18 14:51:29 +02002788 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002789
2790exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002791 mbedtls_platform_zeroize(actual_mac, sizeof(actual_mac));
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002792
Gilles Peskine449bd832023-01-11 14:50:10 +01002793 return status;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002794}
Gilles Peskinee59236f2018-01-27 23:32:46 +01002795
Gilles Peskinee59236f2018-01-27 23:32:46 +01002796/****************************************************************/
2797/* Asymmetric cryptography */
2798/****************************************************************/
2799
Gilles Peskine449bd832023-01-11 14:50:10 +01002800static psa_status_t psa_sign_verify_check_alg(int input_is_message,
2801 psa_algorithm_t alg)
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002802{
Gilles Peskine449bd832023-01-11 14:50:10 +01002803 if (input_is_message) {
2804 if (!PSA_ALG_IS_SIGN_MESSAGE(alg)) {
2805 return PSA_ERROR_INVALID_ARGUMENT;
2806 }
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002807
Gilles Peskine449bd832023-01-11 14:50:10 +01002808 if (PSA_ALG_IS_SIGN_HASH(alg)) {
2809 if (!PSA_ALG_IS_HASH(PSA_ALG_SIGN_GET_HASH(alg))) {
2810 return PSA_ERROR_INVALID_ARGUMENT;
2811 }
2812 }
2813 } else {
2814 if (!PSA_ALG_IS_SIGN_HASH(alg)) {
2815 return PSA_ERROR_INVALID_ARGUMENT;
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002816 }
2817 }
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002818
Gilles Peskine449bd832023-01-11 14:50:10 +01002819 return PSA_SUCCESS;
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002820}
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002821
Gilles Peskine449bd832023-01-11 14:50:10 +01002822static psa_status_t psa_sign_internal(mbedtls_svc_key_id_t key,
2823 int input_is_message,
2824 psa_algorithm_t alg,
2825 const uint8_t *input,
2826 size_t input_length,
2827 uint8_t *signature,
2828 size_t signature_size,
2829 size_t *signature_length)
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002830{
2831 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2832 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2833 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002834 psa_key_attributes_t attributes;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002835
2836 *signature_length = 0;
2837
Gilles Peskine449bd832023-01-11 14:50:10 +01002838 status = psa_sign_verify_check_alg(input_is_message, alg);
2839 if (status != PSA_SUCCESS) {
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002840 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002841 }
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002842
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002843 /* Immediately reject a zero-length signature buffer. This guarantees
gabor-mezei-arm12b4f342021-05-05 13:54:55 +02002844 * that signature must be a valid pointer. (On the other hand, the input
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002845 * buffer can in principle be empty since it doesn't actually have
2846 * to be a hash.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01002847 if (signature_size == 0) {
2848 return PSA_ERROR_BUFFER_TOO_SMALL;
2849 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002850
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002851 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002852 key, &slot,
2853 input_is_message ? PSA_KEY_USAGE_SIGN_MESSAGE :
2854 PSA_KEY_USAGE_SIGN_HASH,
2855 alg);
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002856
Gilles Peskine449bd832023-01-11 14:50:10 +01002857 if (status != PSA_SUCCESS) {
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002858 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002859 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002860
Gilles Peskine449bd832023-01-11 14:50:10 +01002861 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002862 status = PSA_ERROR_INVALID_ARGUMENT;
2863 goto exit;
2864 }
2865
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002866 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01002867 .core = slot->attr
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002868 };
2869
Gilles Peskine449bd832023-01-11 14:50:10 +01002870 if (input_is_message) {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002871 status = psa_driver_wrapper_sign_message(
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002872 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002873 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002874 signature, signature_size, signature_length);
2875 } else {
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002876
2877 status = psa_driver_wrapper_sign_hash(
2878 &attributes, slot->key.data, slot->key.bytes,
2879 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002880 signature, signature_size, signature_length);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002881 }
2882
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002883
2884exit:
Paul Elliott59200a22023-02-21 15:07:40 +00002885 psa_wipe_tag_output_buffer(signature, status, signature_size,
2886 *signature_length);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002887
Ryan Everett1b70a072024-01-04 10:32:49 +00002888 unlock_status = psa_unregister_read(slot);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002889
Gilles Peskine449bd832023-01-11 14:50:10 +01002890 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002891}
2892
Gilles Peskine449bd832023-01-11 14:50:10 +01002893static psa_status_t psa_verify_internal(mbedtls_svc_key_id_t key,
2894 int input_is_message,
2895 psa_algorithm_t alg,
2896 const uint8_t *input,
2897 size_t input_length,
2898 const uint8_t *signature,
2899 size_t signature_length)
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002900{
2901 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2902 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2903 psa_key_slot_t *slot;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002904
Gilles Peskine449bd832023-01-11 14:50:10 +01002905 status = psa_sign_verify_check_alg(input_is_message, alg);
2906 if (status != PSA_SUCCESS) {
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002907 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002908 }
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002909
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002910 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002911 key, &slot,
2912 input_is_message ? PSA_KEY_USAGE_VERIFY_MESSAGE :
2913 PSA_KEY_USAGE_VERIFY_HASH,
2914 alg);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002915
Gilles Peskine449bd832023-01-11 14:50:10 +01002916 if (status != PSA_SUCCESS) {
2917 return status;
2918 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002919
2920 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01002921 .core = slot->attr
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002922 };
2923
Gilles Peskine449bd832023-01-11 14:50:10 +01002924 if (input_is_message) {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002925 status = psa_driver_wrapper_verify_message(
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002926 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002927 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002928 signature, signature_length);
2929 } else {
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002930 status = psa_driver_wrapper_verify_hash(
2931 &attributes, slot->key.data, slot->key.bytes,
2932 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002933 signature, signature_length);
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002934 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002935
Ryan Everett1b70a072024-01-04 10:32:49 +00002936 unlock_status = psa_unregister_read(slot);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002937
Gilles Peskine449bd832023-01-11 14:50:10 +01002938 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002939
2940}
2941
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002942psa_status_t psa_sign_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002943 const psa_key_attributes_t *attributes,
2944 const uint8_t *key_buffer,
2945 size_t key_buffer_size,
2946 psa_algorithm_t alg,
2947 const uint8_t *input,
2948 size_t input_length,
2949 uint8_t *signature,
2950 size_t signature_size,
Gilles Peskine449bd832023-01-11 14:50:10 +01002951 size_t *signature_length)
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002952{
2953 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002954
Gilles Peskine449bd832023-01-11 14:50:10 +01002955 if (PSA_ALG_IS_SIGN_HASH(alg)) {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002956 size_t hash_length;
2957 uint8_t hash[PSA_HASH_MAX_SIZE];
2958
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002959 status = psa_driver_wrapper_hash_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01002960 PSA_ALG_SIGN_GET_HASH(alg),
2961 input, input_length,
2962 hash, sizeof(hash), &hash_length);
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002963
Gilles Peskine449bd832023-01-11 14:50:10 +01002964 if (status != PSA_SUCCESS) {
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002965 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002966 }
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002967
2968 return psa_driver_wrapper_sign_hash(
Gilles Peskine449bd832023-01-11 14:50:10 +01002969 attributes, key_buffer, key_buffer_size,
2970 alg, hash, hash_length,
2971 signature, signature_size, signature_length);
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002972 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002973
Gilles Peskine449bd832023-01-11 14:50:10 +01002974 return PSA_ERROR_NOT_SUPPORTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002975}
2976
Gilles Peskine449bd832023-01-11 14:50:10 +01002977psa_status_t psa_sign_message(mbedtls_svc_key_id_t key,
2978 psa_algorithm_t alg,
2979 const uint8_t *input,
2980 size_t input_length,
2981 uint8_t *signature,
2982 size_t signature_size,
2983 size_t *signature_length)
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002984{
2985 return psa_sign_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002986 key, 1, alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002987 signature, signature_size, signature_length);
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002988}
2989
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002990psa_status_t psa_verify_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002991 const psa_key_attributes_t *attributes,
2992 const uint8_t *key_buffer,
2993 size_t key_buffer_size,
2994 psa_algorithm_t alg,
2995 const uint8_t *input,
2996 size_t input_length,
2997 const uint8_t *signature,
Gilles Peskine449bd832023-01-11 14:50:10 +01002998 size_t signature_length)
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002999{
3000 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003001
Gilles Peskine449bd832023-01-11 14:50:10 +01003002 if (PSA_ALG_IS_SIGN_HASH(alg)) {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02003003 size_t hash_length;
3004 uint8_t hash[PSA_HASH_MAX_SIZE];
3005
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003006 status = psa_driver_wrapper_hash_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01003007 PSA_ALG_SIGN_GET_HASH(alg),
3008 input, input_length,
3009 hash, sizeof(hash), &hash_length);
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003010
Gilles Peskine449bd832023-01-11 14:50:10 +01003011 if (status != PSA_SUCCESS) {
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003012 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01003013 }
gabor-mezei-armf9820f92021-05-03 16:26:20 +02003014
3015 return psa_driver_wrapper_verify_hash(
Gilles Peskine449bd832023-01-11 14:50:10 +01003016 attributes, key_buffer, key_buffer_size,
3017 alg, hash, hash_length,
3018 signature, signature_length);
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003019 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003020
Gilles Peskine449bd832023-01-11 14:50:10 +01003021 return PSA_ERROR_NOT_SUPPORTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003022}
3023
Gilles Peskine449bd832023-01-11 14:50:10 +01003024psa_status_t psa_verify_message(mbedtls_svc_key_id_t key,
3025 psa_algorithm_t alg,
3026 const uint8_t *input,
3027 size_t input_length,
3028 const uint8_t *signature,
3029 size_t signature_length)
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003030{
3031 return psa_verify_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02003032 key, 1, alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003033 signature, signature_length);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003034}
3035
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02003036psa_status_t psa_sign_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01003037 const psa_key_attributes_t *attributes,
3038 const uint8_t *key_buffer, size_t key_buffer_size,
3039 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003040 uint8_t *signature, size_t signature_size, size_t *signature_length)
Gilles Peskinee59236f2018-01-27 23:32:46 +01003041{
Gilles Peskine449bd832023-01-11 14:50:10 +01003042 if (attributes->core.type == PSA_KEY_TYPE_RSA_KEY_PAIR) {
3043 if (PSA_ALG_IS_RSA_PKCS1V15_SIGN(alg) ||
3044 PSA_ALG_IS_RSA_PSS(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003045#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003046 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
3047 return mbedtls_psa_rsa_sign_hash(
3048 attributes,
3049 key_buffer, key_buffer_size,
3050 alg, hash, hash_length,
3051 signature, signature_size, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01003052#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
3053 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003054 } else {
3055 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanacda8342020-07-24 23:09:52 +02003056 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003057 } else if (PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3058 if (PSA_ALG_IS_ECDSA(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003059#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003060 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3061 return mbedtls_psa_ecdsa_sign_hash(
3062 attributes,
3063 key_buffer, key_buffer_size,
3064 alg, hash, hash_length,
3065 signature, signature_size, signature_length);
Gilles Peskinee59236f2018-01-27 23:32:46 +01003066#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3067 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003068 } else {
3069 return PSA_ERROR_INVALID_ARGUMENT;
Ronald Cron4501c982021-03-19 20:09:32 +01003070 }
Ronald Cron8a494f32021-02-17 09:49:51 +01003071 }
Ronald Cron4501c982021-03-19 20:09:32 +01003072
Gilles Peskine449bd832023-01-11 14:50:10 +01003073 (void) key_buffer;
3074 (void) key_buffer_size;
3075 (void) hash;
3076 (void) hash_length;
3077 (void) signature;
3078 (void) signature_size;
3079 (void) signature_length;
Ronald Cron4501c982021-03-19 20:09:32 +01003080
Gilles Peskine449bd832023-01-11 14:50:10 +01003081 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron18659932020-12-08 16:32:23 +01003082}
Gilles Peskinee59236f2018-01-27 23:32:46 +01003083
Gilles Peskine449bd832023-01-11 14:50:10 +01003084psa_status_t psa_sign_hash(mbedtls_svc_key_id_t key,
3085 psa_algorithm_t alg,
3086 const uint8_t *hash,
3087 size_t hash_length,
3088 uint8_t *signature,
3089 size_t signature_size,
3090 size_t *signature_length)
Gilles Peskinee59236f2018-01-27 23:32:46 +01003091{
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003092 return psa_sign_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02003093 key, 0, alg, hash, hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003094 signature, signature_size, signature_length);
itayzafrir5c753392018-05-08 11:18:38 +03003095}
3096
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02003097psa_status_t psa_verify_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01003098 const psa_key_attributes_t *attributes,
3099 const uint8_t *key_buffer, size_t key_buffer_size,
3100 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003101 const uint8_t *signature, size_t signature_length)
itayzafrir5c753392018-05-08 11:18:38 +03003102{
Gilles Peskine449bd832023-01-11 14:50:10 +01003103 if (PSA_KEY_TYPE_IS_RSA(attributes->core.type)) {
3104 if (PSA_ALG_IS_RSA_PKCS1V15_SIGN(alg) ||
3105 PSA_ALG_IS_RSA_PSS(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003106#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003107 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
3108 return mbedtls_psa_rsa_verify_hash(
3109 attributes,
3110 key_buffer, key_buffer_size,
3111 alg, hash, hash_length,
3112 signature, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01003113#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
3114 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003115 } else {
3116 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanacda8342020-07-24 23:09:52 +02003117 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003118 } else if (PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3119 if (PSA_ALG_IS_ECDSA(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003120#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003121 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3122 return mbedtls_psa_ecdsa_verify_hash(
3123 attributes,
3124 key_buffer, key_buffer_size,
3125 alg, hash, hash_length,
3126 signature, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01003127#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3128 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003129 } else {
3130 return PSA_ERROR_INVALID_ARGUMENT;
Ronald Cron4501c982021-03-19 20:09:32 +01003131 }
Ronald Cron8a494f32021-02-17 09:49:51 +01003132 }
Ronald Cron4501c982021-03-19 20:09:32 +01003133
Gilles Peskine449bd832023-01-11 14:50:10 +01003134 (void) key_buffer;
3135 (void) key_buffer_size;
3136 (void) hash;
3137 (void) hash_length;
3138 (void) signature;
3139 (void) signature_length;
Ronald Cron4501c982021-03-19 20:09:32 +01003140
Gilles Peskine449bd832023-01-11 14:50:10 +01003141 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron18659932020-12-08 16:32:23 +01003142}
3143
Gilles Peskine449bd832023-01-11 14:50:10 +01003144psa_status_t psa_verify_hash(mbedtls_svc_key_id_t key,
3145 psa_algorithm_t alg,
3146 const uint8_t *hash,
3147 size_t hash_length,
3148 const uint8_t *signature,
3149 size_t signature_length)
itayzafrir5c753392018-05-08 11:18:38 +03003150{
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003151 return psa_verify_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02003152 key, 0, alg, hash, hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003153 signature, signature_length);
Gilles Peskinee59236f2018-01-27 23:32:46 +01003154}
3155
Gilles Peskine449bd832023-01-11 14:50:10 +01003156psa_status_t psa_asymmetric_encrypt(mbedtls_svc_key_id_t key,
3157 psa_algorithm_t alg,
3158 const uint8_t *input,
3159 size_t input_length,
3160 const uint8_t *salt,
3161 size_t salt_length,
3162 uint8_t *output,
3163 size_t output_size,
3164 size_t *output_length)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003165{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003166 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003167 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003168 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003169 psa_key_attributes_t attributes;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003170
Darryl Green5cc689a2018-07-24 15:34:10 +01003171 (void) input;
3172 (void) input_length;
3173 (void) salt;
3174 (void) output;
3175 (void) output_size;
3176
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003177 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003178
Gilles Peskine449bd832023-01-11 14:50:10 +01003179 if (!PSA_ALG_IS_RSA_OAEP(alg) && salt_length != 0) {
3180 return PSA_ERROR_INVALID_ARGUMENT;
3181 }
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003182
Valerio Setti5bb454a2024-01-15 10:43:16 +01003183 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01003184 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg);
3185 if (status != PSA_SUCCESS) {
3186 return status;
3187 }
3188 if (!(PSA_KEY_TYPE_IS_PUBLIC_KEY(slot->attr.type) ||
3189 PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type))) {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003190 status = PSA_ERROR_INVALID_ARGUMENT;
3191 goto exit;
3192 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003193
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003194 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01003195 .core = slot->attr
Przemyslaw Stekiel19e61422021-12-09 11:09:11 +01003196 };
Steven Cooremana2371e52020-07-28 14:30:39 +02003197
Przemyslaw Stekiel19e61422021-12-09 11:09:11 +01003198 status = psa_driver_wrapper_asymmetric_encrypt(
3199 &attributes, slot->key.data, slot->key.bytes,
3200 alg, input, input_length, salt, salt_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003201 output, output_size, output_length);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003202exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00003203 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003204
Gilles Peskine449bd832023-01-11 14:50:10 +01003205 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003206}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003207
Gilles Peskine449bd832023-01-11 14:50:10 +01003208psa_status_t psa_asymmetric_decrypt(mbedtls_svc_key_id_t key,
3209 psa_algorithm_t alg,
3210 const uint8_t *input,
3211 size_t input_length,
3212 const uint8_t *salt,
3213 size_t salt_length,
3214 uint8_t *output,
3215 size_t output_size,
3216 size_t *output_length)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003217{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003218 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003219 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003220 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003221 psa_key_attributes_t attributes;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003222
Darryl Green5cc689a2018-07-24 15:34:10 +01003223 (void) input;
3224 (void) input_length;
3225 (void) salt;
3226 (void) output;
3227 (void) output_size;
3228
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003229 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003230
Gilles Peskine449bd832023-01-11 14:50:10 +01003231 if (!PSA_ALG_IS_RSA_OAEP(alg) && salt_length != 0) {
3232 return PSA_ERROR_INVALID_ARGUMENT;
3233 }
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003234
Valerio Setti5bb454a2024-01-15 10:43:16 +01003235 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01003236 key, &slot, PSA_KEY_USAGE_DECRYPT, alg);
3237 if (status != PSA_SUCCESS) {
3238 return status;
3239 }
3240 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003241 status = PSA_ERROR_INVALID_ARGUMENT;
3242 goto exit;
3243 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003244
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003245 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01003246 .core = slot->attr
Przemyslaw Stekiel8d45c002021-12-13 08:58:19 +01003247 };
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003248
Przemyslaw Stekiel8d45c002021-12-13 08:58:19 +01003249 status = psa_driver_wrapper_asymmetric_decrypt(
3250 &attributes, slot->key.data, slot->key.bytes,
3251 alg, input, input_length, salt, salt_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003252 output, output_size, output_length);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003253
3254exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00003255 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003256
Gilles Peskine449bd832023-01-11 14:50:10 +01003257 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003258}
Gilles Peskinee59236f2018-01-27 23:32:46 +01003259
Paul Elliott9fe12f62022-11-30 19:16:02 +00003260/****************************************************************/
3261/* Asymmetric interruptible cryptography */
3262/****************************************************************/
3263
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003264static uint32_t psa_interruptible_max_ops = PSA_INTERRUPTIBLE_MAX_OPS_UNLIMITED;
3265
Paul Elliott9fe12f62022-11-30 19:16:02 +00003266void psa_interruptible_set_max_ops(uint32_t max_ops)
3267{
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003268 psa_interruptible_max_ops = max_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003269}
3270
3271uint32_t psa_interruptible_get_max_ops(void)
3272{
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003273 return psa_interruptible_max_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003274}
3275
Paul Elliott9fe12f62022-11-30 19:16:02 +00003276uint32_t psa_sign_hash_get_num_ops(
3277 const psa_sign_hash_interruptible_operation_t *operation)
3278{
Paul Elliott296ede92022-12-15 17:00:30 +00003279 return operation->num_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003280}
3281
3282uint32_t psa_verify_hash_get_num_ops(
3283 const psa_verify_hash_interruptible_operation_t *operation)
3284{
Paul Elliott296ede92022-12-15 17:00:30 +00003285 return operation->num_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003286}
3287
Paul Elliott59ad9452022-12-18 15:09:02 +00003288static psa_status_t psa_sign_hash_abort_internal(
3289 psa_sign_hash_interruptible_operation_t *operation)
3290{
3291 if (operation->id == 0) {
3292 /* The object has (apparently) been initialized but it is not (yet)
3293 * in use. It's ok to call abort on such an object, and there's
3294 * nothing to do. */
3295 return PSA_SUCCESS;
3296 }
3297
3298 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3299
3300 status = psa_driver_wrapper_sign_hash_abort(operation);
3301
3302 operation->id = 0;
3303
Paul Elliotte6145dc2023-02-07 12:51:21 +00003304 /* Do not clear either the error_occurred or num_ops elements here as they
3305 * only want to be cleared by the application calling abort, not by abort
3306 * being called at completion of an operation. */
3307
Paul Elliott59ad9452022-12-18 15:09:02 +00003308 return status;
3309}
3310
Paul Elliott9fe12f62022-11-30 19:16:02 +00003311psa_status_t psa_sign_hash_start(
3312 psa_sign_hash_interruptible_operation_t *operation,
3313 mbedtls_svc_key_id_t key, psa_algorithm_t alg,
3314 const uint8_t *hash, size_t hash_length)
3315{
3316 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3317 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3318 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003319 psa_key_attributes_t attributes;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003320
Paul Elliottc9774412023-02-06 15:14:07 +00003321 /* Check that start has not been previously called, or operation has not
3322 * previously errored. */
3323 if (operation->id != 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003324 return PSA_ERROR_BAD_STATE;
3325 }
3326
Paul Elliott9fe12f62022-11-30 19:16:02 +00003327 status = psa_sign_verify_check_alg(0, alg);
3328 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003329 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003330 return status;
3331 }
3332
3333 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
3334 PSA_KEY_USAGE_SIGN_HASH,
3335 alg);
3336
3337 if (status != PSA_SUCCESS) {
3338 goto exit;
3339 }
3340
3341 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
3342 status = PSA_ERROR_INVALID_ARGUMENT;
3343 goto exit;
3344 }
3345
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003346 attributes = (psa_key_attributes_t) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003347 .core = slot->attr
3348 };
3349
Paul Elliott296ede92022-12-15 17:00:30 +00003350 /* Ensure ops count gets reset, in case of operation re-use. */
3351 operation->num_ops = 0;
3352
Paul Elliott9fe12f62022-11-30 19:16:02 +00003353 status = psa_driver_wrapper_sign_hash_start(operation, &attributes,
3354 slot->key.data,
3355 slot->key.bytes, alg,
3356 hash, hash_length);
3357exit:
3358
3359 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003360 operation->error_occurred = 1;
Paul Elliott59ad9452022-12-18 15:09:02 +00003361 psa_sign_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003362 }
3363
Ryan Everett1b70a072024-01-04 10:32:49 +00003364 unlock_status = psa_unregister_read(slot);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003365
Paul Elliottc9774412023-02-06 15:14:07 +00003366 if (unlock_status != PSA_SUCCESS) {
3367 operation->error_occurred = 1;
3368 }
Paul Elliott9fe12f62022-11-30 19:16:02 +00003369
Paul Elliottc9774412023-02-06 15:14:07 +00003370 return (status == PSA_SUCCESS) ? unlock_status : status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003371}
3372
3373
3374psa_status_t psa_sign_hash_complete(
3375 psa_sign_hash_interruptible_operation_t *operation,
3376 uint8_t *signature, size_t signature_size,
3377 size_t *signature_length)
3378{
3379 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3380
3381 *signature_length = 0;
3382
Paul Elliottc9774412023-02-06 15:14:07 +00003383 /* Check that start has been called first, and that operation has not
3384 * previously errored. */
3385 if (operation->id == 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003386 status = PSA_ERROR_BAD_STATE;
3387 goto exit;
3388 }
3389
Paul Elliott096abc42023-02-03 18:33:23 +00003390 /* Immediately reject a zero-length signature buffer. This guarantees that
3391 * signature must be a valid pointer. */
Paul Elliott9fe12f62022-11-30 19:16:02 +00003392 if (signature_size == 0) {
3393 status = PSA_ERROR_BUFFER_TOO_SMALL;
3394 goto exit;
3395 }
3396
3397 status = psa_driver_wrapper_sign_hash_complete(operation, signature,
3398 signature_size,
3399 signature_length);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003400
Paul Elliott296ede92022-12-15 17:00:30 +00003401 /* Update ops count with work done. */
Paul Elliottde1114c2023-02-07 12:43:11 +00003402 operation->num_ops = psa_driver_wrapper_sign_hash_get_num_ops(operation);
Paul Elliott296ede92022-12-15 17:00:30 +00003403
Paul Elliottebe225c2023-02-10 14:32:53 +00003404exit:
3405
Paul Elliott59200a22023-02-21 15:07:40 +00003406 psa_wipe_tag_output_buffer(signature, status, signature_size,
3407 *signature_length);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003408
Paul Elliott53bb3122023-02-10 14:22:22 +00003409 if (status != PSA_OPERATION_INCOMPLETE) {
Paul Elliottc9774412023-02-06 15:14:07 +00003410 if (status != PSA_SUCCESS) {
3411 operation->error_occurred = 1;
3412 }
3413
Paul Elliott59ad9452022-12-18 15:09:02 +00003414 psa_sign_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003415 }
3416
3417 return status;
3418}
3419
3420psa_status_t psa_sign_hash_abort(
3421 psa_sign_hash_interruptible_operation_t *operation)
3422{
Paul Elliott59ad9452022-12-18 15:09:02 +00003423 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3424
3425 status = psa_sign_hash_abort_internal(operation);
3426
3427 /* We clear the number of ops done here, so that it is not cleared when
3428 * the operation fails or succeeds, only on manual abort. */
3429 operation->num_ops = 0;
3430
Paul Elliottc9774412023-02-06 15:14:07 +00003431 /* Likewise, failure state. */
3432 operation->error_occurred = 0;
3433
Paul Elliott59ad9452022-12-18 15:09:02 +00003434 return status;
3435}
3436
3437static psa_status_t psa_verify_hash_abort_internal(
3438 psa_verify_hash_interruptible_operation_t *operation)
3439{
Paul Elliott9fe12f62022-11-30 19:16:02 +00003440 if (operation->id == 0) {
3441 /* The object has (apparently) been initialized but it is not (yet)
3442 * in use. It's ok to call abort on such an object, and there's
3443 * nothing to do. */
3444 return PSA_SUCCESS;
3445 }
3446
Paul Elliott59ad9452022-12-18 15:09:02 +00003447 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3448
3449 status = psa_driver_wrapper_verify_hash_abort(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003450
3451 operation->id = 0;
3452
Paul Elliotte6145dc2023-02-07 12:51:21 +00003453 /* Do not clear either the error_occurred or num_ops elements here as they
3454 * only want to be cleared by the application calling abort, not by abort
3455 * being called at completion of an operation. */
3456
Paul Elliott59ad9452022-12-18 15:09:02 +00003457 return status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003458}
3459
3460psa_status_t psa_verify_hash_start(
3461 psa_verify_hash_interruptible_operation_t *operation,
3462 mbedtls_svc_key_id_t key, psa_algorithm_t alg,
3463 const uint8_t *hash, size_t hash_length,
3464 const uint8_t *signature, size_t signature_length)
3465{
3466 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3467 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3468 psa_key_slot_t *slot;
3469
Paul Elliottc9774412023-02-06 15:14:07 +00003470 /* Check that start has not been previously called, or operation has not
3471 * previously errored. */
3472 if (operation->id != 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003473 return PSA_ERROR_BAD_STATE;
3474 }
3475
3476 status = psa_sign_verify_check_alg(0, alg);
3477 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003478 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003479 return status;
3480 }
3481
3482 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
3483 PSA_KEY_USAGE_VERIFY_HASH,
3484 alg);
3485
3486 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003487 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003488 return status;
3489 }
3490
3491 psa_key_attributes_t attributes = {
3492 .core = slot->attr
3493 };
3494
Paul Elliott296ede92022-12-15 17:00:30 +00003495 /* Ensure ops count gets reset, in case of operation re-use. */
3496 operation->num_ops = 0;
3497
Paul Elliott9fe12f62022-11-30 19:16:02 +00003498 status = psa_driver_wrapper_verify_hash_start(operation, &attributes,
3499 slot->key.data,
3500 slot->key.bytes,
3501 alg, hash, hash_length,
3502 signature, signature_length);
3503
3504 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003505 operation->error_occurred = 1;
Paul Elliott59ad9452022-12-18 15:09:02 +00003506 psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003507 }
3508
Ryan Everett1b70a072024-01-04 10:32:49 +00003509 unlock_status = psa_unregister_read(slot);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003510
Paul Elliottc9774412023-02-06 15:14:07 +00003511 if (unlock_status != PSA_SUCCESS) {
3512 operation->error_occurred = 1;
3513 }
Paul Elliott9fe12f62022-11-30 19:16:02 +00003514
Paul Elliottc9774412023-02-06 15:14:07 +00003515 return (status == PSA_SUCCESS) ? unlock_status : status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003516}
3517
3518psa_status_t psa_verify_hash_complete(
3519 psa_verify_hash_interruptible_operation_t *operation)
3520{
3521 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3522
Paul Elliottc9774412023-02-06 15:14:07 +00003523 /* Check that start has been called first, and that operation has not
3524 * previously errored. */
3525 if (operation->id == 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003526 status = PSA_ERROR_BAD_STATE;
3527 goto exit;
3528 }
3529
3530 status = psa_driver_wrapper_verify_hash_complete(operation);
3531
Paul Elliott296ede92022-12-15 17:00:30 +00003532 /* Update ops count with work done. */
Paul Elliottde1114c2023-02-07 12:43:11 +00003533 operation->num_ops = psa_driver_wrapper_verify_hash_get_num_ops(
Paul Elliott296ede92022-12-15 17:00:30 +00003534 operation);
3535
Paul Elliottebe225c2023-02-10 14:32:53 +00003536exit:
3537
Paul Elliott9fe12f62022-11-30 19:16:02 +00003538 if (status != PSA_OPERATION_INCOMPLETE) {
Paul Elliottc9774412023-02-06 15:14:07 +00003539 if (status != PSA_SUCCESS) {
3540 operation->error_occurred = 1;
3541 }
3542
Paul Elliott59ad9452022-12-18 15:09:02 +00003543 psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003544 }
3545
3546 return status;
3547}
3548
3549psa_status_t psa_verify_hash_abort(
3550 psa_verify_hash_interruptible_operation_t *operation)
3551{
Paul Elliott59ad9452022-12-18 15:09:02 +00003552 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003553
Paul Elliott59ad9452022-12-18 15:09:02 +00003554 status = psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003555
Paul Elliott59ad9452022-12-18 15:09:02 +00003556 /* We clear the number of ops done here, so that it is not cleared when
3557 * the operation fails or succeeds, only on manual abort. */
3558 operation->num_ops = 0;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003559
Paul Elliottc9774412023-02-06 15:14:07 +00003560 /* Likewise, failure state. */
3561 operation->error_occurred = 0;
3562
Paul Elliott59ad9452022-12-18 15:09:02 +00003563 return status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003564}
3565
Paul Elliott588f8ed2022-12-02 18:10:26 +00003566/****************************************************************/
3567/* Asymmetric interruptible cryptography internal */
3568/* implementations */
3569/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003570
Paul Elliott588f8ed2022-12-02 18:10:26 +00003571void mbedtls_psa_interruptible_set_max_ops(uint32_t max_ops)
3572{
Paul Elliott7cc4e812023-01-10 17:14:11 +00003573
Paul Elliott588f8ed2022-12-02 18:10:26 +00003574#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3575 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3576 defined(MBEDTLS_ECP_RESTARTABLE)
3577
3578 /* Internal implementation uses zero to indicate infinite number max ops,
3579 * therefore avoid this value, and set to minimum possible. */
3580 if (max_ops == 0) {
3581 max_ops = 1;
3582 }
3583
Paul Elliott588f8ed2022-12-02 18:10:26 +00003584 mbedtls_ecp_set_max_ops(max_ops);
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003585#else
3586 (void) max_ops;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003587#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3588 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3589 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3590}
3591
Paul Elliott588f8ed2022-12-02 18:10:26 +00003592uint32_t mbedtls_psa_sign_hash_get_num_ops(
Paul Elliottf8e5b562023-02-19 18:43:45 +00003593 const mbedtls_psa_sign_hash_interruptible_operation_t *operation)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003594{
3595#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3596 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3597 defined(MBEDTLS_ECP_RESTARTABLE)
3598
Paul Elliott93d9ca82023-02-15 18:14:21 +00003599 return operation->num_ops;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003600#else
3601 (void) operation;
3602 return 0;
3603#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3604 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3605 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3606}
3607
3608uint32_t mbedtls_psa_verify_hash_get_num_ops(
Paul Elliottf8e5b562023-02-19 18:43:45 +00003609 const mbedtls_psa_verify_hash_interruptible_operation_t *operation)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003610{
3611 #if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3612 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3613 defined(MBEDTLS_ECP_RESTARTABLE)
3614
Paul Elliott93d9ca82023-02-15 18:14:21 +00003615 return operation->num_ops;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003616#else
3617 (void) operation;
3618 return 0;
3619#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3620 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3621 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3622}
3623
3624psa_status_t mbedtls_psa_sign_hash_start(
3625 mbedtls_psa_sign_hash_interruptible_operation_t *operation,
3626 const psa_key_attributes_t *attributes, const uint8_t *key_buffer,
3627 size_t key_buffer_size, psa_algorithm_t alg,
3628 const uint8_t *hash, size_t hash_length)
3629{
3630 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott0290a762023-02-09 14:30:24 +00003631 size_t required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003632
Paul Elliott068fe072023-01-16 13:59:15 +00003633 if (!PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3634 return PSA_ERROR_NOT_SUPPORTED;
3635 }
3636
3637 if (!PSA_ALG_IS_ECDSA(alg)) {
Paul Elliott813f9cd2023-02-05 15:28:46 +00003638 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott068fe072023-01-16 13:59:15 +00003639 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003640
3641#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Paul Elliott068fe072023-01-16 13:59:15 +00003642 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3643 defined(MBEDTLS_ECP_RESTARTABLE)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003644
Paul Elliotta1c94092023-02-15 16:38:04 +00003645 mbedtls_ecdsa_restart_init(&operation->restart_ctx);
3646
Paul Elliott93d9ca82023-02-15 18:14:21 +00003647 /* Ensure num_ops is zero'ed in case of context re-use. */
3648 operation->num_ops = 0;
3649
Paul Elliott068fe072023-01-16 13:59:15 +00003650 status = mbedtls_psa_ecp_load_representation(attributes->core.type,
3651 attributes->core.bits,
3652 key_buffer,
3653 key_buffer_size,
3654 &operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003655
Paul Elliott068fe072023-01-16 13:59:15 +00003656 if (status != PSA_SUCCESS) {
3657 return status;
3658 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003659
Paul Elliott1bc59df2023-02-05 13:41:57 +00003660 operation->coordinate_bytes = PSA_BITS_TO_BYTES(
Paul Elliottc569fc22023-02-10 13:02:54 +00003661 operation->ctx->grp.nbits);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003662
Paul Elliott068fe072023-01-16 13:59:15 +00003663 psa_algorithm_t hash_alg = PSA_ALG_SIGN_GET_HASH(alg);
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02003664 operation->md_alg = mbedtls_md_type_from_psa_alg(hash_alg);
Paul Elliott068fe072023-01-16 13:59:15 +00003665 operation->alg = alg;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003666
Paul Elliott0290a762023-02-09 14:30:24 +00003667 /* We only need to store the same length of hash as the private key size
3668 * here, it would be truncated by the internal implementation anyway. */
3669 required_hash_length = (hash_length < operation->coordinate_bytes ?
3670 hash_length : operation->coordinate_bytes);
3671
Paul Elliottba70ad42023-02-15 18:23:53 +00003672 if (required_hash_length > sizeof(operation->hash)) {
3673 /* Shouldn't happen, but better safe than sorry. */
3674 return PSA_ERROR_CORRUPTION_DETECTED;
3675 }
3676
Paul Elliott0290a762023-02-09 14:30:24 +00003677 memcpy(operation->hash, hash, required_hash_length);
3678 operation->hash_length = required_hash_length;
Paul Elliott068fe072023-01-16 13:59:15 +00003679
3680 return PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003681
3682#else
Paul Elliott068fe072023-01-16 13:59:15 +00003683 (void) operation;
3684 (void) key_buffer;
3685 (void) key_buffer_size;
3686 (void) alg;
3687 (void) hash;
3688 (void) hash_length;
3689 (void) status;
Paul Elliott0290a762023-02-09 14:30:24 +00003690 (void) required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003691
Paul Elliott068fe072023-01-16 13:59:15 +00003692 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003693#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3694 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3695 * defined( MBEDTLS_ECP_RESTARTABLE ) */
Paul Elliott588f8ed2022-12-02 18:10:26 +00003696}
3697
3698psa_status_t mbedtls_psa_sign_hash_complete(
3699 mbedtls_psa_sign_hash_interruptible_operation_t *operation,
3700 uint8_t *signature, size_t signature_size,
3701 size_t *signature_length)
3702{
Paul Elliott588f8ed2022-12-02 18:10:26 +00003703#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3704 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3705 defined(MBEDTLS_ECP_RESTARTABLE)
3706
Paul Elliotta1c94092023-02-15 16:38:04 +00003707 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott1243f932023-02-07 11:21:10 +00003708 mbedtls_mpi r;
3709 mbedtls_mpi s;
3710
Paul Elliott46845252023-02-03 14:59:11 +00003711 mbedtls_mpi_init(&r);
3712 mbedtls_mpi_init(&s);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003713
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003714 /* Ensure max_ops is set to the current value (or default). */
3715 mbedtls_psa_interruptible_set_max_ops(psa_interruptible_get_max_ops());
3716
Paul Elliotta1c94092023-02-15 16:38:04 +00003717 if (signature_size < 2 * operation->coordinate_bytes) {
3718 status = PSA_ERROR_BUFFER_TOO_SMALL;
3719 goto exit;
3720 }
3721
Paul Elliott588f8ed2022-12-02 18:10:26 +00003722 if (PSA_ALG_ECDSA_IS_DETERMINISTIC(operation->alg)) {
Paul Elliott46845252023-02-03 14:59:11 +00003723
Paul Elliott588f8ed2022-12-02 18:10:26 +00003724#if defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3725 status = mbedtls_to_psa_error(
3726 mbedtls_ecdsa_sign_det_restartable(&operation->ctx->grp,
Paul Elliott46845252023-02-03 14:59:11 +00003727 &r,
3728 &s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003729 &operation->ctx->d,
3730 operation->hash,
3731 operation->hash_length,
3732 operation->md_alg,
3733 mbedtls_psa_get_random,
3734 MBEDTLS_PSA_RANDOM_STATE,
3735 &operation->restart_ctx));
3736#else /* defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Paul Elliott724bd252023-02-08 12:35:08 +00003737 status = PSA_ERROR_NOT_SUPPORTED;
3738 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003739#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
3740 } else {
Paul Elliott588f8ed2022-12-02 18:10:26 +00003741 status = mbedtls_to_psa_error(
3742 mbedtls_ecdsa_sign_restartable(&operation->ctx->grp,
Paul Elliott46845252023-02-03 14:59:11 +00003743 &r,
3744 &s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003745 &operation->ctx->d,
3746 operation->hash,
3747 operation->hash_length,
3748 mbedtls_psa_get_random,
3749 MBEDTLS_PSA_RANDOM_STATE,
3750 mbedtls_psa_get_random,
3751 MBEDTLS_PSA_RANDOM_STATE,
3752 &operation->restart_ctx));
3753 }
3754
Paul Elliottf8e5b562023-02-19 18:43:45 +00003755 /* Hide the fact that the restart context only holds a delta of number of
3756 * ops done during the last operation, not an absolute value. */
3757 operation->num_ops += operation->restart_ctx.ecp.ops_done;
3758
Paul Elliott724bd252023-02-08 12:35:08 +00003759 if (status == PSA_SUCCESS) {
Paul Elliott588f8ed2022-12-02 18:10:26 +00003760 status = mbedtls_to_psa_error(
Paul Elliott46845252023-02-03 14:59:11 +00003761 mbedtls_mpi_write_binary(&r,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003762 signature,
Paul Elliott1bc59df2023-02-05 13:41:57 +00003763 operation->coordinate_bytes)
3764 );
Paul Elliott588f8ed2022-12-02 18:10:26 +00003765
3766 if (status != PSA_SUCCESS) {
Paul Elliott724bd252023-02-08 12:35:08 +00003767 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003768 }
3769
3770 status = mbedtls_to_psa_error(
Paul Elliott46845252023-02-03 14:59:11 +00003771 mbedtls_mpi_write_binary(&s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003772 signature +
Paul Elliott1bc59df2023-02-05 13:41:57 +00003773 operation->coordinate_bytes,
3774 operation->coordinate_bytes)
3775 );
Paul Elliott588f8ed2022-12-02 18:10:26 +00003776
3777 if (status != PSA_SUCCESS) {
Paul Elliott724bd252023-02-08 12:35:08 +00003778 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003779 }
3780
Paul Elliott1bc59df2023-02-05 13:41:57 +00003781 *signature_length = operation->coordinate_bytes * 2;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003782
Paul Elliott724bd252023-02-08 12:35:08 +00003783 status = PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003784 }
Paul Elliott724bd252023-02-08 12:35:08 +00003785
3786exit:
3787
3788 mbedtls_mpi_free(&r);
3789 mbedtls_mpi_free(&s);
3790 return status;
3791
Paul Elliott588f8ed2022-12-02 18:10:26 +00003792 #else
3793
3794 (void) operation;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003795 (void) signature;
3796 (void) signature_size;
3797 (void) signature_length;
3798
3799 return PSA_ERROR_NOT_SUPPORTED;
3800
3801#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3802 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3803 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3804}
3805
3806psa_status_t mbedtls_psa_sign_hash_abort(
3807 mbedtls_psa_sign_hash_interruptible_operation_t *operation)
3808{
3809
3810#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3811 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3812 defined(MBEDTLS_ECP_RESTARTABLE)
3813
3814 if (operation->ctx) {
3815 mbedtls_ecdsa_free(operation->ctx);
3816 mbedtls_free(operation->ctx);
Paul Elliottf9c91a72023-02-05 18:06:38 +00003817 operation->ctx = NULL;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003818 }
3819
3820 mbedtls_ecdsa_restart_free(&operation->restart_ctx);
3821
Paul Elliott93d9ca82023-02-15 18:14:21 +00003822 operation->num_ops = 0;
3823
Paul Elliott588f8ed2022-12-02 18:10:26 +00003824 return PSA_SUCCESS;
3825
3826#else
3827
3828 (void) operation;
3829
3830 return PSA_ERROR_NOT_SUPPORTED;
3831
3832#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3833 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3834 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3835}
3836
3837psa_status_t mbedtls_psa_verify_hash_start(
3838 mbedtls_psa_verify_hash_interruptible_operation_t *operation,
3839 const psa_key_attributes_t *attributes,
3840 const uint8_t *key_buffer, size_t key_buffer_size,
3841 psa_algorithm_t alg,
3842 const uint8_t *hash, size_t hash_length,
3843 const uint8_t *signature, size_t signature_length)
3844{
3845 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott1bc59df2023-02-05 13:41:57 +00003846 size_t coordinate_bytes = 0;
Paul Elliott0290a762023-02-09 14:30:24 +00003847 size_t required_hash_length = 0;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003848
Paul Elliott068fe072023-01-16 13:59:15 +00003849 if (!PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3850 return PSA_ERROR_NOT_SUPPORTED;
3851 }
3852
3853 if (!PSA_ALG_IS_ECDSA(alg)) {
Paul Elliott813f9cd2023-02-05 15:28:46 +00003854 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott068fe072023-01-16 13:59:15 +00003855 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003856
3857#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Paul Elliott068fe072023-01-16 13:59:15 +00003858 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3859 defined(MBEDTLS_ECP_RESTARTABLE)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003860
Paul Elliotta1c94092023-02-15 16:38:04 +00003861 mbedtls_ecdsa_restart_init(&operation->restart_ctx);
3862 mbedtls_mpi_init(&operation->r);
3863 mbedtls_mpi_init(&operation->s);
3864
Paul Elliott93d9ca82023-02-15 18:14:21 +00003865 /* Ensure num_ops is zero'ed in case of context re-use. */
3866 operation->num_ops = 0;
3867
Paul Elliott068fe072023-01-16 13:59:15 +00003868 status = mbedtls_psa_ecp_load_representation(attributes->core.type,
3869 attributes->core.bits,
3870 key_buffer,
3871 key_buffer_size,
3872 &operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003873
Paul Elliott068fe072023-01-16 13:59:15 +00003874 if (status != PSA_SUCCESS) {
3875 return status;
3876 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003877
Paul Elliottc569fc22023-02-10 13:02:54 +00003878 coordinate_bytes = PSA_BITS_TO_BYTES(operation->ctx->grp.nbits);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003879
Paul Elliott1bc59df2023-02-05 13:41:57 +00003880 if (signature_length != 2 * coordinate_bytes) {
Paul Elliott068fe072023-01-16 13:59:15 +00003881 return PSA_ERROR_INVALID_SIGNATURE;
3882 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003883
Paul Elliott068fe072023-01-16 13:59:15 +00003884 status = mbedtls_to_psa_error(
3885 mbedtls_mpi_read_binary(&operation->r,
3886 signature,
Paul Elliott1bc59df2023-02-05 13:41:57 +00003887 coordinate_bytes));
Paul Elliott588f8ed2022-12-02 18:10:26 +00003888
Paul Elliott068fe072023-01-16 13:59:15 +00003889 if (status != PSA_SUCCESS) {
3890 return status;
3891 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003892
Paul Elliott068fe072023-01-16 13:59:15 +00003893 status = mbedtls_to_psa_error(
3894 mbedtls_mpi_read_binary(&operation->s,
3895 signature +
Paul Elliott1bc59df2023-02-05 13:41:57 +00003896 coordinate_bytes,
3897 coordinate_bytes));
Paul Elliott588f8ed2022-12-02 18:10:26 +00003898
Paul Elliott068fe072023-01-16 13:59:15 +00003899 if (status != PSA_SUCCESS) {
3900 return status;
3901 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003902
Paul Elliott2c9843f2023-02-15 17:32:42 +00003903 status = mbedtls_psa_ecp_load_public_part(operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003904
Paul Elliott2c9843f2023-02-15 17:32:42 +00003905 if (status != PSA_SUCCESS) {
3906 return status;
Paul Elliott068fe072023-01-16 13:59:15 +00003907 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003908
Paul Elliott0290a762023-02-09 14:30:24 +00003909 /* We only need to store the same length of hash as the private key size
3910 * here, it would be truncated by the internal implementation anyway. */
3911 required_hash_length = (hash_length < coordinate_bytes ? hash_length :
3912 coordinate_bytes);
3913
Paul Elliottba70ad42023-02-15 18:23:53 +00003914 if (required_hash_length > sizeof(operation->hash)) {
3915 /* Shouldn't happen, but better safe than sorry. */
3916 return PSA_ERROR_CORRUPTION_DETECTED;
3917 }
3918
Paul Elliott0290a762023-02-09 14:30:24 +00003919 memcpy(operation->hash, hash, required_hash_length);
3920 operation->hash_length = required_hash_length;
Paul Elliott068fe072023-01-16 13:59:15 +00003921
3922 return PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003923#else
Paul Elliott068fe072023-01-16 13:59:15 +00003924 (void) operation;
3925 (void) key_buffer;
3926 (void) key_buffer_size;
3927 (void) alg;
3928 (void) hash;
3929 (void) hash_length;
3930 (void) signature;
3931 (void) signature_length;
3932 (void) status;
Paul Elliott1243f932023-02-07 11:21:10 +00003933 (void) coordinate_bytes;
Paul Elliott0290a762023-02-09 14:30:24 +00003934 (void) required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003935
Paul Elliott068fe072023-01-16 13:59:15 +00003936 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003937#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3938 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3939 * defined( MBEDTLS_ECP_RESTARTABLE ) */
Paul Elliott588f8ed2022-12-02 18:10:26 +00003940}
3941
3942psa_status_t mbedtls_psa_verify_hash_complete(
3943 mbedtls_psa_verify_hash_interruptible_operation_t *operation)
3944{
3945
3946#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3947 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3948 defined(MBEDTLS_ECP_RESTARTABLE)
3949
Paul Elliottf8e5b562023-02-19 18:43:45 +00003950 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3951
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003952 /* Ensure max_ops is set to the current value (or default). */
3953 mbedtls_psa_interruptible_set_max_ops(psa_interruptible_get_max_ops());
3954
Paul Elliottf8e5b562023-02-19 18:43:45 +00003955 status = mbedtls_to_psa_error(
Paul Elliott588f8ed2022-12-02 18:10:26 +00003956 mbedtls_ecdsa_verify_restartable(&operation->ctx->grp,
3957 operation->hash,
3958 operation->hash_length,
3959 &operation->ctx->Q,
3960 &operation->r,
3961 &operation->s,
3962 &operation->restart_ctx));
3963
Paul Elliottf8e5b562023-02-19 18:43:45 +00003964 /* Hide the fact that the restart context only holds a delta of number of
3965 * ops done during the last operation, not an absolute value. */
3966 operation->num_ops += operation->restart_ctx.ecp.ops_done;
3967
3968 return status;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003969#else
3970 (void) operation;
3971
3972 return PSA_ERROR_NOT_SUPPORTED;
3973
3974#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3975 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3976 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3977}
3978
3979psa_status_t mbedtls_psa_verify_hash_abort(
3980 mbedtls_psa_verify_hash_interruptible_operation_t *operation)
3981{
3982
3983#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3984 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3985 defined(MBEDTLS_ECP_RESTARTABLE)
3986
3987 if (operation->ctx) {
3988 mbedtls_ecdsa_free(operation->ctx);
3989 mbedtls_free(operation->ctx);
Paul Elliottf9c91a72023-02-05 18:06:38 +00003990 operation->ctx = NULL;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003991 }
3992
3993 mbedtls_ecdsa_restart_free(&operation->restart_ctx);
3994
Paul Elliott93d9ca82023-02-15 18:14:21 +00003995 operation->num_ops = 0;
3996
Paul Elliott588f8ed2022-12-02 18:10:26 +00003997 mbedtls_mpi_free(&operation->r);
3998 mbedtls_mpi_free(&operation->s);
3999
4000 return PSA_SUCCESS;
4001
4002#else
4003 (void) operation;
4004
4005 return PSA_ERROR_NOT_SUPPORTED;
4006
4007#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
4008 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
4009 * defined( MBEDTLS_ECP_RESTARTABLE ) */
4010}
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004011
mohammad1603503973b2018-03-12 15:59:30 +02004012/****************************************************************/
4013/* Symmetric cryptography */
4014/****************************************************************/
4015
Gilles Peskine449bd832023-01-11 14:50:10 +01004016static psa_status_t psa_cipher_setup(psa_cipher_operation_t *operation,
4017 mbedtls_svc_key_id_t key,
4018 psa_algorithm_t alg,
4019 mbedtls_operation_t cipher_operation)
Ronald Cronab99ac22020-10-01 16:38:28 +02004020{
4021 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4022 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman54648242021-06-24 11:49:45 +01004023 psa_key_slot_t *slot = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01004024 psa_key_usage_t usage = (cipher_operation == MBEDTLS_ENCRYPT ?
4025 PSA_KEY_USAGE_ENCRYPT :
4026 PSA_KEY_USAGE_DECRYPT);
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004027 psa_key_attributes_t attributes;
Ronald Cronab99ac22020-10-01 16:38:28 +02004028
4029 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004030 if (operation->id != 0) {
Dave Rodgman54648242021-06-24 11:49:45 +01004031 status = PSA_ERROR_BAD_STATE;
4032 goto exit;
4033 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004034
Gilles Peskine449bd832023-01-11 14:50:10 +01004035 if (!PSA_ALG_IS_CIPHER(alg)) {
Dave Rodgman54648242021-06-24 11:49:45 +01004036 status = PSA_ERROR_INVALID_ARGUMENT;
4037 goto exit;
4038 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004039
Gilles Peskine449bd832023-01-11 14:50:10 +01004040 status = psa_get_and_lock_key_slot_with_policy(key, &slot, usage, alg);
4041 if (status != PSA_SUCCESS) {
Ronald Cronab99ac22020-10-01 16:38:28 +02004042 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004043 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004044
Ronald Cron49fafa92021-03-10 08:34:23 +01004045 /* Initialize the operation struct members, except for id. The id member
Ronald Cronab99ac22020-10-01 16:38:28 +02004046 * is used to indicate to psa_cipher_abort that there are resources to free,
Ronald Cron49fafa92021-03-10 08:34:23 +01004047 * so we only set it (in the driver wrapper) after resources have been
4048 * allocated/initialized. */
Ronald Cronab99ac22020-10-01 16:38:28 +02004049 operation->iv_set = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004050 if (alg == PSA_ALG_ECB_NO_PADDING) {
Ronald Cronab99ac22020-10-01 16:38:28 +02004051 operation->iv_required = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004052 } else {
Ronald Cronab99ac22020-10-01 16:38:28 +02004053 operation->iv_required = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004054 }
4055 operation->default_iv_length = PSA_CIPHER_IV_LENGTH(slot->attr.type, alg);
Ronald Cronab99ac22020-10-01 16:38:28 +02004056
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004057 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004058 .core = slot->attr
Ronald Crona4af55f2020-12-14 14:36:06 +01004059 };
4060
Ronald Cronab99ac22020-10-01 16:38:28 +02004061 /* Try doing the operation through a driver before using software fallback. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004062 if (cipher_operation == MBEDTLS_ENCRYPT) {
4063 status = psa_driver_wrapper_cipher_encrypt_setup(operation,
4064 &attributes,
4065 slot->key.data,
4066 slot->key.bytes,
4067 alg);
4068 } else {
4069 status = psa_driver_wrapper_cipher_decrypt_setup(operation,
4070 &attributes,
4071 slot->key.data,
4072 slot->key.bytes,
4073 alg);
4074 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004075
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004076exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004077 if (status != PSA_SUCCESS) {
4078 psa_cipher_abort(operation);
4079 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004080
Ryan Everett1b70a072024-01-04 10:32:49 +00004081 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02004082
Gilles Peskine449bd832023-01-11 14:50:10 +01004083 return (status == PSA_SUCCESS) ? unlock_status : status;
mohammad1603503973b2018-03-12 15:59:30 +02004084}
4085
Gilles Peskine449bd832023-01-11 14:50:10 +01004086psa_status_t psa_cipher_encrypt_setup(psa_cipher_operation_t *operation,
4087 mbedtls_svc_key_id_t key,
4088 psa_algorithm_t alg)
mohammad16038481e742018-03-18 13:57:31 +02004089{
Gilles Peskine449bd832023-01-11 14:50:10 +01004090 return psa_cipher_setup(operation, key, alg, MBEDTLS_ENCRYPT);
mohammad16038481e742018-03-18 13:57:31 +02004091}
4092
Gilles Peskine449bd832023-01-11 14:50:10 +01004093psa_status_t psa_cipher_decrypt_setup(psa_cipher_operation_t *operation,
4094 mbedtls_svc_key_id_t key,
4095 psa_algorithm_t alg)
mohammad16038481e742018-03-18 13:57:31 +02004096{
Gilles Peskine449bd832023-01-11 14:50:10 +01004097 return psa_cipher_setup(operation, key, alg, MBEDTLS_DECRYPT);
mohammad16038481e742018-03-18 13:57:31 +02004098}
4099
Gilles Peskine449bd832023-01-11 14:50:10 +01004100psa_status_t psa_cipher_generate_iv(psa_cipher_operation_t *operation,
4101 uint8_t *iv,
4102 size_t iv_size,
4103 size_t *iv_length)
mohammad1603503973b2018-03-12 15:59:30 +02004104{
Ronald Cron6d051732020-10-01 14:10:20 +02004105 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2fb90522021-07-05 12:31:44 +02004106 uint8_t local_iv[PSA_CIPHER_IV_MAX_SIZE];
Sergeybef1f632023-03-06 15:25:06 -07004107 size_t default_iv_length = 0;
Ronald Cron5618a392021-03-26 09:52:26 +01004108
Gilles Peskine449bd832023-01-11 14:50:10 +01004109 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004110 status = PSA_ERROR_BAD_STATE;
4111 goto exit;
Ronald Cronc45b4af2020-09-29 16:18:05 +02004112 }
4113
Gilles Peskine449bd832023-01-11 14:50:10 +01004114 if (operation->iv_set || !operation->iv_required) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004115 status = PSA_ERROR_BAD_STATE;
4116 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004117 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004118
Ronald Cron2fb90522021-07-05 12:31:44 +02004119 default_iv_length = operation->default_iv_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01004120 if (iv_size < default_iv_length) {
Ronald Cron5618a392021-03-26 09:52:26 +01004121 status = PSA_ERROR_BUFFER_TOO_SMALL;
4122 goto exit;
4123 }
Gilles Peskinee553c652018-06-04 16:22:46 +02004124
Gilles Peskine449bd832023-01-11 14:50:10 +01004125 if (default_iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Ronald Cron2fb90522021-07-05 12:31:44 +02004126 status = PSA_ERROR_GENERIC_ERROR;
4127 goto exit;
4128 }
4129
Gilles Peskine449bd832023-01-11 14:50:10 +01004130 status = psa_generate_random(local_iv, default_iv_length);
4131 if (status != PSA_SUCCESS) {
Ronald Cron5618a392021-03-26 09:52:26 +01004132 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004133 }
Ronald Cron5618a392021-03-26 09:52:26 +01004134
Gilles Peskine449bd832023-01-11 14:50:10 +01004135 status = psa_driver_wrapper_cipher_set_iv(operation,
4136 local_iv, default_iv_length);
Ronald Cron5618a392021-03-26 09:52:26 +01004137
4138exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004139 if (status == PSA_SUCCESS) {
4140 memcpy(iv, local_iv, default_iv_length);
Ronald Cron2fb90522021-07-05 12:31:44 +02004141 *iv_length = default_iv_length;
Steven Cooreman7df02922020-09-09 15:28:49 +02004142 operation->iv_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004143 } else {
Ronald Cron2fb90522021-07-05 12:31:44 +02004144 *iv_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004145 psa_cipher_abort(operation);
Ronald Cron2fb90522021-07-05 12:31:44 +02004146 }
Ronald Cron6d051732020-10-01 14:10:20 +02004147
Gilles Peskine449bd832023-01-11 14:50:10 +01004148 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004149}
4150
Gilles Peskine449bd832023-01-11 14:50:10 +01004151psa_status_t psa_cipher_set_iv(psa_cipher_operation_t *operation,
4152 const uint8_t *iv,
4153 size_t iv_length)
mohammad1603503973b2018-03-12 15:59:30 +02004154{
Ronald Cron6d051732020-10-01 14:10:20 +02004155 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronc45b4af2020-09-29 16:18:05 +02004156
Gilles Peskine449bd832023-01-11 14:50:10 +01004157 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004158 status = PSA_ERROR_BAD_STATE;
4159 goto exit;
4160 }
Ronald Cronc45b4af2020-09-29 16:18:05 +02004161
Gilles Peskine449bd832023-01-11 14:50:10 +01004162 if (operation->iv_set || !operation->iv_required) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004163 status = PSA_ERROR_BAD_STATE;
4164 goto exit;
4165 }
Ronald Crona0d68172021-03-26 10:15:08 +01004166
Gilles Peskine449bd832023-01-11 14:50:10 +01004167 if (iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004168 status = PSA_ERROR_INVALID_ARGUMENT;
4169 goto exit;
4170 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004171
Gilles Peskine449bd832023-01-11 14:50:10 +01004172 status = psa_driver_wrapper_cipher_set_iv(operation,
4173 iv,
4174 iv_length);
Steven Cooremand3feccd2020-09-01 15:56:14 +02004175
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004176exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004177 if (status == PSA_SUCCESS) {
itayzafrir534bd7c2018-08-02 13:56:32 +03004178 operation->iv_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004179 } else {
4180 psa_cipher_abort(operation);
4181 }
4182 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004183}
4184
Gilles Peskine449bd832023-01-11 14:50:10 +01004185psa_status_t psa_cipher_update(psa_cipher_operation_t *operation,
4186 const uint8_t *input,
4187 size_t input_length,
4188 uint8_t *output,
4189 size_t output_size,
4190 size_t *output_length)
mohammad1603503973b2018-03-12 15:59:30 +02004191{
Steven Cooremanffecb7b2020-08-25 15:13:13 +02004192 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron6d051732020-10-01 14:10:20 +02004193
Gilles Peskine449bd832023-01-11 14:50:10 +01004194 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004195 status = PSA_ERROR_BAD_STATE;
4196 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004197 }
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004198
Gilles Peskine449bd832023-01-11 14:50:10 +01004199 if (operation->iv_required && !operation->iv_set) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004200 status = PSA_ERROR_BAD_STATE;
4201 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004202 }
Jaeden Ameroab439972019-02-15 14:12:05 +00004203
Gilles Peskine449bd832023-01-11 14:50:10 +01004204 status = psa_driver_wrapper_cipher_update(operation,
4205 input,
4206 input_length,
4207 output,
4208 output_size,
4209 output_length);
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004210
4211exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004212 if (status != PSA_SUCCESS) {
4213 psa_cipher_abort(operation);
4214 }
Ronald Cron6d051732020-10-01 14:10:20 +02004215
Gilles Peskine449bd832023-01-11 14:50:10 +01004216 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004217}
4218
Gilles Peskine449bd832023-01-11 14:50:10 +01004219psa_status_t psa_cipher_finish(psa_cipher_operation_t *operation,
4220 uint8_t *output,
4221 size_t output_size,
4222 size_t *output_length)
mohammad1603503973b2018-03-12 15:59:30 +02004223{
David Saadab4ecc272019-02-14 13:48:10 +02004224 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Ronald Cron6d051732020-10-01 14:10:20 +02004225
Gilles Peskine449bd832023-01-11 14:50:10 +01004226 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004227 status = PSA_ERROR_BAD_STATE;
4228 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004229 }
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004230
Gilles Peskine449bd832023-01-11 14:50:10 +01004231 if (operation->iv_required && !operation->iv_set) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004232 status = PSA_ERROR_BAD_STATE;
4233 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004234 }
Moran Pekerbed71a22018-04-22 20:19:20 +03004235
Gilles Peskine449bd832023-01-11 14:50:10 +01004236 status = psa_driver_wrapper_cipher_finish(operation,
4237 output,
4238 output_size,
4239 output_length);
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004240
4241exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004242 if (status == PSA_SUCCESS) {
4243 return psa_cipher_abort(operation);
4244 } else {
Steven Cooremanef8575e2020-09-11 11:44:50 +02004245 *output_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004246 (void) psa_cipher_abort(operation);
Janos Follath315b51c2018-07-09 16:04:51 +01004247
Gilles Peskine449bd832023-01-11 14:50:10 +01004248 return status;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004249 }
mohammad1603503973b2018-03-12 15:59:30 +02004250}
4251
Gilles Peskine449bd832023-01-11 14:50:10 +01004252psa_status_t psa_cipher_abort(psa_cipher_operation_t *operation)
Gilles Peskinee553c652018-06-04 16:22:46 +02004253{
Gilles Peskine449bd832023-01-11 14:50:10 +01004254 if (operation->id == 0) {
Steven Cooremana07b9972020-09-10 14:54:14 +02004255 /* The object has (apparently) been initialized but it is not (yet)
Gilles Peskine81736312018-06-26 15:04:31 +02004256 * in use. It's ok to call abort on such an object, and there's
4257 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004258 return PSA_SUCCESS;
Gilles Peskine81736312018-06-26 15:04:31 +02004259 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004260
Gilles Peskine449bd832023-01-11 14:50:10 +01004261 psa_driver_wrapper_cipher_abort(operation);
Gilles Peskinee553c652018-06-04 16:22:46 +02004262
Ronald Cron49fafa92021-03-10 08:34:23 +01004263 operation->id = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004264 operation->iv_set = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004265 operation->iv_required = 0;
Moran Peker41deec42018-04-04 15:43:05 +03004266
Gilles Peskine449bd832023-01-11 14:50:10 +01004267 return PSA_SUCCESS;
mohammad1603503973b2018-03-12 15:59:30 +02004268}
4269
Gilles Peskine449bd832023-01-11 14:50:10 +01004270psa_status_t psa_cipher_encrypt(mbedtls_svc_key_id_t key,
4271 psa_algorithm_t alg,
4272 const uint8_t *input,
4273 size_t input_length,
4274 uint8_t *output,
4275 size_t output_size,
4276 size_t *output_length)
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004277{
4278 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004279 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron23919522021-07-08 19:00:07 +02004280 psa_key_slot_t *slot = NULL;
Ronald Cronc6e6f502021-07-09 18:44:58 +02004281 uint8_t local_iv[PSA_CIPHER_IV_MAX_SIZE];
4282 size_t default_iv_length = 0;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004283 psa_key_attributes_t attributes;
gabor-mezei-arm6f4e5bb2021-06-25 15:21:11 +02004284
Gilles Peskine449bd832023-01-11 14:50:10 +01004285 if (!PSA_ALG_IS_CIPHER(alg)) {
Ronald Cron23919522021-07-08 19:00:07 +02004286 status = PSA_ERROR_INVALID_ARGUMENT;
4287 goto exit;
4288 }
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004289
Gilles Peskine449bd832023-01-11 14:50:10 +01004290 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
4291 PSA_KEY_USAGE_ENCRYPT,
4292 alg);
4293 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004294 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004295 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004296
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004297 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004298 .core = slot->attr
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004299 };
4300
Gilles Peskine449bd832023-01-11 14:50:10 +01004301 default_iv_length = PSA_CIPHER_IV_LENGTH(slot->attr.type, alg);
4302 if (default_iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Ronald Cronc6e6f502021-07-09 18:44:58 +02004303 status = PSA_ERROR_GENERIC_ERROR;
4304 goto exit;
4305 }
4306
Gilles Peskine449bd832023-01-11 14:50:10 +01004307 if (default_iv_length > 0) {
4308 if (output_size < default_iv_length) {
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004309 status = PSA_ERROR_BUFFER_TOO_SMALL;
4310 goto exit;
4311 }
4312
Gilles Peskine449bd832023-01-11 14:50:10 +01004313 status = psa_generate_random(local_iv, default_iv_length);
4314 if (status != PSA_SUCCESS) {
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004315 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004316 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004317 }
4318
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004319 status = psa_driver_wrapper_cipher_encrypt(
4320 &attributes, slot->key.data, slot->key.bytes,
Ronald Cronc6e6f502021-07-09 18:44:58 +02004321 alg, local_iv, default_iv_length, input, input_length,
Ronald Cronafbc7ed2023-01-24 16:02:04 +01004322 psa_crypto_buffer_offset(output, default_iv_length),
Gilles Peskine449bd832023-01-11 14:50:10 +01004323 output_size - default_iv_length, output_length);
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004324
4325exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00004326 unlock_status = psa_unregister_read(slot);
Gilles Peskine449bd832023-01-11 14:50:10 +01004327 if (status == PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004328 status = unlock_status;
Ronald Cronc6e6f502021-07-09 18:44:58 +02004329 }
Ronald Cron23919522021-07-08 19:00:07 +02004330
Gilles Peskine449bd832023-01-11 14:50:10 +01004331 if (status == PSA_SUCCESS) {
4332 if (default_iv_length > 0) {
4333 memcpy(output, local_iv, default_iv_length);
4334 }
4335 *output_length += default_iv_length;
4336 } else {
4337 *output_length = 0;
4338 }
4339
4340 return status;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004341}
4342
Gilles Peskine449bd832023-01-11 14:50:10 +01004343psa_status_t psa_cipher_decrypt(mbedtls_svc_key_id_t key,
4344 psa_algorithm_t alg,
4345 const uint8_t *input,
4346 size_t input_length,
4347 uint8_t *output,
4348 size_t output_size,
4349 size_t *output_length)
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004350{
4351 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004352 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron23919522021-07-08 19:00:07 +02004353 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004354 psa_key_attributes_t attributes;
gabor-mezei-arm6f4e5bb2021-06-25 15:21:11 +02004355
Gilles Peskine449bd832023-01-11 14:50:10 +01004356 if (!PSA_ALG_IS_CIPHER(alg)) {
Ronald Cron23919522021-07-08 19:00:07 +02004357 status = PSA_ERROR_INVALID_ARGUMENT;
4358 goto exit;
4359 }
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004360
Gilles Peskine449bd832023-01-11 14:50:10 +01004361 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
4362 PSA_KEY_USAGE_DECRYPT,
4363 alg);
4364 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004365 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004366 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004367
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004368 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004369 .core = slot->attr
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004370 };
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004371
Gilles Peskine449bd832023-01-11 14:50:10 +01004372 if (alg == PSA_ALG_CCM_STAR_NO_TAG &&
4373 input_length < PSA_BLOCK_CIPHER_BLOCK_LENGTH(slot->attr.type)) {
Mateusz Starzyk594215b2021-10-14 12:23:06 +02004374 status = PSA_ERROR_INVALID_ARGUMENT;
4375 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004376 } else if (input_length < PSA_CIPHER_IV_LENGTH(slot->attr.type, alg)) {
gabor-mezei-arm258ae072021-06-25 15:25:38 +02004377 status = PSA_ERROR_INVALID_ARGUMENT;
4378 goto exit;
4379 }
4380
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004381 status = psa_driver_wrapper_cipher_decrypt(
4382 &attributes, slot->key.data, slot->key.bytes,
4383 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004384 output, output_size, output_length);
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004385
gabor-mezei-arm258ae072021-06-25 15:25:38 +02004386exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00004387 unlock_status = psa_unregister_read(slot);
Gilles Peskine449bd832023-01-11 14:50:10 +01004388 if (status == PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004389 status = unlock_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01004390 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004391
Gilles Peskine449bd832023-01-11 14:50:10 +01004392 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004393 *output_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004394 }
Ronald Cron23919522021-07-08 19:00:07 +02004395
Gilles Peskine449bd832023-01-11 14:50:10 +01004396 return status;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004397}
4398
4399
mohammad16035955c982018-04-26 00:53:03 +03004400/****************************************************************/
4401/* AEAD */
4402/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004403
Paul Elliottbaff51c2021-09-28 17:44:45 +01004404/* Helper function to get the base algorithm from its variants. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004405static psa_algorithm_t psa_aead_get_base_algorithm(psa_algorithm_t alg)
Paul Elliottbaff51c2021-09-28 17:44:45 +01004406{
Gilles Peskine449bd832023-01-11 14:50:10 +01004407 return PSA_ALG_AEAD_WITH_DEFAULT_LENGTH_TAG(alg);
Paul Elliottbaff51c2021-09-28 17:44:45 +01004408}
4409
4410/* Helper function to perform common nonce length checks. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004411static psa_status_t psa_aead_check_nonce_length(psa_algorithm_t alg,
4412 size_t nonce_length)
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004413{
Gilles Peskine449bd832023-01-11 14:50:10 +01004414 psa_algorithm_t base_alg = psa_aead_get_base_algorithm(alg);
Paul Elliottbaff51c2021-09-28 17:44:45 +01004415
Gilles Peskine449bd832023-01-11 14:50:10 +01004416 switch (base_alg) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004417#if defined(PSA_WANT_ALG_GCM)
4418 case PSA_ALG_GCM:
4419 /* Not checking max nonce size here as GCM spec allows almost
Gilles Peskine449bd832023-01-11 14:50:10 +01004420 * arbitrarily large nonces. Please note that we do not generally
4421 * recommend the usage of nonces of greater length than
4422 * PSA_AEAD_NONCE_MAX_SIZE, as large nonces are hashed to a shorter
4423 * size, which can then lead to collisions if you encrypt a very
4424 * large number of messages.*/
4425 if (nonce_length != 0) {
4426 return PSA_SUCCESS;
4427 }
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004428 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004429#endif /* PSA_WANT_ALG_GCM */
4430#if defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004431 case PSA_ALG_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01004432 if (nonce_length >= 7 && nonce_length <= 13) {
4433 return PSA_SUCCESS;
4434 }
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004435 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004436#endif /* PSA_WANT_ALG_CCM */
4437#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004438 case PSA_ALG_CHACHA20_POLY1305:
Gilles Peskine449bd832023-01-11 14:50:10 +01004439 if (nonce_length == 12) {
4440 return PSA_SUCCESS;
4441 } else if (nonce_length == 8) {
4442 return PSA_ERROR_NOT_SUPPORTED;
4443 }
Bence Szépkúti6d48e202021-11-15 20:04:15 +01004444 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004445#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004446 default:
Przemek Stekiel4c499272022-09-27 13:55:37 +02004447 (void) nonce_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01004448 return PSA_ERROR_NOT_SUPPORTED;
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004449 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004450
Gilles Peskine449bd832023-01-11 14:50:10 +01004451 return PSA_ERROR_INVALID_ARGUMENT;
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004452}
4453
Gilles Peskine449bd832023-01-11 14:50:10 +01004454static psa_status_t psa_aead_check_algorithm(psa_algorithm_t alg)
Bence Szépkútiaa3a6e42022-01-13 16:26:03 +01004455{
Gilles Peskine449bd832023-01-11 14:50:10 +01004456 if (!PSA_ALG_IS_AEAD(alg) || PSA_ALG_IS_WILDCARD(alg)) {
4457 return PSA_ERROR_INVALID_ARGUMENT;
4458 }
Bence Szépkúti08f34652021-12-08 21:07:13 +01004459
Gilles Peskine449bd832023-01-11 14:50:10 +01004460 return PSA_SUCCESS;
Bence Szépkúti08f34652021-12-08 21:07:13 +01004461}
4462
Gilles Peskine449bd832023-01-11 14:50:10 +01004463psa_status_t psa_aead_encrypt(mbedtls_svc_key_id_t key,
4464 psa_algorithm_t alg,
4465 const uint8_t *nonce,
4466 size_t nonce_length,
4467 const uint8_t *additional_data,
4468 size_t additional_data_length,
4469 const uint8_t *plaintext,
4470 size_t plaintext_length,
4471 uint8_t *ciphertext,
4472 size_t ciphertext_size,
4473 size_t *ciphertext_length)
mohammad16035955c982018-04-26 00:53:03 +03004474{
Ronald Cron215633c2021-03-16 17:15:37 +01004475 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4476 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02004477
mohammad1603f08a5502018-06-03 15:05:47 +03004478 *ciphertext_length = 0;
mohammad1603e58e6842018-05-09 04:58:32 -07004479
Gilles Peskine449bd832023-01-11 14:50:10 +01004480 status = psa_aead_check_algorithm(alg);
4481 if (status != PSA_SUCCESS) {
4482 return status;
4483 }
Steven Cooremanea7ab132021-03-17 16:28:00 +01004484
Ronald Cron9a986162021-03-26 12:40:07 +01004485 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01004486 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg);
4487 if (status != PSA_SUCCESS) {
4488 return status;
4489 }
mohammad16035955c982018-04-26 00:53:03 +03004490
Ronald Cron215633c2021-03-16 17:15:37 +01004491 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01004492 .core = slot->attr
Ronald Cron215633c2021-03-16 17:15:37 +01004493 };
mohammad16035955c982018-04-26 00:53:03 +03004494
Gilles Peskine449bd832023-01-11 14:50:10 +01004495 status = psa_aead_check_nonce_length(alg, nonce_length);
4496 if (status != PSA_SUCCESS) {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004497 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004498 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004499
Ronald Cronde822812021-03-17 16:08:20 +01004500 status = psa_driver_wrapper_aead_encrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01004501 &attributes, slot->key.data, slot->key.bytes,
4502 alg,
4503 nonce, nonce_length,
4504 additional_data, additional_data_length,
4505 plaintext, plaintext_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004506 ciphertext, ciphertext_size, ciphertext_length);
Gilles Peskine2d277862018-06-18 15:41:12 +02004507
Gilles Peskine449bd832023-01-11 14:50:10 +01004508 if (status != PSA_SUCCESS && ciphertext_size != 0) {
4509 memset(ciphertext, 0, ciphertext_size);
4510 }
Gilles Peskine2d277862018-06-18 15:41:12 +02004511
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004512exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00004513 psa_unregister_read(slot);
mohammad16035955c982018-04-26 00:53:03 +03004514
Gilles Peskine449bd832023-01-11 14:50:10 +01004515 return status;
Gilles Peskineee652a32018-06-01 19:23:52 +02004516}
4517
Gilles Peskine449bd832023-01-11 14:50:10 +01004518psa_status_t psa_aead_decrypt(mbedtls_svc_key_id_t key,
4519 psa_algorithm_t alg,
4520 const uint8_t *nonce,
4521 size_t nonce_length,
4522 const uint8_t *additional_data,
4523 size_t additional_data_length,
4524 const uint8_t *ciphertext,
4525 size_t ciphertext_length,
4526 uint8_t *plaintext,
4527 size_t plaintext_size,
4528 size_t *plaintext_length)
mohammad16035955c982018-04-26 00:53:03 +03004529{
Ronald Cron215633c2021-03-16 17:15:37 +01004530 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4531 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02004532
Gilles Peskineee652a32018-06-01 19:23:52 +02004533 *plaintext_length = 0;
mohammad16039e5a5152018-04-26 12:07:35 +03004534
Gilles Peskine449bd832023-01-11 14:50:10 +01004535 status = psa_aead_check_algorithm(alg);
4536 if (status != PSA_SUCCESS) {
4537 return status;
4538 }
Steven Cooremanea7ab132021-03-17 16:28:00 +01004539
Ronald Cron9a986162021-03-26 12:40:07 +01004540 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01004541 key, &slot, PSA_KEY_USAGE_DECRYPT, alg);
4542 if (status != PSA_SUCCESS) {
4543 return status;
4544 }
mohammad16035955c982018-04-26 00:53:03 +03004545
Ronald Cron215633c2021-03-16 17:15:37 +01004546 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01004547 .core = slot->attr
Ronald Cron215633c2021-03-16 17:15:37 +01004548 };
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004549
Gilles Peskine449bd832023-01-11 14:50:10 +01004550 status = psa_aead_check_nonce_length(alg, nonce_length);
4551 if (status != PSA_SUCCESS) {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004552 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004553 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004554
Ronald Cronde822812021-03-17 16:08:20 +01004555 status = psa_driver_wrapper_aead_decrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01004556 &attributes, slot->key.data, slot->key.bytes,
4557 alg,
4558 nonce, nonce_length,
4559 additional_data, additional_data_length,
4560 ciphertext, ciphertext_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004561 plaintext, plaintext_size, plaintext_length);
Gilles Peskinea40d7742018-06-01 16:28:30 +02004562
Gilles Peskine449bd832023-01-11 14:50:10 +01004563 if (status != PSA_SUCCESS && plaintext_size != 0) {
4564 memset(plaintext, 0, plaintext_size);
4565 }
mohammad160360a64d02018-06-03 17:20:42 +03004566
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004567exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00004568 psa_unregister_read(slot);
Ronald Cron215633c2021-03-16 17:15:37 +01004569
Gilles Peskine449bd832023-01-11 14:50:10 +01004570 return status;
mohammad16035955c982018-04-26 00:53:03 +03004571}
4572
Gilles Peskine449bd832023-01-11 14:50:10 +01004573static psa_status_t psa_validate_tag_length(psa_algorithm_t alg)
4574{
4575 const uint8_t tag_len = PSA_ALG_AEAD_GET_TAG_LENGTH(alg);
Andrzej Kurekf8816012021-12-19 17:00:12 +01004576
Gilles Peskine449bd832023-01-11 14:50:10 +01004577 switch (PSA_ALG_AEAD_WITH_SHORTENED_TAG(alg, 0)) {
Przemek Stekiel86679c72022-10-06 17:06:56 +02004578#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004579 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004580 /* CCM allows the following tag lengths: 4, 6, 8, 10, 12, 14, 16.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004581 if (tag_len < 4 || tag_len > 16 || tag_len % 2) {
4582 return PSA_ERROR_INVALID_ARGUMENT;
4583 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01004584 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02004585#endif /* PSA_WANT_ALG_CCM */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004586
Przemek Stekiel86679c72022-10-06 17:06:56 +02004587#if defined(PSA_WANT_ALG_GCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004588 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_GCM, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004589 /* GCM allows the following tag lengths: 4, 8, 12, 13, 14, 15, 16. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004590 if (tag_len != 4 && tag_len != 8 && (tag_len < 12 || tag_len > 16)) {
4591 return PSA_ERROR_INVALID_ARGUMENT;
4592 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01004593 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02004594#endif /* PSA_WANT_ALG_GCM */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004595
Przemek Stekiel86679c72022-10-06 17:06:56 +02004596#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Gilles Peskine449bd832023-01-11 14:50:10 +01004597 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CHACHA20_POLY1305, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004598 /* We only support the default tag length. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004599 if (tag_len != 16) {
4600 return PSA_ERROR_INVALID_ARGUMENT;
4601 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01004602 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02004603#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004604
4605 default:
4606 (void) tag_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004607 return PSA_ERROR_NOT_SUPPORTED;
Andrzej Kurekf8816012021-12-19 17:00:12 +01004608 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004609 return PSA_SUCCESS;
Andrzej Kurekf8816012021-12-19 17:00:12 +01004610}
4611
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004612/* Set the key for a multipart authenticated operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004613static psa_status_t psa_aead_setup(psa_aead_operation_t *operation,
4614 int is_encrypt,
4615 mbedtls_svc_key_id_t key,
4616 psa_algorithm_t alg)
Paul Elliottc2b71442021-06-24 18:17:52 +01004617{
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004618 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4619 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
4620 psa_key_slot_t *slot = NULL;
4621 psa_key_usage_t key_usage = 0;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004622 psa_key_attributes_t attributes;
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004623
Gilles Peskine449bd832023-01-11 14:50:10 +01004624 status = psa_aead_check_algorithm(alg);
4625 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004626 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004627 }
Paul Elliottc2b71442021-06-24 18:17:52 +01004628
Gilles Peskine449bd832023-01-11 14:50:10 +01004629 if (operation->id != 0) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004630 status = PSA_ERROR_BAD_STATE;
4631 goto exit;
Paul Elliottc2b71442021-06-24 18:17:52 +01004632 }
4633
Gilles Peskine449bd832023-01-11 14:50:10 +01004634 if (operation->nonce_set || operation->lengths_set ||
4635 operation->ad_started || operation->body_started) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004636 status = PSA_ERROR_BAD_STATE;
4637 goto exit;
Paul Elliottc2b71442021-06-24 18:17:52 +01004638 }
4639
Gilles Peskine449bd832023-01-11 14:50:10 +01004640 if (is_encrypt) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004641 key_usage = PSA_KEY_USAGE_ENCRYPT;
Gilles Peskine449bd832023-01-11 14:50:10 +01004642 } else {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004643 key_usage = PSA_KEY_USAGE_DECRYPT;
Gilles Peskine449bd832023-01-11 14:50:10 +01004644 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004645
Gilles Peskine449bd832023-01-11 14:50:10 +01004646 status = psa_get_and_lock_key_slot_with_policy(key, &slot, key_usage,
4647 alg);
4648 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004649 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004650 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004651
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004652 attributes = (psa_key_attributes_t) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004653 .core = slot->attr
4654 };
4655
Gilles Peskine449bd832023-01-11 14:50:10 +01004656 if ((status = psa_validate_tag_length(alg)) != PSA_SUCCESS) {
Przemek Stekiel6ab50762022-10-08 17:54:30 +02004657 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004658 }
Przemek Stekiel6ab50762022-10-08 17:54:30 +02004659
Gilles Peskine449bd832023-01-11 14:50:10 +01004660 if (is_encrypt) {
4661 status = psa_driver_wrapper_aead_encrypt_setup(operation,
4662 &attributes,
4663 slot->key.data,
4664 slot->key.bytes,
4665 alg);
4666 } else {
4667 status = psa_driver_wrapper_aead_decrypt_setup(operation,
4668 &attributes,
4669 slot->key.data,
4670 slot->key.bytes,
4671 alg);
4672 }
4673 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004674 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004675 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004676
Gilles Peskine449bd832023-01-11 14:50:10 +01004677 operation->key_type = psa_get_key_type(&attributes);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004678
4679exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00004680 unlock_status = psa_unregister_read(slot);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004681
Gilles Peskine449bd832023-01-11 14:50:10 +01004682 if (status == PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004683 status = unlock_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01004684 operation->alg = psa_aead_get_base_algorithm(alg);
Paul Elliottd9343f22021-08-23 18:59:49 +01004685 operation->is_encrypt = is_encrypt;
Gilles Peskine449bd832023-01-11 14:50:10 +01004686 } else {
4687 psa_aead_abort(operation);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004688 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004689
Gilles Peskine449bd832023-01-11 14:50:10 +01004690 return status;
Paul Elliottc2b71442021-06-24 18:17:52 +01004691}
4692
Paul Elliott302ff6b2021-04-20 18:10:30 +01004693/* Set the key for a multipart authenticated encryption operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004694psa_status_t psa_aead_encrypt_setup(psa_aead_operation_t *operation,
4695 mbedtls_svc_key_id_t key,
4696 psa_algorithm_t alg)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004697{
Gilles Peskine449bd832023-01-11 14:50:10 +01004698 return psa_aead_setup(operation, 1, key, alg);
Paul Elliott302ff6b2021-04-20 18:10:30 +01004699}
4700
4701/* Set the key for a multipart authenticated decryption operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004702psa_status_t psa_aead_decrypt_setup(psa_aead_operation_t *operation,
4703 mbedtls_svc_key_id_t key,
4704 psa_algorithm_t alg)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004705{
Gilles Peskine449bd832023-01-11 14:50:10 +01004706 return psa_aead_setup(operation, 0, key, alg);
Paul Elliott302ff6b2021-04-20 18:10:30 +01004707}
4708
4709/* Generate a random nonce / IV for multipart AEAD operation */
Gilles Peskine449bd832023-01-11 14:50:10 +01004710psa_status_t psa_aead_generate_nonce(psa_aead_operation_t *operation,
4711 uint8_t *nonce,
4712 size_t nonce_size,
4713 size_t *nonce_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004714{
4715 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Croncae59092021-11-26 18:53:58 +01004716 uint8_t local_nonce[PSA_AEAD_NONCE_MAX_SIZE];
Sergeybef1f632023-03-06 15:25:06 -07004717 size_t required_nonce_size = 0;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004718
Paul Elliott8eb9daf2021-06-04 16:42:21 +01004719 *nonce_length = 0;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004720
Gilles Peskine449bd832023-01-11 14:50:10 +01004721 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004722 status = PSA_ERROR_BAD_STATE;
4723 goto exit;
4724 }
4725
Gilles Peskine449bd832023-01-11 14:50:10 +01004726 if (operation->nonce_set || !operation->is_encrypt) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004727 status = PSA_ERROR_BAD_STATE;
4728 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004729 }
4730
Paul Elliotte193ea82021-10-01 13:00:16 +01004731 /* For CCM, this size may not be correct according to the PSA
4732 * specification. The PSA Crypto 1.0.1 specification states:
4733 *
4734 * CCM encodes the plaintext length pLen in L octets, with L the smallest
4735 * integer >= 2 where pLen < 2^(8L). The nonce length is then 15 - L bytes.
4736 *
4737 * However this restriction that L has to be the smallest integer is not
4738 * applied in practice, and it is not implementable here since the
4739 * plaintext length may or may not be known at this time. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004740 required_nonce_size = PSA_AEAD_NONCE_LENGTH(operation->key_type,
4741 operation->alg);
4742 if (nonce_size < required_nonce_size) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004743 status = PSA_ERROR_BUFFER_TOO_SMALL;
4744 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004745 }
4746
Gilles Peskine449bd832023-01-11 14:50:10 +01004747 status = psa_generate_random(local_nonce, required_nonce_size);
4748 if (status != PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004749 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004750 }
Paul Elliott302ff6b2021-04-20 18:10:30 +01004751
Gilles Peskine449bd832023-01-11 14:50:10 +01004752 status = psa_aead_set_nonce(operation, local_nonce, required_nonce_size);
Paul Elliott302ff6b2021-04-20 18:10:30 +01004753
Paul Elliott39dc6b82021-05-11 19:16:09 +01004754exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004755 if (status == PSA_SUCCESS) {
4756 memcpy(nonce, local_nonce, required_nonce_size);
Paul Elliott39dc6b82021-05-11 19:16:09 +01004757 *nonce_length = required_nonce_size;
Gilles Peskine449bd832023-01-11 14:50:10 +01004758 } else {
4759 psa_aead_abort(operation);
Ronald Croncae59092021-11-26 18:53:58 +01004760 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01004761
Gilles Peskine449bd832023-01-11 14:50:10 +01004762 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004763}
4764
4765/* Set the nonce for a multipart authenticated encryption or decryption
4766 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004767psa_status_t psa_aead_set_nonce(psa_aead_operation_t *operation,
4768 const uint8_t *nonce,
4769 size_t nonce_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004770{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004771 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4772
Gilles Peskine449bd832023-01-11 14:50:10 +01004773 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004774 status = PSA_ERROR_BAD_STATE;
4775 goto exit;
4776 }
4777
Gilles Peskine449bd832023-01-11 14:50:10 +01004778 if (operation->nonce_set) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004779 status = PSA_ERROR_BAD_STATE;
4780 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004781 }
4782
Gilles Peskine449bd832023-01-11 14:50:10 +01004783 status = psa_aead_check_nonce_length(operation->alg, nonce_length);
4784 if (status != PSA_SUCCESS) {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004785 status = PSA_ERROR_INVALID_ARGUMENT;
4786 goto exit;
Paul Elliott4ed1ed12021-09-27 18:09:28 +01004787 }
Paul Elliott1a98aca2021-05-20 18:24:07 +01004788
Gilles Peskine449bd832023-01-11 14:50:10 +01004789 status = psa_driver_wrapper_aead_set_nonce(operation, nonce,
4790 nonce_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004791
Paul Elliott39dc6b82021-05-11 19:16:09 +01004792exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004793 if (status == PSA_SUCCESS) {
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004794 operation->nonce_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004795 } else {
4796 psa_aead_abort(operation);
4797 }
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004798
Gilles Peskine449bd832023-01-11 14:50:10 +01004799 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004800}
4801
4802/* Declare the lengths of the message and additional data for multipart AEAD. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004803psa_status_t psa_aead_set_lengths(psa_aead_operation_t *operation,
4804 size_t ad_length,
4805 size_t plaintext_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004806{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004807 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4808
Gilles Peskine449bd832023-01-11 14:50:10 +01004809 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004810 status = PSA_ERROR_BAD_STATE;
4811 goto exit;
4812 }
4813
Gilles Peskine449bd832023-01-11 14:50:10 +01004814 if (operation->lengths_set || operation->ad_started ||
4815 operation->body_started) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004816 status = PSA_ERROR_BAD_STATE;
4817 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004818 }
4819
Gilles Peskine449bd832023-01-11 14:50:10 +01004820 switch (operation->alg) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004821#if defined(PSA_WANT_ALG_GCM)
4822 case PSA_ALG_GCM:
4823 /* Lengths can only be too large for GCM if size_t is bigger than 32
Gilles Peskine449bd832023-01-11 14:50:10 +01004824 * bits. Without the guard this code will generate warnings on 32bit
4825 * builds. */
Paul Elliott325d3742021-09-27 17:56:28 +01004826#if SIZE_MAX > UINT32_MAX
Gilles Peskine449bd832023-01-11 14:50:10 +01004827 if (((uint64_t) ad_length) >> 61 != 0 ||
4828 ((uint64_t) plaintext_length) > 0xFFFFFFFE0ull) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004829 status = PSA_ERROR_INVALID_ARGUMENT;
4830 goto exit;
4831 }
Paul Elliott325d3742021-09-27 17:56:28 +01004832#endif
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004833 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004834#endif /* PSA_WANT_ALG_GCM */
4835#if defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004836 case PSA_ALG_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01004837 if (ad_length > 0xFF00) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004838 status = PSA_ERROR_INVALID_ARGUMENT;
4839 goto exit;
4840 }
4841 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004842#endif /* PSA_WANT_ALG_CCM */
4843#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004844 case PSA_ALG_CHACHA20_POLY1305:
4845 /* No length restrictions for ChaChaPoly. */
4846 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004847#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004848 default:
4849 break;
4850 }
Paul Elliott325d3742021-09-27 17:56:28 +01004851
Gilles Peskine449bd832023-01-11 14:50:10 +01004852 status = psa_driver_wrapper_aead_set_lengths(operation, ad_length,
4853 plaintext_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004854
Paul Elliott39dc6b82021-05-11 19:16:09 +01004855exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004856 if (status == PSA_SUCCESS) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01004857 operation->ad_remaining = ad_length;
4858 operation->body_remaining = plaintext_length;
Paul Elliott39dc6b82021-05-11 19:16:09 +01004859 operation->lengths_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004860 } else {
4861 psa_aead_abort(operation);
Paul Elliottee4ffe02021-05-20 17:25:06 +01004862 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01004863
Gilles Peskine449bd832023-01-11 14:50:10 +01004864 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004865}
Paul Elliott3d7d52c2021-09-01 10:33:14 +01004866
4867/* Pass additional data to an active multipart AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004868psa_status_t psa_aead_update_ad(psa_aead_operation_t *operation,
4869 const uint8_t *input,
4870 size_t input_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004871{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004872 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4873
Gilles Peskine449bd832023-01-11 14:50:10 +01004874 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004875 status = PSA_ERROR_BAD_STATE;
4876 goto exit;
4877 }
4878
Gilles Peskine449bd832023-01-11 14:50:10 +01004879 if (!operation->nonce_set || operation->body_started) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004880 status = PSA_ERROR_BAD_STATE;
4881 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004882 }
4883
Gilles Peskine449bd832023-01-11 14:50:10 +01004884 if (operation->lengths_set) {
4885 if (operation->ad_remaining < input_length) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01004886 status = PSA_ERROR_INVALID_ARGUMENT;
4887 goto exit;
4888 }
4889
4890 operation->ad_remaining -= input_length;
4891 }
Paul Elliotte193ea82021-10-01 13:00:16 +01004892#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004893 else if (operation->alg == PSA_ALG_CCM) {
Paul Elliotte193ea82021-10-01 13:00:16 +01004894 status = PSA_ERROR_BAD_STATE;
4895 goto exit;
4896 }
4897#endif /* PSA_WANT_ALG_CCM */
Paul Elliottee4ffe02021-05-20 17:25:06 +01004898
Gilles Peskine449bd832023-01-11 14:50:10 +01004899 status = psa_driver_wrapper_aead_update_ad(operation, input,
4900 input_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004901
Paul Elliott39dc6b82021-05-11 19:16:09 +01004902exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004903 if (status == PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004904 operation->ad_started = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004905 } else {
4906 psa_aead_abort(operation);
4907 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01004908
Gilles Peskine449bd832023-01-11 14:50:10 +01004909 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004910}
4911
4912/* Encrypt or decrypt a message fragment in an active multipart AEAD
4913 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004914psa_status_t psa_aead_update(psa_aead_operation_t *operation,
4915 const uint8_t *input,
4916 size_t input_length,
4917 uint8_t *output,
4918 size_t output_size,
4919 size_t *output_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004920{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004921 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004922
4923 *output_length = 0;
4924
Gilles Peskine449bd832023-01-11 14:50:10 +01004925 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004926 status = PSA_ERROR_BAD_STATE;
4927 goto exit;
4928 }
4929
Gilles Peskine449bd832023-01-11 14:50:10 +01004930 if (!operation->nonce_set) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004931 status = PSA_ERROR_BAD_STATE;
4932 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004933 }
4934
Gilles Peskine449bd832023-01-11 14:50:10 +01004935 if (operation->lengths_set) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01004936 /* Additional data length was supplied, but not all the additional
4937 data was supplied.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004938 if (operation->ad_remaining != 0) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01004939 status = PSA_ERROR_INVALID_ARGUMENT;
4940 goto exit;
4941 }
4942
4943 /* Too much data provided. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004944 if (operation->body_remaining < input_length) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01004945 status = PSA_ERROR_INVALID_ARGUMENT;
4946 goto exit;
4947 }
4948
4949 operation->body_remaining -= input_length;
4950 }
Paul Elliotte193ea82021-10-01 13:00:16 +01004951#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004952 else if (operation->alg == PSA_ALG_CCM) {
Paul Elliotte193ea82021-10-01 13:00:16 +01004953 status = PSA_ERROR_BAD_STATE;
4954 goto exit;
4955 }
4956#endif /* PSA_WANT_ALG_CCM */
Paul Elliottee4ffe02021-05-20 17:25:06 +01004957
Gilles Peskine449bd832023-01-11 14:50:10 +01004958 status = psa_driver_wrapper_aead_update(operation, input, input_length,
4959 output, output_size,
4960 output_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004961
Paul Elliott39dc6b82021-05-11 19:16:09 +01004962exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004963 if (status == PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004964 operation->body_started = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004965 } else {
4966 psa_aead_abort(operation);
4967 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01004968
Gilles Peskine449bd832023-01-11 14:50:10 +01004969 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004970}
4971
Gilles Peskine449bd832023-01-11 14:50:10 +01004972static psa_status_t psa_aead_final_checks(const psa_aead_operation_t *operation)
Paul Elliottad53dcc2021-06-23 08:50:14 +01004973{
Gilles Peskine449bd832023-01-11 14:50:10 +01004974 if (operation->id == 0 || !operation->nonce_set) {
4975 return PSA_ERROR_BAD_STATE;
4976 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01004977
Gilles Peskine449bd832023-01-11 14:50:10 +01004978 if (operation->lengths_set && (operation->ad_remaining != 0 ||
4979 operation->body_remaining != 0)) {
4980 return PSA_ERROR_INVALID_ARGUMENT;
4981 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01004982
Gilles Peskine449bd832023-01-11 14:50:10 +01004983 return PSA_SUCCESS;
Paul Elliottad53dcc2021-06-23 08:50:14 +01004984}
4985
Paul Elliott302ff6b2021-04-20 18:10:30 +01004986/* Finish encrypting a message in a multipart AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004987psa_status_t psa_aead_finish(psa_aead_operation_t *operation,
4988 uint8_t *ciphertext,
4989 size_t ciphertext_size,
4990 size_t *ciphertext_length,
4991 uint8_t *tag,
4992 size_t tag_size,
4993 size_t *tag_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004994{
Paul Elliott39dc6b82021-05-11 19:16:09 +01004995 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4996
Paul Elliott302ff6b2021-04-20 18:10:30 +01004997 *ciphertext_length = 0;
Paul Elliottf88a5652021-06-22 17:53:45 +01004998 *tag_length = tag_size;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004999
Gilles Peskine449bd832023-01-11 14:50:10 +01005000 status = psa_aead_final_checks(operation);
5001 if (status != PSA_SUCCESS) {
Paul Elliottad53dcc2021-06-23 08:50:14 +01005002 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005003 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01005004
Gilles Peskine449bd832023-01-11 14:50:10 +01005005 if (!operation->is_encrypt) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005006 status = PSA_ERROR_BAD_STATE;
5007 goto exit;
5008 }
5009
Gilles Peskine449bd832023-01-11 14:50:10 +01005010 status = psa_driver_wrapper_aead_finish(operation, ciphertext,
5011 ciphertext_size,
5012 ciphertext_length,
5013 tag, tag_size, tag_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005014
Paul Elliott39dc6b82021-05-11 19:16:09 +01005015exit:
Paul Elliottdc42ca82023-02-24 18:11:59 +00005016
5017
Paul Elliottf47b0952021-05-21 18:02:33 +01005018 /* In case the operation fails and the user fails to check for failure or
Paul Elliott4c916e82021-09-19 18:34:50 +01005019 * the zero tag size, make sure the tag is set to something implausible.
5020 * Even if the operation succeeds, make sure we clear the rest of the
5021 * buffer to prevent potential leakage of anything previously placed in
5022 * the same buffer.*/
Paul Elliottdc42ca82023-02-24 18:11:59 +00005023 psa_wipe_tag_output_buffer(tag, status, tag_size, *tag_length);
Paul Elliottf47b0952021-05-21 18:02:33 +01005024
Gilles Peskine449bd832023-01-11 14:50:10 +01005025 psa_aead_abort(operation);
Paul Elliott39dc6b82021-05-11 19:16:09 +01005026
Gilles Peskine449bd832023-01-11 14:50:10 +01005027 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005028}
5029
5030/* Finish authenticating and decrypting a message in a multipart AEAD
5031 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01005032psa_status_t psa_aead_verify(psa_aead_operation_t *operation,
5033 uint8_t *plaintext,
5034 size_t plaintext_size,
5035 size_t *plaintext_length,
5036 const uint8_t *tag,
5037 size_t tag_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005038{
Paul Elliott39dc6b82021-05-11 19:16:09 +01005039 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5040
Paul Elliott302ff6b2021-04-20 18:10:30 +01005041 *plaintext_length = 0;
5042
Gilles Peskine449bd832023-01-11 14:50:10 +01005043 status = psa_aead_final_checks(operation);
5044 if (status != PSA_SUCCESS) {
Paul Elliottad53dcc2021-06-23 08:50:14 +01005045 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005046 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01005047
Gilles Peskine449bd832023-01-11 14:50:10 +01005048 if (operation->is_encrypt) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005049 status = PSA_ERROR_BAD_STATE;
5050 goto exit;
5051 }
5052
Gilles Peskine449bd832023-01-11 14:50:10 +01005053 status = psa_driver_wrapper_aead_verify(operation, plaintext,
5054 plaintext_size,
5055 plaintext_length,
5056 tag, tag_length);
Paul Elliott39dc6b82021-05-11 19:16:09 +01005057
5058exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005059 psa_aead_abort(operation);
Paul Elliott39dc6b82021-05-11 19:16:09 +01005060
Gilles Peskine449bd832023-01-11 14:50:10 +01005061 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005062}
5063
5064/* Abort an AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005065psa_status_t psa_aead_abort(psa_aead_operation_t *operation)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005066{
5067 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5068
Gilles Peskine449bd832023-01-11 14:50:10 +01005069 if (operation->id == 0) {
Paul Elliott302ff6b2021-04-20 18:10:30 +01005070 /* The object has (apparently) been initialized but it is not (yet)
5071 * in use. It's ok to call abort on such an object, and there's
5072 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005073 return PSA_SUCCESS;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005074 }
5075
Gilles Peskine449bd832023-01-11 14:50:10 +01005076 status = psa_driver_wrapper_aead_abort(operation);
Paul Elliott302ff6b2021-04-20 18:10:30 +01005077
Gilles Peskine449bd832023-01-11 14:50:10 +01005078 memset(operation, 0, sizeof(*operation));
Paul Elliott302ff6b2021-04-20 18:10:30 +01005079
Gilles Peskine449bd832023-01-11 14:50:10 +01005080 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005081}
5082
Gilles Peskinee59236f2018-01-27 23:32:46 +01005083/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02005084/* Generators */
5085/****************************************************************/
5086
Przemek Stekiel69c46792022-06-10 12:59:51 +02005087#if defined(BUILTIN_ALG_ANY_HKDF) || \
John Durkop07cc04a2020-11-16 22:08:34 -08005088 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005089 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) || \
Kusumit Ghoderaoaf0b5342023-05-03 11:58:46 +05305090 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS) || \
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305091 defined(PSA_HAVE_SOFT_PBKDF2)
John Durkop07cc04a2020-11-16 22:08:34 -08005092#define AT_LEAST_ONE_BUILTIN_KDF
Steven Cooreman094a77e2021-05-06 17:58:36 +02005093#endif /* At least one builtin KDF */
5094
Przemek Stekiel69c46792022-06-10 12:59:51 +02005095#if defined(BUILTIN_ALG_ANY_HKDF) || \
Steven Cooreman094a77e2021-05-06 17:58:36 +02005096 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5097 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
5098static psa_status_t psa_key_derivation_start_hmac(
5099 psa_mac_operation_t *operation,
5100 psa_algorithm_t hash_alg,
5101 const uint8_t *hmac_key,
Gilles Peskine449bd832023-01-11 14:50:10 +01005102 size_t hmac_key_length)
Steven Cooreman094a77e2021-05-06 17:58:36 +02005103{
5104 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5105 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01005106 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
5107 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(hmac_key_length));
5108 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_HASH);
Steven Cooreman094a77e2021-05-06 17:58:36 +02005109
Steven Cooreman72f736a2021-05-07 14:14:37 +02005110 operation->is_sign = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005111 operation->mac_size = PSA_HASH_LENGTH(hash_alg);
Steven Cooreman72f736a2021-05-07 14:14:37 +02005112
Gilles Peskine449bd832023-01-11 14:50:10 +01005113 status = psa_driver_wrapper_mac_sign_setup(operation,
5114 &attributes,
5115 hmac_key, hmac_key_length,
5116 PSA_ALG_HMAC(hash_alg));
Steven Cooreman094a77e2021-05-06 17:58:36 +02005117
Gilles Peskine449bd832023-01-11 14:50:10 +01005118 psa_reset_key_attributes(&attributes);
5119 return status;
Steven Cooreman094a77e2021-05-06 17:58:36 +02005120}
5121#endif /* KDF algorithms reliant on HMAC */
John Durkop07cc04a2020-11-16 22:08:34 -08005122
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005123#define HKDF_STATE_INIT 0 /* no input yet */
5124#define HKDF_STATE_STARTED 1 /* got salt */
5125#define HKDF_STATE_KEYED 2 /* got key */
5126#define HKDF_STATE_OUTPUT 3 /* output started */
5127
Gilles Peskinecbe66502019-05-16 16:59:18 +02005128static psa_algorithm_t psa_key_derivation_get_kdf_alg(
Gilles Peskine449bd832023-01-11 14:50:10 +01005129 const psa_key_derivation_operation_t *operation)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005130{
Gilles Peskine449bd832023-01-11 14:50:10 +01005131 if (PSA_ALG_IS_KEY_AGREEMENT(operation->alg)) {
5132 return PSA_ALG_KEY_AGREEMENT_GET_KDF(operation->alg);
5133 } else {
5134 return operation->alg;
5135 }
Gilles Peskine969c5d62019-01-16 15:53:06 +01005136}
5137
Gilles Peskine449bd832023-01-11 14:50:10 +01005138psa_status_t psa_key_derivation_abort(psa_key_derivation_operation_t *operation)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005139{
5140 psa_status_t status = PSA_SUCCESS;
Gilles Peskine449bd832023-01-11 14:50:10 +01005141 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
5142 if (kdf_alg == 0) {
Gilles Peskineeab56e42018-07-12 17:12:33 +02005143 /* The object has (apparently) been initialized but it is not
5144 * in use. It's ok to call abort on such an object, and there's
5145 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005146 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02005147#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01005148 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
5149 mbedtls_free(operation->ctx.hkdf.info);
5150 status = psa_mac_abort(&operation->ctx.hkdf.hmac);
5151 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02005152#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08005153#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5154 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005155 if (PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
5156 /* TLS-1.2 PSK-to-MS KDF uses the same core as TLS-1.2 PRF */
5157 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
5158 if (operation->ctx.tls12_prf.secret != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005159 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.secret,
Gilles Peskine449bd832023-01-11 14:50:10 +01005160 operation->ctx.tls12_prf.secret_length);
Steven Cooremana6df6042021-04-29 19:32:25 +02005161 }
5162
Gilles Peskine449bd832023-01-11 14:50:10 +01005163 if (operation->ctx.tls12_prf.seed != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005164 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.seed,
Gilles Peskine449bd832023-01-11 14:50:10 +01005165 operation->ctx.tls12_prf.seed_length);
Janos Follath6a1d2622019-06-11 10:37:28 +01005166 }
5167
Gilles Peskine449bd832023-01-11 14:50:10 +01005168 if (operation->ctx.tls12_prf.label != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005169 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.label,
Gilles Peskine449bd832023-01-11 14:50:10 +01005170 operation->ctx.tls12_prf.label_length);
Janos Follath6a1d2622019-06-11 10:37:28 +01005171 }
Przemek Stekiel6c764412022-11-22 14:05:12 +01005172#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005173 if (operation->ctx.tls12_prf.other_secret != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005174 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.other_secret,
Gilles Peskine449bd832023-01-11 14:50:10 +01005175 operation->ctx.tls12_prf.other_secret_length);
Przemek Stekiele3ee2212022-04-07 14:29:56 +02005176 }
Przemek Stekiel6c764412022-11-22 14:05:12 +01005177#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Steven Cooremana6df6042021-04-29 19:32:25 +02005178 status = PSA_SUCCESS;
Janos Follath6a1d2622019-06-11 10:37:28 +01005179
5180 /* We leave the fields Ai and output_block to be erased safely by the
5181 * mbedtls_platform_zeroize() in the end of this function. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005182 } else
John Durkop07cc04a2020-11-16 22:08:34 -08005183#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
5184 * defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005185#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005186 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
5187 mbedtls_platform_zeroize(operation->ctx.tls12_ecjpake_to_pms.data,
5188 sizeof(operation->ctx.tls12_ecjpake_to_pms.data));
5189 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005190#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS) */
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305191#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05305192 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305193 if (operation->ctx.pbkdf2.salt != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005194 mbedtls_zeroize_and_free(operation->ctx.pbkdf2.salt,
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305195 operation->ctx.pbkdf2.salt_length);
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305196 }
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305197
5198 status = PSA_SUCCESS;
5199 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305200#endif /* defined(PSA_HAVE_SOFT_PBKDF2) */
Gilles Peskineeab56e42018-07-12 17:12:33 +02005201 {
5202 status = PSA_ERROR_BAD_STATE;
5203 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005204 mbedtls_platform_zeroize(operation, sizeof(*operation));
5205 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005206}
5207
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005208psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskine449bd832023-01-11 14:50:10 +01005209 size_t *capacity)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005210{
Gilles Peskine449bd832023-01-11 14:50:10 +01005211 if (operation->alg == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005212 /* This is a blank key derivation operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005213 return PSA_ERROR_BAD_STATE;
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005214 }
5215
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005216 *capacity = operation->capacity;
Gilles Peskine449bd832023-01-11 14:50:10 +01005217 return PSA_SUCCESS;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005218}
5219
Gilles Peskine449bd832023-01-11 14:50:10 +01005220psa_status_t psa_key_derivation_set_capacity(psa_key_derivation_operation_t *operation,
5221 size_t capacity)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005222{
Gilles Peskine449bd832023-01-11 14:50:10 +01005223 if (operation->alg == 0) {
5224 return PSA_ERROR_BAD_STATE;
5225 }
5226 if (capacity > operation->capacity) {
5227 return PSA_ERROR_INVALID_ARGUMENT;
5228 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005229 operation->capacity = capacity;
Gilles Peskine449bd832023-01-11 14:50:10 +01005230 return PSA_SUCCESS;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005231}
5232
Przemek Stekiel69c46792022-06-10 12:59:51 +02005233#if defined(BUILTIN_ALG_ANY_HKDF)
Przemek Stekiel03d948c2022-05-19 11:45:20 +02005234/* Read some bytes from an HKDF-based operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005235static psa_status_t psa_key_derivation_hkdf_read(psa_hkdf_key_derivation_t *hkdf,
5236 psa_algorithm_t kdf_alg,
5237 uint8_t *output,
5238 size_t output_length)
Gilles Peskinebef7f142018-07-12 17:22:21 +02005239{
Gilles Peskine449bd832023-01-11 14:50:10 +01005240 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
5241 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Steven Cooremand1ed1d92021-04-29 19:11:25 +02005242 size_t hmac_output_length;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005243 psa_status_t status;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005244#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01005245 const uint8_t last_block = PSA_ALG_IS_HKDF_EXTRACT(kdf_alg) ? 0 : 0xff;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005246#else
5247 const uint8_t last_block = 0xff;
5248#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskinebef7f142018-07-12 17:22:21 +02005249
Gilles Peskine449bd832023-01-11 14:50:10 +01005250 if (hkdf->state < HKDF_STATE_KEYED ||
5251 (!hkdf->info_set
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005252#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01005253 && !PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005254#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01005255 )) {
5256 return PSA_ERROR_BAD_STATE;
5257 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005258 hkdf->state = HKDF_STATE_OUTPUT;
5259
Gilles Peskine449bd832023-01-11 14:50:10 +01005260 while (output_length != 0) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005261 /* Copy what remains of the current block */
5262 uint8_t n = hash_length - hkdf->offset_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005263 if (n > output_length) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005264 n = (uint8_t) output_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01005265 }
5266 memcpy(output, hkdf->output_block + hkdf->offset_in_block, n);
Gilles Peskinebef7f142018-07-12 17:22:21 +02005267 output += n;
5268 output_length -= n;
5269 hkdf->offset_in_block += n;
Gilles Peskine449bd832023-01-11 14:50:10 +01005270 if (output_length == 0) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005271 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01005272 }
Przemek Stekiel03d948c2022-05-19 11:45:20 +02005273 /* We can't be wanting more output after the last block, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005274 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005275 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02005276 * object was corrupted or if this function is called directly
5277 * inside the library. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005278 if (hkdf->block_number == last_block) {
5279 return PSA_ERROR_BAD_STATE;
5280 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02005281
5282 /* We need a new block */
5283 ++hkdf->block_number;
5284 hkdf->offset_in_block = 0;
Steven Cooremand1ed1d92021-04-29 19:11:25 +02005285
Gilles Peskine449bd832023-01-11 14:50:10 +01005286 status = psa_key_derivation_start_hmac(&hkdf->hmac,
5287 hash_alg,
5288 hkdf->prk,
5289 hash_length);
5290 if (status != PSA_SUCCESS) {
5291 return status;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005292 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005293
5294 if (hkdf->block_number != 1) {
5295 status = psa_mac_update(&hkdf->hmac,
5296 hkdf->output_block,
5297 hash_length);
5298 if (status != PSA_SUCCESS) {
5299 return status;
5300 }
5301 }
5302 status = psa_mac_update(&hkdf->hmac,
5303 hkdf->info,
5304 hkdf->info_length);
5305 if (status != PSA_SUCCESS) {
5306 return status;
5307 }
5308 status = psa_mac_update(&hkdf->hmac,
5309 &hkdf->block_number, 1);
5310 if (status != PSA_SUCCESS) {
5311 return status;
5312 }
5313 status = psa_mac_sign_finish(&hkdf->hmac,
5314 hkdf->output_block,
5315 sizeof(hkdf->output_block),
5316 &hmac_output_length);
5317 if (status != PSA_SUCCESS) {
5318 return status;
5319 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02005320 }
5321
Gilles Peskine449bd832023-01-11 14:50:10 +01005322 return PSA_SUCCESS;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005323}
Przemek Stekiel69c46792022-06-10 12:59:51 +02005324#endif /* BUILTIN_ALG_ANY_HKDF */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005325
John Durkop07cc04a2020-11-16 22:08:34 -08005326#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5327 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follath7742fee2019-06-17 12:58:10 +01005328static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
5329 psa_tls12_prf_key_derivation_t *tls12_prf,
Gilles Peskine449bd832023-01-11 14:50:10 +01005330 psa_algorithm_t alg)
Janos Follath7742fee2019-06-17 12:58:10 +01005331{
Gilles Peskine449bd832023-01-11 14:50:10 +01005332 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(alg);
5333 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Steven Cooremana6df6042021-04-29 19:32:25 +02005334 psa_mac_operation_t hmac = PSA_MAC_OPERATION_INIT;
5335 size_t hmac_output_length;
Janos Follathea29bfb2019-06-19 12:21:20 +01005336 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005337
Janos Follath7742fee2019-06-17 12:58:10 +01005338 /* We can't be wanting more output after block 0xff, otherwise
5339 * the capacity check in psa_key_derivation_output_bytes() would have
5340 * prevented this call. It could happen only if the operation
5341 * object was corrupted or if this function is called directly
5342 * inside the library. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005343 if (tls12_prf->block_number == 0xff) {
5344 return PSA_ERROR_CORRUPTION_DETECTED;
5345 }
Janos Follath7742fee2019-06-17 12:58:10 +01005346
5347 /* We need a new block */
5348 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01005349 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01005350
5351 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
5352 *
5353 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
5354 *
5355 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
5356 * HMAC_hash(secret, A(2) + seed) +
5357 * HMAC_hash(secret, A(3) + seed) + ...
5358 *
5359 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01005360 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01005361 *
Janos Follathea29bfb2019-06-19 12:21:20 +01005362 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01005363 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01005364 * is currently extracted as `output_block` and where i is
5365 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01005366 */
5367
Gilles Peskine449bd832023-01-11 14:50:10 +01005368 status = psa_key_derivation_start_hmac(&hmac,
5369 hash_alg,
5370 tls12_prf->secret,
5371 tls12_prf->secret_length);
5372 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005373 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005374 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005375
5376 /* Calculate A(i) where i = tls12_prf->block_number. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005377 if (tls12_prf->block_number == 1) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005378 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
5379 * the variable seed and in this instance means it in the context of the
5380 * P_hash function, where seed = label + seed.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01005381 status = psa_mac_update(&hmac,
5382 tls12_prf->label,
5383 tls12_prf->label_length);
5384 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005385 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005386 }
5387 status = psa_mac_update(&hmac,
5388 tls12_prf->seed,
5389 tls12_prf->seed_length);
5390 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005391 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005392 }
5393 } else {
Janos Follathea29bfb2019-06-19 12:21:20 +01005394 /* A(i) = HMAC_hash(secret, A(i-1)) */
Gilles Peskine449bd832023-01-11 14:50:10 +01005395 status = psa_mac_update(&hmac, tls12_prf->Ai, hash_length);
5396 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005397 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005398 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005399 }
5400
Gilles Peskine449bd832023-01-11 14:50:10 +01005401 status = psa_mac_sign_finish(&hmac,
5402 tls12_prf->Ai, hash_length,
5403 &hmac_output_length);
5404 if (hmac_output_length != hash_length) {
Steven Cooremana6df6042021-04-29 19:32:25 +02005405 status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01005406 }
5407 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005408 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005409 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005410
5411 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
Gilles Peskine449bd832023-01-11 14:50:10 +01005412 status = psa_key_derivation_start_hmac(&hmac,
5413 hash_alg,
5414 tls12_prf->secret,
5415 tls12_prf->secret_length);
5416 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005417 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005418 }
5419 status = psa_mac_update(&hmac, tls12_prf->Ai, hash_length);
5420 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005421 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005422 }
5423 status = psa_mac_update(&hmac, tls12_prf->label, tls12_prf->label_length);
5424 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005425 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005426 }
5427 status = psa_mac_update(&hmac, tls12_prf->seed, tls12_prf->seed_length);
5428 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005429 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005430 }
5431 status = psa_mac_sign_finish(&hmac,
5432 tls12_prf->output_block, hash_length,
5433 &hmac_output_length);
5434 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005435 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005436 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005437
Janos Follath7742fee2019-06-17 12:58:10 +01005438
5439cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01005440 cleanup_status = psa_mac_abort(&hmac);
5441 if (status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005442 status = cleanup_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01005443 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005444
Gilles Peskine449bd832023-01-11 14:50:10 +01005445 return status;
Janos Follath7742fee2019-06-17 12:58:10 +01005446}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005447
Janos Follath844eb0e2019-06-19 12:10:49 +01005448static psa_status_t psa_key_derivation_tls12_prf_read(
5449 psa_tls12_prf_key_derivation_t *tls12_prf,
5450 psa_algorithm_t alg,
5451 uint8_t *output,
Gilles Peskine449bd832023-01-11 14:50:10 +01005452 size_t output_length)
Janos Follath844eb0e2019-06-19 12:10:49 +01005453{
Gilles Peskine449bd832023-01-11 14:50:10 +01005454 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH(alg);
5455 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Janos Follath844eb0e2019-06-19 12:10:49 +01005456 psa_status_t status;
5457 uint8_t offset, length;
5458
Gilles Peskine449bd832023-01-11 14:50:10 +01005459 switch (tls12_prf->state) {
Gilles Peskineb1edaec2021-06-11 22:41:46 +02005460 case PSA_TLS12_PRF_STATE_LABEL_SET:
5461 tls12_prf->state = PSA_TLS12_PRF_STATE_OUTPUT;
5462 break;
5463 case PSA_TLS12_PRF_STATE_OUTPUT:
5464 break;
5465 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005466 return PSA_ERROR_BAD_STATE;
Gilles Peskineb1edaec2021-06-11 22:41:46 +02005467 }
5468
Gilles Peskine449bd832023-01-11 14:50:10 +01005469 while (output_length != 0) {
Janos Follath844eb0e2019-06-19 12:10:49 +01005470 /* Check if we have fully processed the current block. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005471 if (tls12_prf->left_in_block == 0) {
5472 status = psa_key_derivation_tls12_prf_generate_next_block(tls12_prf,
5473 alg);
5474 if (status != PSA_SUCCESS) {
5475 return status;
5476 }
Janos Follath844eb0e2019-06-19 12:10:49 +01005477
5478 continue;
5479 }
5480
Gilles Peskine449bd832023-01-11 14:50:10 +01005481 if (tls12_prf->left_in_block > output_length) {
Janos Follath844eb0e2019-06-19 12:10:49 +01005482 length = (uint8_t) output_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01005483 } else {
Janos Follath844eb0e2019-06-19 12:10:49 +01005484 length = tls12_prf->left_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005485 }
Janos Follath844eb0e2019-06-19 12:10:49 +01005486
5487 offset = hash_length - tls12_prf->left_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005488 memcpy(output, tls12_prf->output_block + offset, length);
Janos Follath844eb0e2019-06-19 12:10:49 +01005489 output += length;
5490 output_length -= length;
5491 tls12_prf->left_in_block -= length;
5492 }
5493
Gilles Peskine449bd832023-01-11 14:50:10 +01005494 return PSA_SUCCESS;
Janos Follath844eb0e2019-06-19 12:10:49 +01005495}
John Durkop07cc04a2020-11-16 22:08:34 -08005496#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
5497 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskinebef7f142018-07-12 17:22:21 +02005498
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005499#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
5500static psa_status_t psa_key_derivation_tls12_ecjpake_to_pms_read(
5501 psa_tls12_ecjpake_to_pms_t *ecjpake,
5502 uint8_t *output,
Gilles Peskine449bd832023-01-11 14:50:10 +01005503 size_t output_length)
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005504{
5505 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Andrzej Kurek5603efd2022-09-26 10:49:16 -04005506 size_t output_size = 0;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005507
Gilles Peskine449bd832023-01-11 14:50:10 +01005508 if (output_length != 32) {
5509 return PSA_ERROR_INVALID_ARGUMENT;
5510 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005511
Gilles Peskine449bd832023-01-11 14:50:10 +01005512 status = psa_hash_compute(PSA_ALG_SHA_256, ecjpake->data,
5513 PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE, output, output_length,
5514 &output_size);
5515 if (status != PSA_SUCCESS) {
5516 return status;
5517 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005518
Gilles Peskine449bd832023-01-11 14:50:10 +01005519 if (output_size != output_length) {
5520 return PSA_ERROR_GENERIC_ERROR;
5521 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005522
Gilles Peskine449bd832023-01-11 14:50:10 +01005523 return PSA_SUCCESS;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005524}
5525#endif
5526
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305527#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305528static psa_status_t psa_key_derivation_pbkdf2_generate_block(
5529 psa_pbkdf2_key_derivation_t *pbkdf2,
5530 psa_algorithm_t prf_alg,
5531 uint8_t prf_output_length,
5532 psa_key_attributes_t *attributes)
5533{
5534 psa_status_t status;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305535 psa_mac_operation_t mac_operation = PSA_MAC_OPERATION_INIT;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305536 size_t mac_output_length;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305537 uint8_t U_i[PSA_MAC_MAX_SIZE];
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305538 uint8_t *U_accumulator = pbkdf2->output_block;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305539 uint64_t i;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305540 uint8_t block_counter[4];
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305541
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305542 mac_operation.is_sign = 1;
5543 mac_operation.mac_size = prf_output_length;
5544 MBEDTLS_PUT_UINT32_BE(pbkdf2->block_number, block_counter, 0);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305545
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305546 status = psa_driver_wrapper_mac_sign_setup(&mac_operation,
5547 attributes,
5548 pbkdf2->password,
5549 pbkdf2->password_length,
5550 prf_alg);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305551 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305552 goto cleanup;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305553 }
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305554 status = psa_mac_update(&mac_operation, pbkdf2->salt, pbkdf2->salt_length);
5555 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305556 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305557 }
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305558 status = psa_mac_update(&mac_operation, block_counter, sizeof(block_counter));
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305559 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305560 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305561 }
5562 status = psa_mac_sign_finish(&mac_operation, U_i, sizeof(U_i),
5563 &mac_output_length);
5564 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305565 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305566 }
5567
5568 if (mac_output_length != prf_output_length) {
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305569 status = PSA_ERROR_CORRUPTION_DETECTED;
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305570 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305571 }
5572
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305573 memcpy(U_accumulator, U_i, prf_output_length);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305574
5575 for (i = 1; i < pbkdf2->input_cost; i++) {
Kusumit Ghoderao4536bb62023-06-22 15:42:59 +05305576 /* We are passing prf_output_length as mac_size because the driver
5577 * function directly sets mac_output_length as mac_size upon success.
Kusumit Ghoderao5f3345a2023-07-27 21:21:38 +05305578 * See https://github.com/Mbed-TLS/mbedtls/issues/7801 */
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305579 status = psa_driver_wrapper_mac_compute(attributes,
5580 pbkdf2->password,
5581 pbkdf2->password_length,
5582 prf_alg, U_i, prf_output_length,
Kusumit Ghoderao4536bb62023-06-22 15:42:59 +05305583 U_i, prf_output_length,
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305584 &mac_output_length);
5585 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305586 goto cleanup;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305587 }
5588
Kusumit Ghoderao109ee3d2023-06-08 16:36:45 +05305589 mbedtls_xor(U_accumulator, U_accumulator, U_i, prf_output_length);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305590 }
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305591
5592cleanup:
5593 /* Zeroise buffers to clear sensitive data from memory. */
5594 mbedtls_platform_zeroize(U_i, PSA_MAC_MAX_SIZE);
5595 return status;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305596}
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05305597
5598static psa_status_t psa_key_derivation_pbkdf2_read(
5599 psa_pbkdf2_key_derivation_t *pbkdf2,
5600 psa_algorithm_t kdf_alg,
5601 uint8_t *output,
5602 size_t output_length)
5603{
5604 psa_status_t status;
5605 psa_algorithm_t prf_alg;
5606 uint8_t prf_output_length;
5607 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
5608 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(pbkdf2->password_length));
5609 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
5610
5611 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
5612 prf_alg = PSA_ALG_HMAC(PSA_ALG_PBKDF2_HMAC_GET_HASH(kdf_alg));
5613 prf_output_length = PSA_HASH_LENGTH(prf_alg);
5614 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
Kusumit Ghoderaoa2520a52023-06-22 15:42:19 +05305615 } else if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
5616 prf_alg = PSA_ALG_CMAC;
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05305617 prf_output_length = PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC);
Kusumit Ghoderaoa2520a52023-06-22 15:42:19 +05305618 psa_set_key_type(&attributes, PSA_KEY_TYPE_AES);
Kusumit Ghoderaod9ec1af2023-06-08 20:19:51 +05305619 } else {
5620 return PSA_ERROR_INVALID_ARGUMENT;
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05305621 }
5622
5623 switch (pbkdf2->state) {
5624 case PSA_PBKDF2_STATE_PASSWORD_SET:
5625 /* Initially we need a new block so bytes_used is equal to block size*/
5626 pbkdf2->bytes_used = prf_output_length;
5627 pbkdf2->state = PSA_PBKDF2_STATE_OUTPUT;
5628 break;
5629 case PSA_PBKDF2_STATE_OUTPUT:
5630 break;
5631 default:
5632 return PSA_ERROR_BAD_STATE;
5633 }
5634
5635 while (output_length != 0) {
5636 uint8_t n = prf_output_length - pbkdf2->bytes_used;
5637 if (n > output_length) {
5638 n = (uint8_t) output_length;
5639 }
5640 memcpy(output, pbkdf2->output_block + pbkdf2->bytes_used, n);
5641 output += n;
5642 output_length -= n;
5643 pbkdf2->bytes_used += n;
5644
5645 if (output_length == 0) {
5646 break;
5647 }
5648
5649 /* We need a new block */
5650 pbkdf2->bytes_used = 0;
5651 pbkdf2->block_number++;
5652
5653 status = psa_key_derivation_pbkdf2_generate_block(pbkdf2, prf_alg,
5654 prf_output_length,
5655 &attributes);
5656 if (status != PSA_SUCCESS) {
5657 return status;
5658 }
5659 }
5660
5661 return PSA_SUCCESS;
5662}
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305663#endif /* PSA_HAVE_SOFT_PBKDF2 */
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305664
Janos Follath6c6c8fc2019-06-17 12:38:20 +01005665psa_status_t psa_key_derivation_output_bytes(
5666 psa_key_derivation_operation_t *operation,
5667 uint8_t *output,
Gilles Peskine449bd832023-01-11 14:50:10 +01005668 size_t output_length)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005669{
5670 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01005671 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
Gilles Peskineeab56e42018-07-12 17:12:33 +02005672
Gilles Peskine449bd832023-01-11 14:50:10 +01005673 if (operation->alg == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005674 /* This is a blank operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005675 return PSA_ERROR_BAD_STATE;
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005676 }
5677
Gilles Peskine449bd832023-01-11 14:50:10 +01005678 if (output_length > operation->capacity) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005679 operation->capacity = 0;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005680 /* Go through the error path to wipe all confidential data now
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005681 * that the operation object is useless. */
David Saadab4ecc272019-02-14 13:48:10 +02005682 status = PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005683 goto exit;
5684 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005685 if (output_length == 0 && operation->capacity == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005686 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005687 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02005688 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
5689 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005690 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02005691 * output_length > 0. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005692 return PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005693 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005694 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005695
Przemek Stekiel69c46792022-06-10 12:59:51 +02005696#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01005697 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
5698 status = psa_key_derivation_hkdf_read(&operation->ctx.hkdf, kdf_alg,
5699 output, output_length);
5700 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02005701#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08005702#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5703 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005704 if (PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
5705 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
5706 status = psa_key_derivation_tls12_prf_read(&operation->ctx.tls12_prf,
5707 kdf_alg, output,
5708 output_length);
5709 } else
John Durkop07cc04a2020-11-16 22:08:34 -08005710#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
5711 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005712#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005713 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005714 status = psa_key_derivation_tls12_ecjpake_to_pms_read(
Gilles Peskine449bd832023-01-11 14:50:10 +01005715 &operation->ctx.tls12_ecjpake_to_pms, output, output_length);
5716 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005717#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305718#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05305719 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05305720 status = psa_key_derivation_pbkdf2_read(&operation->ctx.pbkdf2, kdf_alg,
5721 output, output_length);
Kusumit Ghoderao056f0c52023-05-03 15:58:34 +05305722 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305723#endif /* PSA_HAVE_SOFT_PBKDF2 */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005724
Gilles Peskineeab56e42018-07-12 17:12:33 +02005725 {
Steven Cooreman74afe472021-02-10 17:19:22 +01005726 (void) kdf_alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01005727 return PSA_ERROR_BAD_STATE;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005728 }
5729
5730exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005731 if (status != PSA_SUCCESS) {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005732 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005733 * This allows us to differentiate between exhausted operations and
5734 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
5735 * operations. */
5736 psa_algorithm_t alg = operation->alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01005737 psa_key_derivation_abort(operation);
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005738 operation->alg = alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01005739 memset(output, '!', output_length);
Gilles Peskineeab56e42018-07-12 17:12:33 +02005740 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005741 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005742}
5743
David Brown7807bf72021-02-09 16:28:23 -07005744#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01005745static void psa_des_set_key_parity(uint8_t *data, size_t data_size)
Gilles Peskine08542d82018-07-19 17:05:42 +02005746{
Gilles Peskine449bd832023-01-11 14:50:10 +01005747 if (data_size >= 8) {
5748 mbedtls_des_key_set_parity(data);
5749 }
5750 if (data_size >= 16) {
5751 mbedtls_des_key_set_parity(data + 8);
5752 }
5753 if (data_size >= 24) {
5754 mbedtls_des_key_set_parity(data + 16);
5755 }
Gilles Peskine08542d82018-07-19 17:05:42 +02005756}
David Brown7807bf72021-02-09 16:28:23 -07005757#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine08542d82018-07-19 17:05:42 +02005758
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005759/*
Gilles Peskine449bd832023-01-11 14:50:10 +01005760 * ECC keys on a Weierstrass elliptic curve require the generation
5761 * of a private key which is an integer
5762 * in the range [1, N - 1], where N is the boundary of the private key domain:
5763 * N is the prime p for Diffie-Hellman, or the order of the
5764 * curve’s base point for ECC.
5765 *
5766 * Let m be the bit size of N, such that 2^m > N >= 2^(m-1).
5767 * This function generates the private key using the following process:
5768 *
5769 * 1. Draw a byte string of length ceiling(m/8) bytes.
5770 * 2. If m is not a multiple of 8, set the most significant
5771 * (8 * ceiling(m/8) - m) bits of the first byte in the string to zero.
5772 * 3. Convert the string to integer k by decoding it as a big-endian byte string.
5773 * 4. If k > N - 2, discard the result and return to step 1.
5774 * 5. Output k + 1 as the private key.
5775 *
5776 * This method allows compliance to NIST standards, specifically the methods titled
5777 * Key-Pair Generation by Testing Candidates in the following publications:
5778 * - NIST Special Publication 800-56A: Recommendation for Pair-Wise Key-Establishment
5779 * Schemes Using Discrete Logarithm Cryptography [SP800-56A] §5.6.1.1.4 for
5780 * Diffie-Hellman keys.
5781 *
5782 * - [SP800-56A] §5.6.1.2.2 or FIPS Publication 186-4: Digital Signature
5783 * Standard (DSS) [FIPS186-4] §B.4.2 for elliptic curve keys.
5784 *
5785 * Note: Function allocates memory for *data buffer, so given *data should be
5786 * always NULL.
5787 */
Valerio Setti86587ab2023-06-27 13:09:30 +02005788#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE)
5789#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE)
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01005790static psa_status_t psa_generate_derived_ecc_key_weierstrass_helper(
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005791 psa_key_slot_t *slot,
5792 size_t bits,
5793 psa_key_derivation_operation_t *operation,
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005794 uint8_t **data
5795 )
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005796{
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005797 unsigned key_out_of_range = 1;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005798 mbedtls_mpi k;
5799 mbedtls_mpi diff_N_2;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005800 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Przemek Stekiela81aed22022-03-01 15:13:30 +01005801 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01005802 size_t m;
5803 size_t m_bytes;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005804
Gilles Peskine449bd832023-01-11 14:50:10 +01005805 mbedtls_mpi_init(&k);
5806 mbedtls_mpi_init(&diff_N_2);
Przemyslaw Stekiel1dfd1222021-11-18 13:35:00 +01005807
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005808 psa_ecc_family_t curve = PSA_KEY_TYPE_ECC_GET_FAMILY(
Gilles Peskine449bd832023-01-11 14:50:10 +01005809 slot->attr.type);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005810 mbedtls_ecp_group_id grp_id =
Valerio Settid36c3132023-12-21 14:03:51 +01005811 mbedtls_ecc_group_from_psa(curve, bits);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005812
Gilles Peskine449bd832023-01-11 14:50:10 +01005813 if (grp_id == MBEDTLS_ECP_DP_NONE) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005814 ret = MBEDTLS_ERR_ASN1_INVALID_DATA;
Przemyslaw Stekiel871a3362021-12-02 08:46:39 +01005815 goto cleanup;
5816 }
5817
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005818 mbedtls_ecp_group ecp_group;
Gilles Peskine449bd832023-01-11 14:50:10 +01005819 mbedtls_ecp_group_init(&ecp_group);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005820
Gilles Peskine449bd832023-01-11 14:50:10 +01005821 MBEDTLS_MPI_CHK(mbedtls_ecp_group_load(&ecp_group, grp_id));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005822
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005823 /* N is the boundary of the private key domain (ecp_group.N). */
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005824 /* Let m be the bit size of N. */
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01005825 m = ecp_group.nbits;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005826
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01005827 m_bytes = PSA_BITS_TO_BYTES(m);
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005828
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005829 /* Calculate N - 2 - it will be needed later. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005830 MBEDTLS_MPI_CHK(mbedtls_mpi_sub_int(&diff_N_2, &ecp_group.N, 2));
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005831
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005832 /* Note: This function is always called with *data == NULL and it
5833 * allocates memory for the data buffer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005834 *data = mbedtls_calloc(1, m_bytes);
5835 if (*data == NULL) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005836 ret = MBEDTLS_ERR_ASN1_ALLOC_FAILED;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005837 goto cleanup;
5838 }
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005839
Gilles Peskine449bd832023-01-11 14:50:10 +01005840 while (key_out_of_range) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005841 /* 1. Draw a byte string of length ceiling(m/8) bytes. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005842 if ((status = psa_key_derivation_output_bytes(operation, *data, m_bytes)) != 0) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005843 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005844 }
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005845
5846 /* 2. If m is not a multiple of 8 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005847 if (m % 8 != 0) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005848 /* Set the most significant
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005849 * (8 * ceiling(m/8) - m) bits of the first byte in
5850 * the string to zero.
5851 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005852 uint8_t clear_bit_mask = (1 << (m % 8)) - 1;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005853 (*data)[0] &= clear_bit_mask;
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005854 }
5855
5856 /* 3. Convert the string to integer k by decoding it as a
Gilles Peskine449bd832023-01-11 14:50:10 +01005857 * big-endian byte string.
5858 */
5859 MBEDTLS_MPI_CHK(mbedtls_mpi_read_binary(&k, *data, m_bytes));
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005860
5861 /* 4. If k > N - 2, discard the result and return to step 1.
Gilles Peskine449bd832023-01-11 14:50:10 +01005862 * Result of comparison is returned. When it indicates error
5863 * then this function is called again.
5864 */
5865 MBEDTLS_MPI_CHK(mbedtls_mpi_lt_mpi_ct(&diff_N_2, &k, &key_out_of_range));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005866 }
5867
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005868 /* 5. Output k + 1 as the private key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005869 MBEDTLS_MPI_CHK(mbedtls_mpi_add_int(&k, &k, 1));
5870 MBEDTLS_MPI_CHK(mbedtls_mpi_write_binary(&k, *data, m_bytes));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005871cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01005872 if (ret != 0) {
5873 status = mbedtls_to_psa_error(ret);
5874 }
5875 if (status != PSA_SUCCESS) {
5876 mbedtls_free(*data);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005877 *data = NULL;
5878 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005879 mbedtls_mpi_free(&k);
5880 mbedtls_mpi_free(&diff_N_2);
5881 return status;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005882}
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005883
5884/* ECC keys on a Montgomery elliptic curve draws a byte string whose length
5885 * is determined by the curve, and sets the mandatory bits accordingly. That is:
5886 *
5887 * - Curve25519 (PSA_ECC_FAMILY_MONTGOMERY, 255 bits):
5888 * draw a 32-byte string and process it as specified in
5889 * Elliptic Curves for Security [RFC7748] §5.
5890 *
5891 * - Curve448 (PSA_ECC_FAMILY_MONTGOMERY, 448 bits):
5892 * draw a 56-byte string and process it as specified in [RFC7748] §5.
5893 *
5894 * Note: Function allocates memory for *data buffer, so given *data should be
5895 * always NULL.
5896 */
5897
5898static psa_status_t psa_generate_derived_ecc_key_montgomery_helper(
5899 size_t bits,
5900 psa_key_derivation_operation_t *operation,
5901 uint8_t **data
5902 )
5903{
5904 size_t output_length;
Przemek Stekiela81aed22022-03-01 15:13:30 +01005905 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005906
Gilles Peskine449bd832023-01-11 14:50:10 +01005907 switch (bits) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005908 case 255:
5909 output_length = 32;
5910 break;
5911 case 448:
5912 output_length = 56;
5913 break;
5914 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005915 return PSA_ERROR_INVALID_ARGUMENT;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005916 break;
5917 }
5918
Gilles Peskine449bd832023-01-11 14:50:10 +01005919 *data = mbedtls_calloc(1, output_length);
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005920
Gilles Peskine449bd832023-01-11 14:50:10 +01005921 if (*data == NULL) {
5922 return PSA_ERROR_INSUFFICIENT_MEMORY;
5923 }
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005924
Gilles Peskine449bd832023-01-11 14:50:10 +01005925 status = psa_key_derivation_output_bytes(operation, *data, output_length);
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005926
Gilles Peskine449bd832023-01-11 14:50:10 +01005927 if (status != PSA_SUCCESS) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005928 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01005929 }
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005930
Gilles Peskine449bd832023-01-11 14:50:10 +01005931 switch (bits) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005932 case 255:
5933 (*data)[0] &= 248;
5934 (*data)[31] &= 127;
5935 (*data)[31] |= 64;
5936 break;
5937 case 448:
5938 (*data)[0] &= 252;
5939 (*data)[55] |= 128;
5940 break;
5941 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005942 return PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005943 break;
5944 }
5945
5946 return status;
5947}
Valerio Setti86587ab2023-06-27 13:09:30 +02005948#else /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE */
5949static psa_status_t psa_generate_derived_ecc_key_weierstrass_helper(
5950 psa_key_slot_t *slot, size_t bits,
5951 psa_key_derivation_operation_t *operation, uint8_t **data)
5952{
5953 (void) slot;
5954 (void) bits;
5955 (void) operation;
5956 (void) data;
5957 return PSA_ERROR_NOT_SUPPORTED;
5958}
5959
5960static psa_status_t psa_generate_derived_ecc_key_montgomery_helper(
5961 size_t bits, psa_key_derivation_operation_t *operation, uint8_t **data)
5962{
5963 (void) bits;
5964 (void) operation;
5965 (void) data;
5966 return PSA_ERROR_NOT_SUPPORTED;
5967}
5968#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE */
5969#endif /* PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE */
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005970
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01005971static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005972 psa_key_slot_t *slot,
5973 size_t bits,
Gilles Peskine449bd832023-01-11 14:50:10 +01005974 psa_key_derivation_operation_t *operation)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005975{
5976 uint8_t *data = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01005977 size_t bytes = PSA_BITS_TO_BYTES(bits);
Archanad8a83dc2021-06-14 10:04:16 +05305978 size_t storage_size = bytes;
Przemek Stekiela81aed22022-03-01 15:13:30 +01005979 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01005980 psa_key_attributes_t attributes;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005981
Gilles Peskine449bd832023-01-11 14:50:10 +01005982 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(slot->attr.type)) {
5983 return PSA_ERROR_INVALID_ARGUMENT;
5984 }
Gilles Peskineeab56e42018-07-12 17:12:33 +02005985
Valerio Setti8ffdb5d2023-06-20 13:14:08 +02005986#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE) || \
Valerio Settidd24f292023-06-26 12:21:17 +02005987 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE)
Gilles Peskine449bd832023-01-11 14:50:10 +01005988 if (PSA_KEY_TYPE_IS_ECC(slot->attr.type)) {
5989 psa_ecc_family_t curve = PSA_KEY_TYPE_ECC_GET_FAMILY(slot->attr.type);
5990 if (PSA_ECC_FAMILY_IS_WEIERSTRASS(curve)) {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01005991 /* Weierstrass elliptic curve */
Gilles Peskine449bd832023-01-11 14:50:10 +01005992 status = psa_generate_derived_ecc_key_weierstrass_helper(slot, bits, operation, &data);
5993 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005994 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005995 }
5996 } else {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01005997 /* Montgomery elliptic curve */
Gilles Peskine449bd832023-01-11 14:50:10 +01005998 status = psa_generate_derived_ecc_key_montgomery_helper(bits, operation, &data);
5999 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01006000 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006001 }
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01006002 }
Przemyslaw Stekiel1dfd1222021-11-18 13:35:00 +01006003 } else
Valerio Setti8ffdb5d2023-06-20 13:14:08 +02006004#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE) ||
Valerio Settidd24f292023-06-26 12:21:17 +02006005 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE) */
Gilles Peskine449bd832023-01-11 14:50:10 +01006006 if (key_type_is_raw_bytes(slot->attr.type)) {
6007 if (bits % 8 != 0) {
6008 return PSA_ERROR_INVALID_ARGUMENT;
6009 }
6010 data = mbedtls_calloc(1, bytes);
6011 if (data == NULL) {
6012 return PSA_ERROR_INSUFFICIENT_MEMORY;
6013 }
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01006014
Gilles Peskine449bd832023-01-11 14:50:10 +01006015 status = psa_key_derivation_output_bytes(operation, data, bytes);
6016 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01006017 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006018 }
David Brown12ca5032021-02-11 11:02:00 -07006019#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01006020 if (slot->attr.type == PSA_KEY_TYPE_DES) {
6021 psa_des_set_key_parity(data, bytes);
6022 }
Przemek Stekielf110dc02022-03-01 14:48:05 +01006023#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES) */
Gilles Peskine449bd832023-01-11 14:50:10 +01006024 } else {
6025 return PSA_ERROR_NOT_SUPPORTED;
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01006026 }
Ronald Crondd04d422020-11-28 15:14:42 +01006027
Ronald Cronbf33c932020-11-28 18:06:53 +01006028 slot->attr.bits = (psa_key_bits_t) bits;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01006029 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01006030 .core = slot->attr
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01006031 };
6032
Gilles Peskine449bd832023-01-11 14:50:10 +01006033 if (psa_key_lifetime_is_external(attributes.core.lifetime)) {
6034 status = psa_driver_wrapper_get_key_buffer_size(&attributes,
6035 &storage_size);
6036 if (status != PSA_SUCCESS) {
Archanad8a83dc2021-06-14 10:04:16 +05306037 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006038 }
Archanad8a83dc2021-06-14 10:04:16 +05306039 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006040 status = psa_allocate_buffer_to_slot(slot, storage_size);
6041 if (status != PSA_SUCCESS) {
Archanad8a83dc2021-06-14 10:04:16 +05306042 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006043 }
Archanad8a83dc2021-06-14 10:04:16 +05306044
Gilles Peskine449bd832023-01-11 14:50:10 +01006045 status = psa_driver_wrapper_import_key(&attributes,
6046 data, bytes,
6047 slot->key.data,
6048 slot->key.bytes,
6049 &slot->key.bytes, &bits);
6050 if (bits != slot->attr.bits) {
Ronald Cronbf33c932020-11-28 18:06:53 +01006051 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine449bd832023-01-11 14:50:10 +01006052 }
Gilles Peskineeab56e42018-07-12 17:12:33 +02006053
6054exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01006055 mbedtls_free(data);
6056 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02006057}
6058
Gilles Peskine449bd832023-01-11 14:50:10 +01006059psa_status_t psa_key_derivation_output_key(const psa_key_attributes_t *attributes,
6060 psa_key_derivation_operation_t *operation,
6061 mbedtls_svc_key_id_t *key)
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006062{
6063 psa_status_t status;
6064 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02006065 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine0f84d622019-09-12 19:03:13 +02006066
Ronald Cron81709fc2020-11-14 12:10:32 +01006067 *key = MBEDTLS_SVC_KEY_ID_INIT;
6068
Gilles Peskine0f84d622019-09-12 19:03:13 +02006069 /* Reject any attempt to create a zero-length key so that we don't
6070 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006071 if (psa_get_key_bits(attributes) == 0) {
6072 return PSA_ERROR_INVALID_ARGUMENT;
6073 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02006074
Gilles Peskine449bd832023-01-11 14:50:10 +01006075 if (operation->alg == PSA_ALG_NONE) {
6076 return PSA_ERROR_BAD_STATE;
6077 }
Dave Rodgmand69da6c2021-11-16 10:32:48 +00006078
Gilles Peskine449bd832023-01-11 14:50:10 +01006079 if (!operation->can_output_key) {
6080 return PSA_ERROR_NOT_PERMITTED;
6081 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02006082
Gilles Peskine449bd832023-01-11 14:50:10 +01006083 status = psa_start_key_creation(PSA_KEY_CREATION_DERIVE, attributes,
6084 &slot, &driver);
Gilles Peskinef4ee6622019-07-24 13:44:30 +02006085#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006086 if (driver != NULL) {
Gilles Peskinef4ee6622019-07-24 13:44:30 +02006087 /* Deriving a key in a secure element is not implemented yet. */
6088 status = PSA_ERROR_NOT_SUPPORTED;
6089 }
6090#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine449bd832023-01-11 14:50:10 +01006091 if (status == PSA_SUCCESS) {
6092 status = psa_generate_derived_key_internal(slot,
6093 attributes->core.bits,
6094 operation);
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006095 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006096 if (status == PSA_SUCCESS) {
6097 status = psa_finish_key_creation(slot, driver, key);
6098 }
6099 if (status != PSA_SUCCESS) {
6100 psa_fail_key_creation(slot, driver);
6101 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02006102
Gilles Peskine449bd832023-01-11 14:50:10 +01006103 return status;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006104}
6105
Gilles Peskineeab56e42018-07-12 17:12:33 +02006106
6107
6108/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02006109/* Key derivation */
6110/****************************************************************/
6111
Steven Cooreman932ffb72021-02-15 12:14:32 +01006112#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006113static int is_kdf_alg_supported(psa_algorithm_t kdf_alg)
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006114{
6115#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006116 if (PSA_ALG_IS_HKDF(kdf_alg)) {
6117 return 1;
6118 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006119#endif
Przemek Stekielb57a44b2022-06-06 08:33:45 +02006120#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006121 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6122 return 1;
6123 }
Przemek Stekielb57a44b2022-06-06 08:33:45 +02006124#endif
6125#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006126 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
6127 return 1;
6128 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006129#endif
6130#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006131 if (PSA_ALG_IS_TLS12_PRF(kdf_alg)) {
6132 return 1;
6133 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006134#endif
6135#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006136 if (PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
6137 return 1;
6138 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006139#endif
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006140#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006141 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
6142 return 1;
6143 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006144#endif
Kusumit Ghoderaod132cac2023-05-03 12:00:27 +05306145#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
6146 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
6147 return 1;
6148 }
6149#endif
Kusumit Ghoderao2cd64962023-06-22 15:38:57 +05306150#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128)
6151 if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
6152 return 1;
6153 }
6154#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006155 return 0;
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006156}
6157
Gilles Peskine449bd832023-01-11 14:50:10 +01006158static psa_status_t psa_hash_try_support(psa_algorithm_t alg)
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006159{
6160 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01006161 psa_status_t status = psa_hash_setup(&operation, alg);
6162 psa_hash_abort(&operation);
6163 return status;
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006164}
6165
Kusumit Ghoderao86e83dd2023-12-01 16:38:26 +05306166static psa_status_t psa_key_derivation_set_maximum_capacity(
6167 psa_key_derivation_operation_t *operation,
6168 psa_algorithm_t kdf_alg)
6169{
6170#if defined(PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS)
6171 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
6172 operation->capacity = PSA_HASH_LENGTH(PSA_ALG_SHA_256);
6173 return PSA_SUCCESS;
6174 }
6175#endif
6176#if defined(PSA_WANT_ALG_PBKDF2_AES_CMAC_PRF_128)
6177 if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
6178#if (SIZE_MAX > UINT32_MAX)
Kusumit Ghoderao7d4db632023-12-07 16:17:46 +05306179 operation->capacity = UINT32_MAX * (size_t) PSA_MAC_LENGTH(
Kusumit Ghoderaod3f70d32023-12-06 16:20:04 +05306180 PSA_KEY_TYPE_AES,
6181 128U,
6182 PSA_ALG_CMAC);
Kusumit Ghoderao86e83dd2023-12-01 16:38:26 +05306183#else
6184 operation->capacity = SIZE_MAX;
6185#endif
6186 return PSA_SUCCESS;
6187 }
6188#endif /* PSA_WANT_ALG_PBKDF2_AES_CMAC_PRF_128 */
6189
6190 /* After this point, if kdf_alg is not valid then value of hash_alg may be
6191 * invalid or meaningless but it does not affect this function */
6192 psa_algorithm_t hash_alg = PSA_ALG_GET_HASH(kdf_alg);
6193 size_t hash_size = PSA_HASH_LENGTH(hash_alg);
Kusumit Ghoderaod3f70d32023-12-06 16:20:04 +05306194 if (hash_size == 0) {
6195 return PSA_ERROR_NOT_SUPPORTED;
6196 }
Kusumit Ghoderao86e83dd2023-12-01 16:38:26 +05306197
6198 /* Make sure that hash_alg is a supported hash algorithm. Otherwise
6199 * we might fail later, which is somewhat unfriendly and potentially
6200 * risk-prone. */
6201 psa_status_t status = psa_hash_try_support(hash_alg);
6202 if (status != PSA_SUCCESS) {
6203 return status;
6204 }
6205
6206#if defined(PSA_WANT_ALG_HKDF)
6207 if (PSA_ALG_IS_HKDF(kdf_alg)) {
6208 operation->capacity = 255 * hash_size;
6209 } else
6210#endif
6211#if defined(PSA_WANT_ALG_HKDF_EXTRACT)
6212 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6213 operation->capacity = hash_size;
6214 } else
6215#endif
6216#if defined(PSA_WANT_ALG_HKDF_EXPAND)
6217 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
6218 operation->capacity = 255 * hash_size;
6219 } else
6220#endif
6221#if defined(PSA_WANT_ALG_TLS12_PRF)
6222 if (PSA_ALG_IS_TLS12_PRF(kdf_alg) &&
6223 (hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384)) {
6224 operation->capacity = SIZE_MAX;
6225 } else
6226#endif
6227#if defined(PSA_WANT_ALG_TLS12_PSK_TO_MS)
6228 if (PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg) &&
6229 (hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384)) {
6230 /* Master Secret is always 48 bytes
6231 * https://datatracker.ietf.org/doc/html/rfc5246.html#section-8.1 */
6232 operation->capacity = 48U;
6233 } else
6234#endif
6235#if defined(PSA_WANT_ALG_PBKDF2_HMAC)
6236 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
6237#if (SIZE_MAX > UINT32_MAX)
6238 operation->capacity = UINT32_MAX * hash_size;
6239#else
6240 operation->capacity = SIZE_MAX;
6241#endif
6242 } else
6243#endif /* PSA_WANT_ALG_PBKDF2_HMAC */
6244 {
Kusumit Ghoderaod3f70d32023-12-06 16:20:04 +05306245 (void) hash_size;
Kusumit Ghoderao86e83dd2023-12-01 16:38:26 +05306246 status = PSA_ERROR_NOT_SUPPORTED;
6247 }
6248 return status;
6249}
6250
Gilles Peskine969c5d62019-01-16 15:53:06 +01006251static psa_status_t psa_key_derivation_setup_kdf(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006252 psa_key_derivation_operation_t *operation,
Gilles Peskine449bd832023-01-11 14:50:10 +01006253 psa_algorithm_t kdf_alg)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006254{
Janos Follath5fe19732019-06-20 15:09:30 +01006255 /* Make sure that operation->ctx is properly zero-initialised. (Macro
6256 * initialisers for this union leave some bytes unspecified.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01006257 memset(&operation->ctx, 0, sizeof(operation->ctx));
Janos Follath5fe19732019-06-20 15:09:30 +01006258
Gilles Peskine969c5d62019-01-16 15:53:06 +01006259 /* Make sure that kdf_alg is a supported key derivation algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006260 if (!is_kdf_alg_supported(kdf_alg)) {
6261 return PSA_ERROR_NOT_SUPPORTED;
6262 }
John Durkop07cc04a2020-11-16 22:08:34 -08006263
Kusumit Ghoderao86e83dd2023-12-01 16:38:26 +05306264 psa_status_t status = psa_key_derivation_set_maximum_capacity(operation,
6265 kdf_alg);
Kusumit Ghoderao5f3a9382023-09-13 16:28:12 +05306266 return status;
Gilles Peskine969c5d62019-01-16 15:53:06 +01006267}
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006268
Gilles Peskine449bd832023-01-11 14:50:10 +01006269static psa_status_t psa_key_agreement_try_support(psa_algorithm_t alg)
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006270{
6271#if defined(PSA_WANT_ALG_ECDH)
Gilles Peskine449bd832023-01-11 14:50:10 +01006272 if (alg == PSA_ALG_ECDH) {
6273 return PSA_SUCCESS;
6274 }
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006275#endif
Przemek Stekielfb3dd542022-12-01 14:59:15 +01006276#if defined(PSA_WANT_ALG_FFDH)
6277 if (alg == PSA_ALG_FFDH) {
6278 return PSA_SUCCESS;
6279 }
6280#endif
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006281 (void) alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01006282 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006283}
Gilles Peskinebb3814c2022-12-16 01:12:12 +01006284
6285static int psa_key_derivation_allows_free_form_secret_input(
6286 psa_algorithm_t kdf_alg)
6287{
6288#if defined(PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS)
6289 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
6290 return 0;
6291 }
6292#endif
6293 (void) kdf_alg;
6294 return 1;
6295}
John Durkop07cc04a2020-11-16 22:08:34 -08006296#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01006297
Gilles Peskine449bd832023-01-11 14:50:10 +01006298psa_status_t psa_key_derivation_setup(psa_key_derivation_operation_t *operation,
6299 psa_algorithm_t alg)
Gilles Peskine969c5d62019-01-16 15:53:06 +01006300{
6301 psa_status_t status;
6302
Gilles Peskine449bd832023-01-11 14:50:10 +01006303 if (operation->alg != 0) {
6304 return PSA_ERROR_BAD_STATE;
Gilles Peskine969c5d62019-01-16 15:53:06 +01006305 }
Gilles Peskine969c5d62019-01-16 15:53:06 +01006306
Gilles Peskine449bd832023-01-11 14:50:10 +01006307 if (PSA_ALG_IS_RAW_KEY_AGREEMENT(alg)) {
6308 return PSA_ERROR_INVALID_ARGUMENT;
6309 } else if (PSA_ALG_IS_KEY_AGREEMENT(alg)) {
6310#if defined(AT_LEAST_ONE_BUILTIN_KDF)
6311 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF(alg);
6312 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE(alg);
6313 status = psa_key_agreement_try_support(ka_alg);
6314 if (status != PSA_SUCCESS) {
6315 return status;
6316 }
Gilles Peskinebb3814c2022-12-16 01:12:12 +01006317 if (!psa_key_derivation_allows_free_form_secret_input(kdf_alg)) {
6318 return PSA_ERROR_INVALID_ARGUMENT;
6319 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006320 status = psa_key_derivation_setup_kdf(operation, kdf_alg);
6321#else
6322 return PSA_ERROR_NOT_SUPPORTED;
6323#endif /* AT_LEAST_ONE_BUILTIN_KDF */
6324 } else if (PSA_ALG_IS_KEY_DERIVATION(alg)) {
6325#if defined(AT_LEAST_ONE_BUILTIN_KDF)
6326 status = psa_key_derivation_setup_kdf(operation, alg);
6327#else
6328 return PSA_ERROR_NOT_SUPPORTED;
6329#endif /* AT_LEAST_ONE_BUILTIN_KDF */
6330 } else {
6331 return PSA_ERROR_INVALID_ARGUMENT;
6332 }
6333
6334 if (status == PSA_SUCCESS) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006335 operation->alg = alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01006336 }
6337 return status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006338}
6339
Przemek Stekiel69c46792022-06-10 12:59:51 +02006340#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006341static psa_status_t psa_hkdf_input(psa_hkdf_key_derivation_t *hkdf,
6342 psa_algorithm_t kdf_alg,
6343 psa_key_derivation_step_t step,
6344 const uint8_t *data,
6345 size_t data_length)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006346{
Gilles Peskine449bd832023-01-11 14:50:10 +01006347 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006348 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006349 switch (step) {
Gilles Peskine03410b52019-05-16 16:05:19 +02006350 case PSA_KEY_DERIVATION_INPUT_SALT:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006351#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006352 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
6353 return PSA_ERROR_INVALID_ARGUMENT;
6354 }
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006355#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND */
Gilles Peskine449bd832023-01-11 14:50:10 +01006356 if (hkdf->state != HKDF_STATE_INIT) {
6357 return PSA_ERROR_BAD_STATE;
6358 } else {
6359 status = psa_key_derivation_start_hmac(&hkdf->hmac,
6360 hash_alg,
6361 data, data_length);
6362 if (status != PSA_SUCCESS) {
6363 return status;
6364 }
Steven Cooremand1ed1d92021-04-29 19:11:25 +02006365 hkdf->state = HKDF_STATE_STARTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01006366 return PSA_SUCCESS;
Steven Cooremand1ed1d92021-04-29 19:11:25 +02006367 }
Gilles Peskine03410b52019-05-16 16:05:19 +02006368 case PSA_KEY_DERIVATION_INPUT_SECRET:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006369#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006370 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
Przemek Stekiel2fb0dcd2022-05-19 10:34:37 +02006371 /* We shouldn't be in different state as HKDF_EXPAND only allows
6372 * two inputs: SECRET (this case) and INFO which does not modify
6373 * the state. It could happen only if the hkdf
6374 * object was corrupted. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006375 if (hkdf->state != HKDF_STATE_INIT) {
6376 return PSA_ERROR_BAD_STATE;
6377 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006378
Przemek Stekiel2fb0dcd2022-05-19 10:34:37 +02006379 /* Allow only input that fits expected prk size */
Gilles Peskine449bd832023-01-11 14:50:10 +01006380 if (data_length != PSA_HASH_LENGTH(hash_alg)) {
6381 return PSA_ERROR_INVALID_ARGUMENT;
6382 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006383
Gilles Peskine449bd832023-01-11 14:50:10 +01006384 memcpy(hkdf->prk, data, data_length);
6385 } else
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006386#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND */
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006387 {
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006388 /* HKDF: If no salt was provided, use an empty salt.
6389 * HKDF-EXTRACT: salt is mandatory. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006390 if (hkdf->state == HKDF_STATE_INIT) {
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006391#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006392 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6393 return PSA_ERROR_BAD_STATE;
6394 }
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006395#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01006396 status = psa_key_derivation_start_hmac(&hkdf->hmac,
6397 hash_alg,
6398 NULL, 0);
6399 if (status != PSA_SUCCESS) {
6400 return status;
6401 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006402 hkdf->state = HKDF_STATE_STARTED;
6403 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006404 if (hkdf->state != HKDF_STATE_STARTED) {
6405 return PSA_ERROR_BAD_STATE;
6406 }
6407 status = psa_mac_update(&hkdf->hmac,
6408 data, data_length);
6409 if (status != PSA_SUCCESS) {
6410 return status;
6411 }
6412 status = psa_mac_sign_finish(&hkdf->hmac,
6413 hkdf->prk,
6414 sizeof(hkdf->prk),
6415 &data_length);
6416 if (status != PSA_SUCCESS) {
6417 return status;
6418 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006419 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006420
Gilles Peskine2b522db2019-04-12 15:11:49 +02006421 hkdf->state = HKDF_STATE_KEYED;
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006422 hkdf->block_number = 0;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006423#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006424 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006425 /* The only block of output is the PRK. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006426 memcpy(hkdf->output_block, hkdf->prk, PSA_HASH_LENGTH(hash_alg));
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006427 hkdf->offset_in_block = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01006428 } else
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006429#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006430 {
6431 /* Block 0 is empty, and the next block will be
6432 * generated by psa_key_derivation_hkdf_read(). */
Gilles Peskine449bd832023-01-11 14:50:10 +01006433 hkdf->offset_in_block = PSA_HASH_LENGTH(hash_alg);
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006434 }
6435
Gilles Peskine449bd832023-01-11 14:50:10 +01006436 return PSA_SUCCESS;
Gilles Peskine03410b52019-05-16 16:05:19 +02006437 case PSA_KEY_DERIVATION_INPUT_INFO:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006438#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006439 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6440 return PSA_ERROR_INVALID_ARGUMENT;
6441 }
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006442#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Przemek Stekielcde3f782022-06-03 16:12:27 +02006443#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006444 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg) &&
6445 hkdf->state == HKDF_STATE_INIT) {
6446 return PSA_ERROR_BAD_STATE;
6447 }
Przemek Stekielcde3f782022-06-03 16:12:27 +02006448#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01006449 if (hkdf->state == HKDF_STATE_OUTPUT) {
6450 return PSA_ERROR_BAD_STATE;
6451 }
6452 if (hkdf->info_set) {
6453 return PSA_ERROR_BAD_STATE;
6454 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006455 hkdf->info_length = data_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01006456 if (data_length != 0) {
6457 hkdf->info = mbedtls_calloc(1, data_length);
6458 if (hkdf->info == NULL) {
6459 return PSA_ERROR_INSUFFICIENT_MEMORY;
6460 }
6461 memcpy(hkdf->info, data, data_length);
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006462 }
6463 hkdf->info_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01006464 return PSA_SUCCESS;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006465 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006466 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006467 }
6468}
Przemek Stekiel69c46792022-06-10 12:59:51 +02006469#endif /* BUILTIN_ALG_ANY_HKDF */
Janos Follathb03233e2019-06-11 15:30:30 +01006470
John Durkop07cc04a2020-11-16 22:08:34 -08006471#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
6472 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006473static psa_status_t psa_tls12_prf_set_seed(psa_tls12_prf_key_derivation_t *prf,
6474 const uint8_t *data,
6475 size_t data_length)
Janos Follathf08e2652019-06-13 09:05:41 +01006476{
Gilles Peskine449bd832023-01-11 14:50:10 +01006477 if (prf->state != PSA_TLS12_PRF_STATE_INIT) {
6478 return PSA_ERROR_BAD_STATE;
6479 }
Janos Follathf08e2652019-06-13 09:05:41 +01006480
Gilles Peskine449bd832023-01-11 14:50:10 +01006481 if (data_length != 0) {
6482 prf->seed = mbedtls_calloc(1, data_length);
6483 if (prf->seed == NULL) {
6484 return PSA_ERROR_INSUFFICIENT_MEMORY;
6485 }
Janos Follathf08e2652019-06-13 09:05:41 +01006486
Gilles Peskine449bd832023-01-11 14:50:10 +01006487 memcpy(prf->seed, data, data_length);
Janos Follathd6dce9f2019-07-04 09:11:38 +01006488 prf->seed_length = data_length;
6489 }
Janos Follathf08e2652019-06-13 09:05:41 +01006490
Gilles Peskine43f958b2020-12-13 14:55:14 +01006491 prf->state = PSA_TLS12_PRF_STATE_SEED_SET;
Janos Follathf08e2652019-06-13 09:05:41 +01006492
Gilles Peskine449bd832023-01-11 14:50:10 +01006493 return PSA_SUCCESS;
Janos Follathf08e2652019-06-13 09:05:41 +01006494}
6495
Gilles Peskine449bd832023-01-11 14:50:10 +01006496static psa_status_t psa_tls12_prf_set_key(psa_tls12_prf_key_derivation_t *prf,
6497 const uint8_t *data,
6498 size_t data_length)
Janos Follath81550542019-06-13 14:26:34 +01006499{
Gilles Peskine449bd832023-01-11 14:50:10 +01006500 if (prf->state != PSA_TLS12_PRF_STATE_SEED_SET &&
6501 prf->state != PSA_TLS12_PRF_STATE_OTHER_KEY_SET) {
6502 return PSA_ERROR_BAD_STATE;
6503 }
Janos Follath81550542019-06-13 14:26:34 +01006504
Gilles Peskine449bd832023-01-11 14:50:10 +01006505 if (data_length != 0) {
6506 prf->secret = mbedtls_calloc(1, data_length);
6507 if (prf->secret == NULL) {
6508 return PSA_ERROR_INSUFFICIENT_MEMORY;
6509 }
Steven Cooremana6df6042021-04-29 19:32:25 +02006510
Gilles Peskine449bd832023-01-11 14:50:10 +01006511 memcpy(prf->secret, data, data_length);
Steven Cooremana6df6042021-04-29 19:32:25 +02006512 prf->secret_length = data_length;
6513 }
Janos Follath81550542019-06-13 14:26:34 +01006514
Gilles Peskine43f958b2020-12-13 14:55:14 +01006515 prf->state = PSA_TLS12_PRF_STATE_KEY_SET;
Janos Follath81550542019-06-13 14:26:34 +01006516
Gilles Peskine449bd832023-01-11 14:50:10 +01006517 return PSA_SUCCESS;
Janos Follath81550542019-06-13 14:26:34 +01006518}
6519
Gilles Peskine449bd832023-01-11 14:50:10 +01006520static psa_status_t psa_tls12_prf_set_label(psa_tls12_prf_key_derivation_t *prf,
6521 const uint8_t *data,
6522 size_t data_length)
Janos Follath63028dd2019-06-13 09:15:47 +01006523{
Gilles Peskine449bd832023-01-11 14:50:10 +01006524 if (prf->state != PSA_TLS12_PRF_STATE_KEY_SET) {
6525 return PSA_ERROR_BAD_STATE;
6526 }
Janos Follath63028dd2019-06-13 09:15:47 +01006527
Gilles Peskine449bd832023-01-11 14:50:10 +01006528 if (data_length != 0) {
6529 prf->label = mbedtls_calloc(1, data_length);
6530 if (prf->label == NULL) {
6531 return PSA_ERROR_INSUFFICIENT_MEMORY;
6532 }
Janos Follath63028dd2019-06-13 09:15:47 +01006533
Gilles Peskine449bd832023-01-11 14:50:10 +01006534 memcpy(prf->label, data, data_length);
Janos Follathd6dce9f2019-07-04 09:11:38 +01006535 prf->label_length = data_length;
6536 }
Janos Follath63028dd2019-06-13 09:15:47 +01006537
Gilles Peskine43f958b2020-12-13 14:55:14 +01006538 prf->state = PSA_TLS12_PRF_STATE_LABEL_SET;
Janos Follath63028dd2019-06-13 09:15:47 +01006539
Gilles Peskine449bd832023-01-11 14:50:10 +01006540 return PSA_SUCCESS;
Janos Follath63028dd2019-06-13 09:15:47 +01006541}
6542
Gilles Peskine449bd832023-01-11 14:50:10 +01006543static psa_status_t psa_tls12_prf_input(psa_tls12_prf_key_derivation_t *prf,
6544 psa_key_derivation_step_t step,
6545 const uint8_t *data,
6546 size_t data_length)
Janos Follathb03233e2019-06-11 15:30:30 +01006547{
Gilles Peskine449bd832023-01-11 14:50:10 +01006548 switch (step) {
Janos Follathf08e2652019-06-13 09:05:41 +01006549 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskine449bd832023-01-11 14:50:10 +01006550 return psa_tls12_prf_set_seed(prf, data, data_length);
Janos Follath81550542019-06-13 14:26:34 +01006551 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006552 return psa_tls12_prf_set_key(prf, data, data_length);
Janos Follath63028dd2019-06-13 09:15:47 +01006553 case PSA_KEY_DERIVATION_INPUT_LABEL:
Gilles Peskine449bd832023-01-11 14:50:10 +01006554 return psa_tls12_prf_set_label(prf, data, data_length);
Janos Follathb03233e2019-06-11 15:30:30 +01006555 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006556 return PSA_ERROR_INVALID_ARGUMENT;
Janos Follathb03233e2019-06-11 15:30:30 +01006557 }
6558}
John Durkop07cc04a2020-11-16 22:08:34 -08006559#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
6560 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
6561
6562#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
6563static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
6564 psa_tls12_prf_key_derivation_t *prf,
John Durkop07cc04a2020-11-16 22:08:34 -08006565 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006566 size_t data_length)
John Durkop07cc04a2020-11-16 22:08:34 -08006567{
6568 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006569 const size_t pms_len = (prf->state == PSA_TLS12_PRF_STATE_OTHER_KEY_SET ?
6570 4 + data_length + prf->other_secret_length :
6571 4 + 2 * data_length);
John Durkop07cc04a2020-11-16 22:08:34 -08006572
Gilles Peskine449bd832023-01-11 14:50:10 +01006573 if (data_length > PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE) {
6574 return PSA_ERROR_INVALID_ARGUMENT;
6575 }
John Durkop07cc04a2020-11-16 22:08:34 -08006576
Gilles Peskine449bd832023-01-11 14:50:10 +01006577 uint8_t *pms = mbedtls_calloc(1, pms_len);
6578 if (pms == NULL) {
6579 return PSA_ERROR_INSUFFICIENT_MEMORY;
6580 }
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02006581 uint8_t *cur = pms;
6582
6583 /* pure-PSK:
6584 * Quoting RFC 4279, Section 2:
John Durkop07cc04a2020-11-16 22:08:34 -08006585 *
6586 * The premaster secret is formed as follows: if the PSK is N octets
6587 * long, concatenate a uint16 with the value N, N zero octets, a second
6588 * uint16 with the value N, and the PSK itself.
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02006589 *
6590 * mixed-PSK:
6591 * In a DHE-PSK, RSA-PSK, ECDHE-PSK the premaster secret is formed as
6592 * follows: concatenate a uint16 with the length of the other secret,
6593 * the other secret itself, uint16 with the length of PSK, and the
6594 * PSK itself.
6595 * For details please check:
6596 * - RFC 4279, Section 4 for the definition of RSA-PSK,
6597 * - RFC 4279, Section 3 for the definition of DHE-PSK,
6598 * - RFC 5489 for the definition of ECDHE-PSK.
John Durkop07cc04a2020-11-16 22:08:34 -08006599 */
6600
Gilles Peskine449bd832023-01-11 14:50:10 +01006601 if (prf->state == PSA_TLS12_PRF_STATE_OTHER_KEY_SET) {
6602 *cur++ = MBEDTLS_BYTE_1(prf->other_secret_length);
6603 *cur++ = MBEDTLS_BYTE_0(prf->other_secret_length);
6604 if (prf->other_secret_length != 0) {
6605 memcpy(cur, prf->other_secret, prf->other_secret_length);
6606 mbedtls_platform_zeroize(prf->other_secret, prf->other_secret_length);
Przemek Stekiel2503f7e2022-04-12 12:08:01 +02006607 cur += prf->other_secret_length;
6608 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006609 } else {
6610 *cur++ = MBEDTLS_BYTE_1(data_length);
6611 *cur++ = MBEDTLS_BYTE_0(data_length);
6612 memset(cur, 0, data_length);
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02006613 cur += data_length;
6614 }
6615
Gilles Peskine449bd832023-01-11 14:50:10 +01006616 *cur++ = MBEDTLS_BYTE_1(data_length);
6617 *cur++ = MBEDTLS_BYTE_0(data_length);
6618 memcpy(cur, data, data_length);
John Durkop07cc04a2020-11-16 22:08:34 -08006619 cur += data_length;
6620
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00006621 status = psa_tls12_prf_set_key(prf, pms, (size_t) (cur - pms));
John Durkop07cc04a2020-11-16 22:08:34 -08006622
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01006623 mbedtls_zeroize_and_free(pms, pms_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01006624 return status;
John Durkop07cc04a2020-11-16 22:08:34 -08006625}
Janos Follath6660f0e2019-06-17 08:44:03 +01006626
Przemek Stekiele47201b2022-04-19 13:53:28 +02006627static psa_status_t psa_tls12_prf_psk_to_ms_set_other_key(
6628 psa_tls12_prf_key_derivation_t *prf,
6629 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006630 size_t data_length)
Przemek Stekiele47201b2022-04-19 13:53:28 +02006631{
Gilles Peskine449bd832023-01-11 14:50:10 +01006632 if (prf->state != PSA_TLS12_PRF_STATE_SEED_SET) {
6633 return PSA_ERROR_BAD_STATE;
Przemek Stekiele47201b2022-04-19 13:53:28 +02006634 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006635
6636 if (data_length != 0) {
6637 prf->other_secret = mbedtls_calloc(1, data_length);
6638 if (prf->other_secret == NULL) {
6639 return PSA_ERROR_INSUFFICIENT_MEMORY;
6640 }
6641
6642 memcpy(prf->other_secret, data, data_length);
6643 prf->other_secret_length = data_length;
6644 } else {
Przemek Stekiele47201b2022-04-19 13:53:28 +02006645 prf->other_secret_length = 0;
6646 }
6647
6648 prf->state = PSA_TLS12_PRF_STATE_OTHER_KEY_SET;
6649
Gilles Peskine449bd832023-01-11 14:50:10 +01006650 return PSA_SUCCESS;
Przemek Stekiele47201b2022-04-19 13:53:28 +02006651}
6652
Janos Follath6660f0e2019-06-17 08:44:03 +01006653static psa_status_t psa_tls12_prf_psk_to_ms_input(
6654 psa_tls12_prf_key_derivation_t *prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01006655 psa_key_derivation_step_t step,
6656 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006657 size_t data_length)
Janos Follath6660f0e2019-06-17 08:44:03 +01006658{
Gilles Peskine449bd832023-01-11 14:50:10 +01006659 switch (step) {
Przemek Stekiele47201b2022-04-19 13:53:28 +02006660 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006661 return psa_tls12_prf_psk_to_ms_set_key(prf,
6662 data, data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02006663 break;
6664 case PSA_KEY_DERIVATION_INPUT_OTHER_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006665 return psa_tls12_prf_psk_to_ms_set_other_key(prf,
6666 data,
6667 data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02006668 break;
6669 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006670 return psa_tls12_prf_input(prf, step, data, data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02006671 break;
Janos Follath6660f0e2019-06-17 08:44:03 +01006672
Przemek Stekiele47201b2022-04-19 13:53:28 +02006673 }
Janos Follath6660f0e2019-06-17 08:44:03 +01006674}
John Durkop07cc04a2020-11-16 22:08:34 -08006675#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006676
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006677#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
6678static psa_status_t psa_tls12_ecjpake_to_pms_input(
6679 psa_tls12_ecjpake_to_pms_t *ecjpake,
Andrzej Kurek702776f2022-09-16 06:22:44 -04006680 psa_key_derivation_step_t step,
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006681 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006682 size_t data_length)
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006683{
Gilles Peskine449bd832023-01-11 14:50:10 +01006684 if (data_length != PSA_TLS12_ECJPAKE_TO_PMS_INPUT_SIZE ||
6685 step != PSA_KEY_DERIVATION_INPUT_SECRET) {
6686 return PSA_ERROR_INVALID_ARGUMENT;
Andrzej Kurek5603efd2022-09-26 10:49:16 -04006687 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006688
6689 /* Check if the passed point is in an uncompressed form */
Gilles Peskine449bd832023-01-11 14:50:10 +01006690 if (data[0] != 0x04) {
6691 return PSA_ERROR_INVALID_ARGUMENT;
6692 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006693
6694 /* Only K.X has to be extracted - bytes 1 to 32 inclusive. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006695 memcpy(ecjpake->data, data + 1, PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE);
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006696
Gilles Peskine449bd832023-01-11 14:50:10 +01006697 return PSA_SUCCESS;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006698}
6699#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306700
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306701#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306702static psa_status_t psa_pbkdf2_set_input_cost(
6703 psa_pbkdf2_key_derivation_t *pbkdf2,
6704 psa_key_derivation_step_t step,
6705 uint64_t data)
6706{
6707 if (step != PSA_KEY_DERIVATION_INPUT_COST) {
6708 return PSA_ERROR_INVALID_ARGUMENT;
6709 }
6710
6711 if (pbkdf2->state != PSA_PBKDF2_STATE_INIT) {
6712 return PSA_ERROR_BAD_STATE;
6713 }
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05306714
Kusumit Ghoderaoe66a8ad2023-05-24 12:30:43 +05306715 if (data > PSA_VENDOR_PBKDF2_MAX_ITERATIONS) {
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05306716 return PSA_ERROR_NOT_SUPPORTED;
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306717 }
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05306718
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306719 if (data == 0) {
6720 return PSA_ERROR_INVALID_ARGUMENT;
6721 }
Kusumit Ghoderaoe66a8ad2023-05-24 12:30:43 +05306722
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306723 pbkdf2->input_cost = data;
6724 pbkdf2->state = PSA_PBKDF2_STATE_INPUT_COST_SET;
6725
6726 return PSA_SUCCESS;
6727}
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306728
6729static psa_status_t psa_pbkdf2_set_salt(psa_pbkdf2_key_derivation_t *pbkdf2,
6730 const uint8_t *data,
6731 size_t data_length)
6732{
Gilles Peskineead17662023-08-20 22:02:51 +02006733 if (pbkdf2->state == PSA_PBKDF2_STATE_INPUT_COST_SET) {
6734 pbkdf2->state = PSA_PBKDF2_STATE_SALT_SET;
6735 } else if (pbkdf2->state == PSA_PBKDF2_STATE_SALT_SET) {
6736 /* Appending to existing salt. No state change. */
6737 } else {
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306738 return PSA_ERROR_BAD_STATE;
6739 }
6740
Gilles Peskineca57d782023-07-20 19:08:06 +02006741 if (data_length == 0) {
Gilles Peskineead17662023-08-20 22:02:51 +02006742 /* Appending an empty string, nothing to do. */
6743 } else {
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306744 uint8_t *next_salt;
Kusumit Ghoderaob538bb72023-05-24 12:32:14 +05306745
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306746 next_salt = mbedtls_calloc(1, data_length + pbkdf2->salt_length);
6747 if (next_salt == NULL) {
Kusumit Ghoderaod0422f32023-05-08 15:56:19 +05306748 return PSA_ERROR_INSUFFICIENT_MEMORY;
6749 }
6750
Gilles Peskineead17662023-08-20 22:02:51 +02006751 if (pbkdf2->salt_length != 0) {
6752 memcpy(next_salt, pbkdf2->salt, pbkdf2->salt_length);
6753 }
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306754 memcpy(next_salt + pbkdf2->salt_length, data, data_length);
Kusumit Ghoderaod0422f32023-05-08 15:56:19 +05306755 pbkdf2->salt_length += data_length;
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306756 mbedtls_free(pbkdf2->salt);
6757 pbkdf2->salt = next_salt;
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306758 }
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306759 return PSA_SUCCESS;
6760}
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306761
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05306762#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306763static psa_status_t psa_pbkdf2_hmac_set_password(psa_algorithm_t hash_alg,
Kusumit Ghoderaoaac9a582023-05-24 14:19:17 +05306764 const uint8_t *input,
6765 size_t input_len,
6766 uint8_t *output,
Kusumit Ghoderao91f99f52023-05-24 22:21:48 +05306767 size_t *output_len)
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306768{
6769 psa_status_t status = PSA_SUCCESS;
6770 if (input_len > PSA_HASH_BLOCK_LENGTH(hash_alg)) {
6771 status = psa_hash_compute(hash_alg, input, input_len, output,
Kusumit Ghoderao91f99f52023-05-24 22:21:48 +05306772 PSA_HMAC_MAX_HASH_BLOCK_SIZE, output_len);
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306773 } else {
6774 memcpy(output, input, input_len);
Kusumit Ghoderao91f99f52023-05-24 22:21:48 +05306775 *output_len = PSA_HASH_BLOCK_LENGTH(hash_alg);
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306776 }
6777 return status;
6778}
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05306779#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC */
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306780
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05306781#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128)
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306782static psa_status_t psa_pbkdf2_cmac_set_password(const uint8_t *input,
6783 size_t input_len,
6784 uint8_t *output,
6785 size_t *output_len)
6786{
6787 psa_status_t status = PSA_SUCCESS;
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306788 if (input_len != PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC)) {
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306789 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Kusumit Ghoderao3fde8fe2023-06-27 10:41:43 +05306790 uint8_t zeros[16] = { 0 };
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306791 psa_set_key_type(&attributes, PSA_KEY_TYPE_AES);
6792 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(sizeof(zeros)));
6793 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306794 /* Passing PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC) as
Kusumit Ghoderao5f3345a2023-07-27 21:21:38 +05306795 * mac_size as the driver function sets mac_output_length = mac_size
6796 * on success. See https://github.com/Mbed-TLS/mbedtls/issues/7801 */
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306797 status = psa_driver_wrapper_mac_compute(&attributes,
6798 zeros, sizeof(zeros),
6799 PSA_ALG_CMAC, input, input_len,
6800 output,
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306801 PSA_MAC_LENGTH(PSA_KEY_TYPE_AES,
6802 128U,
6803 PSA_ALG_CMAC),
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306804 output_len);
6805 } else {
6806 memcpy(output, input, input_len);
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306807 *output_len = PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC);
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306808 }
6809 return status;
6810}
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05306811#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128 */
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306812
6813static psa_status_t psa_pbkdf2_set_password(psa_pbkdf2_key_derivation_t *pbkdf2,
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306814 psa_algorithm_t kdf_alg,
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306815 const uint8_t *data,
6816 size_t data_length)
6817{
Kusumit Ghoderaoaac9a582023-05-24 14:19:17 +05306818 psa_status_t status = PSA_SUCCESS;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306819 if (pbkdf2->state != PSA_PBKDF2_STATE_SALT_SET) {
6820 return PSA_ERROR_BAD_STATE;
6821 }
6822
Kusumit Ghoderaof3e696d2023-07-28 13:30:50 +05306823#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306824 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
6825 psa_algorithm_t hash_alg = PSA_ALG_PBKDF2_HMAC_GET_HASH(kdf_alg);
6826 status = psa_pbkdf2_hmac_set_password(hash_alg, data, data_length,
6827 pbkdf2->password,
6828 &pbkdf2->password_length);
Kusumit Ghoderaof3e696d2023-07-28 13:30:50 +05306829 } else
6830#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC */
6831#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128)
6832 if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306833 status = psa_pbkdf2_cmac_set_password(data, data_length,
6834 pbkdf2->password,
6835 &pbkdf2->password_length);
Kusumit Ghoderaof3e696d2023-07-28 13:30:50 +05306836 } else
6837#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128 */
6838 {
6839 return PSA_ERROR_INVALID_ARGUMENT;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306840 }
6841
6842 pbkdf2->state = PSA_PBKDF2_STATE_PASSWORD_SET;
6843
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306844 return status;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306845}
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05306846
6847static psa_status_t psa_pbkdf2_input(psa_pbkdf2_key_derivation_t *pbkdf2,
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306848 psa_algorithm_t kdf_alg,
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05306849 psa_key_derivation_step_t step,
6850 const uint8_t *data,
6851 size_t data_length)
6852{
6853 switch (step) {
6854 case PSA_KEY_DERIVATION_INPUT_SALT:
6855 return psa_pbkdf2_set_salt(pbkdf2, data, data_length);
6856 case PSA_KEY_DERIVATION_INPUT_PASSWORD:
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306857 return psa_pbkdf2_set_password(pbkdf2, kdf_alg, data, data_length);
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05306858 default:
6859 return PSA_ERROR_INVALID_ARGUMENT;
6860 }
6861}
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306862#endif /* PSA_HAVE_SOFT_PBKDF2 */
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306863
Gilles Peskineb8965192019-09-24 16:21:10 +02006864/** Check whether the given key type is acceptable for the given
6865 * input step of a key derivation.
6866 *
6867 * Secret inputs must have the type #PSA_KEY_TYPE_DERIVE.
6868 * Non-secret inputs must have the type #PSA_KEY_TYPE_RAW_DATA.
6869 * Both secret and non-secret inputs can alternatively have the type
6870 * #PSA_KEY_TYPE_NONE, which is never the type of a key object, meaning
6871 * that the input was passed as a buffer rather than via a key object.
6872 */
Gilles Peskine224b0d62019-09-23 18:13:17 +02006873static int psa_key_derivation_check_input_type(
6874 psa_key_derivation_step_t step,
Gilles Peskine449bd832023-01-11 14:50:10 +01006875 psa_key_type_t key_type)
Gilles Peskine224b0d62019-09-23 18:13:17 +02006876{
Gilles Peskine449bd832023-01-11 14:50:10 +01006877 switch (step) {
Gilles Peskine224b0d62019-09-23 18:13:17 +02006878 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006879 if (key_type == PSA_KEY_TYPE_DERIVE) {
6880 return PSA_SUCCESS;
6881 }
6882 if (key_type == PSA_KEY_TYPE_NONE) {
6883 return PSA_SUCCESS;
6884 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02006885 break;
Przemek Stekiela7695a22022-04-07 15:39:01 +02006886 case PSA_KEY_DERIVATION_INPUT_OTHER_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006887 if (key_type == PSA_KEY_TYPE_DERIVE) {
6888 return PSA_SUCCESS;
6889 }
6890 if (key_type == PSA_KEY_TYPE_NONE) {
6891 return PSA_SUCCESS;
6892 }
Przemek Stekiela7695a22022-04-07 15:39:01 +02006893 break;
Gilles Peskine224b0d62019-09-23 18:13:17 +02006894 case PSA_KEY_DERIVATION_INPUT_LABEL:
6895 case PSA_KEY_DERIVATION_INPUT_SALT:
6896 case PSA_KEY_DERIVATION_INPUT_INFO:
6897 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskine449bd832023-01-11 14:50:10 +01006898 if (key_type == PSA_KEY_TYPE_RAW_DATA) {
6899 return PSA_SUCCESS;
6900 }
6901 if (key_type == PSA_KEY_TYPE_NONE) {
6902 return PSA_SUCCESS;
6903 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02006904 break;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306905 case PSA_KEY_DERIVATION_INPUT_PASSWORD:
6906 if (key_type == PSA_KEY_TYPE_PASSWORD) {
6907 return PSA_SUCCESS;
6908 }
6909 if (key_type == PSA_KEY_TYPE_DERIVE) {
6910 return PSA_SUCCESS;
6911 }
6912 if (key_type == PSA_KEY_TYPE_NONE) {
6913 return PSA_SUCCESS;
6914 }
6915 break;
Gilles Peskine224b0d62019-09-23 18:13:17 +02006916 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006917 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine224b0d62019-09-23 18:13:17 +02006918}
6919
Janos Follathb80a94e2019-06-12 15:54:46 +01006920static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006921 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01006922 psa_key_derivation_step_t step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02006923 psa_key_type_t key_type,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01006924 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006925 size_t data_length)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006926{
Gilles Peskine46d7faf2019-09-23 19:22:55 +02006927 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006928 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
Gilles Peskine46d7faf2019-09-23 19:22:55 +02006929
Gilles Peskine449bd832023-01-11 14:50:10 +01006930 status = psa_key_derivation_check_input_type(step, key_type);
6931 if (status != PSA_SUCCESS) {
Gilles Peskine224b0d62019-09-23 18:13:17 +02006932 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006933 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02006934
Przemek Stekiel69c46792022-06-10 12:59:51 +02006935#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006936 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
6937 status = psa_hkdf_input(&operation->ctx.hkdf, kdf_alg,
6938 step, data, data_length);
6939 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02006940#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08006941#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006942 if (PSA_ALG_IS_TLS12_PRF(kdf_alg)) {
6943 status = psa_tls12_prf_input(&operation->ctx.tls12_prf,
6944 step, data, data_length);
6945 } else
John Durkop07cc04a2020-11-16 22:08:34 -08006946#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF */
6947#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006948 if (PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
6949 status = psa_tls12_prf_psk_to_ms_input(&operation->ctx.tls12_prf,
6950 step, data, data_length);
6951 } else
John Durkop07cc04a2020-11-16 22:08:34 -08006952#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006953#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006954 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006955 status = psa_tls12_ecjpake_to_pms_input(
Gilles Peskine449bd832023-01-11 14:50:10 +01006956 &operation->ctx.tls12_ecjpake_to_pms, step, data, data_length);
6957 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006958#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306959#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05306960 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306961 status = psa_pbkdf2_input(&operation->ctx.pbkdf2, kdf_alg,
6962 step, data, data_length);
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05306963 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306964#endif /* PSA_HAVE_SOFT_PBKDF2 */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006965 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006966 /* This can't happen unless the operation object was not initialized */
Steven Cooreman74afe472021-02-10 17:19:22 +01006967 (void) data;
6968 (void) data_length;
6969 (void) kdf_alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01006970 return PSA_ERROR_BAD_STATE;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006971 }
6972
Gilles Peskine224b0d62019-09-23 18:13:17 +02006973exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01006974 if (status != PSA_SUCCESS) {
6975 psa_key_derivation_abort(operation);
6976 }
6977 return status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006978}
6979
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05306980static psa_status_t psa_key_derivation_input_integer_internal(
6981 psa_key_derivation_operation_t *operation,
6982 psa_key_derivation_step_t step,
6983 uint64_t value)
6984{
6985 psa_status_t status;
6986 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
6987
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306988#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05306989 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306990 status = psa_pbkdf2_set_input_cost(
6991 &operation->ctx.pbkdf2, step, value);
6992 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306993#endif /* PSA_HAVE_SOFT_PBKDF2 */
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05306994 {
Kusumit Ghoderao3a18dee2023-04-07 16:16:27 +05306995 (void) step;
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05306996 (void) value;
6997 (void) kdf_alg;
Kusumit Ghoderaoa14ae5a2023-04-19 14:16:26 +05306998 status = PSA_ERROR_INVALID_ARGUMENT;
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05306999 }
7000
7001 if (status != PSA_SUCCESS) {
7002 psa_key_derivation_abort(operation);
7003 }
7004 return status;
7005}
7006
Janos Follath51f4a0f2019-06-14 11:35:55 +01007007psa_status_t psa_key_derivation_input_bytes(
7008 psa_key_derivation_operation_t *operation,
7009 psa_key_derivation_step_t step,
7010 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01007011 size_t data_length)
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01007012{
Gilles Peskine449bd832023-01-11 14:50:10 +01007013 return psa_key_derivation_input_internal(operation, step,
7014 PSA_KEY_TYPE_NONE,
7015 data, data_length);
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01007016}
7017
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05307018psa_status_t psa_key_derivation_input_integer(
7019 psa_key_derivation_operation_t *operation,
7020 psa_key_derivation_step_t step,
7021 uint64_t value)
7022{
7023 return psa_key_derivation_input_integer_internal(operation, step, value);
7024}
7025
Janos Follath51f4a0f2019-06-14 11:35:55 +01007026psa_status_t psa_key_derivation_input_key(
7027 psa_key_derivation_operation_t *operation,
7028 psa_key_derivation_step_t step,
Gilles Peskine449bd832023-01-11 14:50:10 +01007029 mbedtls_svc_key_id_t key)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007030{
Ronald Cronf95a2b12020-10-22 15:24:49 +02007031 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01007032 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007033 psa_key_slot_t *slot;
Gilles Peskine178c9aa2019-09-24 18:21:06 +02007034
Ronald Cron5c522922020-11-14 16:35:34 +01007035 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01007036 key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg);
7037 if (status != PSA_SUCCESS) {
7038 psa_key_derivation_abort(operation);
7039 return status;
Gilles Peskine593773d2019-09-23 18:17:40 +02007040 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02007041
Kusumit Ghoderao3128c5d2023-05-03 12:27:57 +05307042 /* Passing a key object as a SECRET or PASSWORD input unlocks the
7043 * permission to output to a key object. */
7044 if (step == PSA_KEY_DERIVATION_INPUT_SECRET ||
7045 step == PSA_KEY_DERIVATION_INPUT_PASSWORD) {
Gilles Peskine178c9aa2019-09-24 18:21:06 +02007046 operation->can_output_key = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01007047 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02007048
Gilles Peskine449bd832023-01-11 14:50:10 +01007049 status = psa_key_derivation_input_internal(operation,
7050 step, slot->attr.type,
7051 slot->key.data,
7052 slot->key.bytes);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007053
Ryan Everett1b70a072024-01-04 10:32:49 +00007054 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007055
Gilles Peskine449bd832023-01-11 14:50:10 +01007056 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007057}
Gilles Peskineea0fb492018-07-12 17:17:20 +02007058
7059
7060
7061/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02007062/* Key agreement */
7063/****************************************************************/
7064
Gilles Peskine449bd832023-01-11 14:50:10 +01007065psa_status_t psa_key_agreement_raw_builtin(const psa_key_attributes_t *attributes,
7066 const uint8_t *key_buffer,
7067 size_t key_buffer_size,
7068 psa_algorithm_t alg,
7069 const uint8_t *peer_key,
7070 size_t peer_key_length,
7071 uint8_t *shared_secret,
7072 size_t shared_secret_size,
7073 size_t *shared_secret_length)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02007074{
Gilles Peskine449bd832023-01-11 14:50:10 +01007075 switch (alg) {
John Durkop6ba40d12020-11-10 08:50:04 -08007076#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskine0216fe12019-04-11 21:23:21 +02007077 case PSA_ALG_ECDH:
Gilles Peskine449bd832023-01-11 14:50:10 +01007078 return mbedtls_psa_key_agreement_ecdh(attributes, key_buffer,
7079 key_buffer_size, alg,
7080 peer_key, peer_key_length,
7081 shared_secret,
7082 shared_secret_size,
7083 shared_secret_length);
Gilles Peskine01d718c2018-09-18 12:01:02 +02007084#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Przemek Stekielfb3dd542022-12-01 14:59:15 +01007085
7086#if defined(MBEDTLS_PSA_BUILTIN_ALG_FFDH)
7087 case PSA_ALG_FFDH:
Przemek Stekiel152bb462023-06-01 11:52:39 +02007088 return mbedtls_psa_ffdh_key_agreement(attributes,
Przemek Stekiel359f4622022-12-05 14:11:55 +01007089 peer_key,
7090 peer_key_length,
7091 key_buffer,
7092 key_buffer_size,
7093 shared_secret,
7094 shared_secret_size,
7095 shared_secret_length);
Przemek Stekielfb3dd542022-12-01 14:59:15 +01007096#endif /* MBEDTLS_PSA_BUILTIN_ALG_FFDH */
7097
Gilles Peskine01d718c2018-09-18 12:01:02 +02007098 default:
Aditya Deshpande17845b82022-10-13 17:21:01 +01007099 (void) attributes;
7100 (void) key_buffer;
7101 (void) key_buffer_size;
Gilles Peskine93f85002018-11-16 16:43:31 +01007102 (void) peer_key;
7103 (void) peer_key_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02007104 (void) shared_secret;
7105 (void) shared_secret_size;
7106 (void) shared_secret_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01007107 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine01d718c2018-09-18 12:01:02 +02007108 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02007109}
Gilles Peskine01d718c2018-09-18 12:01:02 +02007110
Aditya Deshpande17845b82022-10-13 17:21:01 +01007111/** Internal function for raw key agreement
7112 * Calls the driver wrapper which will hand off key agreement task
Aditya Deshpande40c05cc2022-10-14 16:41:40 +01007113 * to the driver's implementation if a driver is present.
7114 * Fallback specified in the driver wrapper is built-in raw key agreement
Aditya Deshpande17845b82022-10-13 17:21:01 +01007115 * (psa_key_agreement_raw_builtin).
7116 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007117static psa_status_t psa_key_agreement_raw_internal(psa_algorithm_t alg,
7118 psa_key_slot_t *private_key,
7119 const uint8_t *peer_key,
7120 size_t peer_key_length,
7121 uint8_t *shared_secret,
7122 size_t shared_secret_size,
7123 size_t *shared_secret_length)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02007124{
Gilles Peskine449bd832023-01-11 14:50:10 +01007125 if (!PSA_ALG_IS_RAW_KEY_AGREEMENT(alg)) {
7126 return PSA_ERROR_NOT_SUPPORTED;
7127 }
Aditya Deshpande17845b82022-10-13 17:21:01 +01007128
7129 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01007130 .core = private_key->attr
Aditya Deshpande17845b82022-10-13 17:21:01 +01007131 };
7132
Gilles Peskine449bd832023-01-11 14:50:10 +01007133 return psa_driver_wrapper_key_agreement(&attributes,
7134 private_key->key.data,
7135 private_key->key.bytes, alg,
7136 peer_key, peer_key_length,
7137 shared_secret,
7138 shared_secret_size,
7139 shared_secret_length);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007140}
7141
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02007142/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine01d718c2018-09-18 12:01:02 +02007143 * to potentially free embedded data structures and wipe confidential data.
7144 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007145static psa_status_t psa_key_agreement_internal(psa_key_derivation_operation_t *operation,
7146 psa_key_derivation_step_t step,
7147 psa_key_slot_t *private_key,
7148 const uint8_t *peer_key,
7149 size_t peer_key_length)
Gilles Peskine01d718c2018-09-18 12:01:02 +02007150{
7151 psa_status_t status;
Aditya Deshpande2f7fd762022-11-22 11:10:34 +00007152 uint8_t shared_secret[PSA_RAW_KEY_AGREEMENT_OUTPUT_MAX_SIZE];
Gilles Peskine01d718c2018-09-18 12:01:02 +02007153 size_t shared_secret_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007154 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE(operation->alg);
Gilles Peskine01d718c2018-09-18 12:01:02 +02007155
7156 /* Step 1: run the secret agreement algorithm to generate the shared
7157 * secret. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007158 status = psa_key_agreement_raw_internal(ka_alg,
7159 private_key,
7160 peer_key, peer_key_length,
7161 shared_secret,
7162 sizeof(shared_secret),
7163 &shared_secret_length);
7164 if (status != PSA_SUCCESS) {
Gilles Peskine12313cd2018-06-20 00:20:32 +02007165 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007166 }
Gilles Peskine12313cd2018-06-20 00:20:32 +02007167
Gilles Peskineb0b255c2018-07-06 17:01:38 +02007168 /* Step 2: set up the key derivation to generate key material from
Gilles Peskine224b0d62019-09-23 18:13:17 +02007169 * the shared secret. A shared secret is permitted wherever a key
7170 * of type DERIVE is permitted. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007171 status = psa_key_derivation_input_internal(operation, step,
7172 PSA_KEY_TYPE_DERIVE,
7173 shared_secret,
7174 shared_secret_length);
Gilles Peskine12313cd2018-06-20 00:20:32 +02007175exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007176 mbedtls_platform_zeroize(shared_secret, shared_secret_length);
7177 return status;
Gilles Peskine12313cd2018-06-20 00:20:32 +02007178}
7179
Gilles Peskine449bd832023-01-11 14:50:10 +01007180psa_status_t psa_key_derivation_key_agreement(psa_key_derivation_operation_t *operation,
7181 psa_key_derivation_step_t step,
7182 mbedtls_svc_key_id_t private_key,
7183 const uint8_t *peer_key,
7184 size_t peer_key_length)
Gilles Peskine12313cd2018-06-20 00:20:32 +02007185{
Ronald Cronf95a2b12020-10-22 15:24:49 +02007186 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01007187 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01007188 psa_key_slot_t *slot;
Ronald Cronf95a2b12020-10-22 15:24:49 +02007189
Gilles Peskine449bd832023-01-11 14:50:10 +01007190 if (!PSA_ALG_IS_KEY_AGREEMENT(operation->alg)) {
7191 return PSA_ERROR_INVALID_ARGUMENT;
7192 }
Ronald Cron5c522922020-11-14 16:35:34 +01007193 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01007194 private_key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg);
7195 if (status != PSA_SUCCESS) {
7196 return status;
7197 }
7198 status = psa_key_agreement_internal(operation, step,
7199 slot,
7200 peer_key, peer_key_length);
7201 if (status != PSA_SUCCESS) {
7202 psa_key_derivation_abort(operation);
7203 } else {
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007204 /* If a private key has been added as SECRET, we allow the derived
7205 * key material to be used as a key in PSA Crypto. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007206 if (step == PSA_KEY_DERIVATION_INPUT_SECRET) {
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007207 operation->can_output_key = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01007208 }
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007209 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007210
Ryan Everett1b70a072024-01-04 10:32:49 +00007211 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007212
Gilles Peskine449bd832023-01-11 14:50:10 +01007213 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskineaf3baab2018-06-27 22:55:52 +02007214}
7215
Gilles Peskine449bd832023-01-11 14:50:10 +01007216psa_status_t psa_raw_key_agreement(psa_algorithm_t alg,
7217 mbedtls_svc_key_id_t private_key,
7218 const uint8_t *peer_key,
7219 size_t peer_key_length,
7220 uint8_t *output,
7221 size_t output_size,
7222 size_t *output_length)
Gilles Peskine0216fe12019-04-11 21:23:21 +02007223{
Ronald Cronf95a2b12020-10-22 15:24:49 +02007224 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01007225 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +02007226 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007227 size_t expected_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02007228
Gilles Peskine449bd832023-01-11 14:50:10 +01007229 if (!PSA_ALG_IS_KEY_AGREEMENT(alg)) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007230 status = PSA_ERROR_INVALID_ARGUMENT;
7231 goto exit;
7232 }
Ronald Cron5c522922020-11-14 16:35:34 +01007233 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01007234 private_key, &slot, PSA_KEY_USAGE_DERIVE, alg);
7235 if (status != PSA_SUCCESS) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007236 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007237 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02007238
Gilles Peskine3e561302022-04-14 00:17:15 +02007239 /* PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() is in general an upper bound
7240 * for the output size. The PSA specification only guarantees that this
7241 * function works if output_size >= PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE(...),
7242 * but it might be nice to allow smaller buffers if the output fits.
7243 * At the time of writing this comment, with only ECDH implemented,
7244 * PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() is exact so the point is moot.
7245 * If FFDH is implemented, PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() can easily
7246 * be exact for it as well. */
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007247 expected_length =
Gilles Peskine449bd832023-01-11 14:50:10 +01007248 PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE(slot->attr.type, slot->attr.bits);
7249 if (output_size < expected_length) {
Gilles Peskine3e561302022-04-14 00:17:15 +02007250 status = PSA_ERROR_BUFFER_TOO_SMALL;
7251 goto exit;
7252 }
7253
Gilles Peskine449bd832023-01-11 14:50:10 +01007254 status = psa_key_agreement_raw_internal(alg, slot,
7255 peer_key, peer_key_length,
7256 output, output_size,
7257 output_length);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007258
7259exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007260 if (status != PSA_SUCCESS) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007261 /* If an error happens and is not handled properly, the output
7262 * may be used as a key to protect sensitive data. Arrange for such
7263 * a key to be random, which is likely to result in decryption or
7264 * verification errors. This is better than filling the buffer with
7265 * some constant data such as zeros, which would result in the data
7266 * being protected with a reproducible, easily knowable key.
7267 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007268 psa_generate_random(output, output_size);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007269 *output_length = output_size;
7270 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007271
Ryan Everett1b70a072024-01-04 10:32:49 +00007272 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007273
Gilles Peskine449bd832023-01-11 14:50:10 +01007274 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine0216fe12019-04-11 21:23:21 +02007275}
Gilles Peskine86a440b2018-11-12 18:39:40 +01007276
7277
Gilles Peskine30524eb2020-11-13 17:02:26 +01007278
Gilles Peskine86a440b2018-11-12 18:39:40 +01007279/****************************************************************/
7280/* Random generation */
Gilles Peskine53d991e2018-07-12 01:14:59 +02007281/****************************************************************/
Gilles Peskine12313cd2018-06-20 00:20:32 +02007282
Gilles Peskine672a7712023-04-28 21:00:28 +02007283#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
7284#include "entropy_poll.h"
7285#endif
7286
Gilles Peskine30524eb2020-11-13 17:02:26 +01007287/** Initialize the PSA random generator.
7288 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007289static void mbedtls_psa_random_init(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01007290{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007291#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine449bd832023-01-11 14:50:10 +01007292 memset(rng, 0, sizeof(*rng));
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007293#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
7294
Gilles Peskine30524eb2020-11-13 17:02:26 +01007295 /* Set default configuration if
7296 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007297 if (rng->entropy_init == NULL) {
Gilles Peskine30524eb2020-11-13 17:02:26 +01007298 rng->entropy_init = mbedtls_entropy_init;
Gilles Peskine449bd832023-01-11 14:50:10 +01007299 }
7300 if (rng->entropy_free == NULL) {
Gilles Peskine30524eb2020-11-13 17:02:26 +01007301 rng->entropy_free = mbedtls_entropy_free;
Gilles Peskine449bd832023-01-11 14:50:10 +01007302 }
Gilles Peskine30524eb2020-11-13 17:02:26 +01007303
Gilles Peskine449bd832023-01-11 14:50:10 +01007304 rng->entropy_init(&rng->entropy);
Gilles Peskine30524eb2020-11-13 17:02:26 +01007305#if defined(MBEDTLS_PSA_INJECT_ENTROPY) && \
7306 defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
7307 /* The PSA entropy injection feature depends on using NV seed as an entropy
7308 * source. Add NV seed as an entropy source for PSA entropy injection. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007309 mbedtls_entropy_add_source(&rng->entropy,
7310 mbedtls_nv_seed_poll, NULL,
7311 MBEDTLS_ENTROPY_BLOCK_SIZE,
7312 MBEDTLS_ENTROPY_SOURCE_STRONG);
Gilles Peskine30524eb2020-11-13 17:02:26 +01007313#endif
7314
Gilles Peskine449bd832023-01-11 14:50:10 +01007315 mbedtls_psa_drbg_init(MBEDTLS_PSA_RANDOM_STATE);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007316#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007317}
7318
7319/** Deinitialize the PSA random generator.
7320 */
Valerio Setti83e0de82023-11-24 12:13:05 +01007321static void mbedtls_psa_random_free(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01007322{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007323#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Valerio Setti83e0de82023-11-24 12:13:05 +01007324 memset(rng, 0, sizeof(*rng));
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007325#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Valerio Setti83e0de82023-11-24 12:13:05 +01007326 mbedtls_psa_drbg_free(MBEDTLS_PSA_RANDOM_STATE);
7327 rng->entropy_free(&rng->entropy);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007328#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007329}
7330
7331/** Seed the PSA random generator.
7332 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007333static psa_status_t mbedtls_psa_random_seed(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01007334{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007335#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
7336 /* Do nothing: the external RNG seeds itself. */
7337 (void) rng;
Gilles Peskine449bd832023-01-11 14:50:10 +01007338 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007339#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007340 const unsigned char drbg_seed[] = "PSA";
Gilles Peskine449bd832023-01-11 14:50:10 +01007341 int ret = mbedtls_psa_drbg_seed(&rng->entropy,
7342 drbg_seed, sizeof(drbg_seed) - 1);
7343 return mbedtls_to_psa_error(ret);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007344#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007345}
7346
Gilles Peskine449bd832023-01-11 14:50:10 +01007347psa_status_t psa_generate_random(uint8_t *output,
7348 size_t output_size)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007349{
Gilles Peskinee59236f2018-01-27 23:32:46 +01007350 GUARD_MODULE_INITIALIZED;
7351
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007352#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
7353
7354 size_t output_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007355 psa_status_t status = mbedtls_psa_external_get_random(&global_data.rng,
7356 output, output_size,
7357 &output_length);
7358 if (status != PSA_SUCCESS) {
7359 return status;
7360 }
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007361 /* Breaking up a request into smaller chunks is currently not supported
Tom Cosgrove1797b052022-12-04 17:19:59 +00007362 * for the external RNG interface. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007363 if (output_length != output_size) {
7364 return PSA_ERROR_INSUFFICIENT_ENTROPY;
7365 }
7366 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007367
7368#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
7369
Gilles Peskine449bd832023-01-11 14:50:10 +01007370 while (output_size > 0) {
Gilles Peskine71ddab92021-01-04 21:01:07 +01007371 size_t request_size =
Gilles Peskine449bd832023-01-11 14:50:10 +01007372 (output_size > MBEDTLS_PSA_RANDOM_MAX_REQUEST ?
7373 MBEDTLS_PSA_RANDOM_MAX_REQUEST :
7374 output_size);
7375 int ret = mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE,
7376 output, request_size);
7377 if (ret != 0) {
7378 return mbedtls_to_psa_error(ret);
7379 }
Gilles Peskine71ddab92021-01-04 21:01:07 +01007380 output_size -= request_size;
7381 output += request_size;
Gilles Peskinef181eca2019-08-07 13:49:00 +02007382 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007383 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007384#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskinee59236f2018-01-27 23:32:46 +01007385}
7386
Gilles Peskine8814fc42020-12-14 15:33:44 +01007387/* Wrapper function allowing the classic API to use the PSA RNG.
Gilles Peskine9c3e0602021-01-05 16:03:55 +01007388 *
7389 * `mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE, ...)` calls
7390 * `psa_generate_random(...)`. The state parameter is ignored since the
7391 * PSA API doesn't support passing an explicit state.
7392 *
7393 * In the non-external case, psa_generate_random() calls an
7394 * `mbedtls_xxx_drbg_random` function which has exactly the same signature
7395 * and semantics as mbedtls_psa_get_random(). As an optimization,
7396 * instead of doing this back-and-forth between the PSA API and the
7397 * classic API, psa_crypto_random_impl.h defines `mbedtls_psa_get_random`
7398 * as a constant function pointer to `mbedtls_xxx_drbg_random`.
Gilles Peskine8814fc42020-12-14 15:33:44 +01007399 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007400#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
7401int mbedtls_psa_get_random(void *p_rng,
7402 unsigned char *output,
7403 size_t output_size)
Gilles Peskine8814fc42020-12-14 15:33:44 +01007404{
Gilles Peskine9c3e0602021-01-05 16:03:55 +01007405 /* This function takes a pointer to the RNG state because that's what
7406 * classic mbedtls functions using an RNG expect. The PSA RNG manages
7407 * its own state internally and doesn't let the caller access that state.
7408 * So we just ignore the state parameter, and in practice we'll pass
7409 * NULL. */
Gilles Peskine8814fc42020-12-14 15:33:44 +01007410 (void) p_rng;
Gilles Peskine449bd832023-01-11 14:50:10 +01007411 psa_status_t status = psa_generate_random(output, output_size);
7412 if (status == PSA_SUCCESS) {
7413 return 0;
7414 } else {
7415 return MBEDTLS_ERR_ENTROPY_SOURCE_FAILED;
7416 }
Gilles Peskine8814fc42020-12-14 15:33:44 +01007417}
7418#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
7419
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01007420#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
Gilles Peskine449bd832023-01-11 14:50:10 +01007421psa_status_t mbedtls_psa_inject_entropy(const uint8_t *seed,
7422 size_t seed_size)
Netanel Gonen2bcd3122018-11-19 11:53:02 +02007423{
Gilles Peskine449bd832023-01-11 14:50:10 +01007424 if (global_data.initialized) {
7425 return PSA_ERROR_NOT_PERMITTED;
7426 }
Netanel Gonen21f37cb2018-11-19 11:53:55 +02007427
Gilles Peskine449bd832023-01-11 14:50:10 +01007428 if (((seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM) ||
7429 (seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE)) ||
7430 (seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE)) {
7431 return PSA_ERROR_INVALID_ARGUMENT;
7432 }
Netanel Gonen21f37cb2018-11-19 11:53:55 +02007433
Gilles Peskine449bd832023-01-11 14:50:10 +01007434 return mbedtls_psa_storage_inject_entropy(seed, seed_size);
Netanel Gonen2bcd3122018-11-19 11:53:02 +02007435}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01007436#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02007437
Ronald Cron3772afe2021-02-08 16:10:05 +01007438/** Validate the key type and size for key generation
Ronald Cron01b2aba2020-10-05 09:42:02 +02007439 *
Ronald Cron3772afe2021-02-08 16:10:05 +01007440 * \param type The key type
7441 * \param bits The number of bits of the key
Ronald Cron01b2aba2020-10-05 09:42:02 +02007442 *
7443 * \retval #PSA_SUCCESS
Ronald Cron3772afe2021-02-08 16:10:05 +01007444 * The key type and size are valid.
Ronald Cron01b2aba2020-10-05 09:42:02 +02007445 * \retval #PSA_ERROR_INVALID_ARGUMENT
7446 * The size in bits of the key is not valid.
7447 * \retval #PSA_ERROR_NOT_SUPPORTED
7448 * The type and/or the size in bits of the key or the combination of
7449 * the two is not supported.
7450 */
Ronald Cron3772afe2021-02-08 16:10:05 +01007451static psa_status_t psa_validate_key_type_and_size_for_key_generation(
Gilles Peskine449bd832023-01-11 14:50:10 +01007452 psa_key_type_t type, size_t bits)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007453{
Ronald Cronf3bb7612020-10-02 20:11:59 +02007454 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007455
Gilles Peskine449bd832023-01-11 14:50:10 +01007456 if (key_type_is_raw_bytes(type)) {
7457 status = psa_validate_unstructured_key_bit_size(type, bits);
7458 if (status != PSA_SUCCESS) {
7459 return status;
7460 }
7461 } else
Valerio Settif6d4dfb2023-07-10 10:55:12 +02007462#if defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007463 if (PSA_KEY_TYPE_IS_RSA(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
7464 if (bits > PSA_VENDOR_RSA_MAX_KEY_BITS) {
7465 return PSA_ERROR_NOT_SUPPORTED;
7466 }
Waleed Elmelegyd7bdbbe2023-07-20 16:26:58 +00007467 if (bits < PSA_VENDOR_RSA_GENERATE_MIN_KEY_BITS) {
Waleed Elmelegyab570712023-07-05 16:40:58 +00007468 return PSA_ERROR_NOT_SUPPORTED;
7469 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +02007470
Ronald Cron01b2aba2020-10-05 09:42:02 +02007471 /* Accept only byte-aligned keys, for the same reasons as
7472 * in psa_import_rsa_key(). */
Gilles Peskine449bd832023-01-11 14:50:10 +01007473 if (bits % 8 != 0) {
7474 return PSA_ERROR_NOT_SUPPORTED;
7475 }
7476 } else
Valerio Settif6d4dfb2023-07-10 10:55:12 +02007477#endif /* defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02007478
Valerio Setti6a9d0ee2023-06-21 10:07:21 +02007479#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007480 if (PSA_KEY_TYPE_IS_ECC(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
Ronald Crond81ab562021-02-16 09:01:16 +01007481 /* To avoid empty block, return successfully here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007482 return PSA_SUCCESS;
7483 } else
Valerio Setti6a9d0ee2023-06-21 10:07:21 +02007484#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_GENERATE) */
Przemek Stekielfedd1342022-12-01 15:00:02 +01007485
Valerio Settia55f0422023-07-10 15:34:41 +02007486#if defined(PSA_WANT_KEY_TYPE_DH_KEY_PAIR_GENERATE)
Przemek Stekielfedd1342022-12-01 15:00:02 +01007487 if (PSA_KEY_TYPE_IS_DH(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
Przemek Stekield1cf1ba2023-04-27 12:04:21 +02007488 if (psa_is_dh_key_size_valid(bits) == 0) {
Przemek Stekielfedd1342022-12-01 15:00:02 +01007489 return PSA_ERROR_NOT_SUPPORTED;
7490 }
7491 } else
Valerio Settia55f0422023-07-10 15:34:41 +02007492#endif /* defined(PSA_WANT_KEY_TYPE_DH_KEY_PAIR_GENERATE) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02007493 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007494 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007495 }
7496
Gilles Peskine449bd832023-01-11 14:50:10 +01007497 return PSA_SUCCESS;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007498}
7499
Ronald Cron55ed0592020-10-05 10:30:40 +02007500psa_status_t psa_generate_key_internal(
Ronald Cron2a38a6b2020-10-02 20:02:04 +02007501 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01007502 uint8_t *key_buffer, size_t key_buffer_size, size_t *key_buffer_length)
Ronald Cron01b2aba2020-10-05 09:42:02 +02007503{
7504 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2a38a6b2020-10-02 20:02:04 +02007505 psa_key_type_t type = attributes->core.type;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007506
Gilles Peskine449bd832023-01-11 14:50:10 +01007507 if ((attributes->domain_parameters == NULL) &&
7508 (attributes->domain_parameters_size != 0)) {
7509 return PSA_ERROR_INVALID_ARGUMENT;
7510 }
Ronald Cron01b2aba2020-10-05 09:42:02 +02007511
Gilles Peskine449bd832023-01-11 14:50:10 +01007512 if (key_type_is_raw_bytes(type)) {
7513 status = psa_generate_random(key_buffer, key_buffer_size);
7514 if (status != PSA_SUCCESS) {
7515 return status;
7516 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +02007517
David Brown12ca5032021-02-11 11:02:00 -07007518#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01007519 if (type == PSA_KEY_TYPE_DES) {
7520 psa_des_set_key_parity(key_buffer, key_buffer_size);
7521 }
David Brown8107e312021-02-12 08:08:46 -07007522#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine449bd832023-01-11 14:50:10 +01007523 } else
Gilles Peskinee59236f2018-01-27 23:32:46 +01007524
Valerio Setti76df8c12023-07-11 14:11:28 +02007525#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007526 if (type == PSA_KEY_TYPE_RSA_KEY_PAIR) {
7527 return mbedtls_psa_rsa_generate_key(attributes,
7528 key_buffer,
7529 key_buffer_size,
7530 key_buffer_length);
7531 } else
Valerio Setti76df8c12023-07-11 14:11:28 +02007532#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_GENERATE) */
Gilles Peskinee59236f2018-01-27 23:32:46 +01007533
Valerio Settibfeaf5b2023-06-20 13:27:46 +02007534#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007535 if (PSA_KEY_TYPE_IS_ECC(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
7536 return mbedtls_psa_ecp_generate_key(attributes,
7537 key_buffer,
7538 key_buffer_size,
7539 key_buffer_length);
7540 } else
Valerio Settibfeaf5b2023-06-20 13:27:46 +02007541#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_GENERATE) */
Przemek Stekielfedd1342022-12-01 15:00:02 +01007542
Valerio Settia55f0422023-07-10 15:34:41 +02007543#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_GENERATE)
Przemek Stekielfedd1342022-12-01 15:00:02 +01007544 if (PSA_KEY_TYPE_IS_DH(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
7545 return mbedtls_psa_ffdh_generate_key(attributes,
7546 key_buffer,
7547 key_buffer_size,
7548 key_buffer_length);
7549 } else
Valerio Settia55f0422023-07-10 15:34:41 +02007550#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_GENERATE) */
Steven Cooreman29149862020-08-05 15:43:42 +02007551 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007552 (void) key_buffer_length;
7553 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman29149862020-08-05 15:43:42 +02007554 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01007555
Gilles Peskine449bd832023-01-11 14:50:10 +01007556 return PSA_SUCCESS;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02007557}
Darryl Green0c6575a2018-11-07 16:05:30 +00007558
Gilles Peskine449bd832023-01-11 14:50:10 +01007559psa_status_t psa_generate_key(const psa_key_attributes_t *attributes,
7560 mbedtls_svc_key_id_t *key)
Gilles Peskineff5f0e72019-04-18 12:53:30 +02007561{
7562 psa_status_t status;
7563 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02007564 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cron2b56bc82020-10-05 10:02:26 +02007565 size_t key_buffer_size;
Gilles Peskine11792082019-08-06 18:36:36 +02007566
Ronald Cron81709fc2020-11-14 12:10:32 +01007567 *key = MBEDTLS_SVC_KEY_ID_INIT;
7568
Gilles Peskine0f84d622019-09-12 19:03:13 +02007569 /* Reject any attempt to create a zero-length key so that we don't
7570 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007571 if (psa_get_key_bits(attributes) == 0) {
7572 return PSA_ERROR_INVALID_ARGUMENT;
7573 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02007574
Przemyslaw Stekielc0fe8202021-10-07 11:08:56 +02007575 /* Reject any attempt to create a public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007576 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(attributes->core.type)) {
7577 return PSA_ERROR_INVALID_ARGUMENT;
7578 }
Przemyslaw Stekielc0fe8202021-10-07 11:08:56 +02007579
Gilles Peskine449bd832023-01-11 14:50:10 +01007580 status = psa_start_key_creation(PSA_KEY_CREATION_GENERATE, attributes,
7581 &slot, &driver);
7582 if (status != PSA_SUCCESS) {
Gilles Peskine11792082019-08-06 18:36:36 +02007583 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007584 }
Gilles Peskine11792082019-08-06 18:36:36 +02007585
Ronald Cron977c2472020-10-13 08:32:21 +02007586 /* In the case of a transparent key or an opaque key stored in local
Archana449608b2021-09-08 15:36:05 +05307587 * storage ( thus not in the case of generating a key in a secure element
7588 * with storage ( MBEDTLS_PSA_CRYPTO_SE_C ) ),we have to allocate a
7589 * buffer to hold the generated key material. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007590 if (slot->key.data == NULL) {
7591 if (PSA_KEY_LIFETIME_GET_LOCATION(attributes->core.lifetime) ==
7592 PSA_KEY_LOCATION_LOCAL_STORAGE) {
Ronald Cron3772afe2021-02-08 16:10:05 +01007593 status = psa_validate_key_type_and_size_for_key_generation(
Gilles Peskine449bd832023-01-11 14:50:10 +01007594 attributes->core.type, attributes->core.bits);
7595 if (status != PSA_SUCCESS) {
Ronald Cron3772afe2021-02-08 16:10:05 +01007596 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007597 }
Ronald Cron3772afe2021-02-08 16:10:05 +01007598
7599 key_buffer_size = PSA_EXPORT_KEY_OUTPUT_SIZE(
Gilles Peskine449bd832023-01-11 14:50:10 +01007600 attributes->core.type,
7601 attributes->core.bits);
7602 } else {
Ronald Cron977c2472020-10-13 08:32:21 +02007603 status = psa_driver_wrapper_get_key_buffer_size(
Gilles Peskine449bd832023-01-11 14:50:10 +01007604 attributes, &key_buffer_size);
7605 if (status != PSA_SUCCESS) {
Ronald Cron3772afe2021-02-08 16:10:05 +01007606 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007607 }
Ronald Cron977c2472020-10-13 08:32:21 +02007608 }
Ronald Cron977c2472020-10-13 08:32:21 +02007609
Gilles Peskine449bd832023-01-11 14:50:10 +01007610 status = psa_allocate_buffer_to_slot(slot, key_buffer_size);
7611 if (status != PSA_SUCCESS) {
Ronald Cron977c2472020-10-13 08:32:21 +02007612 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007613 }
Ronald Cron977c2472020-10-13 08:32:21 +02007614 }
7615
Gilles Peskine449bd832023-01-11 14:50:10 +01007616 status = psa_driver_wrapper_generate_key(attributes,
7617 slot->key.data, slot->key.bytes, &slot->key.bytes);
Gilles Peskine11792082019-08-06 18:36:36 +02007618
Gilles Peskine449bd832023-01-11 14:50:10 +01007619 if (status != PSA_SUCCESS) {
7620 psa_remove_key_data_from_memory(slot);
7621 }
Ronald Cron2b56bc82020-10-05 10:02:26 +02007622
Gilles Peskine11792082019-08-06 18:36:36 +02007623exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007624 if (status == PSA_SUCCESS) {
7625 status = psa_finish_key_creation(slot, driver, key);
7626 }
7627 if (status != PSA_SUCCESS) {
7628 psa_fail_key_creation(slot, driver);
7629 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007630
Gilles Peskine449bd832023-01-11 14:50:10 +01007631 return status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007632}
7633
Gilles Peskinee59236f2018-01-27 23:32:46 +01007634/****************************************************************/
7635/* Module setup */
7636/****************************************************************/
7637
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007638#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine5e769522018-11-20 21:59:56 +01007639psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
Gilles Peskine449bd832023-01-11 14:50:10 +01007640 void (* entropy_init)(mbedtls_entropy_context *ctx),
7641 void (* entropy_free)(mbedtls_entropy_context *ctx))
Gilles Peskine5e769522018-11-20 21:59:56 +01007642{
Gilles Peskine449bd832023-01-11 14:50:10 +01007643 if (global_data.rng_state != RNG_NOT_INITIALIZED) {
7644 return PSA_ERROR_BAD_STATE;
7645 }
Gilles Peskine30524eb2020-11-13 17:02:26 +01007646 global_data.rng.entropy_init = entropy_init;
7647 global_data.rng.entropy_free = entropy_free;
Gilles Peskine449bd832023-01-11 14:50:10 +01007648 return PSA_SUCCESS;
Gilles Peskine5e769522018-11-20 21:59:56 +01007649}
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007650#endif /* !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) */
Gilles Peskine5e769522018-11-20 21:59:56 +01007651
Gilles Peskine449bd832023-01-11 14:50:10 +01007652void mbedtls_psa_crypto_free(void)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007653{
Gilles Peskine449bd832023-01-11 14:50:10 +01007654 psa_wipe_all_key_slots();
Valerio Setti83e0de82023-11-24 12:13:05 +01007655 if (global_data.rng_state != RNG_NOT_INITIALIZED) {
7656 mbedtls_psa_random_free(&global_data.rng);
7657 }
Gilles Peskinec6b69072018-11-20 21:42:52 +01007658 /* Wipe all remaining data, including configuration.
7659 * In particular, this sets all state indicator to the value
7660 * indicating "uninitialized". */
Gilles Peskine449bd832023-01-11 14:50:10 +01007661 mbedtls_platform_zeroize(&global_data, sizeof(global_data));
Ronald Cron9ba76912021-04-10 16:57:30 +02007662
7663 /* Terminate drivers */
Gilles Peskine449bd832023-01-11 14:50:10 +01007664 psa_driver_wrapper_free();
Gilles Peskinee59236f2018-01-27 23:32:46 +01007665}
7666
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007667#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
7668/** Recover a transaction that was interrupted by a power failure.
7669 *
7670 * This function is called during initialization, before psa_crypto_init()
7671 * returns. If this function returns a failure status, the initialization
7672 * fails.
7673 */
7674static psa_status_t psa_crypto_recover_transaction(
Gilles Peskine449bd832023-01-11 14:50:10 +01007675 const psa_crypto_transaction_t *transaction)
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007676{
Gilles Peskine449bd832023-01-11 14:50:10 +01007677 switch (transaction->unknown.type) {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007678 case PSA_CRYPTO_TRANSACTION_CREATE_KEY:
7679 case PSA_CRYPTO_TRANSACTION_DESTROY_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01007680 /* TODO - fall through to the failure case until this
7681 * is implemented.
7682 * https://github.com/ARMmbed/mbed-crypto/issues/218
7683 */
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007684 default:
7685 /* We found an unsupported transaction in the storage.
7686 * We don't know what state the storage is in. Give up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007687 return PSA_ERROR_DATA_INVALID;
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007688 }
7689}
7690#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
7691
Gilles Peskine449bd832023-01-11 14:50:10 +01007692psa_status_t psa_crypto_init(void)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007693{
Gilles Peskine66fb1262018-12-10 16:29:04 +01007694 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007695
Gilles Peskinec6b69072018-11-20 21:42:52 +01007696 /* Double initialization is explicitly allowed. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007697 if (global_data.initialized != 0) {
7698 return PSA_SUCCESS;
7699 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01007700
Manuel Pégourié-Gonnard7abdf7e2023-03-09 11:17:43 +01007701 /* Init drivers */
7702 status = psa_driver_wrapper_init();
7703 if (status != PSA_SUCCESS) {
7704 goto exit;
7705 }
7706 global_data.drivers_initialized = 1;
7707
Valerio Setti402cfba2023-11-13 10:24:32 +01007708 status = psa_initialize_key_slots();
7709 if (status != PSA_SUCCESS) {
7710 goto exit;
7711 }
7712
Gilles Peskine30524eb2020-11-13 17:02:26 +01007713 /* Initialize and seed the random generator. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007714 mbedtls_psa_random_init(&global_data.rng);
Gilles Peskinec6b69072018-11-20 21:42:52 +01007715 global_data.rng_state = RNG_INITIALIZED;
Gilles Peskine449bd832023-01-11 14:50:10 +01007716 status = mbedtls_psa_random_seed(&global_data.rng);
7717 if (status != PSA_SUCCESS) {
Gilles Peskinee59236f2018-01-27 23:32:46 +01007718 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007719 }
Gilles Peskinec6b69072018-11-20 21:42:52 +01007720 global_data.rng_state = RNG_SEEDED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007721
Gilles Peskine4b734222019-07-24 15:56:31 +02007722#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007723 status = psa_crypto_load_transaction();
7724 if (status == PSA_SUCCESS) {
7725 status = psa_crypto_recover_transaction(&psa_crypto_transaction);
7726 if (status != PSA_SUCCESS) {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007727 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007728 }
7729 status = psa_crypto_stop_transaction();
7730 } else if (status == PSA_ERROR_DOES_NOT_EXIST) {
Gilles Peskinefc762652019-07-22 19:30:34 +02007731 /* There's no transaction to complete. It's all good. */
7732 status = PSA_SUCCESS;
7733 }
Gilles Peskine4b734222019-07-24 15:56:31 +02007734#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
Gilles Peskinefc762652019-07-22 19:30:34 +02007735
Gilles Peskinec6b69072018-11-20 21:42:52 +01007736 /* All done. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01007737 global_data.initialized = 1;
7738
7739exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007740 if (status != PSA_SUCCESS) {
7741 mbedtls_psa_crypto_free();
7742 }
7743 return status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007744}
7745
Yanray Wangffc3c482023-07-11 12:01:04 +08007746#if defined(PSA_WANT_ALG_SOME_PAKE)
Przemek Stekielca8d2b22023-01-17 16:21:33 +01007747psa_status_t psa_crypto_driver_pake_get_password_len(
7748 const psa_crypto_driver_pake_inputs_t *inputs,
7749 size_t *password_len)
7750{
7751 if (inputs->password_len == 0) {
7752 return PSA_ERROR_BAD_STATE;
7753 }
7754
7755 *password_len = inputs->password_len;
7756
7757 return PSA_SUCCESS;
7758}
7759
7760psa_status_t psa_crypto_driver_pake_get_password(
7761 const psa_crypto_driver_pake_inputs_t *inputs,
7762 uint8_t *buffer, size_t buffer_size, size_t *buffer_length)
7763{
7764 if (inputs->password_len == 0) {
7765 return PSA_ERROR_BAD_STATE;
7766 }
7767
7768 if (buffer_size < inputs->password_len) {
7769 return PSA_ERROR_BUFFER_TOO_SMALL;
7770 }
7771
7772 memcpy(buffer, inputs->password, inputs->password_len);
7773 *buffer_length = inputs->password_len;
7774
7775 return PSA_SUCCESS;
7776}
7777
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007778psa_status_t psa_crypto_driver_pake_get_user_len(
7779 const psa_crypto_driver_pake_inputs_t *inputs,
7780 size_t *user_len)
7781{
7782 if (inputs->user_len == 0) {
7783 return PSA_ERROR_BAD_STATE;
7784 }
7785
7786 *user_len = inputs->user_len;
7787
7788 return PSA_SUCCESS;
7789}
7790
7791psa_status_t psa_crypto_driver_pake_get_user(
7792 const psa_crypto_driver_pake_inputs_t *inputs,
Przemek Stekielc0e62502023-03-14 11:49:36 +01007793 uint8_t *user_id, size_t user_id_size, size_t *user_id_len)
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007794{
7795 if (inputs->user_len == 0) {
7796 return PSA_ERROR_BAD_STATE;
7797 }
7798
Przemek Stekielc0e62502023-03-14 11:49:36 +01007799 if (user_id_size < inputs->user_len) {
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007800 return PSA_ERROR_BUFFER_TOO_SMALL;
7801 }
7802
Przemek Stekielc0e62502023-03-14 11:49:36 +01007803 memcpy(user_id, inputs->user, inputs->user_len);
7804 *user_id_len = inputs->user_len;
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007805
7806 return PSA_SUCCESS;
7807}
7808
7809psa_status_t psa_crypto_driver_pake_get_peer_len(
7810 const psa_crypto_driver_pake_inputs_t *inputs,
7811 size_t *peer_len)
7812{
7813 if (inputs->peer_len == 0) {
7814 return PSA_ERROR_BAD_STATE;
7815 }
7816
7817 *peer_len = inputs->peer_len;
7818
7819 return PSA_SUCCESS;
7820}
7821
7822psa_status_t psa_crypto_driver_pake_get_peer(
7823 const psa_crypto_driver_pake_inputs_t *inputs,
Przemek Stekielc0e62502023-03-14 11:49:36 +01007824 uint8_t *peer_id, size_t peer_id_size, size_t *peer_id_length)
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007825{
7826 if (inputs->peer_len == 0) {
7827 return PSA_ERROR_BAD_STATE;
7828 }
7829
Przemek Stekielc0e62502023-03-14 11:49:36 +01007830 if (peer_id_size < inputs->peer_len) {
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007831 return PSA_ERROR_BUFFER_TOO_SMALL;
7832 }
7833
Przemek Stekielc0e62502023-03-14 11:49:36 +01007834 memcpy(peer_id, inputs->peer, inputs->peer_len);
7835 *peer_id_length = inputs->peer_len;
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007836
7837 return PSA_SUCCESS;
7838}
7839
Przemek Stekielca8d2b22023-01-17 16:21:33 +01007840psa_status_t psa_crypto_driver_pake_get_cipher_suite(
7841 const psa_crypto_driver_pake_inputs_t *inputs,
7842 psa_pake_cipher_suite_t *cipher_suite)
7843{
7844 if (inputs->cipher_suite.algorithm == PSA_ALG_NONE) {
7845 return PSA_ERROR_BAD_STATE;
7846 }
7847
7848 *cipher_suite = inputs->cipher_suite;
7849
7850 return PSA_SUCCESS;
7851}
7852
Neil Armstronga7d08c32022-06-01 18:21:20 +02007853psa_status_t psa_pake_setup(
7854 psa_pake_operation_t *operation,
7855 const psa_pake_cipher_suite_t *cipher_suite)
7856{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007857 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007858
Przemek Stekiel1c3cfb42023-01-26 10:35:02 +01007859 if (operation->stage != PSA_PAKE_OPERATION_STAGE_SETUP) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007860 status = PSA_ERROR_BAD_STATE;
7861 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007862 }
7863
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01007864 if (PSA_ALG_IS_PAKE(cipher_suite->algorithm) == 0 ||
Przemek Stekiel51eac532022-12-07 11:04:51 +01007865 PSA_ALG_IS_HASH(cipher_suite->hash) == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007866 status = PSA_ERROR_INVALID_ARGUMENT;
7867 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007868 }
7869
Przemek Stekiel51eac532022-12-07 11:04:51 +01007870 memset(&operation->data.inputs, 0, sizeof(operation->data.inputs));
7871
Przemek Stekiele12ed362022-12-21 12:54:46 +01007872 operation->alg = cipher_suite->algorithm;
Przemek Stekiel656b2592023-03-22 13:15:33 +01007873 operation->primitive = PSA_PAKE_PRIMITIVE(cipher_suite->type,
7874 cipher_suite->family, cipher_suite->bits);
Przemek Stekiel51eac532022-12-07 11:04:51 +01007875 operation->data.inputs.cipher_suite = *cipher_suite;
7876
Przemek Stekiel4aa99402023-02-27 13:00:57 +01007877#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01007878 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01007879 psa_jpake_computation_stage_t *computation_stage =
Przemek Stekieldde6a912023-01-26 08:46:37 +01007880 &operation->computation_stage.jpake;
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01007881
David Horstmann16f01512023-06-14 17:21:07 +01007882 memset(computation_stage, 0, sizeof(*computation_stage));
David Horstmanne7f21e62023-05-12 18:17:21 +01007883 computation_stage->step = PSA_PAKE_STEP_KEY_SHARE;
Przemek Stekiel80a88492023-02-20 13:32:22 +01007884 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007885#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01007886 {
7887 status = PSA_ERROR_NOT_SUPPORTED;
7888 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01007889 }
7890
Przemek Stekiel1c3cfb42023-01-26 10:35:02 +01007891 operation->stage = PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS;
7892
Przemek Stekiel51eac532022-12-07 11:04:51 +01007893 return PSA_SUCCESS;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007894exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007895 psa_pake_abort(operation);
7896 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02007897}
7898
7899psa_status_t psa_pake_set_password_key(
7900 psa_pake_operation_t *operation,
7901 mbedtls_svc_key_id_t password)
7902{
Neil Armstrong5ae60962022-09-15 11:29:46 +02007903 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel6c764412022-11-22 14:05:12 +01007904 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
7905 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007906 psa_key_attributes_t attributes;
7907 psa_key_type_t type;
Neil Armstrong5ae60962022-09-15 11:29:46 +02007908
Przemek Stekiel51eac532022-12-07 11:04:51 +01007909 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007910 status = PSA_ERROR_BAD_STATE;
7911 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007912 }
7913
Przemek Stekiel6c764412022-11-22 14:05:12 +01007914 status = psa_get_and_lock_key_slot_with_policy(password, &slot,
7915 PSA_KEY_USAGE_DERIVE,
Przemek Stekield5d28a22023-01-26 10:46:05 +01007916 operation->alg);
Neil Armstrong5ae60962022-09-15 11:29:46 +02007917 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007918 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02007919 }
7920
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007921 attributes = (psa_key_attributes_t) {
Przemek Stekiel6c764412022-11-22 14:05:12 +01007922 .core = slot->attr
7923 };
Neil Armstrong5ae60962022-09-15 11:29:46 +02007924
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007925 type = psa_get_key_type(&attributes);
Neil Armstrong5ae60962022-09-15 11:29:46 +02007926
Przemek Stekiel51eac532022-12-07 11:04:51 +01007927 if (type != PSA_KEY_TYPE_PASSWORD &&
7928 type != PSA_KEY_TYPE_PASSWORD_HASH) {
7929 status = PSA_ERROR_INVALID_ARGUMENT;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007930 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007931 }
7932
Przemek Stekiel51eac532022-12-07 11:04:51 +01007933 operation->data.inputs.password = mbedtls_calloc(1, slot->key.bytes);
7934 if (operation->data.inputs.password == NULL) {
Przemek Stekiele12ed362022-12-21 12:54:46 +01007935 status = PSA_ERROR_INSUFFICIENT_MEMORY;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007936 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007937 }
7938
7939 memcpy(operation->data.inputs.password, slot->key.data, slot->key.bytes);
7940 operation->data.inputs.password_len = slot->key.bytes;
Przemek Stekiel9dd24402023-01-26 15:06:09 +01007941 operation->data.inputs.attributes = attributes;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007942exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007943 if (status != PSA_SUCCESS) {
7944 psa_pake_abort(operation);
7945 }
Ryan Everett1b70a072024-01-04 10:32:49 +00007946 unlock_status = psa_unregister_read(slot);
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007947 return (status == PSA_SUCCESS) ? unlock_status : status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02007948}
7949
7950psa_status_t psa_pake_set_user(
7951 psa_pake_operation_t *operation,
7952 const uint8_t *user_id,
7953 size_t user_id_len)
7954{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007955 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007956
7957 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007958 status = PSA_ERROR_BAD_STATE;
7959 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02007960 }
7961
Przemek Stekiel51eac532022-12-07 11:04:51 +01007962 if (user_id_len == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007963 status = PSA_ERROR_INVALID_ARGUMENT;
7964 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02007965 }
7966
Przemek Stekielf309d6b2023-03-10 09:54:45 +01007967 if (operation->data.inputs.user_len != 0) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007968 status = PSA_ERROR_BAD_STATE;
7969 goto exit;
7970 }
7971
Przemek Stekielf309d6b2023-03-10 09:54:45 +01007972 operation->data.inputs.user = mbedtls_calloc(1, user_id_len);
7973 if (operation->data.inputs.user == NULL) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007974 status = PSA_ERROR_INSUFFICIENT_MEMORY;
7975 goto exit;
7976 }
7977
Przemek Stekielf309d6b2023-03-10 09:54:45 +01007978 memcpy(operation->data.inputs.user, user_id, user_id_len);
7979 operation->data.inputs.user_len = user_id_len;
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007980
7981 return PSA_SUCCESS;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007982exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007983 psa_pake_abort(operation);
7984 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02007985}
7986
7987psa_status_t psa_pake_set_peer(
7988 psa_pake_operation_t *operation,
7989 const uint8_t *peer_id,
7990 size_t peer_id_len)
7991{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007992 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007993
7994 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007995 status = PSA_ERROR_BAD_STATE;
7996 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02007997 }
7998
Przemek Stekiel51eac532022-12-07 11:04:51 +01007999 if (peer_id_len == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008000 status = PSA_ERROR_INVALID_ARGUMENT;
8001 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008002 }
8003
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008004 if (operation->data.inputs.peer_len != 0) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008005 status = PSA_ERROR_BAD_STATE;
8006 goto exit;
8007 }
8008
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008009 operation->data.inputs.peer = mbedtls_calloc(1, peer_id_len);
8010 if (operation->data.inputs.peer == NULL) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008011 status = PSA_ERROR_INSUFFICIENT_MEMORY;
8012 goto exit;
8013 }
8014
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008015 memcpy(operation->data.inputs.peer, peer_id, peer_id_len);
8016 operation->data.inputs.peer_len = peer_id_len;
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008017
8018 return PSA_SUCCESS;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008019exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008020 psa_pake_abort(operation);
8021 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008022}
8023
8024psa_status_t psa_pake_set_role(
8025 psa_pake_operation_t *operation,
8026 psa_pake_role_t role)
8027{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008028 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008029
Przemek Stekiel51eac532022-12-07 11:04:51 +01008030 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008031 status = PSA_ERROR_BAD_STATE;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008032 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008033 }
8034
Przemek Stekiel09104b82023-03-06 14:11:51 +01008035 switch (operation->alg) {
8036#if defined(PSA_WANT_ALG_JPAKE)
8037 case PSA_ALG_JPAKE:
8038 if (role == PSA_PAKE_ROLE_NONE) {
8039 return PSA_SUCCESS;
8040 }
8041 status = PSA_ERROR_INVALID_ARGUMENT;
8042 break;
8043#endif
8044 default:
8045 (void) role;
8046 status = PSA_ERROR_NOT_SUPPORTED;
8047 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008048 }
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008049exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008050 psa_pake_abort(operation);
8051 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008052}
8053
David Horstmanne7f21e62023-05-12 18:17:21 +01008054/* Auxiliary function to convert core computation stage to single driver step. */
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008055#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiel251e86a2023-02-17 14:30:50 +01008056static psa_crypto_driver_pake_step_t convert_jpake_computation_stage_to_driver_step(
Przemek Stekieldde6a912023-01-26 08:46:37 +01008057 psa_jpake_computation_stage_t *stage)
Przemek Stekielb09c4872023-01-17 12:05:38 +01008058{
David Horstmann74a3d8c2023-06-14 18:28:19 +01008059 psa_crypto_driver_pake_step_t key_share_step;
David Horstmann5da95602023-06-08 15:37:12 +01008060 if (stage->round == PSA_JPAKE_FIRST) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008061 int is_x1;
David Horstmann74a3d8c2023-06-14 18:28:19 +01008062
David Horstmann024e5c52023-06-14 15:48:21 +01008063 if (stage->io_mode == PSA_JPAKE_OUTPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008064 is_x1 = (stage->outputs < 1);
8065 } else {
8066 is_x1 = (stage->inputs < 1);
8067 }
8068
David Horstmann74a3d8c2023-06-14 18:28:19 +01008069 key_share_step = is_x1 ?
8070 PSA_JPAKE_X1_STEP_KEY_SHARE :
8071 PSA_JPAKE_X2_STEP_KEY_SHARE;
David Horstmann5da95602023-06-08 15:37:12 +01008072 } else if (stage->round == PSA_JPAKE_SECOND) {
David Horstmann74a3d8c2023-06-14 18:28:19 +01008073 key_share_step = (stage->io_mode == PSA_JPAKE_OUTPUT) ?
8074 PSA_JPAKE_X2S_STEP_KEY_SHARE :
8075 PSA_JPAKE_X4S_STEP_KEY_SHARE;
8076 } else {
8077 return PSA_JPAKE_STEP_INVALID;
Przemek Stekielb09c4872023-01-17 12:05:38 +01008078 }
Agathiyan Bragadeesh387bfa52023-07-17 17:01:33 +01008079 return (psa_crypto_driver_pake_step_t) (key_share_step + stage->step - PSA_PAKE_STEP_KEY_SHARE);
Przemek Stekielb09c4872023-01-17 12:05:38 +01008080}
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008081#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekielb09c4872023-01-17 12:05:38 +01008082
Przemek Stekiel2797d372022-12-22 11:19:22 +01008083static psa_status_t psa_pake_complete_inputs(
8084 psa_pake_operation_t *operation)
8085{
Przemek Stekiel2797d372022-12-22 11:19:22 +01008086 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel18620a32023-01-17 16:34:52 +01008087 /* Create copy of the inputs on stack as inputs share memory
8088 with the driver context which will be setup by the driver. */
8089 psa_crypto_driver_pake_inputs_t inputs = operation->data.inputs;
Przemek Stekiel2797d372022-12-22 11:19:22 +01008090
Przemek Stekielfde11282023-03-13 16:06:09 +01008091 if (inputs.password_len == 0) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01008092 return PSA_ERROR_BAD_STATE;
8093 }
8094
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008095 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekielfde11282023-03-13 16:06:09 +01008096 if (inputs.user_len == 0 || inputs.peer_len == 0) {
8097 return PSA_ERROR_BAD_STATE;
8098 }
Przemek Stekieldff21d32023-02-14 20:09:10 +01008099 }
8100
Przemek Stekiel18620a32023-01-17 16:34:52 +01008101 /* Clear driver context */
8102 mbedtls_platform_zeroize(&operation->data, sizeof(operation->data));
8103
8104 status = psa_driver_wrapper_pake_setup(operation, &inputs);
Przemek Stekiel2797d372022-12-22 11:19:22 +01008105
8106 /* Driver is responsible for creating its own copy of the password. */
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01008107 mbedtls_zeroize_and_free(inputs.password, inputs.password_len);
Przemek Stekiel2797d372022-12-22 11:19:22 +01008108
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008109 /* User and peer are translated to role. */
8110 mbedtls_free(inputs.user);
8111 mbedtls_free(inputs.peer);
8112
Przemek Stekiel2797d372022-12-22 11:19:22 +01008113 if (status == PSA_SUCCESS) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008114#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiel2797d372022-12-22 11:19:22 +01008115 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekield93de322023-02-24 08:39:04 +01008116 operation->stage = PSA_PAKE_OPERATION_STAGE_COMPUTATION;
Przemek Stekiel80a88492023-02-20 13:32:22 +01008117 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008118#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01008119 {
8120 status = PSA_ERROR_NOT_SUPPORTED;
Przemek Stekiel2797d372022-12-22 11:19:22 +01008121 }
Przemek Stekiel2797d372022-12-22 11:19:22 +01008122 }
Przemek Stekiel2797d372022-12-22 11:19:22 +01008123 return status;
8124}
8125
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008126#if defined(PSA_WANT_ALG_JPAKE)
David Horstmanne7f21e62023-05-12 18:17:21 +01008127static psa_status_t psa_jpake_prologue(
Przemek Stekiele12ed362022-12-21 12:54:46 +01008128 psa_pake_operation_t *operation,
David Horstmanne7f21e62023-05-12 18:17:21 +01008129 psa_pake_step_t step,
David Horstmann00ad6bf2023-06-14 15:44:24 +01008130 psa_jpake_io_mode_t io_mode)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008131{
Przemek Stekiele12ed362022-12-21 12:54:46 +01008132 if (step != PSA_PAKE_STEP_KEY_SHARE &&
8133 step != PSA_PAKE_STEP_ZK_PUBLIC &&
8134 step != PSA_PAKE_STEP_ZK_PROOF) {
8135 return PSA_ERROR_INVALID_ARGUMENT;
8136 }
8137
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008138 psa_jpake_computation_stage_t *computation_stage =
8139 &operation->computation_stage.jpake;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008140
David Horstmann5da95602023-06-08 15:37:12 +01008141 if (computation_stage->round != PSA_JPAKE_FIRST &&
8142 computation_stage->round != PSA_JPAKE_SECOND) {
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008143 return PSA_ERROR_BAD_STATE;
8144 }
8145
David Horstmanne7f21e62023-05-12 18:17:21 +01008146 /* Check that the step we are given is the one we were expecting */
8147 if (step != computation_stage->step) {
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008148 return PSA_ERROR_BAD_STATE;
8149 }
8150
David Horstmanne7f21e62023-05-12 18:17:21 +01008151 if (step == PSA_PAKE_STEP_KEY_SHARE &&
8152 computation_stage->inputs == 0 &&
8153 computation_stage->outputs == 0) {
8154 /* Start of the round, so function decides whether we are inputting
8155 * or outputting */
David Horstmann024e5c52023-06-14 15:48:21 +01008156 computation_stage->io_mode = io_mode;
8157 } else if (computation_stage->io_mode != io_mode) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008158 /* Middle of the round so the mode we are in must match the function
8159 * called by the user */
8160 return PSA_ERROR_BAD_STATE;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008161 }
8162
8163 return PSA_SUCCESS;
8164}
8165
David Horstmanne7f21e62023-05-12 18:17:21 +01008166static psa_status_t psa_jpake_epilogue(
8167 psa_pake_operation_t *operation,
David Horstmann00ad6bf2023-06-14 15:44:24 +01008168 psa_jpake_io_mode_t io_mode)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008169{
David Horstmanne7f21e62023-05-12 18:17:21 +01008170 psa_jpake_computation_stage_t *stage =
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008171 &operation->computation_stage.jpake;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008172
David Horstmanne7f21e62023-05-12 18:17:21 +01008173 if (stage->step == PSA_PAKE_STEP_ZK_PROOF) {
8174 /* End of an input/output */
David Horstmann00ad6bf2023-06-14 15:44:24 +01008175 if (io_mode == PSA_JPAKE_INPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008176 stage->inputs++;
David Horstmann246ec5a2023-06-27 10:33:06 +01008177 if (stage->inputs == PSA_JPAKE_EXPECTED_INPUTS(stage->round)) {
David Horstmann024e5c52023-06-14 15:48:21 +01008178 stage->io_mode = PSA_JPAKE_OUTPUT;
David Horstmanne7f21e62023-05-12 18:17:21 +01008179 }
8180 }
David Horstmann00ad6bf2023-06-14 15:44:24 +01008181 if (io_mode == PSA_JPAKE_OUTPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008182 stage->outputs++;
David Horstmann246ec5a2023-06-27 10:33:06 +01008183 if (stage->outputs == PSA_JPAKE_EXPECTED_OUTPUTS(stage->round)) {
David Horstmann024e5c52023-06-14 15:48:21 +01008184 stage->io_mode = PSA_JPAKE_INPUT;
David Horstmanne7f21e62023-05-12 18:17:21 +01008185 }
8186 }
David Horstmann246ec5a2023-06-27 10:33:06 +01008187 if (stage->inputs == PSA_JPAKE_EXPECTED_INPUTS(stage->round) &&
8188 stage->outputs == PSA_JPAKE_EXPECTED_OUTPUTS(stage->round)) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008189 /* End of a round, move to the next round */
8190 stage->inputs = 0;
8191 stage->outputs = 0;
8192 stage->round++;
8193 }
8194 stage->step = PSA_PAKE_STEP_KEY_SHARE;
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008195 } else {
David Horstmanne7f21e62023-05-12 18:17:21 +01008196 stage->step++;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008197 }
Przemek Stekiele12ed362022-12-21 12:54:46 +01008198 return PSA_SUCCESS;
8199}
David Horstmanne7f21e62023-05-12 18:17:21 +01008200
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008201#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008202
Neil Armstronga7d08c32022-06-01 18:21:20 +02008203psa_status_t psa_pake_output(
8204 psa_pake_operation_t *operation,
8205 psa_pake_step_t step,
8206 uint8_t *output,
8207 size_t output_size,
8208 size_t *output_length)
8209{
Przemek Stekiel51eac532022-12-07 11:04:51 +01008210 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008211 psa_crypto_driver_pake_step_t driver_step = PSA_JPAKE_STEP_INVALID;
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008212 *output_length = 0;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008213
8214 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01008215 status = psa_pake_complete_inputs(operation);
8216 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008217 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008218 }
8219 }
8220
8221 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008222 status = PSA_ERROR_BAD_STATE;
8223 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008224 }
8225
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008226 if (output_size == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008227 status = PSA_ERROR_INVALID_ARGUMENT;
8228 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008229 }
8230
Przemek Stekiele12ed362022-12-21 12:54:46 +01008231 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008232#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008233 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008234 status = psa_jpake_prologue(operation, step, PSA_JPAKE_OUTPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008235 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008236 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008237 }
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008238 driver_step = convert_jpake_computation_stage_to_driver_step(
8239 &operation->computation_stage.jpake);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008240 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008241#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008242 default:
Przemek Stekiel80a88492023-02-20 13:32:22 +01008243 (void) step;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008244 status = PSA_ERROR_NOT_SUPPORTED;
8245 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008246 }
8247
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008248 status = psa_driver_wrapper_pake_output(operation, driver_step,
8249 output, output_size, output_length);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008250
8251 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008252 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008253 }
8254
8255 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008256#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008257 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008258 status = psa_jpake_epilogue(operation, PSA_JPAKE_OUTPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008259 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008260 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008261 }
8262 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008263#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008264 default:
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008265 status = PSA_ERROR_NOT_SUPPORTED;
8266 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008267 }
8268
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008269 return PSA_SUCCESS;
8270exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008271 psa_pake_abort(operation);
8272 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008273}
8274
8275psa_status_t psa_pake_input(
8276 psa_pake_operation_t *operation,
8277 psa_pake_step_t step,
8278 const uint8_t *input,
8279 size_t input_length)
8280{
Przemek Stekiel51eac532022-12-07 11:04:51 +01008281 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008282 psa_crypto_driver_pake_step_t driver_step = PSA_JPAKE_STEP_INVALID;
Przemek Stekiel256c75d2023-03-23 14:09:34 +01008283 const size_t max_input_length = (size_t) PSA_PAKE_INPUT_SIZE(operation->alg,
8284 operation->primitive,
8285 step);
Przemek Stekiel51eac532022-12-07 11:04:51 +01008286
8287 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01008288 status = psa_pake_complete_inputs(operation);
8289 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008290 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008291 }
8292 }
8293
8294 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008295 status = PSA_ERROR_BAD_STATE;
8296 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008297 }
8298
Przemek Stekiel256c75d2023-03-23 14:09:34 +01008299 if (input_length == 0 || input_length > max_input_length) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008300 status = PSA_ERROR_INVALID_ARGUMENT;
8301 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008302 }
8303
Przemek Stekiele12ed362022-12-21 12:54:46 +01008304 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008305#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008306 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008307 status = psa_jpake_prologue(operation, step, PSA_JPAKE_INPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008308 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008309 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008310 }
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008311 driver_step = convert_jpake_computation_stage_to_driver_step(
8312 &operation->computation_stage.jpake);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008313 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008314#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008315 default:
Przemek Stekiel80a88492023-02-20 13:32:22 +01008316 (void) step;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008317 status = PSA_ERROR_NOT_SUPPORTED;
8318 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008319 }
8320
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008321 status = psa_driver_wrapper_pake_input(operation, driver_step,
8322 input, input_length);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008323
8324 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008325 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008326 }
8327
8328 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008329#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008330 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008331 status = psa_jpake_epilogue(operation, PSA_JPAKE_INPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008332 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008333 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008334 }
8335 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008336#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008337 default:
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008338 status = PSA_ERROR_NOT_SUPPORTED;
8339 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008340 }
8341
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008342 return PSA_SUCCESS;
8343exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008344 psa_pake_abort(operation);
8345 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008346}
8347
8348psa_status_t psa_pake_get_implicit_key(
8349 psa_pake_operation_t *operation,
8350 psa_key_derivation_operation_t *output)
8351{
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008352 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008353 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel251e86a2023-02-17 14:30:50 +01008354 uint8_t shared_key[MBEDTLS_PSA_JPAKE_BUFFER_SIZE];
Przemek Stekiel0c781802022-11-29 14:53:13 +01008355 size_t shared_key_len = 0;
8356
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008357 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008358 status = PSA_ERROR_BAD_STATE;
8359 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008360 }
8361
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008362#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008363 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008364 psa_jpake_computation_stage_t *computation_stage =
Przemek Stekiel083745e2023-02-23 17:28:23 +01008365 &operation->computation_stage.jpake;
David Horstmann5da95602023-06-08 15:37:12 +01008366 if (computation_stage->round != PSA_JPAKE_FINISHED) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008367 status = PSA_ERROR_BAD_STATE;
8368 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008369 }
Przemek Stekiel80a88492023-02-20 13:32:22 +01008370 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008371#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01008372 {
8373 status = PSA_ERROR_NOT_SUPPORTED;
8374 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008375 }
8376
Przemek Stekiel0c781802022-11-29 14:53:13 +01008377 status = psa_driver_wrapper_pake_get_implicit_key(operation,
8378 shared_key,
Przemek Stekiel6b648622023-02-19 22:55:33 +01008379 sizeof(shared_key),
Przemek Stekiel0c781802022-11-29 14:53:13 +01008380 &shared_key_len);
8381
8382 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008383 goto exit;
Przemek Stekiel0c781802022-11-29 14:53:13 +01008384 }
8385
8386 status = psa_key_derivation_input_bytes(output,
8387 PSA_KEY_DERIVATION_INPUT_SECRET,
8388 shared_key,
8389 shared_key_len);
8390
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008391 mbedtls_platform_zeroize(shared_key, sizeof(shared_key));
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008392exit:
8393 abort_status = psa_pake_abort(operation);
8394 return status == PSA_SUCCESS ? abort_status : status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008395}
8396
8397psa_status_t psa_pake_abort(
8398 psa_pake_operation_t *operation)
8399{
Przemek Stekield69dca92023-01-31 19:59:20 +01008400 psa_status_t status = PSA_SUCCESS;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008401
Przemek Stekield69dca92023-01-31 19:59:20 +01008402 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008403 status = psa_driver_wrapper_pake_abort(operation);
Neil Armstrong5ae60962022-09-15 11:29:46 +02008404 }
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008405
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008406 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
8407 if (operation->data.inputs.password != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01008408 mbedtls_zeroize_and_free(operation->data.inputs.password,
Przemek Stekielaa183422023-03-06 14:21:44 +01008409 operation->data.inputs.password_len);
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008410 }
8411 if (operation->data.inputs.user != NULL) {
8412 mbedtls_free(operation->data.inputs.user);
8413 }
8414 if (operation->data.inputs.peer != NULL) {
8415 mbedtls_free(operation->data.inputs.peer);
8416 }
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008417 }
Przemek Stekield69dca92023-01-31 19:59:20 +01008418 memset(operation, 0, sizeof(psa_pake_operation_t));
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008419
Przemek Stekield69dca92023-01-31 19:59:20 +01008420 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008421}
Tom Cosgrove6d62fac2023-05-10 14:40:05 +01008422#endif /* PSA_WANT_ALG_SOME_PAKE */
Neil Armstronga7d08c32022-06-01 18:21:20 +02008423
Gilles Peskinee59236f2018-01-27 23:32:46 +01008424#endif /* MBEDTLS_PSA_CRYPTO_C */