blob: a0e58a27120d0f8dff4d82bb480c79c745f39e09 [file] [log] [blame]
Gilles Peskinee59236f2018-01-27 23:32:46 +01001/*
2 * PSA crypto layer on top of Mbed TLS crypto
3 */
Bence Szépkúti86974652020-06-15 11:59:37 +02004/*
Bence Szépkúti1e148272020-08-07 13:07:28 +02005 * Copyright The Mbed TLS Contributors
Dave Rodgman16799db2023-11-02 19:47:20 +00006 * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
Gilles Peskinee59236f2018-01-27 23:32:46 +01007 */
8
Gilles Peskinedb09ef62020-06-03 01:43:33 +02009#include "common.h"
Ronald Cronafbc7ed2023-01-24 16:02:04 +010010#include "psa_crypto_core_common.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010011
12#if defined(MBEDTLS_PSA_CRYPTO_C)
mohammad160327010052018-07-03 13:16:15 +030013
John Durkop07cc04a2020-11-16 22:08:34 -080014#if defined(MBEDTLS_PSA_CRYPTO_CONFIG)
15#include "check_crypto_config.h"
16#endif
17
Gilles Peskinee59236f2018-01-27 23:32:46 +010018#include "psa/crypto.h"
Przemyslaw Stekiel705fb0f2021-11-24 08:47:29 +010019#include "psa/crypto_values.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010020
Ronald Crond6d28882020-12-14 14:56:02 +010021#include "psa_crypto_cipher.h"
Gilles Peskine039b90c2018-12-07 18:24:41 +010022#include "psa_crypto_core.h"
Gilles Peskine5e769522018-11-20 21:59:56 +010023#include "psa_crypto_invasive.h"
Xiaokang Qiane9c39c42023-08-09 08:50:19 +000024#include "psa_crypto_driver_wrappers.h"
Xiaokang Qianfe9666b2023-09-11 10:36:20 +000025#include "psa_crypto_driver_wrappers_no_static.h"
Ronald Cron00b7bfc2020-11-25 15:25:26 +010026#include "psa_crypto_ecp.h"
Przemek Stekiel359f4622022-12-05 14:11:55 +010027#include "psa_crypto_ffdh.h"
Steven Cooreman5f88e772021-03-15 11:07:12 +010028#include "psa_crypto_hash.h"
Steven Cooreman82c66b62021-03-19 17:39:17 +010029#include "psa_crypto_mac.h"
Ronald Cron00b7bfc2020-11-25 15:25:26 +010030#include "psa_crypto_rsa.h"
Ronald Cron7023db52020-11-20 18:17:42 +010031#include "psa_crypto_ecp.h"
Gilles Peskinea8ade162019-06-26 11:24:49 +020032#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined0890212019-06-24 14:34:43 +020033#include "psa_crypto_se.h"
Gilles Peskinea8ade162019-06-26 11:24:49 +020034#endif
Gilles Peskine961849f2018-11-30 18:54:54 +010035#include "psa_crypto_slot_management.h"
Darryl Greend49a4992018-06-18 17:27:26 +010036/* Include internal declarations that are useful for implementing persistently
37 * stored keys. */
38#include "psa_crypto_storage.h"
39
Gilles Peskineb2b64d32020-12-14 16:43:58 +010040#include "psa_crypto_random_impl.h"
Gilles Peskine90edc992020-11-13 15:39:19 +010041
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010042#include <stdlib.h>
43#include <string.h>
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010044#include "mbedtls/platform.h"
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010045
Gilles Peskine1c49f1a2020-11-13 18:46:25 +010046#include "mbedtls/aes.h"
Gilles Peskine9a944802018-06-21 09:35:35 +020047#include "mbedtls/asn1.h"
Jaeden Amero25384a22019-01-10 10:23:21 +000048#include "mbedtls/asn1write.h"
Gilles Peskinea81d85b2018-06-26 16:10:23 +020049#include "mbedtls/bignum.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010050#include "mbedtls/camellia.h"
Gilles Peskine26869f22019-05-06 15:25:00 +020051#include "mbedtls/chacha20.h"
52#include "mbedtls/chachapoly.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010053#include "mbedtls/cipher.h"
54#include "mbedtls/ccm.h"
55#include "mbedtls/cmac.h"
Dave Rodgman78701152023-08-29 14:20:18 +010056#include "mbedtls/constant_time.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010057#include "mbedtls/des.h"
Gilles Peskineb7ecdf02018-09-18 12:11:27 +020058#include "mbedtls/ecdh.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010059#include "mbedtls/ecp.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010060#include "mbedtls/entropy.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010061#include "mbedtls/error.h"
62#include "mbedtls/gcm.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010063#include "mbedtls/md5.h"
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010064#include "mbedtls/pk.h"
Chris Jonesdaacb592021-03-09 17:03:29 +000065#include "pk_wrap.h"
Gilles Peskine3f108122018-12-07 18:14:53 +010066#include "mbedtls/platform_util.h"
Janos Follath24eed8d2019-11-22 13:21:35 +000067#include "mbedtls/error.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010068#include "mbedtls/ripemd160.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010069#include "mbedtls/rsa.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010070#include "mbedtls/sha1.h"
71#include "mbedtls/sha256.h"
72#include "mbedtls/sha512.h"
Valerio Setti384fbde2024-01-02 13:26:40 +010073#include "mbedtls/psa_util.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010074
Przemek Stekiel75fe3fb2022-06-09 14:44:55 +020075#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF) || \
76 defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT) || \
77 defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Przemek Stekiel69c46792022-06-10 12:59:51 +020078#define BUILTIN_ALG_ANY_HKDF 1
Przemek Stekiel75fe3fb2022-06-09 14:44:55 +020079#endif
80
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010081/****************************************************************/
82/* Global data, support functions and library management */
83/****************************************************************/
84
Gilles Peskine449bd832023-01-11 14:50:10 +010085static int key_type_is_raw_bytes(psa_key_type_t type)
Gilles Peskine48c0ea12018-06-21 14:15:31 +020086{
Gilles Peskine449bd832023-01-11 14:50:10 +010087 return PSA_KEY_TYPE_IS_UNSTRUCTURED(type);
Gilles Peskine48c0ea12018-06-21 14:15:31 +020088}
89
Gilles Peskine5a3c50e2018-12-04 12:27:09 +010090/* Values for psa_global_data_t::rng_state */
91#define RNG_NOT_INITIALIZED 0
92#define RNG_INITIALIZED 1
93#define RNG_SEEDED 2
Gilles Peskinec6b69072018-11-20 21:42:52 +010094
Gilles Peskine449bd832023-01-11 14:50:10 +010095typedef struct {
Dave Rodgman864f5942023-08-16 18:04:44 +010096 uint8_t initialized;
97 uint8_t rng_state;
98 uint8_t drivers_initialized;
Gilles Peskine2d8a1822021-11-08 22:20:03 +010099 mbedtls_psa_random_context_t rng;
Gilles Peskinee59236f2018-01-27 23:32:46 +0100100} psa_global_data_t;
101
102static psa_global_data_t global_data;
103
Gilles Peskine5894e8e2020-12-14 14:54:06 +0100104#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
105mbedtls_psa_drbg_context_t *const mbedtls_psa_random_state =
106 &global_data.rng.drbg;
107#endif
108
itayzafrir0adf0fc2018-09-06 16:24:41 +0300109#define GUARD_MODULE_INITIALIZED \
Gilles Peskine449bd832023-01-11 14:50:10 +0100110 if (global_data.initialized == 0) \
111 return PSA_ERROR_BAD_STATE;
itayzafrir0adf0fc2018-09-06 16:24:41 +0300112
Manuel Pégourié-Gonnard7abdf7e2023-03-09 11:17:43 +0100113int psa_can_do_hash(psa_algorithm_t hash_alg)
114{
115 (void) hash_alg;
116 return global_data.drivers_initialized;
117}
Valerio Settic6f004f2023-12-12 11:27:36 +0100118
Valerio Setti1fff4f22023-12-28 14:19:34 +0100119int psa_can_do_cipher(psa_key_type_t key_type, psa_algorithm_t cipher_alg)
Valerio Settic6f004f2023-12-12 11:27:36 +0100120{
Valerio Setti1fff4f22023-12-28 14:19:34 +0100121 (void) key_type;
Valerio Settic6f004f2023-12-12 11:27:36 +0100122 (void) cipher_alg;
123 return global_data.drivers_initialized;
124}
125
126
Valerio Settia55f0422023-07-10 15:34:41 +0200127#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_IMPORT) || \
Przemek Stekiel53410502023-04-28 13:18:43 +0200128 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY) || \
Valerio Settia55f0422023-07-10 15:34:41 +0200129 defined(PSA_WANT_KEY_TYPE_DH_KEY_PAIR_GENERATE)
Przemek Stekiel134cc2e2023-05-05 10:13:37 +0200130static int psa_is_dh_key_size_valid(size_t bits)
131{
Valerio Setti504a1022024-01-17 15:19:30 +0100132 switch (bits) {
133#if defined(PSA_WANT_DH_RFC7919_2048)
134 case 2048:
135 return 1;
136#endif /* PSA_WANT_DH_RFC7919_2048 */
137#if defined(PSA_WANT_DH_RFC7919_3072)
138 case 3072:
139 return 1;
140#endif /* PSA_WANT_DH_RFC7919_3072 */
141#if defined(PSA_WANT_DH_RFC7919_4096)
142 case 4096:
143 return 1;
144#endif /* PSA_WANT_DH_RFC7919_4096 */
145#if defined(PSA_WANT_DH_RFC7919_6144)
146 case 6144:
147 return 1;
148#endif /* PSA_WANT_DH_RFC7919_6144 */
149#if defined(PSA_WANT_DH_RFC7919_8192)
150 case 8192:
151 return 1;
152#endif /* PSA_WANT_DH_RFC7919_8192 */
153 default:
154 return 0;
Przemek Stekield1cf1ba2023-04-27 12:04:21 +0200155 }
Przemek Stekield1cf1ba2023-04-27 12:04:21 +0200156}
Valerio Settia55f0422023-07-10 15:34:41 +0200157#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_IMPORT ||
Przemek Stekiel53410502023-04-28 13:18:43 +0200158 MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY ||
Valerio Settia55f0422023-07-10 15:34:41 +0200159 PSA_WANT_KEY_TYPE_DH_KEY_PAIR_GENERATE */
Manuel Pégourié-Gonnard7abdf7e2023-03-09 11:17:43 +0100160
Gilles Peskine449bd832023-01-11 14:50:10 +0100161psa_status_t mbedtls_to_psa_error(int ret)
Gilles Peskinee59236f2018-01-27 23:32:46 +0100162{
Gilles Peskinedbf68962021-01-06 20:04:23 +0100163 /* Mbed TLS error codes can combine a high-level error code and a
164 * low-level error code. The low-level error usually reflects the
165 * root cause better, so dispatch on that preferably. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100166 int low_level_ret = -(-ret & 0x007f);
167 switch (low_level_ret != 0 ? low_level_ret : ret) {
Gilles Peskinee59236f2018-01-27 23:32:46 +0100168 case 0:
Gilles Peskine449bd832023-01-11 14:50:10 +0100169 return PSA_SUCCESS;
Gilles Peskinea5905292018-02-07 20:59:33 +0100170
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100171#if defined(MBEDTLS_AES_C)
Gilles Peskinea5905292018-02-07 20:59:33 +0100172 case MBEDTLS_ERR_AES_INVALID_KEY_LENGTH:
173 case MBEDTLS_ERR_AES_INVALID_INPUT_LENGTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100174 return PSA_ERROR_NOT_SUPPORTED;
Dave Rodgman09a9e582023-08-31 11:05:22 +0100175 case MBEDTLS_ERR_AES_BAD_INPUT_DATA:
176 return PSA_ERROR_INVALID_ARGUMENT;
Dave Rodgman509b5672023-08-16 19:26:23 +0100177#endif
178
179#if defined(MBEDTLS_ASN1_PARSE_C) || defined(MBEDTLS_ASN1_WRITE_C)
Gilles Peskine9a944802018-06-21 09:35:35 +0200180 case MBEDTLS_ERR_ASN1_OUT_OF_DATA:
181 case MBEDTLS_ERR_ASN1_UNEXPECTED_TAG:
182 case MBEDTLS_ERR_ASN1_INVALID_LENGTH:
183 case MBEDTLS_ERR_ASN1_LENGTH_MISMATCH:
184 case MBEDTLS_ERR_ASN1_INVALID_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100185 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine9a944802018-06-21 09:35:35 +0200186 case MBEDTLS_ERR_ASN1_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100187 return PSA_ERROR_INSUFFICIENT_MEMORY;
Gilles Peskine9a944802018-06-21 09:35:35 +0200188 case MBEDTLS_ERR_ASN1_BUF_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +0100189 return PSA_ERROR_BUFFER_TOO_SMALL;
Dave Rodgman509b5672023-08-16 19:26:23 +0100190#endif
Gilles Peskine9a944802018-06-21 09:35:35 +0200191
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100192#if defined(MBEDTLS_CAMELLIA_C)
Jaeden Amero892cd6d2019-02-11 12:21:12 +0000193 case MBEDTLS_ERR_CAMELLIA_BAD_INPUT_DATA:
Gilles Peskinea5905292018-02-07 20:59:33 +0100194 case MBEDTLS_ERR_CAMELLIA_INVALID_INPUT_LENGTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100195 return PSA_ERROR_NOT_SUPPORTED;
Dave Rodgman509b5672023-08-16 19:26:23 +0100196#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100197
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100198#if defined(MBEDTLS_CCM_C)
Gilles Peskinea5905292018-02-07 20:59:33 +0100199 case MBEDTLS_ERR_CCM_BAD_INPUT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100200 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100201 case MBEDTLS_ERR_CCM_AUTH_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100202 return PSA_ERROR_INVALID_SIGNATURE;
Dave Rodgman509b5672023-08-16 19:26:23 +0100203#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100204
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100205#if defined(MBEDTLS_CHACHA20_C)
Gilles Peskine26869f22019-05-06 15:25:00 +0200206 case MBEDTLS_ERR_CHACHA20_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100207 return PSA_ERROR_INVALID_ARGUMENT;
Dave Rodgman509b5672023-08-16 19:26:23 +0100208#endif
Gilles Peskine26869f22019-05-06 15:25:00 +0200209
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100210#if defined(MBEDTLS_CHACHAPOLY_C)
Gilles Peskine26869f22019-05-06 15:25:00 +0200211 case MBEDTLS_ERR_CHACHAPOLY_BAD_STATE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100212 return PSA_ERROR_BAD_STATE;
Gilles Peskine26869f22019-05-06 15:25:00 +0200213 case MBEDTLS_ERR_CHACHAPOLY_AUTH_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100214 return PSA_ERROR_INVALID_SIGNATURE;
Dave Rodgman509b5672023-08-16 19:26:23 +0100215#endif
Gilles Peskine26869f22019-05-06 15:25:00 +0200216
Dave Rodgman509b5672023-08-16 19:26:23 +0100217#if defined(MBEDTLS_CIPHER_C)
Gilles Peskinea5905292018-02-07 20:59:33 +0100218 case MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100219 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea5905292018-02-07 20:59:33 +0100220 case MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100221 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100222 case MBEDTLS_ERR_CIPHER_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100223 return PSA_ERROR_INSUFFICIENT_MEMORY;
Gilles Peskinea5905292018-02-07 20:59:33 +0100224 case MBEDTLS_ERR_CIPHER_INVALID_PADDING:
Gilles Peskine449bd832023-01-11 14:50:10 +0100225 return PSA_ERROR_INVALID_PADDING;
Gilles Peskinea5905292018-02-07 20:59:33 +0100226 case MBEDTLS_ERR_CIPHER_FULL_BLOCK_EXPECTED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100227 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100228 case MBEDTLS_ERR_CIPHER_AUTH_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100229 return PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskinea5905292018-02-07 20:59:33 +0100230 case MBEDTLS_ERR_CIPHER_INVALID_CONTEXT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100231 return PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman509b5672023-08-16 19:26:23 +0100232#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100233
Gilles Peskine449bd832023-01-11 14:50:10 +0100234#if !(defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) || \
235 defined(MBEDTLS_PSA_HMAC_DRBG_MD_TYPE))
Gilles Peskinebee96c82020-11-23 21:00:09 +0100236 /* Only check CTR_DRBG error codes if underlying mbedtls_xxx
237 * functions are passed a CTR_DRBG instance. */
Gilles Peskinea5905292018-02-07 20:59:33 +0100238 case MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100239 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskinea5905292018-02-07 20:59:33 +0100240 case MBEDTLS_ERR_CTR_DRBG_REQUEST_TOO_BIG:
241 case MBEDTLS_ERR_CTR_DRBG_INPUT_TOO_BIG:
Gilles Peskine449bd832023-01-11 14:50:10 +0100242 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea5905292018-02-07 20:59:33 +0100243 case MBEDTLS_ERR_CTR_DRBG_FILE_IO_ERROR:
Gilles Peskine449bd832023-01-11 14:50:10 +0100244 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskine82e57d12020-11-13 21:31:17 +0100245#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100246
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100247#if defined(MBEDTLS_DES_C)
Gilles Peskinea5905292018-02-07 20:59:33 +0100248 case MBEDTLS_ERR_DES_INVALID_INPUT_LENGTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100249 return PSA_ERROR_NOT_SUPPORTED;
Dave Rodgman509b5672023-08-16 19:26:23 +0100250#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100251
Gilles Peskinee59236f2018-01-27 23:32:46 +0100252 case MBEDTLS_ERR_ENTROPY_NO_SOURCES_DEFINED:
253 case MBEDTLS_ERR_ENTROPY_NO_STRONG_SOURCE:
254 case MBEDTLS_ERR_ENTROPY_SOURCE_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100255 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskinea5905292018-02-07 20:59:33 +0100256
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100257#if defined(MBEDTLS_GCM_C)
Gilles Peskinea5905292018-02-07 20:59:33 +0100258 case MBEDTLS_ERR_GCM_AUTH_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100259 return PSA_ERROR_INVALID_SIGNATURE;
Mateusz Starzykf28261f2021-09-30 16:39:07 +0200260 case MBEDTLS_ERR_GCM_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +0100261 return PSA_ERROR_BUFFER_TOO_SMALL;
Gilles Peskinea5905292018-02-07 20:59:33 +0100262 case MBEDTLS_ERR_GCM_BAD_INPUT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100263 return PSA_ERROR_INVALID_ARGUMENT;
Dave Rodgman509b5672023-08-16 19:26:23 +0100264#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100265
Gilles Peskine82e57d12020-11-13 21:31:17 +0100266#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) && \
Gilles Peskine449bd832023-01-11 14:50:10 +0100267 defined(MBEDTLS_PSA_HMAC_DRBG_MD_TYPE)
Gilles Peskinebee96c82020-11-23 21:00:09 +0100268 /* Only check HMAC_DRBG error codes if underlying mbedtls_xxx
269 * functions are passed a HMAC_DRBG instance. */
Gilles Peskine82e57d12020-11-13 21:31:17 +0100270 case MBEDTLS_ERR_HMAC_DRBG_ENTROPY_SOURCE_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100271 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskine82e57d12020-11-13 21:31:17 +0100272 case MBEDTLS_ERR_HMAC_DRBG_REQUEST_TOO_BIG:
273 case MBEDTLS_ERR_HMAC_DRBG_INPUT_TOO_BIG:
Gilles Peskine449bd832023-01-11 14:50:10 +0100274 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine82e57d12020-11-13 21:31:17 +0100275 case MBEDTLS_ERR_HMAC_DRBG_FILE_IO_ERROR:
Gilles Peskine449bd832023-01-11 14:50:10 +0100276 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskine82e57d12020-11-13 21:31:17 +0100277#endif
278
Dave Rodgmandea266f2023-08-31 11:52:43 +0100279#if defined(MBEDTLS_MD_LIGHT)
Gilles Peskinea5905292018-02-07 20:59:33 +0100280 case MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100281 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea5905292018-02-07 20:59:33 +0100282 case MBEDTLS_ERR_MD_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100283 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100284 case MBEDTLS_ERR_MD_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100285 return PSA_ERROR_INSUFFICIENT_MEMORY;
Dave Rodgman509b5672023-08-16 19:26:23 +0100286#if defined(MBEDTLS_FS_IO)
Gilles Peskinea5905292018-02-07 20:59:33 +0100287 case MBEDTLS_ERR_MD_FILE_IO_ERROR:
Gilles Peskine449bd832023-01-11 14:50:10 +0100288 return PSA_ERROR_STORAGE_FAILURE;
Dave Rodgman509b5672023-08-16 19:26:23 +0100289#endif
290#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100291
Dave Rodgman509b5672023-08-16 19:26:23 +0100292#if defined(MBEDTLS_BIGNUM_C)
293#if defined(MBEDTLS_FS_IO)
Gilles Peskinef76aa772018-10-29 19:24:33 +0100294 case MBEDTLS_ERR_MPI_FILE_IO_ERROR:
Gilles Peskine449bd832023-01-11 14:50:10 +0100295 return PSA_ERROR_STORAGE_FAILURE;
Dave Rodgman509b5672023-08-16 19:26:23 +0100296#endif
Gilles Peskinef76aa772018-10-29 19:24:33 +0100297 case MBEDTLS_ERR_MPI_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100298 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100299 case MBEDTLS_ERR_MPI_INVALID_CHARACTER:
Gilles Peskine449bd832023-01-11 14:50:10 +0100300 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100301 case MBEDTLS_ERR_MPI_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +0100302 return PSA_ERROR_BUFFER_TOO_SMALL;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100303 case MBEDTLS_ERR_MPI_NEGATIVE_VALUE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100304 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100305 case MBEDTLS_ERR_MPI_DIVISION_BY_ZERO:
Gilles Peskine449bd832023-01-11 14:50:10 +0100306 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100307 case MBEDTLS_ERR_MPI_NOT_ACCEPTABLE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100308 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100309 case MBEDTLS_ERR_MPI_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100310 return PSA_ERROR_INSUFFICIENT_MEMORY;
Dave Rodgman509b5672023-08-16 19:26:23 +0100311#endif
Gilles Peskinef76aa772018-10-29 19:24:33 +0100312
Dave Rodgman509b5672023-08-16 19:26:23 +0100313#if defined(MBEDTLS_PK_C)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100314 case MBEDTLS_ERR_PK_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100315 return PSA_ERROR_INSUFFICIENT_MEMORY;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100316 case MBEDTLS_ERR_PK_TYPE_MISMATCH:
317 case MBEDTLS_ERR_PK_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100318 return PSA_ERROR_INVALID_ARGUMENT;
Dave Rodgman509b5672023-08-16 19:26:23 +0100319#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) || defined(MBEDTLS_FS_IO) || \
320 defined(MBEDTLS_PSA_ITS_FILE_C)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100321 case MBEDTLS_ERR_PK_FILE_IO_ERROR:
Gilles Peskine449bd832023-01-11 14:50:10 +0100322 return PSA_ERROR_STORAGE_FAILURE;
Dave Rodgman509b5672023-08-16 19:26:23 +0100323#endif
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100324 case MBEDTLS_ERR_PK_KEY_INVALID_VERSION:
325 case MBEDTLS_ERR_PK_KEY_INVALID_FORMAT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100326 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100327 case MBEDTLS_ERR_PK_UNKNOWN_PK_ALG:
Gilles Peskine449bd832023-01-11 14:50:10 +0100328 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100329 case MBEDTLS_ERR_PK_PASSWORD_REQUIRED:
330 case MBEDTLS_ERR_PK_PASSWORD_MISMATCH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100331 return PSA_ERROR_NOT_PERMITTED;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100332 case MBEDTLS_ERR_PK_INVALID_PUBKEY:
Gilles Peskine449bd832023-01-11 14:50:10 +0100333 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100334 case MBEDTLS_ERR_PK_INVALID_ALG:
335 case MBEDTLS_ERR_PK_UNKNOWN_NAMED_CURVE:
336 case MBEDTLS_ERR_PK_FEATURE_UNAVAILABLE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100337 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100338 case MBEDTLS_ERR_PK_SIG_LEN_MISMATCH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100339 return PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskinef9f1bdf2021-06-23 20:32:27 +0200340 case MBEDTLS_ERR_PK_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +0100341 return PSA_ERROR_BUFFER_TOO_SMALL;
Dave Rodgman509b5672023-08-16 19:26:23 +0100342#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100343
Gilles Peskineff2d2002019-05-06 15:26:23 +0200344 case MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100345 return PSA_ERROR_HARDWARE_FAILURE;
Gilles Peskineff2d2002019-05-06 15:26:23 +0200346 case MBEDTLS_ERR_PLATFORM_FEATURE_UNSUPPORTED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100347 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskineff2d2002019-05-06 15:26:23 +0200348
Dave Rodgman509b5672023-08-16 19:26:23 +0100349#if defined(MBEDTLS_RSA_C)
Gilles Peskinea5905292018-02-07 20:59:33 +0100350 case MBEDTLS_ERR_RSA_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100351 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100352 case MBEDTLS_ERR_RSA_INVALID_PADDING:
Gilles Peskine449bd832023-01-11 14:50:10 +0100353 return PSA_ERROR_INVALID_PADDING;
Gilles Peskinea5905292018-02-07 20:59:33 +0100354 case MBEDTLS_ERR_RSA_KEY_GEN_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100355 return PSA_ERROR_HARDWARE_FAILURE;
Gilles Peskinea5905292018-02-07 20:59:33 +0100356 case MBEDTLS_ERR_RSA_KEY_CHECK_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100357 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100358 case MBEDTLS_ERR_RSA_PUBLIC_FAILED:
359 case MBEDTLS_ERR_RSA_PRIVATE_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100360 return PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinea5905292018-02-07 20:59:33 +0100361 case MBEDTLS_ERR_RSA_VERIFY_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100362 return PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskinea5905292018-02-07 20:59:33 +0100363 case MBEDTLS_ERR_RSA_OUTPUT_TOO_LARGE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100364 return PSA_ERROR_BUFFER_TOO_SMALL;
Gilles Peskinea5905292018-02-07 20:59:33 +0100365 case MBEDTLS_ERR_RSA_RNG_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100366 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Dave Rodgman509b5672023-08-16 19:26:23 +0100367#endif
Manuel Pégourié-Gonnard93c08472021-04-15 12:23:55 +0200368
Dave Rodgman1dab4452023-09-01 09:59:51 +0100369#if defined(MBEDTLS_ECP_LIGHT)
itayzafrir5c753392018-05-08 11:18:38 +0300370 case MBEDTLS_ERR_ECP_BAD_INPUT_DATA:
itayzafrir7b30f8b2018-05-09 16:07:36 +0300371 case MBEDTLS_ERR_ECP_INVALID_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +0100372 return PSA_ERROR_INVALID_ARGUMENT;
itayzafrir7b30f8b2018-05-09 16:07:36 +0300373 case MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +0100374 return PSA_ERROR_BUFFER_TOO_SMALL;
itayzafrir7b30f8b2018-05-09 16:07:36 +0300375 case MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100376 return PSA_ERROR_NOT_SUPPORTED;
itayzafrir7b30f8b2018-05-09 16:07:36 +0300377 case MBEDTLS_ERR_ECP_SIG_LEN_MISMATCH:
378 case MBEDTLS_ERR_ECP_VERIFY_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100379 return PSA_ERROR_INVALID_SIGNATURE;
itayzafrir7b30f8b2018-05-09 16:07:36 +0300380 case MBEDTLS_ERR_ECP_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100381 return PSA_ERROR_INSUFFICIENT_MEMORY;
Gilles Peskine40d81602020-11-25 00:09:47 +0100382 case MBEDTLS_ERR_ECP_RANDOM_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100383 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskine40d81602020-11-25 00:09:47 +0100384
Dave Rodgman509b5672023-08-16 19:26:23 +0100385#if defined(MBEDTLS_ECP_RESTARTABLE)
Paul Elliott588f8ed2022-12-02 18:10:26 +0000386 case MBEDTLS_ERR_ECP_IN_PROGRESS:
387 return PSA_OPERATION_INCOMPLETE;
Dave Rodgman509b5672023-08-16 19:26:23 +0100388#endif
389#endif
Paul Elliott588f8ed2022-12-02 18:10:26 +0000390
Janos Follatha13b9052019-11-22 12:48:59 +0000391 case MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100392 return PSA_ERROR_CORRUPTION_DETECTED;
itayzafrir5c753392018-05-08 11:18:38 +0300393
Gilles Peskinee59236f2018-01-27 23:32:46 +0100394 default:
Gilles Peskine449bd832023-01-11 14:50:10 +0100395 return PSA_ERROR_GENERIC_ERROR;
Gilles Peskinee59236f2018-01-27 23:32:46 +0100396 }
397}
398
Paul Elliottdc42ca82023-02-24 18:11:59 +0000399/**
400 * \brief For output buffers which contain "tags"
401 * (outputs that may be checked for validity like
402 * hashes, MACs and signatures), fill the unused
403 * part of the output buffer (the whole buffer on
404 * error, the trailing part on success) with
405 * something that isn't a valid tag (barring an
406 * attack on the tag and deliberately-crafted
407 * input), in case the caller doesn't check the
408 * return status properly.
409 *
410 * \param output_buffer Pointer to buffer to wipe. May not be NULL
411 * unless \p output_buffer_size is zero.
412 * \param status Status of function called to generate
413 * output_buffer originally
414 * \param output_buffer_size Size of output buffer. If zero, \p output_buffer
415 * could be NULL.
416 * \param output_buffer_length Length of data written to output_buffer, must be
417 * less than \p output_buffer_size
418 */
419static void psa_wipe_tag_output_buffer(uint8_t *output_buffer, psa_status_t status,
Paul Elliott7118d172023-02-26 16:57:05 +0000420 size_t output_buffer_size, size_t output_buffer_length)
421{
Paul Elliottdc42ca82023-02-24 18:11:59 +0000422 size_t offset = 0;
423
424 if (output_buffer_size == 0) {
425 /* If output_buffer_size is 0 then we have nothing to do. We must not
426 call memset because output_buffer may be NULL in this case */
427 return;
428 }
429
430 if (status == PSA_SUCCESS) {
431 offset = output_buffer_length;
432 }
433
434 memset(output_buffer + offset, '!', output_buffer_size - offset);
435}
436
Gilles Peskineb0b255c2018-07-06 17:01:38 +0200437
Gilles Peskine449bd832023-01-11 14:50:10 +0100438psa_status_t psa_validate_unstructured_key_bit_size(psa_key_type_t type,
439 size_t bits)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200440{
441 /* Check that the bit size is acceptable for the key type */
Gilles Peskine449bd832023-01-11 14:50:10 +0100442 switch (type) {
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200443 case PSA_KEY_TYPE_RAW_DATA:
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200444 case PSA_KEY_TYPE_HMAC:
Gilles Peskineea0fb492018-07-12 17:17:20 +0200445 case PSA_KEY_TYPE_DERIVE:
Neil Armstrong4b5710f2022-05-25 11:30:27 +0200446 case PSA_KEY_TYPE_PASSWORD:
447 case PSA_KEY_TYPE_PASSWORD_HASH:
Gilles Peskineea0fb492018-07-12 17:17:20 +0200448 break;
Ronald Cron1f0db802021-03-12 09:59:30 +0100449#if defined(PSA_WANT_KEY_TYPE_AES)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200450 case PSA_KEY_TYPE_AES:
Gilles Peskine449bd832023-01-11 14:50:10 +0100451 if (bits != 128 && bits != 192 && bits != 256) {
452 return PSA_ERROR_INVALID_ARGUMENT;
453 }
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200454 break;
455#endif
Gilles Peskine6c12a1e2021-09-21 11:59:39 +0200456#if defined(PSA_WANT_KEY_TYPE_ARIA)
457 case PSA_KEY_TYPE_ARIA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100458 if (bits != 128 && bits != 192 && bits != 256) {
459 return PSA_ERROR_INVALID_ARGUMENT;
460 }
Gilles Peskine6c12a1e2021-09-21 11:59:39 +0200461 break;
462#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100463#if defined(PSA_WANT_KEY_TYPE_CAMELLIA)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200464 case PSA_KEY_TYPE_CAMELLIA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100465 if (bits != 128 && bits != 192 && bits != 256) {
466 return PSA_ERROR_INVALID_ARGUMENT;
467 }
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200468 break;
469#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100470#if defined(PSA_WANT_KEY_TYPE_DES)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200471 case PSA_KEY_TYPE_DES:
Gilles Peskine449bd832023-01-11 14:50:10 +0100472 if (bits != 64 && bits != 128 && bits != 192) {
473 return PSA_ERROR_INVALID_ARGUMENT;
474 }
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200475 break;
476#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100477#if defined(PSA_WANT_KEY_TYPE_CHACHA20)
Gilles Peskine26869f22019-05-06 15:25:00 +0200478 case PSA_KEY_TYPE_CHACHA20:
Gilles Peskine449bd832023-01-11 14:50:10 +0100479 if (bits != 256) {
480 return PSA_ERROR_INVALID_ARGUMENT;
481 }
Gilles Peskine26869f22019-05-06 15:25:00 +0200482 break;
483#endif
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200484 default:
Gilles Peskine449bd832023-01-11 14:50:10 +0100485 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200486 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100487 if (bits % 8 != 0) {
488 return PSA_ERROR_INVALID_ARGUMENT;
489 }
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200490
Gilles Peskine449bd832023-01-11 14:50:10 +0100491 return PSA_SUCCESS;
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200492}
493
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100494/** Check whether a given key type is valid for use with a given MAC algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100495 *
Steven Cooremancd640932021-03-08 12:00:27 +0100496 * Upon successful return of this function, the behavior of #PSA_MAC_LENGTH
497 * when called with the validated \p algorithm and \p key_type is well-defined.
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100498 *
499 * \param[in] algorithm The specific MAC algorithm (can be wildcard).
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100500 * \param[in] key_type The key type of the key to be used with the
501 * \p algorithm.
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100502 *
503 * \retval #PSA_SUCCESS
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100504 * The \p key_type is valid for use with the \p algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100505 * \retval #PSA_ERROR_INVALID_ARGUMENT
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100506 * The \p key_type is not valid for use with the \p algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100507 */
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100508MBEDTLS_STATIC_TESTABLE psa_status_t psa_mac_key_can_do(
Steven Cooreman58c94d32021-03-02 21:31:17 +0100509 psa_algorithm_t algorithm,
Gilles Peskine449bd832023-01-11 14:50:10 +0100510 psa_key_type_t key_type)
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100511{
Gilles Peskine449bd832023-01-11 14:50:10 +0100512 if (PSA_ALG_IS_HMAC(algorithm)) {
513 if (key_type == PSA_KEY_TYPE_HMAC) {
514 return PSA_SUCCESS;
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100515 }
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100516 }
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100517
Gilles Peskine449bd832023-01-11 14:50:10 +0100518 if (PSA_ALG_IS_BLOCK_CIPHER_MAC(algorithm)) {
519 /* Check that we're calling PSA_BLOCK_CIPHER_BLOCK_LENGTH with a cipher
520 * key. */
521 if ((key_type & PSA_KEY_TYPE_CATEGORY_MASK) ==
522 PSA_KEY_TYPE_CATEGORY_SYMMETRIC) {
523 /* PSA_BLOCK_CIPHER_BLOCK_LENGTH returns 1 for stream ciphers and
524 * the block length (larger than 1) for block ciphers. */
525 if (PSA_BLOCK_CIPHER_BLOCK_LENGTH(key_type) > 1) {
526 return PSA_SUCCESS;
527 }
528 }
529 }
530
531 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100532}
533
Gilles Peskine449bd832023-01-11 14:50:10 +0100534psa_status_t psa_allocate_buffer_to_slot(psa_key_slot_t *slot,
535 size_t buffer_length)
Steven Cooreman75b74362020-07-28 14:30:13 +0200536{
Gilles Peskine449bd832023-01-11 14:50:10 +0100537 if (slot->key.data != NULL) {
538 return PSA_ERROR_ALREADY_EXISTS;
539 }
Steven Cooreman75b74362020-07-28 14:30:13 +0200540
Gilles Peskine449bd832023-01-11 14:50:10 +0100541 slot->key.data = mbedtls_calloc(1, buffer_length);
542 if (slot->key.data == NULL) {
543 return PSA_ERROR_INSUFFICIENT_MEMORY;
544 }
Steven Cooreman75b74362020-07-28 14:30:13 +0200545
Ronald Cronea0f8a62020-11-25 17:52:23 +0100546 slot->key.bytes = buffer_length;
Gilles Peskine449bd832023-01-11 14:50:10 +0100547 return PSA_SUCCESS;
Steven Cooreman75b74362020-07-28 14:30:13 +0200548}
549
Gilles Peskine449bd832023-01-11 14:50:10 +0100550psa_status_t psa_copy_key_material_into_slot(psa_key_slot_t *slot,
551 const uint8_t *data,
552 size_t data_length)
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200553{
Gilles Peskine449bd832023-01-11 14:50:10 +0100554 psa_status_t status = psa_allocate_buffer_to_slot(slot,
555 data_length);
556 if (status != PSA_SUCCESS) {
557 return status;
558 }
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200559
Gilles Peskine449bd832023-01-11 14:50:10 +0100560 memcpy(slot->key.data, data, data_length);
561 return PSA_SUCCESS;
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200562}
563
Ronald Crona0fe59f2020-11-29 11:14:53 +0100564psa_status_t psa_import_key_into_slot(
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100565 const psa_key_attributes_t *attributes,
566 const uint8_t *data, size_t data_length,
567 uint8_t *key_buffer, size_t key_buffer_size,
Gilles Peskine449bd832023-01-11 14:50:10 +0100568 size_t *key_buffer_length, size_t *bits)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100569{
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100570 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
571 psa_key_type_t type = attributes->core.type;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100572
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200573 /* zero-length keys are never supported. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100574 if (data_length == 0) {
575 return PSA_ERROR_NOT_SUPPORTED;
576 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200577
Gilles Peskine449bd832023-01-11 14:50:10 +0100578 if (key_type_is_raw_bytes(type)) {
579 *bits = PSA_BYTES_TO_BITS(data_length);
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200580
Gilles Peskine449bd832023-01-11 14:50:10 +0100581 status = psa_validate_unstructured_key_bit_size(attributes->core.type,
582 *bits);
583 if (status != PSA_SUCCESS) {
584 return status;
585 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200586
Ronald Crondd04d422020-11-28 15:14:42 +0100587 /* Copy the key material. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100588 memcpy(key_buffer, data, data_length);
Ronald Crondd04d422020-11-28 15:14:42 +0100589 *key_buffer_length = data_length;
Gilles Peskine449bd832023-01-11 14:50:10 +0100590 (void) key_buffer_size;
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200591
Gilles Peskine449bd832023-01-11 14:50:10 +0100592 return PSA_SUCCESS;
593 } else if (PSA_KEY_TYPE_IS_ASYMMETRIC(type)) {
Valerio Settia55f0422023-07-10 15:34:41 +0200594#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_IMPORT) || \
Przemek Stekiel6d85afa2023-04-28 11:42:17 +0200595 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY)
Przemek Stekiel472b3f32022-12-01 14:38:49 +0100596 if (PSA_KEY_TYPE_IS_DH(type)) {
Przemek Stekield1cf1ba2023-04-27 12:04:21 +0200597 if (psa_is_dh_key_size_valid(PSA_BYTES_TO_BITS(data_length)) == 0) {
Valerio Setti504a1022024-01-17 15:19:30 +0100598 return PSA_ERROR_NOT_SUPPORTED;
Przemek Stekiel472b3f32022-12-01 14:38:49 +0100599 }
Przemek Stekiel33c91eb2023-05-30 15:16:35 +0200600 return mbedtls_psa_ffdh_import_key(attributes,
601 data, data_length,
602 key_buffer, key_buffer_size,
603 key_buffer_length,
604 bits);
Przemek Stekiel472b3f32022-12-01 14:38:49 +0100605 }
Valerio Settia55f0422023-07-10 15:34:41 +0200606#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_IMPORT) ||
Przemek Stekiel6d85afa2023-04-28 11:42:17 +0200607 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY) */
Valerio Setti27c501a2023-06-27 16:58:52 +0200608#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_IMPORT) || \
Gilles Peskine449bd832023-01-11 14:50:10 +0100609 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
610 if (PSA_KEY_TYPE_IS_ECC(type)) {
611 return mbedtls_psa_ecp_import_key(attributes,
612 data, data_length,
613 key_buffer, key_buffer_size,
614 key_buffer_length,
615 bits);
Steven Cooreman40120f62020-10-29 11:42:22 +0100616 }
Valerio Setti27c501a2023-06-27 16:58:52 +0200617#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_IMPORT) ||
John Durkop9814fa22020-11-04 12:28:15 -0800618 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
Valerio Settife478902023-07-25 12:27:19 +0200619#if (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) && \
620 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) || \
Gilles Peskine449bd832023-01-11 14:50:10 +0100621 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
622 if (PSA_KEY_TYPE_IS_RSA(type)) {
623 return mbedtls_psa_rsa_import_key(attributes,
624 data, data_length,
625 key_buffer, key_buffer_size,
626 key_buffer_length,
627 bits);
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200628 }
Valerio Settife478902023-07-25 12:27:19 +0200629#endif /* (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) &&
630 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) ||
John Durkop9814fa22020-11-04 12:28:15 -0800631 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100632 }
Steven Cooreman40120f62020-10-29 11:42:22 +0100633
Gilles Peskine449bd832023-01-11 14:50:10 +0100634 return PSA_ERROR_NOT_SUPPORTED;
Darryl Green06fd18d2018-07-16 11:21:11 +0100635}
636
Gilles Peskinef603c712019-01-19 13:40:11 +0100637/** Calculate the intersection of two algorithm usage policies.
638 *
639 * Return 0 (which allows no operation) on incompatibility.
640 */
641static psa_algorithm_t psa_key_policy_algorithm_intersection(
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100642 psa_key_type_t key_type,
Gilles Peskinef603c712019-01-19 13:40:11 +0100643 psa_algorithm_t alg1,
Gilles Peskine449bd832023-01-11 14:50:10 +0100644 psa_algorithm_t alg2)
Gilles Peskinef603c712019-01-19 13:40:11 +0100645{
Gilles Peskine549ea862019-05-22 11:45:59 +0200646 /* Common case: both sides actually specify the same policy. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100647 if (alg1 == alg2) {
648 return alg1;
649 }
Steven Cooreman03488022021-02-18 12:07:20 +0100650 /* If the policies are from the same hash-and-sign family, check
651 * if one is a wildcard. If so the other has the specific algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100652 if (PSA_ALG_IS_SIGN_HASH(alg1) &&
653 PSA_ALG_IS_SIGN_HASH(alg2) &&
654 (alg1 & ~PSA_ALG_HASH_MASK) == (alg2 & ~PSA_ALG_HASH_MASK)) {
655 if (PSA_ALG_SIGN_GET_HASH(alg1) == PSA_ALG_ANY_HASH) {
656 return alg2;
657 }
658 if (PSA_ALG_SIGN_GET_HASH(alg2) == PSA_ALG_ANY_HASH) {
659 return alg1;
660 }
Steven Cooreman03488022021-02-18 12:07:20 +0100661 }
662 /* If the policies are from the same AEAD family, check whether
Steven Cooreman7de9e2d2021-02-22 17:05:56 +0100663 * one of them is a minimum-tag-length wildcard. Calculate the most
Steven Cooreman03488022021-02-18 12:07:20 +0100664 * restrictive tag length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100665 if (PSA_ALG_IS_AEAD(alg1) && PSA_ALG_IS_AEAD(alg2) &&
666 (PSA_ALG_AEAD_WITH_SHORTENED_TAG(alg1, 0) ==
667 PSA_ALG_AEAD_WITH_SHORTENED_TAG(alg2, 0))) {
668 size_t alg1_len = PSA_ALG_AEAD_GET_TAG_LENGTH(alg1);
669 size_t alg2_len = PSA_ALG_AEAD_GET_TAG_LENGTH(alg2);
Steven Cooremancd640932021-03-08 12:00:27 +0100670 size_t restricted_len = alg1_len > alg2_len ? alg1_len : alg2_len;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100671
Steven Cooreman7de9e2d2021-02-22 17:05:56 +0100672 /* If both are wildcards, return most restrictive wildcard */
Gilles Peskine449bd832023-01-11 14:50:10 +0100673 if (((alg1 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0) &&
674 ((alg2 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0)) {
675 return PSA_ALG_AEAD_WITH_AT_LEAST_THIS_LENGTH_TAG(
676 alg1, restricted_len);
Steven Cooreman03488022021-02-18 12:07:20 +0100677 }
678 /* If only one is a wildcard, return specific algorithm if compatible. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100679 if (((alg1 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0) &&
680 (alg1_len <= alg2_len)) {
681 return alg2;
Steven Cooreman03488022021-02-18 12:07:20 +0100682 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100683 if (((alg2 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0) &&
684 (alg2_len <= alg1_len)) {
685 return alg1;
Steven Cooreman03488022021-02-18 12:07:20 +0100686 }
687 }
688 /* If the policies are from the same MAC family, check whether one
689 * of them is a minimum-MAC-length policy. Calculate the most
690 * restrictive tag length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100691 if (PSA_ALG_IS_MAC(alg1) && PSA_ALG_IS_MAC(alg2) &&
692 (PSA_ALG_FULL_LENGTH_MAC(alg1) ==
693 PSA_ALG_FULL_LENGTH_MAC(alg2))) {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100694 /* Validate the combination of key type and algorithm. Since the base
695 * algorithm of alg1 and alg2 are the same, we only need this once. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100696 if (PSA_SUCCESS != psa_mac_key_can_do(alg1, key_type)) {
697 return 0;
698 }
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100699
Steven Cooreman31a876d2021-03-03 20:47:40 +0100700 /* Get the (exact or at-least) output lengths for both sides of the
701 * requested intersection. None of the currently supported algorithms
702 * have an output length dependent on the actual key size, so setting it
703 * to a bogus value of 0 is currently OK.
704 *
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100705 * Note that for at-least-this-length wildcard algorithms, the output
706 * length is set to the shortest allowed length, which allows us to
707 * calculate the most restrictive tag length for the intersection. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100708 size_t alg1_len = PSA_MAC_LENGTH(key_type, 0, alg1);
709 size_t alg2_len = PSA_MAC_LENGTH(key_type, 0, alg2);
Steven Cooremancd640932021-03-08 12:00:27 +0100710 size_t restricted_len = alg1_len > alg2_len ? alg1_len : alg2_len;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100711
Steven Cooremana1d83222021-02-25 10:20:29 +0100712 /* If both are wildcards, return most restrictive wildcard */
Gilles Peskine449bd832023-01-11 14:50:10 +0100713 if (((alg1 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0) &&
714 ((alg2 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0)) {
715 return PSA_ALG_AT_LEAST_THIS_LENGTH_MAC(alg1, restricted_len);
Steven Cooreman03488022021-02-18 12:07:20 +0100716 }
Steven Cooreman31a876d2021-03-03 20:47:40 +0100717
718 /* If only one is an at-least-this-length policy, the intersection would
719 * be the other (fixed-length) policy as long as said fixed length is
720 * equal to or larger than the shortest allowed length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100721 if ((alg1 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0) {
722 return (alg1_len <= alg2_len) ? alg2 : 0;
Steven Cooreman03488022021-02-18 12:07:20 +0100723 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100724 if ((alg2 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0) {
725 return (alg2_len <= alg1_len) ? alg1 : 0;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100726 }
Steven Cooreman31a876d2021-03-03 20:47:40 +0100727
Steven Cooremancd640932021-03-08 12:00:27 +0100728 /* If none of them are wildcards, check whether they define the same tag
729 * length. This is still possible here when one is default-length and
730 * the other specific-length. Ensure to always return the
731 * specific-length version for the intersection. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100732 if (alg1_len == alg2_len) {
733 return PSA_ALG_TRUNCATED_MAC(alg1, alg1_len);
734 }
Gilles Peskinef603c712019-01-19 13:40:11 +0100735 }
736 /* If the policies are incompatible, allow nothing. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100737 return 0;
Gilles Peskinef603c712019-01-19 13:40:11 +0100738}
739
Gilles Peskine449bd832023-01-11 14:50:10 +0100740static int psa_key_algorithm_permits(psa_key_type_t key_type,
741 psa_algorithm_t policy_alg,
742 psa_algorithm_t requested_alg)
Gilles Peskined6f371b2019-05-10 19:33:38 +0200743{
Gilles Peskine549ea862019-05-22 11:45:59 +0200744 /* Common case: the policy only allows requested_alg. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100745 if (requested_alg == policy_alg) {
746 return 1;
747 }
Steven Cooreman03488022021-02-18 12:07:20 +0100748 /* If policy_alg is a hash-and-sign with a wildcard for the hash,
749 * and requested_alg is the same hash-and-sign family with any hash,
750 * then requested_alg is compliant with policy_alg. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100751 if (PSA_ALG_IS_SIGN_HASH(requested_alg) &&
752 PSA_ALG_SIGN_GET_HASH(policy_alg) == PSA_ALG_ANY_HASH) {
753 return (policy_alg & ~PSA_ALG_HASH_MASK) ==
754 (requested_alg & ~PSA_ALG_HASH_MASK);
Steven Cooreman03488022021-02-18 12:07:20 +0100755 }
756 /* If policy_alg is a wildcard AEAD algorithm of the same base as
757 * the requested algorithm, check the requested tag length to be
758 * equal-length or longer than the wildcard-specified length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100759 if (PSA_ALG_IS_AEAD(policy_alg) &&
760 PSA_ALG_IS_AEAD(requested_alg) &&
761 (PSA_ALG_AEAD_WITH_SHORTENED_TAG(policy_alg, 0) ==
762 PSA_ALG_AEAD_WITH_SHORTENED_TAG(requested_alg, 0)) &&
763 ((policy_alg & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0)) {
764 return PSA_ALG_AEAD_GET_TAG_LENGTH(policy_alg) <=
765 PSA_ALG_AEAD_GET_TAG_LENGTH(requested_alg);
Steven Cooreman03488022021-02-18 12:07:20 +0100766 }
Steven Cooremancd640932021-03-08 12:00:27 +0100767 /* If policy_alg is a MAC algorithm of the same base as the requested
768 * algorithm, check whether their MAC lengths are compatible. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100769 if (PSA_ALG_IS_MAC(policy_alg) &&
770 PSA_ALG_IS_MAC(requested_alg) &&
771 (PSA_ALG_FULL_LENGTH_MAC(policy_alg) ==
772 PSA_ALG_FULL_LENGTH_MAC(requested_alg))) {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100773 /* Validate the combination of key type and algorithm. Since the policy
774 * and requested algorithms are the same, we only need this once. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100775 if (PSA_SUCCESS != psa_mac_key_can_do(policy_alg, key_type)) {
776 return 0;
777 }
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100778
Steven Cooreman31a876d2021-03-03 20:47:40 +0100779 /* Get both the requested output length for the algorithm which is to be
780 * verified, and the default output length for the base algorithm.
781 * Note that none of the currently supported algorithms have an output
782 * length dependent on actual key size, so setting it to a bogus value
783 * of 0 is currently OK. */
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100784 size_t requested_output_length = PSA_MAC_LENGTH(
Gilles Peskine449bd832023-01-11 14:50:10 +0100785 key_type, 0, requested_alg);
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100786 size_t default_output_length = PSA_MAC_LENGTH(
Gilles Peskine449bd832023-01-11 14:50:10 +0100787 key_type, 0,
788 PSA_ALG_FULL_LENGTH_MAC(requested_alg));
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100789
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100790 /* If the policy is default-length, only allow an algorithm with
791 * a declared exact-length matching the default. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100792 if (PSA_MAC_TRUNCATED_LENGTH(policy_alg) == 0) {
793 return requested_output_length == default_output_length;
794 }
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100795
796 /* If the requested algorithm is default-length, allow it if the policy
Steven Cooremancd640932021-03-08 12:00:27 +0100797 * length exactly matches the default length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100798 if (PSA_MAC_TRUNCATED_LENGTH(requested_alg) == 0 &&
799 PSA_MAC_TRUNCATED_LENGTH(policy_alg) == default_output_length) {
800 return 1;
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100801 }
802
Steven Cooremancd640932021-03-08 12:00:27 +0100803 /* If policy_alg is an at-least-this-length wildcard MAC algorithm,
804 * check for the requested MAC length to be equal to or longer than the
805 * minimum allowed length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100806 if ((policy_alg & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0) {
807 return PSA_MAC_TRUNCATED_LENGTH(policy_alg) <=
808 requested_output_length;
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100809 }
Gilles Peskined6f371b2019-05-10 19:33:38 +0200810 }
Steven Cooremance48e852020-10-05 16:02:45 +0200811 /* If policy_alg is a generic key agreement operation, then using it for
Steven Cooremanfa5e6312020-10-15 17:07:12 +0200812 * a key derivation with that key agreement should also be allowed. This
813 * behaviour is expected to be defined in a future specification version. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100814 if (PSA_ALG_IS_RAW_KEY_AGREEMENT(policy_alg) &&
815 PSA_ALG_IS_KEY_AGREEMENT(requested_alg)) {
816 return PSA_ALG_KEY_AGREEMENT_GET_BASE(requested_alg) ==
817 policy_alg;
Steven Cooremance48e852020-10-05 16:02:45 +0200818 }
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100819 /* If it isn't explicitly permitted, it's forbidden. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100820 return 0;
Gilles Peskined6f371b2019-05-10 19:33:38 +0200821}
822
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100823/** Test whether a policy permits an algorithm.
824 *
825 * The caller must test usage flags separately.
Steven Cooreman7e39f052021-02-23 14:18:32 +0100826 *
Steven Cooreman5a172672021-03-02 21:27:42 +0100827 * \note This function requires providing the key type for which the policy is
828 * being validated, since some algorithm policy definitions (e.g. MAC)
829 * have different properties depending on what kind of cipher it is
830 * combined with.
831 *
Steven Cooreman7e39f052021-02-23 14:18:32 +0100832 * \retval PSA_SUCCESS When \p alg is a specific algorithm
833 * allowed by the \p policy.
834 * \retval PSA_ERROR_INVALID_ARGUMENT When \p alg is not a specific algorithm
835 * \retval PSA_ERROR_NOT_PERMITTED When \p alg is a specific algorithm, but
836 * the \p policy does not allow it.
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100837 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100838static psa_status_t psa_key_policy_permits(const psa_key_policy_t *policy,
839 psa_key_type_t key_type,
840 psa_algorithm_t alg)
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100841{
Steven Cooremand788fab2021-02-25 11:29:17 +0100842 /* '0' is not a valid algorithm */
Gilles Peskine449bd832023-01-11 14:50:10 +0100843 if (alg == 0) {
844 return PSA_ERROR_INVALID_ARGUMENT;
845 }
Steven Cooremand788fab2021-02-25 11:29:17 +0100846
Steven Cooreman7e39f052021-02-23 14:18:32 +0100847 /* A requested algorithm cannot be a wildcard. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100848 if (PSA_ALG_IS_WILDCARD(alg)) {
849 return PSA_ERROR_INVALID_ARGUMENT;
850 }
Steven Cooreman7e39f052021-02-23 14:18:32 +0100851
Gilles Peskine449bd832023-01-11 14:50:10 +0100852 if (psa_key_algorithm_permits(key_type, policy->alg, alg) ||
853 psa_key_algorithm_permits(key_type, policy->alg2, alg)) {
854 return PSA_SUCCESS;
855 } else {
856 return PSA_ERROR_NOT_PERMITTED;
857 }
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100858}
859
Gilles Peskinef603c712019-01-19 13:40:11 +0100860/** Restrict a key policy based on a constraint.
861 *
Steven Cooreman5a172672021-03-02 21:27:42 +0100862 * \note This function requires providing the key type for which the policy is
863 * being restricted, since some algorithm policy definitions (e.g. MAC)
864 * have different properties depending on what kind of cipher it is
865 * combined with.
866 *
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100867 * \param[in] key_type The key type for which to restrict the policy
Gilles Peskinef603c712019-01-19 13:40:11 +0100868 * \param[in,out] policy The policy to restrict.
869 * \param[in] constraint The policy constraint to apply.
870 *
871 * \retval #PSA_SUCCESS
872 * \c *policy contains the intersection of the original value of
873 * \c *policy and \c *constraint.
874 * \retval #PSA_ERROR_INVALID_ARGUMENT
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100875 * \c key_type, \c *policy and \c *constraint are incompatible.
Gilles Peskinef603c712019-01-19 13:40:11 +0100876 * \c *policy is unchanged.
877 */
878static psa_status_t psa_restrict_key_policy(
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100879 psa_key_type_t key_type,
Gilles Peskinef603c712019-01-19 13:40:11 +0100880 psa_key_policy_t *policy,
Gilles Peskine449bd832023-01-11 14:50:10 +0100881 const psa_key_policy_t *constraint)
Gilles Peskinef603c712019-01-19 13:40:11 +0100882{
883 psa_algorithm_t intersection_alg =
Gilles Peskine449bd832023-01-11 14:50:10 +0100884 psa_key_policy_algorithm_intersection(key_type, policy->alg,
885 constraint->alg);
Gilles Peskined6f371b2019-05-10 19:33:38 +0200886 psa_algorithm_t intersection_alg2 =
Gilles Peskine449bd832023-01-11 14:50:10 +0100887 psa_key_policy_algorithm_intersection(key_type, policy->alg2,
888 constraint->alg2);
889 if (intersection_alg == 0 && policy->alg != 0 && constraint->alg != 0) {
890 return PSA_ERROR_INVALID_ARGUMENT;
891 }
892 if (intersection_alg2 == 0 && policy->alg2 != 0 && constraint->alg2 != 0) {
893 return PSA_ERROR_INVALID_ARGUMENT;
894 }
Gilles Peskinef603c712019-01-19 13:40:11 +0100895 policy->usage &= constraint->usage;
896 policy->alg = intersection_alg;
Gilles Peskined6f371b2019-05-10 19:33:38 +0200897 policy->alg2 = intersection_alg2;
Gilles Peskine449bd832023-01-11 14:50:10 +0100898 return PSA_SUCCESS;
Gilles Peskinef603c712019-01-19 13:40:11 +0100899}
900
Przemek Stekiel061f6942022-11-30 10:51:35 +0100901/** Get the description of a key given its identifier and policy constraints
902 * and lock it.
903 *
904 * The key must have allow all the usage flags set in \p usage. If \p alg is
905 * nonzero, the key must allow operations with this algorithm. If \p alg is
906 * zero, the algorithm is not checked.
907 *
908 * In case of a persistent key, the function loads the description of the key
909 * into a key slot if not already done.
910 *
Ryan Everett098c6652024-01-03 13:03:36 +0000911 * On success, the returned key slot has been registered for reading.
912 * It is the responsibility of the caller to call psa_unregister_read(slot)
913 * when they have finished reading the contents of the slot.
Przemek Stekiel061f6942022-11-30 10:51:35 +0100914 */
915static psa_status_t psa_get_and_lock_key_slot_with_policy(
Ronald Cron5c522922020-11-14 16:35:34 +0100916 mbedtls_svc_key_id_t key,
917 psa_key_slot_t **p_slot,
918 psa_key_usage_t usage,
Gilles Peskine449bd832023-01-11 14:50:10 +0100919 psa_algorithm_t alg)
Darryl Green06fd18d2018-07-16 11:21:11 +0100920{
Ronald Cronf95a2b12020-10-22 15:24:49 +0200921 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel9a5b8122022-12-22 13:34:47 +0100922 psa_key_slot_t *slot = NULL;
Darryl Green06fd18d2018-07-16 11:21:11 +0100923
Gilles Peskine449bd832023-01-11 14:50:10 +0100924 status = psa_get_and_lock_key_slot(key, p_slot);
925 if (status != PSA_SUCCESS) {
926 return status;
927 }
Ronald Cronf95a2b12020-10-22 15:24:49 +0200928 slot = *p_slot;
Darryl Green06fd18d2018-07-16 11:21:11 +0100929
930 /* Enforce that usage policy for the key slot contains all the flags
931 * required by the usage parameter. There is one exception: public
932 * keys can always be exported, so we treat public key objects as
933 * if they had the export flag. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100934 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(slot->attr.type)) {
Darryl Green06fd18d2018-07-16 11:21:11 +0100935 usage &= ~PSA_KEY_USAGE_EXPORT;
Gilles Peskine449bd832023-01-11 14:50:10 +0100936 }
Ronald Cronf95a2b12020-10-22 15:24:49 +0200937
Gilles Peskine449bd832023-01-11 14:50:10 +0100938 if ((slot->attr.policy.usage & usage) != usage) {
Steven Cooreman328f11c2021-03-02 11:44:51 +0100939 status = PSA_ERROR_NOT_PERMITTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +0200940 goto error;
Steven Cooreman328f11c2021-03-02 11:44:51 +0100941 }
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100942
Shaun Case8b0ecbc2021-12-20 21:14:10 -0800943 /* Enforce that the usage policy permits the requested algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100944 if (alg != 0) {
945 status = psa_key_policy_permits(&slot->attr.policy,
946 slot->attr.type,
947 alg);
948 if (status != PSA_SUCCESS) {
Steven Cooreman7e39f052021-02-23 14:18:32 +0100949 goto error;
Gilles Peskine449bd832023-01-11 14:50:10 +0100950 }
Steven Cooreman7e39f052021-02-23 14:18:32 +0100951 }
Darryl Green06fd18d2018-07-16 11:21:11 +0100952
Gilles Peskine449bd832023-01-11 14:50:10 +0100953 return PSA_SUCCESS;
Ronald Cronf95a2b12020-10-22 15:24:49 +0200954
955error:
956 *p_slot = NULL;
Ryan Everett098c6652024-01-03 13:03:36 +0000957 psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +0200958
Gilles Peskine449bd832023-01-11 14:50:10 +0100959 return status;
Darryl Green06fd18d2018-07-16 11:21:11 +0100960}
Darryl Green940d72c2018-07-13 13:18:51 +0100961
Ronald Cron5c522922020-11-14 16:35:34 +0100962/** Get a key slot containing a transparent key and lock it.
Gilles Peskine28f8f302019-07-24 13:30:31 +0200963 *
964 * A transparent key is a key for which the key material is directly
Ronald Cronddae0f52021-08-24 15:39:44 +0200965 * available, as opposed to a key in a secure element and/or to be used
966 * by a secure element.
Gilles Peskine28f8f302019-07-24 13:30:31 +0200967 *
Ronald Cronddae0f52021-08-24 15:39:44 +0200968 * This is a temporary function that may be used instead of
969 * psa_get_and_lock_key_slot_with_policy() when there is no opaque key support
970 * for a cryptographic operation.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200971 *
Ryan Everett098c6652024-01-03 13:03:36 +0000972 * On success, the returned key slot has been registered for reading.
973 * It is the responsibility of the caller to call psa_unregister_read(slot)
974 * when they have finished reading the contents of the slot.
Gilles Peskine28f8f302019-07-24 13:30:31 +0200975 */
Ronald Cron5c522922020-11-14 16:35:34 +0100976static psa_status_t psa_get_and_lock_transparent_key_slot_with_policy(
977 mbedtls_svc_key_id_t key,
978 psa_key_slot_t **p_slot,
979 psa_key_usage_t usage,
Gilles Peskine449bd832023-01-11 14:50:10 +0100980 psa_algorithm_t alg)
Gilles Peskine28f8f302019-07-24 13:30:31 +0200981{
Gilles Peskine449bd832023-01-11 14:50:10 +0100982 psa_status_t status = psa_get_and_lock_key_slot_with_policy(key, p_slot,
983 usage, alg);
984 if (status != PSA_SUCCESS) {
985 return status;
Gilles Peskine28f8f302019-07-24 13:30:31 +0200986 }
Ronald Cronf95a2b12020-10-22 15:24:49 +0200987
Gilles Peskine449bd832023-01-11 14:50:10 +0100988 if (psa_key_lifetime_is_external((*p_slot)->attr.lifetime)) {
Ryan Everett098c6652024-01-03 13:03:36 +0000989 psa_unregister_read(*p_slot);
Gilles Peskine449bd832023-01-11 14:50:10 +0100990 *p_slot = NULL;
991 return PSA_ERROR_NOT_SUPPORTED;
992 }
993
994 return PSA_SUCCESS;
Gilles Peskine28f8f302019-07-24 13:30:31 +0200995}
Gilles Peskine28f8f302019-07-24 13:30:31 +0200996
Gilles Peskine449bd832023-01-11 14:50:10 +0100997psa_status_t psa_remove_key_data_from_memory(psa_key_slot_t *slot)
Darryl Green40225ba2018-11-15 14:48:15 +0000998{
Gilles Peskine449bd832023-01-11 14:50:10 +0100999 if (slot->key.data != NULL) {
Tom Cosgrove52f7e182023-08-01 09:08:48 +01001000 mbedtls_zeroize_and_free(slot->key.data, slot->key.bytes);
Gilles Peskine449bd832023-01-11 14:50:10 +01001001 }
Ronald Cronea0f8a62020-11-25 17:52:23 +01001002
Ronald Cronea0f8a62020-11-25 17:52:23 +01001003 slot->key.data = NULL;
1004 slot->key.bytes = 0;
Darryl Green40225ba2018-11-15 14:48:15 +00001005
Gilles Peskine449bd832023-01-11 14:50:10 +01001006 return PSA_SUCCESS;
Darryl Green40225ba2018-11-15 14:48:15 +00001007}
1008
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001009/** Completely wipe a slot in memory, including its policy.
1010 * Persistent storage is not affected. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001011psa_status_t psa_wipe_key_slot(psa_key_slot_t *slot)
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001012{
Gilles Peskine449bd832023-01-11 14:50:10 +01001013 psa_status_t status = psa_remove_key_data_from_memory(slot);
Ronald Cronddd3d052020-10-30 14:07:07 +01001014
Gilles Peskine449bd832023-01-11 14:50:10 +01001015 /*
1016 * As the return error code may not be handled in case of multiple errors,
Ryan Everett7ed542e2024-01-17 11:39:09 +00001017 * do our best to report an unexpected amount of registered readers or
1018 * an unexpected state.
1019 * Assert with MBEDTLS_TEST_HOOK_TEST_ASSERT that the slot is valid for
1020 * wiping.
Gilles Peskine449bd832023-01-11 14:50:10 +01001021 * if the MBEDTLS_TEST_HOOKS configuration option is enabled and the
1022 * function is called as part of the execution of a test suite, the
1023 * execution of the test suite is stopped in error if the assertion fails.
1024 */
Ryan Everett7ed542e2024-01-17 11:39:09 +00001025 switch (slot->state) {
1026 case PSA_SLOT_FULL:
1027 /* In this state psa_wipe_key_slot() must only be called if the
1028 * caller is the last reader. */
1029 case PSA_SLOT_PENDING_DELETION:
1030 /* In this state psa_wipe_key_slot() must only be called if the
1031 * caller is the last reader. */
1032 if (slot->registered_readers != 1) {
1033 MBEDTLS_TEST_HOOK_TEST_ASSERT(slot->registered_readers == 1);
1034 status = PSA_ERROR_CORRUPTION_DETECTED;
1035 }
1036 break;
1037 case PSA_SLOT_FILLING:
1038 /* In this state registered_readers must be 0. */
1039 if (slot->registered_readers != 0) {
1040 MBEDTLS_TEST_HOOK_TEST_ASSERT(slot->registered_readers == 0);
1041 status = PSA_ERROR_CORRUPTION_DETECTED;
1042 }
1043 break;
1044 case PSA_SLOT_EMPTY:
1045 /* The slot is already empty, it cannot be wiped. */
1046 MBEDTLS_TEST_HOOK_TEST_ASSERT(slot->state != PSA_SLOT_EMPTY);
1047 status = PSA_ERROR_CORRUPTION_DETECTED;
1048 break;
1049 default:
1050 /* The slot's state is invalid. */
1051 status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronddd3d052020-10-30 14:07:07 +01001052 }
1053
Gilles Peskine3f7cd622019-08-13 15:01:08 +02001054 /* Multipart operations may still be using the key. This is safe
1055 * because all multipart operation objects are independent from
1056 * the key slot: if they need to access the key after the setup
1057 * phase, they have a copy of the key. Note that this means that
1058 * key material can linger until all operations are completed. */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001059 /* At this point, key material and other type-specific content has
1060 * been wiped. Clear remaining metadata. We can call memset and not
Ryan Everettaa33c512023-12-21 17:32:07 +00001061 * zeroize because the metadata is not particularly sensitive.
1062 * This memset also sets the slot's state to PSA_SLOT_EMPTY. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001063 memset(slot, 0, sizeof(*slot));
1064 return status;
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001065}
1066
Gilles Peskine449bd832023-01-11 14:50:10 +01001067psa_status_t psa_destroy_key(mbedtls_svc_key_id_t key)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001068{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001069 psa_key_slot_t *slot;
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001070 psa_status_t status; /* status of the last operation */
1071 psa_status_t overall_status = PSA_SUCCESS;
Gilles Peskine354f7672019-07-12 23:46:38 +02001072#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1073 psa_se_drv_table_entry_t *driver;
1074#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001075
Gilles Peskine449bd832023-01-11 14:50:10 +01001076 if (mbedtls_svc_key_id_is_null(key)) {
1077 return PSA_SUCCESS;
1078 }
Gilles Peskine1841cf42019-10-08 15:48:25 +02001079
Ronald Cronf2911112020-10-29 17:51:10 +01001080 /*
Ryan Everett7ed542e2024-01-17 11:39:09 +00001081 * Get the description of the key in a key slot, and register to read it.
1082 * In the case of a persistent key, this will load the key description
1083 * from persistent memory if not done yet.
1084 * We cannot avoid this loading as without it we don't know if
Ronald Cronf2911112020-10-29 17:51:10 +01001085 * the key is operated by an SE or not and this information is needed by
Ryan Everett7ed542e2024-01-17 11:39:09 +00001086 * the current implementation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001087 status = psa_get_and_lock_key_slot(key, &slot);
1088 if (status != PSA_SUCCESS) {
1089 return status;
1090 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001091
Ryan Everettc053d962024-01-25 17:56:32 +00001092#if defined(MBEDTLS_THREADING_C)
Ryan Everett763971f2024-01-29 17:13:36 +00001093 /* We cannot unlock between setting the state to PENDING_DELETION
1094 * and destroying the key in storage, as otherwise another thread
1095 * could load the key into a new slot and the key will not be
1096 * fully destroyed. */
Ryan Everettc053d962024-01-25 17:56:32 +00001097 PSA_THREADING_CHK_GOTO_EXIT(mbedtls_mutex_lock(
1098 &mbedtls_threading_key_slot_mutex));
1099#endif
Ryan Everett7ed542e2024-01-17 11:39:09 +00001100 /* Set the key slot containing the key description's state to
1101 * PENDING_DELETION. This stops new operations from registering
1102 * to read the slot. Current readers can safely continue to access
1103 * the key within the slot; the last registered reader will
1104 * automatically wipe the slot when they call psa_unregister_read().
1105 * If the key is persistent, we can now delete the copy of the key
1106 * from memory. If the key is opaque, we require the driver to
1107 * deal with the deletion. */
Ryan Everettc053d962024-01-25 17:56:32 +00001108 status = psa_key_slot_state_transition(slot, PSA_SLOT_FULL,
1109 PSA_SLOT_PENDING_DELETION);
1110
1111 if (status != PSA_SUCCESS) {
1112 goto exit;
1113 }
Ronald Cronf2911112020-10-29 17:51:10 +01001114
Gilles Peskine449bd832023-01-11 14:50:10 +01001115 if (PSA_KEY_LIFETIME_IS_READ_ONLY(slot->attr.lifetime)) {
Gilles Peskine6687cd02021-04-21 22:32:05 +02001116 /* Refuse the destruction of a read-only key (which may or may not work
1117 * if we attempt it, depending on whether the key is merely read-only
1118 * by policy or actually physically read-only).
Gilles Peskinef9a046e2021-06-07 23:27:54 +02001119 * Just do the best we can, which is to wipe the copy in memory
1120 * (done in this function's cleanup code). */
1121 overall_status = PSA_ERROR_NOT_PERMITTED;
1122 goto exit;
Gilles Peskine6687cd02021-04-21 22:32:05 +02001123 }
1124
Gilles Peskine354f7672019-07-12 23:46:38 +02001125#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001126 driver = psa_get_se_driver_entry(slot->attr.lifetime);
1127 if (driver != NULL) {
Gilles Peskine60450a42019-07-25 11:32:45 +02001128 /* For a key in a secure element, we need to do three things:
1129 * remove the key file in internal storage, destroy the
1130 * key inside the secure element, and update the driver's
1131 * persistent data. Start a transaction that will encompass these
1132 * three actions. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001133 psa_crypto_prepare_transaction(PSA_CRYPTO_TRANSACTION_DESTROY_KEY);
Gilles Peskine8e338702019-07-30 20:06:31 +02001134 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Gilles Peskine449bd832023-01-11 14:50:10 +01001135 psa_crypto_transaction.key.slot = psa_key_slot_get_slot_number(slot);
Gilles Peskine8e338702019-07-30 20:06:31 +02001136 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskine449bd832023-01-11 14:50:10 +01001137 status = psa_crypto_save_transaction();
1138 if (status != PSA_SUCCESS) {
1139 (void) psa_crypto_stop_transaction();
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001140 /* We should still try to destroy the key in the secure
1141 * element and the key metadata in storage. This is especially
1142 * important if the error is that the storage is full.
1143 * But how to do it exactly without risking an inconsistent
1144 * state after a reset?
1145 * https://github.com/ARMmbed/mbed-crypto/issues/215
1146 */
1147 overall_status = status;
1148 goto exit;
Gilles Peskinefc762652019-07-22 19:30:34 +02001149 }
1150
Gilles Peskine449bd832023-01-11 14:50:10 +01001151 status = psa_destroy_se_key(driver,
1152 psa_key_slot_get_slot_number(slot));
1153 if (overall_status == PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001154 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001155 }
Gilles Peskinefc762652019-07-22 19:30:34 +02001156 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001157#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1158
Darryl Greend49a4992018-06-18 17:27:26 +01001159#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001160 if (!PSA_KEY_LIFETIME_IS_VOLATILE(slot->attr.lifetime)) {
Ryan Everett4a0ba802024-01-17 14:12:33 +00001161 /* Destroy the copy of the persistent key from storage.
Ryan Everett7ed542e2024-01-17 11:39:09 +00001162 * The slot will still hold a copy of the key until the last reader
1163 * unregisters. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001164 status = psa_destroy_persistent_key(slot->attr.id);
1165 if (overall_status == PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001166 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001167 }
Darryl Greend49a4992018-06-18 17:27:26 +01001168 }
1169#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
Gilles Peskine354f7672019-07-12 23:46:38 +02001170
Gilles Peskinefc762652019-07-22 19:30:34 +02001171#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001172 if (driver != NULL) {
1173 status = psa_save_se_persistent_data(driver);
1174 if (overall_status == PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001175 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001176 }
1177 status = psa_crypto_stop_transaction();
1178 if (overall_status == PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001179 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001180 }
Gilles Peskinefc762652019-07-22 19:30:34 +02001181 }
1182#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1183
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001184exit:
Ryan Everett7ed542e2024-01-17 11:39:09 +00001185 /* Unregister from reading the slot. If we are the last active reader
1186 * then this will wipe the slot. */
1187 status = psa_unregister_read(slot);
1188 /* Prioritize CORRUPTION_DETECTED from unregistering over
1189 * a storage error. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001190 if (status != PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001191 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001192 }
Ryan Everettc053d962024-01-25 17:56:32 +00001193
1194#if defined(MBEDTLS_THREADING_C)
Ryan Everett7fee4f72024-02-09 14:11:27 +00001195 /* Don't overwrite existing errors if the unlock fails. */
1196 status = overall_status;
Ryan Everettc053d962024-01-25 17:56:32 +00001197 PSA_THREADING_CHK_RET(mbedtls_mutex_unlock(
1198 &mbedtls_threading_key_slot_mutex));
1199#endif
1200
Gilles Peskine449bd832023-01-11 14:50:10 +01001201 return overall_status;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001202}
1203
Valerio Settib2bcedb2023-07-10 11:24:00 +02001204#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT) || \
John Durkop0e005192020-10-31 22:06:54 -07001205 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskineb699f072019-04-26 16:06:02 +02001206static psa_status_t psa_get_rsa_public_exponent(
1207 const mbedtls_rsa_context *rsa,
Gilles Peskine449bd832023-01-11 14:50:10 +01001208 psa_key_attributes_t *attributes)
Gilles Peskineb699f072019-04-26 16:06:02 +02001209{
1210 mbedtls_mpi mpi;
Janos Follath24eed8d2019-11-22 13:21:35 +00001211 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb699f072019-04-26 16:06:02 +02001212 uint8_t *buffer = NULL;
1213 size_t buflen;
Gilles Peskine449bd832023-01-11 14:50:10 +01001214 mbedtls_mpi_init(&mpi);
Gilles Peskineb699f072019-04-26 16:06:02 +02001215
Gilles Peskine449bd832023-01-11 14:50:10 +01001216 ret = mbedtls_rsa_export(rsa, NULL, NULL, NULL, NULL, &mpi);
1217 if (ret != 0) {
Gilles Peskineb699f072019-04-26 16:06:02 +02001218 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001219 }
1220 if (mbedtls_mpi_cmp_int(&mpi, 65537) == 0) {
Gilles Peskine772c8b12019-04-26 17:37:21 +02001221 /* It's the default value, which is reported as an empty string,
1222 * so there's nothing to do. */
1223 goto exit;
1224 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001225
Gilles Peskine449bd832023-01-11 14:50:10 +01001226 buflen = mbedtls_mpi_size(&mpi);
1227 buffer = mbedtls_calloc(1, buflen);
1228 if (buffer == NULL) {
Gilles Peskineb699f072019-04-26 16:06:02 +02001229 ret = MBEDTLS_ERR_MPI_ALLOC_FAILED;
1230 goto exit;
1231 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001232 ret = mbedtls_mpi_write_binary(&mpi, buffer, buflen);
1233 if (ret != 0) {
Gilles Peskineb699f072019-04-26 16:06:02 +02001234 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001235 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001236 attributes->domain_parameters = buffer;
1237 attributes->domain_parameters_size = buflen;
1238
1239exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01001240 mbedtls_mpi_free(&mpi);
1241 if (ret != 0) {
1242 mbedtls_free(buffer);
1243 }
1244 return mbedtls_to_psa_error(ret);
Gilles Peskineb699f072019-04-26 16:06:02 +02001245}
Valerio Settib2bcedb2023-07-10 11:24:00 +02001246#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT) ||
John Durkop9814fa22020-11-04 12:28:15 -08001247 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001248
Gilles Peskinebfd322f2019-07-23 11:58:03 +02001249/** Retrieve all the publicly-accessible attributes of a key.
1250 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001251psa_status_t psa_get_key_attributes(mbedtls_svc_key_id_t key,
1252 psa_key_attributes_t *attributes)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001253{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001254 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001255 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001256 psa_key_slot_t *slot;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001257
Gilles Peskine449bd832023-01-11 14:50:10 +01001258 psa_reset_key_attributes(attributes);
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001259
Gilles Peskine449bd832023-01-11 14:50:10 +01001260 status = psa_get_and_lock_key_slot_with_policy(key, &slot, 0, 0);
1261 if (status != PSA_SUCCESS) {
1262 return status;
1263 }
Gilles Peskineb870b182018-07-06 16:02:09 +02001264
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001265 attributes->core = slot->attr;
Gilles Peskine449bd832023-01-11 14:50:10 +01001266 attributes->core.flags &= (MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1267 MBEDTLS_PSA_KA_MASK_DUAL_USE);
Gilles Peskinec8000c02019-08-02 20:15:51 +02001268
1269#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001270 if (psa_get_se_driver_entry(slot->attr.lifetime) != NULL) {
1271 psa_set_key_slot_number(attributes,
1272 psa_key_slot_get_slot_number(slot));
1273 }
Gilles Peskinec8000c02019-08-02 20:15:51 +02001274#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineb699f072019-04-26 16:06:02 +02001275
Gilles Peskine449bd832023-01-11 14:50:10 +01001276 switch (slot->attr.type) {
Valerio Settib2bcedb2023-07-10 11:24:00 +02001277#if (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) && \
1278 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) || \
John Durkop0e005192020-10-31 22:06:54 -07001279 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02001280 case PSA_KEY_TYPE_RSA_KEY_PAIR:
Gilles Peskineb699f072019-04-26 16:06:02 +02001281 case PSA_KEY_TYPE_RSA_PUBLIC_KEY:
Pengyu Lvf75893b2023-12-08 17:21:39 +08001282 /* TODO: This is a temporary situation where domain parameters are deprecated,
1283 * but we need it for namely generating an RSA key with a non-default exponent.
1284 * This would be improved after https://github.com/Mbed-TLS/mbedtls/issues/6494.
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001285 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001286 if (!psa_key_lifetime_is_external(slot->attr.lifetime)) {
Steven Cooremana2371e52020-07-28 14:30:39 +02001287 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02001288
Ronald Cron90857082020-11-25 14:58:33 +01001289 status = mbedtls_psa_rsa_load_representation(
Gilles Peskine449bd832023-01-11 14:50:10 +01001290 slot->attr.type,
1291 slot->key.data,
1292 slot->key.bytes,
1293 &rsa);
1294 if (status != PSA_SUCCESS) {
Steven Cooremana01795d2020-07-24 22:48:15 +02001295 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01001296 }
Steven Cooremana01795d2020-07-24 22:48:15 +02001297
Gilles Peskine449bd832023-01-11 14:50:10 +01001298 status = psa_get_rsa_public_exponent(rsa,
1299 attributes);
1300 mbedtls_rsa_free(rsa);
1301 mbedtls_free(rsa);
Steven Cooremana01795d2020-07-24 22:48:15 +02001302 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001303 break;
Pengyu Lve9efbc22023-12-08 16:59:08 +08001304#else
1305 case PSA_KEY_TYPE_RSA_KEY_PAIR:
1306 case PSA_KEY_TYPE_RSA_PUBLIC_KEY:
1307 attributes->domain_parameters = NULL;
1308 attributes->domain_parameters_size = SIZE_MAX;
1309 break;
Valerio Settib2bcedb2023-07-10 11:24:00 +02001310#endif /* (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) && \
1311 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) ||
John Durkop9814fa22020-11-04 12:28:15 -08001312 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001313 default:
1314 /* Nothing else to do. */
1315 break;
1316 }
1317
Gilles Peskine449bd832023-01-11 14:50:10 +01001318 if (status != PSA_SUCCESS) {
1319 psa_reset_key_attributes(attributes);
1320 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001321
Ryan Everett1b70a072024-01-04 10:32:49 +00001322 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02001323
Gilles Peskine449bd832023-01-11 14:50:10 +01001324 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001325}
1326
Gilles Peskinec8000c02019-08-02 20:15:51 +02001327#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1328psa_status_t psa_get_key_slot_number(
1329 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01001330 psa_key_slot_number_t *slot_number)
Gilles Peskinec8000c02019-08-02 20:15:51 +02001331{
Gilles Peskine449bd832023-01-11 14:50:10 +01001332 if (attributes->core.flags & MBEDTLS_PSA_KA_FLAG_HAS_SLOT_NUMBER) {
Gilles Peskinec8000c02019-08-02 20:15:51 +02001333 *slot_number = attributes->slot_number;
Gilles Peskine449bd832023-01-11 14:50:10 +01001334 return PSA_SUCCESS;
1335 } else {
1336 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinec8000c02019-08-02 20:15:51 +02001337 }
Gilles Peskinec8000c02019-08-02 20:15:51 +02001338}
1339#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1340
Gilles Peskine449bd832023-01-11 14:50:10 +01001341static psa_status_t psa_export_key_buffer_internal(const uint8_t *key_buffer,
1342 size_t key_buffer_size,
1343 uint8_t *data,
1344 size_t data_size,
1345 size_t *data_length)
Steven Cooremana01795d2020-07-24 22:48:15 +02001346{
Gilles Peskine449bd832023-01-11 14:50:10 +01001347 if (key_buffer_size > data_size) {
1348 return PSA_ERROR_BUFFER_TOO_SMALL;
1349 }
1350 memcpy(data, key_buffer, key_buffer_size);
1351 memset(data + key_buffer_size, 0,
1352 data_size - key_buffer_size);
Ronald Crond18b5f82020-11-25 16:46:05 +01001353 *data_length = key_buffer_size;
Gilles Peskine449bd832023-01-11 14:50:10 +01001354 return PSA_SUCCESS;
Steven Cooremana01795d2020-07-24 22:48:15 +02001355}
1356
Ronald Cron7285cda2020-11-26 14:46:37 +01001357psa_status_t psa_export_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001358 const psa_key_attributes_t *attributes,
1359 const uint8_t *key_buffer, size_t key_buffer_size,
Gilles Peskine449bd832023-01-11 14:50:10 +01001360 uint8_t *data, size_t data_size, size_t *data_length)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001361{
Ronald Crond18b5f82020-11-25 16:46:05 +01001362 psa_key_type_t type = attributes->core.type;
1363
Gilles Peskine449bd832023-01-11 14:50:10 +01001364 if (key_type_is_raw_bytes(type) ||
1365 PSA_KEY_TYPE_IS_RSA(type) ||
Przemek Stekiel472b3f32022-12-01 14:38:49 +01001366 PSA_KEY_TYPE_IS_ECC(type) ||
1367 PSA_KEY_TYPE_IS_DH(type)) {
Gilles Peskine449bd832023-01-11 14:50:10 +01001368 return psa_export_key_buffer_internal(
1369 key_buffer, key_buffer_size,
1370 data, data_size, data_length);
1371 } else {
Ronald Cron9486f9d2020-11-26 13:36:23 +01001372 /* This shouldn't happen in the reference implementation, but
1373 it is valid for a special-purpose implementation to omit
1374 support for exporting certain key types. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001375 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron9486f9d2020-11-26 13:36:23 +01001376 }
1377}
1378
Gilles Peskine449bd832023-01-11 14:50:10 +01001379psa_status_t psa_export_key(mbedtls_svc_key_id_t key,
1380 uint8_t *data,
1381 size_t data_size,
1382 size_t *data_length)
Ronald Cron9486f9d2020-11-26 13:36:23 +01001383{
1384 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
1385 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
1386 psa_key_slot_t *slot;
1387
Ronald Crone907e552021-01-18 13:22:38 +01001388 /* Reject a zero-length output buffer now, since this can never be a
1389 * valid key representation. This way we know that data must be a valid
1390 * pointer and we can do things like memset(data, ..., data_size). */
Gilles Peskine449bd832023-01-11 14:50:10 +01001391 if (data_size == 0) {
1392 return PSA_ERROR_BUFFER_TOO_SMALL;
1393 }
Ronald Crone907e552021-01-18 13:22:38 +01001394
Ronald Cron9486f9d2020-11-26 13:36:23 +01001395 /* Set the key to empty now, so that even when there are errors, we always
1396 * set data_length to a value between 0 and data_size. On error, setting
1397 * the key to empty is a good choice because an empty key representation is
1398 * unlikely to be accepted anywhere. */
Jaeden Amerof24c7f82018-06-27 17:20:43 +01001399 *data_length = 0;
1400
Ronald Cron9486f9d2020-11-26 13:36:23 +01001401 /* Export requires the EXPORT flag. There is an exception for public keys,
1402 * which don't require any flag, but
1403 * psa_get_and_lock_key_slot_with_policy() takes care of this.
1404 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001405 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
1406 PSA_KEY_USAGE_EXPORT, 0);
1407 if (status != PSA_SUCCESS) {
1408 return status;
1409 }
mohammad160306e79202018-03-28 13:17:44 +03001410
Ronald Crond18b5f82020-11-25 16:46:05 +01001411 psa_key_attributes_t attributes = {
1412 .core = slot->attr
1413 };
Gilles Peskine449bd832023-01-11 14:50:10 +01001414 status = psa_driver_wrapper_export_key(&attributes,
1415 slot->key.data, slot->key.bytes,
1416 data, data_size, data_length);
Ronald Cron9486f9d2020-11-26 13:36:23 +01001417
Ryan Everett1b70a072024-01-04 10:32:49 +00001418 unlock_status = psa_unregister_read(slot);
Ronald Cron9486f9d2020-11-26 13:36:23 +01001419
Gilles Peskine449bd832023-01-11 14:50:10 +01001420 return (status == PSA_SUCCESS) ? unlock_status : status;
Ronald Cron9486f9d2020-11-26 13:36:23 +01001421}
1422
Ronald Cron7285cda2020-11-26 14:46:37 +01001423psa_status_t psa_export_public_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001424 const psa_key_attributes_t *attributes,
1425 const uint8_t *key_buffer,
1426 size_t key_buffer_size,
1427 uint8_t *data,
1428 size_t data_size,
Gilles Peskine449bd832023-01-11 14:50:10 +01001429 size_t *data_length)
Ronald Cron9486f9d2020-11-26 13:36:23 +01001430{
Ronald Crond18b5f82020-11-25 16:46:05 +01001431 psa_key_type_t type = attributes->core.type;
Ronald Crond18b5f82020-11-25 16:46:05 +01001432
Przemek Stekiel6fd72b62023-04-27 10:20:56 +02001433 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(type) &&
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001434 (PSA_KEY_TYPE_IS_RSA(type) || PSA_KEY_TYPE_IS_ECC(type) ||
1435 PSA_KEY_TYPE_IS_DH(type))) {
Przemek Stekiel6fd72b62023-04-27 10:20:56 +02001436 /* Exporting public -> public */
1437 return psa_export_key_buffer_internal(
1438 key_buffer, key_buffer_size,
1439 data, data_size, data_length);
1440 } else if (PSA_KEY_TYPE_IS_RSA(type)) {
Valerio Settib2bcedb2023-07-10 11:24:00 +02001441#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT) || \
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001442 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
1443 return mbedtls_psa_rsa_export_public_key(attributes,
1444 key_buffer,
1445 key_buffer_size,
1446 data,
1447 data_size,
1448 data_length);
Darryl Green9e2d7a02018-07-24 16:33:30 +01001449#else
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001450 /* We don't know how to convert a private RSA key to public. */
1451 return PSA_ERROR_NOT_SUPPORTED;
Valerio Settib2bcedb2023-07-10 11:24:00 +02001452#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT) ||
John Durkop9814fa22020-11-04 12:28:15 -08001453 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Przemek Stekiel6fd72b62023-04-27 10:20:56 +02001454 } else if (PSA_KEY_TYPE_IS_ECC(type)) {
Valerio Setti27c501a2023-06-27 16:58:52 +02001455#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_EXPORT) || \
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001456 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
1457 return mbedtls_psa_ecp_export_public_key(attributes,
1458 key_buffer,
1459 key_buffer_size,
1460 data,
1461 data_size,
1462 data_length);
Steven Cooreman560c28a2020-07-24 23:20:24 +02001463#else
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001464 /* We don't know how to convert a private ECC key to public */
1465 return PSA_ERROR_NOT_SUPPORTED;
Valerio Setti27c501a2023-06-27 16:58:52 +02001466#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_EXPORT) ||
John Durkop9814fa22020-11-04 12:28:15 -08001467 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
Przemek Stekiel6fd72b62023-04-27 10:20:56 +02001468 } else if (PSA_KEY_TYPE_IS_DH(type)) {
Valerio Settia55f0422023-07-10 15:34:41 +02001469#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_EXPORT) || \
Przemek Stekiel6d85afa2023-04-28 11:42:17 +02001470 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY)
Przemek Stekiel152bb462023-06-01 11:52:39 +02001471 return mbedtls_psa_ffdh_export_public_key(attributes,
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001472 key_buffer,
1473 key_buffer_size,
1474 data, data_size,
1475 data_length);
Przemek Stekiel472b3f32022-12-01 14:38:49 +01001476#else
Przemek Stekiel472b3f32022-12-01 14:38:49 +01001477 return PSA_ERROR_NOT_SUPPORTED;
Valerio Settia55f0422023-07-10 15:34:41 +02001478#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_EXPORT) ||
Przemek Stekiel6d85afa2023-04-28 11:42:17 +02001479 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY) */
Gilles Peskine449bd832023-01-11 14:50:10 +01001480 } else {
Przemek Stekiel0b11ee02023-05-16 13:26:06 +02001481 (void) key_buffer;
1482 (void) key_buffer_size;
1483 (void) data;
1484 (void) data_size;
1485 (void) data_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01001486 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman560c28a2020-07-24 23:20:24 +02001487 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001488}
Ronald Crond18b5f82020-11-25 16:46:05 +01001489
Gilles Peskine449bd832023-01-11 14:50:10 +01001490psa_status_t psa_export_public_key(mbedtls_svc_key_id_t key,
1491 uint8_t *data,
1492 size_t data_size,
1493 size_t *data_length)
Moran Pekerdd4ea382018-04-03 15:30:03 +03001494{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001495 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001496 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001497 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01001498 psa_key_attributes_t attributes;
Darryl Greendd8fb772018-11-07 16:00:44 +00001499
Ronald Crone907e552021-01-18 13:22:38 +01001500 /* Reject a zero-length output buffer now, since this can never be a
1501 * valid key representation. This way we know that data must be a valid
1502 * pointer and we can do things like memset(data, ..., data_size). */
Gilles Peskine449bd832023-01-11 14:50:10 +01001503 if (data_size == 0) {
1504 return PSA_ERROR_BUFFER_TOO_SMALL;
1505 }
Ronald Crone907e552021-01-18 13:22:38 +01001506
Darryl Greendd8fb772018-11-07 16:00:44 +00001507 /* Set the key to empty now, so that even when there are errors, we always
1508 * set data_length to a value between 0 and data_size. On error, setting
1509 * the key to empty is a good choice because an empty key representation is
1510 * unlikely to be accepted anywhere. */
1511 *data_length = 0;
1512
1513 /* Exporting a public key doesn't require a usage flag. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001514 status = psa_get_and_lock_key_slot_with_policy(key, &slot, 0, 0);
1515 if (status != PSA_SUCCESS) {
1516 return status;
1517 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001518
Gilles Peskine449bd832023-01-11 14:50:10 +01001519 if (!PSA_KEY_TYPE_IS_ASYMMETRIC(slot->attr.type)) {
1520 status = PSA_ERROR_INVALID_ARGUMENT;
1521 goto exit;
Ronald Cron9486f9d2020-11-26 13:36:23 +01001522 }
1523
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01001524 attributes = (psa_key_attributes_t) {
Ronald Crond18b5f82020-11-25 16:46:05 +01001525 .core = slot->attr
1526 };
Ronald Cron67227982020-11-26 15:16:05 +01001527 status = psa_driver_wrapper_export_public_key(
Ronald Crond18b5f82020-11-25 16:46:05 +01001528 &attributes, slot->key.data, slot->key.bytes,
Gilles Peskine449bd832023-01-11 14:50:10 +01001529 data, data_size, data_length);
Ronald Cron9486f9d2020-11-26 13:36:23 +01001530
1531exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00001532 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02001533
Gilles Peskine449bd832023-01-11 14:50:10 +01001534 return (status == PSA_SUCCESS) ? unlock_status : status;
Moran Pekerdd4ea382018-04-03 15:30:03 +03001535}
1536
Tom Cosgrove6ef9bb32023-03-08 14:19:51 +00001537MBEDTLS_STATIC_ASSERT(
1538 (MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE) == 0,
1539 "One or more key attribute flag is listed as both external-only and dual-use")
1540MBEDTLS_STATIC_ASSERT(
1541 (PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE) == 0,
1542 "One or more key attribute flag is listed as both internal-only and dual-use")
1543MBEDTLS_STATIC_ASSERT(
1544 (PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY) == 0,
1545 "One or more key attribute flag is listed as both internal-only and external-only")
Gilles Peskine91e8c332019-08-02 19:19:39 +02001546
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001547/** Validate that a key policy is internally well-formed.
1548 *
1549 * This function only rejects invalid policies. It does not validate the
1550 * consistency of the policy with respect to other attributes of the key
1551 * such as the key type.
1552 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001553static psa_status_t psa_validate_key_policy(const psa_key_policy_t *policy)
Gilles Peskine4747d192019-04-17 15:05:45 +02001554{
Gilles Peskine449bd832023-01-11 14:50:10 +01001555 if ((policy->usage & ~(PSA_KEY_USAGE_EXPORT |
1556 PSA_KEY_USAGE_COPY |
1557 PSA_KEY_USAGE_ENCRYPT |
1558 PSA_KEY_USAGE_DECRYPT |
1559 PSA_KEY_USAGE_SIGN_MESSAGE |
1560 PSA_KEY_USAGE_VERIFY_MESSAGE |
1561 PSA_KEY_USAGE_SIGN_HASH |
1562 PSA_KEY_USAGE_VERIFY_HASH |
1563 PSA_KEY_USAGE_VERIFY_DERIVATION |
1564 PSA_KEY_USAGE_DERIVE)) != 0) {
1565 return PSA_ERROR_INVALID_ARGUMENT;
1566 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001567
Gilles Peskine449bd832023-01-11 14:50:10 +01001568 return PSA_SUCCESS;
Gilles Peskine4747d192019-04-17 15:05:45 +02001569}
1570
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001571/** Validate the internal consistency of key attributes.
1572 *
1573 * This function only rejects invalid attribute values. If does not
1574 * validate the consistency of the attributes with any key data that may
1575 * be involved in the creation of the key.
1576 *
1577 * Call this function early in the key creation process.
1578 *
1579 * \param[in] attributes Key attributes for the new key.
1580 * \param[out] p_drv On any return, the driver for the key, if any.
1581 * NULL for a transparent key.
1582 *
1583 */
1584static psa_status_t psa_validate_key_attributes(
1585 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01001586 psa_se_drv_table_entry_t **p_drv)
Darryl Green0c6575a2018-11-07 16:05:30 +00001587{
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001588 psa_status_t status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine449bd832023-01-11 14:50:10 +01001589 psa_key_lifetime_t lifetime = psa_get_key_lifetime(attributes);
1590 mbedtls_svc_key_id_t key = psa_get_key_id(attributes);
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001591
Gilles Peskine449bd832023-01-11 14:50:10 +01001592 status = psa_validate_key_location(lifetime, p_drv);
1593 if (status != PSA_SUCCESS) {
1594 return status;
Ronald Crond2ed4812020-07-17 16:11:30 +02001595 }
1596
Gilles Peskine449bd832023-01-11 14:50:10 +01001597 status = psa_validate_key_persistence(lifetime);
1598 if (status != PSA_SUCCESS) {
1599 return status;
1600 }
1601
1602 if (PSA_KEY_LIFETIME_IS_VOLATILE(lifetime)) {
1603 if (MBEDTLS_SVC_KEY_ID_GET_KEY_ID(key) != 0) {
1604 return PSA_ERROR_INVALID_ARGUMENT;
1605 }
1606 } else {
1607 if (!psa_is_valid_key_id(psa_get_key_id(attributes), 0)) {
1608 return PSA_ERROR_INVALID_ARGUMENT;
1609 }
1610 }
1611
1612 status = psa_validate_key_policy(&attributes->core.policy);
1613 if (status != PSA_SUCCESS) {
1614 return status;
1615 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001616
1617 /* Refuse to create overly large keys.
1618 * Note that this doesn't trigger on import if the attributes don't
1619 * explicitly specify a size (so psa_get_key_bits returns 0), so
1620 * psa_import_key() needs its own checks. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001621 if (psa_get_key_bits(attributes) > PSA_MAX_KEY_BITS) {
1622 return PSA_ERROR_NOT_SUPPORTED;
1623 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001624
Gilles Peskine91e8c332019-08-02 19:19:39 +02001625 /* Reject invalid flags. These should not be reachable through the API. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001626 if (attributes->core.flags & ~(MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1627 MBEDTLS_PSA_KA_MASK_DUAL_USE)) {
1628 return PSA_ERROR_INVALID_ARGUMENT;
1629 }
Gilles Peskine91e8c332019-08-02 19:19:39 +02001630
Gilles Peskine449bd832023-01-11 14:50:10 +01001631 return PSA_SUCCESS;
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001632}
1633
Gilles Peskine4747d192019-04-17 15:05:45 +02001634/** Prepare a key slot to receive key material.
1635 *
1636 * This function allocates a key slot and sets its metadata.
1637 *
1638 * If this function fails, call psa_fail_key_creation().
1639 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001640 * This function is intended to be used as follows:
1641 * -# Call psa_start_key_creation() to allocate a key slot, prepare
Ronald Croncf56a0a2020-08-04 09:51:30 +02001642 * it with the specified attributes, and in case of a volatile key assign it
1643 * a volatile key identifier.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001644 * -# Populate the slot with the key material.
1645 * -# Call psa_finish_key_creation() to finalize the creation of the slot.
1646 * In case of failure at any step, stop the sequence and call
1647 * psa_fail_key_creation().
1648 *
Ryan Everettb69118e2024-01-02 15:54:32 +00001649 * On success, the key slot's state is PSA_SLOT_FILLING.
1650 * It is the responsibility of the caller to change the slot's state to
1651 * PSA_SLOT_EMPTY/FULL once key creation has finished.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001652 *
Gilles Peskinedf179142019-07-15 22:02:14 +02001653 * \param method An identification of the calling function.
Gilles Peskine011e4282019-06-26 18:34:38 +02001654 * \param[in] attributes Key attributes for the new key.
Gilles Peskine011e4282019-06-26 18:34:38 +02001655 * \param[out] p_slot On success, a pointer to the prepared slot.
1656 * \param[out] p_drv On any return, the driver for the key, if any.
1657 * NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001658 *
1659 * \retval #PSA_SUCCESS
1660 * The key slot is ready to receive key material.
1661 * \return If this function fails, the key slot is an invalid state.
1662 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001663 */
1664static psa_status_t psa_start_key_creation(
Gilles Peskinedf179142019-07-15 22:02:14 +02001665 psa_key_creation_method_t method,
Gilles Peskine4747d192019-04-17 15:05:45 +02001666 const psa_key_attributes_t *attributes,
Gilles Peskine011e4282019-06-26 18:34:38 +02001667 psa_key_slot_t **p_slot,
Gilles Peskine449bd832023-01-11 14:50:10 +01001668 psa_se_drv_table_entry_t **p_drv)
Gilles Peskine4747d192019-04-17 15:05:45 +02001669{
1670 psa_status_t status;
Ronald Cron2a993152020-07-17 14:13:26 +02001671 psa_key_id_t volatile_key_id;
Gilles Peskine4747d192019-04-17 15:05:45 +02001672 psa_key_slot_t *slot;
1673
Gilles Peskinedf179142019-07-15 22:02:14 +02001674 (void) method;
Gilles Peskine011e4282019-06-26 18:34:38 +02001675 *p_drv = NULL;
1676
Gilles Peskine449bd832023-01-11 14:50:10 +01001677 status = psa_validate_key_attributes(attributes, p_drv);
1678 if (status != PSA_SUCCESS) {
1679 return status;
1680 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001681
Ryan Everettb69118e2024-01-02 15:54:32 +00001682 status = psa_reserve_free_key_slot(&volatile_key_id, p_slot);
Gilles Peskine449bd832023-01-11 14:50:10 +01001683 if (status != PSA_SUCCESS) {
1684 return status;
1685 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001686 slot = *p_slot;
1687
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001688 /* We're storing the declared bit-size of the key. It's up to each
1689 * creation mechanism to verify that this information is correct.
1690 * It's automatically correct for mechanisms that use the bit-size as
Gilles Peskineb46bef22019-07-30 21:32:04 +02001691 * an input (generate, device) but not for those where the bit-size
Ronald Cronc4d1b512020-07-31 11:26:37 +02001692 * is optional (import, copy). In case of a volatile key, assign it the
1693 * volatile key identifier associated to the slot returned to contain its
1694 * definition. */
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001695
1696 slot->attr = attributes->core;
Gilles Peskine449bd832023-01-11 14:50:10 +01001697 if (PSA_KEY_LIFETIME_IS_VOLATILE(slot->attr.lifetime)) {
Ronald Cronc4d1b512020-07-31 11:26:37 +02001698#if !defined(MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER)
1699 slot->attr.id = volatile_key_id;
1700#else
1701 slot->attr.id.key_id = volatile_key_id;
1702#endif
1703 }
Gilles Peskinec744d992019-07-30 17:26:54 +02001704
Gilles Peskine91e8c332019-08-02 19:19:39 +02001705 /* Erase external-only flags from the internal copy. To access
Gilles Peskine013f5472019-08-07 15:42:14 +02001706 * external-only flags, query `attributes`. Thanks to the check
1707 * in psa_validate_key_attributes(), this leaves the dual-use
Ryan Everettb69118e2024-01-02 15:54:32 +00001708 * flags and any internal flag that psa_reserve_free_key_slot()
Gilles Peskine013f5472019-08-07 15:42:14 +02001709 * may have set. */
1710 slot->attr.flags &= ~MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY;
Gilles Peskine91e8c332019-08-02 19:19:39 +02001711
Gilles Peskinecbaff462019-07-12 23:46:04 +02001712#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001713 /* For a key in a secure element, we need to do three things
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001714 * when creating or registering a persistent key:
Gilles Peskine60450a42019-07-25 11:32:45 +02001715 * create the key file in internal storage, create the
1716 * key inside the secure element, and update the driver's
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001717 * persistent data. This is done by starting a transaction that will
1718 * encompass these three actions.
1719 * For registering a volatile key, we just need to find an appropriate
1720 * slot number inside the SE. Since the key is designated volatile, creating
1721 * a transaction is not required. */
Gilles Peskine60450a42019-07-25 11:32:45 +02001722 /* The first thing to do is to find a slot number for the new key.
1723 * We save the slot number in persistent storage as part of the
1724 * transaction data. It will be needed to recover if the power
1725 * fails during the key creation process, to clean up on the secure
1726 * element side after restarting. Obtaining a slot number from the
1727 * secure element driver updates its persistent state, but we do not yet
1728 * save the driver's persistent state, so that if the power fails,
Gilles Peskinefc762652019-07-22 19:30:34 +02001729 * we can roll back to a state where the key doesn't exist. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001730 if (*p_drv != NULL) {
Ronald Cronea0f8a62020-11-25 17:52:23 +01001731 psa_key_slot_number_t slot_number;
Gilles Peskine449bd832023-01-11 14:50:10 +01001732 status = psa_find_se_slot_for_key(attributes, method, *p_drv,
1733 &slot_number);
1734 if (status != PSA_SUCCESS) {
1735 return status;
1736 }
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001737
Gilles Peskine449bd832023-01-11 14:50:10 +01001738 if (!PSA_KEY_LIFETIME_IS_VOLATILE(attributes->core.lifetime)) {
1739 psa_crypto_prepare_transaction(PSA_CRYPTO_TRANSACTION_CREATE_KEY);
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001740 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001741 psa_crypto_transaction.key.slot = slot_number;
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001742 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskine449bd832023-01-11 14:50:10 +01001743 status = psa_crypto_save_transaction();
1744 if (status != PSA_SUCCESS) {
1745 (void) psa_crypto_stop_transaction();
1746 return status;
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001747 }
Gilles Peskine66be51c2019-07-25 18:02:52 +02001748 }
Ronald Cronea0f8a62020-11-25 17:52:23 +01001749
1750 status = psa_copy_key_material_into_slot(
Gilles Peskine449bd832023-01-11 14:50:10 +01001751 slot, (uint8_t *) (&slot_number), sizeof(slot_number));
Darryl Green0c6575a2018-11-07 16:05:30 +00001752 }
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001753
Gilles Peskine449bd832023-01-11 14:50:10 +01001754 if (*p_drv == NULL && method == PSA_KEY_CREATION_REGISTER) {
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001755 /* Key registration only makes sense with a secure element. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001756 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001757 }
Gilles Peskinecbaff462019-07-12 23:46:04 +02001758#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1759
Gilles Peskine449bd832023-01-11 14:50:10 +01001760 return PSA_SUCCESS;
Darryl Green0c6575a2018-11-07 16:05:30 +00001761}
Gilles Peskine4747d192019-04-17 15:05:45 +02001762
1763/** Finalize the creation of a key once its key material has been set.
1764 *
1765 * This entails writing the key to persistent storage.
1766 *
1767 * If this function fails, call psa_fail_key_creation().
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001768 * See the documentation of psa_start_key_creation() for the intended use
1769 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001770 *
Ryan Everettb69118e2024-01-02 15:54:32 +00001771 * If the finalization succeeds, the function sets the key slot's state to
1772 * PSA_SLOT_FULL, and the key slot can no longer be accessed as part of the
1773 * key creation process.
Ronald Cron50972942020-11-14 11:28:25 +01001774 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001775 * \param[in,out] slot Pointer to the slot with key material.
1776 * \param[in] driver The secure element driver for the key,
1777 * or NULL for a transparent key.
Ronald Cron81709fc2020-11-14 12:10:32 +01001778 * \param[out] key On success, identifier of the key. Note that the
1779 * key identifier is also stored in the key slot.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001780 *
1781 * \retval #PSA_SUCCESS
Ronald Croncf56a0a2020-08-04 09:51:30 +02001782 * The key was successfully created.
Gilles Peskineed733552023-02-14 19:21:09 +01001783 * \retval #PSA_ERROR_INSUFFICIENT_MEMORY \emptydescription
1784 * \retval #PSA_ERROR_INSUFFICIENT_STORAGE \emptydescription
1785 * \retval #PSA_ERROR_ALREADY_EXISTS \emptydescription
1786 * \retval #PSA_ERROR_DATA_INVALID \emptydescription
1787 * \retval #PSA_ERROR_DATA_CORRUPT \emptydescription
1788 * \retval #PSA_ERROR_STORAGE_FAILURE \emptydescription
gabor-mezei-arm452b0a32020-11-09 17:42:55 +01001789 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001790 * \return If this function fails, the key slot is an invalid state.
1791 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001792 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001793static psa_status_t psa_finish_key_creation(
1794 psa_key_slot_t *slot,
Ronald Cron81709fc2020-11-14 12:10:32 +01001795 psa_se_drv_table_entry_t *driver,
1796 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02001797{
1798 psa_status_t status = PSA_SUCCESS;
Gilles Peskine30afafd2019-04-25 13:47:40 +02001799 (void) slot;
Gilles Peskine011e4282019-06-26 18:34:38 +02001800 (void) driver;
Gilles Peskine4747d192019-04-17 15:05:45 +02001801
Ryan Everett91ffe5b2024-01-23 20:05:42 +00001802#if defined(MBEDTLS_THREADING_C)
1803 PSA_THREADING_CHK_RET(mbedtls_mutex_lock(
1804 &mbedtls_threading_key_slot_mutex));
1805#endif
1806
Gilles Peskine4747d192019-04-17 15:05:45 +02001807#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001808 if (!PSA_KEY_LIFETIME_IS_VOLATILE(slot->attr.lifetime)) {
Gilles Peskine1df83d42019-07-23 16:13:14 +02001809#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001810 if (driver != NULL) {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001811 psa_se_key_data_storage_t data;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001812 psa_key_slot_number_t slot_number =
Gilles Peskine449bd832023-01-11 14:50:10 +01001813 psa_key_slot_get_slot_number(slot);
Ronald Cronea0f8a62020-11-25 17:52:23 +01001814
Tom Cosgrove6ef9bb32023-03-08 14:19:51 +00001815 MBEDTLS_STATIC_ASSERT(sizeof(slot_number) ==
1816 sizeof(data.slot_number),
1817 "Slot number size does not match psa_se_key_data_storage_t");
1818
Gilles Peskine449bd832023-01-11 14:50:10 +01001819 memcpy(&data.slot_number, &slot_number, sizeof(slot_number));
1820 status = psa_save_persistent_key(&slot->attr,
1821 (uint8_t *) &data,
1822 sizeof(data));
1823 } else
Gilles Peskine1df83d42019-07-23 16:13:14 +02001824#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1825 {
Steven Cooreman40120f62020-10-29 11:42:22 +01001826 /* Key material is saved in export representation in the slot, so
1827 * just pass the slot buffer for storage. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001828 status = psa_save_persistent_key(&slot->attr,
1829 slot->key.data,
1830 slot->key.bytes);
Gilles Peskine1df83d42019-07-23 16:13:14 +02001831 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001832 }
Darryl Green0c6575a2018-11-07 16:05:30 +00001833#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
1834
Gilles Peskinecbaff462019-07-12 23:46:04 +02001835#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001836 /* Finish the transaction for a key creation. This does not
1837 * happen when registering an existing key. Detect this case
1838 * by checking whether a transaction is in progress (actual
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001839 * creation of a persistent key in a secure element requires a transaction,
1840 * but registration or volatile key creation doesn't use one). */
Gilles Peskine449bd832023-01-11 14:50:10 +01001841 if (driver != NULL &&
1842 psa_crypto_transaction.unknown.type == PSA_CRYPTO_TRANSACTION_CREATE_KEY) {
1843 status = psa_save_se_persistent_data(driver);
1844 if (status != PSA_SUCCESS) {
1845 psa_destroy_persistent_key(slot->attr.id);
Ryan Everett91ffe5b2024-01-23 20:05:42 +00001846
1847#if defined(MBEDTLS_THREADING_C)
1848 PSA_THREADING_CHK_RET(mbedtls_mutex_unlock(
1849 &mbedtls_threading_key_slot_mutex));
1850#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001851 return status;
Gilles Peskinecbaff462019-07-12 23:46:04 +02001852 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001853 status = psa_crypto_stop_transaction();
Gilles Peskinecbaff462019-07-12 23:46:04 +02001854 }
1855#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1856
Gilles Peskine449bd832023-01-11 14:50:10 +01001857 if (status == PSA_SUCCESS) {
Ronald Cron81709fc2020-11-14 12:10:32 +01001858 *key = slot->attr.id;
Ryan Everettb69118e2024-01-02 15:54:32 +00001859 status = psa_key_slot_state_transition(slot, PSA_SLOT_FILLING,
1860 PSA_SLOT_FULL);
Gilles Peskine449bd832023-01-11 14:50:10 +01001861 if (status != PSA_SUCCESS) {
Ronald Cron81709fc2020-11-14 12:10:32 +01001862 *key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01001863 }
Ronald Cron81709fc2020-11-14 12:10:32 +01001864 }
Ronald Cron50972942020-11-14 11:28:25 +01001865
Ryan Everett91ffe5b2024-01-23 20:05:42 +00001866#if defined(MBEDTLS_THREADING_C)
1867 PSA_THREADING_CHK_RET(mbedtls_mutex_unlock(
1868 &mbedtls_threading_key_slot_mutex));
1869#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001870 return status;
Gilles Peskine4747d192019-04-17 15:05:45 +02001871}
1872
1873/** Abort the creation of a key.
1874 *
1875 * You may call this function after calling psa_start_key_creation(),
1876 * or after psa_finish_key_creation() fails. In other circumstances, this
1877 * function may not clean up persistent storage.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001878 * See the documentation of psa_start_key_creation() for the intended use
Ryan Everettb69118e2024-01-02 15:54:32 +00001879 * of this function. Sets the slot's state to PSA_SLOT_EMPTY.
Gilles Peskine4747d192019-04-17 15:05:45 +02001880 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001881 * \param[in,out] slot Pointer to the slot with key material.
1882 * \param[in] driver The secure element driver for the key,
1883 * or NULL for a transparent key.
Gilles Peskine4747d192019-04-17 15:05:45 +02001884 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001885static void psa_fail_key_creation(psa_key_slot_t *slot,
1886 psa_se_drv_table_entry_t *driver)
Gilles Peskine4747d192019-04-17 15:05:45 +02001887{
Gilles Peskine011e4282019-06-26 18:34:38 +02001888 (void) driver;
1889
Gilles Peskine449bd832023-01-11 14:50:10 +01001890 if (slot == NULL) {
Gilles Peskine4747d192019-04-17 15:05:45 +02001891 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01001892 }
Gilles Peskine011e4282019-06-26 18:34:38 +02001893
Ryan Everettb7101442024-01-23 20:09:49 +00001894#if defined(MBEDTLS_THREADING_C)
1895 mbedtls_mutex_lock(&mbedtls_threading_key_slot_mutex);
1896#endif
1897
Gilles Peskine011e4282019-06-26 18:34:38 +02001898#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001899 /* TODO: If the key has already been created in the secure
Gilles Peskine011e4282019-06-26 18:34:38 +02001900 * element, and the failure happened later (when saving metadata
1901 * to internal storage), we need to destroy the key in the secure
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001902 * element.
1903 * https://github.com/ARMmbed/mbed-crypto/issues/217
1904 */
Gilles Peskinefc762652019-07-22 19:30:34 +02001905
Gilles Peskined7729582019-08-05 15:55:54 +02001906 /* Abort the ongoing transaction if any (there may not be one if
1907 * the creation process failed before starting one, or if the
1908 * key creation is a registration of a key in a secure element).
1909 * Earlier functions must already have done what it takes to undo any
1910 * partial creation. All that's left is to update the transaction data
1911 * itself. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001912 (void) psa_crypto_stop_transaction();
Gilles Peskine011e4282019-06-26 18:34:38 +02001913#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1914
Gilles Peskine449bd832023-01-11 14:50:10 +01001915 psa_wipe_key_slot(slot);
Ryan Everettb7101442024-01-23 20:09:49 +00001916
1917#if defined(MBEDTLS_THREADING_C)
1918 mbedtls_mutex_unlock(&mbedtls_threading_key_slot_mutex);
1919#endif
Gilles Peskine4747d192019-04-17 15:05:45 +02001920}
1921
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001922/** Validate optional attributes during key creation.
1923 *
1924 * Some key attributes are optional during key creation. If they are
1925 * specified in the attributes structure, check that they are consistent
1926 * with the data in the slot.
1927 *
1928 * This function should be called near the end of key creation, after
1929 * the slot in memory is fully populated but before saving persistent data.
1930 */
1931static psa_status_t psa_validate_optional_attributes(
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001932 const psa_key_slot_t *slot,
Gilles Peskine449bd832023-01-11 14:50:10 +01001933 const psa_key_attributes_t *attributes)
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001934{
Gilles Peskine449bd832023-01-11 14:50:10 +01001935 if (attributes->core.type != 0) {
1936 if (attributes->core.type != slot->attr.type) {
1937 return PSA_ERROR_INVALID_ARGUMENT;
1938 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001939 }
1940
Gilles Peskine449bd832023-01-11 14:50:10 +01001941 if (attributes->domain_parameters_size != 0) {
Valerio Settib2bcedb2023-07-10 11:24:00 +02001942#if (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) && \
1943 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01001944 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
1945 if (PSA_KEY_TYPE_IS_RSA(slot->attr.type)) {
Steven Cooremana2371e52020-07-28 14:30:39 +02001946 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman75b74362020-07-28 14:30:13 +02001947 mbedtls_mpi actual, required;
Steven Cooreman6d839f02020-07-30 11:36:45 +02001948 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooremana01795d2020-07-24 22:48:15 +02001949
Ronald Cron90857082020-11-25 14:58:33 +01001950 psa_status_t status = mbedtls_psa_rsa_load_representation(
Gilles Peskine449bd832023-01-11 14:50:10 +01001951 slot->attr.type,
1952 slot->key.data,
1953 slot->key.bytes,
1954 &rsa);
1955 if (status != PSA_SUCCESS) {
1956 return status;
1957 }
Steven Cooreman75b74362020-07-28 14:30:13 +02001958
Gilles Peskine449bd832023-01-11 14:50:10 +01001959 mbedtls_mpi_init(&actual);
1960 mbedtls_mpi_init(&required);
1961 ret = mbedtls_rsa_export(rsa,
1962 NULL, NULL, NULL, NULL, &actual);
1963 mbedtls_rsa_free(rsa);
1964 mbedtls_free(rsa);
1965 if (ret != 0) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001966 goto rsa_exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001967 }
1968 ret = mbedtls_mpi_read_binary(&required,
1969 attributes->domain_parameters,
1970 attributes->domain_parameters_size);
1971 if (ret != 0) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001972 goto rsa_exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001973 }
1974 if (mbedtls_mpi_cmp_mpi(&actual, &required) != 0) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001975 ret = MBEDTLS_ERR_RSA_BAD_INPUT_DATA;
Gilles Peskine449bd832023-01-11 14:50:10 +01001976 }
1977rsa_exit:
1978 mbedtls_mpi_free(&actual);
1979 mbedtls_mpi_free(&required);
1980 if (ret != 0) {
1981 return mbedtls_to_psa_error(ret);
1982 }
1983 } else
Valerio Settib2bcedb2023-07-10 11:24:00 +02001984#endif /* (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) &&
1985 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) ||
John Durkop9814fa22020-11-04 12:28:15 -08001986 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001987 {
Gilles Peskine449bd832023-01-11 14:50:10 +01001988 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001989 }
1990 }
1991
Gilles Peskine449bd832023-01-11 14:50:10 +01001992 if (attributes->core.bits != 0) {
1993 if (attributes->core.bits != slot->attr.bits) {
1994 return PSA_ERROR_INVALID_ARGUMENT;
1995 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001996 }
1997
Gilles Peskine449bd832023-01-11 14:50:10 +01001998 return PSA_SUCCESS;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001999}
2000
Gilles Peskine449bd832023-01-11 14:50:10 +01002001psa_status_t psa_import_key(const psa_key_attributes_t *attributes,
2002 const uint8_t *data,
2003 size_t data_length,
2004 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02002005{
2006 psa_status_t status;
2007 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002008 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002009 size_t bits;
Archanad8a83dc2021-06-14 10:04:16 +05302010 size_t storage_size = data_length;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002011
Ronald Cron81709fc2020-11-14 12:10:32 +01002012 *key = MBEDTLS_SVC_KEY_ID_INIT;
2013
Gilles Peskine0f84d622019-09-12 19:03:13 +02002014 /* Reject zero-length symmetric keys (including raw data key objects).
2015 * This also rejects any key which might be encoded as an empty string,
2016 * which is never valid. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002017 if (data_length == 0) {
2018 return PSA_ERROR_INVALID_ARGUMENT;
2019 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02002020
Archana449608b2021-09-08 15:36:05 +05302021 /* Ensure that the bytes-to-bits conversion cannot overflow. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002022 if (data_length > SIZE_MAX / 8) {
2023 return PSA_ERROR_NOT_SUPPORTED;
2024 }
Archana6ed4bda2021-08-04 10:47:15 +05302025
Gilles Peskine449bd832023-01-11 14:50:10 +01002026 status = psa_start_key_creation(PSA_KEY_CREATION_IMPORT, attributes,
2027 &slot, &driver);
2028 if (status != PSA_SUCCESS) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002029 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002030 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002031
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002032 /* In the case of a transparent key or an opaque key stored in local
Archana449608b2021-09-08 15:36:05 +05302033 * storage ( thus not in the case of importing a key in a secure element
2034 * with storage ( MBEDTLS_PSA_CRYPTO_SE_C ) ),we have to allocate a
2035 * buffer to hold the imported key material. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002036 if (slot->key.data == NULL) {
2037 if (psa_key_lifetime_is_external(attributes->core.lifetime)) {
Archana449608b2021-09-08 15:36:05 +05302038 status = psa_driver_wrapper_get_key_buffer_size_from_key_data(
Gilles Peskine449bd832023-01-11 14:50:10 +01002039 attributes, data, data_length, &storage_size);
2040 if (status != PSA_SUCCESS) {
Archanad8a83dc2021-06-14 10:04:16 +05302041 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002042 }
Archanad8a83dc2021-06-14 10:04:16 +05302043 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002044 status = psa_allocate_buffer_to_slot(slot, storage_size);
2045 if (status != PSA_SUCCESS) {
Gilles Peskineb46bef22019-07-30 21:32:04 +02002046 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002047 }
Gilles Peskine5d309672019-07-12 23:47:28 +02002048 }
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002049
2050 bits = slot->attr.bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01002051 status = psa_driver_wrapper_import_key(attributes,
2052 data, data_length,
2053 slot->key.data,
2054 slot->key.bytes,
2055 &slot->key.bytes, &bits);
2056 if (status != PSA_SUCCESS) {
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002057 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002058 }
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002059
Gilles Peskine449bd832023-01-11 14:50:10 +01002060 if (slot->attr.bits == 0) {
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002061 slot->attr.bits = (psa_key_bits_t) bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01002062 } else if (bits != slot->attr.bits) {
Steven Cooremanac3434f2021-01-15 17:36:02 +01002063 status = PSA_ERROR_INVALID_ARGUMENT;
2064 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02002065 }
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01002066
Archana6ed4bda2021-08-04 10:47:15 +05302067 /* Enforce a size limit, and in particular ensure that the bit
2068 * size fits in its representation type.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01002069 if (bits > PSA_MAX_KEY_BITS) {
Archana6ed4bda2021-08-04 10:47:15 +05302070 status = PSA_ERROR_NOT_SUPPORTED;
2071 goto exit;
2072 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002073 status = psa_validate_optional_attributes(slot, attributes);
2074 if (status != PSA_SUCCESS) {
Gilles Peskine18017402019-07-24 20:25:59 +02002075 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002076 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002077
Gilles Peskine449bd832023-01-11 14:50:10 +01002078 status = psa_finish_key_creation(slot, driver, key);
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002079exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002080 if (status != PSA_SUCCESS) {
2081 psa_fail_key_creation(slot, driver);
2082 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002083
Gilles Peskine449bd832023-01-11 14:50:10 +01002084 return status;
Gilles Peskine4747d192019-04-17 15:05:45 +02002085}
2086
Gilles Peskined7729582019-08-05 15:55:54 +02002087#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2088psa_status_t mbedtls_psa_register_se_key(
Gilles Peskine449bd832023-01-11 14:50:10 +01002089 const psa_key_attributes_t *attributes)
Gilles Peskined7729582019-08-05 15:55:54 +02002090{
2091 psa_status_t status;
2092 psa_key_slot_t *slot = NULL;
2093 psa_se_drv_table_entry_t *driver = NULL;
Ronald Croncf56a0a2020-08-04 09:51:30 +02002094 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskined7729582019-08-05 15:55:54 +02002095
2096 /* Leaving attributes unspecified is not currently supported.
2097 * It could make sense to query the key type and size from the
2098 * secure element, but not all secure elements support this
2099 * and the driver HAL doesn't currently support it. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002100 if (psa_get_key_type(attributes) == PSA_KEY_TYPE_NONE) {
2101 return PSA_ERROR_NOT_SUPPORTED;
2102 }
2103 if (psa_get_key_bits(attributes) == 0) {
2104 return PSA_ERROR_NOT_SUPPORTED;
2105 }
Gilles Peskined7729582019-08-05 15:55:54 +02002106
Gilles Peskine449bd832023-01-11 14:50:10 +01002107 status = psa_start_key_creation(PSA_KEY_CREATION_REGISTER, attributes,
2108 &slot, &driver);
2109 if (status != PSA_SUCCESS) {
Gilles Peskined7729582019-08-05 15:55:54 +02002110 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002111 }
Gilles Peskined7729582019-08-05 15:55:54 +02002112
Gilles Peskine449bd832023-01-11 14:50:10 +01002113 status = psa_finish_key_creation(slot, driver, &key);
Gilles Peskined7729582019-08-05 15:55:54 +02002114
2115exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002116 if (status != PSA_SUCCESS) {
2117 psa_fail_key_creation(slot, driver);
2118 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002119
Gilles Peskined7729582019-08-05 15:55:54 +02002120 /* Registration doesn't keep the key in RAM. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002121 psa_close_key(key);
2122 return status;
Gilles Peskined7729582019-08-05 15:55:54 +02002123}
2124#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2125
Gilles Peskine449bd832023-01-11 14:50:10 +01002126psa_status_t psa_copy_key(mbedtls_svc_key_id_t source_key,
2127 const psa_key_attributes_t *specified_attributes,
2128 mbedtls_svc_key_id_t *target_key)
Gilles Peskinef603c712019-01-19 13:40:11 +01002129{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002130 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01002131 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinef603c712019-01-19 13:40:11 +01002132 psa_key_slot_t *source_slot = NULL;
2133 psa_key_slot_t *target_slot = NULL;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002134 psa_key_attributes_t actual_attributes = *specified_attributes;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002135 psa_se_drv_table_entry_t *driver = NULL;
Archana8a180362021-07-05 02:18:48 +05302136 size_t storage_size = 0;
Gilles Peskinef603c712019-01-19 13:40:11 +01002137
Ronald Cron81709fc2020-11-14 12:10:32 +01002138 *target_key = MBEDTLS_SVC_KEY_ID_INIT;
2139
Archana8a180362021-07-05 02:18:48 +05302140 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002141 source_key, &source_slot, PSA_KEY_USAGE_COPY, 0);
2142 if (status != PSA_SUCCESS) {
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002143 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002144 }
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002145
Gilles Peskine449bd832023-01-11 14:50:10 +01002146 status = psa_validate_optional_attributes(source_slot,
2147 specified_attributes);
2148 if (status != PSA_SUCCESS) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002149 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002150 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002151
Archana9d17bf42021-09-10 06:22:44 +05302152 /* The target key type and number of bits have been validated by
2153 * psa_validate_optional_attributes() to be either equal to zero or
2154 * equal to the ones of the source key. So it is safe to inherit
2155 * them from the source key now."
Archana374fe5b2021-09-08 15:50:28 +05302156 * */
Archana9d17bf42021-09-10 06:22:44 +05302157 actual_attributes.core.bits = source_slot->attr.bits;
2158 actual_attributes.core.type = source_slot->attr.type;
Archana374fe5b2021-09-08 15:50:28 +05302159
2160
Gilles Peskine449bd832023-01-11 14:50:10 +01002161 status = psa_restrict_key_policy(source_slot->attr.type,
2162 &actual_attributes.core.policy,
2163 &source_slot->attr.policy);
2164 if (status != PSA_SUCCESS) {
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002165 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002166 }
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002167
Gilles Peskine449bd832023-01-11 14:50:10 +01002168 status = psa_start_key_creation(PSA_KEY_CREATION_COPY, &actual_attributes,
2169 &target_slot, &driver);
2170 if (status != PSA_SUCCESS) {
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002171 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002172 }
2173 if (PSA_KEY_LIFETIME_GET_LOCATION(target_slot->attr.lifetime) !=
2174 PSA_KEY_LIFETIME_GET_LOCATION(source_slot->attr.lifetime)) {
Archana8a180362021-07-05 02:18:48 +05302175 /*
Archana9d17bf42021-09-10 06:22:44 +05302176 * If the source and target keys are stored in different locations,
Archana8a180362021-07-05 02:18:48 +05302177 * the source key would need to be exported as plaintext and re-imported
2178 * in the other location. This has security implications which have not
Archana449608b2021-09-08 15:36:05 +05302179 * been fully mapped. For now, this can be achieved through
Archana8a180362021-07-05 02:18:48 +05302180 * appropriate API invocations from the application, if needed.
2181 * */
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002182 status = PSA_ERROR_NOT_SUPPORTED;
2183 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002184 }
Archana8a180362021-07-05 02:18:48 +05302185 /*
2186 * When the source and target keys are within the same location,
Archana449608b2021-09-08 15:36:05 +05302187 * - For transparent keys it is a blind copy without any driver invocation,
Archana8a180362021-07-05 02:18:48 +05302188 * - For opaque keys this translates to an invocation of the drivers'
2189 * copy_key entry point through the dispatch layer.
2190 * */
Gilles Peskine449bd832023-01-11 14:50:10 +01002191 if (psa_key_lifetime_is_external(actual_attributes.core.lifetime)) {
2192 status = psa_driver_wrapper_get_key_buffer_size(&actual_attributes,
2193 &storage_size);
2194 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302195 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002196 }
Archana374fe5b2021-09-08 15:50:28 +05302197
Gilles Peskine449bd832023-01-11 14:50:10 +01002198 status = psa_allocate_buffer_to_slot(target_slot, storage_size);
2199 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302200 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002201 }
Archana374fe5b2021-09-08 15:50:28 +05302202
Gilles Peskine449bd832023-01-11 14:50:10 +01002203 status = psa_driver_wrapper_copy_key(&actual_attributes,
2204 source_slot->key.data,
2205 source_slot->key.bytes,
2206 target_slot->key.data,
2207 target_slot->key.bytes,
2208 &target_slot->key.bytes);
2209 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302210 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002211 }
2212 } else {
2213 status = psa_copy_key_material_into_slot(target_slot,
Archana9d17bf42021-09-10 06:22:44 +05302214 source_slot->key.data,
Gilles Peskine449bd832023-01-11 14:50:10 +01002215 source_slot->key.bytes);
2216 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302217 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002218 }
Archana8a180362021-07-05 02:18:48 +05302219 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002220 status = psa_finish_key_creation(target_slot, driver, target_key);
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002221exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002222 if (status != PSA_SUCCESS) {
2223 psa_fail_key_creation(target_slot, driver);
2224 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002225
Ryan Everett1b70a072024-01-04 10:32:49 +00002226 unlock_status = psa_unregister_read(source_slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02002227
Gilles Peskine449bd832023-01-11 14:50:10 +01002228 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskinef603c712019-01-19 13:40:11 +01002229}
2230
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02002231
2232
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01002233/****************************************************************/
Gilles Peskine20035e32018-02-03 22:44:14 +01002234/* Message digests */
2235/****************************************************************/
2236
Gilles Peskine449bd832023-01-11 14:50:10 +01002237psa_status_t psa_hash_abort(psa_hash_operation_t *operation)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002238{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002239 /* Aborting a non-active operation is allowed */
Gilles Peskine449bd832023-01-11 14:50:10 +01002240 if (operation->id == 0) {
2241 return PSA_SUCCESS;
2242 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002243
Gilles Peskine449bd832023-01-11 14:50:10 +01002244 psa_status_t status = psa_driver_wrapper_hash_abort(operation);
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002245 operation->id = 0;
2246
Gilles Peskine449bd832023-01-11 14:50:10 +01002247 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002248}
2249
Gilles Peskine449bd832023-01-11 14:50:10 +01002250psa_status_t psa_hash_setup(psa_hash_operation_t *operation,
2251 psa_algorithm_t alg)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002252{
Dave Rodgman685b6a72021-06-24 11:49:14 +01002253 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002254
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002255 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002256 if (operation->id != 0) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002257 status = PSA_ERROR_BAD_STATE;
2258 goto exit;
2259 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002260
Gilles Peskine449bd832023-01-11 14:50:10 +01002261 if (!PSA_ALG_IS_HASH(alg)) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002262 status = PSA_ERROR_INVALID_ARGUMENT;
2263 goto exit;
2264 }
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002265
Steven Cooremanb6bf4bb2021-03-15 19:00:14 +01002266 /* Ensure all of the context is zeroized, since PSA_HASH_OPERATION_INIT only
2267 * directly zeroes the int-sized dummy member of the context union. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002268 memset(&operation->ctx, 0, sizeof(operation->ctx));
Steven Cooreman893232f2021-03-15 12:23:37 +01002269
Gilles Peskine449bd832023-01-11 14:50:10 +01002270 status = psa_driver_wrapper_hash_setup(operation, alg);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002271
2272exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002273 if (status != PSA_SUCCESS) {
2274 psa_hash_abort(operation);
2275 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002276
2277 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002278}
2279
Gilles Peskine449bd832023-01-11 14:50:10 +01002280psa_status_t psa_hash_update(psa_hash_operation_t *operation,
2281 const uint8_t *input,
2282 size_t input_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002283{
Dave Rodgman685b6a72021-06-24 11:49:14 +01002284 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2285
Gilles Peskine449bd832023-01-11 14:50:10 +01002286 if (operation->id == 0) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002287 status = PSA_ERROR_BAD_STATE;
2288 goto exit;
2289 }
Gilles Peskine94e44542018-07-12 16:58:43 +02002290
Steven Cooremanc8288352021-03-04 14:02:19 +01002291 /* Don't require hash implementations to behave correctly on a
2292 * zero-length input, which may have an invalid pointer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002293 if (input_length == 0) {
2294 return PSA_SUCCESS;
2295 }
Steven Cooremanc8288352021-03-04 14:02:19 +01002296
Gilles Peskine449bd832023-01-11 14:50:10 +01002297 status = psa_driver_wrapper_hash_update(operation, input, input_length);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002298
2299exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002300 if (status != PSA_SUCCESS) {
2301 psa_hash_abort(operation);
2302 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002303
Gilles Peskine449bd832023-01-11 14:50:10 +01002304 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002305}
2306
Gilles Peskine449bd832023-01-11 14:50:10 +01002307psa_status_t psa_hash_finish(psa_hash_operation_t *operation,
2308 uint8_t *hash,
2309 size_t hash_size,
2310 size_t *hash_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002311{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002312 *hash_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002313 if (operation->id == 0) {
2314 return PSA_ERROR_BAD_STATE;
2315 }
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002316
Steven Cooreman1e582352021-02-18 17:24:37 +01002317 psa_status_t status = psa_driver_wrapper_hash_finish(
Gilles Peskine449bd832023-01-11 14:50:10 +01002318 operation, hash, hash_size, hash_length);
2319 psa_hash_abort(operation);
2320 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002321}
2322
Gilles Peskine449bd832023-01-11 14:50:10 +01002323psa_status_t psa_hash_verify(psa_hash_operation_t *operation,
2324 const uint8_t *hash,
2325 size_t hash_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002326{
Ronald Cron69a63422021-10-18 09:47:58 +02002327 uint8_t actual_hash[PSA_HASH_MAX_SIZE];
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002328 size_t actual_hash_length;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002329 psa_status_t status = psa_hash_finish(
Gilles Peskine449bd832023-01-11 14:50:10 +01002330 operation,
2331 actual_hash, sizeof(actual_hash),
2332 &actual_hash_length);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002333
Gilles Peskine449bd832023-01-11 14:50:10 +01002334 if (status != PSA_SUCCESS) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002335 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002336 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002337
Gilles Peskine449bd832023-01-11 14:50:10 +01002338 if (actual_hash_length != hash_length) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002339 status = PSA_ERROR_INVALID_SIGNATURE;
2340 goto exit;
2341 }
2342
Dave Rodgman78701152023-08-29 14:20:18 +01002343 if (mbedtls_ct_memcmp(hash, actual_hash, actual_hash_length) != 0) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002344 status = PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01002345 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002346
2347exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002348 mbedtls_platform_zeroize(actual_hash, sizeof(actual_hash));
2349 if (status != PSA_SUCCESS) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002350 psa_hash_abort(operation);
Gilles Peskine449bd832023-01-11 14:50:10 +01002351 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002352
Gilles Peskine449bd832023-01-11 14:50:10 +01002353 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002354}
2355
Gilles Peskine449bd832023-01-11 14:50:10 +01002356psa_status_t psa_hash_compute(psa_algorithm_t alg,
2357 const uint8_t *input, size_t input_length,
2358 uint8_t *hash, size_t hash_size,
2359 size_t *hash_length)
Gilles Peskine0a749c82019-11-28 19:33:58 +01002360{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002361 *hash_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002362 if (!PSA_ALG_IS_HASH(alg)) {
2363 return PSA_ERROR_INVALID_ARGUMENT;
2364 }
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002365
Gilles Peskine449bd832023-01-11 14:50:10 +01002366 return psa_driver_wrapper_hash_compute(alg, input, input_length,
2367 hash, hash_size, hash_length);
Gilles Peskine0a749c82019-11-28 19:33:58 +01002368}
2369
Gilles Peskine449bd832023-01-11 14:50:10 +01002370psa_status_t psa_hash_compare(psa_algorithm_t alg,
2371 const uint8_t *input, size_t input_length,
2372 const uint8_t *hash, size_t hash_length)
Gilles Peskine0a749c82019-11-28 19:33:58 +01002373{
Ronald Cron69a63422021-10-18 09:47:58 +02002374 uint8_t actual_hash[PSA_HASH_MAX_SIZE];
Steven Cooreman84d670d2021-02-18 16:22:53 +01002375 size_t actual_hash_length;
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002376
Gilles Peskine449bd832023-01-11 14:50:10 +01002377 if (!PSA_ALG_IS_HASH(alg)) {
2378 return PSA_ERROR_INVALID_ARGUMENT;
2379 }
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002380
Steven Cooreman1e582352021-02-18 17:24:37 +01002381 psa_status_t status = psa_driver_wrapper_hash_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01002382 alg, input, input_length,
2383 actual_hash, sizeof(actual_hash),
2384 &actual_hash_length);
2385 if (status != PSA_SUCCESS) {
Gilles Peskine60aebec2021-12-13 12:33:18 +01002386 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002387 }
2388 if (actual_hash_length != hash_length) {
Gilles Peskine60aebec2021-12-13 12:33:18 +01002389 status = PSA_ERROR_INVALID_SIGNATURE;
2390 goto exit;
2391 }
Dave Rodgman78701152023-08-29 14:20:18 +01002392 if (mbedtls_ct_memcmp(hash, actual_hash, actual_hash_length) != 0) {
Gilles Peskine60aebec2021-12-13 12:33:18 +01002393 status = PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01002394 }
Gilles Peskine60aebec2021-12-13 12:33:18 +01002395
2396exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002397 mbedtls_platform_zeroize(actual_hash, sizeof(actual_hash));
2398 return status;
Gilles Peskine0a749c82019-11-28 19:33:58 +01002399}
2400
Gilles Peskine449bd832023-01-11 14:50:10 +01002401psa_status_t psa_hash_clone(const psa_hash_operation_t *source_operation,
2402 psa_hash_operation_t *target_operation)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002403{
Gilles Peskine449bd832023-01-11 14:50:10 +01002404 if (source_operation->id == 0 ||
2405 target_operation->id != 0) {
2406 return PSA_ERROR_BAD_STATE;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002407 }
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002408
Gilles Peskine449bd832023-01-11 14:50:10 +01002409 psa_status_t status = psa_driver_wrapper_hash_clone(source_operation,
2410 target_operation);
2411 if (status != PSA_SUCCESS) {
2412 psa_hash_abort(target_operation);
2413 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002414
Gilles Peskine449bd832023-01-11 14:50:10 +01002415 return status;
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002416}
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002417
2418
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002419/****************************************************************/
Gilles Peskine8c9def32018-02-08 10:02:12 +01002420/* MAC */
2421/****************************************************************/
2422
Gilles Peskine449bd832023-01-11 14:50:10 +01002423psa_status_t psa_mac_abort(psa_mac_operation_t *operation)
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002424{
Steven Cooremane6804192021-03-19 18:28:56 +01002425 /* Aborting a non-active operation is allowed */
Gilles Peskine449bd832023-01-11 14:50:10 +01002426 if (operation->id == 0) {
2427 return PSA_SUCCESS;
2428 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002429
Gilles Peskine449bd832023-01-11 14:50:10 +01002430 psa_status_t status = psa_driver_wrapper_mac_abort(operation);
Steven Cooreman72f736a2021-05-07 14:14:37 +02002431 operation->mac_size = 0;
2432 operation->is_sign = 0;
Steven Cooremane6804192021-03-19 18:28:56 +01002433 operation->id = 0;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002434
Gilles Peskine449bd832023-01-11 14:50:10 +01002435 return status;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002436}
2437
Ronald Cron2dff3b22021-06-17 16:33:22 +02002438static psa_status_t psa_mac_finalize_alg_and_key_validation(
2439 psa_algorithm_t alg,
Ronald Cron79bdd822021-06-17 16:46:44 +02002440 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01002441 uint8_t *mac_size)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002442{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002443 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002444 psa_key_type_t key_type = psa_get_key_type(attributes);
2445 size_t key_bits = psa_get_key_bits(attributes);
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002446
Gilles Peskine449bd832023-01-11 14:50:10 +01002447 if (!PSA_ALG_IS_MAC(alg)) {
2448 return PSA_ERROR_INVALID_ARGUMENT;
2449 }
Steven Cooremane6804192021-03-19 18:28:56 +01002450
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002451 /* Validate the combination of key type and algorithm */
Gilles Peskine449bd832023-01-11 14:50:10 +01002452 status = psa_mac_key_can_do(alg, key_type);
2453 if (status != PSA_SUCCESS) {
2454 return status;
2455 }
Steven Cooreman15472f82021-03-02 16:16:22 +01002456
Steven Cooremand1a68f12021-05-10 11:13:41 +02002457 /* Get the output length for the algorithm and key combination */
Gilles Peskine449bd832023-01-11 14:50:10 +01002458 *mac_size = PSA_MAC_LENGTH(key_type, key_bits, alg);
Steven Cooreman15472f82021-03-02 16:16:22 +01002459
Gilles Peskine449bd832023-01-11 14:50:10 +01002460 if (*mac_size < 4) {
Steven Cooreman15472f82021-03-02 16:16:22 +01002461 /* A very short MAC is too short for security since it can be
2462 * brute-forced. Ancient protocols with 32-bit MACs do exist,
2463 * so we make this our minimum, even though 32 bits is still
2464 * too small for security. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002465 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman15472f82021-03-02 16:16:22 +01002466 }
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02002467
Gilles Peskine449bd832023-01-11 14:50:10 +01002468 if (*mac_size > PSA_MAC_LENGTH(key_type, key_bits,
2469 PSA_ALG_FULL_LENGTH_MAC(alg))) {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002470 /* It's impossible to "truncate" to a larger length than the full length
2471 * of the algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002472 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002473 }
2474
Gilles Peskine449bd832023-01-11 14:50:10 +01002475 if (*mac_size > PSA_MAC_MAX_SIZE) {
Gilles Peskinea9b6c802022-03-16 13:54:49 +01002476 /* PSA_MAC_LENGTH returns the correct length even for a MAC algorithm
2477 * that is disabled in the compile-time configuration. The result can
2478 * therefore be larger than PSA_MAC_MAX_SIZE, which does take the
2479 * configuration into account. In this case, force a return of
2480 * PSA_ERROR_NOT_SUPPORTED here. Otherwise psa_mac_verify(), or
2481 * psa_mac_compute(mac_size=PSA_MAC_MAX_SIZE), would return
2482 * PSA_ERROR_BUFFER_TOO_SMALL for an unsupported algorithm whose MAC size
2483 * is larger than PSA_MAC_MAX_SIZE, which is misleading and which breaks
2484 * systematically generated tests. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002485 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea9b6c802022-03-16 13:54:49 +01002486 }
2487
Gilles Peskine449bd832023-01-11 14:50:10 +01002488 return PSA_SUCCESS;
Ronald Cron2dff3b22021-06-17 16:33:22 +02002489}
2490
Gilles Peskine449bd832023-01-11 14:50:10 +01002491static psa_status_t psa_mac_setup(psa_mac_operation_t *operation,
2492 mbedtls_svc_key_id_t key,
2493 psa_algorithm_t alg,
2494 int is_sign)
Gilles Peskinee59236f2018-01-27 23:32:46 +01002495{
2496 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2497 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman54648242021-06-24 11:49:45 +01002498 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002499 psa_key_attributes_t attributes;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002500
2501 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002502 if (operation->id != 0) {
Dave Rodgman54648242021-06-24 11:49:45 +01002503 status = PSA_ERROR_BAD_STATE;
2504 goto exit;
2505 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002506
2507 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002508 key,
2509 &slot,
2510 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
2511 alg);
2512 if (status != PSA_SUCCESS) {
Dave Rodgman54648242021-06-24 11:49:45 +01002513 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002514 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002515
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002516 attributes = (psa_key_attributes_t) {
Gilles Peskine8c9def32018-02-08 10:02:12 +01002517 .core = slot->attr
2518 };
2519
Gilles Peskine449bd832023-01-11 14:50:10 +01002520 status = psa_mac_finalize_alg_and_key_validation(alg, &attributes,
2521 &operation->mac_size);
2522 if (status != PSA_SUCCESS) {
Gilles Peskine8c9def32018-02-08 10:02:12 +01002523 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002524 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002525
2526 operation->is_sign = is_sign;
Steven Cooremane6804192021-03-19 18:28:56 +01002527 /* Dispatch the MAC setup call with validated input */
Gilles Peskine449bd832023-01-11 14:50:10 +01002528 if (is_sign) {
2529 status = psa_driver_wrapper_mac_sign_setup(operation,
2530 &attributes,
2531 slot->key.data,
2532 slot->key.bytes,
2533 alg);
2534 } else {
2535 status = psa_driver_wrapper_mac_verify_setup(operation,
2536 &attributes,
2537 slot->key.data,
2538 slot->key.bytes,
2539 alg);
Gilles Peskine8c9def32018-02-08 10:02:12 +01002540 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002541
Gilles Peskinefbfac682018-07-08 20:51:54 +02002542exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002543 if (status != PSA_SUCCESS) {
2544 psa_mac_abort(operation);
2545 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002546
Ryan Everett1b70a072024-01-04 10:32:49 +00002547 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02002548
Gilles Peskine449bd832023-01-11 14:50:10 +01002549 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002550}
2551
Gilles Peskine449bd832023-01-11 14:50:10 +01002552psa_status_t psa_mac_sign_setup(psa_mac_operation_t *operation,
2553 mbedtls_svc_key_id_t key,
2554 psa_algorithm_t alg)
Gilles Peskine89167cb2018-07-08 20:12:23 +02002555{
Gilles Peskine449bd832023-01-11 14:50:10 +01002556 return psa_mac_setup(operation, key, alg, 1);
Gilles Peskine89167cb2018-07-08 20:12:23 +02002557}
2558
Gilles Peskine449bd832023-01-11 14:50:10 +01002559psa_status_t psa_mac_verify_setup(psa_mac_operation_t *operation,
2560 mbedtls_svc_key_id_t key,
2561 psa_algorithm_t alg)
Gilles Peskine89167cb2018-07-08 20:12:23 +02002562{
Gilles Peskine449bd832023-01-11 14:50:10 +01002563 return psa_mac_setup(operation, key, alg, 0);
Gilles Peskine89167cb2018-07-08 20:12:23 +02002564}
2565
Gilles Peskine449bd832023-01-11 14:50:10 +01002566psa_status_t psa_mac_update(psa_mac_operation_t *operation,
2567 const uint8_t *input,
2568 size_t input_length)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002569{
Gilles Peskine449bd832023-01-11 14:50:10 +01002570 if (operation->id == 0) {
2571 return PSA_ERROR_BAD_STATE;
2572 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002573
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002574 /* Don't require hash implementations to behave correctly on a
2575 * zero-length input, which may have an invalid pointer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002576 if (input_length == 0) {
2577 return PSA_SUCCESS;
2578 }
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03002579
Gilles Peskine449bd832023-01-11 14:50:10 +01002580 psa_status_t status = psa_driver_wrapper_mac_update(operation,
2581 input, input_length);
2582 if (status != PSA_SUCCESS) {
2583 psa_mac_abort(operation);
2584 }
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002585
Gilles Peskine449bd832023-01-11 14:50:10 +01002586 return status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002587}
2588
Gilles Peskine449bd832023-01-11 14:50:10 +01002589psa_status_t psa_mac_sign_finish(psa_mac_operation_t *operation,
2590 uint8_t *mac,
2591 size_t mac_size,
2592 size_t *mac_length)
mohammad16036df908f2018-04-02 08:34:15 -07002593{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002594 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2595 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002596
Gilles Peskine449bd832023-01-11 14:50:10 +01002597 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002598 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002599 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002600 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002601
Gilles Peskine449bd832023-01-11 14:50:10 +01002602 if (!operation->is_sign) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002603 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002604 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002605 }
Steven Cooreman72f736a2021-05-07 14:14:37 +02002606
Steven Cooreman8af5c5c2021-05-11 11:09:13 +02002607 /* Sanity check. This will guarantee that mac_size != 0 (and so mac != NULL)
2608 * once all the error checks are done. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002609 if (operation->mac_size == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002610 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002611 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002612 }
Steven Cooreman8af5c5c2021-05-11 11:09:13 +02002613
Gilles Peskine449bd832023-01-11 14:50:10 +01002614 if (mac_size < operation->mac_size) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002615 status = PSA_ERROR_BUFFER_TOO_SMALL;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002616 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002617 }
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002618
Gilles Peskine449bd832023-01-11 14:50:10 +01002619 status = psa_driver_wrapper_mac_sign_finish(operation,
2620 mac, operation->mac_size,
2621 mac_length);
Steven Cooreman72f736a2021-05-07 14:14:37 +02002622
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002623exit:
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002624 /* In case of success, set the potential excess room in the output buffer
2625 * to an invalid value, to avoid potentially leaking a longer MAC.
2626 * In case of error, set the output length and content to a safe default,
2627 * such that in case the caller misses an error check, the output would be
2628 * an unachievable MAC.
2629 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002630 if (status != PSA_SUCCESS) {
Steven Cooreman72f736a2021-05-07 14:14:37 +02002631 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002632 operation->mac_size = 0;
Steven Cooreman72f736a2021-05-07 14:14:37 +02002633 }
mohammad16036df908f2018-04-02 08:34:15 -07002634
Paul Elliottdc42ca82023-02-24 18:11:59 +00002635 psa_wipe_tag_output_buffer(mac, status, mac_size, *mac_length);
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002636
Gilles Peskine449bd832023-01-11 14:50:10 +01002637 abort_status = psa_mac_abort(operation);
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002638
Gilles Peskine449bd832023-01-11 14:50:10 +01002639 return status == PSA_SUCCESS ? abort_status : status;
mohammad16036df908f2018-04-02 08:34:15 -07002640}
2641
Gilles Peskine449bd832023-01-11 14:50:10 +01002642psa_status_t psa_mac_verify_finish(psa_mac_operation_t *operation,
2643 const uint8_t *mac,
2644 size_t mac_length)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002645{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002646 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2647 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002648
Gilles Peskine449bd832023-01-11 14:50:10 +01002649 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002650 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002651 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002652 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002653
Gilles Peskine449bd832023-01-11 14:50:10 +01002654 if (operation->is_sign) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002655 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002656 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002657 }
Steven Cooreman72f736a2021-05-07 14:14:37 +02002658
Gilles Peskine449bd832023-01-11 14:50:10 +01002659 if (operation->mac_size != mac_length) {
Steven Cooreman72f736a2021-05-07 14:14:37 +02002660 status = PSA_ERROR_INVALID_SIGNATURE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002661 goto exit;
Steven Cooreman72f736a2021-05-07 14:14:37 +02002662 }
2663
Gilles Peskine449bd832023-01-11 14:50:10 +01002664 status = psa_driver_wrapper_mac_verify_finish(operation,
2665 mac, mac_length);
Steven Cooreman72f736a2021-05-07 14:14:37 +02002666
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002667exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002668 abort_status = psa_mac_abort(operation);
mohammad16036df908f2018-04-02 08:34:15 -07002669
Gilles Peskine449bd832023-01-11 14:50:10 +01002670 return status == PSA_SUCCESS ? abort_status : status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002671}
2672
Gilles Peskine449bd832023-01-11 14:50:10 +01002673static psa_status_t psa_mac_compute_internal(mbedtls_svc_key_id_t key,
2674 psa_algorithm_t alg,
2675 const uint8_t *input,
2676 size_t input_length,
2677 uint8_t *mac,
2678 size_t mac_size,
2679 size_t *mac_length,
2680 int is_sign)
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002681{
2682 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron51131b52021-06-17 17:17:20 +02002683 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2684 psa_key_slot_t *slot;
2685 uint8_t operation_mac_size = 0;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002686 psa_key_attributes_t attributes;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002687
Ronald Cron51131b52021-06-17 17:17:20 +02002688 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002689 key,
2690 &slot,
2691 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
2692 alg);
2693 if (status != PSA_SUCCESS) {
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002694 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002695 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002696
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002697 attributes = (psa_key_attributes_t) {
Ronald Cron51131b52021-06-17 17:17:20 +02002698 .core = slot->attr
2699 };
2700
Gilles Peskine449bd832023-01-11 14:50:10 +01002701 status = psa_mac_finalize_alg_and_key_validation(alg, &attributes,
2702 &operation_mac_size);
2703 if (status != PSA_SUCCESS) {
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002704 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002705 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002706
Gilles Peskine449bd832023-01-11 14:50:10 +01002707 if (mac_size < operation_mac_size) {
Ronald Cron51131b52021-06-17 17:17:20 +02002708 status = PSA_ERROR_BUFFER_TOO_SMALL;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002709 goto exit;
Ronald Cron51131b52021-06-17 17:17:20 +02002710 }
2711
2712 status = psa_driver_wrapper_mac_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01002713 &attributes,
2714 slot->key.data, slot->key.bytes,
2715 alg,
2716 input, input_length,
2717 mac, operation_mac_size, mac_length);
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002718
2719exit:
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002720 /* In case of success, set the potential excess room in the output buffer
2721 * to an invalid value, to avoid potentially leaking a longer MAC.
2722 * In case of error, set the output length and content to a safe default,
2723 * such that in case the caller misses an error check, the output would be
2724 * an unachievable MAC.
2725 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002726 if (status != PSA_SUCCESS) {
Ronald Cron51131b52021-06-17 17:17:20 +02002727 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002728 operation_mac_size = 0;
Ronald Cron51131b52021-06-17 17:17:20 +02002729 }
Paul Elliottdc42ca82023-02-24 18:11:59 +00002730
2731 psa_wipe_tag_output_buffer(mac, status, mac_size, *mac_length);
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002732
Ryan Everett1b70a072024-01-04 10:32:49 +00002733 unlock_status = psa_unregister_read(slot);
Ronald Cron51131b52021-06-17 17:17:20 +02002734
Gilles Peskine449bd832023-01-11 14:50:10 +01002735 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002736}
2737
Gilles Peskine449bd832023-01-11 14:50:10 +01002738psa_status_t psa_mac_compute(mbedtls_svc_key_id_t key,
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002739 psa_algorithm_t alg,
2740 const uint8_t *input,
2741 size_t input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002742 uint8_t *mac,
2743 size_t mac_size,
2744 size_t *mac_length)
2745{
2746 return psa_mac_compute_internal(key, alg,
2747 input, input_length,
2748 mac, mac_size, mac_length, 1);
2749}
2750
2751psa_status_t psa_mac_verify(mbedtls_svc_key_id_t key,
2752 psa_algorithm_t alg,
2753 const uint8_t *input,
2754 size_t input_length,
2755 const uint8_t *mac,
2756 size_t mac_length)
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002757{
2758 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Crona587cbc2021-06-18 14:51:29 +02002759 uint8_t actual_mac[PSA_MAC_MAX_SIZE];
2760 size_t actual_mac_length;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002761
Gilles Peskine449bd832023-01-11 14:50:10 +01002762 status = psa_mac_compute_internal(key, alg,
2763 input, input_length,
2764 actual_mac, sizeof(actual_mac),
2765 &actual_mac_length, 0);
2766 if (status != PSA_SUCCESS) {
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002767 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002768 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002769
Gilles Peskine449bd832023-01-11 14:50:10 +01002770 if (mac_length != actual_mac_length) {
Ronald Crona587cbc2021-06-18 14:51:29 +02002771 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002772 goto exit;
Ronald Crona587cbc2021-06-18 14:51:29 +02002773 }
Dave Rodgman78701152023-08-29 14:20:18 +01002774 if (mbedtls_ct_memcmp(mac, actual_mac, actual_mac_length) != 0) {
Ronald Crona587cbc2021-06-18 14:51:29 +02002775 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002776 goto exit;
Ronald Crona587cbc2021-06-18 14:51:29 +02002777 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002778
2779exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002780 mbedtls_platform_zeroize(actual_mac, sizeof(actual_mac));
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002781
Gilles Peskine449bd832023-01-11 14:50:10 +01002782 return status;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002783}
Gilles Peskinee59236f2018-01-27 23:32:46 +01002784
Gilles Peskinee59236f2018-01-27 23:32:46 +01002785/****************************************************************/
2786/* Asymmetric cryptography */
2787/****************************************************************/
2788
Gilles Peskine449bd832023-01-11 14:50:10 +01002789static psa_status_t psa_sign_verify_check_alg(int input_is_message,
2790 psa_algorithm_t alg)
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002791{
Gilles Peskine449bd832023-01-11 14:50:10 +01002792 if (input_is_message) {
2793 if (!PSA_ALG_IS_SIGN_MESSAGE(alg)) {
2794 return PSA_ERROR_INVALID_ARGUMENT;
2795 }
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002796
Gilles Peskine449bd832023-01-11 14:50:10 +01002797 if (PSA_ALG_IS_SIGN_HASH(alg)) {
2798 if (!PSA_ALG_IS_HASH(PSA_ALG_SIGN_GET_HASH(alg))) {
2799 return PSA_ERROR_INVALID_ARGUMENT;
2800 }
2801 }
2802 } else {
2803 if (!PSA_ALG_IS_SIGN_HASH(alg)) {
2804 return PSA_ERROR_INVALID_ARGUMENT;
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002805 }
2806 }
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002807
Gilles Peskine449bd832023-01-11 14:50:10 +01002808 return PSA_SUCCESS;
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002809}
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002810
Gilles Peskine449bd832023-01-11 14:50:10 +01002811static psa_status_t psa_sign_internal(mbedtls_svc_key_id_t key,
2812 int input_is_message,
2813 psa_algorithm_t alg,
2814 const uint8_t *input,
2815 size_t input_length,
2816 uint8_t *signature,
2817 size_t signature_size,
2818 size_t *signature_length)
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002819{
2820 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2821 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2822 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002823 psa_key_attributes_t attributes;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002824
2825 *signature_length = 0;
2826
Gilles Peskine449bd832023-01-11 14:50:10 +01002827 status = psa_sign_verify_check_alg(input_is_message, alg);
2828 if (status != PSA_SUCCESS) {
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002829 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002830 }
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002831
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002832 /* Immediately reject a zero-length signature buffer. This guarantees
gabor-mezei-arm12b4f342021-05-05 13:54:55 +02002833 * that signature must be a valid pointer. (On the other hand, the input
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002834 * buffer can in principle be empty since it doesn't actually have
2835 * to be a hash.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01002836 if (signature_size == 0) {
2837 return PSA_ERROR_BUFFER_TOO_SMALL;
2838 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002839
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002840 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002841 key, &slot,
2842 input_is_message ? PSA_KEY_USAGE_SIGN_MESSAGE :
2843 PSA_KEY_USAGE_SIGN_HASH,
2844 alg);
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002845
Gilles Peskine449bd832023-01-11 14:50:10 +01002846 if (status != PSA_SUCCESS) {
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002847 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002848 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002849
Gilles Peskine449bd832023-01-11 14:50:10 +01002850 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002851 status = PSA_ERROR_INVALID_ARGUMENT;
2852 goto exit;
2853 }
2854
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002855 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01002856 .core = slot->attr
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002857 };
2858
Gilles Peskine449bd832023-01-11 14:50:10 +01002859 if (input_is_message) {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002860 status = psa_driver_wrapper_sign_message(
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002861 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002862 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002863 signature, signature_size, signature_length);
2864 } else {
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002865
2866 status = psa_driver_wrapper_sign_hash(
2867 &attributes, slot->key.data, slot->key.bytes,
2868 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002869 signature, signature_size, signature_length);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002870 }
2871
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002872
2873exit:
Paul Elliott59200a22023-02-21 15:07:40 +00002874 psa_wipe_tag_output_buffer(signature, status, signature_size,
2875 *signature_length);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002876
Ryan Everett1b70a072024-01-04 10:32:49 +00002877 unlock_status = psa_unregister_read(slot);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002878
Gilles Peskine449bd832023-01-11 14:50:10 +01002879 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002880}
2881
Gilles Peskine449bd832023-01-11 14:50:10 +01002882static psa_status_t psa_verify_internal(mbedtls_svc_key_id_t key,
2883 int input_is_message,
2884 psa_algorithm_t alg,
2885 const uint8_t *input,
2886 size_t input_length,
2887 const uint8_t *signature,
2888 size_t signature_length)
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002889{
2890 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2891 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2892 psa_key_slot_t *slot;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002893
Gilles Peskine449bd832023-01-11 14:50:10 +01002894 status = psa_sign_verify_check_alg(input_is_message, alg);
2895 if (status != PSA_SUCCESS) {
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002896 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002897 }
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002898
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002899 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002900 key, &slot,
2901 input_is_message ? PSA_KEY_USAGE_VERIFY_MESSAGE :
2902 PSA_KEY_USAGE_VERIFY_HASH,
2903 alg);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002904
Gilles Peskine449bd832023-01-11 14:50:10 +01002905 if (status != PSA_SUCCESS) {
2906 return status;
2907 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002908
2909 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01002910 .core = slot->attr
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002911 };
2912
Gilles Peskine449bd832023-01-11 14:50:10 +01002913 if (input_is_message) {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002914 status = psa_driver_wrapper_verify_message(
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002915 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002916 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002917 signature, signature_length);
2918 } else {
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002919 status = psa_driver_wrapper_verify_hash(
2920 &attributes, slot->key.data, slot->key.bytes,
2921 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002922 signature, signature_length);
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002923 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002924
Ryan Everett1b70a072024-01-04 10:32:49 +00002925 unlock_status = psa_unregister_read(slot);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002926
Gilles Peskine449bd832023-01-11 14:50:10 +01002927 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002928
2929}
2930
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002931psa_status_t psa_sign_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002932 const psa_key_attributes_t *attributes,
2933 const uint8_t *key_buffer,
2934 size_t key_buffer_size,
2935 psa_algorithm_t alg,
2936 const uint8_t *input,
2937 size_t input_length,
2938 uint8_t *signature,
2939 size_t signature_size,
Gilles Peskine449bd832023-01-11 14:50:10 +01002940 size_t *signature_length)
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002941{
2942 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002943
Gilles Peskine449bd832023-01-11 14:50:10 +01002944 if (PSA_ALG_IS_SIGN_HASH(alg)) {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002945 size_t hash_length;
2946 uint8_t hash[PSA_HASH_MAX_SIZE];
2947
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002948 status = psa_driver_wrapper_hash_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01002949 PSA_ALG_SIGN_GET_HASH(alg),
2950 input, input_length,
2951 hash, sizeof(hash), &hash_length);
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002952
Gilles Peskine449bd832023-01-11 14:50:10 +01002953 if (status != PSA_SUCCESS) {
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002954 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002955 }
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002956
2957 return psa_driver_wrapper_sign_hash(
Gilles Peskine449bd832023-01-11 14:50:10 +01002958 attributes, key_buffer, key_buffer_size,
2959 alg, hash, hash_length,
2960 signature, signature_size, signature_length);
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002961 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002962
Gilles Peskine449bd832023-01-11 14:50:10 +01002963 return PSA_ERROR_NOT_SUPPORTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002964}
2965
Gilles Peskine449bd832023-01-11 14:50:10 +01002966psa_status_t psa_sign_message(mbedtls_svc_key_id_t key,
2967 psa_algorithm_t alg,
2968 const uint8_t *input,
2969 size_t input_length,
2970 uint8_t *signature,
2971 size_t signature_size,
2972 size_t *signature_length)
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002973{
2974 return psa_sign_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002975 key, 1, alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002976 signature, signature_size, signature_length);
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002977}
2978
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002979psa_status_t psa_verify_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002980 const psa_key_attributes_t *attributes,
2981 const uint8_t *key_buffer,
2982 size_t key_buffer_size,
2983 psa_algorithm_t alg,
2984 const uint8_t *input,
2985 size_t input_length,
2986 const uint8_t *signature,
Gilles Peskine449bd832023-01-11 14:50:10 +01002987 size_t signature_length)
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002988{
2989 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002990
Gilles Peskine449bd832023-01-11 14:50:10 +01002991 if (PSA_ALG_IS_SIGN_HASH(alg)) {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002992 size_t hash_length;
2993 uint8_t hash[PSA_HASH_MAX_SIZE];
2994
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002995 status = psa_driver_wrapper_hash_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01002996 PSA_ALG_SIGN_GET_HASH(alg),
2997 input, input_length,
2998 hash, sizeof(hash), &hash_length);
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002999
Gilles Peskine449bd832023-01-11 14:50:10 +01003000 if (status != PSA_SUCCESS) {
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003001 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01003002 }
gabor-mezei-armf9820f92021-05-03 16:26:20 +02003003
3004 return psa_driver_wrapper_verify_hash(
Gilles Peskine449bd832023-01-11 14:50:10 +01003005 attributes, key_buffer, key_buffer_size,
3006 alg, hash, hash_length,
3007 signature, signature_length);
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003008 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003009
Gilles Peskine449bd832023-01-11 14:50:10 +01003010 return PSA_ERROR_NOT_SUPPORTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003011}
3012
Gilles Peskine449bd832023-01-11 14:50:10 +01003013psa_status_t psa_verify_message(mbedtls_svc_key_id_t key,
3014 psa_algorithm_t alg,
3015 const uint8_t *input,
3016 size_t input_length,
3017 const uint8_t *signature,
3018 size_t signature_length)
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003019{
3020 return psa_verify_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02003021 key, 1, alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003022 signature, signature_length);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003023}
3024
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02003025psa_status_t psa_sign_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01003026 const psa_key_attributes_t *attributes,
3027 const uint8_t *key_buffer, size_t key_buffer_size,
3028 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003029 uint8_t *signature, size_t signature_size, size_t *signature_length)
Gilles Peskinee59236f2018-01-27 23:32:46 +01003030{
Gilles Peskine449bd832023-01-11 14:50:10 +01003031 if (attributes->core.type == PSA_KEY_TYPE_RSA_KEY_PAIR) {
3032 if (PSA_ALG_IS_RSA_PKCS1V15_SIGN(alg) ||
3033 PSA_ALG_IS_RSA_PSS(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003034#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003035 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
3036 return mbedtls_psa_rsa_sign_hash(
3037 attributes,
3038 key_buffer, key_buffer_size,
3039 alg, hash, hash_length,
3040 signature, signature_size, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01003041#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
3042 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003043 } else {
3044 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanacda8342020-07-24 23:09:52 +02003045 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003046 } else if (PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3047 if (PSA_ALG_IS_ECDSA(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003048#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003049 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3050 return mbedtls_psa_ecdsa_sign_hash(
3051 attributes,
3052 key_buffer, key_buffer_size,
3053 alg, hash, hash_length,
3054 signature, signature_size, signature_length);
Gilles Peskinee59236f2018-01-27 23:32:46 +01003055#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3056 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003057 } else {
3058 return PSA_ERROR_INVALID_ARGUMENT;
Ronald Cron4501c982021-03-19 20:09:32 +01003059 }
Ronald Cron8a494f32021-02-17 09:49:51 +01003060 }
Ronald Cron4501c982021-03-19 20:09:32 +01003061
Gilles Peskine449bd832023-01-11 14:50:10 +01003062 (void) key_buffer;
3063 (void) key_buffer_size;
3064 (void) hash;
3065 (void) hash_length;
3066 (void) signature;
3067 (void) signature_size;
3068 (void) signature_length;
Ronald Cron4501c982021-03-19 20:09:32 +01003069
Gilles Peskine449bd832023-01-11 14:50:10 +01003070 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron18659932020-12-08 16:32:23 +01003071}
Gilles Peskinee59236f2018-01-27 23:32:46 +01003072
Gilles Peskine449bd832023-01-11 14:50:10 +01003073psa_status_t psa_sign_hash(mbedtls_svc_key_id_t key,
3074 psa_algorithm_t alg,
3075 const uint8_t *hash,
3076 size_t hash_length,
3077 uint8_t *signature,
3078 size_t signature_size,
3079 size_t *signature_length)
Gilles Peskinee59236f2018-01-27 23:32:46 +01003080{
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003081 return psa_sign_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02003082 key, 0, alg, hash, hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003083 signature, signature_size, signature_length);
itayzafrir5c753392018-05-08 11:18:38 +03003084}
3085
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02003086psa_status_t psa_verify_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01003087 const psa_key_attributes_t *attributes,
3088 const uint8_t *key_buffer, size_t key_buffer_size,
3089 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003090 const uint8_t *signature, size_t signature_length)
itayzafrir5c753392018-05-08 11:18:38 +03003091{
Gilles Peskine449bd832023-01-11 14:50:10 +01003092 if (PSA_KEY_TYPE_IS_RSA(attributes->core.type)) {
3093 if (PSA_ALG_IS_RSA_PKCS1V15_SIGN(alg) ||
3094 PSA_ALG_IS_RSA_PSS(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003095#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003096 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
3097 return mbedtls_psa_rsa_verify_hash(
3098 attributes,
3099 key_buffer, key_buffer_size,
3100 alg, hash, hash_length,
3101 signature, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01003102#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
3103 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003104 } else {
3105 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanacda8342020-07-24 23:09:52 +02003106 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003107 } else if (PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3108 if (PSA_ALG_IS_ECDSA(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003109#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003110 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3111 return mbedtls_psa_ecdsa_verify_hash(
3112 attributes,
3113 key_buffer, key_buffer_size,
3114 alg, hash, hash_length,
3115 signature, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01003116#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3117 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003118 } else {
3119 return PSA_ERROR_INVALID_ARGUMENT;
Ronald Cron4501c982021-03-19 20:09:32 +01003120 }
Ronald Cron8a494f32021-02-17 09:49:51 +01003121 }
Ronald Cron4501c982021-03-19 20:09:32 +01003122
Gilles Peskine449bd832023-01-11 14:50:10 +01003123 (void) key_buffer;
3124 (void) key_buffer_size;
3125 (void) hash;
3126 (void) hash_length;
3127 (void) signature;
3128 (void) signature_length;
Ronald Cron4501c982021-03-19 20:09:32 +01003129
Gilles Peskine449bd832023-01-11 14:50:10 +01003130 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron18659932020-12-08 16:32:23 +01003131}
3132
Gilles Peskine449bd832023-01-11 14:50:10 +01003133psa_status_t psa_verify_hash(mbedtls_svc_key_id_t key,
3134 psa_algorithm_t alg,
3135 const uint8_t *hash,
3136 size_t hash_length,
3137 const uint8_t *signature,
3138 size_t signature_length)
itayzafrir5c753392018-05-08 11:18:38 +03003139{
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003140 return psa_verify_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02003141 key, 0, alg, hash, hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003142 signature, signature_length);
Gilles Peskinee59236f2018-01-27 23:32:46 +01003143}
3144
Gilles Peskine449bd832023-01-11 14:50:10 +01003145psa_status_t psa_asymmetric_encrypt(mbedtls_svc_key_id_t key,
3146 psa_algorithm_t alg,
3147 const uint8_t *input,
3148 size_t input_length,
3149 const uint8_t *salt,
3150 size_t salt_length,
3151 uint8_t *output,
3152 size_t output_size,
3153 size_t *output_length)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003154{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003155 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003156 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003157 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003158 psa_key_attributes_t attributes;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003159
Darryl Green5cc689a2018-07-24 15:34:10 +01003160 (void) input;
3161 (void) input_length;
3162 (void) salt;
3163 (void) output;
3164 (void) output_size;
3165
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003166 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003167
Gilles Peskine449bd832023-01-11 14:50:10 +01003168 if (!PSA_ALG_IS_RSA_OAEP(alg) && salt_length != 0) {
3169 return PSA_ERROR_INVALID_ARGUMENT;
3170 }
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003171
Valerio Setti5bb454a2024-01-15 10:43:16 +01003172 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01003173 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg);
3174 if (status != PSA_SUCCESS) {
3175 return status;
3176 }
3177 if (!(PSA_KEY_TYPE_IS_PUBLIC_KEY(slot->attr.type) ||
3178 PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type))) {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003179 status = PSA_ERROR_INVALID_ARGUMENT;
3180 goto exit;
3181 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003182
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003183 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01003184 .core = slot->attr
Przemyslaw Stekiel19e61422021-12-09 11:09:11 +01003185 };
Steven Cooremana2371e52020-07-28 14:30:39 +02003186
Przemyslaw Stekiel19e61422021-12-09 11:09:11 +01003187 status = psa_driver_wrapper_asymmetric_encrypt(
3188 &attributes, slot->key.data, slot->key.bytes,
3189 alg, input, input_length, salt, salt_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003190 output, output_size, output_length);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003191exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00003192 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003193
Gilles Peskine449bd832023-01-11 14:50:10 +01003194 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003195}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003196
Gilles Peskine449bd832023-01-11 14:50:10 +01003197psa_status_t psa_asymmetric_decrypt(mbedtls_svc_key_id_t key,
3198 psa_algorithm_t alg,
3199 const uint8_t *input,
3200 size_t input_length,
3201 const uint8_t *salt,
3202 size_t salt_length,
3203 uint8_t *output,
3204 size_t output_size,
3205 size_t *output_length)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003206{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003207 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003208 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003209 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003210 psa_key_attributes_t attributes;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003211
Darryl Green5cc689a2018-07-24 15:34:10 +01003212 (void) input;
3213 (void) input_length;
3214 (void) salt;
3215 (void) output;
3216 (void) output_size;
3217
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003218 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003219
Gilles Peskine449bd832023-01-11 14:50:10 +01003220 if (!PSA_ALG_IS_RSA_OAEP(alg) && salt_length != 0) {
3221 return PSA_ERROR_INVALID_ARGUMENT;
3222 }
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003223
Valerio Setti5bb454a2024-01-15 10:43:16 +01003224 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01003225 key, &slot, PSA_KEY_USAGE_DECRYPT, alg);
3226 if (status != PSA_SUCCESS) {
3227 return status;
3228 }
3229 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003230 status = PSA_ERROR_INVALID_ARGUMENT;
3231 goto exit;
3232 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003233
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003234 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01003235 .core = slot->attr
Przemyslaw Stekiel8d45c002021-12-13 08:58:19 +01003236 };
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003237
Przemyslaw Stekiel8d45c002021-12-13 08:58:19 +01003238 status = psa_driver_wrapper_asymmetric_decrypt(
3239 &attributes, slot->key.data, slot->key.bytes,
3240 alg, input, input_length, salt, salt_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003241 output, output_size, output_length);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003242
3243exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00003244 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003245
Gilles Peskine449bd832023-01-11 14:50:10 +01003246 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003247}
Gilles Peskinee59236f2018-01-27 23:32:46 +01003248
Paul Elliott9fe12f62022-11-30 19:16:02 +00003249/****************************************************************/
3250/* Asymmetric interruptible cryptography */
3251/****************************************************************/
3252
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003253static uint32_t psa_interruptible_max_ops = PSA_INTERRUPTIBLE_MAX_OPS_UNLIMITED;
3254
Paul Elliott9fe12f62022-11-30 19:16:02 +00003255void psa_interruptible_set_max_ops(uint32_t max_ops)
3256{
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003257 psa_interruptible_max_ops = max_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003258}
3259
3260uint32_t psa_interruptible_get_max_ops(void)
3261{
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003262 return psa_interruptible_max_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003263}
3264
Paul Elliott9fe12f62022-11-30 19:16:02 +00003265uint32_t psa_sign_hash_get_num_ops(
3266 const psa_sign_hash_interruptible_operation_t *operation)
3267{
Paul Elliott296ede92022-12-15 17:00:30 +00003268 return operation->num_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003269}
3270
3271uint32_t psa_verify_hash_get_num_ops(
3272 const psa_verify_hash_interruptible_operation_t *operation)
3273{
Paul Elliott296ede92022-12-15 17:00:30 +00003274 return operation->num_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003275}
3276
Paul Elliott59ad9452022-12-18 15:09:02 +00003277static psa_status_t psa_sign_hash_abort_internal(
3278 psa_sign_hash_interruptible_operation_t *operation)
3279{
3280 if (operation->id == 0) {
3281 /* The object has (apparently) been initialized but it is not (yet)
3282 * in use. It's ok to call abort on such an object, and there's
3283 * nothing to do. */
3284 return PSA_SUCCESS;
3285 }
3286
3287 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3288
3289 status = psa_driver_wrapper_sign_hash_abort(operation);
3290
3291 operation->id = 0;
3292
Paul Elliotte6145dc2023-02-07 12:51:21 +00003293 /* Do not clear either the error_occurred or num_ops elements here as they
3294 * only want to be cleared by the application calling abort, not by abort
3295 * being called at completion of an operation. */
3296
Paul Elliott59ad9452022-12-18 15:09:02 +00003297 return status;
3298}
3299
Paul Elliott9fe12f62022-11-30 19:16:02 +00003300psa_status_t psa_sign_hash_start(
3301 psa_sign_hash_interruptible_operation_t *operation,
3302 mbedtls_svc_key_id_t key, psa_algorithm_t alg,
3303 const uint8_t *hash, size_t hash_length)
3304{
3305 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3306 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3307 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003308 psa_key_attributes_t attributes;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003309
Paul Elliottc9774412023-02-06 15:14:07 +00003310 /* Check that start has not been previously called, or operation has not
3311 * previously errored. */
3312 if (operation->id != 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003313 return PSA_ERROR_BAD_STATE;
3314 }
3315
Paul Elliott9fe12f62022-11-30 19:16:02 +00003316 status = psa_sign_verify_check_alg(0, alg);
3317 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003318 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003319 return status;
3320 }
3321
3322 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
3323 PSA_KEY_USAGE_SIGN_HASH,
3324 alg);
3325
3326 if (status != PSA_SUCCESS) {
3327 goto exit;
3328 }
3329
3330 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
3331 status = PSA_ERROR_INVALID_ARGUMENT;
3332 goto exit;
3333 }
3334
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003335 attributes = (psa_key_attributes_t) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003336 .core = slot->attr
3337 };
3338
Paul Elliott296ede92022-12-15 17:00:30 +00003339 /* Ensure ops count gets reset, in case of operation re-use. */
3340 operation->num_ops = 0;
3341
Paul Elliott9fe12f62022-11-30 19:16:02 +00003342 status = psa_driver_wrapper_sign_hash_start(operation, &attributes,
3343 slot->key.data,
3344 slot->key.bytes, alg,
3345 hash, hash_length);
3346exit:
3347
3348 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003349 operation->error_occurred = 1;
Paul Elliott59ad9452022-12-18 15:09:02 +00003350 psa_sign_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003351 }
3352
Ryan Everett1b70a072024-01-04 10:32:49 +00003353 unlock_status = psa_unregister_read(slot);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003354
Paul Elliottc9774412023-02-06 15:14:07 +00003355 if (unlock_status != PSA_SUCCESS) {
3356 operation->error_occurred = 1;
3357 }
Paul Elliott9fe12f62022-11-30 19:16:02 +00003358
Paul Elliottc9774412023-02-06 15:14:07 +00003359 return (status == PSA_SUCCESS) ? unlock_status : status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003360}
3361
3362
3363psa_status_t psa_sign_hash_complete(
3364 psa_sign_hash_interruptible_operation_t *operation,
3365 uint8_t *signature, size_t signature_size,
3366 size_t *signature_length)
3367{
3368 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3369
3370 *signature_length = 0;
3371
Paul Elliottc9774412023-02-06 15:14:07 +00003372 /* Check that start has been called first, and that operation has not
3373 * previously errored. */
3374 if (operation->id == 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003375 status = PSA_ERROR_BAD_STATE;
3376 goto exit;
3377 }
3378
Paul Elliott096abc42023-02-03 18:33:23 +00003379 /* Immediately reject a zero-length signature buffer. This guarantees that
3380 * signature must be a valid pointer. */
Paul Elliott9fe12f62022-11-30 19:16:02 +00003381 if (signature_size == 0) {
3382 status = PSA_ERROR_BUFFER_TOO_SMALL;
3383 goto exit;
3384 }
3385
3386 status = psa_driver_wrapper_sign_hash_complete(operation, signature,
3387 signature_size,
3388 signature_length);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003389
Paul Elliott296ede92022-12-15 17:00:30 +00003390 /* Update ops count with work done. */
Paul Elliottde1114c2023-02-07 12:43:11 +00003391 operation->num_ops = psa_driver_wrapper_sign_hash_get_num_ops(operation);
Paul Elliott296ede92022-12-15 17:00:30 +00003392
Paul Elliottebe225c2023-02-10 14:32:53 +00003393exit:
3394
Paul Elliott59200a22023-02-21 15:07:40 +00003395 psa_wipe_tag_output_buffer(signature, status, signature_size,
3396 *signature_length);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003397
Paul Elliott53bb3122023-02-10 14:22:22 +00003398 if (status != PSA_OPERATION_INCOMPLETE) {
Paul Elliottc9774412023-02-06 15:14:07 +00003399 if (status != PSA_SUCCESS) {
3400 operation->error_occurred = 1;
3401 }
3402
Paul Elliott59ad9452022-12-18 15:09:02 +00003403 psa_sign_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003404 }
3405
3406 return status;
3407}
3408
3409psa_status_t psa_sign_hash_abort(
3410 psa_sign_hash_interruptible_operation_t *operation)
3411{
Paul Elliott59ad9452022-12-18 15:09:02 +00003412 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3413
3414 status = psa_sign_hash_abort_internal(operation);
3415
3416 /* We clear the number of ops done here, so that it is not cleared when
3417 * the operation fails or succeeds, only on manual abort. */
3418 operation->num_ops = 0;
3419
Paul Elliottc9774412023-02-06 15:14:07 +00003420 /* Likewise, failure state. */
3421 operation->error_occurred = 0;
3422
Paul Elliott59ad9452022-12-18 15:09:02 +00003423 return status;
3424}
3425
3426static psa_status_t psa_verify_hash_abort_internal(
3427 psa_verify_hash_interruptible_operation_t *operation)
3428{
Paul Elliott9fe12f62022-11-30 19:16:02 +00003429 if (operation->id == 0) {
3430 /* The object has (apparently) been initialized but it is not (yet)
3431 * in use. It's ok to call abort on such an object, and there's
3432 * nothing to do. */
3433 return PSA_SUCCESS;
3434 }
3435
Paul Elliott59ad9452022-12-18 15:09:02 +00003436 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3437
3438 status = psa_driver_wrapper_verify_hash_abort(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003439
3440 operation->id = 0;
3441
Paul Elliotte6145dc2023-02-07 12:51:21 +00003442 /* Do not clear either the error_occurred or num_ops elements here as they
3443 * only want to be cleared by the application calling abort, not by abort
3444 * being called at completion of an operation. */
3445
Paul Elliott59ad9452022-12-18 15:09:02 +00003446 return status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003447}
3448
3449psa_status_t psa_verify_hash_start(
3450 psa_verify_hash_interruptible_operation_t *operation,
3451 mbedtls_svc_key_id_t key, psa_algorithm_t alg,
3452 const uint8_t *hash, size_t hash_length,
3453 const uint8_t *signature, size_t signature_length)
3454{
3455 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3456 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3457 psa_key_slot_t *slot;
3458
Paul Elliottc9774412023-02-06 15:14:07 +00003459 /* Check that start has not been previously called, or operation has not
3460 * previously errored. */
3461 if (operation->id != 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003462 return PSA_ERROR_BAD_STATE;
3463 }
3464
3465 status = psa_sign_verify_check_alg(0, alg);
3466 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003467 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003468 return status;
3469 }
3470
3471 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
3472 PSA_KEY_USAGE_VERIFY_HASH,
3473 alg);
3474
3475 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003476 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003477 return status;
3478 }
3479
3480 psa_key_attributes_t attributes = {
3481 .core = slot->attr
3482 };
3483
Paul Elliott296ede92022-12-15 17:00:30 +00003484 /* Ensure ops count gets reset, in case of operation re-use. */
3485 operation->num_ops = 0;
3486
Paul Elliott9fe12f62022-11-30 19:16:02 +00003487 status = psa_driver_wrapper_verify_hash_start(operation, &attributes,
3488 slot->key.data,
3489 slot->key.bytes,
3490 alg, hash, hash_length,
3491 signature, signature_length);
3492
3493 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003494 operation->error_occurred = 1;
Paul Elliott59ad9452022-12-18 15:09:02 +00003495 psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003496 }
3497
Ryan Everett1b70a072024-01-04 10:32:49 +00003498 unlock_status = psa_unregister_read(slot);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003499
Paul Elliottc9774412023-02-06 15:14:07 +00003500 if (unlock_status != PSA_SUCCESS) {
3501 operation->error_occurred = 1;
3502 }
Paul Elliott9fe12f62022-11-30 19:16:02 +00003503
Paul Elliottc9774412023-02-06 15:14:07 +00003504 return (status == PSA_SUCCESS) ? unlock_status : status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003505}
3506
3507psa_status_t psa_verify_hash_complete(
3508 psa_verify_hash_interruptible_operation_t *operation)
3509{
3510 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3511
Paul Elliottc9774412023-02-06 15:14:07 +00003512 /* Check that start has been called first, and that operation has not
3513 * previously errored. */
3514 if (operation->id == 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003515 status = PSA_ERROR_BAD_STATE;
3516 goto exit;
3517 }
3518
3519 status = psa_driver_wrapper_verify_hash_complete(operation);
3520
Paul Elliott296ede92022-12-15 17:00:30 +00003521 /* Update ops count with work done. */
Paul Elliottde1114c2023-02-07 12:43:11 +00003522 operation->num_ops = psa_driver_wrapper_verify_hash_get_num_ops(
Paul Elliott296ede92022-12-15 17:00:30 +00003523 operation);
3524
Paul Elliottebe225c2023-02-10 14:32:53 +00003525exit:
3526
Paul Elliott9fe12f62022-11-30 19:16:02 +00003527 if (status != PSA_OPERATION_INCOMPLETE) {
Paul Elliottc9774412023-02-06 15:14:07 +00003528 if (status != PSA_SUCCESS) {
3529 operation->error_occurred = 1;
3530 }
3531
Paul Elliott59ad9452022-12-18 15:09:02 +00003532 psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003533 }
3534
3535 return status;
3536}
3537
3538psa_status_t psa_verify_hash_abort(
3539 psa_verify_hash_interruptible_operation_t *operation)
3540{
Paul Elliott59ad9452022-12-18 15:09:02 +00003541 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003542
Paul Elliott59ad9452022-12-18 15:09:02 +00003543 status = psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003544
Paul Elliott59ad9452022-12-18 15:09:02 +00003545 /* We clear the number of ops done here, so that it is not cleared when
3546 * the operation fails or succeeds, only on manual abort. */
3547 operation->num_ops = 0;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003548
Paul Elliottc9774412023-02-06 15:14:07 +00003549 /* Likewise, failure state. */
3550 operation->error_occurred = 0;
3551
Paul Elliott59ad9452022-12-18 15:09:02 +00003552 return status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003553}
3554
Paul Elliott588f8ed2022-12-02 18:10:26 +00003555/****************************************************************/
3556/* Asymmetric interruptible cryptography internal */
3557/* implementations */
3558/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003559
Paul Elliott588f8ed2022-12-02 18:10:26 +00003560void mbedtls_psa_interruptible_set_max_ops(uint32_t max_ops)
3561{
Paul Elliott7cc4e812023-01-10 17:14:11 +00003562
Paul Elliott588f8ed2022-12-02 18:10:26 +00003563#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3564 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3565 defined(MBEDTLS_ECP_RESTARTABLE)
3566
3567 /* Internal implementation uses zero to indicate infinite number max ops,
3568 * therefore avoid this value, and set to minimum possible. */
3569 if (max_ops == 0) {
3570 max_ops = 1;
3571 }
3572
Paul Elliott588f8ed2022-12-02 18:10:26 +00003573 mbedtls_ecp_set_max_ops(max_ops);
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003574#else
3575 (void) max_ops;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003576#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3577 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3578 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3579}
3580
Paul Elliott588f8ed2022-12-02 18:10:26 +00003581uint32_t mbedtls_psa_sign_hash_get_num_ops(
Paul Elliottf8e5b562023-02-19 18:43:45 +00003582 const mbedtls_psa_sign_hash_interruptible_operation_t *operation)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003583{
3584#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3585 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3586 defined(MBEDTLS_ECP_RESTARTABLE)
3587
Paul Elliott93d9ca82023-02-15 18:14:21 +00003588 return operation->num_ops;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003589#else
3590 (void) operation;
3591 return 0;
3592#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3593 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3594 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3595}
3596
3597uint32_t mbedtls_psa_verify_hash_get_num_ops(
Paul Elliottf8e5b562023-02-19 18:43:45 +00003598 const mbedtls_psa_verify_hash_interruptible_operation_t *operation)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003599{
3600 #if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3601 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3602 defined(MBEDTLS_ECP_RESTARTABLE)
3603
Paul Elliott93d9ca82023-02-15 18:14:21 +00003604 return operation->num_ops;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003605#else
3606 (void) operation;
3607 return 0;
3608#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3609 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3610 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3611}
3612
3613psa_status_t mbedtls_psa_sign_hash_start(
3614 mbedtls_psa_sign_hash_interruptible_operation_t *operation,
3615 const psa_key_attributes_t *attributes, const uint8_t *key_buffer,
3616 size_t key_buffer_size, psa_algorithm_t alg,
3617 const uint8_t *hash, size_t hash_length)
3618{
3619 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott0290a762023-02-09 14:30:24 +00003620 size_t required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003621
Paul Elliott068fe072023-01-16 13:59:15 +00003622 if (!PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3623 return PSA_ERROR_NOT_SUPPORTED;
3624 }
3625
3626 if (!PSA_ALG_IS_ECDSA(alg)) {
Paul Elliott813f9cd2023-02-05 15:28:46 +00003627 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott068fe072023-01-16 13:59:15 +00003628 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003629
3630#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Paul Elliott068fe072023-01-16 13:59:15 +00003631 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3632 defined(MBEDTLS_ECP_RESTARTABLE)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003633
Paul Elliotta1c94092023-02-15 16:38:04 +00003634 mbedtls_ecdsa_restart_init(&operation->restart_ctx);
3635
Paul Elliott93d9ca82023-02-15 18:14:21 +00003636 /* Ensure num_ops is zero'ed in case of context re-use. */
3637 operation->num_ops = 0;
3638
Paul Elliott068fe072023-01-16 13:59:15 +00003639 status = mbedtls_psa_ecp_load_representation(attributes->core.type,
3640 attributes->core.bits,
3641 key_buffer,
3642 key_buffer_size,
3643 &operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003644
Paul Elliott068fe072023-01-16 13:59:15 +00003645 if (status != PSA_SUCCESS) {
3646 return status;
3647 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003648
Paul Elliott1bc59df2023-02-05 13:41:57 +00003649 operation->coordinate_bytes = PSA_BITS_TO_BYTES(
Paul Elliottc569fc22023-02-10 13:02:54 +00003650 operation->ctx->grp.nbits);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003651
Paul Elliott068fe072023-01-16 13:59:15 +00003652 psa_algorithm_t hash_alg = PSA_ALG_SIGN_GET_HASH(alg);
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02003653 operation->md_alg = mbedtls_md_type_from_psa_alg(hash_alg);
Paul Elliott068fe072023-01-16 13:59:15 +00003654 operation->alg = alg;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003655
Paul Elliott0290a762023-02-09 14:30:24 +00003656 /* We only need to store the same length of hash as the private key size
3657 * here, it would be truncated by the internal implementation anyway. */
3658 required_hash_length = (hash_length < operation->coordinate_bytes ?
3659 hash_length : operation->coordinate_bytes);
3660
Paul Elliottba70ad42023-02-15 18:23:53 +00003661 if (required_hash_length > sizeof(operation->hash)) {
3662 /* Shouldn't happen, but better safe than sorry. */
3663 return PSA_ERROR_CORRUPTION_DETECTED;
3664 }
3665
Paul Elliott0290a762023-02-09 14:30:24 +00003666 memcpy(operation->hash, hash, required_hash_length);
3667 operation->hash_length = required_hash_length;
Paul Elliott068fe072023-01-16 13:59:15 +00003668
3669 return PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003670
3671#else
Paul Elliott068fe072023-01-16 13:59:15 +00003672 (void) operation;
3673 (void) key_buffer;
3674 (void) key_buffer_size;
3675 (void) alg;
3676 (void) hash;
3677 (void) hash_length;
3678 (void) status;
Paul Elliott0290a762023-02-09 14:30:24 +00003679 (void) required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003680
Paul Elliott068fe072023-01-16 13:59:15 +00003681 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003682#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3683 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3684 * defined( MBEDTLS_ECP_RESTARTABLE ) */
Paul Elliott588f8ed2022-12-02 18:10:26 +00003685}
3686
3687psa_status_t mbedtls_psa_sign_hash_complete(
3688 mbedtls_psa_sign_hash_interruptible_operation_t *operation,
3689 uint8_t *signature, size_t signature_size,
3690 size_t *signature_length)
3691{
Paul Elliott588f8ed2022-12-02 18:10:26 +00003692#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3693 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3694 defined(MBEDTLS_ECP_RESTARTABLE)
3695
Paul Elliotta1c94092023-02-15 16:38:04 +00003696 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott1243f932023-02-07 11:21:10 +00003697 mbedtls_mpi r;
3698 mbedtls_mpi s;
3699
Paul Elliott46845252023-02-03 14:59:11 +00003700 mbedtls_mpi_init(&r);
3701 mbedtls_mpi_init(&s);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003702
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003703 /* Ensure max_ops is set to the current value (or default). */
3704 mbedtls_psa_interruptible_set_max_ops(psa_interruptible_get_max_ops());
3705
Paul Elliotta1c94092023-02-15 16:38:04 +00003706 if (signature_size < 2 * operation->coordinate_bytes) {
3707 status = PSA_ERROR_BUFFER_TOO_SMALL;
3708 goto exit;
3709 }
3710
Paul Elliott588f8ed2022-12-02 18:10:26 +00003711 if (PSA_ALG_ECDSA_IS_DETERMINISTIC(operation->alg)) {
Paul Elliott46845252023-02-03 14:59:11 +00003712
Paul Elliott588f8ed2022-12-02 18:10:26 +00003713#if defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3714 status = mbedtls_to_psa_error(
3715 mbedtls_ecdsa_sign_det_restartable(&operation->ctx->grp,
Paul Elliott46845252023-02-03 14:59:11 +00003716 &r,
3717 &s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003718 &operation->ctx->d,
3719 operation->hash,
3720 operation->hash_length,
3721 operation->md_alg,
3722 mbedtls_psa_get_random,
3723 MBEDTLS_PSA_RANDOM_STATE,
3724 &operation->restart_ctx));
3725#else /* defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Paul Elliott724bd252023-02-08 12:35:08 +00003726 status = PSA_ERROR_NOT_SUPPORTED;
3727 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003728#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
3729 } else {
Paul Elliott588f8ed2022-12-02 18:10:26 +00003730 status = mbedtls_to_psa_error(
3731 mbedtls_ecdsa_sign_restartable(&operation->ctx->grp,
Paul Elliott46845252023-02-03 14:59:11 +00003732 &r,
3733 &s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003734 &operation->ctx->d,
3735 operation->hash,
3736 operation->hash_length,
3737 mbedtls_psa_get_random,
3738 MBEDTLS_PSA_RANDOM_STATE,
3739 mbedtls_psa_get_random,
3740 MBEDTLS_PSA_RANDOM_STATE,
3741 &operation->restart_ctx));
3742 }
3743
Paul Elliottf8e5b562023-02-19 18:43:45 +00003744 /* Hide the fact that the restart context only holds a delta of number of
3745 * ops done during the last operation, not an absolute value. */
3746 operation->num_ops += operation->restart_ctx.ecp.ops_done;
3747
Paul Elliott724bd252023-02-08 12:35:08 +00003748 if (status == PSA_SUCCESS) {
Paul Elliott588f8ed2022-12-02 18:10:26 +00003749 status = mbedtls_to_psa_error(
Paul Elliott46845252023-02-03 14:59:11 +00003750 mbedtls_mpi_write_binary(&r,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003751 signature,
Paul Elliott1bc59df2023-02-05 13:41:57 +00003752 operation->coordinate_bytes)
3753 );
Paul Elliott588f8ed2022-12-02 18:10:26 +00003754
3755 if (status != PSA_SUCCESS) {
Paul Elliott724bd252023-02-08 12:35:08 +00003756 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003757 }
3758
3759 status = mbedtls_to_psa_error(
Paul Elliott46845252023-02-03 14:59:11 +00003760 mbedtls_mpi_write_binary(&s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003761 signature +
Paul Elliott1bc59df2023-02-05 13:41:57 +00003762 operation->coordinate_bytes,
3763 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
Paul Elliott1bc59df2023-02-05 13:41:57 +00003770 *signature_length = operation->coordinate_bytes * 2;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003771
Paul Elliott724bd252023-02-08 12:35:08 +00003772 status = PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003773 }
Paul Elliott724bd252023-02-08 12:35:08 +00003774
3775exit:
3776
3777 mbedtls_mpi_free(&r);
3778 mbedtls_mpi_free(&s);
3779 return status;
3780
Paul Elliott588f8ed2022-12-02 18:10:26 +00003781 #else
3782
3783 (void) operation;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003784 (void) signature;
3785 (void) signature_size;
3786 (void) signature_length;
3787
3788 return PSA_ERROR_NOT_SUPPORTED;
3789
3790#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3791 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3792 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3793}
3794
3795psa_status_t mbedtls_psa_sign_hash_abort(
3796 mbedtls_psa_sign_hash_interruptible_operation_t *operation)
3797{
3798
3799#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3800 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3801 defined(MBEDTLS_ECP_RESTARTABLE)
3802
3803 if (operation->ctx) {
3804 mbedtls_ecdsa_free(operation->ctx);
3805 mbedtls_free(operation->ctx);
Paul Elliottf9c91a72023-02-05 18:06:38 +00003806 operation->ctx = NULL;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003807 }
3808
3809 mbedtls_ecdsa_restart_free(&operation->restart_ctx);
3810
Paul Elliott93d9ca82023-02-15 18:14:21 +00003811 operation->num_ops = 0;
3812
Paul Elliott588f8ed2022-12-02 18:10:26 +00003813 return PSA_SUCCESS;
3814
3815#else
3816
3817 (void) operation;
3818
3819 return PSA_ERROR_NOT_SUPPORTED;
3820
3821#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3822 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3823 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3824}
3825
3826psa_status_t mbedtls_psa_verify_hash_start(
3827 mbedtls_psa_verify_hash_interruptible_operation_t *operation,
3828 const psa_key_attributes_t *attributes,
3829 const uint8_t *key_buffer, size_t key_buffer_size,
3830 psa_algorithm_t alg,
3831 const uint8_t *hash, size_t hash_length,
3832 const uint8_t *signature, size_t signature_length)
3833{
3834 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott1bc59df2023-02-05 13:41:57 +00003835 size_t coordinate_bytes = 0;
Paul Elliott0290a762023-02-09 14:30:24 +00003836 size_t required_hash_length = 0;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003837
Paul Elliott068fe072023-01-16 13:59:15 +00003838 if (!PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3839 return PSA_ERROR_NOT_SUPPORTED;
3840 }
3841
3842 if (!PSA_ALG_IS_ECDSA(alg)) {
Paul Elliott813f9cd2023-02-05 15:28:46 +00003843 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott068fe072023-01-16 13:59:15 +00003844 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003845
3846#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Paul Elliott068fe072023-01-16 13:59:15 +00003847 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3848 defined(MBEDTLS_ECP_RESTARTABLE)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003849
Paul Elliotta1c94092023-02-15 16:38:04 +00003850 mbedtls_ecdsa_restart_init(&operation->restart_ctx);
3851 mbedtls_mpi_init(&operation->r);
3852 mbedtls_mpi_init(&operation->s);
3853
Paul Elliott93d9ca82023-02-15 18:14:21 +00003854 /* Ensure num_ops is zero'ed in case of context re-use. */
3855 operation->num_ops = 0;
3856
Paul Elliott068fe072023-01-16 13:59:15 +00003857 status = mbedtls_psa_ecp_load_representation(attributes->core.type,
3858 attributes->core.bits,
3859 key_buffer,
3860 key_buffer_size,
3861 &operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003862
Paul Elliott068fe072023-01-16 13:59:15 +00003863 if (status != PSA_SUCCESS) {
3864 return status;
3865 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003866
Paul Elliottc569fc22023-02-10 13:02:54 +00003867 coordinate_bytes = PSA_BITS_TO_BYTES(operation->ctx->grp.nbits);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003868
Paul Elliott1bc59df2023-02-05 13:41:57 +00003869 if (signature_length != 2 * coordinate_bytes) {
Paul Elliott068fe072023-01-16 13:59:15 +00003870 return PSA_ERROR_INVALID_SIGNATURE;
3871 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003872
Paul Elliott068fe072023-01-16 13:59:15 +00003873 status = mbedtls_to_psa_error(
3874 mbedtls_mpi_read_binary(&operation->r,
3875 signature,
Paul Elliott1bc59df2023-02-05 13:41:57 +00003876 coordinate_bytes));
Paul Elliott588f8ed2022-12-02 18:10:26 +00003877
Paul Elliott068fe072023-01-16 13:59:15 +00003878 if (status != PSA_SUCCESS) {
3879 return status;
3880 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003881
Paul Elliott068fe072023-01-16 13:59:15 +00003882 status = mbedtls_to_psa_error(
3883 mbedtls_mpi_read_binary(&operation->s,
3884 signature +
Paul Elliott1bc59df2023-02-05 13:41:57 +00003885 coordinate_bytes,
3886 coordinate_bytes));
Paul Elliott588f8ed2022-12-02 18:10:26 +00003887
Paul Elliott068fe072023-01-16 13:59:15 +00003888 if (status != PSA_SUCCESS) {
3889 return status;
3890 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003891
Paul Elliott2c9843f2023-02-15 17:32:42 +00003892 status = mbedtls_psa_ecp_load_public_part(operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003893
Paul Elliott2c9843f2023-02-15 17:32:42 +00003894 if (status != PSA_SUCCESS) {
3895 return status;
Paul Elliott068fe072023-01-16 13:59:15 +00003896 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003897
Paul Elliott0290a762023-02-09 14:30:24 +00003898 /* We only need to store the same length of hash as the private key size
3899 * here, it would be truncated by the internal implementation anyway. */
3900 required_hash_length = (hash_length < coordinate_bytes ? hash_length :
3901 coordinate_bytes);
3902
Paul Elliottba70ad42023-02-15 18:23:53 +00003903 if (required_hash_length > sizeof(operation->hash)) {
3904 /* Shouldn't happen, but better safe than sorry. */
3905 return PSA_ERROR_CORRUPTION_DETECTED;
3906 }
3907
Paul Elliott0290a762023-02-09 14:30:24 +00003908 memcpy(operation->hash, hash, required_hash_length);
3909 operation->hash_length = required_hash_length;
Paul Elliott068fe072023-01-16 13:59:15 +00003910
3911 return PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003912#else
Paul Elliott068fe072023-01-16 13:59:15 +00003913 (void) operation;
3914 (void) key_buffer;
3915 (void) key_buffer_size;
3916 (void) alg;
3917 (void) hash;
3918 (void) hash_length;
3919 (void) signature;
3920 (void) signature_length;
3921 (void) status;
Paul Elliott1243f932023-02-07 11:21:10 +00003922 (void) coordinate_bytes;
Paul Elliott0290a762023-02-09 14:30:24 +00003923 (void) required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003924
Paul Elliott068fe072023-01-16 13:59:15 +00003925 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003926#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3927 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3928 * defined( MBEDTLS_ECP_RESTARTABLE ) */
Paul Elliott588f8ed2022-12-02 18:10:26 +00003929}
3930
3931psa_status_t mbedtls_psa_verify_hash_complete(
3932 mbedtls_psa_verify_hash_interruptible_operation_t *operation)
3933{
3934
3935#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3936 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3937 defined(MBEDTLS_ECP_RESTARTABLE)
3938
Paul Elliottf8e5b562023-02-19 18:43:45 +00003939 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3940
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003941 /* Ensure max_ops is set to the current value (or default). */
3942 mbedtls_psa_interruptible_set_max_ops(psa_interruptible_get_max_ops());
3943
Paul Elliottf8e5b562023-02-19 18:43:45 +00003944 status = mbedtls_to_psa_error(
Paul Elliott588f8ed2022-12-02 18:10:26 +00003945 mbedtls_ecdsa_verify_restartable(&operation->ctx->grp,
3946 operation->hash,
3947 operation->hash_length,
3948 &operation->ctx->Q,
3949 &operation->r,
3950 &operation->s,
3951 &operation->restart_ctx));
3952
Paul Elliottf8e5b562023-02-19 18:43:45 +00003953 /* Hide the fact that the restart context only holds a delta of number of
3954 * ops done during the last operation, not an absolute value. */
3955 operation->num_ops += operation->restart_ctx.ecp.ops_done;
3956
3957 return status;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003958#else
3959 (void) operation;
3960
3961 return PSA_ERROR_NOT_SUPPORTED;
3962
3963#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3964 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3965 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3966}
3967
3968psa_status_t mbedtls_psa_verify_hash_abort(
3969 mbedtls_psa_verify_hash_interruptible_operation_t *operation)
3970{
3971
3972#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3973 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3974 defined(MBEDTLS_ECP_RESTARTABLE)
3975
3976 if (operation->ctx) {
3977 mbedtls_ecdsa_free(operation->ctx);
3978 mbedtls_free(operation->ctx);
Paul Elliottf9c91a72023-02-05 18:06:38 +00003979 operation->ctx = NULL;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003980 }
3981
3982 mbedtls_ecdsa_restart_free(&operation->restart_ctx);
3983
Paul Elliott93d9ca82023-02-15 18:14:21 +00003984 operation->num_ops = 0;
3985
Paul Elliott588f8ed2022-12-02 18:10:26 +00003986 mbedtls_mpi_free(&operation->r);
3987 mbedtls_mpi_free(&operation->s);
3988
3989 return PSA_SUCCESS;
3990
3991#else
3992 (void) operation;
3993
3994 return PSA_ERROR_NOT_SUPPORTED;
3995
3996#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3997 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3998 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3999}
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004000
mohammad1603503973b2018-03-12 15:59:30 +02004001/****************************************************************/
4002/* Symmetric cryptography */
4003/****************************************************************/
4004
Gilles Peskine449bd832023-01-11 14:50:10 +01004005static psa_status_t psa_cipher_setup(psa_cipher_operation_t *operation,
4006 mbedtls_svc_key_id_t key,
4007 psa_algorithm_t alg,
4008 mbedtls_operation_t cipher_operation)
Ronald Cronab99ac22020-10-01 16:38:28 +02004009{
4010 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4011 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman54648242021-06-24 11:49:45 +01004012 psa_key_slot_t *slot = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01004013 psa_key_usage_t usage = (cipher_operation == MBEDTLS_ENCRYPT ?
4014 PSA_KEY_USAGE_ENCRYPT :
4015 PSA_KEY_USAGE_DECRYPT);
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004016 psa_key_attributes_t attributes;
Ronald Cronab99ac22020-10-01 16:38:28 +02004017
4018 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004019 if (operation->id != 0) {
Dave Rodgman54648242021-06-24 11:49:45 +01004020 status = PSA_ERROR_BAD_STATE;
4021 goto exit;
4022 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004023
Gilles Peskine449bd832023-01-11 14:50:10 +01004024 if (!PSA_ALG_IS_CIPHER(alg)) {
Dave Rodgman54648242021-06-24 11:49:45 +01004025 status = PSA_ERROR_INVALID_ARGUMENT;
4026 goto exit;
4027 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004028
Gilles Peskine449bd832023-01-11 14:50:10 +01004029 status = psa_get_and_lock_key_slot_with_policy(key, &slot, usage, alg);
4030 if (status != PSA_SUCCESS) {
Ronald Cronab99ac22020-10-01 16:38:28 +02004031 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004032 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004033
Ronald Cron49fafa92021-03-10 08:34:23 +01004034 /* Initialize the operation struct members, except for id. The id member
Ronald Cronab99ac22020-10-01 16:38:28 +02004035 * is used to indicate to psa_cipher_abort that there are resources to free,
Ronald Cron49fafa92021-03-10 08:34:23 +01004036 * so we only set it (in the driver wrapper) after resources have been
4037 * allocated/initialized. */
Ronald Cronab99ac22020-10-01 16:38:28 +02004038 operation->iv_set = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004039 if (alg == PSA_ALG_ECB_NO_PADDING) {
Ronald Cronab99ac22020-10-01 16:38:28 +02004040 operation->iv_required = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004041 } else {
Ronald Cronab99ac22020-10-01 16:38:28 +02004042 operation->iv_required = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004043 }
4044 operation->default_iv_length = PSA_CIPHER_IV_LENGTH(slot->attr.type, alg);
Ronald Cronab99ac22020-10-01 16:38:28 +02004045
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004046 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004047 .core = slot->attr
Ronald Crona4af55f2020-12-14 14:36:06 +01004048 };
4049
Ronald Cronab99ac22020-10-01 16:38:28 +02004050 /* Try doing the operation through a driver before using software fallback. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004051 if (cipher_operation == MBEDTLS_ENCRYPT) {
4052 status = psa_driver_wrapper_cipher_encrypt_setup(operation,
4053 &attributes,
4054 slot->key.data,
4055 slot->key.bytes,
4056 alg);
4057 } else {
4058 status = psa_driver_wrapper_cipher_decrypt_setup(operation,
4059 &attributes,
4060 slot->key.data,
4061 slot->key.bytes,
4062 alg);
4063 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004064
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004065exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004066 if (status != PSA_SUCCESS) {
4067 psa_cipher_abort(operation);
4068 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004069
Ryan Everett1b70a072024-01-04 10:32:49 +00004070 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02004071
Gilles Peskine449bd832023-01-11 14:50:10 +01004072 return (status == PSA_SUCCESS) ? unlock_status : status;
mohammad1603503973b2018-03-12 15:59:30 +02004073}
4074
Gilles Peskine449bd832023-01-11 14:50:10 +01004075psa_status_t psa_cipher_encrypt_setup(psa_cipher_operation_t *operation,
4076 mbedtls_svc_key_id_t key,
4077 psa_algorithm_t alg)
mohammad16038481e742018-03-18 13:57:31 +02004078{
Gilles Peskine449bd832023-01-11 14:50:10 +01004079 return psa_cipher_setup(operation, key, alg, MBEDTLS_ENCRYPT);
mohammad16038481e742018-03-18 13:57:31 +02004080}
4081
Gilles Peskine449bd832023-01-11 14:50:10 +01004082psa_status_t psa_cipher_decrypt_setup(psa_cipher_operation_t *operation,
4083 mbedtls_svc_key_id_t key,
4084 psa_algorithm_t alg)
mohammad16038481e742018-03-18 13:57:31 +02004085{
Gilles Peskine449bd832023-01-11 14:50:10 +01004086 return psa_cipher_setup(operation, key, alg, MBEDTLS_DECRYPT);
mohammad16038481e742018-03-18 13:57:31 +02004087}
4088
Gilles Peskine449bd832023-01-11 14:50:10 +01004089psa_status_t psa_cipher_generate_iv(psa_cipher_operation_t *operation,
4090 uint8_t *iv,
4091 size_t iv_size,
4092 size_t *iv_length)
mohammad1603503973b2018-03-12 15:59:30 +02004093{
Ronald Cron6d051732020-10-01 14:10:20 +02004094 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2fb90522021-07-05 12:31:44 +02004095 uint8_t local_iv[PSA_CIPHER_IV_MAX_SIZE];
Sergeybef1f632023-03-06 15:25:06 -07004096 size_t default_iv_length = 0;
Ronald Cron5618a392021-03-26 09:52:26 +01004097
Gilles Peskine449bd832023-01-11 14:50:10 +01004098 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004099 status = PSA_ERROR_BAD_STATE;
4100 goto exit;
Ronald Cronc45b4af2020-09-29 16:18:05 +02004101 }
4102
Gilles Peskine449bd832023-01-11 14:50:10 +01004103 if (operation->iv_set || !operation->iv_required) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004104 status = PSA_ERROR_BAD_STATE;
4105 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004106 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004107
Ronald Cron2fb90522021-07-05 12:31:44 +02004108 default_iv_length = operation->default_iv_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01004109 if (iv_size < default_iv_length) {
Ronald Cron5618a392021-03-26 09:52:26 +01004110 status = PSA_ERROR_BUFFER_TOO_SMALL;
4111 goto exit;
4112 }
Gilles Peskinee553c652018-06-04 16:22:46 +02004113
Gilles Peskine449bd832023-01-11 14:50:10 +01004114 if (default_iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Ronald Cron2fb90522021-07-05 12:31:44 +02004115 status = PSA_ERROR_GENERIC_ERROR;
4116 goto exit;
4117 }
4118
Gilles Peskine449bd832023-01-11 14:50:10 +01004119 status = psa_generate_random(local_iv, default_iv_length);
4120 if (status != PSA_SUCCESS) {
Ronald Cron5618a392021-03-26 09:52:26 +01004121 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004122 }
Ronald Cron5618a392021-03-26 09:52:26 +01004123
Gilles Peskine449bd832023-01-11 14:50:10 +01004124 status = psa_driver_wrapper_cipher_set_iv(operation,
4125 local_iv, default_iv_length);
Ronald Cron5618a392021-03-26 09:52:26 +01004126
4127exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004128 if (status == PSA_SUCCESS) {
4129 memcpy(iv, local_iv, default_iv_length);
Ronald Cron2fb90522021-07-05 12:31:44 +02004130 *iv_length = default_iv_length;
Steven Cooreman7df02922020-09-09 15:28:49 +02004131 operation->iv_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004132 } else {
Ronald Cron2fb90522021-07-05 12:31:44 +02004133 *iv_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004134 psa_cipher_abort(operation);
Ronald Cron2fb90522021-07-05 12:31:44 +02004135 }
Ronald Cron6d051732020-10-01 14:10:20 +02004136
Gilles Peskine449bd832023-01-11 14:50:10 +01004137 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004138}
4139
Gilles Peskine449bd832023-01-11 14:50:10 +01004140psa_status_t psa_cipher_set_iv(psa_cipher_operation_t *operation,
4141 const uint8_t *iv,
4142 size_t iv_length)
mohammad1603503973b2018-03-12 15:59:30 +02004143{
Ronald Cron6d051732020-10-01 14:10:20 +02004144 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronc45b4af2020-09-29 16:18:05 +02004145
Gilles Peskine449bd832023-01-11 14:50:10 +01004146 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004147 status = PSA_ERROR_BAD_STATE;
4148 goto exit;
4149 }
Ronald Cronc45b4af2020-09-29 16:18:05 +02004150
Gilles Peskine449bd832023-01-11 14:50:10 +01004151 if (operation->iv_set || !operation->iv_required) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004152 status = PSA_ERROR_BAD_STATE;
4153 goto exit;
4154 }
Ronald Crona0d68172021-03-26 10:15:08 +01004155
Gilles Peskine449bd832023-01-11 14:50:10 +01004156 if (iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004157 status = PSA_ERROR_INVALID_ARGUMENT;
4158 goto exit;
4159 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004160
Gilles Peskine449bd832023-01-11 14:50:10 +01004161 status = psa_driver_wrapper_cipher_set_iv(operation,
4162 iv,
4163 iv_length);
Steven Cooremand3feccd2020-09-01 15:56:14 +02004164
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004165exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004166 if (status == PSA_SUCCESS) {
itayzafrir534bd7c2018-08-02 13:56:32 +03004167 operation->iv_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004168 } else {
4169 psa_cipher_abort(operation);
4170 }
4171 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004172}
4173
Gilles Peskine449bd832023-01-11 14:50:10 +01004174psa_status_t psa_cipher_update(psa_cipher_operation_t *operation,
4175 const uint8_t *input,
4176 size_t input_length,
4177 uint8_t *output,
4178 size_t output_size,
4179 size_t *output_length)
mohammad1603503973b2018-03-12 15:59:30 +02004180{
Steven Cooremanffecb7b2020-08-25 15:13:13 +02004181 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron6d051732020-10-01 14:10:20 +02004182
Gilles Peskine449bd832023-01-11 14:50:10 +01004183 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004184 status = PSA_ERROR_BAD_STATE;
4185 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004186 }
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004187
Gilles Peskine449bd832023-01-11 14:50:10 +01004188 if (operation->iv_required && !operation->iv_set) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004189 status = PSA_ERROR_BAD_STATE;
4190 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004191 }
Jaeden Ameroab439972019-02-15 14:12:05 +00004192
Gilles Peskine449bd832023-01-11 14:50:10 +01004193 status = psa_driver_wrapper_cipher_update(operation,
4194 input,
4195 input_length,
4196 output,
4197 output_size,
4198 output_length);
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004199
4200exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004201 if (status != PSA_SUCCESS) {
4202 psa_cipher_abort(operation);
4203 }
Ronald Cron6d051732020-10-01 14:10:20 +02004204
Gilles Peskine449bd832023-01-11 14:50:10 +01004205 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004206}
4207
Gilles Peskine449bd832023-01-11 14:50:10 +01004208psa_status_t psa_cipher_finish(psa_cipher_operation_t *operation,
4209 uint8_t *output,
4210 size_t output_size,
4211 size_t *output_length)
mohammad1603503973b2018-03-12 15:59:30 +02004212{
David Saadab4ecc272019-02-14 13:48:10 +02004213 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Ronald Cron6d051732020-10-01 14:10:20 +02004214
Gilles Peskine449bd832023-01-11 14:50:10 +01004215 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004216 status = PSA_ERROR_BAD_STATE;
4217 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004218 }
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004219
Gilles Peskine449bd832023-01-11 14:50:10 +01004220 if (operation->iv_required && !operation->iv_set) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004221 status = PSA_ERROR_BAD_STATE;
4222 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004223 }
Moran Pekerbed71a22018-04-22 20:19:20 +03004224
Gilles Peskine449bd832023-01-11 14:50:10 +01004225 status = psa_driver_wrapper_cipher_finish(operation,
4226 output,
4227 output_size,
4228 output_length);
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004229
4230exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004231 if (status == PSA_SUCCESS) {
4232 return psa_cipher_abort(operation);
4233 } else {
Steven Cooremanef8575e2020-09-11 11:44:50 +02004234 *output_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004235 (void) psa_cipher_abort(operation);
Janos Follath315b51c2018-07-09 16:04:51 +01004236
Gilles Peskine449bd832023-01-11 14:50:10 +01004237 return status;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004238 }
mohammad1603503973b2018-03-12 15:59:30 +02004239}
4240
Gilles Peskine449bd832023-01-11 14:50:10 +01004241psa_status_t psa_cipher_abort(psa_cipher_operation_t *operation)
Gilles Peskinee553c652018-06-04 16:22:46 +02004242{
Gilles Peskine449bd832023-01-11 14:50:10 +01004243 if (operation->id == 0) {
Steven Cooremana07b9972020-09-10 14:54:14 +02004244 /* The object has (apparently) been initialized but it is not (yet)
Gilles Peskine81736312018-06-26 15:04:31 +02004245 * in use. It's ok to call abort on such an object, and there's
4246 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004247 return PSA_SUCCESS;
Gilles Peskine81736312018-06-26 15:04:31 +02004248 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004249
Gilles Peskine449bd832023-01-11 14:50:10 +01004250 psa_driver_wrapper_cipher_abort(operation);
Gilles Peskinee553c652018-06-04 16:22:46 +02004251
Ronald Cron49fafa92021-03-10 08:34:23 +01004252 operation->id = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004253 operation->iv_set = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004254 operation->iv_required = 0;
Moran Peker41deec42018-04-04 15:43:05 +03004255
Gilles Peskine449bd832023-01-11 14:50:10 +01004256 return PSA_SUCCESS;
mohammad1603503973b2018-03-12 15:59:30 +02004257}
4258
Gilles Peskine449bd832023-01-11 14:50:10 +01004259psa_status_t psa_cipher_encrypt(mbedtls_svc_key_id_t key,
4260 psa_algorithm_t alg,
4261 const uint8_t *input,
4262 size_t input_length,
4263 uint8_t *output,
4264 size_t output_size,
4265 size_t *output_length)
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004266{
4267 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004268 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron23919522021-07-08 19:00:07 +02004269 psa_key_slot_t *slot = NULL;
Ronald Cronc6e6f502021-07-09 18:44:58 +02004270 uint8_t local_iv[PSA_CIPHER_IV_MAX_SIZE];
4271 size_t default_iv_length = 0;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004272 psa_key_attributes_t attributes;
gabor-mezei-arm6f4e5bb2021-06-25 15:21:11 +02004273
Gilles Peskine449bd832023-01-11 14:50:10 +01004274 if (!PSA_ALG_IS_CIPHER(alg)) {
Ronald Cron23919522021-07-08 19:00:07 +02004275 status = PSA_ERROR_INVALID_ARGUMENT;
4276 goto exit;
4277 }
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004278
Gilles Peskine449bd832023-01-11 14:50:10 +01004279 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
4280 PSA_KEY_USAGE_ENCRYPT,
4281 alg);
4282 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004283 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004284 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004285
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004286 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004287 .core = slot->attr
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004288 };
4289
Gilles Peskine449bd832023-01-11 14:50:10 +01004290 default_iv_length = PSA_CIPHER_IV_LENGTH(slot->attr.type, alg);
4291 if (default_iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Ronald Cronc6e6f502021-07-09 18:44:58 +02004292 status = PSA_ERROR_GENERIC_ERROR;
4293 goto exit;
4294 }
4295
Gilles Peskine449bd832023-01-11 14:50:10 +01004296 if (default_iv_length > 0) {
4297 if (output_size < default_iv_length) {
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004298 status = PSA_ERROR_BUFFER_TOO_SMALL;
4299 goto exit;
4300 }
4301
Gilles Peskine449bd832023-01-11 14:50:10 +01004302 status = psa_generate_random(local_iv, default_iv_length);
4303 if (status != PSA_SUCCESS) {
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004304 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004305 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004306 }
4307
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004308 status = psa_driver_wrapper_cipher_encrypt(
4309 &attributes, slot->key.data, slot->key.bytes,
Ronald Cronc6e6f502021-07-09 18:44:58 +02004310 alg, local_iv, default_iv_length, input, input_length,
Ronald Cronafbc7ed2023-01-24 16:02:04 +01004311 psa_crypto_buffer_offset(output, default_iv_length),
Gilles Peskine449bd832023-01-11 14:50:10 +01004312 output_size - default_iv_length, output_length);
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004313
4314exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00004315 unlock_status = psa_unregister_read(slot);
Gilles Peskine449bd832023-01-11 14:50:10 +01004316 if (status == PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004317 status = unlock_status;
Ronald Cronc6e6f502021-07-09 18:44:58 +02004318 }
Ronald Cron23919522021-07-08 19:00:07 +02004319
Gilles Peskine449bd832023-01-11 14:50:10 +01004320 if (status == PSA_SUCCESS) {
4321 if (default_iv_length > 0) {
4322 memcpy(output, local_iv, default_iv_length);
4323 }
4324 *output_length += default_iv_length;
4325 } else {
4326 *output_length = 0;
4327 }
4328
4329 return status;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004330}
4331
Gilles Peskine449bd832023-01-11 14:50:10 +01004332psa_status_t psa_cipher_decrypt(mbedtls_svc_key_id_t key,
4333 psa_algorithm_t alg,
4334 const uint8_t *input,
4335 size_t input_length,
4336 uint8_t *output,
4337 size_t output_size,
4338 size_t *output_length)
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004339{
4340 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004341 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron23919522021-07-08 19:00:07 +02004342 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004343 psa_key_attributes_t attributes;
gabor-mezei-arm6f4e5bb2021-06-25 15:21:11 +02004344
Gilles Peskine449bd832023-01-11 14:50:10 +01004345 if (!PSA_ALG_IS_CIPHER(alg)) {
Ronald Cron23919522021-07-08 19:00:07 +02004346 status = PSA_ERROR_INVALID_ARGUMENT;
4347 goto exit;
4348 }
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004349
Gilles Peskine449bd832023-01-11 14:50:10 +01004350 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
4351 PSA_KEY_USAGE_DECRYPT,
4352 alg);
4353 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004354 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004355 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004356
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004357 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004358 .core = slot->attr
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004359 };
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004360
Gilles Peskine449bd832023-01-11 14:50:10 +01004361 if (alg == PSA_ALG_CCM_STAR_NO_TAG &&
4362 input_length < PSA_BLOCK_CIPHER_BLOCK_LENGTH(slot->attr.type)) {
Mateusz Starzyk594215b2021-10-14 12:23:06 +02004363 status = PSA_ERROR_INVALID_ARGUMENT;
4364 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004365 } else if (input_length < PSA_CIPHER_IV_LENGTH(slot->attr.type, alg)) {
gabor-mezei-arm258ae072021-06-25 15:25:38 +02004366 status = PSA_ERROR_INVALID_ARGUMENT;
4367 goto exit;
4368 }
4369
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004370 status = psa_driver_wrapper_cipher_decrypt(
4371 &attributes, slot->key.data, slot->key.bytes,
4372 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004373 output, output_size, output_length);
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004374
gabor-mezei-arm258ae072021-06-25 15:25:38 +02004375exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00004376 unlock_status = psa_unregister_read(slot);
Gilles Peskine449bd832023-01-11 14:50:10 +01004377 if (status == PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004378 status = unlock_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01004379 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004380
Gilles Peskine449bd832023-01-11 14:50:10 +01004381 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004382 *output_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004383 }
Ronald Cron23919522021-07-08 19:00:07 +02004384
Gilles Peskine449bd832023-01-11 14:50:10 +01004385 return status;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004386}
4387
4388
mohammad16035955c982018-04-26 00:53:03 +03004389/****************************************************************/
4390/* AEAD */
4391/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004392
Paul Elliottbaff51c2021-09-28 17:44:45 +01004393/* Helper function to get the base algorithm from its variants. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004394static psa_algorithm_t psa_aead_get_base_algorithm(psa_algorithm_t alg)
Paul Elliottbaff51c2021-09-28 17:44:45 +01004395{
Gilles Peskine449bd832023-01-11 14:50:10 +01004396 return PSA_ALG_AEAD_WITH_DEFAULT_LENGTH_TAG(alg);
Paul Elliottbaff51c2021-09-28 17:44:45 +01004397}
4398
4399/* Helper function to perform common nonce length checks. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004400static psa_status_t psa_aead_check_nonce_length(psa_algorithm_t alg,
4401 size_t nonce_length)
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004402{
Gilles Peskine449bd832023-01-11 14:50:10 +01004403 psa_algorithm_t base_alg = psa_aead_get_base_algorithm(alg);
Paul Elliottbaff51c2021-09-28 17:44:45 +01004404
Gilles Peskine449bd832023-01-11 14:50:10 +01004405 switch (base_alg) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004406#if defined(PSA_WANT_ALG_GCM)
4407 case PSA_ALG_GCM:
4408 /* Not checking max nonce size here as GCM spec allows almost
Gilles Peskine449bd832023-01-11 14:50:10 +01004409 * arbitrarily large nonces. Please note that we do not generally
4410 * recommend the usage of nonces of greater length than
4411 * PSA_AEAD_NONCE_MAX_SIZE, as large nonces are hashed to a shorter
4412 * size, which can then lead to collisions if you encrypt a very
4413 * large number of messages.*/
4414 if (nonce_length != 0) {
4415 return PSA_SUCCESS;
4416 }
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004417 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004418#endif /* PSA_WANT_ALG_GCM */
4419#if defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004420 case PSA_ALG_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01004421 if (nonce_length >= 7 && nonce_length <= 13) {
4422 return PSA_SUCCESS;
4423 }
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004424 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004425#endif /* PSA_WANT_ALG_CCM */
4426#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004427 case PSA_ALG_CHACHA20_POLY1305:
Gilles Peskine449bd832023-01-11 14:50:10 +01004428 if (nonce_length == 12) {
4429 return PSA_SUCCESS;
4430 } else if (nonce_length == 8) {
4431 return PSA_ERROR_NOT_SUPPORTED;
4432 }
Bence Szépkúti6d48e202021-11-15 20:04:15 +01004433 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004434#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004435 default:
Przemek Stekiel4c499272022-09-27 13:55:37 +02004436 (void) nonce_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01004437 return PSA_ERROR_NOT_SUPPORTED;
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004438 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004439
Gilles Peskine449bd832023-01-11 14:50:10 +01004440 return PSA_ERROR_INVALID_ARGUMENT;
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004441}
4442
Gilles Peskine449bd832023-01-11 14:50:10 +01004443static psa_status_t psa_aead_check_algorithm(psa_algorithm_t alg)
Bence Szépkútiaa3a6e42022-01-13 16:26:03 +01004444{
Gilles Peskine449bd832023-01-11 14:50:10 +01004445 if (!PSA_ALG_IS_AEAD(alg) || PSA_ALG_IS_WILDCARD(alg)) {
4446 return PSA_ERROR_INVALID_ARGUMENT;
4447 }
Bence Szépkúti08f34652021-12-08 21:07:13 +01004448
Gilles Peskine449bd832023-01-11 14:50:10 +01004449 return PSA_SUCCESS;
Bence Szépkúti08f34652021-12-08 21:07:13 +01004450}
4451
Gilles Peskine449bd832023-01-11 14:50:10 +01004452psa_status_t psa_aead_encrypt(mbedtls_svc_key_id_t key,
4453 psa_algorithm_t alg,
4454 const uint8_t *nonce,
4455 size_t nonce_length,
4456 const uint8_t *additional_data,
4457 size_t additional_data_length,
4458 const uint8_t *plaintext,
4459 size_t plaintext_length,
4460 uint8_t *ciphertext,
4461 size_t ciphertext_size,
4462 size_t *ciphertext_length)
mohammad16035955c982018-04-26 00:53:03 +03004463{
Ronald Cron215633c2021-03-16 17:15:37 +01004464 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4465 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02004466
mohammad1603f08a5502018-06-03 15:05:47 +03004467 *ciphertext_length = 0;
mohammad1603e58e6842018-05-09 04:58:32 -07004468
Gilles Peskine449bd832023-01-11 14:50:10 +01004469 status = psa_aead_check_algorithm(alg);
4470 if (status != PSA_SUCCESS) {
4471 return status;
4472 }
Steven Cooremanea7ab132021-03-17 16:28:00 +01004473
Ronald Cron9a986162021-03-26 12:40:07 +01004474 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01004475 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg);
4476 if (status != PSA_SUCCESS) {
4477 return status;
4478 }
mohammad16035955c982018-04-26 00:53:03 +03004479
Ronald Cron215633c2021-03-16 17:15:37 +01004480 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01004481 .core = slot->attr
Ronald Cron215633c2021-03-16 17:15:37 +01004482 };
mohammad16035955c982018-04-26 00:53:03 +03004483
Gilles Peskine449bd832023-01-11 14:50:10 +01004484 status = psa_aead_check_nonce_length(alg, nonce_length);
4485 if (status != PSA_SUCCESS) {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004486 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004487 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004488
Ronald Cronde822812021-03-17 16:08:20 +01004489 status = psa_driver_wrapper_aead_encrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01004490 &attributes, slot->key.data, slot->key.bytes,
4491 alg,
4492 nonce, nonce_length,
4493 additional_data, additional_data_length,
4494 plaintext, plaintext_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004495 ciphertext, ciphertext_size, ciphertext_length);
Gilles Peskine2d277862018-06-18 15:41:12 +02004496
Gilles Peskine449bd832023-01-11 14:50:10 +01004497 if (status != PSA_SUCCESS && ciphertext_size != 0) {
4498 memset(ciphertext, 0, ciphertext_size);
4499 }
Gilles Peskine2d277862018-06-18 15:41:12 +02004500
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004501exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00004502 psa_unregister_read(slot);
mohammad16035955c982018-04-26 00:53:03 +03004503
Gilles Peskine449bd832023-01-11 14:50:10 +01004504 return status;
Gilles Peskineee652a32018-06-01 19:23:52 +02004505}
4506
Gilles Peskine449bd832023-01-11 14:50:10 +01004507psa_status_t psa_aead_decrypt(mbedtls_svc_key_id_t key,
4508 psa_algorithm_t alg,
4509 const uint8_t *nonce,
4510 size_t nonce_length,
4511 const uint8_t *additional_data,
4512 size_t additional_data_length,
4513 const uint8_t *ciphertext,
4514 size_t ciphertext_length,
4515 uint8_t *plaintext,
4516 size_t plaintext_size,
4517 size_t *plaintext_length)
mohammad16035955c982018-04-26 00:53:03 +03004518{
Ronald Cron215633c2021-03-16 17:15:37 +01004519 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4520 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02004521
Gilles Peskineee652a32018-06-01 19:23:52 +02004522 *plaintext_length = 0;
mohammad16039e5a5152018-04-26 12:07:35 +03004523
Gilles Peskine449bd832023-01-11 14:50:10 +01004524 status = psa_aead_check_algorithm(alg);
4525 if (status != PSA_SUCCESS) {
4526 return status;
4527 }
Steven Cooremanea7ab132021-03-17 16:28:00 +01004528
Ronald Cron9a986162021-03-26 12:40:07 +01004529 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01004530 key, &slot, PSA_KEY_USAGE_DECRYPT, alg);
4531 if (status != PSA_SUCCESS) {
4532 return status;
4533 }
mohammad16035955c982018-04-26 00:53:03 +03004534
Ronald Cron215633c2021-03-16 17:15:37 +01004535 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01004536 .core = slot->attr
Ronald Cron215633c2021-03-16 17:15:37 +01004537 };
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004538
Gilles Peskine449bd832023-01-11 14:50:10 +01004539 status = psa_aead_check_nonce_length(alg, nonce_length);
4540 if (status != PSA_SUCCESS) {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004541 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004542 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004543
Ronald Cronde822812021-03-17 16:08:20 +01004544 status = psa_driver_wrapper_aead_decrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01004545 &attributes, slot->key.data, slot->key.bytes,
4546 alg,
4547 nonce, nonce_length,
4548 additional_data, additional_data_length,
4549 ciphertext, ciphertext_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004550 plaintext, plaintext_size, plaintext_length);
Gilles Peskinea40d7742018-06-01 16:28:30 +02004551
Gilles Peskine449bd832023-01-11 14:50:10 +01004552 if (status != PSA_SUCCESS && plaintext_size != 0) {
4553 memset(plaintext, 0, plaintext_size);
4554 }
mohammad160360a64d02018-06-03 17:20:42 +03004555
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004556exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00004557 psa_unregister_read(slot);
Ronald Cron215633c2021-03-16 17:15:37 +01004558
Gilles Peskine449bd832023-01-11 14:50:10 +01004559 return status;
mohammad16035955c982018-04-26 00:53:03 +03004560}
4561
Gilles Peskine449bd832023-01-11 14:50:10 +01004562static psa_status_t psa_validate_tag_length(psa_algorithm_t alg)
4563{
4564 const uint8_t tag_len = PSA_ALG_AEAD_GET_TAG_LENGTH(alg);
Andrzej Kurekf8816012021-12-19 17:00:12 +01004565
Gilles Peskine449bd832023-01-11 14:50:10 +01004566 switch (PSA_ALG_AEAD_WITH_SHORTENED_TAG(alg, 0)) {
Przemek Stekiel86679c72022-10-06 17:06:56 +02004567#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004568 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004569 /* CCM allows the following tag lengths: 4, 6, 8, 10, 12, 14, 16.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004570 if (tag_len < 4 || tag_len > 16 || tag_len % 2) {
4571 return PSA_ERROR_INVALID_ARGUMENT;
4572 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01004573 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02004574#endif /* PSA_WANT_ALG_CCM */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004575
Przemek Stekiel86679c72022-10-06 17:06:56 +02004576#if defined(PSA_WANT_ALG_GCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004577 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_GCM, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004578 /* GCM allows the following tag lengths: 4, 8, 12, 13, 14, 15, 16. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004579 if (tag_len != 4 && tag_len != 8 && (tag_len < 12 || tag_len > 16)) {
4580 return PSA_ERROR_INVALID_ARGUMENT;
4581 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01004582 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02004583#endif /* PSA_WANT_ALG_GCM */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004584
Przemek Stekiel86679c72022-10-06 17:06:56 +02004585#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Gilles Peskine449bd832023-01-11 14:50:10 +01004586 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CHACHA20_POLY1305, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004587 /* We only support the default tag length. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004588 if (tag_len != 16) {
4589 return PSA_ERROR_INVALID_ARGUMENT;
4590 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01004591 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02004592#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004593
4594 default:
4595 (void) tag_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004596 return PSA_ERROR_NOT_SUPPORTED;
Andrzej Kurekf8816012021-12-19 17:00:12 +01004597 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004598 return PSA_SUCCESS;
Andrzej Kurekf8816012021-12-19 17:00:12 +01004599}
4600
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004601/* Set the key for a multipart authenticated operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004602static psa_status_t psa_aead_setup(psa_aead_operation_t *operation,
4603 int is_encrypt,
4604 mbedtls_svc_key_id_t key,
4605 psa_algorithm_t alg)
Paul Elliottc2b71442021-06-24 18:17:52 +01004606{
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004607 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4608 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
4609 psa_key_slot_t *slot = NULL;
4610 psa_key_usage_t key_usage = 0;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004611 psa_key_attributes_t attributes;
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004612
Gilles Peskine449bd832023-01-11 14:50:10 +01004613 status = psa_aead_check_algorithm(alg);
4614 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004615 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004616 }
Paul Elliottc2b71442021-06-24 18:17:52 +01004617
Gilles Peskine449bd832023-01-11 14:50:10 +01004618 if (operation->id != 0) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004619 status = PSA_ERROR_BAD_STATE;
4620 goto exit;
Paul Elliottc2b71442021-06-24 18:17:52 +01004621 }
4622
Gilles Peskine449bd832023-01-11 14:50:10 +01004623 if (operation->nonce_set || operation->lengths_set ||
4624 operation->ad_started || operation->body_started) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004625 status = PSA_ERROR_BAD_STATE;
4626 goto exit;
Paul Elliottc2b71442021-06-24 18:17:52 +01004627 }
4628
Gilles Peskine449bd832023-01-11 14:50:10 +01004629 if (is_encrypt) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004630 key_usage = PSA_KEY_USAGE_ENCRYPT;
Gilles Peskine449bd832023-01-11 14:50:10 +01004631 } else {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004632 key_usage = PSA_KEY_USAGE_DECRYPT;
Gilles Peskine449bd832023-01-11 14:50:10 +01004633 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004634
Gilles Peskine449bd832023-01-11 14:50:10 +01004635 status = psa_get_and_lock_key_slot_with_policy(key, &slot, key_usage,
4636 alg);
4637 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004638 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004639 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004640
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004641 attributes = (psa_key_attributes_t) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004642 .core = slot->attr
4643 };
4644
Gilles Peskine449bd832023-01-11 14:50:10 +01004645 if ((status = psa_validate_tag_length(alg)) != PSA_SUCCESS) {
Przemek Stekiel6ab50762022-10-08 17:54:30 +02004646 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004647 }
Przemek Stekiel6ab50762022-10-08 17:54:30 +02004648
Gilles Peskine449bd832023-01-11 14:50:10 +01004649 if (is_encrypt) {
4650 status = psa_driver_wrapper_aead_encrypt_setup(operation,
4651 &attributes,
4652 slot->key.data,
4653 slot->key.bytes,
4654 alg);
4655 } else {
4656 status = psa_driver_wrapper_aead_decrypt_setup(operation,
4657 &attributes,
4658 slot->key.data,
4659 slot->key.bytes,
4660 alg);
4661 }
4662 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004663 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004664 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004665
Gilles Peskine449bd832023-01-11 14:50:10 +01004666 operation->key_type = psa_get_key_type(&attributes);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004667
4668exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00004669 unlock_status = psa_unregister_read(slot);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004670
Gilles Peskine449bd832023-01-11 14:50:10 +01004671 if (status == PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004672 status = unlock_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01004673 operation->alg = psa_aead_get_base_algorithm(alg);
Paul Elliottd9343f22021-08-23 18:59:49 +01004674 operation->is_encrypt = is_encrypt;
Gilles Peskine449bd832023-01-11 14:50:10 +01004675 } else {
4676 psa_aead_abort(operation);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004677 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004678
Gilles Peskine449bd832023-01-11 14:50:10 +01004679 return status;
Paul Elliottc2b71442021-06-24 18:17:52 +01004680}
4681
Paul Elliott302ff6b2021-04-20 18:10:30 +01004682/* Set the key for a multipart authenticated encryption operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004683psa_status_t psa_aead_encrypt_setup(psa_aead_operation_t *operation,
4684 mbedtls_svc_key_id_t key,
4685 psa_algorithm_t alg)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004686{
Gilles Peskine449bd832023-01-11 14:50:10 +01004687 return psa_aead_setup(operation, 1, key, alg);
Paul Elliott302ff6b2021-04-20 18:10:30 +01004688}
4689
4690/* Set the key for a multipart authenticated decryption operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004691psa_status_t psa_aead_decrypt_setup(psa_aead_operation_t *operation,
4692 mbedtls_svc_key_id_t key,
4693 psa_algorithm_t alg)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004694{
Gilles Peskine449bd832023-01-11 14:50:10 +01004695 return psa_aead_setup(operation, 0, key, alg);
Paul Elliott302ff6b2021-04-20 18:10:30 +01004696}
4697
4698/* Generate a random nonce / IV for multipart AEAD operation */
Gilles Peskine449bd832023-01-11 14:50:10 +01004699psa_status_t psa_aead_generate_nonce(psa_aead_operation_t *operation,
4700 uint8_t *nonce,
4701 size_t nonce_size,
4702 size_t *nonce_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004703{
4704 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Croncae59092021-11-26 18:53:58 +01004705 uint8_t local_nonce[PSA_AEAD_NONCE_MAX_SIZE];
Sergeybef1f632023-03-06 15:25:06 -07004706 size_t required_nonce_size = 0;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004707
Paul Elliott8eb9daf2021-06-04 16:42:21 +01004708 *nonce_length = 0;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004709
Gilles Peskine449bd832023-01-11 14:50:10 +01004710 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004711 status = PSA_ERROR_BAD_STATE;
4712 goto exit;
4713 }
4714
Gilles Peskine449bd832023-01-11 14:50:10 +01004715 if (operation->nonce_set || !operation->is_encrypt) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004716 status = PSA_ERROR_BAD_STATE;
4717 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004718 }
4719
Paul Elliotte193ea82021-10-01 13:00:16 +01004720 /* For CCM, this size may not be correct according to the PSA
4721 * specification. The PSA Crypto 1.0.1 specification states:
4722 *
4723 * CCM encodes the plaintext length pLen in L octets, with L the smallest
4724 * integer >= 2 where pLen < 2^(8L). The nonce length is then 15 - L bytes.
4725 *
4726 * However this restriction that L has to be the smallest integer is not
4727 * applied in practice, and it is not implementable here since the
4728 * plaintext length may or may not be known at this time. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004729 required_nonce_size = PSA_AEAD_NONCE_LENGTH(operation->key_type,
4730 operation->alg);
4731 if (nonce_size < required_nonce_size) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004732 status = PSA_ERROR_BUFFER_TOO_SMALL;
4733 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004734 }
4735
Gilles Peskine449bd832023-01-11 14:50:10 +01004736 status = psa_generate_random(local_nonce, required_nonce_size);
4737 if (status != PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004738 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004739 }
Paul Elliott302ff6b2021-04-20 18:10:30 +01004740
Gilles Peskine449bd832023-01-11 14:50:10 +01004741 status = psa_aead_set_nonce(operation, local_nonce, required_nonce_size);
Paul Elliott302ff6b2021-04-20 18:10:30 +01004742
Paul Elliott39dc6b82021-05-11 19:16:09 +01004743exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004744 if (status == PSA_SUCCESS) {
4745 memcpy(nonce, local_nonce, required_nonce_size);
Paul Elliott39dc6b82021-05-11 19:16:09 +01004746 *nonce_length = required_nonce_size;
Gilles Peskine449bd832023-01-11 14:50:10 +01004747 } else {
4748 psa_aead_abort(operation);
Ronald Croncae59092021-11-26 18:53:58 +01004749 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01004750
Gilles Peskine449bd832023-01-11 14:50:10 +01004751 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004752}
4753
4754/* Set the nonce for a multipart authenticated encryption or decryption
4755 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004756psa_status_t psa_aead_set_nonce(psa_aead_operation_t *operation,
4757 const uint8_t *nonce,
4758 size_t nonce_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004759{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004760 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4761
Gilles Peskine449bd832023-01-11 14:50:10 +01004762 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004763 status = PSA_ERROR_BAD_STATE;
4764 goto exit;
4765 }
4766
Gilles Peskine449bd832023-01-11 14:50:10 +01004767 if (operation->nonce_set) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004768 status = PSA_ERROR_BAD_STATE;
4769 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004770 }
4771
Gilles Peskine449bd832023-01-11 14:50:10 +01004772 status = psa_aead_check_nonce_length(operation->alg, nonce_length);
4773 if (status != PSA_SUCCESS) {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004774 status = PSA_ERROR_INVALID_ARGUMENT;
4775 goto exit;
Paul Elliott4ed1ed12021-09-27 18:09:28 +01004776 }
Paul Elliott1a98aca2021-05-20 18:24:07 +01004777
Gilles Peskine449bd832023-01-11 14:50:10 +01004778 status = psa_driver_wrapper_aead_set_nonce(operation, nonce,
4779 nonce_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004780
Paul Elliott39dc6b82021-05-11 19:16:09 +01004781exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004782 if (status == PSA_SUCCESS) {
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004783 operation->nonce_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004784 } else {
4785 psa_aead_abort(operation);
4786 }
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004787
Gilles Peskine449bd832023-01-11 14:50:10 +01004788 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004789}
4790
4791/* Declare the lengths of the message and additional data for multipart AEAD. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004792psa_status_t psa_aead_set_lengths(psa_aead_operation_t *operation,
4793 size_t ad_length,
4794 size_t plaintext_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004795{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004796 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4797
Gilles Peskine449bd832023-01-11 14:50:10 +01004798 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004799 status = PSA_ERROR_BAD_STATE;
4800 goto exit;
4801 }
4802
Gilles Peskine449bd832023-01-11 14:50:10 +01004803 if (operation->lengths_set || operation->ad_started ||
4804 operation->body_started) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004805 status = PSA_ERROR_BAD_STATE;
4806 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004807 }
4808
Gilles Peskine449bd832023-01-11 14:50:10 +01004809 switch (operation->alg) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004810#if defined(PSA_WANT_ALG_GCM)
4811 case PSA_ALG_GCM:
4812 /* Lengths can only be too large for GCM if size_t is bigger than 32
Gilles Peskine449bd832023-01-11 14:50:10 +01004813 * bits. Without the guard this code will generate warnings on 32bit
4814 * builds. */
Paul Elliott325d3742021-09-27 17:56:28 +01004815#if SIZE_MAX > UINT32_MAX
Gilles Peskine449bd832023-01-11 14:50:10 +01004816 if (((uint64_t) ad_length) >> 61 != 0 ||
4817 ((uint64_t) plaintext_length) > 0xFFFFFFFE0ull) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004818 status = PSA_ERROR_INVALID_ARGUMENT;
4819 goto exit;
4820 }
Paul Elliott325d3742021-09-27 17:56:28 +01004821#endif
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004822 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004823#endif /* PSA_WANT_ALG_GCM */
4824#if defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004825 case PSA_ALG_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01004826 if (ad_length > 0xFF00) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004827 status = PSA_ERROR_INVALID_ARGUMENT;
4828 goto exit;
4829 }
4830 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004831#endif /* PSA_WANT_ALG_CCM */
4832#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004833 case PSA_ALG_CHACHA20_POLY1305:
4834 /* No length restrictions for ChaChaPoly. */
4835 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004836#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004837 default:
4838 break;
4839 }
Paul Elliott325d3742021-09-27 17:56:28 +01004840
Gilles Peskine449bd832023-01-11 14:50:10 +01004841 status = psa_driver_wrapper_aead_set_lengths(operation, ad_length,
4842 plaintext_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004843
Paul Elliott39dc6b82021-05-11 19:16:09 +01004844exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004845 if (status == PSA_SUCCESS) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01004846 operation->ad_remaining = ad_length;
4847 operation->body_remaining = plaintext_length;
Paul Elliott39dc6b82021-05-11 19:16:09 +01004848 operation->lengths_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004849 } else {
4850 psa_aead_abort(operation);
Paul Elliottee4ffe02021-05-20 17:25:06 +01004851 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01004852
Gilles Peskine449bd832023-01-11 14:50:10 +01004853 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004854}
Paul Elliott3d7d52c2021-09-01 10:33:14 +01004855
4856/* Pass additional data to an active multipart AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004857psa_status_t psa_aead_update_ad(psa_aead_operation_t *operation,
4858 const uint8_t *input,
4859 size_t input_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004860{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004861 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4862
Gilles Peskine449bd832023-01-11 14:50:10 +01004863 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004864 status = PSA_ERROR_BAD_STATE;
4865 goto exit;
4866 }
4867
Gilles Peskine449bd832023-01-11 14:50:10 +01004868 if (!operation->nonce_set || operation->body_started) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004869 status = PSA_ERROR_BAD_STATE;
4870 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004871 }
4872
Gilles Peskine449bd832023-01-11 14:50:10 +01004873 if (operation->lengths_set) {
4874 if (operation->ad_remaining < input_length) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01004875 status = PSA_ERROR_INVALID_ARGUMENT;
4876 goto exit;
4877 }
4878
4879 operation->ad_remaining -= input_length;
4880 }
Paul Elliotte193ea82021-10-01 13:00:16 +01004881#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004882 else if (operation->alg == PSA_ALG_CCM) {
Paul Elliotte193ea82021-10-01 13:00:16 +01004883 status = PSA_ERROR_BAD_STATE;
4884 goto exit;
4885 }
4886#endif /* PSA_WANT_ALG_CCM */
Paul Elliottee4ffe02021-05-20 17:25:06 +01004887
Gilles Peskine449bd832023-01-11 14:50:10 +01004888 status = psa_driver_wrapper_aead_update_ad(operation, input,
4889 input_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004890
Paul Elliott39dc6b82021-05-11 19:16:09 +01004891exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004892 if (status == PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004893 operation->ad_started = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004894 } else {
4895 psa_aead_abort(operation);
4896 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01004897
Gilles Peskine449bd832023-01-11 14:50:10 +01004898 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004899}
4900
4901/* Encrypt or decrypt a message fragment in an active multipart AEAD
4902 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004903psa_status_t psa_aead_update(psa_aead_operation_t *operation,
4904 const uint8_t *input,
4905 size_t input_length,
4906 uint8_t *output,
4907 size_t output_size,
4908 size_t *output_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004909{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004910 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004911
4912 *output_length = 0;
4913
Gilles Peskine449bd832023-01-11 14:50:10 +01004914 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004915 status = PSA_ERROR_BAD_STATE;
4916 goto exit;
4917 }
4918
Gilles Peskine449bd832023-01-11 14:50:10 +01004919 if (!operation->nonce_set) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004920 status = PSA_ERROR_BAD_STATE;
4921 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004922 }
4923
Gilles Peskine449bd832023-01-11 14:50:10 +01004924 if (operation->lengths_set) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01004925 /* Additional data length was supplied, but not all the additional
4926 data was supplied.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004927 if (operation->ad_remaining != 0) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01004928 status = PSA_ERROR_INVALID_ARGUMENT;
4929 goto exit;
4930 }
4931
4932 /* Too much data provided. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004933 if (operation->body_remaining < input_length) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01004934 status = PSA_ERROR_INVALID_ARGUMENT;
4935 goto exit;
4936 }
4937
4938 operation->body_remaining -= input_length;
4939 }
Paul Elliotte193ea82021-10-01 13:00:16 +01004940#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004941 else if (operation->alg == PSA_ALG_CCM) {
Paul Elliotte193ea82021-10-01 13:00:16 +01004942 status = PSA_ERROR_BAD_STATE;
4943 goto exit;
4944 }
4945#endif /* PSA_WANT_ALG_CCM */
Paul Elliottee4ffe02021-05-20 17:25:06 +01004946
Gilles Peskine449bd832023-01-11 14:50:10 +01004947 status = psa_driver_wrapper_aead_update(operation, input, input_length,
4948 output, output_size,
4949 output_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004950
Paul Elliott39dc6b82021-05-11 19:16:09 +01004951exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004952 if (status == PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004953 operation->body_started = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004954 } else {
4955 psa_aead_abort(operation);
4956 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01004957
Gilles Peskine449bd832023-01-11 14:50:10 +01004958 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004959}
4960
Gilles Peskine449bd832023-01-11 14:50:10 +01004961static psa_status_t psa_aead_final_checks(const psa_aead_operation_t *operation)
Paul Elliottad53dcc2021-06-23 08:50:14 +01004962{
Gilles Peskine449bd832023-01-11 14:50:10 +01004963 if (operation->id == 0 || !operation->nonce_set) {
4964 return PSA_ERROR_BAD_STATE;
4965 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01004966
Gilles Peskine449bd832023-01-11 14:50:10 +01004967 if (operation->lengths_set && (operation->ad_remaining != 0 ||
4968 operation->body_remaining != 0)) {
4969 return PSA_ERROR_INVALID_ARGUMENT;
4970 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01004971
Gilles Peskine449bd832023-01-11 14:50:10 +01004972 return PSA_SUCCESS;
Paul Elliottad53dcc2021-06-23 08:50:14 +01004973}
4974
Paul Elliott302ff6b2021-04-20 18:10:30 +01004975/* Finish encrypting a message in a multipart AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004976psa_status_t psa_aead_finish(psa_aead_operation_t *operation,
4977 uint8_t *ciphertext,
4978 size_t ciphertext_size,
4979 size_t *ciphertext_length,
4980 uint8_t *tag,
4981 size_t tag_size,
4982 size_t *tag_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004983{
Paul Elliott39dc6b82021-05-11 19:16:09 +01004984 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4985
Paul Elliott302ff6b2021-04-20 18:10:30 +01004986 *ciphertext_length = 0;
Paul Elliottf88a5652021-06-22 17:53:45 +01004987 *tag_length = tag_size;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004988
Gilles Peskine449bd832023-01-11 14:50:10 +01004989 status = psa_aead_final_checks(operation);
4990 if (status != PSA_SUCCESS) {
Paul Elliottad53dcc2021-06-23 08:50:14 +01004991 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004992 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01004993
Gilles Peskine449bd832023-01-11 14:50:10 +01004994 if (!operation->is_encrypt) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004995 status = PSA_ERROR_BAD_STATE;
4996 goto exit;
4997 }
4998
Gilles Peskine449bd832023-01-11 14:50:10 +01004999 status = psa_driver_wrapper_aead_finish(operation, ciphertext,
5000 ciphertext_size,
5001 ciphertext_length,
5002 tag, tag_size, tag_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005003
Paul Elliott39dc6b82021-05-11 19:16:09 +01005004exit:
Paul Elliottdc42ca82023-02-24 18:11:59 +00005005
5006
Paul Elliottf47b0952021-05-21 18:02:33 +01005007 /* In case the operation fails and the user fails to check for failure or
Paul Elliott4c916e82021-09-19 18:34:50 +01005008 * the zero tag size, make sure the tag is set to something implausible.
5009 * Even if the operation succeeds, make sure we clear the rest of the
5010 * buffer to prevent potential leakage of anything previously placed in
5011 * the same buffer.*/
Paul Elliottdc42ca82023-02-24 18:11:59 +00005012 psa_wipe_tag_output_buffer(tag, status, tag_size, *tag_length);
Paul Elliottf47b0952021-05-21 18:02:33 +01005013
Gilles Peskine449bd832023-01-11 14:50:10 +01005014 psa_aead_abort(operation);
Paul Elliott39dc6b82021-05-11 19:16:09 +01005015
Gilles Peskine449bd832023-01-11 14:50:10 +01005016 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005017}
5018
5019/* Finish authenticating and decrypting a message in a multipart AEAD
5020 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01005021psa_status_t psa_aead_verify(psa_aead_operation_t *operation,
5022 uint8_t *plaintext,
5023 size_t plaintext_size,
5024 size_t *plaintext_length,
5025 const uint8_t *tag,
5026 size_t tag_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005027{
Paul Elliott39dc6b82021-05-11 19:16:09 +01005028 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5029
Paul Elliott302ff6b2021-04-20 18:10:30 +01005030 *plaintext_length = 0;
5031
Gilles Peskine449bd832023-01-11 14:50:10 +01005032 status = psa_aead_final_checks(operation);
5033 if (status != PSA_SUCCESS) {
Paul Elliottad53dcc2021-06-23 08:50:14 +01005034 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005035 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01005036
Gilles Peskine449bd832023-01-11 14:50:10 +01005037 if (operation->is_encrypt) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005038 status = PSA_ERROR_BAD_STATE;
5039 goto exit;
5040 }
5041
Gilles Peskine449bd832023-01-11 14:50:10 +01005042 status = psa_driver_wrapper_aead_verify(operation, plaintext,
5043 plaintext_size,
5044 plaintext_length,
5045 tag, tag_length);
Paul Elliott39dc6b82021-05-11 19:16:09 +01005046
5047exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005048 psa_aead_abort(operation);
Paul Elliott39dc6b82021-05-11 19:16:09 +01005049
Gilles Peskine449bd832023-01-11 14:50:10 +01005050 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005051}
5052
5053/* Abort an AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005054psa_status_t psa_aead_abort(psa_aead_operation_t *operation)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005055{
5056 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5057
Gilles Peskine449bd832023-01-11 14:50:10 +01005058 if (operation->id == 0) {
Paul Elliott302ff6b2021-04-20 18:10:30 +01005059 /* The object has (apparently) been initialized but it is not (yet)
5060 * in use. It's ok to call abort on such an object, and there's
5061 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005062 return PSA_SUCCESS;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005063 }
5064
Gilles Peskine449bd832023-01-11 14:50:10 +01005065 status = psa_driver_wrapper_aead_abort(operation);
Paul Elliott302ff6b2021-04-20 18:10:30 +01005066
Gilles Peskine449bd832023-01-11 14:50:10 +01005067 memset(operation, 0, sizeof(*operation));
Paul Elliott302ff6b2021-04-20 18:10:30 +01005068
Gilles Peskine449bd832023-01-11 14:50:10 +01005069 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005070}
5071
Gilles Peskinee59236f2018-01-27 23:32:46 +01005072/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02005073/* Generators */
5074/****************************************************************/
5075
Przemek Stekiel69c46792022-06-10 12:59:51 +02005076#if defined(BUILTIN_ALG_ANY_HKDF) || \
John Durkop07cc04a2020-11-16 22:08:34 -08005077 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005078 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) || \
Kusumit Ghoderaoaf0b5342023-05-03 11:58:46 +05305079 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS) || \
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305080 defined(PSA_HAVE_SOFT_PBKDF2)
John Durkop07cc04a2020-11-16 22:08:34 -08005081#define AT_LEAST_ONE_BUILTIN_KDF
Steven Cooreman094a77e2021-05-06 17:58:36 +02005082#endif /* At least one builtin KDF */
5083
Przemek Stekiel69c46792022-06-10 12:59:51 +02005084#if defined(BUILTIN_ALG_ANY_HKDF) || \
Steven Cooreman094a77e2021-05-06 17:58:36 +02005085 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5086 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
5087static psa_status_t psa_key_derivation_start_hmac(
5088 psa_mac_operation_t *operation,
5089 psa_algorithm_t hash_alg,
5090 const uint8_t *hmac_key,
Gilles Peskine449bd832023-01-11 14:50:10 +01005091 size_t hmac_key_length)
Steven Cooreman094a77e2021-05-06 17:58:36 +02005092{
5093 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5094 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01005095 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
5096 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(hmac_key_length));
5097 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_HASH);
Steven Cooreman094a77e2021-05-06 17:58:36 +02005098
Steven Cooreman72f736a2021-05-07 14:14:37 +02005099 operation->is_sign = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005100 operation->mac_size = PSA_HASH_LENGTH(hash_alg);
Steven Cooreman72f736a2021-05-07 14:14:37 +02005101
Gilles Peskine449bd832023-01-11 14:50:10 +01005102 status = psa_driver_wrapper_mac_sign_setup(operation,
5103 &attributes,
5104 hmac_key, hmac_key_length,
5105 PSA_ALG_HMAC(hash_alg));
Steven Cooreman094a77e2021-05-06 17:58:36 +02005106
Gilles Peskine449bd832023-01-11 14:50:10 +01005107 psa_reset_key_attributes(&attributes);
5108 return status;
Steven Cooreman094a77e2021-05-06 17:58:36 +02005109}
5110#endif /* KDF algorithms reliant on HMAC */
John Durkop07cc04a2020-11-16 22:08:34 -08005111
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005112#define HKDF_STATE_INIT 0 /* no input yet */
5113#define HKDF_STATE_STARTED 1 /* got salt */
5114#define HKDF_STATE_KEYED 2 /* got key */
5115#define HKDF_STATE_OUTPUT 3 /* output started */
5116
Gilles Peskinecbe66502019-05-16 16:59:18 +02005117static psa_algorithm_t psa_key_derivation_get_kdf_alg(
Gilles Peskine449bd832023-01-11 14:50:10 +01005118 const psa_key_derivation_operation_t *operation)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005119{
Gilles Peskine449bd832023-01-11 14:50:10 +01005120 if (PSA_ALG_IS_KEY_AGREEMENT(operation->alg)) {
5121 return PSA_ALG_KEY_AGREEMENT_GET_KDF(operation->alg);
5122 } else {
5123 return operation->alg;
5124 }
Gilles Peskine969c5d62019-01-16 15:53:06 +01005125}
5126
Gilles Peskine449bd832023-01-11 14:50:10 +01005127psa_status_t psa_key_derivation_abort(psa_key_derivation_operation_t *operation)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005128{
5129 psa_status_t status = PSA_SUCCESS;
Gilles Peskine449bd832023-01-11 14:50:10 +01005130 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
5131 if (kdf_alg == 0) {
Gilles Peskineeab56e42018-07-12 17:12:33 +02005132 /* The object has (apparently) been initialized but it is not
5133 * in use. It's ok to call abort on such an object, and there's
5134 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005135 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02005136#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01005137 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
5138 mbedtls_free(operation->ctx.hkdf.info);
5139 status = psa_mac_abort(&operation->ctx.hkdf.hmac);
5140 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02005141#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08005142#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5143 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005144 if (PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
5145 /* TLS-1.2 PSK-to-MS KDF uses the same core as TLS-1.2 PRF */
5146 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
5147 if (operation->ctx.tls12_prf.secret != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005148 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.secret,
Gilles Peskine449bd832023-01-11 14:50:10 +01005149 operation->ctx.tls12_prf.secret_length);
Steven Cooremana6df6042021-04-29 19:32:25 +02005150 }
5151
Gilles Peskine449bd832023-01-11 14:50:10 +01005152 if (operation->ctx.tls12_prf.seed != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005153 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.seed,
Gilles Peskine449bd832023-01-11 14:50:10 +01005154 operation->ctx.tls12_prf.seed_length);
Janos Follath6a1d2622019-06-11 10:37:28 +01005155 }
5156
Gilles Peskine449bd832023-01-11 14:50:10 +01005157 if (operation->ctx.tls12_prf.label != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005158 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.label,
Gilles Peskine449bd832023-01-11 14:50:10 +01005159 operation->ctx.tls12_prf.label_length);
Janos Follath6a1d2622019-06-11 10:37:28 +01005160 }
Przemek Stekiel6c764412022-11-22 14:05:12 +01005161#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005162 if (operation->ctx.tls12_prf.other_secret != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005163 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.other_secret,
Gilles Peskine449bd832023-01-11 14:50:10 +01005164 operation->ctx.tls12_prf.other_secret_length);
Przemek Stekiele3ee2212022-04-07 14:29:56 +02005165 }
Przemek Stekiel6c764412022-11-22 14:05:12 +01005166#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Steven Cooremana6df6042021-04-29 19:32:25 +02005167 status = PSA_SUCCESS;
Janos Follath6a1d2622019-06-11 10:37:28 +01005168
5169 /* We leave the fields Ai and output_block to be erased safely by the
5170 * mbedtls_platform_zeroize() in the end of this function. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005171 } else
John Durkop07cc04a2020-11-16 22:08:34 -08005172#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
5173 * defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005174#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005175 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
5176 mbedtls_platform_zeroize(operation->ctx.tls12_ecjpake_to_pms.data,
5177 sizeof(operation->ctx.tls12_ecjpake_to_pms.data));
5178 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005179#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS) */
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305180#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05305181 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305182 if (operation->ctx.pbkdf2.salt != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005183 mbedtls_zeroize_and_free(operation->ctx.pbkdf2.salt,
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305184 operation->ctx.pbkdf2.salt_length);
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305185 }
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305186
5187 status = PSA_SUCCESS;
5188 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305189#endif /* defined(PSA_HAVE_SOFT_PBKDF2) */
Gilles Peskineeab56e42018-07-12 17:12:33 +02005190 {
5191 status = PSA_ERROR_BAD_STATE;
5192 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005193 mbedtls_platform_zeroize(operation, sizeof(*operation));
5194 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005195}
5196
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005197psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskine449bd832023-01-11 14:50:10 +01005198 size_t *capacity)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005199{
Gilles Peskine449bd832023-01-11 14:50:10 +01005200 if (operation->alg == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005201 /* This is a blank key derivation operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005202 return PSA_ERROR_BAD_STATE;
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005203 }
5204
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005205 *capacity = operation->capacity;
Gilles Peskine449bd832023-01-11 14:50:10 +01005206 return PSA_SUCCESS;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005207}
5208
Gilles Peskine449bd832023-01-11 14:50:10 +01005209psa_status_t psa_key_derivation_set_capacity(psa_key_derivation_operation_t *operation,
5210 size_t capacity)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005211{
Gilles Peskine449bd832023-01-11 14:50:10 +01005212 if (operation->alg == 0) {
5213 return PSA_ERROR_BAD_STATE;
5214 }
5215 if (capacity > operation->capacity) {
5216 return PSA_ERROR_INVALID_ARGUMENT;
5217 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005218 operation->capacity = capacity;
Gilles Peskine449bd832023-01-11 14:50:10 +01005219 return PSA_SUCCESS;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005220}
5221
Przemek Stekiel69c46792022-06-10 12:59:51 +02005222#if defined(BUILTIN_ALG_ANY_HKDF)
Przemek Stekiel03d948c2022-05-19 11:45:20 +02005223/* Read some bytes from an HKDF-based operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005224static psa_status_t psa_key_derivation_hkdf_read(psa_hkdf_key_derivation_t *hkdf,
5225 psa_algorithm_t kdf_alg,
5226 uint8_t *output,
5227 size_t output_length)
Gilles Peskinebef7f142018-07-12 17:22:21 +02005228{
Gilles Peskine449bd832023-01-11 14:50:10 +01005229 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
5230 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Steven Cooremand1ed1d92021-04-29 19:11:25 +02005231 size_t hmac_output_length;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005232 psa_status_t status;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005233#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01005234 const uint8_t last_block = PSA_ALG_IS_HKDF_EXTRACT(kdf_alg) ? 0 : 0xff;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005235#else
5236 const uint8_t last_block = 0xff;
5237#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskinebef7f142018-07-12 17:22:21 +02005238
Gilles Peskine449bd832023-01-11 14:50:10 +01005239 if (hkdf->state < HKDF_STATE_KEYED ||
5240 (!hkdf->info_set
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005241#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01005242 && !PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005243#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01005244 )) {
5245 return PSA_ERROR_BAD_STATE;
5246 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005247 hkdf->state = HKDF_STATE_OUTPUT;
5248
Gilles Peskine449bd832023-01-11 14:50:10 +01005249 while (output_length != 0) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005250 /* Copy what remains of the current block */
5251 uint8_t n = hash_length - hkdf->offset_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005252 if (n > output_length) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005253 n = (uint8_t) output_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01005254 }
5255 memcpy(output, hkdf->output_block + hkdf->offset_in_block, n);
Gilles Peskinebef7f142018-07-12 17:22:21 +02005256 output += n;
5257 output_length -= n;
5258 hkdf->offset_in_block += n;
Gilles Peskine449bd832023-01-11 14:50:10 +01005259 if (output_length == 0) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005260 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01005261 }
Przemek Stekiel03d948c2022-05-19 11:45:20 +02005262 /* We can't be wanting more output after the last block, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005263 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005264 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02005265 * object was corrupted or if this function is called directly
5266 * inside the library. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005267 if (hkdf->block_number == last_block) {
5268 return PSA_ERROR_BAD_STATE;
5269 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02005270
5271 /* We need a new block */
5272 ++hkdf->block_number;
5273 hkdf->offset_in_block = 0;
Steven Cooremand1ed1d92021-04-29 19:11:25 +02005274
Gilles Peskine449bd832023-01-11 14:50:10 +01005275 status = psa_key_derivation_start_hmac(&hkdf->hmac,
5276 hash_alg,
5277 hkdf->prk,
5278 hash_length);
5279 if (status != PSA_SUCCESS) {
5280 return status;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005281 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005282
5283 if (hkdf->block_number != 1) {
5284 status = psa_mac_update(&hkdf->hmac,
5285 hkdf->output_block,
5286 hash_length);
5287 if (status != PSA_SUCCESS) {
5288 return status;
5289 }
5290 }
5291 status = psa_mac_update(&hkdf->hmac,
5292 hkdf->info,
5293 hkdf->info_length);
5294 if (status != PSA_SUCCESS) {
5295 return status;
5296 }
5297 status = psa_mac_update(&hkdf->hmac,
5298 &hkdf->block_number, 1);
5299 if (status != PSA_SUCCESS) {
5300 return status;
5301 }
5302 status = psa_mac_sign_finish(&hkdf->hmac,
5303 hkdf->output_block,
5304 sizeof(hkdf->output_block),
5305 &hmac_output_length);
5306 if (status != PSA_SUCCESS) {
5307 return status;
5308 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02005309 }
5310
Gilles Peskine449bd832023-01-11 14:50:10 +01005311 return PSA_SUCCESS;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005312}
Przemek Stekiel69c46792022-06-10 12:59:51 +02005313#endif /* BUILTIN_ALG_ANY_HKDF */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005314
John Durkop07cc04a2020-11-16 22:08:34 -08005315#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5316 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follath7742fee2019-06-17 12:58:10 +01005317static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
5318 psa_tls12_prf_key_derivation_t *tls12_prf,
Gilles Peskine449bd832023-01-11 14:50:10 +01005319 psa_algorithm_t alg)
Janos Follath7742fee2019-06-17 12:58:10 +01005320{
Gilles Peskine449bd832023-01-11 14:50:10 +01005321 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(alg);
5322 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Steven Cooremana6df6042021-04-29 19:32:25 +02005323 psa_mac_operation_t hmac = PSA_MAC_OPERATION_INIT;
5324 size_t hmac_output_length;
Janos Follathea29bfb2019-06-19 12:21:20 +01005325 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005326
Janos Follath7742fee2019-06-17 12:58:10 +01005327 /* We can't be wanting more output after block 0xff, otherwise
5328 * the capacity check in psa_key_derivation_output_bytes() would have
5329 * prevented this call. It could happen only if the operation
5330 * object was corrupted or if this function is called directly
5331 * inside the library. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005332 if (tls12_prf->block_number == 0xff) {
5333 return PSA_ERROR_CORRUPTION_DETECTED;
5334 }
Janos Follath7742fee2019-06-17 12:58:10 +01005335
5336 /* We need a new block */
5337 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01005338 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01005339
5340 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
5341 *
5342 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
5343 *
5344 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
5345 * HMAC_hash(secret, A(2) + seed) +
5346 * HMAC_hash(secret, A(3) + seed) + ...
5347 *
5348 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01005349 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01005350 *
Janos Follathea29bfb2019-06-19 12:21:20 +01005351 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01005352 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01005353 * is currently extracted as `output_block` and where i is
5354 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01005355 */
5356
Gilles Peskine449bd832023-01-11 14:50:10 +01005357 status = psa_key_derivation_start_hmac(&hmac,
5358 hash_alg,
5359 tls12_prf->secret,
5360 tls12_prf->secret_length);
5361 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005362 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005363 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005364
5365 /* Calculate A(i) where i = tls12_prf->block_number. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005366 if (tls12_prf->block_number == 1) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005367 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
5368 * the variable seed and in this instance means it in the context of the
5369 * P_hash function, where seed = label + seed.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01005370 status = psa_mac_update(&hmac,
5371 tls12_prf->label,
5372 tls12_prf->label_length);
5373 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005374 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005375 }
5376 status = psa_mac_update(&hmac,
5377 tls12_prf->seed,
5378 tls12_prf->seed_length);
5379 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005380 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005381 }
5382 } else {
Janos Follathea29bfb2019-06-19 12:21:20 +01005383 /* A(i) = HMAC_hash(secret, A(i-1)) */
Gilles Peskine449bd832023-01-11 14:50:10 +01005384 status = psa_mac_update(&hmac, tls12_prf->Ai, hash_length);
5385 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005386 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005387 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005388 }
5389
Gilles Peskine449bd832023-01-11 14:50:10 +01005390 status = psa_mac_sign_finish(&hmac,
5391 tls12_prf->Ai, hash_length,
5392 &hmac_output_length);
5393 if (hmac_output_length != hash_length) {
Steven Cooremana6df6042021-04-29 19:32:25 +02005394 status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01005395 }
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 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
Gilles Peskine449bd832023-01-11 14:50:10 +01005401 status = psa_key_derivation_start_hmac(&hmac,
5402 hash_alg,
5403 tls12_prf->secret,
5404 tls12_prf->secret_length);
5405 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005406 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005407 }
5408 status = psa_mac_update(&hmac, tls12_prf->Ai, hash_length);
5409 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005410 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005411 }
5412 status = psa_mac_update(&hmac, tls12_prf->label, tls12_prf->label_length);
5413 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005414 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005415 }
5416 status = psa_mac_update(&hmac, tls12_prf->seed, tls12_prf->seed_length);
5417 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005418 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005419 }
5420 status = psa_mac_sign_finish(&hmac,
5421 tls12_prf->output_block, hash_length,
5422 &hmac_output_length);
5423 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005424 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005425 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005426
Janos Follath7742fee2019-06-17 12:58:10 +01005427
5428cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01005429 cleanup_status = psa_mac_abort(&hmac);
5430 if (status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005431 status = cleanup_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01005432 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005433
Gilles Peskine449bd832023-01-11 14:50:10 +01005434 return status;
Janos Follath7742fee2019-06-17 12:58:10 +01005435}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005436
Janos Follath844eb0e2019-06-19 12:10:49 +01005437static psa_status_t psa_key_derivation_tls12_prf_read(
5438 psa_tls12_prf_key_derivation_t *tls12_prf,
5439 psa_algorithm_t alg,
5440 uint8_t *output,
Gilles Peskine449bd832023-01-11 14:50:10 +01005441 size_t output_length)
Janos Follath844eb0e2019-06-19 12:10:49 +01005442{
Gilles Peskine449bd832023-01-11 14:50:10 +01005443 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH(alg);
5444 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Janos Follath844eb0e2019-06-19 12:10:49 +01005445 psa_status_t status;
5446 uint8_t offset, length;
5447
Gilles Peskine449bd832023-01-11 14:50:10 +01005448 switch (tls12_prf->state) {
Gilles Peskineb1edaec2021-06-11 22:41:46 +02005449 case PSA_TLS12_PRF_STATE_LABEL_SET:
5450 tls12_prf->state = PSA_TLS12_PRF_STATE_OUTPUT;
5451 break;
5452 case PSA_TLS12_PRF_STATE_OUTPUT:
5453 break;
5454 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005455 return PSA_ERROR_BAD_STATE;
Gilles Peskineb1edaec2021-06-11 22:41:46 +02005456 }
5457
Gilles Peskine449bd832023-01-11 14:50:10 +01005458 while (output_length != 0) {
Janos Follath844eb0e2019-06-19 12:10:49 +01005459 /* Check if we have fully processed the current block. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005460 if (tls12_prf->left_in_block == 0) {
5461 status = psa_key_derivation_tls12_prf_generate_next_block(tls12_prf,
5462 alg);
5463 if (status != PSA_SUCCESS) {
5464 return status;
5465 }
Janos Follath844eb0e2019-06-19 12:10:49 +01005466
5467 continue;
5468 }
5469
Gilles Peskine449bd832023-01-11 14:50:10 +01005470 if (tls12_prf->left_in_block > output_length) {
Janos Follath844eb0e2019-06-19 12:10:49 +01005471 length = (uint8_t) output_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01005472 } else {
Janos Follath844eb0e2019-06-19 12:10:49 +01005473 length = tls12_prf->left_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005474 }
Janos Follath844eb0e2019-06-19 12:10:49 +01005475
5476 offset = hash_length - tls12_prf->left_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005477 memcpy(output, tls12_prf->output_block + offset, length);
Janos Follath844eb0e2019-06-19 12:10:49 +01005478 output += length;
5479 output_length -= length;
5480 tls12_prf->left_in_block -= length;
5481 }
5482
Gilles Peskine449bd832023-01-11 14:50:10 +01005483 return PSA_SUCCESS;
Janos Follath844eb0e2019-06-19 12:10:49 +01005484}
John Durkop07cc04a2020-11-16 22:08:34 -08005485#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
5486 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskinebef7f142018-07-12 17:22:21 +02005487
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005488#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
5489static psa_status_t psa_key_derivation_tls12_ecjpake_to_pms_read(
5490 psa_tls12_ecjpake_to_pms_t *ecjpake,
5491 uint8_t *output,
Gilles Peskine449bd832023-01-11 14:50:10 +01005492 size_t output_length)
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005493{
5494 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Andrzej Kurek5603efd2022-09-26 10:49:16 -04005495 size_t output_size = 0;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005496
Gilles Peskine449bd832023-01-11 14:50:10 +01005497 if (output_length != 32) {
5498 return PSA_ERROR_INVALID_ARGUMENT;
5499 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005500
Gilles Peskine449bd832023-01-11 14:50:10 +01005501 status = psa_hash_compute(PSA_ALG_SHA_256, ecjpake->data,
5502 PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE, output, output_length,
5503 &output_size);
5504 if (status != PSA_SUCCESS) {
5505 return status;
5506 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005507
Gilles Peskine449bd832023-01-11 14:50:10 +01005508 if (output_size != output_length) {
5509 return PSA_ERROR_GENERIC_ERROR;
5510 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005511
Gilles Peskine449bd832023-01-11 14:50:10 +01005512 return PSA_SUCCESS;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005513}
5514#endif
5515
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305516#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305517static psa_status_t psa_key_derivation_pbkdf2_generate_block(
5518 psa_pbkdf2_key_derivation_t *pbkdf2,
5519 psa_algorithm_t prf_alg,
5520 uint8_t prf_output_length,
5521 psa_key_attributes_t *attributes)
5522{
5523 psa_status_t status;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305524 psa_mac_operation_t mac_operation = PSA_MAC_OPERATION_INIT;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305525 size_t mac_output_length;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305526 uint8_t U_i[PSA_MAC_MAX_SIZE];
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305527 uint8_t *U_accumulator = pbkdf2->output_block;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305528 uint64_t i;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305529 uint8_t block_counter[4];
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305530
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305531 mac_operation.is_sign = 1;
5532 mac_operation.mac_size = prf_output_length;
5533 MBEDTLS_PUT_UINT32_BE(pbkdf2->block_number, block_counter, 0);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305534
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305535 status = psa_driver_wrapper_mac_sign_setup(&mac_operation,
5536 attributes,
5537 pbkdf2->password,
5538 pbkdf2->password_length,
5539 prf_alg);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305540 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305541 goto cleanup;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305542 }
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305543 status = psa_mac_update(&mac_operation, pbkdf2->salt, pbkdf2->salt_length);
5544 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305545 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305546 }
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305547 status = psa_mac_update(&mac_operation, block_counter, sizeof(block_counter));
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305548 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305549 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305550 }
5551 status = psa_mac_sign_finish(&mac_operation, U_i, sizeof(U_i),
5552 &mac_output_length);
5553 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305554 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305555 }
5556
5557 if (mac_output_length != prf_output_length) {
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305558 status = PSA_ERROR_CORRUPTION_DETECTED;
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305559 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305560 }
5561
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305562 memcpy(U_accumulator, U_i, prf_output_length);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305563
5564 for (i = 1; i < pbkdf2->input_cost; i++) {
Kusumit Ghoderao4536bb62023-06-22 15:42:59 +05305565 /* We are passing prf_output_length as mac_size because the driver
5566 * function directly sets mac_output_length as mac_size upon success.
Kusumit Ghoderao5f3345a2023-07-27 21:21:38 +05305567 * See https://github.com/Mbed-TLS/mbedtls/issues/7801 */
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305568 status = psa_driver_wrapper_mac_compute(attributes,
5569 pbkdf2->password,
5570 pbkdf2->password_length,
5571 prf_alg, U_i, prf_output_length,
Kusumit Ghoderao4536bb62023-06-22 15:42:59 +05305572 U_i, prf_output_length,
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305573 &mac_output_length);
5574 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305575 goto cleanup;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305576 }
5577
Kusumit Ghoderao109ee3d2023-06-08 16:36:45 +05305578 mbedtls_xor(U_accumulator, U_accumulator, U_i, prf_output_length);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305579 }
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305580
5581cleanup:
5582 /* Zeroise buffers to clear sensitive data from memory. */
5583 mbedtls_platform_zeroize(U_i, PSA_MAC_MAX_SIZE);
5584 return status;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305585}
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05305586
5587static psa_status_t psa_key_derivation_pbkdf2_read(
5588 psa_pbkdf2_key_derivation_t *pbkdf2,
5589 psa_algorithm_t kdf_alg,
5590 uint8_t *output,
5591 size_t output_length)
5592{
5593 psa_status_t status;
5594 psa_algorithm_t prf_alg;
5595 uint8_t prf_output_length;
5596 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
5597 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(pbkdf2->password_length));
5598 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
5599
5600 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
5601 prf_alg = PSA_ALG_HMAC(PSA_ALG_PBKDF2_HMAC_GET_HASH(kdf_alg));
5602 prf_output_length = PSA_HASH_LENGTH(prf_alg);
5603 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
Kusumit Ghoderaoa2520a52023-06-22 15:42:19 +05305604 } else if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
5605 prf_alg = PSA_ALG_CMAC;
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05305606 prf_output_length = PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC);
Kusumit Ghoderaoa2520a52023-06-22 15:42:19 +05305607 psa_set_key_type(&attributes, PSA_KEY_TYPE_AES);
Kusumit Ghoderaod9ec1af2023-06-08 20:19:51 +05305608 } else {
5609 return PSA_ERROR_INVALID_ARGUMENT;
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05305610 }
5611
5612 switch (pbkdf2->state) {
5613 case PSA_PBKDF2_STATE_PASSWORD_SET:
5614 /* Initially we need a new block so bytes_used is equal to block size*/
5615 pbkdf2->bytes_used = prf_output_length;
5616 pbkdf2->state = PSA_PBKDF2_STATE_OUTPUT;
5617 break;
5618 case PSA_PBKDF2_STATE_OUTPUT:
5619 break;
5620 default:
5621 return PSA_ERROR_BAD_STATE;
5622 }
5623
5624 while (output_length != 0) {
5625 uint8_t n = prf_output_length - pbkdf2->bytes_used;
5626 if (n > output_length) {
5627 n = (uint8_t) output_length;
5628 }
5629 memcpy(output, pbkdf2->output_block + pbkdf2->bytes_used, n);
5630 output += n;
5631 output_length -= n;
5632 pbkdf2->bytes_used += n;
5633
5634 if (output_length == 0) {
5635 break;
5636 }
5637
5638 /* We need a new block */
5639 pbkdf2->bytes_used = 0;
5640 pbkdf2->block_number++;
5641
5642 status = psa_key_derivation_pbkdf2_generate_block(pbkdf2, prf_alg,
5643 prf_output_length,
5644 &attributes);
5645 if (status != PSA_SUCCESS) {
5646 return status;
5647 }
5648 }
5649
5650 return PSA_SUCCESS;
5651}
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305652#endif /* PSA_HAVE_SOFT_PBKDF2 */
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305653
Janos Follath6c6c8fc2019-06-17 12:38:20 +01005654psa_status_t psa_key_derivation_output_bytes(
5655 psa_key_derivation_operation_t *operation,
5656 uint8_t *output,
Gilles Peskine449bd832023-01-11 14:50:10 +01005657 size_t output_length)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005658{
5659 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01005660 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
Gilles Peskineeab56e42018-07-12 17:12:33 +02005661
Gilles Peskine449bd832023-01-11 14:50:10 +01005662 if (operation->alg == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005663 /* This is a blank operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005664 return PSA_ERROR_BAD_STATE;
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005665 }
5666
Gilles Peskine449bd832023-01-11 14:50:10 +01005667 if (output_length > operation->capacity) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005668 operation->capacity = 0;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005669 /* Go through the error path to wipe all confidential data now
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005670 * that the operation object is useless. */
David Saadab4ecc272019-02-14 13:48:10 +02005671 status = PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005672 goto exit;
5673 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005674 if (output_length == 0 && operation->capacity == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005675 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005676 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02005677 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
5678 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005679 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02005680 * output_length > 0. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005681 return PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005682 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005683 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005684
Przemek Stekiel69c46792022-06-10 12:59:51 +02005685#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01005686 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
5687 status = psa_key_derivation_hkdf_read(&operation->ctx.hkdf, kdf_alg,
5688 output, output_length);
5689 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02005690#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08005691#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5692 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005693 if (PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
5694 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
5695 status = psa_key_derivation_tls12_prf_read(&operation->ctx.tls12_prf,
5696 kdf_alg, output,
5697 output_length);
5698 } else
John Durkop07cc04a2020-11-16 22:08:34 -08005699#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
5700 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005701#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005702 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005703 status = psa_key_derivation_tls12_ecjpake_to_pms_read(
Gilles Peskine449bd832023-01-11 14:50:10 +01005704 &operation->ctx.tls12_ecjpake_to_pms, output, output_length);
5705 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005706#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305707#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05305708 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05305709 status = psa_key_derivation_pbkdf2_read(&operation->ctx.pbkdf2, kdf_alg,
5710 output, output_length);
Kusumit Ghoderao056f0c52023-05-03 15:58:34 +05305711 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305712#endif /* PSA_HAVE_SOFT_PBKDF2 */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005713
Gilles Peskineeab56e42018-07-12 17:12:33 +02005714 {
Steven Cooreman74afe472021-02-10 17:19:22 +01005715 (void) kdf_alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01005716 return PSA_ERROR_BAD_STATE;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005717 }
5718
5719exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005720 if (status != PSA_SUCCESS) {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005721 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005722 * This allows us to differentiate between exhausted operations and
5723 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
5724 * operations. */
5725 psa_algorithm_t alg = operation->alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01005726 psa_key_derivation_abort(operation);
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005727 operation->alg = alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01005728 memset(output, '!', output_length);
Gilles Peskineeab56e42018-07-12 17:12:33 +02005729 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005730 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005731}
5732
David Brown7807bf72021-02-09 16:28:23 -07005733#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01005734static void psa_des_set_key_parity(uint8_t *data, size_t data_size)
Gilles Peskine08542d82018-07-19 17:05:42 +02005735{
Gilles Peskine449bd832023-01-11 14:50:10 +01005736 if (data_size >= 8) {
5737 mbedtls_des_key_set_parity(data);
5738 }
5739 if (data_size >= 16) {
5740 mbedtls_des_key_set_parity(data + 8);
5741 }
5742 if (data_size >= 24) {
5743 mbedtls_des_key_set_parity(data + 16);
5744 }
Gilles Peskine08542d82018-07-19 17:05:42 +02005745}
David Brown7807bf72021-02-09 16:28:23 -07005746#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine08542d82018-07-19 17:05:42 +02005747
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005748/*
Gilles Peskine449bd832023-01-11 14:50:10 +01005749 * ECC keys on a Weierstrass elliptic curve require the generation
5750 * of a private key which is an integer
5751 * in the range [1, N - 1], where N is the boundary of the private key domain:
5752 * N is the prime p for Diffie-Hellman, or the order of the
5753 * curve’s base point for ECC.
5754 *
5755 * Let m be the bit size of N, such that 2^m > N >= 2^(m-1).
5756 * This function generates the private key using the following process:
5757 *
5758 * 1. Draw a byte string of length ceiling(m/8) bytes.
5759 * 2. If m is not a multiple of 8, set the most significant
5760 * (8 * ceiling(m/8) - m) bits of the first byte in the string to zero.
5761 * 3. Convert the string to integer k by decoding it as a big-endian byte string.
5762 * 4. If k > N - 2, discard the result and return to step 1.
5763 * 5. Output k + 1 as the private key.
5764 *
5765 * This method allows compliance to NIST standards, specifically the methods titled
5766 * Key-Pair Generation by Testing Candidates in the following publications:
5767 * - NIST Special Publication 800-56A: Recommendation for Pair-Wise Key-Establishment
5768 * Schemes Using Discrete Logarithm Cryptography [SP800-56A] §5.6.1.1.4 for
5769 * Diffie-Hellman keys.
5770 *
5771 * - [SP800-56A] §5.6.1.2.2 or FIPS Publication 186-4: Digital Signature
5772 * Standard (DSS) [FIPS186-4] §B.4.2 for elliptic curve keys.
5773 *
5774 * Note: Function allocates memory for *data buffer, so given *data should be
5775 * always NULL.
5776 */
Valerio Setti86587ab2023-06-27 13:09:30 +02005777#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE)
5778#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE)
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01005779static psa_status_t psa_generate_derived_ecc_key_weierstrass_helper(
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005780 psa_key_slot_t *slot,
5781 size_t bits,
5782 psa_key_derivation_operation_t *operation,
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005783 uint8_t **data
5784 )
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005785{
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005786 unsigned key_out_of_range = 1;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005787 mbedtls_mpi k;
5788 mbedtls_mpi diff_N_2;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005789 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Przemek Stekiela81aed22022-03-01 15:13:30 +01005790 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01005791 size_t m;
5792 size_t m_bytes;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005793
Gilles Peskine449bd832023-01-11 14:50:10 +01005794 mbedtls_mpi_init(&k);
5795 mbedtls_mpi_init(&diff_N_2);
Przemyslaw Stekiel1dfd1222021-11-18 13:35:00 +01005796
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005797 psa_ecc_family_t curve = PSA_KEY_TYPE_ECC_GET_FAMILY(
Gilles Peskine449bd832023-01-11 14:50:10 +01005798 slot->attr.type);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005799 mbedtls_ecp_group_id grp_id =
Valerio Settid36c3132023-12-21 14:03:51 +01005800 mbedtls_ecc_group_from_psa(curve, bits);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005801
Gilles Peskine449bd832023-01-11 14:50:10 +01005802 if (grp_id == MBEDTLS_ECP_DP_NONE) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005803 ret = MBEDTLS_ERR_ASN1_INVALID_DATA;
Przemyslaw Stekiel871a3362021-12-02 08:46:39 +01005804 goto cleanup;
5805 }
5806
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005807 mbedtls_ecp_group ecp_group;
Gilles Peskine449bd832023-01-11 14:50:10 +01005808 mbedtls_ecp_group_init(&ecp_group);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005809
Gilles Peskine449bd832023-01-11 14:50:10 +01005810 MBEDTLS_MPI_CHK(mbedtls_ecp_group_load(&ecp_group, grp_id));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005811
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005812 /* N is the boundary of the private key domain (ecp_group.N). */
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005813 /* Let m be the bit size of N. */
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01005814 m = ecp_group.nbits;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005815
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01005816 m_bytes = PSA_BITS_TO_BYTES(m);
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005817
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005818 /* Calculate N - 2 - it will be needed later. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005819 MBEDTLS_MPI_CHK(mbedtls_mpi_sub_int(&diff_N_2, &ecp_group.N, 2));
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005820
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005821 /* Note: This function is always called with *data == NULL and it
5822 * allocates memory for the data buffer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005823 *data = mbedtls_calloc(1, m_bytes);
5824 if (*data == NULL) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005825 ret = MBEDTLS_ERR_ASN1_ALLOC_FAILED;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005826 goto cleanup;
5827 }
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005828
Gilles Peskine449bd832023-01-11 14:50:10 +01005829 while (key_out_of_range) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005830 /* 1. Draw a byte string of length ceiling(m/8) bytes. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005831 if ((status = psa_key_derivation_output_bytes(operation, *data, m_bytes)) != 0) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005832 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005833 }
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005834
5835 /* 2. If m is not a multiple of 8 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005836 if (m % 8 != 0) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005837 /* Set the most significant
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005838 * (8 * ceiling(m/8) - m) bits of the first byte in
5839 * the string to zero.
5840 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005841 uint8_t clear_bit_mask = (1 << (m % 8)) - 1;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005842 (*data)[0] &= clear_bit_mask;
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005843 }
5844
5845 /* 3. Convert the string to integer k by decoding it as a
Gilles Peskine449bd832023-01-11 14:50:10 +01005846 * big-endian byte string.
5847 */
5848 MBEDTLS_MPI_CHK(mbedtls_mpi_read_binary(&k, *data, m_bytes));
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005849
5850 /* 4. If k > N - 2, discard the result and return to step 1.
Gilles Peskine449bd832023-01-11 14:50:10 +01005851 * Result of comparison is returned. When it indicates error
5852 * then this function is called again.
5853 */
5854 MBEDTLS_MPI_CHK(mbedtls_mpi_lt_mpi_ct(&diff_N_2, &k, &key_out_of_range));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005855 }
5856
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005857 /* 5. Output k + 1 as the private key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005858 MBEDTLS_MPI_CHK(mbedtls_mpi_add_int(&k, &k, 1));
5859 MBEDTLS_MPI_CHK(mbedtls_mpi_write_binary(&k, *data, m_bytes));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005860cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01005861 if (ret != 0) {
5862 status = mbedtls_to_psa_error(ret);
5863 }
5864 if (status != PSA_SUCCESS) {
5865 mbedtls_free(*data);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005866 *data = NULL;
5867 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005868 mbedtls_mpi_free(&k);
5869 mbedtls_mpi_free(&diff_N_2);
5870 return status;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005871}
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005872
5873/* ECC keys on a Montgomery elliptic curve draws a byte string whose length
5874 * is determined by the curve, and sets the mandatory bits accordingly. That is:
5875 *
5876 * - Curve25519 (PSA_ECC_FAMILY_MONTGOMERY, 255 bits):
5877 * draw a 32-byte string and process it as specified in
5878 * Elliptic Curves for Security [RFC7748] §5.
5879 *
5880 * - Curve448 (PSA_ECC_FAMILY_MONTGOMERY, 448 bits):
5881 * draw a 56-byte string and process it as specified in [RFC7748] §5.
5882 *
5883 * Note: Function allocates memory for *data buffer, so given *data should be
5884 * always NULL.
5885 */
5886
5887static psa_status_t psa_generate_derived_ecc_key_montgomery_helper(
5888 size_t bits,
5889 psa_key_derivation_operation_t *operation,
5890 uint8_t **data
5891 )
5892{
5893 size_t output_length;
Przemek Stekiela81aed22022-03-01 15:13:30 +01005894 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005895
Gilles Peskine449bd832023-01-11 14:50:10 +01005896 switch (bits) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005897 case 255:
5898 output_length = 32;
5899 break;
5900 case 448:
5901 output_length = 56;
5902 break;
5903 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005904 return PSA_ERROR_INVALID_ARGUMENT;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005905 break;
5906 }
5907
Gilles Peskine449bd832023-01-11 14:50:10 +01005908 *data = mbedtls_calloc(1, output_length);
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005909
Gilles Peskine449bd832023-01-11 14:50:10 +01005910 if (*data == NULL) {
5911 return PSA_ERROR_INSUFFICIENT_MEMORY;
5912 }
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005913
Gilles Peskine449bd832023-01-11 14:50:10 +01005914 status = psa_key_derivation_output_bytes(operation, *data, output_length);
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005915
Gilles Peskine449bd832023-01-11 14:50:10 +01005916 if (status != PSA_SUCCESS) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005917 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01005918 }
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005919
Gilles Peskine449bd832023-01-11 14:50:10 +01005920 switch (bits) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005921 case 255:
5922 (*data)[0] &= 248;
5923 (*data)[31] &= 127;
5924 (*data)[31] |= 64;
5925 break;
5926 case 448:
5927 (*data)[0] &= 252;
5928 (*data)[55] |= 128;
5929 break;
5930 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005931 return PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005932 break;
5933 }
5934
5935 return status;
5936}
Valerio Setti86587ab2023-06-27 13:09:30 +02005937#else /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE */
5938static psa_status_t psa_generate_derived_ecc_key_weierstrass_helper(
5939 psa_key_slot_t *slot, size_t bits,
5940 psa_key_derivation_operation_t *operation, uint8_t **data)
5941{
5942 (void) slot;
5943 (void) bits;
5944 (void) operation;
5945 (void) data;
5946 return PSA_ERROR_NOT_SUPPORTED;
5947}
5948
5949static psa_status_t psa_generate_derived_ecc_key_montgomery_helper(
5950 size_t bits, psa_key_derivation_operation_t *operation, uint8_t **data)
5951{
5952 (void) bits;
5953 (void) operation;
5954 (void) data;
5955 return PSA_ERROR_NOT_SUPPORTED;
5956}
5957#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE */
5958#endif /* PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE */
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005959
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01005960static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005961 psa_key_slot_t *slot,
5962 size_t bits,
Gilles Peskine449bd832023-01-11 14:50:10 +01005963 psa_key_derivation_operation_t *operation)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005964{
5965 uint8_t *data = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01005966 size_t bytes = PSA_BITS_TO_BYTES(bits);
Archanad8a83dc2021-06-14 10:04:16 +05305967 size_t storage_size = bytes;
Przemek Stekiela81aed22022-03-01 15:13:30 +01005968 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01005969 psa_key_attributes_t attributes;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005970
Gilles Peskine449bd832023-01-11 14:50:10 +01005971 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(slot->attr.type)) {
5972 return PSA_ERROR_INVALID_ARGUMENT;
5973 }
Gilles Peskineeab56e42018-07-12 17:12:33 +02005974
Valerio Setti8ffdb5d2023-06-20 13:14:08 +02005975#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE) || \
Valerio Settidd24f292023-06-26 12:21:17 +02005976 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE)
Gilles Peskine449bd832023-01-11 14:50:10 +01005977 if (PSA_KEY_TYPE_IS_ECC(slot->attr.type)) {
5978 psa_ecc_family_t curve = PSA_KEY_TYPE_ECC_GET_FAMILY(slot->attr.type);
5979 if (PSA_ECC_FAMILY_IS_WEIERSTRASS(curve)) {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01005980 /* Weierstrass elliptic curve */
Gilles Peskine449bd832023-01-11 14:50:10 +01005981 status = psa_generate_derived_ecc_key_weierstrass_helper(slot, bits, operation, &data);
5982 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005983 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005984 }
5985 } else {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01005986 /* Montgomery elliptic curve */
Gilles Peskine449bd832023-01-11 14:50:10 +01005987 status = psa_generate_derived_ecc_key_montgomery_helper(bits, operation, &data);
5988 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01005989 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005990 }
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01005991 }
Przemyslaw Stekiel1dfd1222021-11-18 13:35:00 +01005992 } else
Valerio Setti8ffdb5d2023-06-20 13:14:08 +02005993#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE) ||
Valerio Settidd24f292023-06-26 12:21:17 +02005994 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE) */
Gilles Peskine449bd832023-01-11 14:50:10 +01005995 if (key_type_is_raw_bytes(slot->attr.type)) {
5996 if (bits % 8 != 0) {
5997 return PSA_ERROR_INVALID_ARGUMENT;
5998 }
5999 data = mbedtls_calloc(1, bytes);
6000 if (data == NULL) {
6001 return PSA_ERROR_INSUFFICIENT_MEMORY;
6002 }
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01006003
Gilles Peskine449bd832023-01-11 14:50:10 +01006004 status = psa_key_derivation_output_bytes(operation, data, bytes);
6005 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01006006 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006007 }
David Brown12ca5032021-02-11 11:02:00 -07006008#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01006009 if (slot->attr.type == PSA_KEY_TYPE_DES) {
6010 psa_des_set_key_parity(data, bytes);
6011 }
Przemek Stekielf110dc02022-03-01 14:48:05 +01006012#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES) */
Gilles Peskine449bd832023-01-11 14:50:10 +01006013 } else {
6014 return PSA_ERROR_NOT_SUPPORTED;
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01006015 }
Ronald Crondd04d422020-11-28 15:14:42 +01006016
Ronald Cronbf33c932020-11-28 18:06:53 +01006017 slot->attr.bits = (psa_key_bits_t) bits;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01006018 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01006019 .core = slot->attr
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01006020 };
6021
Gilles Peskine449bd832023-01-11 14:50:10 +01006022 if (psa_key_lifetime_is_external(attributes.core.lifetime)) {
6023 status = psa_driver_wrapper_get_key_buffer_size(&attributes,
6024 &storage_size);
6025 if (status != PSA_SUCCESS) {
Archanad8a83dc2021-06-14 10:04:16 +05306026 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006027 }
Archanad8a83dc2021-06-14 10:04:16 +05306028 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006029 status = psa_allocate_buffer_to_slot(slot, storage_size);
6030 if (status != PSA_SUCCESS) {
Archanad8a83dc2021-06-14 10:04:16 +05306031 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006032 }
Archanad8a83dc2021-06-14 10:04:16 +05306033
Gilles Peskine449bd832023-01-11 14:50:10 +01006034 status = psa_driver_wrapper_import_key(&attributes,
6035 data, bytes,
6036 slot->key.data,
6037 slot->key.bytes,
6038 &slot->key.bytes, &bits);
6039 if (bits != slot->attr.bits) {
Ronald Cronbf33c932020-11-28 18:06:53 +01006040 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine449bd832023-01-11 14:50:10 +01006041 }
Gilles Peskineeab56e42018-07-12 17:12:33 +02006042
6043exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01006044 mbedtls_free(data);
6045 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02006046}
6047
Gilles Peskine449bd832023-01-11 14:50:10 +01006048psa_status_t psa_key_derivation_output_key(const psa_key_attributes_t *attributes,
6049 psa_key_derivation_operation_t *operation,
6050 mbedtls_svc_key_id_t *key)
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006051{
6052 psa_status_t status;
6053 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02006054 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine0f84d622019-09-12 19:03:13 +02006055
Ronald Cron81709fc2020-11-14 12:10:32 +01006056 *key = MBEDTLS_SVC_KEY_ID_INIT;
6057
Gilles Peskine0f84d622019-09-12 19:03:13 +02006058 /* Reject any attempt to create a zero-length key so that we don't
6059 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006060 if (psa_get_key_bits(attributes) == 0) {
6061 return PSA_ERROR_INVALID_ARGUMENT;
6062 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02006063
Gilles Peskine449bd832023-01-11 14:50:10 +01006064 if (operation->alg == PSA_ALG_NONE) {
6065 return PSA_ERROR_BAD_STATE;
6066 }
Dave Rodgmand69da6c2021-11-16 10:32:48 +00006067
Gilles Peskine449bd832023-01-11 14:50:10 +01006068 if (!operation->can_output_key) {
6069 return PSA_ERROR_NOT_PERMITTED;
6070 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02006071
Gilles Peskine449bd832023-01-11 14:50:10 +01006072 status = psa_start_key_creation(PSA_KEY_CREATION_DERIVE, attributes,
6073 &slot, &driver);
Gilles Peskinef4ee6622019-07-24 13:44:30 +02006074#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006075 if (driver != NULL) {
Gilles Peskinef4ee6622019-07-24 13:44:30 +02006076 /* Deriving a key in a secure element is not implemented yet. */
6077 status = PSA_ERROR_NOT_SUPPORTED;
6078 }
6079#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine449bd832023-01-11 14:50:10 +01006080 if (status == PSA_SUCCESS) {
6081 status = psa_generate_derived_key_internal(slot,
6082 attributes->core.bits,
6083 operation);
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006084 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006085 if (status == PSA_SUCCESS) {
6086 status = psa_finish_key_creation(slot, driver, key);
6087 }
6088 if (status != PSA_SUCCESS) {
6089 psa_fail_key_creation(slot, driver);
6090 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02006091
Gilles Peskine449bd832023-01-11 14:50:10 +01006092 return status;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006093}
6094
Gilles Peskineeab56e42018-07-12 17:12:33 +02006095
6096
6097/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02006098/* Key derivation */
6099/****************************************************************/
6100
Steven Cooreman932ffb72021-02-15 12:14:32 +01006101#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006102static int is_kdf_alg_supported(psa_algorithm_t kdf_alg)
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006103{
6104#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006105 if (PSA_ALG_IS_HKDF(kdf_alg)) {
6106 return 1;
6107 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006108#endif
Przemek Stekielb57a44b2022-06-06 08:33:45 +02006109#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006110 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6111 return 1;
6112 }
Przemek Stekielb57a44b2022-06-06 08:33:45 +02006113#endif
6114#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006115 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
6116 return 1;
6117 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006118#endif
6119#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006120 if (PSA_ALG_IS_TLS12_PRF(kdf_alg)) {
6121 return 1;
6122 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006123#endif
6124#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006125 if (PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
6126 return 1;
6127 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006128#endif
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006129#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006130 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
6131 return 1;
6132 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006133#endif
Kusumit Ghoderaod132cac2023-05-03 12:00:27 +05306134#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
6135 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
6136 return 1;
6137 }
6138#endif
Kusumit Ghoderao2cd64962023-06-22 15:38:57 +05306139#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128)
6140 if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
6141 return 1;
6142 }
6143#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006144 return 0;
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006145}
6146
Gilles Peskine449bd832023-01-11 14:50:10 +01006147static psa_status_t psa_hash_try_support(psa_algorithm_t alg)
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006148{
6149 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01006150 psa_status_t status = psa_hash_setup(&operation, alg);
6151 psa_hash_abort(&operation);
6152 return status;
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006153}
6154
Kusumit Ghoderao86e83dd2023-12-01 16:38:26 +05306155static psa_status_t psa_key_derivation_set_maximum_capacity(
6156 psa_key_derivation_operation_t *operation,
6157 psa_algorithm_t kdf_alg)
6158{
6159#if defined(PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS)
6160 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
6161 operation->capacity = PSA_HASH_LENGTH(PSA_ALG_SHA_256);
6162 return PSA_SUCCESS;
6163 }
6164#endif
6165#if defined(PSA_WANT_ALG_PBKDF2_AES_CMAC_PRF_128)
6166 if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
6167#if (SIZE_MAX > UINT32_MAX)
Kusumit Ghoderao7d4db632023-12-07 16:17:46 +05306168 operation->capacity = UINT32_MAX * (size_t) PSA_MAC_LENGTH(
Kusumit Ghoderaod3f70d32023-12-06 16:20:04 +05306169 PSA_KEY_TYPE_AES,
6170 128U,
6171 PSA_ALG_CMAC);
Kusumit Ghoderao86e83dd2023-12-01 16:38:26 +05306172#else
6173 operation->capacity = SIZE_MAX;
6174#endif
6175 return PSA_SUCCESS;
6176 }
6177#endif /* PSA_WANT_ALG_PBKDF2_AES_CMAC_PRF_128 */
6178
6179 /* After this point, if kdf_alg is not valid then value of hash_alg may be
6180 * invalid or meaningless but it does not affect this function */
6181 psa_algorithm_t hash_alg = PSA_ALG_GET_HASH(kdf_alg);
6182 size_t hash_size = PSA_HASH_LENGTH(hash_alg);
Kusumit Ghoderaod3f70d32023-12-06 16:20:04 +05306183 if (hash_size == 0) {
6184 return PSA_ERROR_NOT_SUPPORTED;
6185 }
Kusumit Ghoderao86e83dd2023-12-01 16:38:26 +05306186
6187 /* Make sure that hash_alg is a supported hash algorithm. Otherwise
6188 * we might fail later, which is somewhat unfriendly and potentially
6189 * risk-prone. */
6190 psa_status_t status = psa_hash_try_support(hash_alg);
6191 if (status != PSA_SUCCESS) {
6192 return status;
6193 }
6194
6195#if defined(PSA_WANT_ALG_HKDF)
6196 if (PSA_ALG_IS_HKDF(kdf_alg)) {
6197 operation->capacity = 255 * hash_size;
6198 } else
6199#endif
6200#if defined(PSA_WANT_ALG_HKDF_EXTRACT)
6201 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6202 operation->capacity = hash_size;
6203 } else
6204#endif
6205#if defined(PSA_WANT_ALG_HKDF_EXPAND)
6206 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
6207 operation->capacity = 255 * hash_size;
6208 } else
6209#endif
6210#if defined(PSA_WANT_ALG_TLS12_PRF)
6211 if (PSA_ALG_IS_TLS12_PRF(kdf_alg) &&
6212 (hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384)) {
6213 operation->capacity = SIZE_MAX;
6214 } else
6215#endif
6216#if defined(PSA_WANT_ALG_TLS12_PSK_TO_MS)
6217 if (PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg) &&
6218 (hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384)) {
6219 /* Master Secret is always 48 bytes
6220 * https://datatracker.ietf.org/doc/html/rfc5246.html#section-8.1 */
6221 operation->capacity = 48U;
6222 } else
6223#endif
6224#if defined(PSA_WANT_ALG_PBKDF2_HMAC)
6225 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
6226#if (SIZE_MAX > UINT32_MAX)
6227 operation->capacity = UINT32_MAX * hash_size;
6228#else
6229 operation->capacity = SIZE_MAX;
6230#endif
6231 } else
6232#endif /* PSA_WANT_ALG_PBKDF2_HMAC */
6233 {
Kusumit Ghoderaod3f70d32023-12-06 16:20:04 +05306234 (void) hash_size;
Kusumit Ghoderao86e83dd2023-12-01 16:38:26 +05306235 status = PSA_ERROR_NOT_SUPPORTED;
6236 }
6237 return status;
6238}
6239
Gilles Peskine969c5d62019-01-16 15:53:06 +01006240static psa_status_t psa_key_derivation_setup_kdf(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006241 psa_key_derivation_operation_t *operation,
Gilles Peskine449bd832023-01-11 14:50:10 +01006242 psa_algorithm_t kdf_alg)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006243{
Janos Follath5fe19732019-06-20 15:09:30 +01006244 /* Make sure that operation->ctx is properly zero-initialised. (Macro
6245 * initialisers for this union leave some bytes unspecified.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01006246 memset(&operation->ctx, 0, sizeof(operation->ctx));
Janos Follath5fe19732019-06-20 15:09:30 +01006247
Gilles Peskine969c5d62019-01-16 15:53:06 +01006248 /* Make sure that kdf_alg is a supported key derivation algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006249 if (!is_kdf_alg_supported(kdf_alg)) {
6250 return PSA_ERROR_NOT_SUPPORTED;
6251 }
John Durkop07cc04a2020-11-16 22:08:34 -08006252
Kusumit Ghoderao86e83dd2023-12-01 16:38:26 +05306253 psa_status_t status = psa_key_derivation_set_maximum_capacity(operation,
6254 kdf_alg);
Kusumit Ghoderao5f3a9382023-09-13 16:28:12 +05306255 return status;
Gilles Peskine969c5d62019-01-16 15:53:06 +01006256}
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006257
Gilles Peskine449bd832023-01-11 14:50:10 +01006258static psa_status_t psa_key_agreement_try_support(psa_algorithm_t alg)
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006259{
6260#if defined(PSA_WANT_ALG_ECDH)
Gilles Peskine449bd832023-01-11 14:50:10 +01006261 if (alg == PSA_ALG_ECDH) {
6262 return PSA_SUCCESS;
6263 }
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006264#endif
Przemek Stekielfb3dd542022-12-01 14:59:15 +01006265#if defined(PSA_WANT_ALG_FFDH)
6266 if (alg == PSA_ALG_FFDH) {
6267 return PSA_SUCCESS;
6268 }
6269#endif
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006270 (void) alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01006271 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006272}
Gilles Peskinebb3814c2022-12-16 01:12:12 +01006273
6274static int psa_key_derivation_allows_free_form_secret_input(
6275 psa_algorithm_t kdf_alg)
6276{
6277#if defined(PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS)
6278 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
6279 return 0;
6280 }
6281#endif
6282 (void) kdf_alg;
6283 return 1;
6284}
John Durkop07cc04a2020-11-16 22:08:34 -08006285#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01006286
Gilles Peskine449bd832023-01-11 14:50:10 +01006287psa_status_t psa_key_derivation_setup(psa_key_derivation_operation_t *operation,
6288 psa_algorithm_t alg)
Gilles Peskine969c5d62019-01-16 15:53:06 +01006289{
6290 psa_status_t status;
6291
Gilles Peskine449bd832023-01-11 14:50:10 +01006292 if (operation->alg != 0) {
6293 return PSA_ERROR_BAD_STATE;
Gilles Peskine969c5d62019-01-16 15:53:06 +01006294 }
Gilles Peskine969c5d62019-01-16 15:53:06 +01006295
Gilles Peskine449bd832023-01-11 14:50:10 +01006296 if (PSA_ALG_IS_RAW_KEY_AGREEMENT(alg)) {
6297 return PSA_ERROR_INVALID_ARGUMENT;
6298 } else if (PSA_ALG_IS_KEY_AGREEMENT(alg)) {
6299#if defined(AT_LEAST_ONE_BUILTIN_KDF)
6300 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF(alg);
6301 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE(alg);
6302 status = psa_key_agreement_try_support(ka_alg);
6303 if (status != PSA_SUCCESS) {
6304 return status;
6305 }
Gilles Peskinebb3814c2022-12-16 01:12:12 +01006306 if (!psa_key_derivation_allows_free_form_secret_input(kdf_alg)) {
6307 return PSA_ERROR_INVALID_ARGUMENT;
6308 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006309 status = psa_key_derivation_setup_kdf(operation, kdf_alg);
6310#else
6311 return PSA_ERROR_NOT_SUPPORTED;
6312#endif /* AT_LEAST_ONE_BUILTIN_KDF */
6313 } else if (PSA_ALG_IS_KEY_DERIVATION(alg)) {
6314#if defined(AT_LEAST_ONE_BUILTIN_KDF)
6315 status = psa_key_derivation_setup_kdf(operation, alg);
6316#else
6317 return PSA_ERROR_NOT_SUPPORTED;
6318#endif /* AT_LEAST_ONE_BUILTIN_KDF */
6319 } else {
6320 return PSA_ERROR_INVALID_ARGUMENT;
6321 }
6322
6323 if (status == PSA_SUCCESS) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006324 operation->alg = alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01006325 }
6326 return status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006327}
6328
Przemek Stekiel69c46792022-06-10 12:59:51 +02006329#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006330static psa_status_t psa_hkdf_input(psa_hkdf_key_derivation_t *hkdf,
6331 psa_algorithm_t kdf_alg,
6332 psa_key_derivation_step_t step,
6333 const uint8_t *data,
6334 size_t data_length)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006335{
Gilles Peskine449bd832023-01-11 14:50:10 +01006336 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006337 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006338 switch (step) {
Gilles Peskine03410b52019-05-16 16:05:19 +02006339 case PSA_KEY_DERIVATION_INPUT_SALT:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006340#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006341 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
6342 return PSA_ERROR_INVALID_ARGUMENT;
6343 }
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006344#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND */
Gilles Peskine449bd832023-01-11 14:50:10 +01006345 if (hkdf->state != HKDF_STATE_INIT) {
6346 return PSA_ERROR_BAD_STATE;
6347 } else {
6348 status = psa_key_derivation_start_hmac(&hkdf->hmac,
6349 hash_alg,
6350 data, data_length);
6351 if (status != PSA_SUCCESS) {
6352 return status;
6353 }
Steven Cooremand1ed1d92021-04-29 19:11:25 +02006354 hkdf->state = HKDF_STATE_STARTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01006355 return PSA_SUCCESS;
Steven Cooremand1ed1d92021-04-29 19:11:25 +02006356 }
Gilles Peskine03410b52019-05-16 16:05:19 +02006357 case PSA_KEY_DERIVATION_INPUT_SECRET:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006358#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006359 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
Przemek Stekiel2fb0dcd2022-05-19 10:34:37 +02006360 /* We shouldn't be in different state as HKDF_EXPAND only allows
6361 * two inputs: SECRET (this case) and INFO which does not modify
6362 * the state. It could happen only if the hkdf
6363 * object was corrupted. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006364 if (hkdf->state != HKDF_STATE_INIT) {
6365 return PSA_ERROR_BAD_STATE;
6366 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006367
Przemek Stekiel2fb0dcd2022-05-19 10:34:37 +02006368 /* Allow only input that fits expected prk size */
Gilles Peskine449bd832023-01-11 14:50:10 +01006369 if (data_length != PSA_HASH_LENGTH(hash_alg)) {
6370 return PSA_ERROR_INVALID_ARGUMENT;
6371 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006372
Gilles Peskine449bd832023-01-11 14:50:10 +01006373 memcpy(hkdf->prk, data, data_length);
6374 } else
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006375#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND */
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006376 {
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006377 /* HKDF: If no salt was provided, use an empty salt.
6378 * HKDF-EXTRACT: salt is mandatory. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006379 if (hkdf->state == HKDF_STATE_INIT) {
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006380#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006381 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6382 return PSA_ERROR_BAD_STATE;
6383 }
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006384#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01006385 status = psa_key_derivation_start_hmac(&hkdf->hmac,
6386 hash_alg,
6387 NULL, 0);
6388 if (status != PSA_SUCCESS) {
6389 return status;
6390 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006391 hkdf->state = HKDF_STATE_STARTED;
6392 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006393 if (hkdf->state != HKDF_STATE_STARTED) {
6394 return PSA_ERROR_BAD_STATE;
6395 }
6396 status = psa_mac_update(&hkdf->hmac,
6397 data, data_length);
6398 if (status != PSA_SUCCESS) {
6399 return status;
6400 }
6401 status = psa_mac_sign_finish(&hkdf->hmac,
6402 hkdf->prk,
6403 sizeof(hkdf->prk),
6404 &data_length);
6405 if (status != PSA_SUCCESS) {
6406 return status;
6407 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006408 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006409
Gilles Peskine2b522db2019-04-12 15:11:49 +02006410 hkdf->state = HKDF_STATE_KEYED;
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006411 hkdf->block_number = 0;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006412#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006413 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006414 /* The only block of output is the PRK. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006415 memcpy(hkdf->output_block, hkdf->prk, PSA_HASH_LENGTH(hash_alg));
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006416 hkdf->offset_in_block = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01006417 } else
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006418#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006419 {
6420 /* Block 0 is empty, and the next block will be
6421 * generated by psa_key_derivation_hkdf_read(). */
Gilles Peskine449bd832023-01-11 14:50:10 +01006422 hkdf->offset_in_block = PSA_HASH_LENGTH(hash_alg);
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006423 }
6424
Gilles Peskine449bd832023-01-11 14:50:10 +01006425 return PSA_SUCCESS;
Gilles Peskine03410b52019-05-16 16:05:19 +02006426 case PSA_KEY_DERIVATION_INPUT_INFO:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006427#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006428 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6429 return PSA_ERROR_INVALID_ARGUMENT;
6430 }
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006431#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Przemek Stekielcde3f782022-06-03 16:12:27 +02006432#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006433 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg) &&
6434 hkdf->state == HKDF_STATE_INIT) {
6435 return PSA_ERROR_BAD_STATE;
6436 }
Przemek Stekielcde3f782022-06-03 16:12:27 +02006437#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01006438 if (hkdf->state == HKDF_STATE_OUTPUT) {
6439 return PSA_ERROR_BAD_STATE;
6440 }
6441 if (hkdf->info_set) {
6442 return PSA_ERROR_BAD_STATE;
6443 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006444 hkdf->info_length = data_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01006445 if (data_length != 0) {
6446 hkdf->info = mbedtls_calloc(1, data_length);
6447 if (hkdf->info == NULL) {
6448 return PSA_ERROR_INSUFFICIENT_MEMORY;
6449 }
6450 memcpy(hkdf->info, data, data_length);
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006451 }
6452 hkdf->info_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01006453 return PSA_SUCCESS;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006454 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006455 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006456 }
6457}
Przemek Stekiel69c46792022-06-10 12:59:51 +02006458#endif /* BUILTIN_ALG_ANY_HKDF */
Janos Follathb03233e2019-06-11 15:30:30 +01006459
John Durkop07cc04a2020-11-16 22:08:34 -08006460#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
6461 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006462static psa_status_t psa_tls12_prf_set_seed(psa_tls12_prf_key_derivation_t *prf,
6463 const uint8_t *data,
6464 size_t data_length)
Janos Follathf08e2652019-06-13 09:05:41 +01006465{
Gilles Peskine449bd832023-01-11 14:50:10 +01006466 if (prf->state != PSA_TLS12_PRF_STATE_INIT) {
6467 return PSA_ERROR_BAD_STATE;
6468 }
Janos Follathf08e2652019-06-13 09:05:41 +01006469
Gilles Peskine449bd832023-01-11 14:50:10 +01006470 if (data_length != 0) {
6471 prf->seed = mbedtls_calloc(1, data_length);
6472 if (prf->seed == NULL) {
6473 return PSA_ERROR_INSUFFICIENT_MEMORY;
6474 }
Janos Follathf08e2652019-06-13 09:05:41 +01006475
Gilles Peskine449bd832023-01-11 14:50:10 +01006476 memcpy(prf->seed, data, data_length);
Janos Follathd6dce9f2019-07-04 09:11:38 +01006477 prf->seed_length = data_length;
6478 }
Janos Follathf08e2652019-06-13 09:05:41 +01006479
Gilles Peskine43f958b2020-12-13 14:55:14 +01006480 prf->state = PSA_TLS12_PRF_STATE_SEED_SET;
Janos Follathf08e2652019-06-13 09:05:41 +01006481
Gilles Peskine449bd832023-01-11 14:50:10 +01006482 return PSA_SUCCESS;
Janos Follathf08e2652019-06-13 09:05:41 +01006483}
6484
Gilles Peskine449bd832023-01-11 14:50:10 +01006485static psa_status_t psa_tls12_prf_set_key(psa_tls12_prf_key_derivation_t *prf,
6486 const uint8_t *data,
6487 size_t data_length)
Janos Follath81550542019-06-13 14:26:34 +01006488{
Gilles Peskine449bd832023-01-11 14:50:10 +01006489 if (prf->state != PSA_TLS12_PRF_STATE_SEED_SET &&
6490 prf->state != PSA_TLS12_PRF_STATE_OTHER_KEY_SET) {
6491 return PSA_ERROR_BAD_STATE;
6492 }
Janos Follath81550542019-06-13 14:26:34 +01006493
Gilles Peskine449bd832023-01-11 14:50:10 +01006494 if (data_length != 0) {
6495 prf->secret = mbedtls_calloc(1, data_length);
6496 if (prf->secret == NULL) {
6497 return PSA_ERROR_INSUFFICIENT_MEMORY;
6498 }
Steven Cooremana6df6042021-04-29 19:32:25 +02006499
Gilles Peskine449bd832023-01-11 14:50:10 +01006500 memcpy(prf->secret, data, data_length);
Steven Cooremana6df6042021-04-29 19:32:25 +02006501 prf->secret_length = data_length;
6502 }
Janos Follath81550542019-06-13 14:26:34 +01006503
Gilles Peskine43f958b2020-12-13 14:55:14 +01006504 prf->state = PSA_TLS12_PRF_STATE_KEY_SET;
Janos Follath81550542019-06-13 14:26:34 +01006505
Gilles Peskine449bd832023-01-11 14:50:10 +01006506 return PSA_SUCCESS;
Janos Follath81550542019-06-13 14:26:34 +01006507}
6508
Gilles Peskine449bd832023-01-11 14:50:10 +01006509static psa_status_t psa_tls12_prf_set_label(psa_tls12_prf_key_derivation_t *prf,
6510 const uint8_t *data,
6511 size_t data_length)
Janos Follath63028dd2019-06-13 09:15:47 +01006512{
Gilles Peskine449bd832023-01-11 14:50:10 +01006513 if (prf->state != PSA_TLS12_PRF_STATE_KEY_SET) {
6514 return PSA_ERROR_BAD_STATE;
6515 }
Janos Follath63028dd2019-06-13 09:15:47 +01006516
Gilles Peskine449bd832023-01-11 14:50:10 +01006517 if (data_length != 0) {
6518 prf->label = mbedtls_calloc(1, data_length);
6519 if (prf->label == NULL) {
6520 return PSA_ERROR_INSUFFICIENT_MEMORY;
6521 }
Janos Follath63028dd2019-06-13 09:15:47 +01006522
Gilles Peskine449bd832023-01-11 14:50:10 +01006523 memcpy(prf->label, data, data_length);
Janos Follathd6dce9f2019-07-04 09:11:38 +01006524 prf->label_length = data_length;
6525 }
Janos Follath63028dd2019-06-13 09:15:47 +01006526
Gilles Peskine43f958b2020-12-13 14:55:14 +01006527 prf->state = PSA_TLS12_PRF_STATE_LABEL_SET;
Janos Follath63028dd2019-06-13 09:15:47 +01006528
Gilles Peskine449bd832023-01-11 14:50:10 +01006529 return PSA_SUCCESS;
Janos Follath63028dd2019-06-13 09:15:47 +01006530}
6531
Gilles Peskine449bd832023-01-11 14:50:10 +01006532static psa_status_t psa_tls12_prf_input(psa_tls12_prf_key_derivation_t *prf,
6533 psa_key_derivation_step_t step,
6534 const uint8_t *data,
6535 size_t data_length)
Janos Follathb03233e2019-06-11 15:30:30 +01006536{
Gilles Peskine449bd832023-01-11 14:50:10 +01006537 switch (step) {
Janos Follathf08e2652019-06-13 09:05:41 +01006538 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskine449bd832023-01-11 14:50:10 +01006539 return psa_tls12_prf_set_seed(prf, data, data_length);
Janos Follath81550542019-06-13 14:26:34 +01006540 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006541 return psa_tls12_prf_set_key(prf, data, data_length);
Janos Follath63028dd2019-06-13 09:15:47 +01006542 case PSA_KEY_DERIVATION_INPUT_LABEL:
Gilles Peskine449bd832023-01-11 14:50:10 +01006543 return psa_tls12_prf_set_label(prf, data, data_length);
Janos Follathb03233e2019-06-11 15:30:30 +01006544 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006545 return PSA_ERROR_INVALID_ARGUMENT;
Janos Follathb03233e2019-06-11 15:30:30 +01006546 }
6547}
John Durkop07cc04a2020-11-16 22:08:34 -08006548#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
6549 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
6550
6551#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
6552static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
6553 psa_tls12_prf_key_derivation_t *prf,
John Durkop07cc04a2020-11-16 22:08:34 -08006554 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006555 size_t data_length)
John Durkop07cc04a2020-11-16 22:08:34 -08006556{
6557 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006558 const size_t pms_len = (prf->state == PSA_TLS12_PRF_STATE_OTHER_KEY_SET ?
6559 4 + data_length + prf->other_secret_length :
6560 4 + 2 * data_length);
John Durkop07cc04a2020-11-16 22:08:34 -08006561
Gilles Peskine449bd832023-01-11 14:50:10 +01006562 if (data_length > PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE) {
6563 return PSA_ERROR_INVALID_ARGUMENT;
6564 }
John Durkop07cc04a2020-11-16 22:08:34 -08006565
Gilles Peskine449bd832023-01-11 14:50:10 +01006566 uint8_t *pms = mbedtls_calloc(1, pms_len);
6567 if (pms == NULL) {
6568 return PSA_ERROR_INSUFFICIENT_MEMORY;
6569 }
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02006570 uint8_t *cur = pms;
6571
6572 /* pure-PSK:
6573 * Quoting RFC 4279, Section 2:
John Durkop07cc04a2020-11-16 22:08:34 -08006574 *
6575 * The premaster secret is formed as follows: if the PSK is N octets
6576 * long, concatenate a uint16 with the value N, N zero octets, a second
6577 * uint16 with the value N, and the PSK itself.
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02006578 *
6579 * mixed-PSK:
6580 * In a DHE-PSK, RSA-PSK, ECDHE-PSK the premaster secret is formed as
6581 * follows: concatenate a uint16 with the length of the other secret,
6582 * the other secret itself, uint16 with the length of PSK, and the
6583 * PSK itself.
6584 * For details please check:
6585 * - RFC 4279, Section 4 for the definition of RSA-PSK,
6586 * - RFC 4279, Section 3 for the definition of DHE-PSK,
6587 * - RFC 5489 for the definition of ECDHE-PSK.
John Durkop07cc04a2020-11-16 22:08:34 -08006588 */
6589
Gilles Peskine449bd832023-01-11 14:50:10 +01006590 if (prf->state == PSA_TLS12_PRF_STATE_OTHER_KEY_SET) {
6591 *cur++ = MBEDTLS_BYTE_1(prf->other_secret_length);
6592 *cur++ = MBEDTLS_BYTE_0(prf->other_secret_length);
6593 if (prf->other_secret_length != 0) {
6594 memcpy(cur, prf->other_secret, prf->other_secret_length);
6595 mbedtls_platform_zeroize(prf->other_secret, prf->other_secret_length);
Przemek Stekiel2503f7e2022-04-12 12:08:01 +02006596 cur += prf->other_secret_length;
6597 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006598 } else {
6599 *cur++ = MBEDTLS_BYTE_1(data_length);
6600 *cur++ = MBEDTLS_BYTE_0(data_length);
6601 memset(cur, 0, data_length);
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02006602 cur += data_length;
6603 }
6604
Gilles Peskine449bd832023-01-11 14:50:10 +01006605 *cur++ = MBEDTLS_BYTE_1(data_length);
6606 *cur++ = MBEDTLS_BYTE_0(data_length);
6607 memcpy(cur, data, data_length);
John Durkop07cc04a2020-11-16 22:08:34 -08006608 cur += data_length;
6609
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00006610 status = psa_tls12_prf_set_key(prf, pms, (size_t) (cur - pms));
John Durkop07cc04a2020-11-16 22:08:34 -08006611
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01006612 mbedtls_zeroize_and_free(pms, pms_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01006613 return status;
John Durkop07cc04a2020-11-16 22:08:34 -08006614}
Janos Follath6660f0e2019-06-17 08:44:03 +01006615
Przemek Stekiele47201b2022-04-19 13:53:28 +02006616static psa_status_t psa_tls12_prf_psk_to_ms_set_other_key(
6617 psa_tls12_prf_key_derivation_t *prf,
6618 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006619 size_t data_length)
Przemek Stekiele47201b2022-04-19 13:53:28 +02006620{
Gilles Peskine449bd832023-01-11 14:50:10 +01006621 if (prf->state != PSA_TLS12_PRF_STATE_SEED_SET) {
6622 return PSA_ERROR_BAD_STATE;
Przemek Stekiele47201b2022-04-19 13:53:28 +02006623 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006624
6625 if (data_length != 0) {
6626 prf->other_secret = mbedtls_calloc(1, data_length);
6627 if (prf->other_secret == NULL) {
6628 return PSA_ERROR_INSUFFICIENT_MEMORY;
6629 }
6630
6631 memcpy(prf->other_secret, data, data_length);
6632 prf->other_secret_length = data_length;
6633 } else {
Przemek Stekiele47201b2022-04-19 13:53:28 +02006634 prf->other_secret_length = 0;
6635 }
6636
6637 prf->state = PSA_TLS12_PRF_STATE_OTHER_KEY_SET;
6638
Gilles Peskine449bd832023-01-11 14:50:10 +01006639 return PSA_SUCCESS;
Przemek Stekiele47201b2022-04-19 13:53:28 +02006640}
6641
Janos Follath6660f0e2019-06-17 08:44:03 +01006642static psa_status_t psa_tls12_prf_psk_to_ms_input(
6643 psa_tls12_prf_key_derivation_t *prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01006644 psa_key_derivation_step_t step,
6645 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006646 size_t data_length)
Janos Follath6660f0e2019-06-17 08:44:03 +01006647{
Gilles Peskine449bd832023-01-11 14:50:10 +01006648 switch (step) {
Przemek Stekiele47201b2022-04-19 13:53:28 +02006649 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006650 return psa_tls12_prf_psk_to_ms_set_key(prf,
6651 data, data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02006652 break;
6653 case PSA_KEY_DERIVATION_INPUT_OTHER_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006654 return psa_tls12_prf_psk_to_ms_set_other_key(prf,
6655 data,
6656 data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02006657 break;
6658 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006659 return psa_tls12_prf_input(prf, step, data, data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02006660 break;
Janos Follath6660f0e2019-06-17 08:44:03 +01006661
Przemek Stekiele47201b2022-04-19 13:53:28 +02006662 }
Janos Follath6660f0e2019-06-17 08:44:03 +01006663}
John Durkop07cc04a2020-11-16 22:08:34 -08006664#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006665
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006666#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
6667static psa_status_t psa_tls12_ecjpake_to_pms_input(
6668 psa_tls12_ecjpake_to_pms_t *ecjpake,
Andrzej Kurek702776f2022-09-16 06:22:44 -04006669 psa_key_derivation_step_t step,
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006670 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006671 size_t data_length)
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006672{
Gilles Peskine449bd832023-01-11 14:50:10 +01006673 if (data_length != PSA_TLS12_ECJPAKE_TO_PMS_INPUT_SIZE ||
6674 step != PSA_KEY_DERIVATION_INPUT_SECRET) {
6675 return PSA_ERROR_INVALID_ARGUMENT;
Andrzej Kurek5603efd2022-09-26 10:49:16 -04006676 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006677
6678 /* Check if the passed point is in an uncompressed form */
Gilles Peskine449bd832023-01-11 14:50:10 +01006679 if (data[0] != 0x04) {
6680 return PSA_ERROR_INVALID_ARGUMENT;
6681 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006682
6683 /* Only K.X has to be extracted - bytes 1 to 32 inclusive. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006684 memcpy(ecjpake->data, data + 1, PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE);
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006685
Gilles Peskine449bd832023-01-11 14:50:10 +01006686 return PSA_SUCCESS;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006687}
6688#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306689
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306690#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306691static psa_status_t psa_pbkdf2_set_input_cost(
6692 psa_pbkdf2_key_derivation_t *pbkdf2,
6693 psa_key_derivation_step_t step,
6694 uint64_t data)
6695{
6696 if (step != PSA_KEY_DERIVATION_INPUT_COST) {
6697 return PSA_ERROR_INVALID_ARGUMENT;
6698 }
6699
6700 if (pbkdf2->state != PSA_PBKDF2_STATE_INIT) {
6701 return PSA_ERROR_BAD_STATE;
6702 }
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05306703
Kusumit Ghoderaoe66a8ad2023-05-24 12:30:43 +05306704 if (data > PSA_VENDOR_PBKDF2_MAX_ITERATIONS) {
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05306705 return PSA_ERROR_NOT_SUPPORTED;
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306706 }
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05306707
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306708 if (data == 0) {
6709 return PSA_ERROR_INVALID_ARGUMENT;
6710 }
Kusumit Ghoderaoe66a8ad2023-05-24 12:30:43 +05306711
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306712 pbkdf2->input_cost = data;
6713 pbkdf2->state = PSA_PBKDF2_STATE_INPUT_COST_SET;
6714
6715 return PSA_SUCCESS;
6716}
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306717
6718static psa_status_t psa_pbkdf2_set_salt(psa_pbkdf2_key_derivation_t *pbkdf2,
6719 const uint8_t *data,
6720 size_t data_length)
6721{
Gilles Peskineead17662023-08-20 22:02:51 +02006722 if (pbkdf2->state == PSA_PBKDF2_STATE_INPUT_COST_SET) {
6723 pbkdf2->state = PSA_PBKDF2_STATE_SALT_SET;
6724 } else if (pbkdf2->state == PSA_PBKDF2_STATE_SALT_SET) {
6725 /* Appending to existing salt. No state change. */
6726 } else {
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306727 return PSA_ERROR_BAD_STATE;
6728 }
6729
Gilles Peskineca57d782023-07-20 19:08:06 +02006730 if (data_length == 0) {
Gilles Peskineead17662023-08-20 22:02:51 +02006731 /* Appending an empty string, nothing to do. */
6732 } else {
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306733 uint8_t *next_salt;
Kusumit Ghoderaob538bb72023-05-24 12:32:14 +05306734
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306735 next_salt = mbedtls_calloc(1, data_length + pbkdf2->salt_length);
6736 if (next_salt == NULL) {
Kusumit Ghoderaod0422f32023-05-08 15:56:19 +05306737 return PSA_ERROR_INSUFFICIENT_MEMORY;
6738 }
6739
Gilles Peskineead17662023-08-20 22:02:51 +02006740 if (pbkdf2->salt_length != 0) {
6741 memcpy(next_salt, pbkdf2->salt, pbkdf2->salt_length);
6742 }
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306743 memcpy(next_salt + pbkdf2->salt_length, data, data_length);
Kusumit Ghoderaod0422f32023-05-08 15:56:19 +05306744 pbkdf2->salt_length += data_length;
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306745 mbedtls_free(pbkdf2->salt);
6746 pbkdf2->salt = next_salt;
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306747 }
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306748 return PSA_SUCCESS;
6749}
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306750
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05306751#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306752static psa_status_t psa_pbkdf2_hmac_set_password(psa_algorithm_t hash_alg,
Kusumit Ghoderaoaac9a582023-05-24 14:19:17 +05306753 const uint8_t *input,
6754 size_t input_len,
6755 uint8_t *output,
Kusumit Ghoderao91f99f52023-05-24 22:21:48 +05306756 size_t *output_len)
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306757{
6758 psa_status_t status = PSA_SUCCESS;
6759 if (input_len > PSA_HASH_BLOCK_LENGTH(hash_alg)) {
6760 status = psa_hash_compute(hash_alg, input, input_len, output,
Kusumit Ghoderao91f99f52023-05-24 22:21:48 +05306761 PSA_HMAC_MAX_HASH_BLOCK_SIZE, output_len);
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306762 } else {
6763 memcpy(output, input, input_len);
Kusumit Ghoderao91f99f52023-05-24 22:21:48 +05306764 *output_len = PSA_HASH_BLOCK_LENGTH(hash_alg);
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306765 }
6766 return status;
6767}
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05306768#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC */
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306769
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05306770#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128)
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306771static psa_status_t psa_pbkdf2_cmac_set_password(const uint8_t *input,
6772 size_t input_len,
6773 uint8_t *output,
6774 size_t *output_len)
6775{
6776 psa_status_t status = PSA_SUCCESS;
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306777 if (input_len != PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC)) {
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306778 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Kusumit Ghoderao3fde8fe2023-06-27 10:41:43 +05306779 uint8_t zeros[16] = { 0 };
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306780 psa_set_key_type(&attributes, PSA_KEY_TYPE_AES);
6781 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(sizeof(zeros)));
6782 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306783 /* Passing PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC) as
Kusumit Ghoderao5f3345a2023-07-27 21:21:38 +05306784 * mac_size as the driver function sets mac_output_length = mac_size
6785 * on success. See https://github.com/Mbed-TLS/mbedtls/issues/7801 */
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306786 status = psa_driver_wrapper_mac_compute(&attributes,
6787 zeros, sizeof(zeros),
6788 PSA_ALG_CMAC, input, input_len,
6789 output,
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306790 PSA_MAC_LENGTH(PSA_KEY_TYPE_AES,
6791 128U,
6792 PSA_ALG_CMAC),
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306793 output_len);
6794 } else {
6795 memcpy(output, input, input_len);
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306796 *output_len = PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC);
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306797 }
6798 return status;
6799}
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05306800#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128 */
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306801
6802static psa_status_t psa_pbkdf2_set_password(psa_pbkdf2_key_derivation_t *pbkdf2,
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306803 psa_algorithm_t kdf_alg,
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306804 const uint8_t *data,
6805 size_t data_length)
6806{
Kusumit Ghoderaoaac9a582023-05-24 14:19:17 +05306807 psa_status_t status = PSA_SUCCESS;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306808 if (pbkdf2->state != PSA_PBKDF2_STATE_SALT_SET) {
6809 return PSA_ERROR_BAD_STATE;
6810 }
6811
Kusumit Ghoderaof3e696d2023-07-28 13:30:50 +05306812#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306813 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
6814 psa_algorithm_t hash_alg = PSA_ALG_PBKDF2_HMAC_GET_HASH(kdf_alg);
6815 status = psa_pbkdf2_hmac_set_password(hash_alg, data, data_length,
6816 pbkdf2->password,
6817 &pbkdf2->password_length);
Kusumit Ghoderaof3e696d2023-07-28 13:30:50 +05306818 } else
6819#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC */
6820#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128)
6821 if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306822 status = psa_pbkdf2_cmac_set_password(data, data_length,
6823 pbkdf2->password,
6824 &pbkdf2->password_length);
Kusumit Ghoderaof3e696d2023-07-28 13:30:50 +05306825 } else
6826#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128 */
6827 {
6828 return PSA_ERROR_INVALID_ARGUMENT;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306829 }
6830
6831 pbkdf2->state = PSA_PBKDF2_STATE_PASSWORD_SET;
6832
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306833 return status;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306834}
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05306835
6836static psa_status_t psa_pbkdf2_input(psa_pbkdf2_key_derivation_t *pbkdf2,
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306837 psa_algorithm_t kdf_alg,
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05306838 psa_key_derivation_step_t step,
6839 const uint8_t *data,
6840 size_t data_length)
6841{
6842 switch (step) {
6843 case PSA_KEY_DERIVATION_INPUT_SALT:
6844 return psa_pbkdf2_set_salt(pbkdf2, data, data_length);
6845 case PSA_KEY_DERIVATION_INPUT_PASSWORD:
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306846 return psa_pbkdf2_set_password(pbkdf2, kdf_alg, data, data_length);
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05306847 default:
6848 return PSA_ERROR_INVALID_ARGUMENT;
6849 }
6850}
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306851#endif /* PSA_HAVE_SOFT_PBKDF2 */
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306852
Gilles Peskineb8965192019-09-24 16:21:10 +02006853/** Check whether the given key type is acceptable for the given
6854 * input step of a key derivation.
6855 *
6856 * Secret inputs must have the type #PSA_KEY_TYPE_DERIVE.
6857 * Non-secret inputs must have the type #PSA_KEY_TYPE_RAW_DATA.
6858 * Both secret and non-secret inputs can alternatively have the type
6859 * #PSA_KEY_TYPE_NONE, which is never the type of a key object, meaning
6860 * that the input was passed as a buffer rather than via a key object.
6861 */
Gilles Peskine224b0d62019-09-23 18:13:17 +02006862static int psa_key_derivation_check_input_type(
6863 psa_key_derivation_step_t step,
Gilles Peskine449bd832023-01-11 14:50:10 +01006864 psa_key_type_t key_type)
Gilles Peskine224b0d62019-09-23 18:13:17 +02006865{
Gilles Peskine449bd832023-01-11 14:50:10 +01006866 switch (step) {
Gilles Peskine224b0d62019-09-23 18:13:17 +02006867 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006868 if (key_type == PSA_KEY_TYPE_DERIVE) {
6869 return PSA_SUCCESS;
6870 }
6871 if (key_type == PSA_KEY_TYPE_NONE) {
6872 return PSA_SUCCESS;
6873 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02006874 break;
Przemek Stekiela7695a22022-04-07 15:39:01 +02006875 case PSA_KEY_DERIVATION_INPUT_OTHER_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006876 if (key_type == PSA_KEY_TYPE_DERIVE) {
6877 return PSA_SUCCESS;
6878 }
6879 if (key_type == PSA_KEY_TYPE_NONE) {
6880 return PSA_SUCCESS;
6881 }
Przemek Stekiela7695a22022-04-07 15:39:01 +02006882 break;
Gilles Peskine224b0d62019-09-23 18:13:17 +02006883 case PSA_KEY_DERIVATION_INPUT_LABEL:
6884 case PSA_KEY_DERIVATION_INPUT_SALT:
6885 case PSA_KEY_DERIVATION_INPUT_INFO:
6886 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskine449bd832023-01-11 14:50:10 +01006887 if (key_type == PSA_KEY_TYPE_RAW_DATA) {
6888 return PSA_SUCCESS;
6889 }
6890 if (key_type == PSA_KEY_TYPE_NONE) {
6891 return PSA_SUCCESS;
6892 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02006893 break;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306894 case PSA_KEY_DERIVATION_INPUT_PASSWORD:
6895 if (key_type == PSA_KEY_TYPE_PASSWORD) {
6896 return PSA_SUCCESS;
6897 }
6898 if (key_type == PSA_KEY_TYPE_DERIVE) {
6899 return PSA_SUCCESS;
6900 }
6901 if (key_type == PSA_KEY_TYPE_NONE) {
6902 return PSA_SUCCESS;
6903 }
6904 break;
Gilles Peskine224b0d62019-09-23 18:13:17 +02006905 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006906 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine224b0d62019-09-23 18:13:17 +02006907}
6908
Janos Follathb80a94e2019-06-12 15:54:46 +01006909static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006910 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01006911 psa_key_derivation_step_t step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02006912 psa_key_type_t key_type,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01006913 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006914 size_t data_length)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006915{
Gilles Peskine46d7faf2019-09-23 19:22:55 +02006916 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006917 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
Gilles Peskine46d7faf2019-09-23 19:22:55 +02006918
Gilles Peskine449bd832023-01-11 14:50:10 +01006919 status = psa_key_derivation_check_input_type(step, key_type);
6920 if (status != PSA_SUCCESS) {
Gilles Peskine224b0d62019-09-23 18:13:17 +02006921 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006922 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02006923
Przemek Stekiel69c46792022-06-10 12:59:51 +02006924#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006925 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
6926 status = psa_hkdf_input(&operation->ctx.hkdf, kdf_alg,
6927 step, data, data_length);
6928 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02006929#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08006930#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006931 if (PSA_ALG_IS_TLS12_PRF(kdf_alg)) {
6932 status = psa_tls12_prf_input(&operation->ctx.tls12_prf,
6933 step, data, data_length);
6934 } else
John Durkop07cc04a2020-11-16 22:08:34 -08006935#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF */
6936#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006937 if (PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
6938 status = psa_tls12_prf_psk_to_ms_input(&operation->ctx.tls12_prf,
6939 step, data, data_length);
6940 } else
John Durkop07cc04a2020-11-16 22:08:34 -08006941#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006942#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006943 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006944 status = psa_tls12_ecjpake_to_pms_input(
Gilles Peskine449bd832023-01-11 14:50:10 +01006945 &operation->ctx.tls12_ecjpake_to_pms, step, data, data_length);
6946 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006947#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306948#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05306949 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306950 status = psa_pbkdf2_input(&operation->ctx.pbkdf2, kdf_alg,
6951 step, data, data_length);
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05306952 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306953#endif /* PSA_HAVE_SOFT_PBKDF2 */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006954 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006955 /* This can't happen unless the operation object was not initialized */
Steven Cooreman74afe472021-02-10 17:19:22 +01006956 (void) data;
6957 (void) data_length;
6958 (void) kdf_alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01006959 return PSA_ERROR_BAD_STATE;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006960 }
6961
Gilles Peskine224b0d62019-09-23 18:13:17 +02006962exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01006963 if (status != PSA_SUCCESS) {
6964 psa_key_derivation_abort(operation);
6965 }
6966 return status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006967}
6968
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05306969static psa_status_t psa_key_derivation_input_integer_internal(
6970 psa_key_derivation_operation_t *operation,
6971 psa_key_derivation_step_t step,
6972 uint64_t value)
6973{
6974 psa_status_t status;
6975 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
6976
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306977#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05306978 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306979 status = psa_pbkdf2_set_input_cost(
6980 &operation->ctx.pbkdf2, step, value);
6981 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306982#endif /* PSA_HAVE_SOFT_PBKDF2 */
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05306983 {
Kusumit Ghoderao3a18dee2023-04-07 16:16:27 +05306984 (void) step;
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05306985 (void) value;
6986 (void) kdf_alg;
Kusumit Ghoderaoa14ae5a2023-04-19 14:16:26 +05306987 status = PSA_ERROR_INVALID_ARGUMENT;
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05306988 }
6989
6990 if (status != PSA_SUCCESS) {
6991 psa_key_derivation_abort(operation);
6992 }
6993 return status;
6994}
6995
Janos Follath51f4a0f2019-06-14 11:35:55 +01006996psa_status_t psa_key_derivation_input_bytes(
6997 psa_key_derivation_operation_t *operation,
6998 psa_key_derivation_step_t step,
6999 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01007000 size_t data_length)
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01007001{
Gilles Peskine449bd832023-01-11 14:50:10 +01007002 return psa_key_derivation_input_internal(operation, step,
7003 PSA_KEY_TYPE_NONE,
7004 data, data_length);
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01007005}
7006
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05307007psa_status_t psa_key_derivation_input_integer(
7008 psa_key_derivation_operation_t *operation,
7009 psa_key_derivation_step_t step,
7010 uint64_t value)
7011{
7012 return psa_key_derivation_input_integer_internal(operation, step, value);
7013}
7014
Janos Follath51f4a0f2019-06-14 11:35:55 +01007015psa_status_t psa_key_derivation_input_key(
7016 psa_key_derivation_operation_t *operation,
7017 psa_key_derivation_step_t step,
Gilles Peskine449bd832023-01-11 14:50:10 +01007018 mbedtls_svc_key_id_t key)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007019{
Ronald Cronf95a2b12020-10-22 15:24:49 +02007020 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01007021 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007022 psa_key_slot_t *slot;
Gilles Peskine178c9aa2019-09-24 18:21:06 +02007023
Ronald Cron5c522922020-11-14 16:35:34 +01007024 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01007025 key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg);
7026 if (status != PSA_SUCCESS) {
7027 psa_key_derivation_abort(operation);
7028 return status;
Gilles Peskine593773d2019-09-23 18:17:40 +02007029 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02007030
Kusumit Ghoderao3128c5d2023-05-03 12:27:57 +05307031 /* Passing a key object as a SECRET or PASSWORD input unlocks the
7032 * permission to output to a key object. */
7033 if (step == PSA_KEY_DERIVATION_INPUT_SECRET ||
7034 step == PSA_KEY_DERIVATION_INPUT_PASSWORD) {
Gilles Peskine178c9aa2019-09-24 18:21:06 +02007035 operation->can_output_key = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01007036 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02007037
Gilles Peskine449bd832023-01-11 14:50:10 +01007038 status = psa_key_derivation_input_internal(operation,
7039 step, slot->attr.type,
7040 slot->key.data,
7041 slot->key.bytes);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007042
Ryan Everett1b70a072024-01-04 10:32:49 +00007043 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007044
Gilles Peskine449bd832023-01-11 14:50:10 +01007045 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007046}
Gilles Peskineea0fb492018-07-12 17:17:20 +02007047
7048
7049
7050/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02007051/* Key agreement */
7052/****************************************************************/
7053
Gilles Peskine449bd832023-01-11 14:50:10 +01007054psa_status_t psa_key_agreement_raw_builtin(const psa_key_attributes_t *attributes,
7055 const uint8_t *key_buffer,
7056 size_t key_buffer_size,
7057 psa_algorithm_t alg,
7058 const uint8_t *peer_key,
7059 size_t peer_key_length,
7060 uint8_t *shared_secret,
7061 size_t shared_secret_size,
7062 size_t *shared_secret_length)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02007063{
Gilles Peskine449bd832023-01-11 14:50:10 +01007064 switch (alg) {
John Durkop6ba40d12020-11-10 08:50:04 -08007065#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskine0216fe12019-04-11 21:23:21 +02007066 case PSA_ALG_ECDH:
Gilles Peskine449bd832023-01-11 14:50:10 +01007067 return mbedtls_psa_key_agreement_ecdh(attributes, key_buffer,
7068 key_buffer_size, alg,
7069 peer_key, peer_key_length,
7070 shared_secret,
7071 shared_secret_size,
7072 shared_secret_length);
Gilles Peskine01d718c2018-09-18 12:01:02 +02007073#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Przemek Stekielfb3dd542022-12-01 14:59:15 +01007074
7075#if defined(MBEDTLS_PSA_BUILTIN_ALG_FFDH)
7076 case PSA_ALG_FFDH:
Przemek Stekiel152bb462023-06-01 11:52:39 +02007077 return mbedtls_psa_ffdh_key_agreement(attributes,
Przemek Stekiel359f4622022-12-05 14:11:55 +01007078 peer_key,
7079 peer_key_length,
7080 key_buffer,
7081 key_buffer_size,
7082 shared_secret,
7083 shared_secret_size,
7084 shared_secret_length);
Przemek Stekielfb3dd542022-12-01 14:59:15 +01007085#endif /* MBEDTLS_PSA_BUILTIN_ALG_FFDH */
7086
Gilles Peskine01d718c2018-09-18 12:01:02 +02007087 default:
Aditya Deshpande17845b82022-10-13 17:21:01 +01007088 (void) attributes;
7089 (void) key_buffer;
7090 (void) key_buffer_size;
Gilles Peskine93f85002018-11-16 16:43:31 +01007091 (void) peer_key;
7092 (void) peer_key_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02007093 (void) shared_secret;
7094 (void) shared_secret_size;
7095 (void) shared_secret_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01007096 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine01d718c2018-09-18 12:01:02 +02007097 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02007098}
Gilles Peskine01d718c2018-09-18 12:01:02 +02007099
Aditya Deshpande17845b82022-10-13 17:21:01 +01007100/** Internal function for raw key agreement
7101 * Calls the driver wrapper which will hand off key agreement task
Aditya Deshpande40c05cc2022-10-14 16:41:40 +01007102 * to the driver's implementation if a driver is present.
7103 * Fallback specified in the driver wrapper is built-in raw key agreement
Aditya Deshpande17845b82022-10-13 17:21:01 +01007104 * (psa_key_agreement_raw_builtin).
7105 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007106static psa_status_t psa_key_agreement_raw_internal(psa_algorithm_t alg,
7107 psa_key_slot_t *private_key,
7108 const uint8_t *peer_key,
7109 size_t peer_key_length,
7110 uint8_t *shared_secret,
7111 size_t shared_secret_size,
7112 size_t *shared_secret_length)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02007113{
Gilles Peskine449bd832023-01-11 14:50:10 +01007114 if (!PSA_ALG_IS_RAW_KEY_AGREEMENT(alg)) {
7115 return PSA_ERROR_NOT_SUPPORTED;
7116 }
Aditya Deshpande17845b82022-10-13 17:21:01 +01007117
7118 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01007119 .core = private_key->attr
Aditya Deshpande17845b82022-10-13 17:21:01 +01007120 };
7121
Gilles Peskine449bd832023-01-11 14:50:10 +01007122 return psa_driver_wrapper_key_agreement(&attributes,
7123 private_key->key.data,
7124 private_key->key.bytes, alg,
7125 peer_key, peer_key_length,
7126 shared_secret,
7127 shared_secret_size,
7128 shared_secret_length);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007129}
7130
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02007131/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine01d718c2018-09-18 12:01:02 +02007132 * to potentially free embedded data structures and wipe confidential data.
7133 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007134static psa_status_t psa_key_agreement_internal(psa_key_derivation_operation_t *operation,
7135 psa_key_derivation_step_t step,
7136 psa_key_slot_t *private_key,
7137 const uint8_t *peer_key,
7138 size_t peer_key_length)
Gilles Peskine01d718c2018-09-18 12:01:02 +02007139{
7140 psa_status_t status;
Aditya Deshpande2f7fd762022-11-22 11:10:34 +00007141 uint8_t shared_secret[PSA_RAW_KEY_AGREEMENT_OUTPUT_MAX_SIZE];
Gilles Peskine01d718c2018-09-18 12:01:02 +02007142 size_t shared_secret_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007143 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE(operation->alg);
Gilles Peskine01d718c2018-09-18 12:01:02 +02007144
7145 /* Step 1: run the secret agreement algorithm to generate the shared
7146 * secret. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007147 status = psa_key_agreement_raw_internal(ka_alg,
7148 private_key,
7149 peer_key, peer_key_length,
7150 shared_secret,
7151 sizeof(shared_secret),
7152 &shared_secret_length);
7153 if (status != PSA_SUCCESS) {
Gilles Peskine12313cd2018-06-20 00:20:32 +02007154 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007155 }
Gilles Peskine12313cd2018-06-20 00:20:32 +02007156
Gilles Peskineb0b255c2018-07-06 17:01:38 +02007157 /* Step 2: set up the key derivation to generate key material from
Gilles Peskine224b0d62019-09-23 18:13:17 +02007158 * the shared secret. A shared secret is permitted wherever a key
7159 * of type DERIVE is permitted. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007160 status = psa_key_derivation_input_internal(operation, step,
7161 PSA_KEY_TYPE_DERIVE,
7162 shared_secret,
7163 shared_secret_length);
Gilles Peskine12313cd2018-06-20 00:20:32 +02007164exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007165 mbedtls_platform_zeroize(shared_secret, shared_secret_length);
7166 return status;
Gilles Peskine12313cd2018-06-20 00:20:32 +02007167}
7168
Gilles Peskine449bd832023-01-11 14:50:10 +01007169psa_status_t psa_key_derivation_key_agreement(psa_key_derivation_operation_t *operation,
7170 psa_key_derivation_step_t step,
7171 mbedtls_svc_key_id_t private_key,
7172 const uint8_t *peer_key,
7173 size_t peer_key_length)
Gilles Peskine12313cd2018-06-20 00:20:32 +02007174{
Ronald Cronf95a2b12020-10-22 15:24:49 +02007175 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01007176 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01007177 psa_key_slot_t *slot;
Ronald Cronf95a2b12020-10-22 15:24:49 +02007178
Gilles Peskine449bd832023-01-11 14:50:10 +01007179 if (!PSA_ALG_IS_KEY_AGREEMENT(operation->alg)) {
7180 return PSA_ERROR_INVALID_ARGUMENT;
7181 }
Ronald Cron5c522922020-11-14 16:35:34 +01007182 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01007183 private_key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg);
7184 if (status != PSA_SUCCESS) {
7185 return status;
7186 }
7187 status = psa_key_agreement_internal(operation, step,
7188 slot,
7189 peer_key, peer_key_length);
7190 if (status != PSA_SUCCESS) {
7191 psa_key_derivation_abort(operation);
7192 } else {
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007193 /* If a private key has been added as SECRET, we allow the derived
7194 * key material to be used as a key in PSA Crypto. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007195 if (step == PSA_KEY_DERIVATION_INPUT_SECRET) {
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007196 operation->can_output_key = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01007197 }
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007198 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007199
Ryan Everett1b70a072024-01-04 10:32:49 +00007200 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007201
Gilles Peskine449bd832023-01-11 14:50:10 +01007202 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskineaf3baab2018-06-27 22:55:52 +02007203}
7204
Gilles Peskine449bd832023-01-11 14:50:10 +01007205psa_status_t psa_raw_key_agreement(psa_algorithm_t alg,
7206 mbedtls_svc_key_id_t private_key,
7207 const uint8_t *peer_key,
7208 size_t peer_key_length,
7209 uint8_t *output,
7210 size_t output_size,
7211 size_t *output_length)
Gilles Peskine0216fe12019-04-11 21:23:21 +02007212{
Ronald Cronf95a2b12020-10-22 15:24:49 +02007213 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01007214 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +02007215 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007216 size_t expected_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02007217
Gilles Peskine449bd832023-01-11 14:50:10 +01007218 if (!PSA_ALG_IS_KEY_AGREEMENT(alg)) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007219 status = PSA_ERROR_INVALID_ARGUMENT;
7220 goto exit;
7221 }
Ronald Cron5c522922020-11-14 16:35:34 +01007222 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01007223 private_key, &slot, PSA_KEY_USAGE_DERIVE, alg);
7224 if (status != PSA_SUCCESS) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007225 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007226 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02007227
Gilles Peskine3e561302022-04-14 00:17:15 +02007228 /* PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() is in general an upper bound
7229 * for the output size. The PSA specification only guarantees that this
7230 * function works if output_size >= PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE(...),
7231 * but it might be nice to allow smaller buffers if the output fits.
7232 * At the time of writing this comment, with only ECDH implemented,
7233 * PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() is exact so the point is moot.
7234 * If FFDH is implemented, PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() can easily
7235 * be exact for it as well. */
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007236 expected_length =
Gilles Peskine449bd832023-01-11 14:50:10 +01007237 PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE(slot->attr.type, slot->attr.bits);
7238 if (output_size < expected_length) {
Gilles Peskine3e561302022-04-14 00:17:15 +02007239 status = PSA_ERROR_BUFFER_TOO_SMALL;
7240 goto exit;
7241 }
7242
Gilles Peskine449bd832023-01-11 14:50:10 +01007243 status = psa_key_agreement_raw_internal(alg, slot,
7244 peer_key, peer_key_length,
7245 output, output_size,
7246 output_length);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007247
7248exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007249 if (status != PSA_SUCCESS) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007250 /* If an error happens and is not handled properly, the output
7251 * may be used as a key to protect sensitive data. Arrange for such
7252 * a key to be random, which is likely to result in decryption or
7253 * verification errors. This is better than filling the buffer with
7254 * some constant data such as zeros, which would result in the data
7255 * being protected with a reproducible, easily knowable key.
7256 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007257 psa_generate_random(output, output_size);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007258 *output_length = output_size;
7259 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007260
Ryan Everett1b70a072024-01-04 10:32:49 +00007261 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007262
Gilles Peskine449bd832023-01-11 14:50:10 +01007263 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine0216fe12019-04-11 21:23:21 +02007264}
Gilles Peskine86a440b2018-11-12 18:39:40 +01007265
7266
Gilles Peskine30524eb2020-11-13 17:02:26 +01007267
Gilles Peskine86a440b2018-11-12 18:39:40 +01007268/****************************************************************/
7269/* Random generation */
Gilles Peskine53d991e2018-07-12 01:14:59 +02007270/****************************************************************/
Gilles Peskine12313cd2018-06-20 00:20:32 +02007271
Gilles Peskine672a7712023-04-28 21:00:28 +02007272#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
7273#include "entropy_poll.h"
7274#endif
7275
Gilles Peskine30524eb2020-11-13 17:02:26 +01007276/** Initialize the PSA random generator.
7277 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007278static void mbedtls_psa_random_init(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01007279{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007280#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine449bd832023-01-11 14:50:10 +01007281 memset(rng, 0, sizeof(*rng));
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007282#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
7283
Gilles Peskine30524eb2020-11-13 17:02:26 +01007284 /* Set default configuration if
7285 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007286 if (rng->entropy_init == NULL) {
Gilles Peskine30524eb2020-11-13 17:02:26 +01007287 rng->entropy_init = mbedtls_entropy_init;
Gilles Peskine449bd832023-01-11 14:50:10 +01007288 }
7289 if (rng->entropy_free == NULL) {
Gilles Peskine30524eb2020-11-13 17:02:26 +01007290 rng->entropy_free = mbedtls_entropy_free;
Gilles Peskine449bd832023-01-11 14:50:10 +01007291 }
Gilles Peskine30524eb2020-11-13 17:02:26 +01007292
Gilles Peskine449bd832023-01-11 14:50:10 +01007293 rng->entropy_init(&rng->entropy);
Gilles Peskine30524eb2020-11-13 17:02:26 +01007294#if defined(MBEDTLS_PSA_INJECT_ENTROPY) && \
7295 defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
7296 /* The PSA entropy injection feature depends on using NV seed as an entropy
7297 * source. Add NV seed as an entropy source for PSA entropy injection. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007298 mbedtls_entropy_add_source(&rng->entropy,
7299 mbedtls_nv_seed_poll, NULL,
7300 MBEDTLS_ENTROPY_BLOCK_SIZE,
7301 MBEDTLS_ENTROPY_SOURCE_STRONG);
Gilles Peskine30524eb2020-11-13 17:02:26 +01007302#endif
7303
Gilles Peskine449bd832023-01-11 14:50:10 +01007304 mbedtls_psa_drbg_init(MBEDTLS_PSA_RANDOM_STATE);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007305#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007306}
7307
7308/** Deinitialize the PSA random generator.
7309 */
Valerio Setti83e0de82023-11-24 12:13:05 +01007310static void mbedtls_psa_random_free(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01007311{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007312#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Valerio Setti83e0de82023-11-24 12:13:05 +01007313 memset(rng, 0, sizeof(*rng));
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007314#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Valerio Setti83e0de82023-11-24 12:13:05 +01007315 mbedtls_psa_drbg_free(MBEDTLS_PSA_RANDOM_STATE);
7316 rng->entropy_free(&rng->entropy);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007317#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007318}
7319
7320/** Seed the PSA random generator.
7321 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007322static psa_status_t mbedtls_psa_random_seed(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01007323{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007324#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
7325 /* Do nothing: the external RNG seeds itself. */
7326 (void) rng;
Gilles Peskine449bd832023-01-11 14:50:10 +01007327 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007328#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007329 const unsigned char drbg_seed[] = "PSA";
Gilles Peskine449bd832023-01-11 14:50:10 +01007330 int ret = mbedtls_psa_drbg_seed(&rng->entropy,
7331 drbg_seed, sizeof(drbg_seed) - 1);
7332 return mbedtls_to_psa_error(ret);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007333#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007334}
7335
Gilles Peskine449bd832023-01-11 14:50:10 +01007336psa_status_t psa_generate_random(uint8_t *output,
7337 size_t output_size)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007338{
Gilles Peskinee59236f2018-01-27 23:32:46 +01007339 GUARD_MODULE_INITIALIZED;
7340
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007341#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
7342
7343 size_t output_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007344 psa_status_t status = mbedtls_psa_external_get_random(&global_data.rng,
7345 output, output_size,
7346 &output_length);
7347 if (status != PSA_SUCCESS) {
7348 return status;
7349 }
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007350 /* Breaking up a request into smaller chunks is currently not supported
Tom Cosgrove1797b052022-12-04 17:19:59 +00007351 * for the external RNG interface. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007352 if (output_length != output_size) {
7353 return PSA_ERROR_INSUFFICIENT_ENTROPY;
7354 }
7355 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007356
7357#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
7358
Gilles Peskine449bd832023-01-11 14:50:10 +01007359 while (output_size > 0) {
Gilles Peskine71ddab92021-01-04 21:01:07 +01007360 size_t request_size =
Gilles Peskine449bd832023-01-11 14:50:10 +01007361 (output_size > MBEDTLS_PSA_RANDOM_MAX_REQUEST ?
7362 MBEDTLS_PSA_RANDOM_MAX_REQUEST :
7363 output_size);
7364 int ret = mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE,
7365 output, request_size);
7366 if (ret != 0) {
7367 return mbedtls_to_psa_error(ret);
7368 }
Gilles Peskine71ddab92021-01-04 21:01:07 +01007369 output_size -= request_size;
7370 output += request_size;
Gilles Peskinef181eca2019-08-07 13:49:00 +02007371 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007372 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007373#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskinee59236f2018-01-27 23:32:46 +01007374}
7375
Gilles Peskine8814fc42020-12-14 15:33:44 +01007376/* Wrapper function allowing the classic API to use the PSA RNG.
Gilles Peskine9c3e0602021-01-05 16:03:55 +01007377 *
7378 * `mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE, ...)` calls
7379 * `psa_generate_random(...)`. The state parameter is ignored since the
7380 * PSA API doesn't support passing an explicit state.
7381 *
7382 * In the non-external case, psa_generate_random() calls an
7383 * `mbedtls_xxx_drbg_random` function which has exactly the same signature
7384 * and semantics as mbedtls_psa_get_random(). As an optimization,
7385 * instead of doing this back-and-forth between the PSA API and the
7386 * classic API, psa_crypto_random_impl.h defines `mbedtls_psa_get_random`
7387 * as a constant function pointer to `mbedtls_xxx_drbg_random`.
Gilles Peskine8814fc42020-12-14 15:33:44 +01007388 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007389#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
7390int mbedtls_psa_get_random(void *p_rng,
7391 unsigned char *output,
7392 size_t output_size)
Gilles Peskine8814fc42020-12-14 15:33:44 +01007393{
Gilles Peskine9c3e0602021-01-05 16:03:55 +01007394 /* This function takes a pointer to the RNG state because that's what
7395 * classic mbedtls functions using an RNG expect. The PSA RNG manages
7396 * its own state internally and doesn't let the caller access that state.
7397 * So we just ignore the state parameter, and in practice we'll pass
7398 * NULL. */
Gilles Peskine8814fc42020-12-14 15:33:44 +01007399 (void) p_rng;
Gilles Peskine449bd832023-01-11 14:50:10 +01007400 psa_status_t status = psa_generate_random(output, output_size);
7401 if (status == PSA_SUCCESS) {
7402 return 0;
7403 } else {
7404 return MBEDTLS_ERR_ENTROPY_SOURCE_FAILED;
7405 }
Gilles Peskine8814fc42020-12-14 15:33:44 +01007406}
7407#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
7408
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01007409#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
Gilles Peskine449bd832023-01-11 14:50:10 +01007410psa_status_t mbedtls_psa_inject_entropy(const uint8_t *seed,
7411 size_t seed_size)
Netanel Gonen2bcd3122018-11-19 11:53:02 +02007412{
Gilles Peskine449bd832023-01-11 14:50:10 +01007413 if (global_data.initialized) {
7414 return PSA_ERROR_NOT_PERMITTED;
7415 }
Netanel Gonen21f37cb2018-11-19 11:53:55 +02007416
Gilles Peskine449bd832023-01-11 14:50:10 +01007417 if (((seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM) ||
7418 (seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE)) ||
7419 (seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE)) {
7420 return PSA_ERROR_INVALID_ARGUMENT;
7421 }
Netanel Gonen21f37cb2018-11-19 11:53:55 +02007422
Gilles Peskine449bd832023-01-11 14:50:10 +01007423 return mbedtls_psa_storage_inject_entropy(seed, seed_size);
Netanel Gonen2bcd3122018-11-19 11:53:02 +02007424}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01007425#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02007426
Ronald Cron3772afe2021-02-08 16:10:05 +01007427/** Validate the key type and size for key generation
Ronald Cron01b2aba2020-10-05 09:42:02 +02007428 *
Ronald Cron3772afe2021-02-08 16:10:05 +01007429 * \param type The key type
7430 * \param bits The number of bits of the key
Ronald Cron01b2aba2020-10-05 09:42:02 +02007431 *
7432 * \retval #PSA_SUCCESS
Ronald Cron3772afe2021-02-08 16:10:05 +01007433 * The key type and size are valid.
Ronald Cron01b2aba2020-10-05 09:42:02 +02007434 * \retval #PSA_ERROR_INVALID_ARGUMENT
7435 * The size in bits of the key is not valid.
7436 * \retval #PSA_ERROR_NOT_SUPPORTED
7437 * The type and/or the size in bits of the key or the combination of
7438 * the two is not supported.
7439 */
Ronald Cron3772afe2021-02-08 16:10:05 +01007440static psa_status_t psa_validate_key_type_and_size_for_key_generation(
Gilles Peskine449bd832023-01-11 14:50:10 +01007441 psa_key_type_t type, size_t bits)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007442{
Ronald Cronf3bb7612020-10-02 20:11:59 +02007443 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007444
Gilles Peskine449bd832023-01-11 14:50:10 +01007445 if (key_type_is_raw_bytes(type)) {
7446 status = psa_validate_unstructured_key_bit_size(type, bits);
7447 if (status != PSA_SUCCESS) {
7448 return status;
7449 }
7450 } else
Valerio Settif6d4dfb2023-07-10 10:55:12 +02007451#if defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007452 if (PSA_KEY_TYPE_IS_RSA(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
7453 if (bits > PSA_VENDOR_RSA_MAX_KEY_BITS) {
7454 return PSA_ERROR_NOT_SUPPORTED;
7455 }
Waleed Elmelegyd7bdbbe2023-07-20 16:26:58 +00007456 if (bits < PSA_VENDOR_RSA_GENERATE_MIN_KEY_BITS) {
Waleed Elmelegyab570712023-07-05 16:40:58 +00007457 return PSA_ERROR_NOT_SUPPORTED;
7458 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +02007459
Ronald Cron01b2aba2020-10-05 09:42:02 +02007460 /* Accept only byte-aligned keys, for the same reasons as
7461 * in psa_import_rsa_key(). */
Gilles Peskine449bd832023-01-11 14:50:10 +01007462 if (bits % 8 != 0) {
7463 return PSA_ERROR_NOT_SUPPORTED;
7464 }
7465 } else
Valerio Settif6d4dfb2023-07-10 10:55:12 +02007466#endif /* defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02007467
Valerio Setti6a9d0ee2023-06-21 10:07:21 +02007468#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007469 if (PSA_KEY_TYPE_IS_ECC(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
Ronald Crond81ab562021-02-16 09:01:16 +01007470 /* To avoid empty block, return successfully here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007471 return PSA_SUCCESS;
7472 } else
Valerio Setti6a9d0ee2023-06-21 10:07:21 +02007473#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_GENERATE) */
Przemek Stekielfedd1342022-12-01 15:00:02 +01007474
Valerio Settia55f0422023-07-10 15:34:41 +02007475#if defined(PSA_WANT_KEY_TYPE_DH_KEY_PAIR_GENERATE)
Przemek Stekielfedd1342022-12-01 15:00:02 +01007476 if (PSA_KEY_TYPE_IS_DH(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
Przemek Stekield1cf1ba2023-04-27 12:04:21 +02007477 if (psa_is_dh_key_size_valid(bits) == 0) {
Przemek Stekielfedd1342022-12-01 15:00:02 +01007478 return PSA_ERROR_NOT_SUPPORTED;
7479 }
7480 } else
Valerio Settia55f0422023-07-10 15:34:41 +02007481#endif /* defined(PSA_WANT_KEY_TYPE_DH_KEY_PAIR_GENERATE) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02007482 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007483 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007484 }
7485
Gilles Peskine449bd832023-01-11 14:50:10 +01007486 return PSA_SUCCESS;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007487}
7488
Ronald Cron55ed0592020-10-05 10:30:40 +02007489psa_status_t psa_generate_key_internal(
Ronald Cron2a38a6b2020-10-02 20:02:04 +02007490 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01007491 uint8_t *key_buffer, size_t key_buffer_size, size_t *key_buffer_length)
Ronald Cron01b2aba2020-10-05 09:42:02 +02007492{
7493 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2a38a6b2020-10-02 20:02:04 +02007494 psa_key_type_t type = attributes->core.type;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007495
Gilles Peskine449bd832023-01-11 14:50:10 +01007496 if ((attributes->domain_parameters == NULL) &&
7497 (attributes->domain_parameters_size != 0)) {
7498 return PSA_ERROR_INVALID_ARGUMENT;
7499 }
Ronald Cron01b2aba2020-10-05 09:42:02 +02007500
Gilles Peskine449bd832023-01-11 14:50:10 +01007501 if (key_type_is_raw_bytes(type)) {
7502 status = psa_generate_random(key_buffer, key_buffer_size);
7503 if (status != PSA_SUCCESS) {
7504 return status;
7505 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +02007506
David Brown12ca5032021-02-11 11:02:00 -07007507#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01007508 if (type == PSA_KEY_TYPE_DES) {
7509 psa_des_set_key_parity(key_buffer, key_buffer_size);
7510 }
David Brown8107e312021-02-12 08:08:46 -07007511#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine449bd832023-01-11 14:50:10 +01007512 } else
Gilles Peskinee59236f2018-01-27 23:32:46 +01007513
Valerio Setti76df8c12023-07-11 14:11:28 +02007514#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007515 if (type == PSA_KEY_TYPE_RSA_KEY_PAIR) {
7516 return mbedtls_psa_rsa_generate_key(attributes,
7517 key_buffer,
7518 key_buffer_size,
7519 key_buffer_length);
7520 } else
Valerio Setti76df8c12023-07-11 14:11:28 +02007521#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_GENERATE) */
Gilles Peskinee59236f2018-01-27 23:32:46 +01007522
Valerio Settibfeaf5b2023-06-20 13:27:46 +02007523#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007524 if (PSA_KEY_TYPE_IS_ECC(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
7525 return mbedtls_psa_ecp_generate_key(attributes,
7526 key_buffer,
7527 key_buffer_size,
7528 key_buffer_length);
7529 } else
Valerio Settibfeaf5b2023-06-20 13:27:46 +02007530#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_GENERATE) */
Przemek Stekielfedd1342022-12-01 15:00:02 +01007531
Valerio Settia55f0422023-07-10 15:34:41 +02007532#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_GENERATE)
Przemek Stekielfedd1342022-12-01 15:00:02 +01007533 if (PSA_KEY_TYPE_IS_DH(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
7534 return mbedtls_psa_ffdh_generate_key(attributes,
7535 key_buffer,
7536 key_buffer_size,
7537 key_buffer_length);
7538 } else
Valerio Settia55f0422023-07-10 15:34:41 +02007539#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_GENERATE) */
Steven Cooreman29149862020-08-05 15:43:42 +02007540 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007541 (void) key_buffer_length;
7542 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman29149862020-08-05 15:43:42 +02007543 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01007544
Gilles Peskine449bd832023-01-11 14:50:10 +01007545 return PSA_SUCCESS;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02007546}
Darryl Green0c6575a2018-11-07 16:05:30 +00007547
Gilles Peskine449bd832023-01-11 14:50:10 +01007548psa_status_t psa_generate_key(const psa_key_attributes_t *attributes,
7549 mbedtls_svc_key_id_t *key)
Gilles Peskineff5f0e72019-04-18 12:53:30 +02007550{
7551 psa_status_t status;
7552 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02007553 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cron2b56bc82020-10-05 10:02:26 +02007554 size_t key_buffer_size;
Gilles Peskine11792082019-08-06 18:36:36 +02007555
Ronald Cron81709fc2020-11-14 12:10:32 +01007556 *key = MBEDTLS_SVC_KEY_ID_INIT;
7557
Gilles Peskine0f84d622019-09-12 19:03:13 +02007558 /* Reject any attempt to create a zero-length key so that we don't
7559 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007560 if (psa_get_key_bits(attributes) == 0) {
7561 return PSA_ERROR_INVALID_ARGUMENT;
7562 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02007563
Przemyslaw Stekielc0fe8202021-10-07 11:08:56 +02007564 /* Reject any attempt to create a public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007565 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(attributes->core.type)) {
7566 return PSA_ERROR_INVALID_ARGUMENT;
7567 }
Przemyslaw Stekielc0fe8202021-10-07 11:08:56 +02007568
Gilles Peskine449bd832023-01-11 14:50:10 +01007569 status = psa_start_key_creation(PSA_KEY_CREATION_GENERATE, attributes,
7570 &slot, &driver);
7571 if (status != PSA_SUCCESS) {
Gilles Peskine11792082019-08-06 18:36:36 +02007572 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007573 }
Gilles Peskine11792082019-08-06 18:36:36 +02007574
Ronald Cron977c2472020-10-13 08:32:21 +02007575 /* In the case of a transparent key or an opaque key stored in local
Archana449608b2021-09-08 15:36:05 +05307576 * storage ( thus not in the case of generating a key in a secure element
7577 * with storage ( MBEDTLS_PSA_CRYPTO_SE_C ) ),we have to allocate a
7578 * buffer to hold the generated key material. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007579 if (slot->key.data == NULL) {
7580 if (PSA_KEY_LIFETIME_GET_LOCATION(attributes->core.lifetime) ==
7581 PSA_KEY_LOCATION_LOCAL_STORAGE) {
Ronald Cron3772afe2021-02-08 16:10:05 +01007582 status = psa_validate_key_type_and_size_for_key_generation(
Gilles Peskine449bd832023-01-11 14:50:10 +01007583 attributes->core.type, attributes->core.bits);
7584 if (status != PSA_SUCCESS) {
Ronald Cron3772afe2021-02-08 16:10:05 +01007585 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007586 }
Ronald Cron3772afe2021-02-08 16:10:05 +01007587
7588 key_buffer_size = PSA_EXPORT_KEY_OUTPUT_SIZE(
Gilles Peskine449bd832023-01-11 14:50:10 +01007589 attributes->core.type,
7590 attributes->core.bits);
7591 } else {
Ronald Cron977c2472020-10-13 08:32:21 +02007592 status = psa_driver_wrapper_get_key_buffer_size(
Gilles Peskine449bd832023-01-11 14:50:10 +01007593 attributes, &key_buffer_size);
7594 if (status != PSA_SUCCESS) {
Ronald Cron3772afe2021-02-08 16:10:05 +01007595 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007596 }
Ronald Cron977c2472020-10-13 08:32:21 +02007597 }
Ronald Cron977c2472020-10-13 08:32:21 +02007598
Gilles Peskine449bd832023-01-11 14:50:10 +01007599 status = psa_allocate_buffer_to_slot(slot, key_buffer_size);
7600 if (status != PSA_SUCCESS) {
Ronald Cron977c2472020-10-13 08:32:21 +02007601 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007602 }
Ronald Cron977c2472020-10-13 08:32:21 +02007603 }
7604
Gilles Peskine449bd832023-01-11 14:50:10 +01007605 status = psa_driver_wrapper_generate_key(attributes,
7606 slot->key.data, slot->key.bytes, &slot->key.bytes);
Gilles Peskine11792082019-08-06 18:36:36 +02007607
Gilles Peskine449bd832023-01-11 14:50:10 +01007608 if (status != PSA_SUCCESS) {
7609 psa_remove_key_data_from_memory(slot);
7610 }
Ronald Cron2b56bc82020-10-05 10:02:26 +02007611
Gilles Peskine11792082019-08-06 18:36:36 +02007612exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007613 if (status == PSA_SUCCESS) {
7614 status = psa_finish_key_creation(slot, driver, key);
7615 }
7616 if (status != PSA_SUCCESS) {
7617 psa_fail_key_creation(slot, driver);
7618 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007619
Gilles Peskine449bd832023-01-11 14:50:10 +01007620 return status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007621}
7622
Gilles Peskinee59236f2018-01-27 23:32:46 +01007623/****************************************************************/
7624/* Module setup */
7625/****************************************************************/
7626
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007627#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine5e769522018-11-20 21:59:56 +01007628psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
Gilles Peskine449bd832023-01-11 14:50:10 +01007629 void (* entropy_init)(mbedtls_entropy_context *ctx),
7630 void (* entropy_free)(mbedtls_entropy_context *ctx))
Gilles Peskine5e769522018-11-20 21:59:56 +01007631{
Gilles Peskine449bd832023-01-11 14:50:10 +01007632 if (global_data.rng_state != RNG_NOT_INITIALIZED) {
7633 return PSA_ERROR_BAD_STATE;
7634 }
Gilles Peskine30524eb2020-11-13 17:02:26 +01007635 global_data.rng.entropy_init = entropy_init;
7636 global_data.rng.entropy_free = entropy_free;
Gilles Peskine449bd832023-01-11 14:50:10 +01007637 return PSA_SUCCESS;
Gilles Peskine5e769522018-11-20 21:59:56 +01007638}
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007639#endif /* !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) */
Gilles Peskine5e769522018-11-20 21:59:56 +01007640
Gilles Peskine449bd832023-01-11 14:50:10 +01007641void mbedtls_psa_crypto_free(void)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007642{
Gilles Peskine449bd832023-01-11 14:50:10 +01007643 psa_wipe_all_key_slots();
Valerio Setti83e0de82023-11-24 12:13:05 +01007644 if (global_data.rng_state != RNG_NOT_INITIALIZED) {
7645 mbedtls_psa_random_free(&global_data.rng);
7646 }
Gilles Peskinec6b69072018-11-20 21:42:52 +01007647 /* Wipe all remaining data, including configuration.
7648 * In particular, this sets all state indicator to the value
7649 * indicating "uninitialized". */
Gilles Peskine449bd832023-01-11 14:50:10 +01007650 mbedtls_platform_zeroize(&global_data, sizeof(global_data));
Ronald Cron9ba76912021-04-10 16:57:30 +02007651
7652 /* Terminate drivers */
Gilles Peskine449bd832023-01-11 14:50:10 +01007653 psa_driver_wrapper_free();
Gilles Peskinee59236f2018-01-27 23:32:46 +01007654}
7655
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007656#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
7657/** Recover a transaction that was interrupted by a power failure.
7658 *
7659 * This function is called during initialization, before psa_crypto_init()
7660 * returns. If this function returns a failure status, the initialization
7661 * fails.
7662 */
7663static psa_status_t psa_crypto_recover_transaction(
Gilles Peskine449bd832023-01-11 14:50:10 +01007664 const psa_crypto_transaction_t *transaction)
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007665{
Gilles Peskine449bd832023-01-11 14:50:10 +01007666 switch (transaction->unknown.type) {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007667 case PSA_CRYPTO_TRANSACTION_CREATE_KEY:
7668 case PSA_CRYPTO_TRANSACTION_DESTROY_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01007669 /* TODO - fall through to the failure case until this
7670 * is implemented.
7671 * https://github.com/ARMmbed/mbed-crypto/issues/218
7672 */
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007673 default:
7674 /* We found an unsupported transaction in the storage.
7675 * We don't know what state the storage is in. Give up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007676 return PSA_ERROR_DATA_INVALID;
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007677 }
7678}
7679#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
7680
Gilles Peskine449bd832023-01-11 14:50:10 +01007681psa_status_t psa_crypto_init(void)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007682{
Gilles Peskine66fb1262018-12-10 16:29:04 +01007683 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007684
Gilles Peskinec6b69072018-11-20 21:42:52 +01007685 /* Double initialization is explicitly allowed. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007686 if (global_data.initialized != 0) {
7687 return PSA_SUCCESS;
7688 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01007689
Manuel Pégourié-Gonnard7abdf7e2023-03-09 11:17:43 +01007690 /* Init drivers */
7691 status = psa_driver_wrapper_init();
7692 if (status != PSA_SUCCESS) {
7693 goto exit;
7694 }
7695 global_data.drivers_initialized = 1;
7696
Valerio Setti402cfba2023-11-13 10:24:32 +01007697 status = psa_initialize_key_slots();
7698 if (status != PSA_SUCCESS) {
7699 goto exit;
7700 }
7701
Gilles Peskine30524eb2020-11-13 17:02:26 +01007702 /* Initialize and seed the random generator. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007703 mbedtls_psa_random_init(&global_data.rng);
Gilles Peskinec6b69072018-11-20 21:42:52 +01007704 global_data.rng_state = RNG_INITIALIZED;
Gilles Peskine449bd832023-01-11 14:50:10 +01007705 status = mbedtls_psa_random_seed(&global_data.rng);
7706 if (status != PSA_SUCCESS) {
Gilles Peskinee59236f2018-01-27 23:32:46 +01007707 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007708 }
Gilles Peskinec6b69072018-11-20 21:42:52 +01007709 global_data.rng_state = RNG_SEEDED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007710
Gilles Peskine4b734222019-07-24 15:56:31 +02007711#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007712 status = psa_crypto_load_transaction();
7713 if (status == PSA_SUCCESS) {
7714 status = psa_crypto_recover_transaction(&psa_crypto_transaction);
7715 if (status != PSA_SUCCESS) {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007716 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007717 }
7718 status = psa_crypto_stop_transaction();
7719 } else if (status == PSA_ERROR_DOES_NOT_EXIST) {
Gilles Peskinefc762652019-07-22 19:30:34 +02007720 /* There's no transaction to complete. It's all good. */
7721 status = PSA_SUCCESS;
7722 }
Gilles Peskine4b734222019-07-24 15:56:31 +02007723#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
Gilles Peskinefc762652019-07-22 19:30:34 +02007724
Gilles Peskinec6b69072018-11-20 21:42:52 +01007725 /* All done. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01007726 global_data.initialized = 1;
7727
7728exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007729 if (status != PSA_SUCCESS) {
7730 mbedtls_psa_crypto_free();
7731 }
7732 return status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007733}
7734
Yanray Wangffc3c482023-07-11 12:01:04 +08007735#if defined(PSA_WANT_ALG_SOME_PAKE)
Przemek Stekielca8d2b22023-01-17 16:21:33 +01007736psa_status_t psa_crypto_driver_pake_get_password_len(
7737 const psa_crypto_driver_pake_inputs_t *inputs,
7738 size_t *password_len)
7739{
7740 if (inputs->password_len == 0) {
7741 return PSA_ERROR_BAD_STATE;
7742 }
7743
7744 *password_len = inputs->password_len;
7745
7746 return PSA_SUCCESS;
7747}
7748
7749psa_status_t psa_crypto_driver_pake_get_password(
7750 const psa_crypto_driver_pake_inputs_t *inputs,
7751 uint8_t *buffer, size_t buffer_size, size_t *buffer_length)
7752{
7753 if (inputs->password_len == 0) {
7754 return PSA_ERROR_BAD_STATE;
7755 }
7756
7757 if (buffer_size < inputs->password_len) {
7758 return PSA_ERROR_BUFFER_TOO_SMALL;
7759 }
7760
7761 memcpy(buffer, inputs->password, inputs->password_len);
7762 *buffer_length = inputs->password_len;
7763
7764 return PSA_SUCCESS;
7765}
7766
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007767psa_status_t psa_crypto_driver_pake_get_user_len(
7768 const psa_crypto_driver_pake_inputs_t *inputs,
7769 size_t *user_len)
7770{
7771 if (inputs->user_len == 0) {
7772 return PSA_ERROR_BAD_STATE;
7773 }
7774
7775 *user_len = inputs->user_len;
7776
7777 return PSA_SUCCESS;
7778}
7779
7780psa_status_t psa_crypto_driver_pake_get_user(
7781 const psa_crypto_driver_pake_inputs_t *inputs,
Przemek Stekielc0e62502023-03-14 11:49:36 +01007782 uint8_t *user_id, size_t user_id_size, size_t *user_id_len)
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007783{
7784 if (inputs->user_len == 0) {
7785 return PSA_ERROR_BAD_STATE;
7786 }
7787
Przemek Stekielc0e62502023-03-14 11:49:36 +01007788 if (user_id_size < inputs->user_len) {
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007789 return PSA_ERROR_BUFFER_TOO_SMALL;
7790 }
7791
Przemek Stekielc0e62502023-03-14 11:49:36 +01007792 memcpy(user_id, inputs->user, inputs->user_len);
7793 *user_id_len = inputs->user_len;
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007794
7795 return PSA_SUCCESS;
7796}
7797
7798psa_status_t psa_crypto_driver_pake_get_peer_len(
7799 const psa_crypto_driver_pake_inputs_t *inputs,
7800 size_t *peer_len)
7801{
7802 if (inputs->peer_len == 0) {
7803 return PSA_ERROR_BAD_STATE;
7804 }
7805
7806 *peer_len = inputs->peer_len;
7807
7808 return PSA_SUCCESS;
7809}
7810
7811psa_status_t psa_crypto_driver_pake_get_peer(
7812 const psa_crypto_driver_pake_inputs_t *inputs,
Przemek Stekielc0e62502023-03-14 11:49:36 +01007813 uint8_t *peer_id, size_t peer_id_size, size_t *peer_id_length)
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007814{
7815 if (inputs->peer_len == 0) {
7816 return PSA_ERROR_BAD_STATE;
7817 }
7818
Przemek Stekielc0e62502023-03-14 11:49:36 +01007819 if (peer_id_size < inputs->peer_len) {
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007820 return PSA_ERROR_BUFFER_TOO_SMALL;
7821 }
7822
Przemek Stekielc0e62502023-03-14 11:49:36 +01007823 memcpy(peer_id, inputs->peer, inputs->peer_len);
7824 *peer_id_length = inputs->peer_len;
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007825
7826 return PSA_SUCCESS;
7827}
7828
Przemek Stekielca8d2b22023-01-17 16:21:33 +01007829psa_status_t psa_crypto_driver_pake_get_cipher_suite(
7830 const psa_crypto_driver_pake_inputs_t *inputs,
7831 psa_pake_cipher_suite_t *cipher_suite)
7832{
7833 if (inputs->cipher_suite.algorithm == PSA_ALG_NONE) {
7834 return PSA_ERROR_BAD_STATE;
7835 }
7836
7837 *cipher_suite = inputs->cipher_suite;
7838
7839 return PSA_SUCCESS;
7840}
7841
Neil Armstronga7d08c32022-06-01 18:21:20 +02007842psa_status_t psa_pake_setup(
7843 psa_pake_operation_t *operation,
7844 const psa_pake_cipher_suite_t *cipher_suite)
7845{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007846 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007847
Przemek Stekiel1c3cfb42023-01-26 10:35:02 +01007848 if (operation->stage != PSA_PAKE_OPERATION_STAGE_SETUP) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007849 status = PSA_ERROR_BAD_STATE;
7850 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007851 }
7852
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01007853 if (PSA_ALG_IS_PAKE(cipher_suite->algorithm) == 0 ||
Przemek Stekiel51eac532022-12-07 11:04:51 +01007854 PSA_ALG_IS_HASH(cipher_suite->hash) == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007855 status = PSA_ERROR_INVALID_ARGUMENT;
7856 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007857 }
7858
Przemek Stekiel51eac532022-12-07 11:04:51 +01007859 memset(&operation->data.inputs, 0, sizeof(operation->data.inputs));
7860
Przemek Stekiele12ed362022-12-21 12:54:46 +01007861 operation->alg = cipher_suite->algorithm;
Przemek Stekiel656b2592023-03-22 13:15:33 +01007862 operation->primitive = PSA_PAKE_PRIMITIVE(cipher_suite->type,
7863 cipher_suite->family, cipher_suite->bits);
Przemek Stekiel51eac532022-12-07 11:04:51 +01007864 operation->data.inputs.cipher_suite = *cipher_suite;
7865
Przemek Stekiel4aa99402023-02-27 13:00:57 +01007866#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01007867 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01007868 psa_jpake_computation_stage_t *computation_stage =
Przemek Stekieldde6a912023-01-26 08:46:37 +01007869 &operation->computation_stage.jpake;
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01007870
David Horstmann16f01512023-06-14 17:21:07 +01007871 memset(computation_stage, 0, sizeof(*computation_stage));
David Horstmanne7f21e62023-05-12 18:17:21 +01007872 computation_stage->step = PSA_PAKE_STEP_KEY_SHARE;
Przemek Stekiel80a88492023-02-20 13:32:22 +01007873 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007874#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01007875 {
7876 status = PSA_ERROR_NOT_SUPPORTED;
7877 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01007878 }
7879
Przemek Stekiel1c3cfb42023-01-26 10:35:02 +01007880 operation->stage = PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS;
7881
Przemek Stekiel51eac532022-12-07 11:04:51 +01007882 return PSA_SUCCESS;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007883exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007884 psa_pake_abort(operation);
7885 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02007886}
7887
7888psa_status_t psa_pake_set_password_key(
7889 psa_pake_operation_t *operation,
7890 mbedtls_svc_key_id_t password)
7891{
Neil Armstrong5ae60962022-09-15 11:29:46 +02007892 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel6c764412022-11-22 14:05:12 +01007893 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
7894 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007895 psa_key_attributes_t attributes;
7896 psa_key_type_t type;
Neil Armstrong5ae60962022-09-15 11:29:46 +02007897
Przemek Stekiel51eac532022-12-07 11:04:51 +01007898 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007899 status = PSA_ERROR_BAD_STATE;
7900 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007901 }
7902
Przemek Stekiel6c764412022-11-22 14:05:12 +01007903 status = psa_get_and_lock_key_slot_with_policy(password, &slot,
7904 PSA_KEY_USAGE_DERIVE,
Przemek Stekield5d28a22023-01-26 10:46:05 +01007905 operation->alg);
Neil Armstrong5ae60962022-09-15 11:29:46 +02007906 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007907 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02007908 }
7909
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007910 attributes = (psa_key_attributes_t) {
Przemek Stekiel6c764412022-11-22 14:05:12 +01007911 .core = slot->attr
7912 };
Neil Armstrong5ae60962022-09-15 11:29:46 +02007913
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007914 type = psa_get_key_type(&attributes);
Neil Armstrong5ae60962022-09-15 11:29:46 +02007915
Przemek Stekiel51eac532022-12-07 11:04:51 +01007916 if (type != PSA_KEY_TYPE_PASSWORD &&
7917 type != PSA_KEY_TYPE_PASSWORD_HASH) {
7918 status = PSA_ERROR_INVALID_ARGUMENT;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007919 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007920 }
7921
Przemek Stekiel51eac532022-12-07 11:04:51 +01007922 operation->data.inputs.password = mbedtls_calloc(1, slot->key.bytes);
7923 if (operation->data.inputs.password == NULL) {
Przemek Stekiele12ed362022-12-21 12:54:46 +01007924 status = PSA_ERROR_INSUFFICIENT_MEMORY;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007925 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007926 }
7927
7928 memcpy(operation->data.inputs.password, slot->key.data, slot->key.bytes);
7929 operation->data.inputs.password_len = slot->key.bytes;
Przemek Stekiel9dd24402023-01-26 15:06:09 +01007930 operation->data.inputs.attributes = attributes;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007931exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007932 if (status != PSA_SUCCESS) {
7933 psa_pake_abort(operation);
7934 }
Ryan Everett1b70a072024-01-04 10:32:49 +00007935 unlock_status = psa_unregister_read(slot);
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007936 return (status == PSA_SUCCESS) ? unlock_status : status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02007937}
7938
7939psa_status_t psa_pake_set_user(
7940 psa_pake_operation_t *operation,
7941 const uint8_t *user_id,
7942 size_t user_id_len)
7943{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007944 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007945
7946 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007947 status = PSA_ERROR_BAD_STATE;
7948 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02007949 }
7950
Przemek Stekiel51eac532022-12-07 11:04:51 +01007951 if (user_id_len == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007952 status = PSA_ERROR_INVALID_ARGUMENT;
7953 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02007954 }
7955
Przemek Stekielf309d6b2023-03-10 09:54:45 +01007956 if (operation->data.inputs.user_len != 0) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007957 status = PSA_ERROR_BAD_STATE;
7958 goto exit;
7959 }
7960
Przemek Stekielf309d6b2023-03-10 09:54:45 +01007961 operation->data.inputs.user = mbedtls_calloc(1, user_id_len);
7962 if (operation->data.inputs.user == NULL) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007963 status = PSA_ERROR_INSUFFICIENT_MEMORY;
7964 goto exit;
7965 }
7966
Przemek Stekielf309d6b2023-03-10 09:54:45 +01007967 memcpy(operation->data.inputs.user, user_id, user_id_len);
7968 operation->data.inputs.user_len = user_id_len;
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007969
7970 return PSA_SUCCESS;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007971exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007972 psa_pake_abort(operation);
7973 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02007974}
7975
7976psa_status_t psa_pake_set_peer(
7977 psa_pake_operation_t *operation,
7978 const uint8_t *peer_id,
7979 size_t peer_id_len)
7980{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007981 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007982
7983 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007984 status = PSA_ERROR_BAD_STATE;
7985 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02007986 }
7987
Przemek Stekiel51eac532022-12-07 11:04:51 +01007988 if (peer_id_len == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007989 status = PSA_ERROR_INVALID_ARGUMENT;
7990 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02007991 }
7992
Przemek Stekielf309d6b2023-03-10 09:54:45 +01007993 if (operation->data.inputs.peer_len != 0) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007994 status = PSA_ERROR_BAD_STATE;
7995 goto exit;
7996 }
7997
Przemek Stekielf309d6b2023-03-10 09:54:45 +01007998 operation->data.inputs.peer = mbedtls_calloc(1, peer_id_len);
7999 if (operation->data.inputs.peer == NULL) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008000 status = PSA_ERROR_INSUFFICIENT_MEMORY;
8001 goto exit;
8002 }
8003
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008004 memcpy(operation->data.inputs.peer, peer_id, peer_id_len);
8005 operation->data.inputs.peer_len = peer_id_len;
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008006
8007 return PSA_SUCCESS;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008008exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008009 psa_pake_abort(operation);
8010 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008011}
8012
8013psa_status_t psa_pake_set_role(
8014 psa_pake_operation_t *operation,
8015 psa_pake_role_t role)
8016{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008017 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008018
Przemek Stekiel51eac532022-12-07 11:04:51 +01008019 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008020 status = PSA_ERROR_BAD_STATE;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008021 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008022 }
8023
Przemek Stekiel09104b82023-03-06 14:11:51 +01008024 switch (operation->alg) {
8025#if defined(PSA_WANT_ALG_JPAKE)
8026 case PSA_ALG_JPAKE:
8027 if (role == PSA_PAKE_ROLE_NONE) {
8028 return PSA_SUCCESS;
8029 }
8030 status = PSA_ERROR_INVALID_ARGUMENT;
8031 break;
8032#endif
8033 default:
8034 (void) role;
8035 status = PSA_ERROR_NOT_SUPPORTED;
8036 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008037 }
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008038exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008039 psa_pake_abort(operation);
8040 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008041}
8042
David Horstmanne7f21e62023-05-12 18:17:21 +01008043/* Auxiliary function to convert core computation stage to single driver step. */
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008044#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiel251e86a2023-02-17 14:30:50 +01008045static psa_crypto_driver_pake_step_t convert_jpake_computation_stage_to_driver_step(
Przemek Stekieldde6a912023-01-26 08:46:37 +01008046 psa_jpake_computation_stage_t *stage)
Przemek Stekielb09c4872023-01-17 12:05:38 +01008047{
David Horstmann74a3d8c2023-06-14 18:28:19 +01008048 psa_crypto_driver_pake_step_t key_share_step;
David Horstmann5da95602023-06-08 15:37:12 +01008049 if (stage->round == PSA_JPAKE_FIRST) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008050 int is_x1;
David Horstmann74a3d8c2023-06-14 18:28:19 +01008051
David Horstmann024e5c52023-06-14 15:48:21 +01008052 if (stage->io_mode == PSA_JPAKE_OUTPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008053 is_x1 = (stage->outputs < 1);
8054 } else {
8055 is_x1 = (stage->inputs < 1);
8056 }
8057
David Horstmann74a3d8c2023-06-14 18:28:19 +01008058 key_share_step = is_x1 ?
8059 PSA_JPAKE_X1_STEP_KEY_SHARE :
8060 PSA_JPAKE_X2_STEP_KEY_SHARE;
David Horstmann5da95602023-06-08 15:37:12 +01008061 } else if (stage->round == PSA_JPAKE_SECOND) {
David Horstmann74a3d8c2023-06-14 18:28:19 +01008062 key_share_step = (stage->io_mode == PSA_JPAKE_OUTPUT) ?
8063 PSA_JPAKE_X2S_STEP_KEY_SHARE :
8064 PSA_JPAKE_X4S_STEP_KEY_SHARE;
8065 } else {
8066 return PSA_JPAKE_STEP_INVALID;
Przemek Stekielb09c4872023-01-17 12:05:38 +01008067 }
Agathiyan Bragadeesh387bfa52023-07-17 17:01:33 +01008068 return (psa_crypto_driver_pake_step_t) (key_share_step + stage->step - PSA_PAKE_STEP_KEY_SHARE);
Przemek Stekielb09c4872023-01-17 12:05:38 +01008069}
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008070#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekielb09c4872023-01-17 12:05:38 +01008071
Przemek Stekiel2797d372022-12-22 11:19:22 +01008072static psa_status_t psa_pake_complete_inputs(
8073 psa_pake_operation_t *operation)
8074{
Przemek Stekiel2797d372022-12-22 11:19:22 +01008075 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel18620a32023-01-17 16:34:52 +01008076 /* Create copy of the inputs on stack as inputs share memory
8077 with the driver context which will be setup by the driver. */
8078 psa_crypto_driver_pake_inputs_t inputs = operation->data.inputs;
Przemek Stekiel2797d372022-12-22 11:19:22 +01008079
Przemek Stekielfde11282023-03-13 16:06:09 +01008080 if (inputs.password_len == 0) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01008081 return PSA_ERROR_BAD_STATE;
8082 }
8083
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008084 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekielfde11282023-03-13 16:06:09 +01008085 if (inputs.user_len == 0 || inputs.peer_len == 0) {
8086 return PSA_ERROR_BAD_STATE;
8087 }
Przemek Stekieldff21d32023-02-14 20:09:10 +01008088 }
8089
Przemek Stekiel18620a32023-01-17 16:34:52 +01008090 /* Clear driver context */
8091 mbedtls_platform_zeroize(&operation->data, sizeof(operation->data));
8092
8093 status = psa_driver_wrapper_pake_setup(operation, &inputs);
Przemek Stekiel2797d372022-12-22 11:19:22 +01008094
8095 /* Driver is responsible for creating its own copy of the password. */
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01008096 mbedtls_zeroize_and_free(inputs.password, inputs.password_len);
Przemek Stekiel2797d372022-12-22 11:19:22 +01008097
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008098 /* User and peer are translated to role. */
8099 mbedtls_free(inputs.user);
8100 mbedtls_free(inputs.peer);
8101
Przemek Stekiel2797d372022-12-22 11:19:22 +01008102 if (status == PSA_SUCCESS) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008103#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiel2797d372022-12-22 11:19:22 +01008104 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekield93de322023-02-24 08:39:04 +01008105 operation->stage = PSA_PAKE_OPERATION_STAGE_COMPUTATION;
Przemek Stekiel80a88492023-02-20 13:32:22 +01008106 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008107#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01008108 {
8109 status = PSA_ERROR_NOT_SUPPORTED;
Przemek Stekiel2797d372022-12-22 11:19:22 +01008110 }
Przemek Stekiel2797d372022-12-22 11:19:22 +01008111 }
Przemek Stekiel2797d372022-12-22 11:19:22 +01008112 return status;
8113}
8114
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008115#if defined(PSA_WANT_ALG_JPAKE)
David Horstmanne7f21e62023-05-12 18:17:21 +01008116static psa_status_t psa_jpake_prologue(
Przemek Stekiele12ed362022-12-21 12:54:46 +01008117 psa_pake_operation_t *operation,
David Horstmanne7f21e62023-05-12 18:17:21 +01008118 psa_pake_step_t step,
David Horstmann00ad6bf2023-06-14 15:44:24 +01008119 psa_jpake_io_mode_t io_mode)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008120{
Przemek Stekiele12ed362022-12-21 12:54:46 +01008121 if (step != PSA_PAKE_STEP_KEY_SHARE &&
8122 step != PSA_PAKE_STEP_ZK_PUBLIC &&
8123 step != PSA_PAKE_STEP_ZK_PROOF) {
8124 return PSA_ERROR_INVALID_ARGUMENT;
8125 }
8126
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008127 psa_jpake_computation_stage_t *computation_stage =
8128 &operation->computation_stage.jpake;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008129
David Horstmann5da95602023-06-08 15:37:12 +01008130 if (computation_stage->round != PSA_JPAKE_FIRST &&
8131 computation_stage->round != PSA_JPAKE_SECOND) {
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008132 return PSA_ERROR_BAD_STATE;
8133 }
8134
David Horstmanne7f21e62023-05-12 18:17:21 +01008135 /* Check that the step we are given is the one we were expecting */
8136 if (step != computation_stage->step) {
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008137 return PSA_ERROR_BAD_STATE;
8138 }
8139
David Horstmanne7f21e62023-05-12 18:17:21 +01008140 if (step == PSA_PAKE_STEP_KEY_SHARE &&
8141 computation_stage->inputs == 0 &&
8142 computation_stage->outputs == 0) {
8143 /* Start of the round, so function decides whether we are inputting
8144 * or outputting */
David Horstmann024e5c52023-06-14 15:48:21 +01008145 computation_stage->io_mode = io_mode;
8146 } else if (computation_stage->io_mode != io_mode) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008147 /* Middle of the round so the mode we are in must match the function
8148 * called by the user */
8149 return PSA_ERROR_BAD_STATE;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008150 }
8151
8152 return PSA_SUCCESS;
8153}
8154
David Horstmanne7f21e62023-05-12 18:17:21 +01008155static psa_status_t psa_jpake_epilogue(
8156 psa_pake_operation_t *operation,
David Horstmann00ad6bf2023-06-14 15:44:24 +01008157 psa_jpake_io_mode_t io_mode)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008158{
David Horstmanne7f21e62023-05-12 18:17:21 +01008159 psa_jpake_computation_stage_t *stage =
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008160 &operation->computation_stage.jpake;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008161
David Horstmanne7f21e62023-05-12 18:17:21 +01008162 if (stage->step == PSA_PAKE_STEP_ZK_PROOF) {
8163 /* End of an input/output */
David Horstmann00ad6bf2023-06-14 15:44:24 +01008164 if (io_mode == PSA_JPAKE_INPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008165 stage->inputs++;
David Horstmann246ec5a2023-06-27 10:33:06 +01008166 if (stage->inputs == PSA_JPAKE_EXPECTED_INPUTS(stage->round)) {
David Horstmann024e5c52023-06-14 15:48:21 +01008167 stage->io_mode = PSA_JPAKE_OUTPUT;
David Horstmanne7f21e62023-05-12 18:17:21 +01008168 }
8169 }
David Horstmann00ad6bf2023-06-14 15:44:24 +01008170 if (io_mode == PSA_JPAKE_OUTPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008171 stage->outputs++;
David Horstmann246ec5a2023-06-27 10:33:06 +01008172 if (stage->outputs == PSA_JPAKE_EXPECTED_OUTPUTS(stage->round)) {
David Horstmann024e5c52023-06-14 15:48:21 +01008173 stage->io_mode = PSA_JPAKE_INPUT;
David Horstmanne7f21e62023-05-12 18:17:21 +01008174 }
8175 }
David Horstmann246ec5a2023-06-27 10:33:06 +01008176 if (stage->inputs == PSA_JPAKE_EXPECTED_INPUTS(stage->round) &&
8177 stage->outputs == PSA_JPAKE_EXPECTED_OUTPUTS(stage->round)) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008178 /* End of a round, move to the next round */
8179 stage->inputs = 0;
8180 stage->outputs = 0;
8181 stage->round++;
8182 }
8183 stage->step = PSA_PAKE_STEP_KEY_SHARE;
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008184 } else {
David Horstmanne7f21e62023-05-12 18:17:21 +01008185 stage->step++;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008186 }
Przemek Stekiele12ed362022-12-21 12:54:46 +01008187 return PSA_SUCCESS;
8188}
David Horstmanne7f21e62023-05-12 18:17:21 +01008189
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008190#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008191
Neil Armstronga7d08c32022-06-01 18:21:20 +02008192psa_status_t psa_pake_output(
8193 psa_pake_operation_t *operation,
8194 psa_pake_step_t step,
8195 uint8_t *output,
8196 size_t output_size,
8197 size_t *output_length)
8198{
Przemek Stekiel51eac532022-12-07 11:04:51 +01008199 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008200 psa_crypto_driver_pake_step_t driver_step = PSA_JPAKE_STEP_INVALID;
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008201 *output_length = 0;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008202
8203 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01008204 status = psa_pake_complete_inputs(operation);
8205 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008206 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008207 }
8208 }
8209
8210 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008211 status = PSA_ERROR_BAD_STATE;
8212 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008213 }
8214
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008215 if (output_size == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008216 status = PSA_ERROR_INVALID_ARGUMENT;
8217 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008218 }
8219
Przemek Stekiele12ed362022-12-21 12:54:46 +01008220 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008221#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008222 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008223 status = psa_jpake_prologue(operation, step, PSA_JPAKE_OUTPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008224 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008225 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008226 }
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008227 driver_step = convert_jpake_computation_stage_to_driver_step(
8228 &operation->computation_stage.jpake);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008229 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008230#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008231 default:
Przemek Stekiel80a88492023-02-20 13:32:22 +01008232 (void) step;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008233 status = PSA_ERROR_NOT_SUPPORTED;
8234 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008235 }
8236
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008237 status = psa_driver_wrapper_pake_output(operation, driver_step,
8238 output, output_size, output_length);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008239
8240 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008241 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008242 }
8243
8244 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008245#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008246 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008247 status = psa_jpake_epilogue(operation, PSA_JPAKE_OUTPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008248 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008249 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008250 }
8251 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008252#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008253 default:
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008254 status = PSA_ERROR_NOT_SUPPORTED;
8255 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008256 }
8257
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008258 return PSA_SUCCESS;
8259exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008260 psa_pake_abort(operation);
8261 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008262}
8263
8264psa_status_t psa_pake_input(
8265 psa_pake_operation_t *operation,
8266 psa_pake_step_t step,
8267 const uint8_t *input,
8268 size_t input_length)
8269{
Przemek Stekiel51eac532022-12-07 11:04:51 +01008270 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008271 psa_crypto_driver_pake_step_t driver_step = PSA_JPAKE_STEP_INVALID;
Przemek Stekiel256c75d2023-03-23 14:09:34 +01008272 const size_t max_input_length = (size_t) PSA_PAKE_INPUT_SIZE(operation->alg,
8273 operation->primitive,
8274 step);
Przemek Stekiel51eac532022-12-07 11:04:51 +01008275
8276 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01008277 status = psa_pake_complete_inputs(operation);
8278 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008279 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008280 }
8281 }
8282
8283 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008284 status = PSA_ERROR_BAD_STATE;
8285 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008286 }
8287
Przemek Stekiel256c75d2023-03-23 14:09:34 +01008288 if (input_length == 0 || input_length > max_input_length) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008289 status = PSA_ERROR_INVALID_ARGUMENT;
8290 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008291 }
8292
Przemek Stekiele12ed362022-12-21 12:54:46 +01008293 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008294#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008295 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008296 status = psa_jpake_prologue(operation, step, PSA_JPAKE_INPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008297 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008298 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008299 }
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008300 driver_step = convert_jpake_computation_stage_to_driver_step(
8301 &operation->computation_stage.jpake);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008302 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008303#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008304 default:
Przemek Stekiel80a88492023-02-20 13:32:22 +01008305 (void) step;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008306 status = PSA_ERROR_NOT_SUPPORTED;
8307 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008308 }
8309
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008310 status = psa_driver_wrapper_pake_input(operation, driver_step,
8311 input, input_length);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008312
8313 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008314 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008315 }
8316
8317 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008318#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008319 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008320 status = psa_jpake_epilogue(operation, PSA_JPAKE_INPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008321 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008322 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008323 }
8324 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008325#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008326 default:
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008327 status = PSA_ERROR_NOT_SUPPORTED;
8328 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008329 }
8330
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008331 return PSA_SUCCESS;
8332exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008333 psa_pake_abort(operation);
8334 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008335}
8336
8337psa_status_t psa_pake_get_implicit_key(
8338 psa_pake_operation_t *operation,
8339 psa_key_derivation_operation_t *output)
8340{
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008341 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008342 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel251e86a2023-02-17 14:30:50 +01008343 uint8_t shared_key[MBEDTLS_PSA_JPAKE_BUFFER_SIZE];
Przemek Stekiel0c781802022-11-29 14:53:13 +01008344 size_t shared_key_len = 0;
8345
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008346 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008347 status = PSA_ERROR_BAD_STATE;
8348 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008349 }
8350
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008351#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008352 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008353 psa_jpake_computation_stage_t *computation_stage =
Przemek Stekiel083745e2023-02-23 17:28:23 +01008354 &operation->computation_stage.jpake;
David Horstmann5da95602023-06-08 15:37:12 +01008355 if (computation_stage->round != PSA_JPAKE_FINISHED) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008356 status = PSA_ERROR_BAD_STATE;
8357 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008358 }
Przemek Stekiel80a88492023-02-20 13:32:22 +01008359 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008360#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01008361 {
8362 status = PSA_ERROR_NOT_SUPPORTED;
8363 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008364 }
8365
Przemek Stekiel0c781802022-11-29 14:53:13 +01008366 status = psa_driver_wrapper_pake_get_implicit_key(operation,
8367 shared_key,
Przemek Stekiel6b648622023-02-19 22:55:33 +01008368 sizeof(shared_key),
Przemek Stekiel0c781802022-11-29 14:53:13 +01008369 &shared_key_len);
8370
8371 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008372 goto exit;
Przemek Stekiel0c781802022-11-29 14:53:13 +01008373 }
8374
8375 status = psa_key_derivation_input_bytes(output,
8376 PSA_KEY_DERIVATION_INPUT_SECRET,
8377 shared_key,
8378 shared_key_len);
8379
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008380 mbedtls_platform_zeroize(shared_key, sizeof(shared_key));
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008381exit:
8382 abort_status = psa_pake_abort(operation);
8383 return status == PSA_SUCCESS ? abort_status : status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008384}
8385
8386psa_status_t psa_pake_abort(
8387 psa_pake_operation_t *operation)
8388{
Przemek Stekield69dca92023-01-31 19:59:20 +01008389 psa_status_t status = PSA_SUCCESS;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008390
Przemek Stekield69dca92023-01-31 19:59:20 +01008391 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008392 status = psa_driver_wrapper_pake_abort(operation);
Neil Armstrong5ae60962022-09-15 11:29:46 +02008393 }
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008394
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008395 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
8396 if (operation->data.inputs.password != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01008397 mbedtls_zeroize_and_free(operation->data.inputs.password,
Przemek Stekielaa183422023-03-06 14:21:44 +01008398 operation->data.inputs.password_len);
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008399 }
8400 if (operation->data.inputs.user != NULL) {
8401 mbedtls_free(operation->data.inputs.user);
8402 }
8403 if (operation->data.inputs.peer != NULL) {
8404 mbedtls_free(operation->data.inputs.peer);
8405 }
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008406 }
Przemek Stekield69dca92023-01-31 19:59:20 +01008407 memset(operation, 0, sizeof(psa_pake_operation_t));
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008408
Przemek Stekield69dca92023-01-31 19:59:20 +01008409 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008410}
Tom Cosgrove6d62fac2023-05-10 14:40:05 +01008411#endif /* PSA_WANT_ALG_SOME_PAKE */
Neil Armstronga7d08c32022-06-01 18:21:20 +02008412
Gilles Peskinee59236f2018-01-27 23:32:46 +01008413#endif /* MBEDTLS_PSA_CRYPTO_C */