blob: 07edd0a0c0cfa0cdc7336133199f6061b0c059cc [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.
Ryan Everett93cea572024-02-20 18:01:29 +0000912 * It is the responsibility of the caller to then unregister
913 * once they have finished reading the contents of the slot.
914 * The caller unregisters by calling psa_unregister_read() or
915 * psa_unregister_read_under_mutex(). psa_unregister_read() must be called
916 * if and only if the caller already holds the global key slot mutex
917 * (when mutexes are enabled). psa_unregister_read_under_mutex() encapsulates
918 * the unregister with mutex lock and unlock operations.
Przemek Stekiel061f6942022-11-30 10:51:35 +0100919 */
920static psa_status_t psa_get_and_lock_key_slot_with_policy(
Ronald Cron5c522922020-11-14 16:35:34 +0100921 mbedtls_svc_key_id_t key,
922 psa_key_slot_t **p_slot,
923 psa_key_usage_t usage,
Gilles Peskine449bd832023-01-11 14:50:10 +0100924 psa_algorithm_t alg)
Darryl Green06fd18d2018-07-16 11:21:11 +0100925{
Ronald Cronf95a2b12020-10-22 15:24:49 +0200926 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel9a5b8122022-12-22 13:34:47 +0100927 psa_key_slot_t *slot = NULL;
Darryl Green06fd18d2018-07-16 11:21:11 +0100928
Gilles Peskine449bd832023-01-11 14:50:10 +0100929 status = psa_get_and_lock_key_slot(key, p_slot);
930 if (status != PSA_SUCCESS) {
931 return status;
932 }
Ronald Cronf95a2b12020-10-22 15:24:49 +0200933 slot = *p_slot;
Darryl Green06fd18d2018-07-16 11:21:11 +0100934
935 /* Enforce that usage policy for the key slot contains all the flags
936 * required by the usage parameter. There is one exception: public
937 * keys can always be exported, so we treat public key objects as
938 * if they had the export flag. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100939 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(slot->attr.type)) {
Darryl Green06fd18d2018-07-16 11:21:11 +0100940 usage &= ~PSA_KEY_USAGE_EXPORT;
Gilles Peskine449bd832023-01-11 14:50:10 +0100941 }
Ronald Cronf95a2b12020-10-22 15:24:49 +0200942
Gilles Peskine449bd832023-01-11 14:50:10 +0100943 if ((slot->attr.policy.usage & usage) != usage) {
Steven Cooreman328f11c2021-03-02 11:44:51 +0100944 status = PSA_ERROR_NOT_PERMITTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +0200945 goto error;
Steven Cooreman328f11c2021-03-02 11:44:51 +0100946 }
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100947
Shaun Case8b0ecbc2021-12-20 21:14:10 -0800948 /* Enforce that the usage policy permits the requested algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100949 if (alg != 0) {
950 status = psa_key_policy_permits(&slot->attr.policy,
951 slot->attr.type,
952 alg);
953 if (status != PSA_SUCCESS) {
Steven Cooreman7e39f052021-02-23 14:18:32 +0100954 goto error;
Gilles Peskine449bd832023-01-11 14:50:10 +0100955 }
Steven Cooreman7e39f052021-02-23 14:18:32 +0100956 }
Darryl Green06fd18d2018-07-16 11:21:11 +0100957
Gilles Peskine449bd832023-01-11 14:50:10 +0100958 return PSA_SUCCESS;
Ronald Cronf95a2b12020-10-22 15:24:49 +0200959
960error:
961 *p_slot = NULL;
Ryan Everettfb792ca2024-01-31 13:40:05 +0000962 psa_unregister_read_under_mutex(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +0200963
Gilles Peskine449bd832023-01-11 14:50:10 +0100964 return status;
Darryl Green06fd18d2018-07-16 11:21:11 +0100965}
Darryl Green940d72c2018-07-13 13:18:51 +0100966
Ronald Cron5c522922020-11-14 16:35:34 +0100967/** Get a key slot containing a transparent key and lock it.
Gilles Peskine28f8f302019-07-24 13:30:31 +0200968 *
969 * A transparent key is a key for which the key material is directly
Ronald Cronddae0f52021-08-24 15:39:44 +0200970 * available, as opposed to a key in a secure element and/or to be used
971 * by a secure element.
Gilles Peskine28f8f302019-07-24 13:30:31 +0200972 *
Ronald Cronddae0f52021-08-24 15:39:44 +0200973 * This is a temporary function that may be used instead of
974 * psa_get_and_lock_key_slot_with_policy() when there is no opaque key support
975 * for a cryptographic operation.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200976 *
Ryan Everett098c6652024-01-03 13:03:36 +0000977 * On success, the returned key slot has been registered for reading.
Ryan Everett93cea572024-02-20 18:01:29 +0000978 * It is the responsibility of the caller to then unregister
979 * once they have finished reading the contents of the slot.
980 * The caller unregisters by calling psa_unregister_read() or
981 * psa_unregister_read_under_mutex(). psa_unregister_read() must be called
982 * if and only if the caller already holds the global key slot mutex
983 * (when mutexes are enabled). psa_unregister_read_under_mutex() encapsulates
984 * psa_unregister_read() with mutex lock and unlock operations.
Gilles Peskine28f8f302019-07-24 13:30:31 +0200985 */
Ronald Cron5c522922020-11-14 16:35:34 +0100986static psa_status_t psa_get_and_lock_transparent_key_slot_with_policy(
987 mbedtls_svc_key_id_t key,
988 psa_key_slot_t **p_slot,
989 psa_key_usage_t usage,
Gilles Peskine449bd832023-01-11 14:50:10 +0100990 psa_algorithm_t alg)
Gilles Peskine28f8f302019-07-24 13:30:31 +0200991{
Gilles Peskine449bd832023-01-11 14:50:10 +0100992 psa_status_t status = psa_get_and_lock_key_slot_with_policy(key, p_slot,
993 usage, alg);
994 if (status != PSA_SUCCESS) {
995 return status;
Gilles Peskine28f8f302019-07-24 13:30:31 +0200996 }
Ronald Cronf95a2b12020-10-22 15:24:49 +0200997
Gilles Peskine449bd832023-01-11 14:50:10 +0100998 if (psa_key_lifetime_is_external((*p_slot)->attr.lifetime)) {
Ryan Everettfb792ca2024-01-31 13:40:05 +0000999 psa_unregister_read_under_mutex(*p_slot);
Gilles Peskine449bd832023-01-11 14:50:10 +01001000 *p_slot = NULL;
1001 return PSA_ERROR_NOT_SUPPORTED;
1002 }
1003
1004 return PSA_SUCCESS;
Gilles Peskine28f8f302019-07-24 13:30:31 +02001005}
Gilles Peskine28f8f302019-07-24 13:30:31 +02001006
Gilles Peskine449bd832023-01-11 14:50:10 +01001007psa_status_t psa_remove_key_data_from_memory(psa_key_slot_t *slot)
Darryl Green40225ba2018-11-15 14:48:15 +00001008{
Gilles Peskine449bd832023-01-11 14:50:10 +01001009 if (slot->key.data != NULL) {
Tom Cosgrove52f7e182023-08-01 09:08:48 +01001010 mbedtls_zeroize_and_free(slot->key.data, slot->key.bytes);
Gilles Peskine449bd832023-01-11 14:50:10 +01001011 }
Ronald Cronea0f8a62020-11-25 17:52:23 +01001012
Ronald Cronea0f8a62020-11-25 17:52:23 +01001013 slot->key.data = NULL;
1014 slot->key.bytes = 0;
Darryl Green40225ba2018-11-15 14:48:15 +00001015
Gilles Peskine449bd832023-01-11 14:50:10 +01001016 return PSA_SUCCESS;
Darryl Green40225ba2018-11-15 14:48:15 +00001017}
1018
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001019/** Completely wipe a slot in memory, including its policy.
1020 * Persistent storage is not affected. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001021psa_status_t psa_wipe_key_slot(psa_key_slot_t *slot)
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001022{
Gilles Peskine449bd832023-01-11 14:50:10 +01001023 psa_status_t status = psa_remove_key_data_from_memory(slot);
Ronald Cronddd3d052020-10-30 14:07:07 +01001024
Gilles Peskine449bd832023-01-11 14:50:10 +01001025 /*
1026 * As the return error code may not be handled in case of multiple errors,
Ryan Everett7ed542e2024-01-17 11:39:09 +00001027 * do our best to report an unexpected amount of registered readers or
1028 * an unexpected state.
1029 * Assert with MBEDTLS_TEST_HOOK_TEST_ASSERT that the slot is valid for
1030 * wiping.
Gilles Peskine449bd832023-01-11 14:50:10 +01001031 * if the MBEDTLS_TEST_HOOKS configuration option is enabled and the
1032 * function is called as part of the execution of a test suite, the
1033 * execution of the test suite is stopped in error if the assertion fails.
1034 */
Ryan Everett7ed542e2024-01-17 11:39:09 +00001035 switch (slot->state) {
1036 case PSA_SLOT_FULL:
1037 /* In this state psa_wipe_key_slot() must only be called if the
1038 * caller is the last reader. */
1039 case PSA_SLOT_PENDING_DELETION:
1040 /* In this state psa_wipe_key_slot() must only be called if the
1041 * caller is the last reader. */
1042 if (slot->registered_readers != 1) {
1043 MBEDTLS_TEST_HOOK_TEST_ASSERT(slot->registered_readers == 1);
1044 status = PSA_ERROR_CORRUPTION_DETECTED;
1045 }
1046 break;
1047 case PSA_SLOT_FILLING:
1048 /* In this state registered_readers must be 0. */
1049 if (slot->registered_readers != 0) {
1050 MBEDTLS_TEST_HOOK_TEST_ASSERT(slot->registered_readers == 0);
1051 status = PSA_ERROR_CORRUPTION_DETECTED;
1052 }
1053 break;
1054 case PSA_SLOT_EMPTY:
1055 /* The slot is already empty, it cannot be wiped. */
1056 MBEDTLS_TEST_HOOK_TEST_ASSERT(slot->state != PSA_SLOT_EMPTY);
1057 status = PSA_ERROR_CORRUPTION_DETECTED;
1058 break;
1059 default:
1060 /* The slot's state is invalid. */
1061 status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronddd3d052020-10-30 14:07:07 +01001062 }
1063
Gilles Peskine3f7cd622019-08-13 15:01:08 +02001064 /* Multipart operations may still be using the key. This is safe
1065 * because all multipart operation objects are independent from
1066 * the key slot: if they need to access the key after the setup
1067 * phase, they have a copy of the key. Note that this means that
1068 * key material can linger until all operations are completed. */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001069 /* At this point, key material and other type-specific content has
1070 * been wiped. Clear remaining metadata. We can call memset and not
Ryan Everettaa33c512023-12-21 17:32:07 +00001071 * zeroize because the metadata is not particularly sensitive.
1072 * This memset also sets the slot's state to PSA_SLOT_EMPTY. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001073 memset(slot, 0, sizeof(*slot));
1074 return status;
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001075}
1076
Gilles Peskine449bd832023-01-11 14:50:10 +01001077psa_status_t psa_destroy_key(mbedtls_svc_key_id_t key)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001078{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001079 psa_key_slot_t *slot;
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001080 psa_status_t status; /* status of the last operation */
1081 psa_status_t overall_status = PSA_SUCCESS;
Gilles Peskine354f7672019-07-12 23:46:38 +02001082#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1083 psa_se_drv_table_entry_t *driver;
1084#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001085
Gilles Peskine449bd832023-01-11 14:50:10 +01001086 if (mbedtls_svc_key_id_is_null(key)) {
1087 return PSA_SUCCESS;
1088 }
Gilles Peskine1841cf42019-10-08 15:48:25 +02001089
Ronald Cronf2911112020-10-29 17:51:10 +01001090 /*
Ryan Everett7ed542e2024-01-17 11:39:09 +00001091 * Get the description of the key in a key slot, and register to read it.
1092 * In the case of a persistent key, this will load the key description
1093 * from persistent memory if not done yet.
1094 * We cannot avoid this loading as without it we don't know if
Ronald Cronf2911112020-10-29 17:51:10 +01001095 * the key is operated by an SE or not and this information is needed by
Ryan Everett7ed542e2024-01-17 11:39:09 +00001096 * the current implementation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001097 status = psa_get_and_lock_key_slot(key, &slot);
1098 if (status != PSA_SUCCESS) {
1099 return status;
1100 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001101
Ryan Everett7ed542e2024-01-17 11:39:09 +00001102 /* Set the key slot containing the key description's state to
1103 * PENDING_DELETION. This stops new operations from registering
1104 * to read the slot. Current readers can safely continue to access
1105 * the key within the slot; the last registered reader will
1106 * automatically wipe the slot when they call psa_unregister_read().
1107 * If the key is persistent, we can now delete the copy of the key
1108 * from memory. If the key is opaque, we require the driver to
1109 * deal with the deletion. */
Ryan Everettc70ce572024-01-03 16:04:33 +00001110 slot->state = PSA_SLOT_PENDING_DELETION;
Ronald Cronf2911112020-10-29 17:51:10 +01001111
Gilles Peskine449bd832023-01-11 14:50:10 +01001112 if (PSA_KEY_LIFETIME_IS_READ_ONLY(slot->attr.lifetime)) {
Gilles Peskine6687cd02021-04-21 22:32:05 +02001113 /* Refuse the destruction of a read-only key (which may or may not work
1114 * if we attempt it, depending on whether the key is merely read-only
1115 * by policy or actually physically read-only).
Gilles Peskinef9a046e2021-06-07 23:27:54 +02001116 * Just do the best we can, which is to wipe the copy in memory
1117 * (done in this function's cleanup code). */
1118 overall_status = PSA_ERROR_NOT_PERMITTED;
1119 goto exit;
Gilles Peskine6687cd02021-04-21 22:32:05 +02001120 }
1121
Gilles Peskine354f7672019-07-12 23:46:38 +02001122#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001123 driver = psa_get_se_driver_entry(slot->attr.lifetime);
1124 if (driver != NULL) {
Gilles Peskine60450a42019-07-25 11:32:45 +02001125 /* For a key in a secure element, we need to do three things:
1126 * remove the key file in internal storage, destroy the
1127 * key inside the secure element, and update the driver's
1128 * persistent data. Start a transaction that will encompass these
1129 * three actions. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001130 psa_crypto_prepare_transaction(PSA_CRYPTO_TRANSACTION_DESTROY_KEY);
Gilles Peskine8e338702019-07-30 20:06:31 +02001131 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Gilles Peskine449bd832023-01-11 14:50:10 +01001132 psa_crypto_transaction.key.slot = psa_key_slot_get_slot_number(slot);
Gilles Peskine8e338702019-07-30 20:06:31 +02001133 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskine449bd832023-01-11 14:50:10 +01001134 status = psa_crypto_save_transaction();
1135 if (status != PSA_SUCCESS) {
1136 (void) psa_crypto_stop_transaction();
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001137 /* We should still try to destroy the key in the secure
1138 * element and the key metadata in storage. This is especially
1139 * important if the error is that the storage is full.
1140 * But how to do it exactly without risking an inconsistent
1141 * state after a reset?
1142 * https://github.com/ARMmbed/mbed-crypto/issues/215
1143 */
1144 overall_status = status;
1145 goto exit;
Gilles Peskinefc762652019-07-22 19:30:34 +02001146 }
1147
Gilles Peskine449bd832023-01-11 14:50:10 +01001148 status = psa_destroy_se_key(driver,
1149 psa_key_slot_get_slot_number(slot));
1150 if (overall_status == PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001151 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001152 }
Gilles Peskinefc762652019-07-22 19:30:34 +02001153 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001154#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1155
Darryl Greend49a4992018-06-18 17:27:26 +01001156#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001157 if (!PSA_KEY_LIFETIME_IS_VOLATILE(slot->attr.lifetime)) {
Ryan Everett4a0ba802024-01-17 14:12:33 +00001158 /* Destroy the copy of the persistent key from storage.
Ryan Everett7ed542e2024-01-17 11:39:09 +00001159 * The slot will still hold a copy of the key until the last reader
1160 * unregisters. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001161 status = psa_destroy_persistent_key(slot->attr.id);
1162 if (overall_status == PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001163 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001164 }
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001165
Gilles Peskine9ce31c42019-08-13 15:14:20 +02001166 /* TODO: other slots may have a copy of the same key. We should
1167 * invalidate them.
1168 * https://github.com/ARMmbed/mbed-crypto/issues/214
1169 */
Darryl Greend49a4992018-06-18 17:27:26 +01001170 }
1171#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
Gilles Peskine354f7672019-07-12 23:46:38 +02001172
Gilles Peskinefc762652019-07-22 19:30:34 +02001173#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001174 if (driver != NULL) {
1175 status = psa_save_se_persistent_data(driver);
1176 if (overall_status == PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001177 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001178 }
1179 status = psa_crypto_stop_transaction();
1180 if (overall_status == PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001181 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001182 }
Gilles Peskinefc762652019-07-22 19:30:34 +02001183 }
1184#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1185
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001186exit:
Ryan Everett7ed542e2024-01-17 11:39:09 +00001187 /* Unregister from reading the slot. If we are the last active reader
1188 * then this will wipe the slot. */
1189 status = psa_unregister_read(slot);
1190 /* Prioritize CORRUPTION_DETECTED from unregistering over
1191 * a storage error. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001192 if (status != PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001193 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001194 }
1195 return overall_status;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001196}
1197
Valerio Settib2bcedb2023-07-10 11:24:00 +02001198#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT) || \
John Durkop0e005192020-10-31 22:06:54 -07001199 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskineb699f072019-04-26 16:06:02 +02001200static psa_status_t psa_get_rsa_public_exponent(
1201 const mbedtls_rsa_context *rsa,
Gilles Peskine449bd832023-01-11 14:50:10 +01001202 psa_key_attributes_t *attributes)
Gilles Peskineb699f072019-04-26 16:06:02 +02001203{
1204 mbedtls_mpi mpi;
Janos Follath24eed8d2019-11-22 13:21:35 +00001205 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb699f072019-04-26 16:06:02 +02001206 uint8_t *buffer = NULL;
1207 size_t buflen;
Gilles Peskine449bd832023-01-11 14:50:10 +01001208 mbedtls_mpi_init(&mpi);
Gilles Peskineb699f072019-04-26 16:06:02 +02001209
Gilles Peskine449bd832023-01-11 14:50:10 +01001210 ret = mbedtls_rsa_export(rsa, NULL, NULL, NULL, NULL, &mpi);
1211 if (ret != 0) {
Gilles Peskineb699f072019-04-26 16:06:02 +02001212 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001213 }
1214 if (mbedtls_mpi_cmp_int(&mpi, 65537) == 0) {
Gilles Peskine772c8b12019-04-26 17:37:21 +02001215 /* It's the default value, which is reported as an empty string,
1216 * so there's nothing to do. */
1217 goto exit;
1218 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001219
Gilles Peskine449bd832023-01-11 14:50:10 +01001220 buflen = mbedtls_mpi_size(&mpi);
1221 buffer = mbedtls_calloc(1, buflen);
1222 if (buffer == NULL) {
Gilles Peskineb699f072019-04-26 16:06:02 +02001223 ret = MBEDTLS_ERR_MPI_ALLOC_FAILED;
1224 goto exit;
1225 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001226 ret = mbedtls_mpi_write_binary(&mpi, buffer, buflen);
1227 if (ret != 0) {
Gilles Peskineb699f072019-04-26 16:06:02 +02001228 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001229 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001230 attributes->domain_parameters = buffer;
1231 attributes->domain_parameters_size = buflen;
1232
1233exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01001234 mbedtls_mpi_free(&mpi);
1235 if (ret != 0) {
1236 mbedtls_free(buffer);
1237 }
1238 return mbedtls_to_psa_error(ret);
Gilles Peskineb699f072019-04-26 16:06:02 +02001239}
Valerio Settib2bcedb2023-07-10 11:24:00 +02001240#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT) ||
John Durkop9814fa22020-11-04 12:28:15 -08001241 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001242
Gilles Peskinebfd322f2019-07-23 11:58:03 +02001243/** Retrieve all the publicly-accessible attributes of a key.
1244 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001245psa_status_t psa_get_key_attributes(mbedtls_svc_key_id_t key,
1246 psa_key_attributes_t *attributes)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001247{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001248 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001249 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001250 psa_key_slot_t *slot;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001251
Gilles Peskine449bd832023-01-11 14:50:10 +01001252 psa_reset_key_attributes(attributes);
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001253
Gilles Peskine449bd832023-01-11 14:50:10 +01001254 status = psa_get_and_lock_key_slot_with_policy(key, &slot, 0, 0);
1255 if (status != PSA_SUCCESS) {
1256 return status;
1257 }
Gilles Peskineb870b182018-07-06 16:02:09 +02001258
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001259 attributes->core = slot->attr;
Gilles Peskine449bd832023-01-11 14:50:10 +01001260 attributes->core.flags &= (MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1261 MBEDTLS_PSA_KA_MASK_DUAL_USE);
Gilles Peskinec8000c02019-08-02 20:15:51 +02001262
1263#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001264 if (psa_get_se_driver_entry(slot->attr.lifetime) != NULL) {
1265 psa_set_key_slot_number(attributes,
1266 psa_key_slot_get_slot_number(slot));
1267 }
Gilles Peskinec8000c02019-08-02 20:15:51 +02001268#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineb699f072019-04-26 16:06:02 +02001269
Gilles Peskine449bd832023-01-11 14:50:10 +01001270 switch (slot->attr.type) {
Valerio Settib2bcedb2023-07-10 11:24:00 +02001271#if (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) && \
1272 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) || \
John Durkop0e005192020-10-31 22:06:54 -07001273 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02001274 case PSA_KEY_TYPE_RSA_KEY_PAIR:
Gilles Peskineb699f072019-04-26 16:06:02 +02001275 case PSA_KEY_TYPE_RSA_PUBLIC_KEY:
Pengyu Lvf75893b2023-12-08 17:21:39 +08001276 /* TODO: This is a temporary situation where domain parameters are deprecated,
1277 * but we need it for namely generating an RSA key with a non-default exponent.
1278 * This would be improved after https://github.com/Mbed-TLS/mbedtls/issues/6494.
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001279 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001280 if (!psa_key_lifetime_is_external(slot->attr.lifetime)) {
Steven Cooremana2371e52020-07-28 14:30:39 +02001281 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02001282
Ronald Cron90857082020-11-25 14:58:33 +01001283 status = mbedtls_psa_rsa_load_representation(
Gilles Peskine449bd832023-01-11 14:50:10 +01001284 slot->attr.type,
1285 slot->key.data,
1286 slot->key.bytes,
1287 &rsa);
1288 if (status != PSA_SUCCESS) {
Steven Cooremana01795d2020-07-24 22:48:15 +02001289 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01001290 }
Steven Cooremana01795d2020-07-24 22:48:15 +02001291
Gilles Peskine449bd832023-01-11 14:50:10 +01001292 status = psa_get_rsa_public_exponent(rsa,
1293 attributes);
1294 mbedtls_rsa_free(rsa);
1295 mbedtls_free(rsa);
Steven Cooremana01795d2020-07-24 22:48:15 +02001296 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001297 break;
Pengyu Lve9efbc22023-12-08 16:59:08 +08001298#else
1299 case PSA_KEY_TYPE_RSA_KEY_PAIR:
1300 case PSA_KEY_TYPE_RSA_PUBLIC_KEY:
1301 attributes->domain_parameters = NULL;
1302 attributes->domain_parameters_size = SIZE_MAX;
1303 break;
Valerio Settib2bcedb2023-07-10 11:24:00 +02001304#endif /* (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) && \
1305 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) ||
John Durkop9814fa22020-11-04 12:28:15 -08001306 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001307 default:
1308 /* Nothing else to do. */
1309 break;
1310 }
1311
Gilles Peskine449bd832023-01-11 14:50:10 +01001312 if (status != PSA_SUCCESS) {
1313 psa_reset_key_attributes(attributes);
1314 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001315
Ryan Everetta103ec92024-01-31 13:59:57 +00001316 unlock_status = psa_unregister_read_under_mutex(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02001317
Gilles Peskine449bd832023-01-11 14:50:10 +01001318 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001319}
1320
Gilles Peskinec8000c02019-08-02 20:15:51 +02001321#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1322psa_status_t psa_get_key_slot_number(
1323 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01001324 psa_key_slot_number_t *slot_number)
Gilles Peskinec8000c02019-08-02 20:15:51 +02001325{
Gilles Peskine449bd832023-01-11 14:50:10 +01001326 if (attributes->core.flags & MBEDTLS_PSA_KA_FLAG_HAS_SLOT_NUMBER) {
Gilles Peskinec8000c02019-08-02 20:15:51 +02001327 *slot_number = attributes->slot_number;
Gilles Peskine449bd832023-01-11 14:50:10 +01001328 return PSA_SUCCESS;
1329 } else {
1330 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinec8000c02019-08-02 20:15:51 +02001331 }
Gilles Peskinec8000c02019-08-02 20:15:51 +02001332}
1333#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1334
Gilles Peskine449bd832023-01-11 14:50:10 +01001335static psa_status_t psa_export_key_buffer_internal(const uint8_t *key_buffer,
1336 size_t key_buffer_size,
1337 uint8_t *data,
1338 size_t data_size,
1339 size_t *data_length)
Steven Cooremana01795d2020-07-24 22:48:15 +02001340{
Gilles Peskine449bd832023-01-11 14:50:10 +01001341 if (key_buffer_size > data_size) {
1342 return PSA_ERROR_BUFFER_TOO_SMALL;
1343 }
1344 memcpy(data, key_buffer, key_buffer_size);
1345 memset(data + key_buffer_size, 0,
1346 data_size - key_buffer_size);
Ronald Crond18b5f82020-11-25 16:46:05 +01001347 *data_length = key_buffer_size;
Gilles Peskine449bd832023-01-11 14:50:10 +01001348 return PSA_SUCCESS;
Steven Cooremana01795d2020-07-24 22:48:15 +02001349}
1350
Ronald Cron7285cda2020-11-26 14:46:37 +01001351psa_status_t psa_export_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001352 const psa_key_attributes_t *attributes,
1353 const uint8_t *key_buffer, size_t key_buffer_size,
Gilles Peskine449bd832023-01-11 14:50:10 +01001354 uint8_t *data, size_t data_size, size_t *data_length)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001355{
Ronald Crond18b5f82020-11-25 16:46:05 +01001356 psa_key_type_t type = attributes->core.type;
1357
Gilles Peskine449bd832023-01-11 14:50:10 +01001358 if (key_type_is_raw_bytes(type) ||
1359 PSA_KEY_TYPE_IS_RSA(type) ||
Przemek Stekiel472b3f32022-12-01 14:38:49 +01001360 PSA_KEY_TYPE_IS_ECC(type) ||
1361 PSA_KEY_TYPE_IS_DH(type)) {
Gilles Peskine449bd832023-01-11 14:50:10 +01001362 return psa_export_key_buffer_internal(
1363 key_buffer, key_buffer_size,
1364 data, data_size, data_length);
1365 } else {
Ronald Cron9486f9d2020-11-26 13:36:23 +01001366 /* This shouldn't happen in the reference implementation, but
1367 it is valid for a special-purpose implementation to omit
1368 support for exporting certain key types. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001369 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron9486f9d2020-11-26 13:36:23 +01001370 }
1371}
1372
Gilles Peskine449bd832023-01-11 14:50:10 +01001373psa_status_t psa_export_key(mbedtls_svc_key_id_t key,
1374 uint8_t *data,
1375 size_t data_size,
1376 size_t *data_length)
Ronald Cron9486f9d2020-11-26 13:36:23 +01001377{
1378 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
1379 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
1380 psa_key_slot_t *slot;
1381
Ronald Crone907e552021-01-18 13:22:38 +01001382 /* Reject a zero-length output buffer now, since this can never be a
1383 * valid key representation. This way we know that data must be a valid
1384 * pointer and we can do things like memset(data, ..., data_size). */
Gilles Peskine449bd832023-01-11 14:50:10 +01001385 if (data_size == 0) {
1386 return PSA_ERROR_BUFFER_TOO_SMALL;
1387 }
Ronald Crone907e552021-01-18 13:22:38 +01001388
Ronald Cron9486f9d2020-11-26 13:36:23 +01001389 /* Set the key to empty now, so that even when there are errors, we always
1390 * set data_length to a value between 0 and data_size. On error, setting
1391 * the key to empty is a good choice because an empty key representation is
1392 * unlikely to be accepted anywhere. */
Jaeden Amerof24c7f82018-06-27 17:20:43 +01001393 *data_length = 0;
1394
Ronald Cron9486f9d2020-11-26 13:36:23 +01001395 /* Export requires the EXPORT flag. There is an exception for public keys,
1396 * which don't require any flag, but
1397 * psa_get_and_lock_key_slot_with_policy() takes care of this.
1398 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001399 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
1400 PSA_KEY_USAGE_EXPORT, 0);
1401 if (status != PSA_SUCCESS) {
1402 return status;
1403 }
mohammad160306e79202018-03-28 13:17:44 +03001404
Ronald Crond18b5f82020-11-25 16:46:05 +01001405 psa_key_attributes_t attributes = {
1406 .core = slot->attr
1407 };
Gilles Peskine449bd832023-01-11 14:50:10 +01001408 status = psa_driver_wrapper_export_key(&attributes,
1409 slot->key.data, slot->key.bytes,
1410 data, data_size, data_length);
Ronald Cron9486f9d2020-11-26 13:36:23 +01001411
Ryan Everetta103ec92024-01-31 13:59:57 +00001412 unlock_status = psa_unregister_read_under_mutex(slot);
Ronald Cron9486f9d2020-11-26 13:36:23 +01001413
Gilles Peskine449bd832023-01-11 14:50:10 +01001414 return (status == PSA_SUCCESS) ? unlock_status : status;
Ronald Cron9486f9d2020-11-26 13:36:23 +01001415}
1416
Ronald Cron7285cda2020-11-26 14:46:37 +01001417psa_status_t psa_export_public_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001418 const psa_key_attributes_t *attributes,
1419 const uint8_t *key_buffer,
1420 size_t key_buffer_size,
1421 uint8_t *data,
1422 size_t data_size,
Gilles Peskine449bd832023-01-11 14:50:10 +01001423 size_t *data_length)
Ronald Cron9486f9d2020-11-26 13:36:23 +01001424{
Ronald Crond18b5f82020-11-25 16:46:05 +01001425 psa_key_type_t type = attributes->core.type;
Ronald Crond18b5f82020-11-25 16:46:05 +01001426
Przemek Stekiel6fd72b62023-04-27 10:20:56 +02001427 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(type) &&
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001428 (PSA_KEY_TYPE_IS_RSA(type) || PSA_KEY_TYPE_IS_ECC(type) ||
1429 PSA_KEY_TYPE_IS_DH(type))) {
Przemek Stekiel6fd72b62023-04-27 10:20:56 +02001430 /* Exporting public -> public */
1431 return psa_export_key_buffer_internal(
1432 key_buffer, key_buffer_size,
1433 data, data_size, data_length);
1434 } else if (PSA_KEY_TYPE_IS_RSA(type)) {
Valerio Settib2bcedb2023-07-10 11:24:00 +02001435#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT) || \
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001436 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
1437 return mbedtls_psa_rsa_export_public_key(attributes,
1438 key_buffer,
1439 key_buffer_size,
1440 data,
1441 data_size,
1442 data_length);
Darryl Green9e2d7a02018-07-24 16:33:30 +01001443#else
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001444 /* We don't know how to convert a private RSA key to public. */
1445 return PSA_ERROR_NOT_SUPPORTED;
Valerio Settib2bcedb2023-07-10 11:24:00 +02001446#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT) ||
John Durkop9814fa22020-11-04 12:28:15 -08001447 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Przemek Stekiel6fd72b62023-04-27 10:20:56 +02001448 } else if (PSA_KEY_TYPE_IS_ECC(type)) {
Valerio Setti27c501a2023-06-27 16:58:52 +02001449#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_EXPORT) || \
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001450 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
1451 return mbedtls_psa_ecp_export_public_key(attributes,
1452 key_buffer,
1453 key_buffer_size,
1454 data,
1455 data_size,
1456 data_length);
Steven Cooreman560c28a2020-07-24 23:20:24 +02001457#else
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001458 /* We don't know how to convert a private ECC key to public */
1459 return PSA_ERROR_NOT_SUPPORTED;
Valerio Setti27c501a2023-06-27 16:58:52 +02001460#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_EXPORT) ||
John Durkop9814fa22020-11-04 12:28:15 -08001461 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
Przemek Stekiel6fd72b62023-04-27 10:20:56 +02001462 } else if (PSA_KEY_TYPE_IS_DH(type)) {
Valerio Settia55f0422023-07-10 15:34:41 +02001463#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_EXPORT) || \
Przemek Stekiel6d85afa2023-04-28 11:42:17 +02001464 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY)
Przemek Stekiel152bb462023-06-01 11:52:39 +02001465 return mbedtls_psa_ffdh_export_public_key(attributes,
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001466 key_buffer,
1467 key_buffer_size,
1468 data, data_size,
1469 data_length);
Przemek Stekiel472b3f32022-12-01 14:38:49 +01001470#else
Przemek Stekiel472b3f32022-12-01 14:38:49 +01001471 return PSA_ERROR_NOT_SUPPORTED;
Valerio Settia55f0422023-07-10 15:34:41 +02001472#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_EXPORT) ||
Przemek Stekiel6d85afa2023-04-28 11:42:17 +02001473 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY) */
Gilles Peskine449bd832023-01-11 14:50:10 +01001474 } else {
Przemek Stekiel0b11ee02023-05-16 13:26:06 +02001475 (void) key_buffer;
1476 (void) key_buffer_size;
1477 (void) data;
1478 (void) data_size;
1479 (void) data_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01001480 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman560c28a2020-07-24 23:20:24 +02001481 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001482}
Ronald Crond18b5f82020-11-25 16:46:05 +01001483
Gilles Peskine449bd832023-01-11 14:50:10 +01001484psa_status_t psa_export_public_key(mbedtls_svc_key_id_t key,
1485 uint8_t *data,
1486 size_t data_size,
1487 size_t *data_length)
Moran Pekerdd4ea382018-04-03 15:30:03 +03001488{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001489 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001490 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001491 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01001492 psa_key_attributes_t attributes;
Darryl Greendd8fb772018-11-07 16:00:44 +00001493
Ronald Crone907e552021-01-18 13:22:38 +01001494 /* Reject a zero-length output buffer now, since this can never be a
1495 * valid key representation. This way we know that data must be a valid
1496 * pointer and we can do things like memset(data, ..., data_size). */
Gilles Peskine449bd832023-01-11 14:50:10 +01001497 if (data_size == 0) {
1498 return PSA_ERROR_BUFFER_TOO_SMALL;
1499 }
Ronald Crone907e552021-01-18 13:22:38 +01001500
Darryl Greendd8fb772018-11-07 16:00:44 +00001501 /* Set the key to empty now, so that even when there are errors, we always
1502 * set data_length to a value between 0 and data_size. On error, setting
1503 * the key to empty is a good choice because an empty key representation is
1504 * unlikely to be accepted anywhere. */
1505 *data_length = 0;
1506
1507 /* Exporting a public key doesn't require a usage flag. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001508 status = psa_get_and_lock_key_slot_with_policy(key, &slot, 0, 0);
1509 if (status != PSA_SUCCESS) {
1510 return status;
1511 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001512
Gilles Peskine449bd832023-01-11 14:50:10 +01001513 if (!PSA_KEY_TYPE_IS_ASYMMETRIC(slot->attr.type)) {
1514 status = PSA_ERROR_INVALID_ARGUMENT;
1515 goto exit;
Ronald Cron9486f9d2020-11-26 13:36:23 +01001516 }
1517
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01001518 attributes = (psa_key_attributes_t) {
Ronald Crond18b5f82020-11-25 16:46:05 +01001519 .core = slot->attr
1520 };
Ronald Cron67227982020-11-26 15:16:05 +01001521 status = psa_driver_wrapper_export_public_key(
Ronald Crond18b5f82020-11-25 16:46:05 +01001522 &attributes, slot->key.data, slot->key.bytes,
Gilles Peskine449bd832023-01-11 14:50:10 +01001523 data, data_size, data_length);
Ronald Cron9486f9d2020-11-26 13:36:23 +01001524
1525exit:
Ryan Everetta103ec92024-01-31 13:59:57 +00001526 unlock_status = psa_unregister_read_under_mutex(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02001527
Gilles Peskine449bd832023-01-11 14:50:10 +01001528 return (status == PSA_SUCCESS) ? unlock_status : status;
Moran Pekerdd4ea382018-04-03 15:30:03 +03001529}
1530
Tom Cosgrove6ef9bb32023-03-08 14:19:51 +00001531MBEDTLS_STATIC_ASSERT(
1532 (MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE) == 0,
1533 "One or more key attribute flag is listed as both external-only and dual-use")
1534MBEDTLS_STATIC_ASSERT(
1535 (PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE) == 0,
1536 "One or more key attribute flag is listed as both internal-only and dual-use")
1537MBEDTLS_STATIC_ASSERT(
1538 (PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY) == 0,
1539 "One or more key attribute flag is listed as both internal-only and external-only")
Gilles Peskine91e8c332019-08-02 19:19:39 +02001540
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001541/** Validate that a key policy is internally well-formed.
1542 *
1543 * This function only rejects invalid policies. It does not validate the
1544 * consistency of the policy with respect to other attributes of the key
1545 * such as the key type.
1546 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001547static psa_status_t psa_validate_key_policy(const psa_key_policy_t *policy)
Gilles Peskine4747d192019-04-17 15:05:45 +02001548{
Gilles Peskine449bd832023-01-11 14:50:10 +01001549 if ((policy->usage & ~(PSA_KEY_USAGE_EXPORT |
1550 PSA_KEY_USAGE_COPY |
1551 PSA_KEY_USAGE_ENCRYPT |
1552 PSA_KEY_USAGE_DECRYPT |
1553 PSA_KEY_USAGE_SIGN_MESSAGE |
1554 PSA_KEY_USAGE_VERIFY_MESSAGE |
1555 PSA_KEY_USAGE_SIGN_HASH |
1556 PSA_KEY_USAGE_VERIFY_HASH |
1557 PSA_KEY_USAGE_VERIFY_DERIVATION |
1558 PSA_KEY_USAGE_DERIVE)) != 0) {
1559 return PSA_ERROR_INVALID_ARGUMENT;
1560 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001561
Gilles Peskine449bd832023-01-11 14:50:10 +01001562 return PSA_SUCCESS;
Gilles Peskine4747d192019-04-17 15:05:45 +02001563}
1564
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001565/** Validate the internal consistency of key attributes.
1566 *
1567 * This function only rejects invalid attribute values. If does not
1568 * validate the consistency of the attributes with any key data that may
1569 * be involved in the creation of the key.
1570 *
1571 * Call this function early in the key creation process.
1572 *
1573 * \param[in] attributes Key attributes for the new key.
1574 * \param[out] p_drv On any return, the driver for the key, if any.
1575 * NULL for a transparent key.
1576 *
1577 */
1578static psa_status_t psa_validate_key_attributes(
1579 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01001580 psa_se_drv_table_entry_t **p_drv)
Darryl Green0c6575a2018-11-07 16:05:30 +00001581{
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001582 psa_status_t status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine449bd832023-01-11 14:50:10 +01001583 psa_key_lifetime_t lifetime = psa_get_key_lifetime(attributes);
1584 mbedtls_svc_key_id_t key = psa_get_key_id(attributes);
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001585
Gilles Peskine449bd832023-01-11 14:50:10 +01001586 status = psa_validate_key_location(lifetime, p_drv);
1587 if (status != PSA_SUCCESS) {
1588 return status;
Ronald Crond2ed4812020-07-17 16:11:30 +02001589 }
1590
Gilles Peskine449bd832023-01-11 14:50:10 +01001591 status = psa_validate_key_persistence(lifetime);
1592 if (status != PSA_SUCCESS) {
1593 return status;
1594 }
1595
1596 if (PSA_KEY_LIFETIME_IS_VOLATILE(lifetime)) {
1597 if (MBEDTLS_SVC_KEY_ID_GET_KEY_ID(key) != 0) {
1598 return PSA_ERROR_INVALID_ARGUMENT;
1599 }
1600 } else {
1601 if (!psa_is_valid_key_id(psa_get_key_id(attributes), 0)) {
1602 return PSA_ERROR_INVALID_ARGUMENT;
1603 }
1604 }
1605
1606 status = psa_validate_key_policy(&attributes->core.policy);
1607 if (status != PSA_SUCCESS) {
1608 return status;
1609 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001610
1611 /* Refuse to create overly large keys.
1612 * Note that this doesn't trigger on import if the attributes don't
1613 * explicitly specify a size (so psa_get_key_bits returns 0), so
1614 * psa_import_key() needs its own checks. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001615 if (psa_get_key_bits(attributes) > PSA_MAX_KEY_BITS) {
1616 return PSA_ERROR_NOT_SUPPORTED;
1617 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001618
Gilles Peskine91e8c332019-08-02 19:19:39 +02001619 /* Reject invalid flags. These should not be reachable through the API. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001620 if (attributes->core.flags & ~(MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1621 MBEDTLS_PSA_KA_MASK_DUAL_USE)) {
1622 return PSA_ERROR_INVALID_ARGUMENT;
1623 }
Gilles Peskine91e8c332019-08-02 19:19:39 +02001624
Gilles Peskine449bd832023-01-11 14:50:10 +01001625 return PSA_SUCCESS;
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001626}
1627
Gilles Peskine4747d192019-04-17 15:05:45 +02001628/** Prepare a key slot to receive key material.
1629 *
1630 * This function allocates a key slot and sets its metadata.
1631 *
1632 * If this function fails, call psa_fail_key_creation().
1633 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001634 * This function is intended to be used as follows:
1635 * -# Call psa_start_key_creation() to allocate a key slot, prepare
Ronald Croncf56a0a2020-08-04 09:51:30 +02001636 * it with the specified attributes, and in case of a volatile key assign it
1637 * a volatile key identifier.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001638 * -# Populate the slot with the key material.
1639 * -# Call psa_finish_key_creation() to finalize the creation of the slot.
1640 * In case of failure at any step, stop the sequence and call
1641 * psa_fail_key_creation().
1642 *
Ryan Everettb69118e2024-01-02 15:54:32 +00001643 * On success, the key slot's state is PSA_SLOT_FILLING.
1644 * It is the responsibility of the caller to change the slot's state to
1645 * PSA_SLOT_EMPTY/FULL once key creation has finished.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001646 *
Gilles Peskinedf179142019-07-15 22:02:14 +02001647 * \param method An identification of the calling function.
Gilles Peskine011e4282019-06-26 18:34:38 +02001648 * \param[in] attributes Key attributes for the new key.
Gilles Peskine011e4282019-06-26 18:34:38 +02001649 * \param[out] p_slot On success, a pointer to the prepared slot.
1650 * \param[out] p_drv On any return, the driver for the key, if any.
1651 * NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001652 *
1653 * \retval #PSA_SUCCESS
1654 * The key slot is ready to receive key material.
1655 * \return If this function fails, the key slot is an invalid state.
1656 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001657 */
1658static psa_status_t psa_start_key_creation(
Gilles Peskinedf179142019-07-15 22:02:14 +02001659 psa_key_creation_method_t method,
Gilles Peskine4747d192019-04-17 15:05:45 +02001660 const psa_key_attributes_t *attributes,
Gilles Peskine011e4282019-06-26 18:34:38 +02001661 psa_key_slot_t **p_slot,
Gilles Peskine449bd832023-01-11 14:50:10 +01001662 psa_se_drv_table_entry_t **p_drv)
Gilles Peskine4747d192019-04-17 15:05:45 +02001663{
1664 psa_status_t status;
Ronald Cron2a993152020-07-17 14:13:26 +02001665 psa_key_id_t volatile_key_id;
Gilles Peskine4747d192019-04-17 15:05:45 +02001666 psa_key_slot_t *slot;
1667
Gilles Peskinedf179142019-07-15 22:02:14 +02001668 (void) method;
Gilles Peskine011e4282019-06-26 18:34:38 +02001669 *p_drv = NULL;
1670
Gilles Peskine449bd832023-01-11 14:50:10 +01001671 status = psa_validate_key_attributes(attributes, p_drv);
1672 if (status != PSA_SUCCESS) {
1673 return status;
1674 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001675
Ryan Everettb69118e2024-01-02 15:54:32 +00001676 status = psa_reserve_free_key_slot(&volatile_key_id, p_slot);
Gilles Peskine449bd832023-01-11 14:50:10 +01001677 if (status != PSA_SUCCESS) {
1678 return status;
1679 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001680 slot = *p_slot;
1681
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001682 /* We're storing the declared bit-size of the key. It's up to each
1683 * creation mechanism to verify that this information is correct.
1684 * It's automatically correct for mechanisms that use the bit-size as
Gilles Peskineb46bef22019-07-30 21:32:04 +02001685 * an input (generate, device) but not for those where the bit-size
Ronald Cronc4d1b512020-07-31 11:26:37 +02001686 * is optional (import, copy). In case of a volatile key, assign it the
1687 * volatile key identifier associated to the slot returned to contain its
1688 * definition. */
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001689
1690 slot->attr = attributes->core;
Gilles Peskine449bd832023-01-11 14:50:10 +01001691 if (PSA_KEY_LIFETIME_IS_VOLATILE(slot->attr.lifetime)) {
Ronald Cronc4d1b512020-07-31 11:26:37 +02001692#if !defined(MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER)
1693 slot->attr.id = volatile_key_id;
1694#else
1695 slot->attr.id.key_id = volatile_key_id;
1696#endif
1697 }
Gilles Peskinec744d992019-07-30 17:26:54 +02001698
Gilles Peskine91e8c332019-08-02 19:19:39 +02001699 /* Erase external-only flags from the internal copy. To access
Gilles Peskine013f5472019-08-07 15:42:14 +02001700 * external-only flags, query `attributes`. Thanks to the check
1701 * in psa_validate_key_attributes(), this leaves the dual-use
Ryan Everettb69118e2024-01-02 15:54:32 +00001702 * flags and any internal flag that psa_reserve_free_key_slot()
Gilles Peskine013f5472019-08-07 15:42:14 +02001703 * may have set. */
1704 slot->attr.flags &= ~MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY;
Gilles Peskine91e8c332019-08-02 19:19:39 +02001705
Gilles Peskinecbaff462019-07-12 23:46:04 +02001706#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001707 /* For a key in a secure element, we need to do three things
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001708 * when creating or registering a persistent key:
Gilles Peskine60450a42019-07-25 11:32:45 +02001709 * create the key file in internal storage, create the
1710 * key inside the secure element, and update the driver's
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001711 * persistent data. This is done by starting a transaction that will
1712 * encompass these three actions.
1713 * For registering a volatile key, we just need to find an appropriate
1714 * slot number inside the SE. Since the key is designated volatile, creating
1715 * a transaction is not required. */
Gilles Peskine60450a42019-07-25 11:32:45 +02001716 /* The first thing to do is to find a slot number for the new key.
1717 * We save the slot number in persistent storage as part of the
1718 * transaction data. It will be needed to recover if the power
1719 * fails during the key creation process, to clean up on the secure
1720 * element side after restarting. Obtaining a slot number from the
1721 * secure element driver updates its persistent state, but we do not yet
1722 * save the driver's persistent state, so that if the power fails,
Gilles Peskinefc762652019-07-22 19:30:34 +02001723 * we can roll back to a state where the key doesn't exist. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001724 if (*p_drv != NULL) {
Ronald Cronea0f8a62020-11-25 17:52:23 +01001725 psa_key_slot_number_t slot_number;
Gilles Peskine449bd832023-01-11 14:50:10 +01001726 status = psa_find_se_slot_for_key(attributes, method, *p_drv,
1727 &slot_number);
1728 if (status != PSA_SUCCESS) {
1729 return status;
1730 }
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001731
Gilles Peskine449bd832023-01-11 14:50:10 +01001732 if (!PSA_KEY_LIFETIME_IS_VOLATILE(attributes->core.lifetime)) {
1733 psa_crypto_prepare_transaction(PSA_CRYPTO_TRANSACTION_CREATE_KEY);
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001734 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001735 psa_crypto_transaction.key.slot = slot_number;
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001736 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskine449bd832023-01-11 14:50:10 +01001737 status = psa_crypto_save_transaction();
1738 if (status != PSA_SUCCESS) {
1739 (void) psa_crypto_stop_transaction();
1740 return status;
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001741 }
Gilles Peskine66be51c2019-07-25 18:02:52 +02001742 }
Ronald Cronea0f8a62020-11-25 17:52:23 +01001743
1744 status = psa_copy_key_material_into_slot(
Gilles Peskine449bd832023-01-11 14:50:10 +01001745 slot, (uint8_t *) (&slot_number), sizeof(slot_number));
Darryl Green0c6575a2018-11-07 16:05:30 +00001746 }
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001747
Gilles Peskine449bd832023-01-11 14:50:10 +01001748 if (*p_drv == NULL && method == PSA_KEY_CREATION_REGISTER) {
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001749 /* Key registration only makes sense with a secure element. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001750 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001751 }
Gilles Peskinecbaff462019-07-12 23:46:04 +02001752#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1753
Gilles Peskine449bd832023-01-11 14:50:10 +01001754 return PSA_SUCCESS;
Darryl Green0c6575a2018-11-07 16:05:30 +00001755}
Gilles Peskine4747d192019-04-17 15:05:45 +02001756
1757/** Finalize the creation of a key once its key material has been set.
1758 *
1759 * This entails writing the key to persistent storage.
1760 *
1761 * If this function fails, call psa_fail_key_creation().
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001762 * See the documentation of psa_start_key_creation() for the intended use
1763 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001764 *
Ryan Everettb69118e2024-01-02 15:54:32 +00001765 * If the finalization succeeds, the function sets the key slot's state to
1766 * PSA_SLOT_FULL, and the key slot can no longer be accessed as part of the
1767 * key creation process.
Ronald Cron50972942020-11-14 11:28:25 +01001768 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001769 * \param[in,out] slot Pointer to the slot with key material.
1770 * \param[in] driver The secure element driver for the key,
1771 * or NULL for a transparent key.
Ronald Cron81709fc2020-11-14 12:10:32 +01001772 * \param[out] key On success, identifier of the key. Note that the
1773 * key identifier is also stored in the key slot.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001774 *
1775 * \retval #PSA_SUCCESS
Ronald Croncf56a0a2020-08-04 09:51:30 +02001776 * The key was successfully created.
Gilles Peskineed733552023-02-14 19:21:09 +01001777 * \retval #PSA_ERROR_INSUFFICIENT_MEMORY \emptydescription
1778 * \retval #PSA_ERROR_INSUFFICIENT_STORAGE \emptydescription
1779 * \retval #PSA_ERROR_ALREADY_EXISTS \emptydescription
1780 * \retval #PSA_ERROR_DATA_INVALID \emptydescription
1781 * \retval #PSA_ERROR_DATA_CORRUPT \emptydescription
1782 * \retval #PSA_ERROR_STORAGE_FAILURE \emptydescription
gabor-mezei-arm452b0a32020-11-09 17:42:55 +01001783 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001784 * \return If this function fails, the key slot is an invalid state.
1785 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001786 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001787static psa_status_t psa_finish_key_creation(
1788 psa_key_slot_t *slot,
Ronald Cron81709fc2020-11-14 12:10:32 +01001789 psa_se_drv_table_entry_t *driver,
1790 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02001791{
1792 psa_status_t status = PSA_SUCCESS;
Gilles Peskine30afafd2019-04-25 13:47:40 +02001793 (void) slot;
Gilles Peskine011e4282019-06-26 18:34:38 +02001794 (void) driver;
Gilles Peskine4747d192019-04-17 15:05:45 +02001795
1796#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001797 if (!PSA_KEY_LIFETIME_IS_VOLATILE(slot->attr.lifetime)) {
Gilles Peskine1df83d42019-07-23 16:13:14 +02001798#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001799 if (driver != NULL) {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001800 psa_se_key_data_storage_t data;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001801 psa_key_slot_number_t slot_number =
Gilles Peskine449bd832023-01-11 14:50:10 +01001802 psa_key_slot_get_slot_number(slot);
Ronald Cronea0f8a62020-11-25 17:52:23 +01001803
Tom Cosgrove6ef9bb32023-03-08 14:19:51 +00001804 MBEDTLS_STATIC_ASSERT(sizeof(slot_number) ==
1805 sizeof(data.slot_number),
1806 "Slot number size does not match psa_se_key_data_storage_t");
1807
Gilles Peskine449bd832023-01-11 14:50:10 +01001808 memcpy(&data.slot_number, &slot_number, sizeof(slot_number));
1809 status = psa_save_persistent_key(&slot->attr,
1810 (uint8_t *) &data,
1811 sizeof(data));
1812 } else
Gilles Peskine1df83d42019-07-23 16:13:14 +02001813#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1814 {
Steven Cooreman40120f62020-10-29 11:42:22 +01001815 /* Key material is saved in export representation in the slot, so
1816 * just pass the slot buffer for storage. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001817 status = psa_save_persistent_key(&slot->attr,
1818 slot->key.data,
1819 slot->key.bytes);
Gilles Peskine1df83d42019-07-23 16:13:14 +02001820 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001821 }
Darryl Green0c6575a2018-11-07 16:05:30 +00001822#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
1823
Gilles Peskinecbaff462019-07-12 23:46:04 +02001824#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001825 /* Finish the transaction for a key creation. This does not
1826 * happen when registering an existing key. Detect this case
1827 * by checking whether a transaction is in progress (actual
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001828 * creation of a persistent key in a secure element requires a transaction,
1829 * but registration or volatile key creation doesn't use one). */
Gilles Peskine449bd832023-01-11 14:50:10 +01001830 if (driver != NULL &&
1831 psa_crypto_transaction.unknown.type == PSA_CRYPTO_TRANSACTION_CREATE_KEY) {
1832 status = psa_save_se_persistent_data(driver);
1833 if (status != PSA_SUCCESS) {
1834 psa_destroy_persistent_key(slot->attr.id);
1835 return status;
Gilles Peskinecbaff462019-07-12 23:46:04 +02001836 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001837 status = psa_crypto_stop_transaction();
Gilles Peskinecbaff462019-07-12 23:46:04 +02001838 }
1839#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1840
Gilles Peskine449bd832023-01-11 14:50:10 +01001841 if (status == PSA_SUCCESS) {
Ronald Cron81709fc2020-11-14 12:10:32 +01001842 *key = slot->attr.id;
Ryan Everettb69118e2024-01-02 15:54:32 +00001843 status = psa_key_slot_state_transition(slot, PSA_SLOT_FILLING,
1844 PSA_SLOT_FULL);
Gilles Peskine449bd832023-01-11 14:50:10 +01001845 if (status != PSA_SUCCESS) {
Ronald Cron81709fc2020-11-14 12:10:32 +01001846 *key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01001847 }
Ronald Cron81709fc2020-11-14 12:10:32 +01001848 }
Ronald Cron50972942020-11-14 11:28:25 +01001849
Gilles Peskine449bd832023-01-11 14:50:10 +01001850 return status;
Gilles Peskine4747d192019-04-17 15:05:45 +02001851}
1852
1853/** Abort the creation of a key.
1854 *
1855 * You may call this function after calling psa_start_key_creation(),
1856 * or after psa_finish_key_creation() fails. In other circumstances, this
1857 * function may not clean up persistent storage.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001858 * See the documentation of psa_start_key_creation() for the intended use
Ryan Everettb69118e2024-01-02 15:54:32 +00001859 * of this function. Sets the slot's state to PSA_SLOT_EMPTY.
Gilles Peskine4747d192019-04-17 15:05:45 +02001860 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001861 * \param[in,out] slot Pointer to the slot with key material.
1862 * \param[in] driver The secure element driver for the key,
1863 * or NULL for a transparent key.
Gilles Peskine4747d192019-04-17 15:05:45 +02001864 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001865static void psa_fail_key_creation(psa_key_slot_t *slot,
1866 psa_se_drv_table_entry_t *driver)
Gilles Peskine4747d192019-04-17 15:05:45 +02001867{
Gilles Peskine011e4282019-06-26 18:34:38 +02001868 (void) driver;
1869
Gilles Peskine449bd832023-01-11 14:50:10 +01001870 if (slot == NULL) {
Gilles Peskine4747d192019-04-17 15:05:45 +02001871 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01001872 }
Gilles Peskine011e4282019-06-26 18:34:38 +02001873
1874#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001875 /* TODO: If the key has already been created in the secure
Gilles Peskine011e4282019-06-26 18:34:38 +02001876 * element, and the failure happened later (when saving metadata
1877 * to internal storage), we need to destroy the key in the secure
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001878 * element.
1879 * https://github.com/ARMmbed/mbed-crypto/issues/217
1880 */
Gilles Peskinefc762652019-07-22 19:30:34 +02001881
Gilles Peskined7729582019-08-05 15:55:54 +02001882 /* Abort the ongoing transaction if any (there may not be one if
1883 * the creation process failed before starting one, or if the
1884 * key creation is a registration of a key in a secure element).
1885 * Earlier functions must already have done what it takes to undo any
1886 * partial creation. All that's left is to update the transaction data
1887 * itself. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001888 (void) psa_crypto_stop_transaction();
Gilles Peskine011e4282019-06-26 18:34:38 +02001889#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1890
Gilles Peskine449bd832023-01-11 14:50:10 +01001891 psa_wipe_key_slot(slot);
Gilles Peskine4747d192019-04-17 15:05:45 +02001892}
1893
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001894/** Validate optional attributes during key creation.
1895 *
1896 * Some key attributes are optional during key creation. If they are
1897 * specified in the attributes structure, check that they are consistent
1898 * with the data in the slot.
1899 *
1900 * This function should be called near the end of key creation, after
1901 * the slot in memory is fully populated but before saving persistent data.
1902 */
1903static psa_status_t psa_validate_optional_attributes(
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001904 const psa_key_slot_t *slot,
Gilles Peskine449bd832023-01-11 14:50:10 +01001905 const psa_key_attributes_t *attributes)
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001906{
Gilles Peskine449bd832023-01-11 14:50:10 +01001907 if (attributes->core.type != 0) {
1908 if (attributes->core.type != slot->attr.type) {
1909 return PSA_ERROR_INVALID_ARGUMENT;
1910 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001911 }
1912
Gilles Peskine449bd832023-01-11 14:50:10 +01001913 if (attributes->domain_parameters_size != 0) {
Valerio Settib2bcedb2023-07-10 11:24:00 +02001914#if (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) && \
1915 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01001916 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
1917 if (PSA_KEY_TYPE_IS_RSA(slot->attr.type)) {
Steven Cooremana2371e52020-07-28 14:30:39 +02001918 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman75b74362020-07-28 14:30:13 +02001919 mbedtls_mpi actual, required;
Steven Cooreman6d839f02020-07-30 11:36:45 +02001920 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooremana01795d2020-07-24 22:48:15 +02001921
Ronald Cron90857082020-11-25 14:58:33 +01001922 psa_status_t status = mbedtls_psa_rsa_load_representation(
Gilles Peskine449bd832023-01-11 14:50:10 +01001923 slot->attr.type,
1924 slot->key.data,
1925 slot->key.bytes,
1926 &rsa);
1927 if (status != PSA_SUCCESS) {
1928 return status;
1929 }
Steven Cooreman75b74362020-07-28 14:30:13 +02001930
Gilles Peskine449bd832023-01-11 14:50:10 +01001931 mbedtls_mpi_init(&actual);
1932 mbedtls_mpi_init(&required);
1933 ret = mbedtls_rsa_export(rsa,
1934 NULL, NULL, NULL, NULL, &actual);
1935 mbedtls_rsa_free(rsa);
1936 mbedtls_free(rsa);
1937 if (ret != 0) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001938 goto rsa_exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001939 }
1940 ret = mbedtls_mpi_read_binary(&required,
1941 attributes->domain_parameters,
1942 attributes->domain_parameters_size);
1943 if (ret != 0) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001944 goto rsa_exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001945 }
1946 if (mbedtls_mpi_cmp_mpi(&actual, &required) != 0) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001947 ret = MBEDTLS_ERR_RSA_BAD_INPUT_DATA;
Gilles Peskine449bd832023-01-11 14:50:10 +01001948 }
1949rsa_exit:
1950 mbedtls_mpi_free(&actual);
1951 mbedtls_mpi_free(&required);
1952 if (ret != 0) {
1953 return mbedtls_to_psa_error(ret);
1954 }
1955 } else
Valerio Settib2bcedb2023-07-10 11:24:00 +02001956#endif /* (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) &&
1957 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) ||
John Durkop9814fa22020-11-04 12:28:15 -08001958 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001959 {
Gilles Peskine449bd832023-01-11 14:50:10 +01001960 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001961 }
1962 }
1963
Gilles Peskine449bd832023-01-11 14:50:10 +01001964 if (attributes->core.bits != 0) {
1965 if (attributes->core.bits != slot->attr.bits) {
1966 return PSA_ERROR_INVALID_ARGUMENT;
1967 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001968 }
1969
Gilles Peskine449bd832023-01-11 14:50:10 +01001970 return PSA_SUCCESS;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001971}
1972
Gilles Peskine449bd832023-01-11 14:50:10 +01001973psa_status_t psa_import_key(const psa_key_attributes_t *attributes,
1974 const uint8_t *data,
1975 size_t data_length,
1976 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02001977{
1978 psa_status_t status;
1979 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001980 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001981 size_t bits;
Archanad8a83dc2021-06-14 10:04:16 +05301982 size_t storage_size = data_length;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001983
Ronald Cron81709fc2020-11-14 12:10:32 +01001984 *key = MBEDTLS_SVC_KEY_ID_INIT;
1985
Gilles Peskine0f84d622019-09-12 19:03:13 +02001986 /* Reject zero-length symmetric keys (including raw data key objects).
1987 * This also rejects any key which might be encoded as an empty string,
1988 * which is never valid. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001989 if (data_length == 0) {
1990 return PSA_ERROR_INVALID_ARGUMENT;
1991 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02001992
Archana449608b2021-09-08 15:36:05 +05301993 /* Ensure that the bytes-to-bits conversion cannot overflow. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001994 if (data_length > SIZE_MAX / 8) {
1995 return PSA_ERROR_NOT_SUPPORTED;
1996 }
Archana6ed4bda2021-08-04 10:47:15 +05301997
Gilles Peskine449bd832023-01-11 14:50:10 +01001998 status = psa_start_key_creation(PSA_KEY_CREATION_IMPORT, attributes,
1999 &slot, &driver);
2000 if (status != PSA_SUCCESS) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002001 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002002 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002003
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002004 /* In the case of a transparent key or an opaque key stored in local
Archana449608b2021-09-08 15:36:05 +05302005 * storage ( thus not in the case of importing a key in a secure element
2006 * with storage ( MBEDTLS_PSA_CRYPTO_SE_C ) ),we have to allocate a
2007 * buffer to hold the imported key material. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002008 if (slot->key.data == NULL) {
2009 if (psa_key_lifetime_is_external(attributes->core.lifetime)) {
Archana449608b2021-09-08 15:36:05 +05302010 status = psa_driver_wrapper_get_key_buffer_size_from_key_data(
Gilles Peskine449bd832023-01-11 14:50:10 +01002011 attributes, data, data_length, &storage_size);
2012 if (status != PSA_SUCCESS) {
Archanad8a83dc2021-06-14 10:04:16 +05302013 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002014 }
Archanad8a83dc2021-06-14 10:04:16 +05302015 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002016 status = psa_allocate_buffer_to_slot(slot, storage_size);
2017 if (status != PSA_SUCCESS) {
Gilles Peskineb46bef22019-07-30 21:32:04 +02002018 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002019 }
Gilles Peskine5d309672019-07-12 23:47:28 +02002020 }
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002021
2022 bits = slot->attr.bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01002023 status = psa_driver_wrapper_import_key(attributes,
2024 data, data_length,
2025 slot->key.data,
2026 slot->key.bytes,
2027 &slot->key.bytes, &bits);
2028 if (status != PSA_SUCCESS) {
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002029 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002030 }
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002031
Gilles Peskine449bd832023-01-11 14:50:10 +01002032 if (slot->attr.bits == 0) {
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002033 slot->attr.bits = (psa_key_bits_t) bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01002034 } else if (bits != slot->attr.bits) {
Steven Cooremanac3434f2021-01-15 17:36:02 +01002035 status = PSA_ERROR_INVALID_ARGUMENT;
2036 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02002037 }
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01002038
Archana6ed4bda2021-08-04 10:47:15 +05302039 /* Enforce a size limit, and in particular ensure that the bit
2040 * size fits in its representation type.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01002041 if (bits > PSA_MAX_KEY_BITS) {
Archana6ed4bda2021-08-04 10:47:15 +05302042 status = PSA_ERROR_NOT_SUPPORTED;
2043 goto exit;
2044 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002045 status = psa_validate_optional_attributes(slot, attributes);
2046 if (status != PSA_SUCCESS) {
Gilles Peskine18017402019-07-24 20:25:59 +02002047 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002048 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002049
Gilles Peskine449bd832023-01-11 14:50:10 +01002050 status = psa_finish_key_creation(slot, driver, key);
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002051exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002052 if (status != PSA_SUCCESS) {
2053 psa_fail_key_creation(slot, driver);
2054 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002055
Gilles Peskine449bd832023-01-11 14:50:10 +01002056 return status;
Gilles Peskine4747d192019-04-17 15:05:45 +02002057}
2058
Gilles Peskined7729582019-08-05 15:55:54 +02002059#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2060psa_status_t mbedtls_psa_register_se_key(
Gilles Peskine449bd832023-01-11 14:50:10 +01002061 const psa_key_attributes_t *attributes)
Gilles Peskined7729582019-08-05 15:55:54 +02002062{
2063 psa_status_t status;
2064 psa_key_slot_t *slot = NULL;
2065 psa_se_drv_table_entry_t *driver = NULL;
Ronald Croncf56a0a2020-08-04 09:51:30 +02002066 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskined7729582019-08-05 15:55:54 +02002067
2068 /* Leaving attributes unspecified is not currently supported.
2069 * It could make sense to query the key type and size from the
2070 * secure element, but not all secure elements support this
2071 * and the driver HAL doesn't currently support it. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002072 if (psa_get_key_type(attributes) == PSA_KEY_TYPE_NONE) {
2073 return PSA_ERROR_NOT_SUPPORTED;
2074 }
2075 if (psa_get_key_bits(attributes) == 0) {
2076 return PSA_ERROR_NOT_SUPPORTED;
2077 }
Gilles Peskined7729582019-08-05 15:55:54 +02002078
Gilles Peskine449bd832023-01-11 14:50:10 +01002079 status = psa_start_key_creation(PSA_KEY_CREATION_REGISTER, attributes,
2080 &slot, &driver);
2081 if (status != PSA_SUCCESS) {
Gilles Peskined7729582019-08-05 15:55:54 +02002082 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002083 }
Gilles Peskined7729582019-08-05 15:55:54 +02002084
Gilles Peskine449bd832023-01-11 14:50:10 +01002085 status = psa_finish_key_creation(slot, driver, &key);
Gilles Peskined7729582019-08-05 15:55:54 +02002086
2087exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002088 if (status != PSA_SUCCESS) {
2089 psa_fail_key_creation(slot, driver);
2090 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002091
Gilles Peskined7729582019-08-05 15:55:54 +02002092 /* Registration doesn't keep the key in RAM. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002093 psa_close_key(key);
2094 return status;
Gilles Peskined7729582019-08-05 15:55:54 +02002095}
2096#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2097
Gilles Peskine449bd832023-01-11 14:50:10 +01002098psa_status_t psa_copy_key(mbedtls_svc_key_id_t source_key,
2099 const psa_key_attributes_t *specified_attributes,
2100 mbedtls_svc_key_id_t *target_key)
Gilles Peskinef603c712019-01-19 13:40:11 +01002101{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002102 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01002103 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinef603c712019-01-19 13:40:11 +01002104 psa_key_slot_t *source_slot = NULL;
2105 psa_key_slot_t *target_slot = NULL;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002106 psa_key_attributes_t actual_attributes = *specified_attributes;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002107 psa_se_drv_table_entry_t *driver = NULL;
Archana8a180362021-07-05 02:18:48 +05302108 size_t storage_size = 0;
Gilles Peskinef603c712019-01-19 13:40:11 +01002109
Ronald Cron81709fc2020-11-14 12:10:32 +01002110 *target_key = MBEDTLS_SVC_KEY_ID_INIT;
2111
Archana8a180362021-07-05 02:18:48 +05302112 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002113 source_key, &source_slot, PSA_KEY_USAGE_COPY, 0);
2114 if (status != PSA_SUCCESS) {
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002115 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002116 }
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002117
Gilles Peskine449bd832023-01-11 14:50:10 +01002118 status = psa_validate_optional_attributes(source_slot,
2119 specified_attributes);
2120 if (status != PSA_SUCCESS) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002121 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002122 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002123
Archana9d17bf42021-09-10 06:22:44 +05302124 /* The target key type and number of bits have been validated by
2125 * psa_validate_optional_attributes() to be either equal to zero or
2126 * equal to the ones of the source key. So it is safe to inherit
2127 * them from the source key now."
Archana374fe5b2021-09-08 15:50:28 +05302128 * */
Archana9d17bf42021-09-10 06:22:44 +05302129 actual_attributes.core.bits = source_slot->attr.bits;
2130 actual_attributes.core.type = source_slot->attr.type;
Archana374fe5b2021-09-08 15:50:28 +05302131
2132
Gilles Peskine449bd832023-01-11 14:50:10 +01002133 status = psa_restrict_key_policy(source_slot->attr.type,
2134 &actual_attributes.core.policy,
2135 &source_slot->attr.policy);
2136 if (status != PSA_SUCCESS) {
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002137 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002138 }
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002139
Gilles Peskine449bd832023-01-11 14:50:10 +01002140 status = psa_start_key_creation(PSA_KEY_CREATION_COPY, &actual_attributes,
2141 &target_slot, &driver);
2142 if (status != PSA_SUCCESS) {
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002143 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002144 }
2145 if (PSA_KEY_LIFETIME_GET_LOCATION(target_slot->attr.lifetime) !=
2146 PSA_KEY_LIFETIME_GET_LOCATION(source_slot->attr.lifetime)) {
Archana8a180362021-07-05 02:18:48 +05302147 /*
Archana9d17bf42021-09-10 06:22:44 +05302148 * If the source and target keys are stored in different locations,
Archana8a180362021-07-05 02:18:48 +05302149 * the source key would need to be exported as plaintext and re-imported
2150 * in the other location. This has security implications which have not
Archana449608b2021-09-08 15:36:05 +05302151 * been fully mapped. For now, this can be achieved through
Archana8a180362021-07-05 02:18:48 +05302152 * appropriate API invocations from the application, if needed.
2153 * */
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002154 status = PSA_ERROR_NOT_SUPPORTED;
2155 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002156 }
Archana8a180362021-07-05 02:18:48 +05302157 /*
2158 * When the source and target keys are within the same location,
Archana449608b2021-09-08 15:36:05 +05302159 * - For transparent keys it is a blind copy without any driver invocation,
Archana8a180362021-07-05 02:18:48 +05302160 * - For opaque keys this translates to an invocation of the drivers'
2161 * copy_key entry point through the dispatch layer.
2162 * */
Gilles Peskine449bd832023-01-11 14:50:10 +01002163 if (psa_key_lifetime_is_external(actual_attributes.core.lifetime)) {
2164 status = psa_driver_wrapper_get_key_buffer_size(&actual_attributes,
2165 &storage_size);
2166 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302167 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002168 }
Archana374fe5b2021-09-08 15:50:28 +05302169
Gilles Peskine449bd832023-01-11 14:50:10 +01002170 status = psa_allocate_buffer_to_slot(target_slot, storage_size);
2171 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302172 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002173 }
Archana374fe5b2021-09-08 15:50:28 +05302174
Gilles Peskine449bd832023-01-11 14:50:10 +01002175 status = psa_driver_wrapper_copy_key(&actual_attributes,
2176 source_slot->key.data,
2177 source_slot->key.bytes,
2178 target_slot->key.data,
2179 target_slot->key.bytes,
2180 &target_slot->key.bytes);
2181 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302182 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002183 }
2184 } else {
2185 status = psa_copy_key_material_into_slot(target_slot,
Archana9d17bf42021-09-10 06:22:44 +05302186 source_slot->key.data,
Gilles Peskine449bd832023-01-11 14:50:10 +01002187 source_slot->key.bytes);
2188 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302189 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002190 }
Archana8a180362021-07-05 02:18:48 +05302191 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002192 status = psa_finish_key_creation(target_slot, driver, target_key);
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002193exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002194 if (status != PSA_SUCCESS) {
2195 psa_fail_key_creation(target_slot, driver);
2196 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002197
Ryan Everetta103ec92024-01-31 13:59:57 +00002198 unlock_status = psa_unregister_read_under_mutex(source_slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02002199
Gilles Peskine449bd832023-01-11 14:50:10 +01002200 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskinef603c712019-01-19 13:40:11 +01002201}
2202
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02002203
2204
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01002205/****************************************************************/
Gilles Peskine20035e32018-02-03 22:44:14 +01002206/* Message digests */
2207/****************************************************************/
2208
Gilles Peskine449bd832023-01-11 14:50:10 +01002209psa_status_t psa_hash_abort(psa_hash_operation_t *operation)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002210{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002211 /* Aborting a non-active operation is allowed */
Gilles Peskine449bd832023-01-11 14:50:10 +01002212 if (operation->id == 0) {
2213 return PSA_SUCCESS;
2214 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002215
Gilles Peskine449bd832023-01-11 14:50:10 +01002216 psa_status_t status = psa_driver_wrapper_hash_abort(operation);
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002217 operation->id = 0;
2218
Gilles Peskine449bd832023-01-11 14:50:10 +01002219 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002220}
2221
Gilles Peskine449bd832023-01-11 14:50:10 +01002222psa_status_t psa_hash_setup(psa_hash_operation_t *operation,
2223 psa_algorithm_t alg)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002224{
Dave Rodgman685b6a72021-06-24 11:49:14 +01002225 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002226
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002227 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002228 if (operation->id != 0) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002229 status = PSA_ERROR_BAD_STATE;
2230 goto exit;
2231 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002232
Gilles Peskine449bd832023-01-11 14:50:10 +01002233 if (!PSA_ALG_IS_HASH(alg)) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002234 status = PSA_ERROR_INVALID_ARGUMENT;
2235 goto exit;
2236 }
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002237
Steven Cooremanb6bf4bb2021-03-15 19:00:14 +01002238 /* Ensure all of the context is zeroized, since PSA_HASH_OPERATION_INIT only
2239 * directly zeroes the int-sized dummy member of the context union. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002240 memset(&operation->ctx, 0, sizeof(operation->ctx));
Steven Cooreman893232f2021-03-15 12:23:37 +01002241
Gilles Peskine449bd832023-01-11 14:50:10 +01002242 status = psa_driver_wrapper_hash_setup(operation, alg);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002243
2244exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002245 if (status != PSA_SUCCESS) {
2246 psa_hash_abort(operation);
2247 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002248
2249 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002250}
2251
Gilles Peskine449bd832023-01-11 14:50:10 +01002252psa_status_t psa_hash_update(psa_hash_operation_t *operation,
2253 const uint8_t *input,
2254 size_t input_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002255{
Dave Rodgman685b6a72021-06-24 11:49:14 +01002256 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2257
Gilles Peskine449bd832023-01-11 14:50:10 +01002258 if (operation->id == 0) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002259 status = PSA_ERROR_BAD_STATE;
2260 goto exit;
2261 }
Gilles Peskine94e44542018-07-12 16:58:43 +02002262
Steven Cooremanc8288352021-03-04 14:02:19 +01002263 /* Don't require hash implementations to behave correctly on a
2264 * zero-length input, which may have an invalid pointer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002265 if (input_length == 0) {
2266 return PSA_SUCCESS;
2267 }
Steven Cooremanc8288352021-03-04 14:02:19 +01002268
Gilles Peskine449bd832023-01-11 14:50:10 +01002269 status = psa_driver_wrapper_hash_update(operation, input, input_length);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002270
2271exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002272 if (status != PSA_SUCCESS) {
2273 psa_hash_abort(operation);
2274 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002275
Gilles Peskine449bd832023-01-11 14:50:10 +01002276 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002277}
2278
Gilles Peskine449bd832023-01-11 14:50:10 +01002279psa_status_t psa_hash_finish(psa_hash_operation_t *operation,
2280 uint8_t *hash,
2281 size_t hash_size,
2282 size_t *hash_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002283{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002284 *hash_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002285 if (operation->id == 0) {
2286 return PSA_ERROR_BAD_STATE;
2287 }
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002288
Steven Cooreman1e582352021-02-18 17:24:37 +01002289 psa_status_t status = psa_driver_wrapper_hash_finish(
Gilles Peskine449bd832023-01-11 14:50:10 +01002290 operation, hash, hash_size, hash_length);
2291 psa_hash_abort(operation);
2292 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002293}
2294
Gilles Peskine449bd832023-01-11 14:50:10 +01002295psa_status_t psa_hash_verify(psa_hash_operation_t *operation,
2296 const uint8_t *hash,
2297 size_t hash_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002298{
Ronald Cron69a63422021-10-18 09:47:58 +02002299 uint8_t actual_hash[PSA_HASH_MAX_SIZE];
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002300 size_t actual_hash_length;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002301 psa_status_t status = psa_hash_finish(
Gilles Peskine449bd832023-01-11 14:50:10 +01002302 operation,
2303 actual_hash, sizeof(actual_hash),
2304 &actual_hash_length);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002305
Gilles Peskine449bd832023-01-11 14:50:10 +01002306 if (status != PSA_SUCCESS) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002307 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002308 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002309
Gilles Peskine449bd832023-01-11 14:50:10 +01002310 if (actual_hash_length != hash_length) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002311 status = PSA_ERROR_INVALID_SIGNATURE;
2312 goto exit;
2313 }
2314
Dave Rodgman78701152023-08-29 14:20:18 +01002315 if (mbedtls_ct_memcmp(hash, actual_hash, actual_hash_length) != 0) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002316 status = PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01002317 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002318
2319exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002320 mbedtls_platform_zeroize(actual_hash, sizeof(actual_hash));
2321 if (status != PSA_SUCCESS) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002322 psa_hash_abort(operation);
Gilles Peskine449bd832023-01-11 14:50:10 +01002323 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002324
Gilles Peskine449bd832023-01-11 14:50:10 +01002325 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002326}
2327
Gilles Peskine449bd832023-01-11 14:50:10 +01002328psa_status_t psa_hash_compute(psa_algorithm_t alg,
2329 const uint8_t *input, size_t input_length,
2330 uint8_t *hash, size_t hash_size,
2331 size_t *hash_length)
Gilles Peskine0a749c82019-11-28 19:33:58 +01002332{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002333 *hash_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002334 if (!PSA_ALG_IS_HASH(alg)) {
2335 return PSA_ERROR_INVALID_ARGUMENT;
2336 }
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002337
Gilles Peskine449bd832023-01-11 14:50:10 +01002338 return psa_driver_wrapper_hash_compute(alg, input, input_length,
2339 hash, hash_size, hash_length);
Gilles Peskine0a749c82019-11-28 19:33:58 +01002340}
2341
Gilles Peskine449bd832023-01-11 14:50:10 +01002342psa_status_t psa_hash_compare(psa_algorithm_t alg,
2343 const uint8_t *input, size_t input_length,
2344 const uint8_t *hash, size_t hash_length)
Gilles Peskine0a749c82019-11-28 19:33:58 +01002345{
Ronald Cron69a63422021-10-18 09:47:58 +02002346 uint8_t actual_hash[PSA_HASH_MAX_SIZE];
Steven Cooreman84d670d2021-02-18 16:22:53 +01002347 size_t actual_hash_length;
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002348
Gilles Peskine449bd832023-01-11 14:50:10 +01002349 if (!PSA_ALG_IS_HASH(alg)) {
2350 return PSA_ERROR_INVALID_ARGUMENT;
2351 }
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002352
Steven Cooreman1e582352021-02-18 17:24:37 +01002353 psa_status_t status = psa_driver_wrapper_hash_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01002354 alg, input, input_length,
2355 actual_hash, sizeof(actual_hash),
2356 &actual_hash_length);
2357 if (status != PSA_SUCCESS) {
Gilles Peskine60aebec2021-12-13 12:33:18 +01002358 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002359 }
2360 if (actual_hash_length != hash_length) {
Gilles Peskine60aebec2021-12-13 12:33:18 +01002361 status = PSA_ERROR_INVALID_SIGNATURE;
2362 goto exit;
2363 }
Dave Rodgman78701152023-08-29 14:20:18 +01002364 if (mbedtls_ct_memcmp(hash, actual_hash, actual_hash_length) != 0) {
Gilles Peskine60aebec2021-12-13 12:33:18 +01002365 status = PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01002366 }
Gilles Peskine60aebec2021-12-13 12:33:18 +01002367
2368exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002369 mbedtls_platform_zeroize(actual_hash, sizeof(actual_hash));
2370 return status;
Gilles Peskine0a749c82019-11-28 19:33:58 +01002371}
2372
Gilles Peskine449bd832023-01-11 14:50:10 +01002373psa_status_t psa_hash_clone(const psa_hash_operation_t *source_operation,
2374 psa_hash_operation_t *target_operation)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002375{
Gilles Peskine449bd832023-01-11 14:50:10 +01002376 if (source_operation->id == 0 ||
2377 target_operation->id != 0) {
2378 return PSA_ERROR_BAD_STATE;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002379 }
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002380
Gilles Peskine449bd832023-01-11 14:50:10 +01002381 psa_status_t status = psa_driver_wrapper_hash_clone(source_operation,
2382 target_operation);
2383 if (status != PSA_SUCCESS) {
2384 psa_hash_abort(target_operation);
2385 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002386
Gilles Peskine449bd832023-01-11 14:50:10 +01002387 return status;
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002388}
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002389
2390
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002391/****************************************************************/
Gilles Peskine8c9def32018-02-08 10:02:12 +01002392/* MAC */
2393/****************************************************************/
2394
Gilles Peskine449bd832023-01-11 14:50:10 +01002395psa_status_t psa_mac_abort(psa_mac_operation_t *operation)
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002396{
Steven Cooremane6804192021-03-19 18:28:56 +01002397 /* Aborting a non-active operation is allowed */
Gilles Peskine449bd832023-01-11 14:50:10 +01002398 if (operation->id == 0) {
2399 return PSA_SUCCESS;
2400 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002401
Gilles Peskine449bd832023-01-11 14:50:10 +01002402 psa_status_t status = psa_driver_wrapper_mac_abort(operation);
Steven Cooreman72f736a2021-05-07 14:14:37 +02002403 operation->mac_size = 0;
2404 operation->is_sign = 0;
Steven Cooremane6804192021-03-19 18:28:56 +01002405 operation->id = 0;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002406
Gilles Peskine449bd832023-01-11 14:50:10 +01002407 return status;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002408}
2409
Ronald Cron2dff3b22021-06-17 16:33:22 +02002410static psa_status_t psa_mac_finalize_alg_and_key_validation(
2411 psa_algorithm_t alg,
Ronald Cron79bdd822021-06-17 16:46:44 +02002412 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01002413 uint8_t *mac_size)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002414{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002415 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002416 psa_key_type_t key_type = psa_get_key_type(attributes);
2417 size_t key_bits = psa_get_key_bits(attributes);
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002418
Gilles Peskine449bd832023-01-11 14:50:10 +01002419 if (!PSA_ALG_IS_MAC(alg)) {
2420 return PSA_ERROR_INVALID_ARGUMENT;
2421 }
Steven Cooremane6804192021-03-19 18:28:56 +01002422
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002423 /* Validate the combination of key type and algorithm */
Gilles Peskine449bd832023-01-11 14:50:10 +01002424 status = psa_mac_key_can_do(alg, key_type);
2425 if (status != PSA_SUCCESS) {
2426 return status;
2427 }
Steven Cooreman15472f82021-03-02 16:16:22 +01002428
Steven Cooremand1a68f12021-05-10 11:13:41 +02002429 /* Get the output length for the algorithm and key combination */
Gilles Peskine449bd832023-01-11 14:50:10 +01002430 *mac_size = PSA_MAC_LENGTH(key_type, key_bits, alg);
Steven Cooreman15472f82021-03-02 16:16:22 +01002431
Gilles Peskine449bd832023-01-11 14:50:10 +01002432 if (*mac_size < 4) {
Steven Cooreman15472f82021-03-02 16:16:22 +01002433 /* A very short MAC is too short for security since it can be
2434 * brute-forced. Ancient protocols with 32-bit MACs do exist,
2435 * so we make this our minimum, even though 32 bits is still
2436 * too small for security. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002437 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman15472f82021-03-02 16:16:22 +01002438 }
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02002439
Gilles Peskine449bd832023-01-11 14:50:10 +01002440 if (*mac_size > PSA_MAC_LENGTH(key_type, key_bits,
2441 PSA_ALG_FULL_LENGTH_MAC(alg))) {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002442 /* It's impossible to "truncate" to a larger length than the full length
2443 * of the algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002444 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002445 }
2446
Gilles Peskine449bd832023-01-11 14:50:10 +01002447 if (*mac_size > PSA_MAC_MAX_SIZE) {
Gilles Peskinea9b6c802022-03-16 13:54:49 +01002448 /* PSA_MAC_LENGTH returns the correct length even for a MAC algorithm
2449 * that is disabled in the compile-time configuration. The result can
2450 * therefore be larger than PSA_MAC_MAX_SIZE, which does take the
2451 * configuration into account. In this case, force a return of
2452 * PSA_ERROR_NOT_SUPPORTED here. Otherwise psa_mac_verify(), or
2453 * psa_mac_compute(mac_size=PSA_MAC_MAX_SIZE), would return
2454 * PSA_ERROR_BUFFER_TOO_SMALL for an unsupported algorithm whose MAC size
2455 * is larger than PSA_MAC_MAX_SIZE, which is misleading and which breaks
2456 * systematically generated tests. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002457 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea9b6c802022-03-16 13:54:49 +01002458 }
2459
Gilles Peskine449bd832023-01-11 14:50:10 +01002460 return PSA_SUCCESS;
Ronald Cron2dff3b22021-06-17 16:33:22 +02002461}
2462
Gilles Peskine449bd832023-01-11 14:50:10 +01002463static psa_status_t psa_mac_setup(psa_mac_operation_t *operation,
2464 mbedtls_svc_key_id_t key,
2465 psa_algorithm_t alg,
2466 int is_sign)
Gilles Peskinee59236f2018-01-27 23:32:46 +01002467{
2468 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2469 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman54648242021-06-24 11:49:45 +01002470 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002471 psa_key_attributes_t attributes;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002472
2473 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002474 if (operation->id != 0) {
Dave Rodgman54648242021-06-24 11:49:45 +01002475 status = PSA_ERROR_BAD_STATE;
2476 goto exit;
2477 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002478
2479 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002480 key,
2481 &slot,
2482 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
2483 alg);
2484 if (status != PSA_SUCCESS) {
Dave Rodgman54648242021-06-24 11:49:45 +01002485 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002486 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002487
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002488 attributes = (psa_key_attributes_t) {
Gilles Peskine8c9def32018-02-08 10:02:12 +01002489 .core = slot->attr
2490 };
2491
Gilles Peskine449bd832023-01-11 14:50:10 +01002492 status = psa_mac_finalize_alg_and_key_validation(alg, &attributes,
2493 &operation->mac_size);
2494 if (status != PSA_SUCCESS) {
Gilles Peskine8c9def32018-02-08 10:02:12 +01002495 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002496 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002497
2498 operation->is_sign = is_sign;
Steven Cooremane6804192021-03-19 18:28:56 +01002499 /* Dispatch the MAC setup call with validated input */
Gilles Peskine449bd832023-01-11 14:50:10 +01002500 if (is_sign) {
2501 status = psa_driver_wrapper_mac_sign_setup(operation,
2502 &attributes,
2503 slot->key.data,
2504 slot->key.bytes,
2505 alg);
2506 } else {
2507 status = psa_driver_wrapper_mac_verify_setup(operation,
2508 &attributes,
2509 slot->key.data,
2510 slot->key.bytes,
2511 alg);
Gilles Peskine8c9def32018-02-08 10:02:12 +01002512 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002513
Gilles Peskinefbfac682018-07-08 20:51:54 +02002514exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002515 if (status != PSA_SUCCESS) {
2516 psa_mac_abort(operation);
2517 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002518
Ryan Everett1b70a072024-01-04 10:32:49 +00002519 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02002520
Gilles Peskine449bd832023-01-11 14:50:10 +01002521 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002522}
2523
Gilles Peskine449bd832023-01-11 14:50:10 +01002524psa_status_t psa_mac_sign_setup(psa_mac_operation_t *operation,
2525 mbedtls_svc_key_id_t key,
2526 psa_algorithm_t alg)
Gilles Peskine89167cb2018-07-08 20:12:23 +02002527{
Gilles Peskine449bd832023-01-11 14:50:10 +01002528 return psa_mac_setup(operation, key, alg, 1);
Gilles Peskine89167cb2018-07-08 20:12:23 +02002529}
2530
Gilles Peskine449bd832023-01-11 14:50:10 +01002531psa_status_t psa_mac_verify_setup(psa_mac_operation_t *operation,
2532 mbedtls_svc_key_id_t key,
2533 psa_algorithm_t alg)
Gilles Peskine89167cb2018-07-08 20:12:23 +02002534{
Gilles Peskine449bd832023-01-11 14:50:10 +01002535 return psa_mac_setup(operation, key, alg, 0);
Gilles Peskine89167cb2018-07-08 20:12:23 +02002536}
2537
Gilles Peskine449bd832023-01-11 14:50:10 +01002538psa_status_t psa_mac_update(psa_mac_operation_t *operation,
2539 const uint8_t *input,
2540 size_t input_length)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002541{
Gilles Peskine449bd832023-01-11 14:50:10 +01002542 if (operation->id == 0) {
2543 return PSA_ERROR_BAD_STATE;
2544 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002545
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002546 /* Don't require hash implementations to behave correctly on a
2547 * zero-length input, which may have an invalid pointer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002548 if (input_length == 0) {
2549 return PSA_SUCCESS;
2550 }
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03002551
Gilles Peskine449bd832023-01-11 14:50:10 +01002552 psa_status_t status = psa_driver_wrapper_mac_update(operation,
2553 input, input_length);
2554 if (status != PSA_SUCCESS) {
2555 psa_mac_abort(operation);
2556 }
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002557
Gilles Peskine449bd832023-01-11 14:50:10 +01002558 return status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002559}
2560
Gilles Peskine449bd832023-01-11 14:50:10 +01002561psa_status_t psa_mac_sign_finish(psa_mac_operation_t *operation,
2562 uint8_t *mac,
2563 size_t mac_size,
2564 size_t *mac_length)
mohammad16036df908f2018-04-02 08:34:15 -07002565{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002566 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2567 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002568
Gilles Peskine449bd832023-01-11 14:50:10 +01002569 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002570 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002571 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002572 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002573
Gilles Peskine449bd832023-01-11 14:50:10 +01002574 if (!operation->is_sign) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002575 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002576 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002577 }
Steven Cooreman72f736a2021-05-07 14:14:37 +02002578
Steven Cooreman8af5c5c2021-05-11 11:09:13 +02002579 /* Sanity check. This will guarantee that mac_size != 0 (and so mac != NULL)
2580 * once all the error checks are done. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002581 if (operation->mac_size == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002582 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002583 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002584 }
Steven Cooreman8af5c5c2021-05-11 11:09:13 +02002585
Gilles Peskine449bd832023-01-11 14:50:10 +01002586 if (mac_size < operation->mac_size) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002587 status = PSA_ERROR_BUFFER_TOO_SMALL;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002588 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002589 }
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002590
Gilles Peskine449bd832023-01-11 14:50:10 +01002591 status = psa_driver_wrapper_mac_sign_finish(operation,
2592 mac, operation->mac_size,
2593 mac_length);
Steven Cooreman72f736a2021-05-07 14:14:37 +02002594
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002595exit:
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002596 /* In case of success, set the potential excess room in the output buffer
2597 * to an invalid value, to avoid potentially leaking a longer MAC.
2598 * In case of error, set the output length and content to a safe default,
2599 * such that in case the caller misses an error check, the output would be
2600 * an unachievable MAC.
2601 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002602 if (status != PSA_SUCCESS) {
Steven Cooreman72f736a2021-05-07 14:14:37 +02002603 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002604 operation->mac_size = 0;
Steven Cooreman72f736a2021-05-07 14:14:37 +02002605 }
mohammad16036df908f2018-04-02 08:34:15 -07002606
Paul Elliottdc42ca82023-02-24 18:11:59 +00002607 psa_wipe_tag_output_buffer(mac, status, mac_size, *mac_length);
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002608
Gilles Peskine449bd832023-01-11 14:50:10 +01002609 abort_status = psa_mac_abort(operation);
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002610
Gilles Peskine449bd832023-01-11 14:50:10 +01002611 return status == PSA_SUCCESS ? abort_status : status;
mohammad16036df908f2018-04-02 08:34:15 -07002612}
2613
Gilles Peskine449bd832023-01-11 14:50:10 +01002614psa_status_t psa_mac_verify_finish(psa_mac_operation_t *operation,
2615 const uint8_t *mac,
2616 size_t mac_length)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002617{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002618 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2619 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002620
Gilles Peskine449bd832023-01-11 14:50:10 +01002621 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002622 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002623 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002624 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002625
Gilles Peskine449bd832023-01-11 14:50:10 +01002626 if (operation->is_sign) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002627 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002628 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002629 }
Steven Cooreman72f736a2021-05-07 14:14:37 +02002630
Gilles Peskine449bd832023-01-11 14:50:10 +01002631 if (operation->mac_size != mac_length) {
Steven Cooreman72f736a2021-05-07 14:14:37 +02002632 status = PSA_ERROR_INVALID_SIGNATURE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002633 goto exit;
Steven Cooreman72f736a2021-05-07 14:14:37 +02002634 }
2635
Gilles Peskine449bd832023-01-11 14:50:10 +01002636 status = psa_driver_wrapper_mac_verify_finish(operation,
2637 mac, mac_length);
Steven Cooreman72f736a2021-05-07 14:14:37 +02002638
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002639exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002640 abort_status = psa_mac_abort(operation);
mohammad16036df908f2018-04-02 08:34:15 -07002641
Gilles Peskine449bd832023-01-11 14:50:10 +01002642 return status == PSA_SUCCESS ? abort_status : status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002643}
2644
Gilles Peskine449bd832023-01-11 14:50:10 +01002645static psa_status_t psa_mac_compute_internal(mbedtls_svc_key_id_t key,
2646 psa_algorithm_t alg,
2647 const uint8_t *input,
2648 size_t input_length,
2649 uint8_t *mac,
2650 size_t mac_size,
2651 size_t *mac_length,
2652 int is_sign)
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002653{
2654 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron51131b52021-06-17 17:17:20 +02002655 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2656 psa_key_slot_t *slot;
2657 uint8_t operation_mac_size = 0;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002658 psa_key_attributes_t attributes;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002659
Ronald Cron51131b52021-06-17 17:17:20 +02002660 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002661 key,
2662 &slot,
2663 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
2664 alg);
2665 if (status != PSA_SUCCESS) {
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002666 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002667 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002668
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002669 attributes = (psa_key_attributes_t) {
Ronald Cron51131b52021-06-17 17:17:20 +02002670 .core = slot->attr
2671 };
2672
Gilles Peskine449bd832023-01-11 14:50:10 +01002673 status = psa_mac_finalize_alg_and_key_validation(alg, &attributes,
2674 &operation_mac_size);
2675 if (status != PSA_SUCCESS) {
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002676 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002677 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002678
Gilles Peskine449bd832023-01-11 14:50:10 +01002679 if (mac_size < operation_mac_size) {
Ronald Cron51131b52021-06-17 17:17:20 +02002680 status = PSA_ERROR_BUFFER_TOO_SMALL;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002681 goto exit;
Ronald Cron51131b52021-06-17 17:17:20 +02002682 }
2683
2684 status = psa_driver_wrapper_mac_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01002685 &attributes,
2686 slot->key.data, slot->key.bytes,
2687 alg,
2688 input, input_length,
2689 mac, operation_mac_size, mac_length);
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002690
2691exit:
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002692 /* In case of success, set the potential excess room in the output buffer
2693 * to an invalid value, to avoid potentially leaking a longer MAC.
2694 * In case of error, set the output length and content to a safe default,
2695 * such that in case the caller misses an error check, the output would be
2696 * an unachievable MAC.
2697 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002698 if (status != PSA_SUCCESS) {
Ronald Cron51131b52021-06-17 17:17:20 +02002699 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002700 operation_mac_size = 0;
Ronald Cron51131b52021-06-17 17:17:20 +02002701 }
Paul Elliottdc42ca82023-02-24 18:11:59 +00002702
2703 psa_wipe_tag_output_buffer(mac, status, mac_size, *mac_length);
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002704
Ryan Everetta103ec92024-01-31 13:59:57 +00002705 unlock_status = psa_unregister_read_under_mutex(slot);
Ronald Cron51131b52021-06-17 17:17:20 +02002706
Gilles Peskine449bd832023-01-11 14:50:10 +01002707 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002708}
2709
Gilles Peskine449bd832023-01-11 14:50:10 +01002710psa_status_t psa_mac_compute(mbedtls_svc_key_id_t key,
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002711 psa_algorithm_t alg,
2712 const uint8_t *input,
2713 size_t input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002714 uint8_t *mac,
2715 size_t mac_size,
2716 size_t *mac_length)
2717{
2718 return psa_mac_compute_internal(key, alg,
2719 input, input_length,
2720 mac, mac_size, mac_length, 1);
2721}
2722
2723psa_status_t psa_mac_verify(mbedtls_svc_key_id_t key,
2724 psa_algorithm_t alg,
2725 const uint8_t *input,
2726 size_t input_length,
2727 const uint8_t *mac,
2728 size_t mac_length)
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002729{
2730 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Crona587cbc2021-06-18 14:51:29 +02002731 uint8_t actual_mac[PSA_MAC_MAX_SIZE];
2732 size_t actual_mac_length;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002733
Gilles Peskine449bd832023-01-11 14:50:10 +01002734 status = psa_mac_compute_internal(key, alg,
2735 input, input_length,
2736 actual_mac, sizeof(actual_mac),
2737 &actual_mac_length, 0);
2738 if (status != PSA_SUCCESS) {
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002739 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002740 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002741
Gilles Peskine449bd832023-01-11 14:50:10 +01002742 if (mac_length != actual_mac_length) {
Ronald Crona587cbc2021-06-18 14:51:29 +02002743 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002744 goto exit;
Ronald Crona587cbc2021-06-18 14:51:29 +02002745 }
Dave Rodgman78701152023-08-29 14:20:18 +01002746 if (mbedtls_ct_memcmp(mac, actual_mac, actual_mac_length) != 0) {
Ronald Crona587cbc2021-06-18 14:51:29 +02002747 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002748 goto exit;
Ronald Crona587cbc2021-06-18 14:51:29 +02002749 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002750
2751exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002752 mbedtls_platform_zeroize(actual_mac, sizeof(actual_mac));
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002753
Gilles Peskine449bd832023-01-11 14:50:10 +01002754 return status;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002755}
Gilles Peskinee59236f2018-01-27 23:32:46 +01002756
Gilles Peskinee59236f2018-01-27 23:32:46 +01002757/****************************************************************/
2758/* Asymmetric cryptography */
2759/****************************************************************/
2760
Gilles Peskine449bd832023-01-11 14:50:10 +01002761static psa_status_t psa_sign_verify_check_alg(int input_is_message,
2762 psa_algorithm_t alg)
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002763{
Gilles Peskine449bd832023-01-11 14:50:10 +01002764 if (input_is_message) {
2765 if (!PSA_ALG_IS_SIGN_MESSAGE(alg)) {
2766 return PSA_ERROR_INVALID_ARGUMENT;
2767 }
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002768
Gilles Peskine449bd832023-01-11 14:50:10 +01002769 if (PSA_ALG_IS_SIGN_HASH(alg)) {
2770 if (!PSA_ALG_IS_HASH(PSA_ALG_SIGN_GET_HASH(alg))) {
2771 return PSA_ERROR_INVALID_ARGUMENT;
2772 }
2773 }
2774 } else {
2775 if (!PSA_ALG_IS_SIGN_HASH(alg)) {
2776 return PSA_ERROR_INVALID_ARGUMENT;
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002777 }
2778 }
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002779
Gilles Peskine449bd832023-01-11 14:50:10 +01002780 return PSA_SUCCESS;
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002781}
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002782
Gilles Peskine449bd832023-01-11 14:50:10 +01002783static psa_status_t psa_sign_internal(mbedtls_svc_key_id_t key,
2784 int input_is_message,
2785 psa_algorithm_t alg,
2786 const uint8_t *input,
2787 size_t input_length,
2788 uint8_t *signature,
2789 size_t signature_size,
2790 size_t *signature_length)
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002791{
2792 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2793 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2794 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002795 psa_key_attributes_t attributes;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002796
2797 *signature_length = 0;
2798
Gilles Peskine449bd832023-01-11 14:50:10 +01002799 status = psa_sign_verify_check_alg(input_is_message, alg);
2800 if (status != PSA_SUCCESS) {
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002801 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002802 }
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002803
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002804 /* Immediately reject a zero-length signature buffer. This guarantees
gabor-mezei-arm12b4f342021-05-05 13:54:55 +02002805 * that signature must be a valid pointer. (On the other hand, the input
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002806 * buffer can in principle be empty since it doesn't actually have
2807 * to be a hash.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01002808 if (signature_size == 0) {
2809 return PSA_ERROR_BUFFER_TOO_SMALL;
2810 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002811
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002812 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002813 key, &slot,
2814 input_is_message ? PSA_KEY_USAGE_SIGN_MESSAGE :
2815 PSA_KEY_USAGE_SIGN_HASH,
2816 alg);
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002817
Gilles Peskine449bd832023-01-11 14:50:10 +01002818 if (status != PSA_SUCCESS) {
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002819 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002820 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002821
Gilles Peskine449bd832023-01-11 14:50:10 +01002822 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002823 status = PSA_ERROR_INVALID_ARGUMENT;
2824 goto exit;
2825 }
2826
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002827 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01002828 .core = slot->attr
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002829 };
2830
Gilles Peskine449bd832023-01-11 14:50:10 +01002831 if (input_is_message) {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002832 status = psa_driver_wrapper_sign_message(
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002833 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002834 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002835 signature, signature_size, signature_length);
2836 } else {
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002837
2838 status = psa_driver_wrapper_sign_hash(
2839 &attributes, slot->key.data, slot->key.bytes,
2840 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002841 signature, signature_size, signature_length);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002842 }
2843
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002844
2845exit:
Paul Elliott59200a22023-02-21 15:07:40 +00002846 psa_wipe_tag_output_buffer(signature, status, signature_size,
2847 *signature_length);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002848
Ryan Everetta103ec92024-01-31 13:59:57 +00002849 unlock_status = psa_unregister_read_under_mutex(slot);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002850
Gilles Peskine449bd832023-01-11 14:50:10 +01002851 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002852}
2853
Gilles Peskine449bd832023-01-11 14:50:10 +01002854static psa_status_t psa_verify_internal(mbedtls_svc_key_id_t key,
2855 int input_is_message,
2856 psa_algorithm_t alg,
2857 const uint8_t *input,
2858 size_t input_length,
2859 const uint8_t *signature,
2860 size_t signature_length)
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002861{
2862 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2863 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2864 psa_key_slot_t *slot;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002865
Gilles Peskine449bd832023-01-11 14:50:10 +01002866 status = psa_sign_verify_check_alg(input_is_message, alg);
2867 if (status != PSA_SUCCESS) {
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002868 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002869 }
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002870
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002871 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002872 key, &slot,
2873 input_is_message ? PSA_KEY_USAGE_VERIFY_MESSAGE :
2874 PSA_KEY_USAGE_VERIFY_HASH,
2875 alg);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002876
Gilles Peskine449bd832023-01-11 14:50:10 +01002877 if (status != PSA_SUCCESS) {
2878 return status;
2879 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002880
2881 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01002882 .core = slot->attr
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002883 };
2884
Gilles Peskine449bd832023-01-11 14:50:10 +01002885 if (input_is_message) {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002886 status = psa_driver_wrapper_verify_message(
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002887 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002888 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002889 signature, signature_length);
2890 } else {
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002891 status = psa_driver_wrapper_verify_hash(
2892 &attributes, slot->key.data, slot->key.bytes,
2893 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002894 signature, signature_length);
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002895 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002896
Ryan Everetta103ec92024-01-31 13:59:57 +00002897 unlock_status = psa_unregister_read_under_mutex(slot);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002898
Gilles Peskine449bd832023-01-11 14:50:10 +01002899 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002900
2901}
2902
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002903psa_status_t psa_sign_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002904 const psa_key_attributes_t *attributes,
2905 const uint8_t *key_buffer,
2906 size_t key_buffer_size,
2907 psa_algorithm_t alg,
2908 const uint8_t *input,
2909 size_t input_length,
2910 uint8_t *signature,
2911 size_t signature_size,
Gilles Peskine449bd832023-01-11 14:50:10 +01002912 size_t *signature_length)
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002913{
2914 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002915
Gilles Peskine449bd832023-01-11 14:50:10 +01002916 if (PSA_ALG_IS_SIGN_HASH(alg)) {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002917 size_t hash_length;
2918 uint8_t hash[PSA_HASH_MAX_SIZE];
2919
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002920 status = psa_driver_wrapper_hash_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01002921 PSA_ALG_SIGN_GET_HASH(alg),
2922 input, input_length,
2923 hash, sizeof(hash), &hash_length);
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002924
Gilles Peskine449bd832023-01-11 14:50:10 +01002925 if (status != PSA_SUCCESS) {
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002926 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002927 }
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002928
2929 return psa_driver_wrapper_sign_hash(
Gilles Peskine449bd832023-01-11 14:50:10 +01002930 attributes, key_buffer, key_buffer_size,
2931 alg, hash, hash_length,
2932 signature, signature_size, signature_length);
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002933 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002934
Gilles Peskine449bd832023-01-11 14:50:10 +01002935 return PSA_ERROR_NOT_SUPPORTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002936}
2937
Gilles Peskine449bd832023-01-11 14:50:10 +01002938psa_status_t psa_sign_message(mbedtls_svc_key_id_t key,
2939 psa_algorithm_t alg,
2940 const uint8_t *input,
2941 size_t input_length,
2942 uint8_t *signature,
2943 size_t signature_size,
2944 size_t *signature_length)
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002945{
2946 return psa_sign_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002947 key, 1, alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002948 signature, signature_size, signature_length);
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002949}
2950
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002951psa_status_t psa_verify_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002952 const psa_key_attributes_t *attributes,
2953 const uint8_t *key_buffer,
2954 size_t key_buffer_size,
2955 psa_algorithm_t alg,
2956 const uint8_t *input,
2957 size_t input_length,
2958 const uint8_t *signature,
Gilles Peskine449bd832023-01-11 14:50:10 +01002959 size_t signature_length)
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002960{
2961 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002962
Gilles Peskine449bd832023-01-11 14:50:10 +01002963 if (PSA_ALG_IS_SIGN_HASH(alg)) {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002964 size_t hash_length;
2965 uint8_t hash[PSA_HASH_MAX_SIZE];
2966
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002967 status = psa_driver_wrapper_hash_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01002968 PSA_ALG_SIGN_GET_HASH(alg),
2969 input, input_length,
2970 hash, sizeof(hash), &hash_length);
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002971
Gilles Peskine449bd832023-01-11 14:50:10 +01002972 if (status != PSA_SUCCESS) {
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002973 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002974 }
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002975
2976 return psa_driver_wrapper_verify_hash(
Gilles Peskine449bd832023-01-11 14:50:10 +01002977 attributes, key_buffer, key_buffer_size,
2978 alg, hash, hash_length,
2979 signature, signature_length);
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002980 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002981
Gilles Peskine449bd832023-01-11 14:50:10 +01002982 return PSA_ERROR_NOT_SUPPORTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002983}
2984
Gilles Peskine449bd832023-01-11 14:50:10 +01002985psa_status_t psa_verify_message(mbedtls_svc_key_id_t key,
2986 psa_algorithm_t alg,
2987 const uint8_t *input,
2988 size_t input_length,
2989 const uint8_t *signature,
2990 size_t signature_length)
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002991{
2992 return psa_verify_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002993 key, 1, alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002994 signature, signature_length);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002995}
2996
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002997psa_status_t psa_sign_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01002998 const psa_key_attributes_t *attributes,
2999 const uint8_t *key_buffer, size_t key_buffer_size,
3000 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003001 uint8_t *signature, size_t signature_size, size_t *signature_length)
Gilles Peskinee59236f2018-01-27 23:32:46 +01003002{
Gilles Peskine449bd832023-01-11 14:50:10 +01003003 if (attributes->core.type == PSA_KEY_TYPE_RSA_KEY_PAIR) {
3004 if (PSA_ALG_IS_RSA_PKCS1V15_SIGN(alg) ||
3005 PSA_ALG_IS_RSA_PSS(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003006#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003007 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
3008 return mbedtls_psa_rsa_sign_hash(
3009 attributes,
3010 key_buffer, key_buffer_size,
3011 alg, hash, hash_length,
3012 signature, signature_size, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01003013#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
3014 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003015 } else {
3016 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanacda8342020-07-24 23:09:52 +02003017 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003018 } else if (PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3019 if (PSA_ALG_IS_ECDSA(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003020#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003021 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3022 return mbedtls_psa_ecdsa_sign_hash(
3023 attributes,
3024 key_buffer, key_buffer_size,
3025 alg, hash, hash_length,
3026 signature, signature_size, signature_length);
Gilles Peskinee59236f2018-01-27 23:32:46 +01003027#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3028 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003029 } else {
3030 return PSA_ERROR_INVALID_ARGUMENT;
Ronald Cron4501c982021-03-19 20:09:32 +01003031 }
Ronald Cron8a494f32021-02-17 09:49:51 +01003032 }
Ronald Cron4501c982021-03-19 20:09:32 +01003033
Gilles Peskine449bd832023-01-11 14:50:10 +01003034 (void) key_buffer;
3035 (void) key_buffer_size;
3036 (void) hash;
3037 (void) hash_length;
3038 (void) signature;
3039 (void) signature_size;
3040 (void) signature_length;
Ronald Cron4501c982021-03-19 20:09:32 +01003041
Gilles Peskine449bd832023-01-11 14:50:10 +01003042 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron18659932020-12-08 16:32:23 +01003043}
Gilles Peskinee59236f2018-01-27 23:32:46 +01003044
Gilles Peskine449bd832023-01-11 14:50:10 +01003045psa_status_t psa_sign_hash(mbedtls_svc_key_id_t key,
3046 psa_algorithm_t alg,
3047 const uint8_t *hash,
3048 size_t hash_length,
3049 uint8_t *signature,
3050 size_t signature_size,
3051 size_t *signature_length)
Gilles Peskinee59236f2018-01-27 23:32:46 +01003052{
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003053 return psa_sign_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02003054 key, 0, alg, hash, hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003055 signature, signature_size, signature_length);
itayzafrir5c753392018-05-08 11:18:38 +03003056}
3057
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02003058psa_status_t psa_verify_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01003059 const psa_key_attributes_t *attributes,
3060 const uint8_t *key_buffer, size_t key_buffer_size,
3061 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003062 const uint8_t *signature, size_t signature_length)
itayzafrir5c753392018-05-08 11:18:38 +03003063{
Gilles Peskine449bd832023-01-11 14:50:10 +01003064 if (PSA_KEY_TYPE_IS_RSA(attributes->core.type)) {
3065 if (PSA_ALG_IS_RSA_PKCS1V15_SIGN(alg) ||
3066 PSA_ALG_IS_RSA_PSS(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003067#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003068 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
3069 return mbedtls_psa_rsa_verify_hash(
3070 attributes,
3071 key_buffer, key_buffer_size,
3072 alg, hash, hash_length,
3073 signature, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01003074#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
3075 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003076 } else {
3077 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanacda8342020-07-24 23:09:52 +02003078 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003079 } else if (PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3080 if (PSA_ALG_IS_ECDSA(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003081#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003082 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3083 return mbedtls_psa_ecdsa_verify_hash(
3084 attributes,
3085 key_buffer, key_buffer_size,
3086 alg, hash, hash_length,
3087 signature, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01003088#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3089 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003090 } else {
3091 return PSA_ERROR_INVALID_ARGUMENT;
Ronald Cron4501c982021-03-19 20:09:32 +01003092 }
Ronald Cron8a494f32021-02-17 09:49:51 +01003093 }
Ronald Cron4501c982021-03-19 20:09:32 +01003094
Gilles Peskine449bd832023-01-11 14:50:10 +01003095 (void) key_buffer;
3096 (void) key_buffer_size;
3097 (void) hash;
3098 (void) hash_length;
3099 (void) signature;
3100 (void) signature_length;
Ronald Cron4501c982021-03-19 20:09:32 +01003101
Gilles Peskine449bd832023-01-11 14:50:10 +01003102 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron18659932020-12-08 16:32:23 +01003103}
3104
Gilles Peskine449bd832023-01-11 14:50:10 +01003105psa_status_t psa_verify_hash(mbedtls_svc_key_id_t key,
3106 psa_algorithm_t alg,
3107 const uint8_t *hash,
3108 size_t hash_length,
3109 const uint8_t *signature,
3110 size_t signature_length)
itayzafrir5c753392018-05-08 11:18:38 +03003111{
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003112 return psa_verify_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02003113 key, 0, alg, hash, hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003114 signature, signature_length);
Gilles Peskinee59236f2018-01-27 23:32:46 +01003115}
3116
Gilles Peskine449bd832023-01-11 14:50:10 +01003117psa_status_t psa_asymmetric_encrypt(mbedtls_svc_key_id_t key,
3118 psa_algorithm_t alg,
3119 const uint8_t *input,
3120 size_t input_length,
3121 const uint8_t *salt,
3122 size_t salt_length,
3123 uint8_t *output,
3124 size_t output_size,
3125 size_t *output_length)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003126{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003127 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003128 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003129 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003130 psa_key_attributes_t attributes;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003131
Darryl Green5cc689a2018-07-24 15:34:10 +01003132 (void) input;
3133 (void) input_length;
3134 (void) salt;
3135 (void) output;
3136 (void) output_size;
3137
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003138 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003139
Gilles Peskine449bd832023-01-11 14:50:10 +01003140 if (!PSA_ALG_IS_RSA_OAEP(alg) && salt_length != 0) {
3141 return PSA_ERROR_INVALID_ARGUMENT;
3142 }
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003143
Valerio Setti5bb454a2024-01-15 10:43:16 +01003144 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01003145 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg);
3146 if (status != PSA_SUCCESS) {
3147 return status;
3148 }
3149 if (!(PSA_KEY_TYPE_IS_PUBLIC_KEY(slot->attr.type) ||
3150 PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type))) {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003151 status = PSA_ERROR_INVALID_ARGUMENT;
3152 goto exit;
3153 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003154
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003155 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01003156 .core = slot->attr
Przemyslaw Stekiel19e61422021-12-09 11:09:11 +01003157 };
Steven Cooremana2371e52020-07-28 14:30:39 +02003158
Przemyslaw Stekiel19e61422021-12-09 11:09:11 +01003159 status = psa_driver_wrapper_asymmetric_encrypt(
3160 &attributes, slot->key.data, slot->key.bytes,
3161 alg, input, input_length, salt, salt_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003162 output, output_size, output_length);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003163exit:
Ryan Everetta103ec92024-01-31 13:59:57 +00003164 unlock_status = psa_unregister_read_under_mutex(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003165
Gilles Peskine449bd832023-01-11 14:50:10 +01003166 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003167}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003168
Gilles Peskine449bd832023-01-11 14:50:10 +01003169psa_status_t psa_asymmetric_decrypt(mbedtls_svc_key_id_t key,
3170 psa_algorithm_t alg,
3171 const uint8_t *input,
3172 size_t input_length,
3173 const uint8_t *salt,
3174 size_t salt_length,
3175 uint8_t *output,
3176 size_t output_size,
3177 size_t *output_length)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003178{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003179 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003180 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003181 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003182 psa_key_attributes_t attributes;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003183
Darryl Green5cc689a2018-07-24 15:34:10 +01003184 (void) input;
3185 (void) input_length;
3186 (void) salt;
3187 (void) output;
3188 (void) output_size;
3189
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003190 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003191
Gilles Peskine449bd832023-01-11 14:50:10 +01003192 if (!PSA_ALG_IS_RSA_OAEP(alg) && salt_length != 0) {
3193 return PSA_ERROR_INVALID_ARGUMENT;
3194 }
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003195
Valerio Setti5bb454a2024-01-15 10:43:16 +01003196 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01003197 key, &slot, PSA_KEY_USAGE_DECRYPT, alg);
3198 if (status != PSA_SUCCESS) {
3199 return status;
3200 }
3201 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003202 status = PSA_ERROR_INVALID_ARGUMENT;
3203 goto exit;
3204 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003205
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003206 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01003207 .core = slot->attr
Przemyslaw Stekiel8d45c002021-12-13 08:58:19 +01003208 };
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003209
Przemyslaw Stekiel8d45c002021-12-13 08:58:19 +01003210 status = psa_driver_wrapper_asymmetric_decrypt(
3211 &attributes, slot->key.data, slot->key.bytes,
3212 alg, input, input_length, salt, salt_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003213 output, output_size, output_length);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003214
3215exit:
Ryan Everetta103ec92024-01-31 13:59:57 +00003216 unlock_status = psa_unregister_read_under_mutex(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003217
Gilles Peskine449bd832023-01-11 14:50:10 +01003218 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003219}
Gilles Peskinee59236f2018-01-27 23:32:46 +01003220
Paul Elliott9fe12f62022-11-30 19:16:02 +00003221/****************************************************************/
3222/* Asymmetric interruptible cryptography */
3223/****************************************************************/
3224
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003225static uint32_t psa_interruptible_max_ops = PSA_INTERRUPTIBLE_MAX_OPS_UNLIMITED;
3226
Paul Elliott9fe12f62022-11-30 19:16:02 +00003227void psa_interruptible_set_max_ops(uint32_t max_ops)
3228{
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003229 psa_interruptible_max_ops = max_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003230}
3231
3232uint32_t psa_interruptible_get_max_ops(void)
3233{
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003234 return psa_interruptible_max_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003235}
3236
Paul Elliott9fe12f62022-11-30 19:16:02 +00003237uint32_t psa_sign_hash_get_num_ops(
3238 const psa_sign_hash_interruptible_operation_t *operation)
3239{
Paul Elliott296ede92022-12-15 17:00:30 +00003240 return operation->num_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003241}
3242
3243uint32_t psa_verify_hash_get_num_ops(
3244 const psa_verify_hash_interruptible_operation_t *operation)
3245{
Paul Elliott296ede92022-12-15 17:00:30 +00003246 return operation->num_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003247}
3248
Paul Elliott59ad9452022-12-18 15:09:02 +00003249static psa_status_t psa_sign_hash_abort_internal(
3250 psa_sign_hash_interruptible_operation_t *operation)
3251{
3252 if (operation->id == 0) {
3253 /* The object has (apparently) been initialized but it is not (yet)
3254 * in use. It's ok to call abort on such an object, and there's
3255 * nothing to do. */
3256 return PSA_SUCCESS;
3257 }
3258
3259 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3260
3261 status = psa_driver_wrapper_sign_hash_abort(operation);
3262
3263 operation->id = 0;
3264
Paul Elliotte6145dc2023-02-07 12:51:21 +00003265 /* Do not clear either the error_occurred or num_ops elements here as they
3266 * only want to be cleared by the application calling abort, not by abort
3267 * being called at completion of an operation. */
3268
Paul Elliott59ad9452022-12-18 15:09:02 +00003269 return status;
3270}
3271
Paul Elliott9fe12f62022-11-30 19:16:02 +00003272psa_status_t psa_sign_hash_start(
3273 psa_sign_hash_interruptible_operation_t *operation,
3274 mbedtls_svc_key_id_t key, psa_algorithm_t alg,
3275 const uint8_t *hash, size_t hash_length)
3276{
3277 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3278 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3279 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003280 psa_key_attributes_t attributes;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003281
Paul Elliottc9774412023-02-06 15:14:07 +00003282 /* Check that start has not been previously called, or operation has not
3283 * previously errored. */
3284 if (operation->id != 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003285 return PSA_ERROR_BAD_STATE;
3286 }
3287
Paul Elliott9fe12f62022-11-30 19:16:02 +00003288 status = psa_sign_verify_check_alg(0, alg);
3289 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003290 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003291 return status;
3292 }
3293
3294 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
3295 PSA_KEY_USAGE_SIGN_HASH,
3296 alg);
3297
3298 if (status != PSA_SUCCESS) {
3299 goto exit;
3300 }
3301
3302 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
3303 status = PSA_ERROR_INVALID_ARGUMENT;
3304 goto exit;
3305 }
3306
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003307 attributes = (psa_key_attributes_t) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003308 .core = slot->attr
3309 };
3310
Paul Elliott296ede92022-12-15 17:00:30 +00003311 /* Ensure ops count gets reset, in case of operation re-use. */
3312 operation->num_ops = 0;
3313
Paul Elliott9fe12f62022-11-30 19:16:02 +00003314 status = psa_driver_wrapper_sign_hash_start(operation, &attributes,
3315 slot->key.data,
3316 slot->key.bytes, alg,
3317 hash, hash_length);
3318exit:
3319
3320 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003321 operation->error_occurred = 1;
Paul Elliott59ad9452022-12-18 15:09:02 +00003322 psa_sign_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003323 }
3324
Ryan Everett1b70a072024-01-04 10:32:49 +00003325 unlock_status = psa_unregister_read(slot);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003326
Paul Elliottc9774412023-02-06 15:14:07 +00003327 if (unlock_status != PSA_SUCCESS) {
3328 operation->error_occurred = 1;
3329 }
Paul Elliott9fe12f62022-11-30 19:16:02 +00003330
Paul Elliottc9774412023-02-06 15:14:07 +00003331 return (status == PSA_SUCCESS) ? unlock_status : status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003332}
3333
3334
3335psa_status_t psa_sign_hash_complete(
3336 psa_sign_hash_interruptible_operation_t *operation,
3337 uint8_t *signature, size_t signature_size,
3338 size_t *signature_length)
3339{
3340 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3341
3342 *signature_length = 0;
3343
Paul Elliottc9774412023-02-06 15:14:07 +00003344 /* Check that start has been called first, and that operation has not
3345 * previously errored. */
3346 if (operation->id == 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003347 status = PSA_ERROR_BAD_STATE;
3348 goto exit;
3349 }
3350
Paul Elliott096abc42023-02-03 18:33:23 +00003351 /* Immediately reject a zero-length signature buffer. This guarantees that
3352 * signature must be a valid pointer. */
Paul Elliott9fe12f62022-11-30 19:16:02 +00003353 if (signature_size == 0) {
3354 status = PSA_ERROR_BUFFER_TOO_SMALL;
3355 goto exit;
3356 }
3357
3358 status = psa_driver_wrapper_sign_hash_complete(operation, signature,
3359 signature_size,
3360 signature_length);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003361
Paul Elliott296ede92022-12-15 17:00:30 +00003362 /* Update ops count with work done. */
Paul Elliottde1114c2023-02-07 12:43:11 +00003363 operation->num_ops = psa_driver_wrapper_sign_hash_get_num_ops(operation);
Paul Elliott296ede92022-12-15 17:00:30 +00003364
Paul Elliottebe225c2023-02-10 14:32:53 +00003365exit:
3366
Paul Elliott59200a22023-02-21 15:07:40 +00003367 psa_wipe_tag_output_buffer(signature, status, signature_size,
3368 *signature_length);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003369
Paul Elliott53bb3122023-02-10 14:22:22 +00003370 if (status != PSA_OPERATION_INCOMPLETE) {
Paul Elliottc9774412023-02-06 15:14:07 +00003371 if (status != PSA_SUCCESS) {
3372 operation->error_occurred = 1;
3373 }
3374
Paul Elliott59ad9452022-12-18 15:09:02 +00003375 psa_sign_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003376 }
3377
3378 return status;
3379}
3380
3381psa_status_t psa_sign_hash_abort(
3382 psa_sign_hash_interruptible_operation_t *operation)
3383{
Paul Elliott59ad9452022-12-18 15:09:02 +00003384 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3385
3386 status = psa_sign_hash_abort_internal(operation);
3387
3388 /* We clear the number of ops done here, so that it is not cleared when
3389 * the operation fails or succeeds, only on manual abort. */
3390 operation->num_ops = 0;
3391
Paul Elliottc9774412023-02-06 15:14:07 +00003392 /* Likewise, failure state. */
3393 operation->error_occurred = 0;
3394
Paul Elliott59ad9452022-12-18 15:09:02 +00003395 return status;
3396}
3397
3398static psa_status_t psa_verify_hash_abort_internal(
3399 psa_verify_hash_interruptible_operation_t *operation)
3400{
Paul Elliott9fe12f62022-11-30 19:16:02 +00003401 if (operation->id == 0) {
3402 /* The object has (apparently) been initialized but it is not (yet)
3403 * in use. It's ok to call abort on such an object, and there's
3404 * nothing to do. */
3405 return PSA_SUCCESS;
3406 }
3407
Paul Elliott59ad9452022-12-18 15:09:02 +00003408 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3409
3410 status = psa_driver_wrapper_verify_hash_abort(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003411
3412 operation->id = 0;
3413
Paul Elliotte6145dc2023-02-07 12:51:21 +00003414 /* Do not clear either the error_occurred or num_ops elements here as they
3415 * only want to be cleared by the application calling abort, not by abort
3416 * being called at completion of an operation. */
3417
Paul Elliott59ad9452022-12-18 15:09:02 +00003418 return status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003419}
3420
3421psa_status_t psa_verify_hash_start(
3422 psa_verify_hash_interruptible_operation_t *operation,
3423 mbedtls_svc_key_id_t key, psa_algorithm_t alg,
3424 const uint8_t *hash, size_t hash_length,
3425 const uint8_t *signature, size_t signature_length)
3426{
3427 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3428 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3429 psa_key_slot_t *slot;
3430
Paul Elliottc9774412023-02-06 15:14:07 +00003431 /* Check that start has not been previously called, or operation has not
3432 * previously errored. */
3433 if (operation->id != 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003434 return PSA_ERROR_BAD_STATE;
3435 }
3436
3437 status = psa_sign_verify_check_alg(0, alg);
3438 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003439 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003440 return status;
3441 }
3442
3443 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
3444 PSA_KEY_USAGE_VERIFY_HASH,
3445 alg);
3446
3447 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003448 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003449 return status;
3450 }
3451
3452 psa_key_attributes_t attributes = {
3453 .core = slot->attr
3454 };
3455
Paul Elliott296ede92022-12-15 17:00:30 +00003456 /* Ensure ops count gets reset, in case of operation re-use. */
3457 operation->num_ops = 0;
3458
Paul Elliott9fe12f62022-11-30 19:16:02 +00003459 status = psa_driver_wrapper_verify_hash_start(operation, &attributes,
3460 slot->key.data,
3461 slot->key.bytes,
3462 alg, hash, hash_length,
3463 signature, signature_length);
3464
3465 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003466 operation->error_occurred = 1;
Paul Elliott59ad9452022-12-18 15:09:02 +00003467 psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003468 }
3469
Ryan Everett1b70a072024-01-04 10:32:49 +00003470 unlock_status = psa_unregister_read(slot);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003471
Paul Elliottc9774412023-02-06 15:14:07 +00003472 if (unlock_status != PSA_SUCCESS) {
3473 operation->error_occurred = 1;
3474 }
Paul Elliott9fe12f62022-11-30 19:16:02 +00003475
Paul Elliottc9774412023-02-06 15:14:07 +00003476 return (status == PSA_SUCCESS) ? unlock_status : status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003477}
3478
3479psa_status_t psa_verify_hash_complete(
3480 psa_verify_hash_interruptible_operation_t *operation)
3481{
3482 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3483
Paul Elliottc9774412023-02-06 15:14:07 +00003484 /* Check that start has been called first, and that operation has not
3485 * previously errored. */
3486 if (operation->id == 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003487 status = PSA_ERROR_BAD_STATE;
3488 goto exit;
3489 }
3490
3491 status = psa_driver_wrapper_verify_hash_complete(operation);
3492
Paul Elliott296ede92022-12-15 17:00:30 +00003493 /* Update ops count with work done. */
Paul Elliottde1114c2023-02-07 12:43:11 +00003494 operation->num_ops = psa_driver_wrapper_verify_hash_get_num_ops(
Paul Elliott296ede92022-12-15 17:00:30 +00003495 operation);
3496
Paul Elliottebe225c2023-02-10 14:32:53 +00003497exit:
3498
Paul Elliott9fe12f62022-11-30 19:16:02 +00003499 if (status != PSA_OPERATION_INCOMPLETE) {
Paul Elliottc9774412023-02-06 15:14:07 +00003500 if (status != PSA_SUCCESS) {
3501 operation->error_occurred = 1;
3502 }
3503
Paul Elliott59ad9452022-12-18 15:09:02 +00003504 psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003505 }
3506
3507 return status;
3508}
3509
3510psa_status_t psa_verify_hash_abort(
3511 psa_verify_hash_interruptible_operation_t *operation)
3512{
Paul Elliott59ad9452022-12-18 15:09:02 +00003513 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003514
Paul Elliott59ad9452022-12-18 15:09:02 +00003515 status = psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003516
Paul Elliott59ad9452022-12-18 15:09:02 +00003517 /* We clear the number of ops done here, so that it is not cleared when
3518 * the operation fails or succeeds, only on manual abort. */
3519 operation->num_ops = 0;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003520
Paul Elliottc9774412023-02-06 15:14:07 +00003521 /* Likewise, failure state. */
3522 operation->error_occurred = 0;
3523
Paul Elliott59ad9452022-12-18 15:09:02 +00003524 return status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003525}
3526
Paul Elliott588f8ed2022-12-02 18:10:26 +00003527/****************************************************************/
3528/* Asymmetric interruptible cryptography internal */
3529/* implementations */
3530/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003531
Paul Elliott588f8ed2022-12-02 18:10:26 +00003532void mbedtls_psa_interruptible_set_max_ops(uint32_t max_ops)
3533{
Paul Elliott7cc4e812023-01-10 17:14:11 +00003534
Paul Elliott588f8ed2022-12-02 18:10:26 +00003535#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3536 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3537 defined(MBEDTLS_ECP_RESTARTABLE)
3538
3539 /* Internal implementation uses zero to indicate infinite number max ops,
3540 * therefore avoid this value, and set to minimum possible. */
3541 if (max_ops == 0) {
3542 max_ops = 1;
3543 }
3544
Paul Elliott588f8ed2022-12-02 18:10:26 +00003545 mbedtls_ecp_set_max_ops(max_ops);
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003546#else
3547 (void) max_ops;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003548#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3549 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3550 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3551}
3552
Paul Elliott588f8ed2022-12-02 18:10:26 +00003553uint32_t mbedtls_psa_sign_hash_get_num_ops(
Paul Elliottf8e5b562023-02-19 18:43:45 +00003554 const mbedtls_psa_sign_hash_interruptible_operation_t *operation)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003555{
3556#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3557 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3558 defined(MBEDTLS_ECP_RESTARTABLE)
3559
Paul Elliott93d9ca82023-02-15 18:14:21 +00003560 return operation->num_ops;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003561#else
3562 (void) operation;
3563 return 0;
3564#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3565 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3566 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3567}
3568
3569uint32_t mbedtls_psa_verify_hash_get_num_ops(
Paul Elliottf8e5b562023-02-19 18:43:45 +00003570 const mbedtls_psa_verify_hash_interruptible_operation_t *operation)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003571{
3572 #if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3573 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3574 defined(MBEDTLS_ECP_RESTARTABLE)
3575
Paul Elliott93d9ca82023-02-15 18:14:21 +00003576 return operation->num_ops;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003577#else
3578 (void) operation;
3579 return 0;
3580#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3581 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3582 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3583}
3584
3585psa_status_t mbedtls_psa_sign_hash_start(
3586 mbedtls_psa_sign_hash_interruptible_operation_t *operation,
3587 const psa_key_attributes_t *attributes, const uint8_t *key_buffer,
3588 size_t key_buffer_size, psa_algorithm_t alg,
3589 const uint8_t *hash, size_t hash_length)
3590{
3591 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott0290a762023-02-09 14:30:24 +00003592 size_t required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003593
Paul Elliott068fe072023-01-16 13:59:15 +00003594 if (!PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3595 return PSA_ERROR_NOT_SUPPORTED;
3596 }
3597
3598 if (!PSA_ALG_IS_ECDSA(alg)) {
Paul Elliott813f9cd2023-02-05 15:28:46 +00003599 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott068fe072023-01-16 13:59:15 +00003600 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003601
3602#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Paul Elliott068fe072023-01-16 13:59:15 +00003603 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3604 defined(MBEDTLS_ECP_RESTARTABLE)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003605
Paul Elliotta1c94092023-02-15 16:38:04 +00003606 mbedtls_ecdsa_restart_init(&operation->restart_ctx);
3607
Paul Elliott93d9ca82023-02-15 18:14:21 +00003608 /* Ensure num_ops is zero'ed in case of context re-use. */
3609 operation->num_ops = 0;
3610
Paul Elliott068fe072023-01-16 13:59:15 +00003611 status = mbedtls_psa_ecp_load_representation(attributes->core.type,
3612 attributes->core.bits,
3613 key_buffer,
3614 key_buffer_size,
3615 &operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003616
Paul Elliott068fe072023-01-16 13:59:15 +00003617 if (status != PSA_SUCCESS) {
3618 return status;
3619 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003620
Paul Elliott1bc59df2023-02-05 13:41:57 +00003621 operation->coordinate_bytes = PSA_BITS_TO_BYTES(
Paul Elliottc569fc22023-02-10 13:02:54 +00003622 operation->ctx->grp.nbits);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003623
Paul Elliott068fe072023-01-16 13:59:15 +00003624 psa_algorithm_t hash_alg = PSA_ALG_SIGN_GET_HASH(alg);
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02003625 operation->md_alg = mbedtls_md_type_from_psa_alg(hash_alg);
Paul Elliott068fe072023-01-16 13:59:15 +00003626 operation->alg = alg;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003627
Paul Elliott0290a762023-02-09 14:30:24 +00003628 /* We only need to store the same length of hash as the private key size
3629 * here, it would be truncated by the internal implementation anyway. */
3630 required_hash_length = (hash_length < operation->coordinate_bytes ?
3631 hash_length : operation->coordinate_bytes);
3632
Paul Elliottba70ad42023-02-15 18:23:53 +00003633 if (required_hash_length > sizeof(operation->hash)) {
3634 /* Shouldn't happen, but better safe than sorry. */
3635 return PSA_ERROR_CORRUPTION_DETECTED;
3636 }
3637
Paul Elliott0290a762023-02-09 14:30:24 +00003638 memcpy(operation->hash, hash, required_hash_length);
3639 operation->hash_length = required_hash_length;
Paul Elliott068fe072023-01-16 13:59:15 +00003640
3641 return PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003642
3643#else
Paul Elliott068fe072023-01-16 13:59:15 +00003644 (void) operation;
3645 (void) key_buffer;
3646 (void) key_buffer_size;
3647 (void) alg;
3648 (void) hash;
3649 (void) hash_length;
3650 (void) status;
Paul Elliott0290a762023-02-09 14:30:24 +00003651 (void) required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003652
Paul Elliott068fe072023-01-16 13:59:15 +00003653 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003654#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3655 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3656 * defined( MBEDTLS_ECP_RESTARTABLE ) */
Paul Elliott588f8ed2022-12-02 18:10:26 +00003657}
3658
3659psa_status_t mbedtls_psa_sign_hash_complete(
3660 mbedtls_psa_sign_hash_interruptible_operation_t *operation,
3661 uint8_t *signature, size_t signature_size,
3662 size_t *signature_length)
3663{
Paul Elliott588f8ed2022-12-02 18:10:26 +00003664#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3665 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3666 defined(MBEDTLS_ECP_RESTARTABLE)
3667
Paul Elliotta1c94092023-02-15 16:38:04 +00003668 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott1243f932023-02-07 11:21:10 +00003669 mbedtls_mpi r;
3670 mbedtls_mpi s;
3671
Paul Elliott46845252023-02-03 14:59:11 +00003672 mbedtls_mpi_init(&r);
3673 mbedtls_mpi_init(&s);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003674
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003675 /* Ensure max_ops is set to the current value (or default). */
3676 mbedtls_psa_interruptible_set_max_ops(psa_interruptible_get_max_ops());
3677
Paul Elliotta1c94092023-02-15 16:38:04 +00003678 if (signature_size < 2 * operation->coordinate_bytes) {
3679 status = PSA_ERROR_BUFFER_TOO_SMALL;
3680 goto exit;
3681 }
3682
Paul Elliott588f8ed2022-12-02 18:10:26 +00003683 if (PSA_ALG_ECDSA_IS_DETERMINISTIC(operation->alg)) {
Paul Elliott46845252023-02-03 14:59:11 +00003684
Paul Elliott588f8ed2022-12-02 18:10:26 +00003685#if defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3686 status = mbedtls_to_psa_error(
3687 mbedtls_ecdsa_sign_det_restartable(&operation->ctx->grp,
Paul Elliott46845252023-02-03 14:59:11 +00003688 &r,
3689 &s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003690 &operation->ctx->d,
3691 operation->hash,
3692 operation->hash_length,
3693 operation->md_alg,
3694 mbedtls_psa_get_random,
3695 MBEDTLS_PSA_RANDOM_STATE,
3696 &operation->restart_ctx));
3697#else /* defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Paul Elliott724bd252023-02-08 12:35:08 +00003698 status = PSA_ERROR_NOT_SUPPORTED;
3699 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003700#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
3701 } else {
Paul Elliott588f8ed2022-12-02 18:10:26 +00003702 status = mbedtls_to_psa_error(
3703 mbedtls_ecdsa_sign_restartable(&operation->ctx->grp,
Paul Elliott46845252023-02-03 14:59:11 +00003704 &r,
3705 &s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003706 &operation->ctx->d,
3707 operation->hash,
3708 operation->hash_length,
3709 mbedtls_psa_get_random,
3710 MBEDTLS_PSA_RANDOM_STATE,
3711 mbedtls_psa_get_random,
3712 MBEDTLS_PSA_RANDOM_STATE,
3713 &operation->restart_ctx));
3714 }
3715
Paul Elliottf8e5b562023-02-19 18:43:45 +00003716 /* Hide the fact that the restart context only holds a delta of number of
3717 * ops done during the last operation, not an absolute value. */
3718 operation->num_ops += operation->restart_ctx.ecp.ops_done;
3719
Paul Elliott724bd252023-02-08 12:35:08 +00003720 if (status == PSA_SUCCESS) {
Paul Elliott588f8ed2022-12-02 18:10:26 +00003721 status = mbedtls_to_psa_error(
Paul Elliott46845252023-02-03 14:59:11 +00003722 mbedtls_mpi_write_binary(&r,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003723 signature,
Paul Elliott1bc59df2023-02-05 13:41:57 +00003724 operation->coordinate_bytes)
3725 );
Paul Elliott588f8ed2022-12-02 18:10:26 +00003726
3727 if (status != PSA_SUCCESS) {
Paul Elliott724bd252023-02-08 12:35:08 +00003728 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003729 }
3730
3731 status = mbedtls_to_psa_error(
Paul Elliott46845252023-02-03 14:59:11 +00003732 mbedtls_mpi_write_binary(&s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003733 signature +
Paul Elliott1bc59df2023-02-05 13:41:57 +00003734 operation->coordinate_bytes,
3735 operation->coordinate_bytes)
3736 );
Paul Elliott588f8ed2022-12-02 18:10:26 +00003737
3738 if (status != PSA_SUCCESS) {
Paul Elliott724bd252023-02-08 12:35:08 +00003739 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003740 }
3741
Paul Elliott1bc59df2023-02-05 13:41:57 +00003742 *signature_length = operation->coordinate_bytes * 2;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003743
Paul Elliott724bd252023-02-08 12:35:08 +00003744 status = PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003745 }
Paul Elliott724bd252023-02-08 12:35:08 +00003746
3747exit:
3748
3749 mbedtls_mpi_free(&r);
3750 mbedtls_mpi_free(&s);
3751 return status;
3752
Paul Elliott588f8ed2022-12-02 18:10:26 +00003753 #else
3754
3755 (void) operation;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003756 (void) signature;
3757 (void) signature_size;
3758 (void) signature_length;
3759
3760 return PSA_ERROR_NOT_SUPPORTED;
3761
3762#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3763 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3764 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3765}
3766
3767psa_status_t mbedtls_psa_sign_hash_abort(
3768 mbedtls_psa_sign_hash_interruptible_operation_t *operation)
3769{
3770
3771#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3772 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3773 defined(MBEDTLS_ECP_RESTARTABLE)
3774
3775 if (operation->ctx) {
3776 mbedtls_ecdsa_free(operation->ctx);
3777 mbedtls_free(operation->ctx);
Paul Elliottf9c91a72023-02-05 18:06:38 +00003778 operation->ctx = NULL;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003779 }
3780
3781 mbedtls_ecdsa_restart_free(&operation->restart_ctx);
3782
Paul Elliott93d9ca82023-02-15 18:14:21 +00003783 operation->num_ops = 0;
3784
Paul Elliott588f8ed2022-12-02 18:10:26 +00003785 return PSA_SUCCESS;
3786
3787#else
3788
3789 (void) operation;
3790
3791 return PSA_ERROR_NOT_SUPPORTED;
3792
3793#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3794 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3795 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3796}
3797
3798psa_status_t mbedtls_psa_verify_hash_start(
3799 mbedtls_psa_verify_hash_interruptible_operation_t *operation,
3800 const psa_key_attributes_t *attributes,
3801 const uint8_t *key_buffer, size_t key_buffer_size,
3802 psa_algorithm_t alg,
3803 const uint8_t *hash, size_t hash_length,
3804 const uint8_t *signature, size_t signature_length)
3805{
3806 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott1bc59df2023-02-05 13:41:57 +00003807 size_t coordinate_bytes = 0;
Paul Elliott0290a762023-02-09 14:30:24 +00003808 size_t required_hash_length = 0;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003809
Paul Elliott068fe072023-01-16 13:59:15 +00003810 if (!PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3811 return PSA_ERROR_NOT_SUPPORTED;
3812 }
3813
3814 if (!PSA_ALG_IS_ECDSA(alg)) {
Paul Elliott813f9cd2023-02-05 15:28:46 +00003815 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott068fe072023-01-16 13:59:15 +00003816 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003817
3818#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Paul Elliott068fe072023-01-16 13:59:15 +00003819 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3820 defined(MBEDTLS_ECP_RESTARTABLE)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003821
Paul Elliotta1c94092023-02-15 16:38:04 +00003822 mbedtls_ecdsa_restart_init(&operation->restart_ctx);
3823 mbedtls_mpi_init(&operation->r);
3824 mbedtls_mpi_init(&operation->s);
3825
Paul Elliott93d9ca82023-02-15 18:14:21 +00003826 /* Ensure num_ops is zero'ed in case of context re-use. */
3827 operation->num_ops = 0;
3828
Paul Elliott068fe072023-01-16 13:59:15 +00003829 status = mbedtls_psa_ecp_load_representation(attributes->core.type,
3830 attributes->core.bits,
3831 key_buffer,
3832 key_buffer_size,
3833 &operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003834
Paul Elliott068fe072023-01-16 13:59:15 +00003835 if (status != PSA_SUCCESS) {
3836 return status;
3837 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003838
Paul Elliottc569fc22023-02-10 13:02:54 +00003839 coordinate_bytes = PSA_BITS_TO_BYTES(operation->ctx->grp.nbits);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003840
Paul Elliott1bc59df2023-02-05 13:41:57 +00003841 if (signature_length != 2 * coordinate_bytes) {
Paul Elliott068fe072023-01-16 13:59:15 +00003842 return PSA_ERROR_INVALID_SIGNATURE;
3843 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003844
Paul Elliott068fe072023-01-16 13:59:15 +00003845 status = mbedtls_to_psa_error(
3846 mbedtls_mpi_read_binary(&operation->r,
3847 signature,
Paul Elliott1bc59df2023-02-05 13:41:57 +00003848 coordinate_bytes));
Paul Elliott588f8ed2022-12-02 18:10:26 +00003849
Paul Elliott068fe072023-01-16 13:59:15 +00003850 if (status != PSA_SUCCESS) {
3851 return status;
3852 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003853
Paul Elliott068fe072023-01-16 13:59:15 +00003854 status = mbedtls_to_psa_error(
3855 mbedtls_mpi_read_binary(&operation->s,
3856 signature +
Paul Elliott1bc59df2023-02-05 13:41:57 +00003857 coordinate_bytes,
3858 coordinate_bytes));
Paul Elliott588f8ed2022-12-02 18:10:26 +00003859
Paul Elliott068fe072023-01-16 13:59:15 +00003860 if (status != PSA_SUCCESS) {
3861 return status;
3862 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003863
Paul Elliott2c9843f2023-02-15 17:32:42 +00003864 status = mbedtls_psa_ecp_load_public_part(operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003865
Paul Elliott2c9843f2023-02-15 17:32:42 +00003866 if (status != PSA_SUCCESS) {
3867 return status;
Paul Elliott068fe072023-01-16 13:59:15 +00003868 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003869
Paul Elliott0290a762023-02-09 14:30:24 +00003870 /* We only need to store the same length of hash as the private key size
3871 * here, it would be truncated by the internal implementation anyway. */
3872 required_hash_length = (hash_length < coordinate_bytes ? hash_length :
3873 coordinate_bytes);
3874
Paul Elliottba70ad42023-02-15 18:23:53 +00003875 if (required_hash_length > sizeof(operation->hash)) {
3876 /* Shouldn't happen, but better safe than sorry. */
3877 return PSA_ERROR_CORRUPTION_DETECTED;
3878 }
3879
Paul Elliott0290a762023-02-09 14:30:24 +00003880 memcpy(operation->hash, hash, required_hash_length);
3881 operation->hash_length = required_hash_length;
Paul Elliott068fe072023-01-16 13:59:15 +00003882
3883 return PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003884#else
Paul Elliott068fe072023-01-16 13:59:15 +00003885 (void) operation;
3886 (void) key_buffer;
3887 (void) key_buffer_size;
3888 (void) alg;
3889 (void) hash;
3890 (void) hash_length;
3891 (void) signature;
3892 (void) signature_length;
3893 (void) status;
Paul Elliott1243f932023-02-07 11:21:10 +00003894 (void) coordinate_bytes;
Paul Elliott0290a762023-02-09 14:30:24 +00003895 (void) required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003896
Paul Elliott068fe072023-01-16 13:59:15 +00003897 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003898#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3899 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3900 * defined( MBEDTLS_ECP_RESTARTABLE ) */
Paul Elliott588f8ed2022-12-02 18:10:26 +00003901}
3902
3903psa_status_t mbedtls_psa_verify_hash_complete(
3904 mbedtls_psa_verify_hash_interruptible_operation_t *operation)
3905{
3906
3907#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3908 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3909 defined(MBEDTLS_ECP_RESTARTABLE)
3910
Paul Elliottf8e5b562023-02-19 18:43:45 +00003911 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3912
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003913 /* Ensure max_ops is set to the current value (or default). */
3914 mbedtls_psa_interruptible_set_max_ops(psa_interruptible_get_max_ops());
3915
Paul Elliottf8e5b562023-02-19 18:43:45 +00003916 status = mbedtls_to_psa_error(
Paul Elliott588f8ed2022-12-02 18:10:26 +00003917 mbedtls_ecdsa_verify_restartable(&operation->ctx->grp,
3918 operation->hash,
3919 operation->hash_length,
3920 &operation->ctx->Q,
3921 &operation->r,
3922 &operation->s,
3923 &operation->restart_ctx));
3924
Paul Elliottf8e5b562023-02-19 18:43:45 +00003925 /* Hide the fact that the restart context only holds a delta of number of
3926 * ops done during the last operation, not an absolute value. */
3927 operation->num_ops += operation->restart_ctx.ecp.ops_done;
3928
3929 return status;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003930#else
3931 (void) operation;
3932
3933 return PSA_ERROR_NOT_SUPPORTED;
3934
3935#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3936 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3937 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3938}
3939
3940psa_status_t mbedtls_psa_verify_hash_abort(
3941 mbedtls_psa_verify_hash_interruptible_operation_t *operation)
3942{
3943
3944#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3945 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3946 defined(MBEDTLS_ECP_RESTARTABLE)
3947
3948 if (operation->ctx) {
3949 mbedtls_ecdsa_free(operation->ctx);
3950 mbedtls_free(operation->ctx);
Paul Elliottf9c91a72023-02-05 18:06:38 +00003951 operation->ctx = NULL;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003952 }
3953
3954 mbedtls_ecdsa_restart_free(&operation->restart_ctx);
3955
Paul Elliott93d9ca82023-02-15 18:14:21 +00003956 operation->num_ops = 0;
3957
Paul Elliott588f8ed2022-12-02 18:10:26 +00003958 mbedtls_mpi_free(&operation->r);
3959 mbedtls_mpi_free(&operation->s);
3960
3961 return PSA_SUCCESS;
3962
3963#else
3964 (void) operation;
3965
3966 return PSA_ERROR_NOT_SUPPORTED;
3967
3968#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3969 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3970 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3971}
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003972
mohammad1603503973b2018-03-12 15:59:30 +02003973/****************************************************************/
3974/* Symmetric cryptography */
3975/****************************************************************/
3976
Gilles Peskine449bd832023-01-11 14:50:10 +01003977static psa_status_t psa_cipher_setup(psa_cipher_operation_t *operation,
3978 mbedtls_svc_key_id_t key,
3979 psa_algorithm_t alg,
3980 mbedtls_operation_t cipher_operation)
Ronald Cronab99ac22020-10-01 16:38:28 +02003981{
3982 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3983 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman54648242021-06-24 11:49:45 +01003984 psa_key_slot_t *slot = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01003985 psa_key_usage_t usage = (cipher_operation == MBEDTLS_ENCRYPT ?
3986 PSA_KEY_USAGE_ENCRYPT :
3987 PSA_KEY_USAGE_DECRYPT);
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003988 psa_key_attributes_t attributes;
Ronald Cronab99ac22020-10-01 16:38:28 +02003989
3990 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003991 if (operation->id != 0) {
Dave Rodgman54648242021-06-24 11:49:45 +01003992 status = PSA_ERROR_BAD_STATE;
3993 goto exit;
3994 }
Ronald Cronab99ac22020-10-01 16:38:28 +02003995
Gilles Peskine449bd832023-01-11 14:50:10 +01003996 if (!PSA_ALG_IS_CIPHER(alg)) {
Dave Rodgman54648242021-06-24 11:49:45 +01003997 status = PSA_ERROR_INVALID_ARGUMENT;
3998 goto exit;
3999 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004000
Gilles Peskine449bd832023-01-11 14:50:10 +01004001 status = psa_get_and_lock_key_slot_with_policy(key, &slot, usage, alg);
4002 if (status != PSA_SUCCESS) {
Ronald Cronab99ac22020-10-01 16:38:28 +02004003 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004004 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004005
Ronald Cron49fafa92021-03-10 08:34:23 +01004006 /* Initialize the operation struct members, except for id. The id member
Ronald Cronab99ac22020-10-01 16:38:28 +02004007 * is used to indicate to psa_cipher_abort that there are resources to free,
Ronald Cron49fafa92021-03-10 08:34:23 +01004008 * so we only set it (in the driver wrapper) after resources have been
4009 * allocated/initialized. */
Ronald Cronab99ac22020-10-01 16:38:28 +02004010 operation->iv_set = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004011 if (alg == PSA_ALG_ECB_NO_PADDING) {
Ronald Cronab99ac22020-10-01 16:38:28 +02004012 operation->iv_required = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004013 } else {
Ronald Cronab99ac22020-10-01 16:38:28 +02004014 operation->iv_required = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004015 }
4016 operation->default_iv_length = PSA_CIPHER_IV_LENGTH(slot->attr.type, alg);
Ronald Cronab99ac22020-10-01 16:38:28 +02004017
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004018 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004019 .core = slot->attr
Ronald Crona4af55f2020-12-14 14:36:06 +01004020 };
4021
Ronald Cronab99ac22020-10-01 16:38:28 +02004022 /* Try doing the operation through a driver before using software fallback. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004023 if (cipher_operation == MBEDTLS_ENCRYPT) {
4024 status = psa_driver_wrapper_cipher_encrypt_setup(operation,
4025 &attributes,
4026 slot->key.data,
4027 slot->key.bytes,
4028 alg);
4029 } else {
4030 status = psa_driver_wrapper_cipher_decrypt_setup(operation,
4031 &attributes,
4032 slot->key.data,
4033 slot->key.bytes,
4034 alg);
4035 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004036
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004037exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004038 if (status != PSA_SUCCESS) {
4039 psa_cipher_abort(operation);
4040 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004041
Ryan Everett1b70a072024-01-04 10:32:49 +00004042 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02004043
Gilles Peskine449bd832023-01-11 14:50:10 +01004044 return (status == PSA_SUCCESS) ? unlock_status : status;
mohammad1603503973b2018-03-12 15:59:30 +02004045}
4046
Gilles Peskine449bd832023-01-11 14:50:10 +01004047psa_status_t psa_cipher_encrypt_setup(psa_cipher_operation_t *operation,
4048 mbedtls_svc_key_id_t key,
4049 psa_algorithm_t alg)
mohammad16038481e742018-03-18 13:57:31 +02004050{
Gilles Peskine449bd832023-01-11 14:50:10 +01004051 return psa_cipher_setup(operation, key, alg, MBEDTLS_ENCRYPT);
mohammad16038481e742018-03-18 13:57:31 +02004052}
4053
Gilles Peskine449bd832023-01-11 14:50:10 +01004054psa_status_t psa_cipher_decrypt_setup(psa_cipher_operation_t *operation,
4055 mbedtls_svc_key_id_t key,
4056 psa_algorithm_t alg)
mohammad16038481e742018-03-18 13:57:31 +02004057{
Gilles Peskine449bd832023-01-11 14:50:10 +01004058 return psa_cipher_setup(operation, key, alg, MBEDTLS_DECRYPT);
mohammad16038481e742018-03-18 13:57:31 +02004059}
4060
Gilles Peskine449bd832023-01-11 14:50:10 +01004061psa_status_t psa_cipher_generate_iv(psa_cipher_operation_t *operation,
4062 uint8_t *iv,
4063 size_t iv_size,
4064 size_t *iv_length)
mohammad1603503973b2018-03-12 15:59:30 +02004065{
Ronald Cron6d051732020-10-01 14:10:20 +02004066 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2fb90522021-07-05 12:31:44 +02004067 uint8_t local_iv[PSA_CIPHER_IV_MAX_SIZE];
Sergeybef1f632023-03-06 15:25:06 -07004068 size_t default_iv_length = 0;
Ronald Cron5618a392021-03-26 09:52:26 +01004069
Gilles Peskine449bd832023-01-11 14:50:10 +01004070 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004071 status = PSA_ERROR_BAD_STATE;
4072 goto exit;
Ronald Cronc45b4af2020-09-29 16:18:05 +02004073 }
4074
Gilles Peskine449bd832023-01-11 14:50:10 +01004075 if (operation->iv_set || !operation->iv_required) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004076 status = PSA_ERROR_BAD_STATE;
4077 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004078 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004079
Ronald Cron2fb90522021-07-05 12:31:44 +02004080 default_iv_length = operation->default_iv_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01004081 if (iv_size < default_iv_length) {
Ronald Cron5618a392021-03-26 09:52:26 +01004082 status = PSA_ERROR_BUFFER_TOO_SMALL;
4083 goto exit;
4084 }
Gilles Peskinee553c652018-06-04 16:22:46 +02004085
Gilles Peskine449bd832023-01-11 14:50:10 +01004086 if (default_iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Ronald Cron2fb90522021-07-05 12:31:44 +02004087 status = PSA_ERROR_GENERIC_ERROR;
4088 goto exit;
4089 }
4090
Gilles Peskine449bd832023-01-11 14:50:10 +01004091 status = psa_generate_random(local_iv, default_iv_length);
4092 if (status != PSA_SUCCESS) {
Ronald Cron5618a392021-03-26 09:52:26 +01004093 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004094 }
Ronald Cron5618a392021-03-26 09:52:26 +01004095
Gilles Peskine449bd832023-01-11 14:50:10 +01004096 status = psa_driver_wrapper_cipher_set_iv(operation,
4097 local_iv, default_iv_length);
Ronald Cron5618a392021-03-26 09:52:26 +01004098
4099exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004100 if (status == PSA_SUCCESS) {
4101 memcpy(iv, local_iv, default_iv_length);
Ronald Cron2fb90522021-07-05 12:31:44 +02004102 *iv_length = default_iv_length;
Steven Cooreman7df02922020-09-09 15:28:49 +02004103 operation->iv_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004104 } else {
Ronald Cron2fb90522021-07-05 12:31:44 +02004105 *iv_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004106 psa_cipher_abort(operation);
Ronald Cron2fb90522021-07-05 12:31:44 +02004107 }
Ronald Cron6d051732020-10-01 14:10:20 +02004108
Gilles Peskine449bd832023-01-11 14:50:10 +01004109 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004110}
4111
Gilles Peskine449bd832023-01-11 14:50:10 +01004112psa_status_t psa_cipher_set_iv(psa_cipher_operation_t *operation,
4113 const uint8_t *iv,
4114 size_t iv_length)
mohammad1603503973b2018-03-12 15:59:30 +02004115{
Ronald Cron6d051732020-10-01 14:10:20 +02004116 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronc45b4af2020-09-29 16:18:05 +02004117
Gilles Peskine449bd832023-01-11 14:50:10 +01004118 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004119 status = PSA_ERROR_BAD_STATE;
4120 goto exit;
4121 }
Ronald Cronc45b4af2020-09-29 16:18:05 +02004122
Gilles Peskine449bd832023-01-11 14:50:10 +01004123 if (operation->iv_set || !operation->iv_required) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004124 status = PSA_ERROR_BAD_STATE;
4125 goto exit;
4126 }
Ronald Crona0d68172021-03-26 10:15:08 +01004127
Gilles Peskine449bd832023-01-11 14:50:10 +01004128 if (iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004129 status = PSA_ERROR_INVALID_ARGUMENT;
4130 goto exit;
4131 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004132
Gilles Peskine449bd832023-01-11 14:50:10 +01004133 status = psa_driver_wrapper_cipher_set_iv(operation,
4134 iv,
4135 iv_length);
Steven Cooremand3feccd2020-09-01 15:56:14 +02004136
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004137exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004138 if (status == PSA_SUCCESS) {
itayzafrir534bd7c2018-08-02 13:56:32 +03004139 operation->iv_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004140 } else {
4141 psa_cipher_abort(operation);
4142 }
4143 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004144}
4145
Gilles Peskine449bd832023-01-11 14:50:10 +01004146psa_status_t psa_cipher_update(psa_cipher_operation_t *operation,
4147 const uint8_t *input,
4148 size_t input_length,
4149 uint8_t *output,
4150 size_t output_size,
4151 size_t *output_length)
mohammad1603503973b2018-03-12 15:59:30 +02004152{
Steven Cooremanffecb7b2020-08-25 15:13:13 +02004153 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron6d051732020-10-01 14:10:20 +02004154
Gilles Peskine449bd832023-01-11 14:50:10 +01004155 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004156 status = PSA_ERROR_BAD_STATE;
4157 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004158 }
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004159
Gilles Peskine449bd832023-01-11 14:50:10 +01004160 if (operation->iv_required && !operation->iv_set) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004161 status = PSA_ERROR_BAD_STATE;
4162 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004163 }
Jaeden Ameroab439972019-02-15 14:12:05 +00004164
Gilles Peskine449bd832023-01-11 14:50:10 +01004165 status = psa_driver_wrapper_cipher_update(operation,
4166 input,
4167 input_length,
4168 output,
4169 output_size,
4170 output_length);
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004171
4172exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004173 if (status != PSA_SUCCESS) {
4174 psa_cipher_abort(operation);
4175 }
Ronald Cron6d051732020-10-01 14:10:20 +02004176
Gilles Peskine449bd832023-01-11 14:50:10 +01004177 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004178}
4179
Gilles Peskine449bd832023-01-11 14:50:10 +01004180psa_status_t psa_cipher_finish(psa_cipher_operation_t *operation,
4181 uint8_t *output,
4182 size_t output_size,
4183 size_t *output_length)
mohammad1603503973b2018-03-12 15:59:30 +02004184{
David Saadab4ecc272019-02-14 13:48:10 +02004185 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Ronald Cron6d051732020-10-01 14:10:20 +02004186
Gilles Peskine449bd832023-01-11 14:50:10 +01004187 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004188 status = PSA_ERROR_BAD_STATE;
4189 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004190 }
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004191
Gilles Peskine449bd832023-01-11 14:50:10 +01004192 if (operation->iv_required && !operation->iv_set) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004193 status = PSA_ERROR_BAD_STATE;
4194 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004195 }
Moran Pekerbed71a22018-04-22 20:19:20 +03004196
Gilles Peskine449bd832023-01-11 14:50:10 +01004197 status = psa_driver_wrapper_cipher_finish(operation,
4198 output,
4199 output_size,
4200 output_length);
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004201
4202exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004203 if (status == PSA_SUCCESS) {
4204 return psa_cipher_abort(operation);
4205 } else {
Steven Cooremanef8575e2020-09-11 11:44:50 +02004206 *output_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004207 (void) psa_cipher_abort(operation);
Janos Follath315b51c2018-07-09 16:04:51 +01004208
Gilles Peskine449bd832023-01-11 14:50:10 +01004209 return status;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004210 }
mohammad1603503973b2018-03-12 15:59:30 +02004211}
4212
Gilles Peskine449bd832023-01-11 14:50:10 +01004213psa_status_t psa_cipher_abort(psa_cipher_operation_t *operation)
Gilles Peskinee553c652018-06-04 16:22:46 +02004214{
Gilles Peskine449bd832023-01-11 14:50:10 +01004215 if (operation->id == 0) {
Steven Cooremana07b9972020-09-10 14:54:14 +02004216 /* The object has (apparently) been initialized but it is not (yet)
Gilles Peskine81736312018-06-26 15:04:31 +02004217 * in use. It's ok to call abort on such an object, and there's
4218 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004219 return PSA_SUCCESS;
Gilles Peskine81736312018-06-26 15:04:31 +02004220 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004221
Gilles Peskine449bd832023-01-11 14:50:10 +01004222 psa_driver_wrapper_cipher_abort(operation);
Gilles Peskinee553c652018-06-04 16:22:46 +02004223
Ronald Cron49fafa92021-03-10 08:34:23 +01004224 operation->id = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004225 operation->iv_set = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004226 operation->iv_required = 0;
Moran Peker41deec42018-04-04 15:43:05 +03004227
Gilles Peskine449bd832023-01-11 14:50:10 +01004228 return PSA_SUCCESS;
mohammad1603503973b2018-03-12 15:59:30 +02004229}
4230
Gilles Peskine449bd832023-01-11 14:50:10 +01004231psa_status_t psa_cipher_encrypt(mbedtls_svc_key_id_t key,
4232 psa_algorithm_t alg,
4233 const uint8_t *input,
4234 size_t input_length,
4235 uint8_t *output,
4236 size_t output_size,
4237 size_t *output_length)
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004238{
4239 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004240 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron23919522021-07-08 19:00:07 +02004241 psa_key_slot_t *slot = NULL;
Ronald Cronc6e6f502021-07-09 18:44:58 +02004242 uint8_t local_iv[PSA_CIPHER_IV_MAX_SIZE];
4243 size_t default_iv_length = 0;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004244 psa_key_attributes_t attributes;
gabor-mezei-arm6f4e5bb2021-06-25 15:21:11 +02004245
Gilles Peskine449bd832023-01-11 14:50:10 +01004246 if (!PSA_ALG_IS_CIPHER(alg)) {
Ronald Cron23919522021-07-08 19:00:07 +02004247 status = PSA_ERROR_INVALID_ARGUMENT;
4248 goto exit;
4249 }
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004250
Gilles Peskine449bd832023-01-11 14:50:10 +01004251 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
4252 PSA_KEY_USAGE_ENCRYPT,
4253 alg);
4254 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004255 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004256 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004257
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004258 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004259 .core = slot->attr
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004260 };
4261
Gilles Peskine449bd832023-01-11 14:50:10 +01004262 default_iv_length = PSA_CIPHER_IV_LENGTH(slot->attr.type, alg);
4263 if (default_iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Ronald Cronc6e6f502021-07-09 18:44:58 +02004264 status = PSA_ERROR_GENERIC_ERROR;
4265 goto exit;
4266 }
4267
Gilles Peskine449bd832023-01-11 14:50:10 +01004268 if (default_iv_length > 0) {
4269 if (output_size < default_iv_length) {
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004270 status = PSA_ERROR_BUFFER_TOO_SMALL;
4271 goto exit;
4272 }
4273
Gilles Peskine449bd832023-01-11 14:50:10 +01004274 status = psa_generate_random(local_iv, default_iv_length);
4275 if (status != PSA_SUCCESS) {
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004276 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004277 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004278 }
4279
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004280 status = psa_driver_wrapper_cipher_encrypt(
4281 &attributes, slot->key.data, slot->key.bytes,
Ronald Cronc6e6f502021-07-09 18:44:58 +02004282 alg, local_iv, default_iv_length, input, input_length,
Ronald Cronafbc7ed2023-01-24 16:02:04 +01004283 psa_crypto_buffer_offset(output, default_iv_length),
Gilles Peskine449bd832023-01-11 14:50:10 +01004284 output_size - default_iv_length, output_length);
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004285
4286exit:
Ryan Everetta103ec92024-01-31 13:59:57 +00004287 unlock_status = psa_unregister_read_under_mutex(slot);
Gilles Peskine449bd832023-01-11 14:50:10 +01004288 if (status == PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004289 status = unlock_status;
Ronald Cronc6e6f502021-07-09 18:44:58 +02004290 }
Ronald Cron23919522021-07-08 19:00:07 +02004291
Gilles Peskine449bd832023-01-11 14:50:10 +01004292 if (status == PSA_SUCCESS) {
4293 if (default_iv_length > 0) {
4294 memcpy(output, local_iv, default_iv_length);
4295 }
4296 *output_length += default_iv_length;
4297 } else {
4298 *output_length = 0;
4299 }
4300
4301 return status;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004302}
4303
Gilles Peskine449bd832023-01-11 14:50:10 +01004304psa_status_t psa_cipher_decrypt(mbedtls_svc_key_id_t key,
4305 psa_algorithm_t alg,
4306 const uint8_t *input,
4307 size_t input_length,
4308 uint8_t *output,
4309 size_t output_size,
4310 size_t *output_length)
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004311{
4312 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004313 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron23919522021-07-08 19:00:07 +02004314 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004315 psa_key_attributes_t attributes;
gabor-mezei-arm6f4e5bb2021-06-25 15:21:11 +02004316
Gilles Peskine449bd832023-01-11 14:50:10 +01004317 if (!PSA_ALG_IS_CIPHER(alg)) {
Ronald Cron23919522021-07-08 19:00:07 +02004318 status = PSA_ERROR_INVALID_ARGUMENT;
4319 goto exit;
4320 }
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004321
Gilles Peskine449bd832023-01-11 14:50:10 +01004322 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
4323 PSA_KEY_USAGE_DECRYPT,
4324 alg);
4325 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004326 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004327 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004328
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004329 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004330 .core = slot->attr
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004331 };
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004332
Gilles Peskine449bd832023-01-11 14:50:10 +01004333 if (alg == PSA_ALG_CCM_STAR_NO_TAG &&
4334 input_length < PSA_BLOCK_CIPHER_BLOCK_LENGTH(slot->attr.type)) {
Mateusz Starzyk594215b2021-10-14 12:23:06 +02004335 status = PSA_ERROR_INVALID_ARGUMENT;
4336 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004337 } else if (input_length < PSA_CIPHER_IV_LENGTH(slot->attr.type, alg)) {
gabor-mezei-arm258ae072021-06-25 15:25:38 +02004338 status = PSA_ERROR_INVALID_ARGUMENT;
4339 goto exit;
4340 }
4341
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004342 status = psa_driver_wrapper_cipher_decrypt(
4343 &attributes, slot->key.data, slot->key.bytes,
4344 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004345 output, output_size, output_length);
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004346
gabor-mezei-arm258ae072021-06-25 15:25:38 +02004347exit:
Ryan Everetta103ec92024-01-31 13:59:57 +00004348 unlock_status = psa_unregister_read_under_mutex(slot);
Gilles Peskine449bd832023-01-11 14:50:10 +01004349 if (status == PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004350 status = unlock_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01004351 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004352
Gilles Peskine449bd832023-01-11 14:50:10 +01004353 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004354 *output_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004355 }
Ronald Cron23919522021-07-08 19:00:07 +02004356
Gilles Peskine449bd832023-01-11 14:50:10 +01004357 return status;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004358}
4359
4360
mohammad16035955c982018-04-26 00:53:03 +03004361/****************************************************************/
4362/* AEAD */
4363/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004364
Paul Elliottbaff51c2021-09-28 17:44:45 +01004365/* Helper function to get the base algorithm from its variants. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004366static psa_algorithm_t psa_aead_get_base_algorithm(psa_algorithm_t alg)
Paul Elliottbaff51c2021-09-28 17:44:45 +01004367{
Gilles Peskine449bd832023-01-11 14:50:10 +01004368 return PSA_ALG_AEAD_WITH_DEFAULT_LENGTH_TAG(alg);
Paul Elliottbaff51c2021-09-28 17:44:45 +01004369}
4370
4371/* Helper function to perform common nonce length checks. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004372static psa_status_t psa_aead_check_nonce_length(psa_algorithm_t alg,
4373 size_t nonce_length)
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004374{
Gilles Peskine449bd832023-01-11 14:50:10 +01004375 psa_algorithm_t base_alg = psa_aead_get_base_algorithm(alg);
Paul Elliottbaff51c2021-09-28 17:44:45 +01004376
Gilles Peskine449bd832023-01-11 14:50:10 +01004377 switch (base_alg) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004378#if defined(PSA_WANT_ALG_GCM)
4379 case PSA_ALG_GCM:
4380 /* Not checking max nonce size here as GCM spec allows almost
Gilles Peskine449bd832023-01-11 14:50:10 +01004381 * arbitrarily large nonces. Please note that we do not generally
4382 * recommend the usage of nonces of greater length than
4383 * PSA_AEAD_NONCE_MAX_SIZE, as large nonces are hashed to a shorter
4384 * size, which can then lead to collisions if you encrypt a very
4385 * large number of messages.*/
4386 if (nonce_length != 0) {
4387 return PSA_SUCCESS;
4388 }
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004389 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004390#endif /* PSA_WANT_ALG_GCM */
4391#if defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004392 case PSA_ALG_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01004393 if (nonce_length >= 7 && nonce_length <= 13) {
4394 return PSA_SUCCESS;
4395 }
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004396 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004397#endif /* PSA_WANT_ALG_CCM */
4398#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004399 case PSA_ALG_CHACHA20_POLY1305:
Gilles Peskine449bd832023-01-11 14:50:10 +01004400 if (nonce_length == 12) {
4401 return PSA_SUCCESS;
4402 } else if (nonce_length == 8) {
4403 return PSA_ERROR_NOT_SUPPORTED;
4404 }
Bence Szépkúti6d48e202021-11-15 20:04:15 +01004405 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004406#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004407 default:
Przemek Stekiel4c499272022-09-27 13:55:37 +02004408 (void) nonce_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01004409 return PSA_ERROR_NOT_SUPPORTED;
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004410 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004411
Gilles Peskine449bd832023-01-11 14:50:10 +01004412 return PSA_ERROR_INVALID_ARGUMENT;
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004413}
4414
Gilles Peskine449bd832023-01-11 14:50:10 +01004415static psa_status_t psa_aead_check_algorithm(psa_algorithm_t alg)
Bence Szépkútiaa3a6e42022-01-13 16:26:03 +01004416{
Gilles Peskine449bd832023-01-11 14:50:10 +01004417 if (!PSA_ALG_IS_AEAD(alg) || PSA_ALG_IS_WILDCARD(alg)) {
4418 return PSA_ERROR_INVALID_ARGUMENT;
4419 }
Bence Szépkúti08f34652021-12-08 21:07:13 +01004420
Gilles Peskine449bd832023-01-11 14:50:10 +01004421 return PSA_SUCCESS;
Bence Szépkúti08f34652021-12-08 21:07:13 +01004422}
4423
Gilles Peskine449bd832023-01-11 14:50:10 +01004424psa_status_t psa_aead_encrypt(mbedtls_svc_key_id_t key,
4425 psa_algorithm_t alg,
4426 const uint8_t *nonce,
4427 size_t nonce_length,
4428 const uint8_t *additional_data,
4429 size_t additional_data_length,
4430 const uint8_t *plaintext,
4431 size_t plaintext_length,
4432 uint8_t *ciphertext,
4433 size_t ciphertext_size,
4434 size_t *ciphertext_length)
mohammad16035955c982018-04-26 00:53:03 +03004435{
Ronald Cron215633c2021-03-16 17:15:37 +01004436 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4437 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02004438
mohammad1603f08a5502018-06-03 15:05:47 +03004439 *ciphertext_length = 0;
mohammad1603e58e6842018-05-09 04:58:32 -07004440
Gilles Peskine449bd832023-01-11 14:50:10 +01004441 status = psa_aead_check_algorithm(alg);
4442 if (status != PSA_SUCCESS) {
4443 return status;
4444 }
Steven Cooremanea7ab132021-03-17 16:28:00 +01004445
Ronald Cron9a986162021-03-26 12:40:07 +01004446 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01004447 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg);
4448 if (status != PSA_SUCCESS) {
4449 return status;
4450 }
mohammad16035955c982018-04-26 00:53:03 +03004451
Ronald Cron215633c2021-03-16 17:15:37 +01004452 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01004453 .core = slot->attr
Ronald Cron215633c2021-03-16 17:15:37 +01004454 };
mohammad16035955c982018-04-26 00:53:03 +03004455
Gilles Peskine449bd832023-01-11 14:50:10 +01004456 status = psa_aead_check_nonce_length(alg, nonce_length);
4457 if (status != PSA_SUCCESS) {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004458 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004459 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004460
Ronald Cronde822812021-03-17 16:08:20 +01004461 status = psa_driver_wrapper_aead_encrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01004462 &attributes, slot->key.data, slot->key.bytes,
4463 alg,
4464 nonce, nonce_length,
4465 additional_data, additional_data_length,
4466 plaintext, plaintext_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004467 ciphertext, ciphertext_size, ciphertext_length);
Gilles Peskine2d277862018-06-18 15:41:12 +02004468
Gilles Peskine449bd832023-01-11 14:50:10 +01004469 if (status != PSA_SUCCESS && ciphertext_size != 0) {
4470 memset(ciphertext, 0, ciphertext_size);
4471 }
Gilles Peskine2d277862018-06-18 15:41:12 +02004472
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004473exit:
Ryan Everetta103ec92024-01-31 13:59:57 +00004474 psa_unregister_read_under_mutex(slot);
mohammad16035955c982018-04-26 00:53:03 +03004475
Gilles Peskine449bd832023-01-11 14:50:10 +01004476 return status;
Gilles Peskineee652a32018-06-01 19:23:52 +02004477}
4478
Gilles Peskine449bd832023-01-11 14:50:10 +01004479psa_status_t psa_aead_decrypt(mbedtls_svc_key_id_t key,
4480 psa_algorithm_t alg,
4481 const uint8_t *nonce,
4482 size_t nonce_length,
4483 const uint8_t *additional_data,
4484 size_t additional_data_length,
4485 const uint8_t *ciphertext,
4486 size_t ciphertext_length,
4487 uint8_t *plaintext,
4488 size_t plaintext_size,
4489 size_t *plaintext_length)
mohammad16035955c982018-04-26 00:53:03 +03004490{
Ronald Cron215633c2021-03-16 17:15:37 +01004491 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4492 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02004493
Gilles Peskineee652a32018-06-01 19:23:52 +02004494 *plaintext_length = 0;
mohammad16039e5a5152018-04-26 12:07:35 +03004495
Gilles Peskine449bd832023-01-11 14:50:10 +01004496 status = psa_aead_check_algorithm(alg);
4497 if (status != PSA_SUCCESS) {
4498 return status;
4499 }
Steven Cooremanea7ab132021-03-17 16:28:00 +01004500
Ronald Cron9a986162021-03-26 12:40:07 +01004501 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01004502 key, &slot, PSA_KEY_USAGE_DECRYPT, alg);
4503 if (status != PSA_SUCCESS) {
4504 return status;
4505 }
mohammad16035955c982018-04-26 00:53:03 +03004506
Ronald Cron215633c2021-03-16 17:15:37 +01004507 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01004508 .core = slot->attr
Ronald Cron215633c2021-03-16 17:15:37 +01004509 };
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004510
Gilles Peskine449bd832023-01-11 14:50:10 +01004511 status = psa_aead_check_nonce_length(alg, nonce_length);
4512 if (status != PSA_SUCCESS) {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004513 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004514 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004515
Ronald Cronde822812021-03-17 16:08:20 +01004516 status = psa_driver_wrapper_aead_decrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01004517 &attributes, slot->key.data, slot->key.bytes,
4518 alg,
4519 nonce, nonce_length,
4520 additional_data, additional_data_length,
4521 ciphertext, ciphertext_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004522 plaintext, plaintext_size, plaintext_length);
Gilles Peskinea40d7742018-06-01 16:28:30 +02004523
Gilles Peskine449bd832023-01-11 14:50:10 +01004524 if (status != PSA_SUCCESS && plaintext_size != 0) {
4525 memset(plaintext, 0, plaintext_size);
4526 }
mohammad160360a64d02018-06-03 17:20:42 +03004527
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004528exit:
Ryan Everetta103ec92024-01-31 13:59:57 +00004529 psa_unregister_read_under_mutex(slot);
Ronald Cron215633c2021-03-16 17:15:37 +01004530
Gilles Peskine449bd832023-01-11 14:50:10 +01004531 return status;
mohammad16035955c982018-04-26 00:53:03 +03004532}
4533
Gilles Peskine449bd832023-01-11 14:50:10 +01004534static psa_status_t psa_validate_tag_length(psa_algorithm_t alg)
4535{
4536 const uint8_t tag_len = PSA_ALG_AEAD_GET_TAG_LENGTH(alg);
Andrzej Kurekf8816012021-12-19 17:00:12 +01004537
Gilles Peskine449bd832023-01-11 14:50:10 +01004538 switch (PSA_ALG_AEAD_WITH_SHORTENED_TAG(alg, 0)) {
Przemek Stekiel86679c72022-10-06 17:06:56 +02004539#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004540 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004541 /* CCM allows the following tag lengths: 4, 6, 8, 10, 12, 14, 16.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004542 if (tag_len < 4 || tag_len > 16 || tag_len % 2) {
4543 return PSA_ERROR_INVALID_ARGUMENT;
4544 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01004545 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02004546#endif /* PSA_WANT_ALG_CCM */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004547
Przemek Stekiel86679c72022-10-06 17:06:56 +02004548#if defined(PSA_WANT_ALG_GCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004549 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_GCM, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004550 /* GCM allows the following tag lengths: 4, 8, 12, 13, 14, 15, 16. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004551 if (tag_len != 4 && tag_len != 8 && (tag_len < 12 || tag_len > 16)) {
4552 return PSA_ERROR_INVALID_ARGUMENT;
4553 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01004554 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02004555#endif /* PSA_WANT_ALG_GCM */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004556
Przemek Stekiel86679c72022-10-06 17:06:56 +02004557#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Gilles Peskine449bd832023-01-11 14:50:10 +01004558 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CHACHA20_POLY1305, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004559 /* We only support the default tag length. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004560 if (tag_len != 16) {
4561 return PSA_ERROR_INVALID_ARGUMENT;
4562 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01004563 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02004564#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004565
4566 default:
4567 (void) tag_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004568 return PSA_ERROR_NOT_SUPPORTED;
Andrzej Kurekf8816012021-12-19 17:00:12 +01004569 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004570 return PSA_SUCCESS;
Andrzej Kurekf8816012021-12-19 17:00:12 +01004571}
4572
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004573/* Set the key for a multipart authenticated operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004574static psa_status_t psa_aead_setup(psa_aead_operation_t *operation,
4575 int is_encrypt,
4576 mbedtls_svc_key_id_t key,
4577 psa_algorithm_t alg)
Paul Elliottc2b71442021-06-24 18:17:52 +01004578{
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004579 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4580 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
4581 psa_key_slot_t *slot = NULL;
4582 psa_key_usage_t key_usage = 0;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004583 psa_key_attributes_t attributes;
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004584
Gilles Peskine449bd832023-01-11 14:50:10 +01004585 status = psa_aead_check_algorithm(alg);
4586 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004587 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004588 }
Paul Elliottc2b71442021-06-24 18:17:52 +01004589
Gilles Peskine449bd832023-01-11 14:50:10 +01004590 if (operation->id != 0) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004591 status = PSA_ERROR_BAD_STATE;
4592 goto exit;
Paul Elliottc2b71442021-06-24 18:17:52 +01004593 }
4594
Gilles Peskine449bd832023-01-11 14:50:10 +01004595 if (operation->nonce_set || operation->lengths_set ||
4596 operation->ad_started || operation->body_started) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004597 status = PSA_ERROR_BAD_STATE;
4598 goto exit;
Paul Elliottc2b71442021-06-24 18:17:52 +01004599 }
4600
Gilles Peskine449bd832023-01-11 14:50:10 +01004601 if (is_encrypt) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004602 key_usage = PSA_KEY_USAGE_ENCRYPT;
Gilles Peskine449bd832023-01-11 14:50:10 +01004603 } else {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004604 key_usage = PSA_KEY_USAGE_DECRYPT;
Gilles Peskine449bd832023-01-11 14:50:10 +01004605 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004606
Gilles Peskine449bd832023-01-11 14:50:10 +01004607 status = psa_get_and_lock_key_slot_with_policy(key, &slot, key_usage,
4608 alg);
4609 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004610 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004611 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004612
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004613 attributes = (psa_key_attributes_t) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004614 .core = slot->attr
4615 };
4616
Gilles Peskine449bd832023-01-11 14:50:10 +01004617 if ((status = psa_validate_tag_length(alg)) != PSA_SUCCESS) {
Przemek Stekiel6ab50762022-10-08 17:54:30 +02004618 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004619 }
Przemek Stekiel6ab50762022-10-08 17:54:30 +02004620
Gilles Peskine449bd832023-01-11 14:50:10 +01004621 if (is_encrypt) {
4622 status = psa_driver_wrapper_aead_encrypt_setup(operation,
4623 &attributes,
4624 slot->key.data,
4625 slot->key.bytes,
4626 alg);
4627 } else {
4628 status = psa_driver_wrapper_aead_decrypt_setup(operation,
4629 &attributes,
4630 slot->key.data,
4631 slot->key.bytes,
4632 alg);
4633 }
4634 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004635 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004636 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004637
Gilles Peskine449bd832023-01-11 14:50:10 +01004638 operation->key_type = psa_get_key_type(&attributes);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004639
4640exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00004641 unlock_status = psa_unregister_read(slot);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004642
Gilles Peskine449bd832023-01-11 14:50:10 +01004643 if (status == PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004644 status = unlock_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01004645 operation->alg = psa_aead_get_base_algorithm(alg);
Paul Elliottd9343f22021-08-23 18:59:49 +01004646 operation->is_encrypt = is_encrypt;
Gilles Peskine449bd832023-01-11 14:50:10 +01004647 } else {
4648 psa_aead_abort(operation);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004649 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004650
Gilles Peskine449bd832023-01-11 14:50:10 +01004651 return status;
Paul Elliottc2b71442021-06-24 18:17:52 +01004652}
4653
Paul Elliott302ff6b2021-04-20 18:10:30 +01004654/* Set the key for a multipart authenticated encryption operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004655psa_status_t psa_aead_encrypt_setup(psa_aead_operation_t *operation,
4656 mbedtls_svc_key_id_t key,
4657 psa_algorithm_t alg)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004658{
Gilles Peskine449bd832023-01-11 14:50:10 +01004659 return psa_aead_setup(operation, 1, key, alg);
Paul Elliott302ff6b2021-04-20 18:10:30 +01004660}
4661
4662/* Set the key for a multipart authenticated decryption operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004663psa_status_t psa_aead_decrypt_setup(psa_aead_operation_t *operation,
4664 mbedtls_svc_key_id_t key,
4665 psa_algorithm_t alg)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004666{
Gilles Peskine449bd832023-01-11 14:50:10 +01004667 return psa_aead_setup(operation, 0, key, alg);
Paul Elliott302ff6b2021-04-20 18:10:30 +01004668}
4669
4670/* Generate a random nonce / IV for multipart AEAD operation */
Gilles Peskine449bd832023-01-11 14:50:10 +01004671psa_status_t psa_aead_generate_nonce(psa_aead_operation_t *operation,
4672 uint8_t *nonce,
4673 size_t nonce_size,
4674 size_t *nonce_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004675{
4676 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Croncae59092021-11-26 18:53:58 +01004677 uint8_t local_nonce[PSA_AEAD_NONCE_MAX_SIZE];
Sergeybef1f632023-03-06 15:25:06 -07004678 size_t required_nonce_size = 0;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004679
Paul Elliott8eb9daf2021-06-04 16:42:21 +01004680 *nonce_length = 0;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004681
Gilles Peskine449bd832023-01-11 14:50:10 +01004682 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004683 status = PSA_ERROR_BAD_STATE;
4684 goto exit;
4685 }
4686
Gilles Peskine449bd832023-01-11 14:50:10 +01004687 if (operation->nonce_set || !operation->is_encrypt) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004688 status = PSA_ERROR_BAD_STATE;
4689 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004690 }
4691
Paul Elliotte193ea82021-10-01 13:00:16 +01004692 /* For CCM, this size may not be correct according to the PSA
4693 * specification. The PSA Crypto 1.0.1 specification states:
4694 *
4695 * CCM encodes the plaintext length pLen in L octets, with L the smallest
4696 * integer >= 2 where pLen < 2^(8L). The nonce length is then 15 - L bytes.
4697 *
4698 * However this restriction that L has to be the smallest integer is not
4699 * applied in practice, and it is not implementable here since the
4700 * plaintext length may or may not be known at this time. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004701 required_nonce_size = PSA_AEAD_NONCE_LENGTH(operation->key_type,
4702 operation->alg);
4703 if (nonce_size < required_nonce_size) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004704 status = PSA_ERROR_BUFFER_TOO_SMALL;
4705 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004706 }
4707
Gilles Peskine449bd832023-01-11 14:50:10 +01004708 status = psa_generate_random(local_nonce, required_nonce_size);
4709 if (status != PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004710 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004711 }
Paul Elliott302ff6b2021-04-20 18:10:30 +01004712
Gilles Peskine449bd832023-01-11 14:50:10 +01004713 status = psa_aead_set_nonce(operation, local_nonce, required_nonce_size);
Paul Elliott302ff6b2021-04-20 18:10:30 +01004714
Paul Elliott39dc6b82021-05-11 19:16:09 +01004715exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004716 if (status == PSA_SUCCESS) {
4717 memcpy(nonce, local_nonce, required_nonce_size);
Paul Elliott39dc6b82021-05-11 19:16:09 +01004718 *nonce_length = required_nonce_size;
Gilles Peskine449bd832023-01-11 14:50:10 +01004719 } else {
4720 psa_aead_abort(operation);
Ronald Croncae59092021-11-26 18:53:58 +01004721 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01004722
Gilles Peskine449bd832023-01-11 14:50:10 +01004723 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004724}
4725
4726/* Set the nonce for a multipart authenticated encryption or decryption
4727 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004728psa_status_t psa_aead_set_nonce(psa_aead_operation_t *operation,
4729 const uint8_t *nonce,
4730 size_t nonce_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004731{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004732 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4733
Gilles Peskine449bd832023-01-11 14:50:10 +01004734 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004735 status = PSA_ERROR_BAD_STATE;
4736 goto exit;
4737 }
4738
Gilles Peskine449bd832023-01-11 14:50:10 +01004739 if (operation->nonce_set) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004740 status = PSA_ERROR_BAD_STATE;
4741 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004742 }
4743
Gilles Peskine449bd832023-01-11 14:50:10 +01004744 status = psa_aead_check_nonce_length(operation->alg, nonce_length);
4745 if (status != PSA_SUCCESS) {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004746 status = PSA_ERROR_INVALID_ARGUMENT;
4747 goto exit;
Paul Elliott4ed1ed12021-09-27 18:09:28 +01004748 }
Paul Elliott1a98aca2021-05-20 18:24:07 +01004749
Gilles Peskine449bd832023-01-11 14:50:10 +01004750 status = psa_driver_wrapper_aead_set_nonce(operation, nonce,
4751 nonce_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004752
Paul Elliott39dc6b82021-05-11 19:16:09 +01004753exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004754 if (status == PSA_SUCCESS) {
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004755 operation->nonce_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004756 } else {
4757 psa_aead_abort(operation);
4758 }
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004759
Gilles Peskine449bd832023-01-11 14:50:10 +01004760 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004761}
4762
4763/* Declare the lengths of the message and additional data for multipart AEAD. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004764psa_status_t psa_aead_set_lengths(psa_aead_operation_t *operation,
4765 size_t ad_length,
4766 size_t plaintext_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004767{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004768 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4769
Gilles Peskine449bd832023-01-11 14:50:10 +01004770 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004771 status = PSA_ERROR_BAD_STATE;
4772 goto exit;
4773 }
4774
Gilles Peskine449bd832023-01-11 14:50:10 +01004775 if (operation->lengths_set || operation->ad_started ||
4776 operation->body_started) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004777 status = PSA_ERROR_BAD_STATE;
4778 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004779 }
4780
Gilles Peskine449bd832023-01-11 14:50:10 +01004781 switch (operation->alg) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004782#if defined(PSA_WANT_ALG_GCM)
4783 case PSA_ALG_GCM:
4784 /* Lengths can only be too large for GCM if size_t is bigger than 32
Gilles Peskine449bd832023-01-11 14:50:10 +01004785 * bits. Without the guard this code will generate warnings on 32bit
4786 * builds. */
Paul Elliott325d3742021-09-27 17:56:28 +01004787#if SIZE_MAX > UINT32_MAX
Gilles Peskine449bd832023-01-11 14:50:10 +01004788 if (((uint64_t) ad_length) >> 61 != 0 ||
4789 ((uint64_t) plaintext_length) > 0xFFFFFFFE0ull) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004790 status = PSA_ERROR_INVALID_ARGUMENT;
4791 goto exit;
4792 }
Paul Elliott325d3742021-09-27 17:56:28 +01004793#endif
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004794 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004795#endif /* PSA_WANT_ALG_GCM */
4796#if defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004797 case PSA_ALG_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01004798 if (ad_length > 0xFF00) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004799 status = PSA_ERROR_INVALID_ARGUMENT;
4800 goto exit;
4801 }
4802 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004803#endif /* PSA_WANT_ALG_CCM */
4804#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004805 case PSA_ALG_CHACHA20_POLY1305:
4806 /* No length restrictions for ChaChaPoly. */
4807 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004808#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004809 default:
4810 break;
4811 }
Paul Elliott325d3742021-09-27 17:56:28 +01004812
Gilles Peskine449bd832023-01-11 14:50:10 +01004813 status = psa_driver_wrapper_aead_set_lengths(operation, ad_length,
4814 plaintext_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004815
Paul Elliott39dc6b82021-05-11 19:16:09 +01004816exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004817 if (status == PSA_SUCCESS) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01004818 operation->ad_remaining = ad_length;
4819 operation->body_remaining = plaintext_length;
Paul Elliott39dc6b82021-05-11 19:16:09 +01004820 operation->lengths_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004821 } else {
4822 psa_aead_abort(operation);
Paul Elliottee4ffe02021-05-20 17:25:06 +01004823 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01004824
Gilles Peskine449bd832023-01-11 14:50:10 +01004825 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004826}
Paul Elliott3d7d52c2021-09-01 10:33:14 +01004827
4828/* Pass additional data to an active multipart AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004829psa_status_t psa_aead_update_ad(psa_aead_operation_t *operation,
4830 const uint8_t *input,
4831 size_t input_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004832{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004833 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4834
Gilles Peskine449bd832023-01-11 14:50:10 +01004835 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004836 status = PSA_ERROR_BAD_STATE;
4837 goto exit;
4838 }
4839
Gilles Peskine449bd832023-01-11 14:50:10 +01004840 if (!operation->nonce_set || operation->body_started) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004841 status = PSA_ERROR_BAD_STATE;
4842 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004843 }
4844
Gilles Peskine449bd832023-01-11 14:50:10 +01004845 if (operation->lengths_set) {
4846 if (operation->ad_remaining < input_length) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01004847 status = PSA_ERROR_INVALID_ARGUMENT;
4848 goto exit;
4849 }
4850
4851 operation->ad_remaining -= input_length;
4852 }
Paul Elliotte193ea82021-10-01 13:00:16 +01004853#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004854 else if (operation->alg == PSA_ALG_CCM) {
Paul Elliotte193ea82021-10-01 13:00:16 +01004855 status = PSA_ERROR_BAD_STATE;
4856 goto exit;
4857 }
4858#endif /* PSA_WANT_ALG_CCM */
Paul Elliottee4ffe02021-05-20 17:25:06 +01004859
Gilles Peskine449bd832023-01-11 14:50:10 +01004860 status = psa_driver_wrapper_aead_update_ad(operation, input,
4861 input_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004862
Paul Elliott39dc6b82021-05-11 19:16:09 +01004863exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004864 if (status == PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004865 operation->ad_started = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004866 } else {
4867 psa_aead_abort(operation);
4868 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01004869
Gilles Peskine449bd832023-01-11 14:50:10 +01004870 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004871}
4872
4873/* Encrypt or decrypt a message fragment in an active multipart AEAD
4874 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004875psa_status_t psa_aead_update(psa_aead_operation_t *operation,
4876 const uint8_t *input,
4877 size_t input_length,
4878 uint8_t *output,
4879 size_t output_size,
4880 size_t *output_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004881{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004882 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004883
4884 *output_length = 0;
4885
Gilles Peskine449bd832023-01-11 14:50:10 +01004886 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004887 status = PSA_ERROR_BAD_STATE;
4888 goto exit;
4889 }
4890
Gilles Peskine449bd832023-01-11 14:50:10 +01004891 if (!operation->nonce_set) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004892 status = PSA_ERROR_BAD_STATE;
4893 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004894 }
4895
Gilles Peskine449bd832023-01-11 14:50:10 +01004896 if (operation->lengths_set) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01004897 /* Additional data length was supplied, but not all the additional
4898 data was supplied.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004899 if (operation->ad_remaining != 0) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01004900 status = PSA_ERROR_INVALID_ARGUMENT;
4901 goto exit;
4902 }
4903
4904 /* Too much data provided. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004905 if (operation->body_remaining < input_length) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01004906 status = PSA_ERROR_INVALID_ARGUMENT;
4907 goto exit;
4908 }
4909
4910 operation->body_remaining -= input_length;
4911 }
Paul Elliotte193ea82021-10-01 13:00:16 +01004912#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004913 else if (operation->alg == PSA_ALG_CCM) {
Paul Elliotte193ea82021-10-01 13:00:16 +01004914 status = PSA_ERROR_BAD_STATE;
4915 goto exit;
4916 }
4917#endif /* PSA_WANT_ALG_CCM */
Paul Elliottee4ffe02021-05-20 17:25:06 +01004918
Gilles Peskine449bd832023-01-11 14:50:10 +01004919 status = psa_driver_wrapper_aead_update(operation, input, input_length,
4920 output, output_size,
4921 output_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004922
Paul Elliott39dc6b82021-05-11 19:16:09 +01004923exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004924 if (status == PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004925 operation->body_started = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004926 } else {
4927 psa_aead_abort(operation);
4928 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01004929
Gilles Peskine449bd832023-01-11 14:50:10 +01004930 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004931}
4932
Gilles Peskine449bd832023-01-11 14:50:10 +01004933static psa_status_t psa_aead_final_checks(const psa_aead_operation_t *operation)
Paul Elliottad53dcc2021-06-23 08:50:14 +01004934{
Gilles Peskine449bd832023-01-11 14:50:10 +01004935 if (operation->id == 0 || !operation->nonce_set) {
4936 return PSA_ERROR_BAD_STATE;
4937 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01004938
Gilles Peskine449bd832023-01-11 14:50:10 +01004939 if (operation->lengths_set && (operation->ad_remaining != 0 ||
4940 operation->body_remaining != 0)) {
4941 return PSA_ERROR_INVALID_ARGUMENT;
4942 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01004943
Gilles Peskine449bd832023-01-11 14:50:10 +01004944 return PSA_SUCCESS;
Paul Elliottad53dcc2021-06-23 08:50:14 +01004945}
4946
Paul Elliott302ff6b2021-04-20 18:10:30 +01004947/* Finish encrypting a message in a multipart AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004948psa_status_t psa_aead_finish(psa_aead_operation_t *operation,
4949 uint8_t *ciphertext,
4950 size_t ciphertext_size,
4951 size_t *ciphertext_length,
4952 uint8_t *tag,
4953 size_t tag_size,
4954 size_t *tag_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004955{
Paul Elliott39dc6b82021-05-11 19:16:09 +01004956 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4957
Paul Elliott302ff6b2021-04-20 18:10:30 +01004958 *ciphertext_length = 0;
Paul Elliottf88a5652021-06-22 17:53:45 +01004959 *tag_length = tag_size;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004960
Gilles Peskine449bd832023-01-11 14:50:10 +01004961 status = psa_aead_final_checks(operation);
4962 if (status != PSA_SUCCESS) {
Paul Elliottad53dcc2021-06-23 08:50:14 +01004963 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004964 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01004965
Gilles Peskine449bd832023-01-11 14:50:10 +01004966 if (!operation->is_encrypt) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004967 status = PSA_ERROR_BAD_STATE;
4968 goto exit;
4969 }
4970
Gilles Peskine449bd832023-01-11 14:50:10 +01004971 status = psa_driver_wrapper_aead_finish(operation, ciphertext,
4972 ciphertext_size,
4973 ciphertext_length,
4974 tag, tag_size, tag_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004975
Paul Elliott39dc6b82021-05-11 19:16:09 +01004976exit:
Paul Elliottdc42ca82023-02-24 18:11:59 +00004977
4978
Paul Elliottf47b0952021-05-21 18:02:33 +01004979 /* In case the operation fails and the user fails to check for failure or
Paul Elliott4c916e82021-09-19 18:34:50 +01004980 * the zero tag size, make sure the tag is set to something implausible.
4981 * Even if the operation succeeds, make sure we clear the rest of the
4982 * buffer to prevent potential leakage of anything previously placed in
4983 * the same buffer.*/
Paul Elliottdc42ca82023-02-24 18:11:59 +00004984 psa_wipe_tag_output_buffer(tag, status, tag_size, *tag_length);
Paul Elliottf47b0952021-05-21 18:02:33 +01004985
Gilles Peskine449bd832023-01-11 14:50:10 +01004986 psa_aead_abort(operation);
Paul Elliott39dc6b82021-05-11 19:16:09 +01004987
Gilles Peskine449bd832023-01-11 14:50:10 +01004988 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004989}
4990
4991/* Finish authenticating and decrypting a message in a multipart AEAD
4992 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004993psa_status_t psa_aead_verify(psa_aead_operation_t *operation,
4994 uint8_t *plaintext,
4995 size_t plaintext_size,
4996 size_t *plaintext_length,
4997 const uint8_t *tag,
4998 size_t tag_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004999{
Paul Elliott39dc6b82021-05-11 19:16:09 +01005000 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5001
Paul Elliott302ff6b2021-04-20 18:10:30 +01005002 *plaintext_length = 0;
5003
Gilles Peskine449bd832023-01-11 14:50:10 +01005004 status = psa_aead_final_checks(operation);
5005 if (status != PSA_SUCCESS) {
Paul Elliottad53dcc2021-06-23 08:50:14 +01005006 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005007 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01005008
Gilles Peskine449bd832023-01-11 14:50:10 +01005009 if (operation->is_encrypt) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005010 status = PSA_ERROR_BAD_STATE;
5011 goto exit;
5012 }
5013
Gilles Peskine449bd832023-01-11 14:50:10 +01005014 status = psa_driver_wrapper_aead_verify(operation, plaintext,
5015 plaintext_size,
5016 plaintext_length,
5017 tag, tag_length);
Paul Elliott39dc6b82021-05-11 19:16:09 +01005018
5019exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005020 psa_aead_abort(operation);
Paul Elliott39dc6b82021-05-11 19:16:09 +01005021
Gilles Peskine449bd832023-01-11 14:50:10 +01005022 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005023}
5024
5025/* Abort an AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005026psa_status_t psa_aead_abort(psa_aead_operation_t *operation)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005027{
5028 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5029
Gilles Peskine449bd832023-01-11 14:50:10 +01005030 if (operation->id == 0) {
Paul Elliott302ff6b2021-04-20 18:10:30 +01005031 /* The object has (apparently) been initialized but it is not (yet)
5032 * in use. It's ok to call abort on such an object, and there's
5033 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005034 return PSA_SUCCESS;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005035 }
5036
Gilles Peskine449bd832023-01-11 14:50:10 +01005037 status = psa_driver_wrapper_aead_abort(operation);
Paul Elliott302ff6b2021-04-20 18:10:30 +01005038
Gilles Peskine449bd832023-01-11 14:50:10 +01005039 memset(operation, 0, sizeof(*operation));
Paul Elliott302ff6b2021-04-20 18:10:30 +01005040
Gilles Peskine449bd832023-01-11 14:50:10 +01005041 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005042}
5043
Gilles Peskinee59236f2018-01-27 23:32:46 +01005044/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02005045/* Generators */
5046/****************************************************************/
5047
Przemek Stekiel69c46792022-06-10 12:59:51 +02005048#if defined(BUILTIN_ALG_ANY_HKDF) || \
John Durkop07cc04a2020-11-16 22:08:34 -08005049 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005050 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) || \
Kusumit Ghoderaoaf0b5342023-05-03 11:58:46 +05305051 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS) || \
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305052 defined(PSA_HAVE_SOFT_PBKDF2)
John Durkop07cc04a2020-11-16 22:08:34 -08005053#define AT_LEAST_ONE_BUILTIN_KDF
Steven Cooreman094a77e2021-05-06 17:58:36 +02005054#endif /* At least one builtin KDF */
5055
Przemek Stekiel69c46792022-06-10 12:59:51 +02005056#if defined(BUILTIN_ALG_ANY_HKDF) || \
Steven Cooreman094a77e2021-05-06 17:58:36 +02005057 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5058 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
5059static psa_status_t psa_key_derivation_start_hmac(
5060 psa_mac_operation_t *operation,
5061 psa_algorithm_t hash_alg,
5062 const uint8_t *hmac_key,
Gilles Peskine449bd832023-01-11 14:50:10 +01005063 size_t hmac_key_length)
Steven Cooreman094a77e2021-05-06 17:58:36 +02005064{
5065 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5066 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01005067 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
5068 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(hmac_key_length));
5069 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_HASH);
Steven Cooreman094a77e2021-05-06 17:58:36 +02005070
Steven Cooreman72f736a2021-05-07 14:14:37 +02005071 operation->is_sign = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005072 operation->mac_size = PSA_HASH_LENGTH(hash_alg);
Steven Cooreman72f736a2021-05-07 14:14:37 +02005073
Gilles Peskine449bd832023-01-11 14:50:10 +01005074 status = psa_driver_wrapper_mac_sign_setup(operation,
5075 &attributes,
5076 hmac_key, hmac_key_length,
5077 PSA_ALG_HMAC(hash_alg));
Steven Cooreman094a77e2021-05-06 17:58:36 +02005078
Gilles Peskine449bd832023-01-11 14:50:10 +01005079 psa_reset_key_attributes(&attributes);
5080 return status;
Steven Cooreman094a77e2021-05-06 17:58:36 +02005081}
5082#endif /* KDF algorithms reliant on HMAC */
John Durkop07cc04a2020-11-16 22:08:34 -08005083
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005084#define HKDF_STATE_INIT 0 /* no input yet */
5085#define HKDF_STATE_STARTED 1 /* got salt */
5086#define HKDF_STATE_KEYED 2 /* got key */
5087#define HKDF_STATE_OUTPUT 3 /* output started */
5088
Gilles Peskinecbe66502019-05-16 16:59:18 +02005089static psa_algorithm_t psa_key_derivation_get_kdf_alg(
Gilles Peskine449bd832023-01-11 14:50:10 +01005090 const psa_key_derivation_operation_t *operation)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005091{
Gilles Peskine449bd832023-01-11 14:50:10 +01005092 if (PSA_ALG_IS_KEY_AGREEMENT(operation->alg)) {
5093 return PSA_ALG_KEY_AGREEMENT_GET_KDF(operation->alg);
5094 } else {
5095 return operation->alg;
5096 }
Gilles Peskine969c5d62019-01-16 15:53:06 +01005097}
5098
Gilles Peskine449bd832023-01-11 14:50:10 +01005099psa_status_t psa_key_derivation_abort(psa_key_derivation_operation_t *operation)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005100{
5101 psa_status_t status = PSA_SUCCESS;
Gilles Peskine449bd832023-01-11 14:50:10 +01005102 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
5103 if (kdf_alg == 0) {
Gilles Peskineeab56e42018-07-12 17:12:33 +02005104 /* The object has (apparently) been initialized but it is not
5105 * in use. It's ok to call abort on such an object, and there's
5106 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005107 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02005108#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01005109 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
5110 mbedtls_free(operation->ctx.hkdf.info);
5111 status = psa_mac_abort(&operation->ctx.hkdf.hmac);
5112 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02005113#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08005114#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5115 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005116 if (PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
5117 /* TLS-1.2 PSK-to-MS KDF uses the same core as TLS-1.2 PRF */
5118 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
5119 if (operation->ctx.tls12_prf.secret != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005120 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.secret,
Gilles Peskine449bd832023-01-11 14:50:10 +01005121 operation->ctx.tls12_prf.secret_length);
Steven Cooremana6df6042021-04-29 19:32:25 +02005122 }
5123
Gilles Peskine449bd832023-01-11 14:50:10 +01005124 if (operation->ctx.tls12_prf.seed != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005125 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.seed,
Gilles Peskine449bd832023-01-11 14:50:10 +01005126 operation->ctx.tls12_prf.seed_length);
Janos Follath6a1d2622019-06-11 10:37:28 +01005127 }
5128
Gilles Peskine449bd832023-01-11 14:50:10 +01005129 if (operation->ctx.tls12_prf.label != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005130 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.label,
Gilles Peskine449bd832023-01-11 14:50:10 +01005131 operation->ctx.tls12_prf.label_length);
Janos Follath6a1d2622019-06-11 10:37:28 +01005132 }
Przemek Stekiel6c764412022-11-22 14:05:12 +01005133#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005134 if (operation->ctx.tls12_prf.other_secret != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005135 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.other_secret,
Gilles Peskine449bd832023-01-11 14:50:10 +01005136 operation->ctx.tls12_prf.other_secret_length);
Przemek Stekiele3ee2212022-04-07 14:29:56 +02005137 }
Przemek Stekiel6c764412022-11-22 14:05:12 +01005138#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Steven Cooremana6df6042021-04-29 19:32:25 +02005139 status = PSA_SUCCESS;
Janos Follath6a1d2622019-06-11 10:37:28 +01005140
5141 /* We leave the fields Ai and output_block to be erased safely by the
5142 * mbedtls_platform_zeroize() in the end of this function. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005143 } else
John Durkop07cc04a2020-11-16 22:08:34 -08005144#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
5145 * defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005146#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005147 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
5148 mbedtls_platform_zeroize(operation->ctx.tls12_ecjpake_to_pms.data,
5149 sizeof(operation->ctx.tls12_ecjpake_to_pms.data));
5150 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005151#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS) */
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305152#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05305153 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305154 if (operation->ctx.pbkdf2.salt != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005155 mbedtls_zeroize_and_free(operation->ctx.pbkdf2.salt,
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305156 operation->ctx.pbkdf2.salt_length);
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305157 }
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305158
5159 status = PSA_SUCCESS;
5160 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305161#endif /* defined(PSA_HAVE_SOFT_PBKDF2) */
Gilles Peskineeab56e42018-07-12 17:12:33 +02005162 {
5163 status = PSA_ERROR_BAD_STATE;
5164 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005165 mbedtls_platform_zeroize(operation, sizeof(*operation));
5166 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005167}
5168
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005169psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskine449bd832023-01-11 14:50:10 +01005170 size_t *capacity)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005171{
Gilles Peskine449bd832023-01-11 14:50:10 +01005172 if (operation->alg == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005173 /* This is a blank key derivation operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005174 return PSA_ERROR_BAD_STATE;
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005175 }
5176
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005177 *capacity = operation->capacity;
Gilles Peskine449bd832023-01-11 14:50:10 +01005178 return PSA_SUCCESS;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005179}
5180
Gilles Peskine449bd832023-01-11 14:50:10 +01005181psa_status_t psa_key_derivation_set_capacity(psa_key_derivation_operation_t *operation,
5182 size_t capacity)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005183{
Gilles Peskine449bd832023-01-11 14:50:10 +01005184 if (operation->alg == 0) {
5185 return PSA_ERROR_BAD_STATE;
5186 }
5187 if (capacity > operation->capacity) {
5188 return PSA_ERROR_INVALID_ARGUMENT;
5189 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005190 operation->capacity = capacity;
Gilles Peskine449bd832023-01-11 14:50:10 +01005191 return PSA_SUCCESS;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005192}
5193
Przemek Stekiel69c46792022-06-10 12:59:51 +02005194#if defined(BUILTIN_ALG_ANY_HKDF)
Przemek Stekiel03d948c2022-05-19 11:45:20 +02005195/* Read some bytes from an HKDF-based operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005196static psa_status_t psa_key_derivation_hkdf_read(psa_hkdf_key_derivation_t *hkdf,
5197 psa_algorithm_t kdf_alg,
5198 uint8_t *output,
5199 size_t output_length)
Gilles Peskinebef7f142018-07-12 17:22:21 +02005200{
Gilles Peskine449bd832023-01-11 14:50:10 +01005201 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
5202 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Steven Cooremand1ed1d92021-04-29 19:11:25 +02005203 size_t hmac_output_length;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005204 psa_status_t status;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005205#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01005206 const uint8_t last_block = PSA_ALG_IS_HKDF_EXTRACT(kdf_alg) ? 0 : 0xff;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005207#else
5208 const uint8_t last_block = 0xff;
5209#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskinebef7f142018-07-12 17:22:21 +02005210
Gilles Peskine449bd832023-01-11 14:50:10 +01005211 if (hkdf->state < HKDF_STATE_KEYED ||
5212 (!hkdf->info_set
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005213#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01005214 && !PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005215#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01005216 )) {
5217 return PSA_ERROR_BAD_STATE;
5218 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005219 hkdf->state = HKDF_STATE_OUTPUT;
5220
Gilles Peskine449bd832023-01-11 14:50:10 +01005221 while (output_length != 0) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005222 /* Copy what remains of the current block */
5223 uint8_t n = hash_length - hkdf->offset_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005224 if (n > output_length) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005225 n = (uint8_t) output_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01005226 }
5227 memcpy(output, hkdf->output_block + hkdf->offset_in_block, n);
Gilles Peskinebef7f142018-07-12 17:22:21 +02005228 output += n;
5229 output_length -= n;
5230 hkdf->offset_in_block += n;
Gilles Peskine449bd832023-01-11 14:50:10 +01005231 if (output_length == 0) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005232 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01005233 }
Przemek Stekiel03d948c2022-05-19 11:45:20 +02005234 /* We can't be wanting more output after the last block, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005235 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005236 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02005237 * object was corrupted or if this function is called directly
5238 * inside the library. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005239 if (hkdf->block_number == last_block) {
5240 return PSA_ERROR_BAD_STATE;
5241 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02005242
5243 /* We need a new block */
5244 ++hkdf->block_number;
5245 hkdf->offset_in_block = 0;
Steven Cooremand1ed1d92021-04-29 19:11:25 +02005246
Gilles Peskine449bd832023-01-11 14:50:10 +01005247 status = psa_key_derivation_start_hmac(&hkdf->hmac,
5248 hash_alg,
5249 hkdf->prk,
5250 hash_length);
5251 if (status != PSA_SUCCESS) {
5252 return status;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005253 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005254
5255 if (hkdf->block_number != 1) {
5256 status = psa_mac_update(&hkdf->hmac,
5257 hkdf->output_block,
5258 hash_length);
5259 if (status != PSA_SUCCESS) {
5260 return status;
5261 }
5262 }
5263 status = psa_mac_update(&hkdf->hmac,
5264 hkdf->info,
5265 hkdf->info_length);
5266 if (status != PSA_SUCCESS) {
5267 return status;
5268 }
5269 status = psa_mac_update(&hkdf->hmac,
5270 &hkdf->block_number, 1);
5271 if (status != PSA_SUCCESS) {
5272 return status;
5273 }
5274 status = psa_mac_sign_finish(&hkdf->hmac,
5275 hkdf->output_block,
5276 sizeof(hkdf->output_block),
5277 &hmac_output_length);
5278 if (status != PSA_SUCCESS) {
5279 return status;
5280 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02005281 }
5282
Gilles Peskine449bd832023-01-11 14:50:10 +01005283 return PSA_SUCCESS;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005284}
Przemek Stekiel69c46792022-06-10 12:59:51 +02005285#endif /* BUILTIN_ALG_ANY_HKDF */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005286
John Durkop07cc04a2020-11-16 22:08:34 -08005287#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5288 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follath7742fee2019-06-17 12:58:10 +01005289static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
5290 psa_tls12_prf_key_derivation_t *tls12_prf,
Gilles Peskine449bd832023-01-11 14:50:10 +01005291 psa_algorithm_t alg)
Janos Follath7742fee2019-06-17 12:58:10 +01005292{
Gilles Peskine449bd832023-01-11 14:50:10 +01005293 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(alg);
5294 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Steven Cooremana6df6042021-04-29 19:32:25 +02005295 psa_mac_operation_t hmac = PSA_MAC_OPERATION_INIT;
5296 size_t hmac_output_length;
Janos Follathea29bfb2019-06-19 12:21:20 +01005297 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005298
Janos Follath7742fee2019-06-17 12:58:10 +01005299 /* We can't be wanting more output after block 0xff, otherwise
5300 * the capacity check in psa_key_derivation_output_bytes() would have
5301 * prevented this call. It could happen only if the operation
5302 * object was corrupted or if this function is called directly
5303 * inside the library. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005304 if (tls12_prf->block_number == 0xff) {
5305 return PSA_ERROR_CORRUPTION_DETECTED;
5306 }
Janos Follath7742fee2019-06-17 12:58:10 +01005307
5308 /* We need a new block */
5309 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01005310 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01005311
5312 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
5313 *
5314 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
5315 *
5316 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
5317 * HMAC_hash(secret, A(2) + seed) +
5318 * HMAC_hash(secret, A(3) + seed) + ...
5319 *
5320 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01005321 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01005322 *
Janos Follathea29bfb2019-06-19 12:21:20 +01005323 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01005324 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01005325 * is currently extracted as `output_block` and where i is
5326 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01005327 */
5328
Gilles Peskine449bd832023-01-11 14:50:10 +01005329 status = psa_key_derivation_start_hmac(&hmac,
5330 hash_alg,
5331 tls12_prf->secret,
5332 tls12_prf->secret_length);
5333 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005334 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005335 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005336
5337 /* Calculate A(i) where i = tls12_prf->block_number. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005338 if (tls12_prf->block_number == 1) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005339 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
5340 * the variable seed and in this instance means it in the context of the
5341 * P_hash function, where seed = label + seed.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01005342 status = psa_mac_update(&hmac,
5343 tls12_prf->label,
5344 tls12_prf->label_length);
5345 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005346 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005347 }
5348 status = psa_mac_update(&hmac,
5349 tls12_prf->seed,
5350 tls12_prf->seed_length);
5351 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005352 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005353 }
5354 } else {
Janos Follathea29bfb2019-06-19 12:21:20 +01005355 /* A(i) = HMAC_hash(secret, A(i-1)) */
Gilles Peskine449bd832023-01-11 14:50:10 +01005356 status = psa_mac_update(&hmac, tls12_prf->Ai, hash_length);
5357 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005358 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005359 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005360 }
5361
Gilles Peskine449bd832023-01-11 14:50:10 +01005362 status = psa_mac_sign_finish(&hmac,
5363 tls12_prf->Ai, hash_length,
5364 &hmac_output_length);
5365 if (hmac_output_length != hash_length) {
Steven Cooremana6df6042021-04-29 19:32:25 +02005366 status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01005367 }
5368 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005369 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005370 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005371
5372 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
Gilles Peskine449bd832023-01-11 14:50:10 +01005373 status = psa_key_derivation_start_hmac(&hmac,
5374 hash_alg,
5375 tls12_prf->secret,
5376 tls12_prf->secret_length);
5377 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005378 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005379 }
5380 status = psa_mac_update(&hmac, tls12_prf->Ai, hash_length);
5381 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005382 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005383 }
5384 status = psa_mac_update(&hmac, tls12_prf->label, tls12_prf->label_length);
5385 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005386 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005387 }
5388 status = psa_mac_update(&hmac, tls12_prf->seed, tls12_prf->seed_length);
5389 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005390 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005391 }
5392 status = psa_mac_sign_finish(&hmac,
5393 tls12_prf->output_block, hash_length,
5394 &hmac_output_length);
5395 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005396 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005397 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005398
Janos Follath7742fee2019-06-17 12:58:10 +01005399
5400cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01005401 cleanup_status = psa_mac_abort(&hmac);
5402 if (status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005403 status = cleanup_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01005404 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005405
Gilles Peskine449bd832023-01-11 14:50:10 +01005406 return status;
Janos Follath7742fee2019-06-17 12:58:10 +01005407}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005408
Janos Follath844eb0e2019-06-19 12:10:49 +01005409static psa_status_t psa_key_derivation_tls12_prf_read(
5410 psa_tls12_prf_key_derivation_t *tls12_prf,
5411 psa_algorithm_t alg,
5412 uint8_t *output,
Gilles Peskine449bd832023-01-11 14:50:10 +01005413 size_t output_length)
Janos Follath844eb0e2019-06-19 12:10:49 +01005414{
Gilles Peskine449bd832023-01-11 14:50:10 +01005415 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH(alg);
5416 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Janos Follath844eb0e2019-06-19 12:10:49 +01005417 psa_status_t status;
5418 uint8_t offset, length;
5419
Gilles Peskine449bd832023-01-11 14:50:10 +01005420 switch (tls12_prf->state) {
Gilles Peskineb1edaec2021-06-11 22:41:46 +02005421 case PSA_TLS12_PRF_STATE_LABEL_SET:
5422 tls12_prf->state = PSA_TLS12_PRF_STATE_OUTPUT;
5423 break;
5424 case PSA_TLS12_PRF_STATE_OUTPUT:
5425 break;
5426 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005427 return PSA_ERROR_BAD_STATE;
Gilles Peskineb1edaec2021-06-11 22:41:46 +02005428 }
5429
Gilles Peskine449bd832023-01-11 14:50:10 +01005430 while (output_length != 0) {
Janos Follath844eb0e2019-06-19 12:10:49 +01005431 /* Check if we have fully processed the current block. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005432 if (tls12_prf->left_in_block == 0) {
5433 status = psa_key_derivation_tls12_prf_generate_next_block(tls12_prf,
5434 alg);
5435 if (status != PSA_SUCCESS) {
5436 return status;
5437 }
Janos Follath844eb0e2019-06-19 12:10:49 +01005438
5439 continue;
5440 }
5441
Gilles Peskine449bd832023-01-11 14:50:10 +01005442 if (tls12_prf->left_in_block > output_length) {
Janos Follath844eb0e2019-06-19 12:10:49 +01005443 length = (uint8_t) output_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01005444 } else {
Janos Follath844eb0e2019-06-19 12:10:49 +01005445 length = tls12_prf->left_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005446 }
Janos Follath844eb0e2019-06-19 12:10:49 +01005447
5448 offset = hash_length - tls12_prf->left_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005449 memcpy(output, tls12_prf->output_block + offset, length);
Janos Follath844eb0e2019-06-19 12:10:49 +01005450 output += length;
5451 output_length -= length;
5452 tls12_prf->left_in_block -= length;
5453 }
5454
Gilles Peskine449bd832023-01-11 14:50:10 +01005455 return PSA_SUCCESS;
Janos Follath844eb0e2019-06-19 12:10:49 +01005456}
John Durkop07cc04a2020-11-16 22:08:34 -08005457#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
5458 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskinebef7f142018-07-12 17:22:21 +02005459
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005460#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
5461static psa_status_t psa_key_derivation_tls12_ecjpake_to_pms_read(
5462 psa_tls12_ecjpake_to_pms_t *ecjpake,
5463 uint8_t *output,
Gilles Peskine449bd832023-01-11 14:50:10 +01005464 size_t output_length)
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005465{
5466 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Andrzej Kurek5603efd2022-09-26 10:49:16 -04005467 size_t output_size = 0;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005468
Gilles Peskine449bd832023-01-11 14:50:10 +01005469 if (output_length != 32) {
5470 return PSA_ERROR_INVALID_ARGUMENT;
5471 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005472
Gilles Peskine449bd832023-01-11 14:50:10 +01005473 status = psa_hash_compute(PSA_ALG_SHA_256, ecjpake->data,
5474 PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE, output, output_length,
5475 &output_size);
5476 if (status != PSA_SUCCESS) {
5477 return status;
5478 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005479
Gilles Peskine449bd832023-01-11 14:50:10 +01005480 if (output_size != output_length) {
5481 return PSA_ERROR_GENERIC_ERROR;
5482 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005483
Gilles Peskine449bd832023-01-11 14:50:10 +01005484 return PSA_SUCCESS;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005485}
5486#endif
5487
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305488#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305489static psa_status_t psa_key_derivation_pbkdf2_generate_block(
5490 psa_pbkdf2_key_derivation_t *pbkdf2,
5491 psa_algorithm_t prf_alg,
5492 uint8_t prf_output_length,
5493 psa_key_attributes_t *attributes)
5494{
5495 psa_status_t status;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305496 psa_mac_operation_t mac_operation = PSA_MAC_OPERATION_INIT;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305497 size_t mac_output_length;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305498 uint8_t U_i[PSA_MAC_MAX_SIZE];
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305499 uint8_t *U_accumulator = pbkdf2->output_block;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305500 uint64_t i;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305501 uint8_t block_counter[4];
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305502
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305503 mac_operation.is_sign = 1;
5504 mac_operation.mac_size = prf_output_length;
5505 MBEDTLS_PUT_UINT32_BE(pbkdf2->block_number, block_counter, 0);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305506
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305507 status = psa_driver_wrapper_mac_sign_setup(&mac_operation,
5508 attributes,
5509 pbkdf2->password,
5510 pbkdf2->password_length,
5511 prf_alg);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305512 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305513 goto cleanup;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305514 }
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305515 status = psa_mac_update(&mac_operation, pbkdf2->salt, pbkdf2->salt_length);
5516 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305517 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305518 }
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305519 status = psa_mac_update(&mac_operation, block_counter, sizeof(block_counter));
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305520 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305521 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305522 }
5523 status = psa_mac_sign_finish(&mac_operation, U_i, sizeof(U_i),
5524 &mac_output_length);
5525 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305526 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305527 }
5528
5529 if (mac_output_length != prf_output_length) {
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305530 status = PSA_ERROR_CORRUPTION_DETECTED;
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305531 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305532 }
5533
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305534 memcpy(U_accumulator, U_i, prf_output_length);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305535
5536 for (i = 1; i < pbkdf2->input_cost; i++) {
Kusumit Ghoderao4536bb62023-06-22 15:42:59 +05305537 /* We are passing prf_output_length as mac_size because the driver
5538 * function directly sets mac_output_length as mac_size upon success.
Kusumit Ghoderao5f3345a2023-07-27 21:21:38 +05305539 * See https://github.com/Mbed-TLS/mbedtls/issues/7801 */
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305540 status = psa_driver_wrapper_mac_compute(attributes,
5541 pbkdf2->password,
5542 pbkdf2->password_length,
5543 prf_alg, U_i, prf_output_length,
Kusumit Ghoderao4536bb62023-06-22 15:42:59 +05305544 U_i, prf_output_length,
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305545 &mac_output_length);
5546 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305547 goto cleanup;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305548 }
5549
Kusumit Ghoderao109ee3d2023-06-08 16:36:45 +05305550 mbedtls_xor(U_accumulator, U_accumulator, U_i, prf_output_length);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305551 }
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305552
5553cleanup:
5554 /* Zeroise buffers to clear sensitive data from memory. */
5555 mbedtls_platform_zeroize(U_i, PSA_MAC_MAX_SIZE);
5556 return status;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305557}
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05305558
5559static psa_status_t psa_key_derivation_pbkdf2_read(
5560 psa_pbkdf2_key_derivation_t *pbkdf2,
5561 psa_algorithm_t kdf_alg,
5562 uint8_t *output,
5563 size_t output_length)
5564{
5565 psa_status_t status;
5566 psa_algorithm_t prf_alg;
5567 uint8_t prf_output_length;
5568 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
5569 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(pbkdf2->password_length));
5570 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
5571
5572 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
5573 prf_alg = PSA_ALG_HMAC(PSA_ALG_PBKDF2_HMAC_GET_HASH(kdf_alg));
5574 prf_output_length = PSA_HASH_LENGTH(prf_alg);
5575 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
Kusumit Ghoderaoa2520a52023-06-22 15:42:19 +05305576 } else if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
5577 prf_alg = PSA_ALG_CMAC;
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05305578 prf_output_length = PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC);
Kusumit Ghoderaoa2520a52023-06-22 15:42:19 +05305579 psa_set_key_type(&attributes, PSA_KEY_TYPE_AES);
Kusumit Ghoderaod9ec1af2023-06-08 20:19:51 +05305580 } else {
5581 return PSA_ERROR_INVALID_ARGUMENT;
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05305582 }
5583
5584 switch (pbkdf2->state) {
5585 case PSA_PBKDF2_STATE_PASSWORD_SET:
5586 /* Initially we need a new block so bytes_used is equal to block size*/
5587 pbkdf2->bytes_used = prf_output_length;
5588 pbkdf2->state = PSA_PBKDF2_STATE_OUTPUT;
5589 break;
5590 case PSA_PBKDF2_STATE_OUTPUT:
5591 break;
5592 default:
5593 return PSA_ERROR_BAD_STATE;
5594 }
5595
5596 while (output_length != 0) {
5597 uint8_t n = prf_output_length - pbkdf2->bytes_used;
5598 if (n > output_length) {
5599 n = (uint8_t) output_length;
5600 }
5601 memcpy(output, pbkdf2->output_block + pbkdf2->bytes_used, n);
5602 output += n;
5603 output_length -= n;
5604 pbkdf2->bytes_used += n;
5605
5606 if (output_length == 0) {
5607 break;
5608 }
5609
5610 /* We need a new block */
5611 pbkdf2->bytes_used = 0;
5612 pbkdf2->block_number++;
5613
5614 status = psa_key_derivation_pbkdf2_generate_block(pbkdf2, prf_alg,
5615 prf_output_length,
5616 &attributes);
5617 if (status != PSA_SUCCESS) {
5618 return status;
5619 }
5620 }
5621
5622 return PSA_SUCCESS;
5623}
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305624#endif /* PSA_HAVE_SOFT_PBKDF2 */
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305625
Janos Follath6c6c8fc2019-06-17 12:38:20 +01005626psa_status_t psa_key_derivation_output_bytes(
5627 psa_key_derivation_operation_t *operation,
5628 uint8_t *output,
Gilles Peskine449bd832023-01-11 14:50:10 +01005629 size_t output_length)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005630{
5631 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01005632 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
Gilles Peskineeab56e42018-07-12 17:12:33 +02005633
Gilles Peskine449bd832023-01-11 14:50:10 +01005634 if (operation->alg == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005635 /* This is a blank operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005636 return PSA_ERROR_BAD_STATE;
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005637 }
5638
Gilles Peskine449bd832023-01-11 14:50:10 +01005639 if (output_length > operation->capacity) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005640 operation->capacity = 0;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005641 /* Go through the error path to wipe all confidential data now
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005642 * that the operation object is useless. */
David Saadab4ecc272019-02-14 13:48:10 +02005643 status = PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005644 goto exit;
5645 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005646 if (output_length == 0 && operation->capacity == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005647 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005648 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02005649 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
5650 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005651 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02005652 * output_length > 0. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005653 return PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005654 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005655 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005656
Przemek Stekiel69c46792022-06-10 12:59:51 +02005657#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01005658 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
5659 status = psa_key_derivation_hkdf_read(&operation->ctx.hkdf, kdf_alg,
5660 output, output_length);
5661 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02005662#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08005663#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5664 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005665 if (PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
5666 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
5667 status = psa_key_derivation_tls12_prf_read(&operation->ctx.tls12_prf,
5668 kdf_alg, output,
5669 output_length);
5670 } else
John Durkop07cc04a2020-11-16 22:08:34 -08005671#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
5672 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005673#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005674 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005675 status = psa_key_derivation_tls12_ecjpake_to_pms_read(
Gilles Peskine449bd832023-01-11 14:50:10 +01005676 &operation->ctx.tls12_ecjpake_to_pms, output, output_length);
5677 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005678#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305679#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05305680 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05305681 status = psa_key_derivation_pbkdf2_read(&operation->ctx.pbkdf2, kdf_alg,
5682 output, output_length);
Kusumit Ghoderao056f0c52023-05-03 15:58:34 +05305683 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305684#endif /* PSA_HAVE_SOFT_PBKDF2 */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005685
Gilles Peskineeab56e42018-07-12 17:12:33 +02005686 {
Steven Cooreman74afe472021-02-10 17:19:22 +01005687 (void) kdf_alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01005688 return PSA_ERROR_BAD_STATE;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005689 }
5690
5691exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005692 if (status != PSA_SUCCESS) {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005693 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005694 * This allows us to differentiate between exhausted operations and
5695 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
5696 * operations. */
5697 psa_algorithm_t alg = operation->alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01005698 psa_key_derivation_abort(operation);
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005699 operation->alg = alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01005700 memset(output, '!', output_length);
Gilles Peskineeab56e42018-07-12 17:12:33 +02005701 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005702 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005703}
5704
David Brown7807bf72021-02-09 16:28:23 -07005705#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01005706static void psa_des_set_key_parity(uint8_t *data, size_t data_size)
Gilles Peskine08542d82018-07-19 17:05:42 +02005707{
Gilles Peskine449bd832023-01-11 14:50:10 +01005708 if (data_size >= 8) {
5709 mbedtls_des_key_set_parity(data);
5710 }
5711 if (data_size >= 16) {
5712 mbedtls_des_key_set_parity(data + 8);
5713 }
5714 if (data_size >= 24) {
5715 mbedtls_des_key_set_parity(data + 16);
5716 }
Gilles Peskine08542d82018-07-19 17:05:42 +02005717}
David Brown7807bf72021-02-09 16:28:23 -07005718#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine08542d82018-07-19 17:05:42 +02005719
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005720/*
Gilles Peskine449bd832023-01-11 14:50:10 +01005721 * ECC keys on a Weierstrass elliptic curve require the generation
5722 * of a private key which is an integer
5723 * in the range [1, N - 1], where N is the boundary of the private key domain:
5724 * N is the prime p for Diffie-Hellman, or the order of the
5725 * curve’s base point for ECC.
5726 *
5727 * Let m be the bit size of N, such that 2^m > N >= 2^(m-1).
5728 * This function generates the private key using the following process:
5729 *
5730 * 1. Draw a byte string of length ceiling(m/8) bytes.
5731 * 2. If m is not a multiple of 8, set the most significant
5732 * (8 * ceiling(m/8) - m) bits of the first byte in the string to zero.
5733 * 3. Convert the string to integer k by decoding it as a big-endian byte string.
5734 * 4. If k > N - 2, discard the result and return to step 1.
5735 * 5. Output k + 1 as the private key.
5736 *
5737 * This method allows compliance to NIST standards, specifically the methods titled
5738 * Key-Pair Generation by Testing Candidates in the following publications:
5739 * - NIST Special Publication 800-56A: Recommendation for Pair-Wise Key-Establishment
5740 * Schemes Using Discrete Logarithm Cryptography [SP800-56A] §5.6.1.1.4 for
5741 * Diffie-Hellman keys.
5742 *
5743 * - [SP800-56A] §5.6.1.2.2 or FIPS Publication 186-4: Digital Signature
5744 * Standard (DSS) [FIPS186-4] §B.4.2 for elliptic curve keys.
5745 *
5746 * Note: Function allocates memory for *data buffer, so given *data should be
5747 * always NULL.
5748 */
Valerio Setti86587ab2023-06-27 13:09:30 +02005749#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE)
5750#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE)
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01005751static psa_status_t psa_generate_derived_ecc_key_weierstrass_helper(
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005752 psa_key_slot_t *slot,
5753 size_t bits,
5754 psa_key_derivation_operation_t *operation,
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005755 uint8_t **data
5756 )
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005757{
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005758 unsigned key_out_of_range = 1;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005759 mbedtls_mpi k;
5760 mbedtls_mpi diff_N_2;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005761 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Przemek Stekiela81aed22022-03-01 15:13:30 +01005762 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01005763 size_t m;
5764 size_t m_bytes;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005765
Gilles Peskine449bd832023-01-11 14:50:10 +01005766 mbedtls_mpi_init(&k);
5767 mbedtls_mpi_init(&diff_N_2);
Przemyslaw Stekiel1dfd1222021-11-18 13:35:00 +01005768
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005769 psa_ecc_family_t curve = PSA_KEY_TYPE_ECC_GET_FAMILY(
Gilles Peskine449bd832023-01-11 14:50:10 +01005770 slot->attr.type);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005771 mbedtls_ecp_group_id grp_id =
Valerio Settid36c3132023-12-21 14:03:51 +01005772 mbedtls_ecc_group_from_psa(curve, bits);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005773
Gilles Peskine449bd832023-01-11 14:50:10 +01005774 if (grp_id == MBEDTLS_ECP_DP_NONE) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005775 ret = MBEDTLS_ERR_ASN1_INVALID_DATA;
Przemyslaw Stekiel871a3362021-12-02 08:46:39 +01005776 goto cleanup;
5777 }
5778
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005779 mbedtls_ecp_group ecp_group;
Gilles Peskine449bd832023-01-11 14:50:10 +01005780 mbedtls_ecp_group_init(&ecp_group);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005781
Gilles Peskine449bd832023-01-11 14:50:10 +01005782 MBEDTLS_MPI_CHK(mbedtls_ecp_group_load(&ecp_group, grp_id));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005783
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005784 /* N is the boundary of the private key domain (ecp_group.N). */
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005785 /* Let m be the bit size of N. */
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01005786 m = ecp_group.nbits;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005787
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01005788 m_bytes = PSA_BITS_TO_BYTES(m);
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005789
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005790 /* Calculate N - 2 - it will be needed later. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005791 MBEDTLS_MPI_CHK(mbedtls_mpi_sub_int(&diff_N_2, &ecp_group.N, 2));
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005792
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005793 /* Note: This function is always called with *data == NULL and it
5794 * allocates memory for the data buffer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005795 *data = mbedtls_calloc(1, m_bytes);
5796 if (*data == NULL) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005797 ret = MBEDTLS_ERR_ASN1_ALLOC_FAILED;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005798 goto cleanup;
5799 }
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005800
Gilles Peskine449bd832023-01-11 14:50:10 +01005801 while (key_out_of_range) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005802 /* 1. Draw a byte string of length ceiling(m/8) bytes. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005803 if ((status = psa_key_derivation_output_bytes(operation, *data, m_bytes)) != 0) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005804 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005805 }
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005806
5807 /* 2. If m is not a multiple of 8 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005808 if (m % 8 != 0) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005809 /* Set the most significant
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005810 * (8 * ceiling(m/8) - m) bits of the first byte in
5811 * the string to zero.
5812 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005813 uint8_t clear_bit_mask = (1 << (m % 8)) - 1;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005814 (*data)[0] &= clear_bit_mask;
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005815 }
5816
5817 /* 3. Convert the string to integer k by decoding it as a
Gilles Peskine449bd832023-01-11 14:50:10 +01005818 * big-endian byte string.
5819 */
5820 MBEDTLS_MPI_CHK(mbedtls_mpi_read_binary(&k, *data, m_bytes));
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005821
5822 /* 4. If k > N - 2, discard the result and return to step 1.
Gilles Peskine449bd832023-01-11 14:50:10 +01005823 * Result of comparison is returned. When it indicates error
5824 * then this function is called again.
5825 */
5826 MBEDTLS_MPI_CHK(mbedtls_mpi_lt_mpi_ct(&diff_N_2, &k, &key_out_of_range));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005827 }
5828
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005829 /* 5. Output k + 1 as the private key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005830 MBEDTLS_MPI_CHK(mbedtls_mpi_add_int(&k, &k, 1));
5831 MBEDTLS_MPI_CHK(mbedtls_mpi_write_binary(&k, *data, m_bytes));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005832cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01005833 if (ret != 0) {
5834 status = mbedtls_to_psa_error(ret);
5835 }
5836 if (status != PSA_SUCCESS) {
5837 mbedtls_free(*data);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005838 *data = NULL;
5839 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005840 mbedtls_mpi_free(&k);
5841 mbedtls_mpi_free(&diff_N_2);
5842 return status;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005843}
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005844
5845/* ECC keys on a Montgomery elliptic curve draws a byte string whose length
5846 * is determined by the curve, and sets the mandatory bits accordingly. That is:
5847 *
5848 * - Curve25519 (PSA_ECC_FAMILY_MONTGOMERY, 255 bits):
5849 * draw a 32-byte string and process it as specified in
5850 * Elliptic Curves for Security [RFC7748] §5.
5851 *
5852 * - Curve448 (PSA_ECC_FAMILY_MONTGOMERY, 448 bits):
5853 * draw a 56-byte string and process it as specified in [RFC7748] §5.
5854 *
5855 * Note: Function allocates memory for *data buffer, so given *data should be
5856 * always NULL.
5857 */
5858
5859static psa_status_t psa_generate_derived_ecc_key_montgomery_helper(
5860 size_t bits,
5861 psa_key_derivation_operation_t *operation,
5862 uint8_t **data
5863 )
5864{
5865 size_t output_length;
Przemek Stekiela81aed22022-03-01 15:13:30 +01005866 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005867
Gilles Peskine449bd832023-01-11 14:50:10 +01005868 switch (bits) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005869 case 255:
5870 output_length = 32;
5871 break;
5872 case 448:
5873 output_length = 56;
5874 break;
5875 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005876 return PSA_ERROR_INVALID_ARGUMENT;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005877 break;
5878 }
5879
Gilles Peskine449bd832023-01-11 14:50:10 +01005880 *data = mbedtls_calloc(1, output_length);
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005881
Gilles Peskine449bd832023-01-11 14:50:10 +01005882 if (*data == NULL) {
5883 return PSA_ERROR_INSUFFICIENT_MEMORY;
5884 }
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005885
Gilles Peskine449bd832023-01-11 14:50:10 +01005886 status = psa_key_derivation_output_bytes(operation, *data, output_length);
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005887
Gilles Peskine449bd832023-01-11 14:50:10 +01005888 if (status != PSA_SUCCESS) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005889 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01005890 }
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005891
Gilles Peskine449bd832023-01-11 14:50:10 +01005892 switch (bits) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005893 case 255:
5894 (*data)[0] &= 248;
5895 (*data)[31] &= 127;
5896 (*data)[31] |= 64;
5897 break;
5898 case 448:
5899 (*data)[0] &= 252;
5900 (*data)[55] |= 128;
5901 break;
5902 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005903 return PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005904 break;
5905 }
5906
5907 return status;
5908}
Valerio Setti86587ab2023-06-27 13:09:30 +02005909#else /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE */
5910static psa_status_t psa_generate_derived_ecc_key_weierstrass_helper(
5911 psa_key_slot_t *slot, size_t bits,
5912 psa_key_derivation_operation_t *operation, uint8_t **data)
5913{
5914 (void) slot;
5915 (void) bits;
5916 (void) operation;
5917 (void) data;
5918 return PSA_ERROR_NOT_SUPPORTED;
5919}
5920
5921static psa_status_t psa_generate_derived_ecc_key_montgomery_helper(
5922 size_t bits, psa_key_derivation_operation_t *operation, uint8_t **data)
5923{
5924 (void) bits;
5925 (void) operation;
5926 (void) data;
5927 return PSA_ERROR_NOT_SUPPORTED;
5928}
5929#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE */
5930#endif /* PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE */
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005931
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01005932static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005933 psa_key_slot_t *slot,
5934 size_t bits,
Gilles Peskine449bd832023-01-11 14:50:10 +01005935 psa_key_derivation_operation_t *operation)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005936{
5937 uint8_t *data = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01005938 size_t bytes = PSA_BITS_TO_BYTES(bits);
Archanad8a83dc2021-06-14 10:04:16 +05305939 size_t storage_size = bytes;
Przemek Stekiela81aed22022-03-01 15:13:30 +01005940 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01005941 psa_key_attributes_t attributes;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005942
Gilles Peskine449bd832023-01-11 14:50:10 +01005943 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(slot->attr.type)) {
5944 return PSA_ERROR_INVALID_ARGUMENT;
5945 }
Gilles Peskineeab56e42018-07-12 17:12:33 +02005946
Valerio Setti8ffdb5d2023-06-20 13:14:08 +02005947#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE) || \
Valerio Settidd24f292023-06-26 12:21:17 +02005948 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE)
Gilles Peskine449bd832023-01-11 14:50:10 +01005949 if (PSA_KEY_TYPE_IS_ECC(slot->attr.type)) {
5950 psa_ecc_family_t curve = PSA_KEY_TYPE_ECC_GET_FAMILY(slot->attr.type);
5951 if (PSA_ECC_FAMILY_IS_WEIERSTRASS(curve)) {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01005952 /* Weierstrass elliptic curve */
Gilles Peskine449bd832023-01-11 14:50:10 +01005953 status = psa_generate_derived_ecc_key_weierstrass_helper(slot, bits, operation, &data);
5954 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005955 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005956 }
5957 } else {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01005958 /* Montgomery elliptic curve */
Gilles Peskine449bd832023-01-11 14:50:10 +01005959 status = psa_generate_derived_ecc_key_montgomery_helper(bits, operation, &data);
5960 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01005961 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005962 }
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01005963 }
Przemyslaw Stekiel1dfd1222021-11-18 13:35:00 +01005964 } else
Valerio Setti8ffdb5d2023-06-20 13:14:08 +02005965#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE) ||
Valerio Settidd24f292023-06-26 12:21:17 +02005966 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE) */
Gilles Peskine449bd832023-01-11 14:50:10 +01005967 if (key_type_is_raw_bytes(slot->attr.type)) {
5968 if (bits % 8 != 0) {
5969 return PSA_ERROR_INVALID_ARGUMENT;
5970 }
5971 data = mbedtls_calloc(1, bytes);
5972 if (data == NULL) {
5973 return PSA_ERROR_INSUFFICIENT_MEMORY;
5974 }
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01005975
Gilles Peskine449bd832023-01-11 14:50:10 +01005976 status = psa_key_derivation_output_bytes(operation, data, bytes);
5977 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01005978 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005979 }
David Brown12ca5032021-02-11 11:02:00 -07005980#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01005981 if (slot->attr.type == PSA_KEY_TYPE_DES) {
5982 psa_des_set_key_parity(data, bytes);
5983 }
Przemek Stekielf110dc02022-03-01 14:48:05 +01005984#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES) */
Gilles Peskine449bd832023-01-11 14:50:10 +01005985 } else {
5986 return PSA_ERROR_NOT_SUPPORTED;
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01005987 }
Ronald Crondd04d422020-11-28 15:14:42 +01005988
Ronald Cronbf33c932020-11-28 18:06:53 +01005989 slot->attr.bits = (psa_key_bits_t) bits;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01005990 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01005991 .core = slot->attr
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01005992 };
5993
Gilles Peskine449bd832023-01-11 14:50:10 +01005994 if (psa_key_lifetime_is_external(attributes.core.lifetime)) {
5995 status = psa_driver_wrapper_get_key_buffer_size(&attributes,
5996 &storage_size);
5997 if (status != PSA_SUCCESS) {
Archanad8a83dc2021-06-14 10:04:16 +05305998 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005999 }
Archanad8a83dc2021-06-14 10:04:16 +05306000 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006001 status = psa_allocate_buffer_to_slot(slot, storage_size);
6002 if (status != PSA_SUCCESS) {
Archanad8a83dc2021-06-14 10:04:16 +05306003 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006004 }
Archanad8a83dc2021-06-14 10:04:16 +05306005
Gilles Peskine449bd832023-01-11 14:50:10 +01006006 status = psa_driver_wrapper_import_key(&attributes,
6007 data, bytes,
6008 slot->key.data,
6009 slot->key.bytes,
6010 &slot->key.bytes, &bits);
6011 if (bits != slot->attr.bits) {
Ronald Cronbf33c932020-11-28 18:06:53 +01006012 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine449bd832023-01-11 14:50:10 +01006013 }
Gilles Peskineeab56e42018-07-12 17:12:33 +02006014
6015exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01006016 mbedtls_free(data);
6017 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02006018}
6019
Gilles Peskine449bd832023-01-11 14:50:10 +01006020psa_status_t psa_key_derivation_output_key(const psa_key_attributes_t *attributes,
6021 psa_key_derivation_operation_t *operation,
6022 mbedtls_svc_key_id_t *key)
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006023{
6024 psa_status_t status;
6025 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02006026 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine0f84d622019-09-12 19:03:13 +02006027
Ronald Cron81709fc2020-11-14 12:10:32 +01006028 *key = MBEDTLS_SVC_KEY_ID_INIT;
6029
Gilles Peskine0f84d622019-09-12 19:03:13 +02006030 /* Reject any attempt to create a zero-length key so that we don't
6031 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006032 if (psa_get_key_bits(attributes) == 0) {
6033 return PSA_ERROR_INVALID_ARGUMENT;
6034 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02006035
Gilles Peskine449bd832023-01-11 14:50:10 +01006036 if (operation->alg == PSA_ALG_NONE) {
6037 return PSA_ERROR_BAD_STATE;
6038 }
Dave Rodgmand69da6c2021-11-16 10:32:48 +00006039
Gilles Peskine449bd832023-01-11 14:50:10 +01006040 if (!operation->can_output_key) {
6041 return PSA_ERROR_NOT_PERMITTED;
6042 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02006043
Gilles Peskine449bd832023-01-11 14:50:10 +01006044 status = psa_start_key_creation(PSA_KEY_CREATION_DERIVE, attributes,
6045 &slot, &driver);
Gilles Peskinef4ee6622019-07-24 13:44:30 +02006046#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006047 if (driver != NULL) {
Gilles Peskinef4ee6622019-07-24 13:44:30 +02006048 /* Deriving a key in a secure element is not implemented yet. */
6049 status = PSA_ERROR_NOT_SUPPORTED;
6050 }
6051#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine449bd832023-01-11 14:50:10 +01006052 if (status == PSA_SUCCESS) {
6053 status = psa_generate_derived_key_internal(slot,
6054 attributes->core.bits,
6055 operation);
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006056 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006057 if (status == PSA_SUCCESS) {
6058 status = psa_finish_key_creation(slot, driver, key);
6059 }
6060 if (status != PSA_SUCCESS) {
6061 psa_fail_key_creation(slot, driver);
6062 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02006063
Gilles Peskine449bd832023-01-11 14:50:10 +01006064 return status;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006065}
6066
Gilles Peskineeab56e42018-07-12 17:12:33 +02006067
6068
6069/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02006070/* Key derivation */
6071/****************************************************************/
6072
Steven Cooreman932ffb72021-02-15 12:14:32 +01006073#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006074static int is_kdf_alg_supported(psa_algorithm_t kdf_alg)
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006075{
6076#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006077 if (PSA_ALG_IS_HKDF(kdf_alg)) {
6078 return 1;
6079 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006080#endif
Przemek Stekielb57a44b2022-06-06 08:33:45 +02006081#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006082 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6083 return 1;
6084 }
Przemek Stekielb57a44b2022-06-06 08:33:45 +02006085#endif
6086#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006087 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
6088 return 1;
6089 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006090#endif
6091#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006092 if (PSA_ALG_IS_TLS12_PRF(kdf_alg)) {
6093 return 1;
6094 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006095#endif
6096#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006097 if (PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
6098 return 1;
6099 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006100#endif
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006101#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006102 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
6103 return 1;
6104 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006105#endif
Kusumit Ghoderaod132cac2023-05-03 12:00:27 +05306106#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
6107 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
6108 return 1;
6109 }
6110#endif
Kusumit Ghoderao2cd64962023-06-22 15:38:57 +05306111#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128)
6112 if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
6113 return 1;
6114 }
6115#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006116 return 0;
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006117}
6118
Gilles Peskine449bd832023-01-11 14:50:10 +01006119static psa_status_t psa_hash_try_support(psa_algorithm_t alg)
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006120{
6121 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01006122 psa_status_t status = psa_hash_setup(&operation, alg);
6123 psa_hash_abort(&operation);
6124 return status;
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006125}
6126
Kusumit Ghoderao86e83dd2023-12-01 16:38:26 +05306127static psa_status_t psa_key_derivation_set_maximum_capacity(
6128 psa_key_derivation_operation_t *operation,
6129 psa_algorithm_t kdf_alg)
6130{
6131#if defined(PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS)
6132 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
6133 operation->capacity = PSA_HASH_LENGTH(PSA_ALG_SHA_256);
6134 return PSA_SUCCESS;
6135 }
6136#endif
6137#if defined(PSA_WANT_ALG_PBKDF2_AES_CMAC_PRF_128)
6138 if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
6139#if (SIZE_MAX > UINT32_MAX)
Kusumit Ghoderao7d4db632023-12-07 16:17:46 +05306140 operation->capacity = UINT32_MAX * (size_t) PSA_MAC_LENGTH(
Kusumit Ghoderaod3f70d32023-12-06 16:20:04 +05306141 PSA_KEY_TYPE_AES,
6142 128U,
6143 PSA_ALG_CMAC);
Kusumit Ghoderao86e83dd2023-12-01 16:38:26 +05306144#else
6145 operation->capacity = SIZE_MAX;
6146#endif
6147 return PSA_SUCCESS;
6148 }
6149#endif /* PSA_WANT_ALG_PBKDF2_AES_CMAC_PRF_128 */
6150
6151 /* After this point, if kdf_alg is not valid then value of hash_alg may be
6152 * invalid or meaningless but it does not affect this function */
6153 psa_algorithm_t hash_alg = PSA_ALG_GET_HASH(kdf_alg);
6154 size_t hash_size = PSA_HASH_LENGTH(hash_alg);
Kusumit Ghoderaod3f70d32023-12-06 16:20:04 +05306155 if (hash_size == 0) {
6156 return PSA_ERROR_NOT_SUPPORTED;
6157 }
Kusumit Ghoderao86e83dd2023-12-01 16:38:26 +05306158
6159 /* Make sure that hash_alg is a supported hash algorithm. Otherwise
6160 * we might fail later, which is somewhat unfriendly and potentially
6161 * risk-prone. */
6162 psa_status_t status = psa_hash_try_support(hash_alg);
6163 if (status != PSA_SUCCESS) {
6164 return status;
6165 }
6166
6167#if defined(PSA_WANT_ALG_HKDF)
6168 if (PSA_ALG_IS_HKDF(kdf_alg)) {
6169 operation->capacity = 255 * hash_size;
6170 } else
6171#endif
6172#if defined(PSA_WANT_ALG_HKDF_EXTRACT)
6173 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6174 operation->capacity = hash_size;
6175 } else
6176#endif
6177#if defined(PSA_WANT_ALG_HKDF_EXPAND)
6178 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
6179 operation->capacity = 255 * hash_size;
6180 } else
6181#endif
6182#if defined(PSA_WANT_ALG_TLS12_PRF)
6183 if (PSA_ALG_IS_TLS12_PRF(kdf_alg) &&
6184 (hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384)) {
6185 operation->capacity = SIZE_MAX;
6186 } else
6187#endif
6188#if defined(PSA_WANT_ALG_TLS12_PSK_TO_MS)
6189 if (PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg) &&
6190 (hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384)) {
6191 /* Master Secret is always 48 bytes
6192 * https://datatracker.ietf.org/doc/html/rfc5246.html#section-8.1 */
6193 operation->capacity = 48U;
6194 } else
6195#endif
6196#if defined(PSA_WANT_ALG_PBKDF2_HMAC)
6197 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
6198#if (SIZE_MAX > UINT32_MAX)
6199 operation->capacity = UINT32_MAX * hash_size;
6200#else
6201 operation->capacity = SIZE_MAX;
6202#endif
6203 } else
6204#endif /* PSA_WANT_ALG_PBKDF2_HMAC */
6205 {
Kusumit Ghoderaod3f70d32023-12-06 16:20:04 +05306206 (void) hash_size;
Kusumit Ghoderao86e83dd2023-12-01 16:38:26 +05306207 status = PSA_ERROR_NOT_SUPPORTED;
6208 }
6209 return status;
6210}
6211
Gilles Peskine969c5d62019-01-16 15:53:06 +01006212static psa_status_t psa_key_derivation_setup_kdf(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006213 psa_key_derivation_operation_t *operation,
Gilles Peskine449bd832023-01-11 14:50:10 +01006214 psa_algorithm_t kdf_alg)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006215{
Janos Follath5fe19732019-06-20 15:09:30 +01006216 /* Make sure that operation->ctx is properly zero-initialised. (Macro
6217 * initialisers for this union leave some bytes unspecified.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01006218 memset(&operation->ctx, 0, sizeof(operation->ctx));
Janos Follath5fe19732019-06-20 15:09:30 +01006219
Gilles Peskine969c5d62019-01-16 15:53:06 +01006220 /* Make sure that kdf_alg is a supported key derivation algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006221 if (!is_kdf_alg_supported(kdf_alg)) {
6222 return PSA_ERROR_NOT_SUPPORTED;
6223 }
John Durkop07cc04a2020-11-16 22:08:34 -08006224
Kusumit Ghoderao86e83dd2023-12-01 16:38:26 +05306225 psa_status_t status = psa_key_derivation_set_maximum_capacity(operation,
6226 kdf_alg);
Kusumit Ghoderao5f3a9382023-09-13 16:28:12 +05306227 return status;
Gilles Peskine969c5d62019-01-16 15:53:06 +01006228}
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006229
Gilles Peskine449bd832023-01-11 14:50:10 +01006230static psa_status_t psa_key_agreement_try_support(psa_algorithm_t alg)
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006231{
6232#if defined(PSA_WANT_ALG_ECDH)
Gilles Peskine449bd832023-01-11 14:50:10 +01006233 if (alg == PSA_ALG_ECDH) {
6234 return PSA_SUCCESS;
6235 }
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006236#endif
Przemek Stekielfb3dd542022-12-01 14:59:15 +01006237#if defined(PSA_WANT_ALG_FFDH)
6238 if (alg == PSA_ALG_FFDH) {
6239 return PSA_SUCCESS;
6240 }
6241#endif
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006242 (void) alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01006243 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006244}
Gilles Peskinebb3814c2022-12-16 01:12:12 +01006245
6246static int psa_key_derivation_allows_free_form_secret_input(
6247 psa_algorithm_t kdf_alg)
6248{
6249#if defined(PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS)
6250 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
6251 return 0;
6252 }
6253#endif
6254 (void) kdf_alg;
6255 return 1;
6256}
John Durkop07cc04a2020-11-16 22:08:34 -08006257#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01006258
Gilles Peskine449bd832023-01-11 14:50:10 +01006259psa_status_t psa_key_derivation_setup(psa_key_derivation_operation_t *operation,
6260 psa_algorithm_t alg)
Gilles Peskine969c5d62019-01-16 15:53:06 +01006261{
6262 psa_status_t status;
6263
Gilles Peskine449bd832023-01-11 14:50:10 +01006264 if (operation->alg != 0) {
6265 return PSA_ERROR_BAD_STATE;
Gilles Peskine969c5d62019-01-16 15:53:06 +01006266 }
Gilles Peskine969c5d62019-01-16 15:53:06 +01006267
Gilles Peskine449bd832023-01-11 14:50:10 +01006268 if (PSA_ALG_IS_RAW_KEY_AGREEMENT(alg)) {
6269 return PSA_ERROR_INVALID_ARGUMENT;
6270 } else if (PSA_ALG_IS_KEY_AGREEMENT(alg)) {
6271#if defined(AT_LEAST_ONE_BUILTIN_KDF)
6272 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF(alg);
6273 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE(alg);
6274 status = psa_key_agreement_try_support(ka_alg);
6275 if (status != PSA_SUCCESS) {
6276 return status;
6277 }
Gilles Peskinebb3814c2022-12-16 01:12:12 +01006278 if (!psa_key_derivation_allows_free_form_secret_input(kdf_alg)) {
6279 return PSA_ERROR_INVALID_ARGUMENT;
6280 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006281 status = psa_key_derivation_setup_kdf(operation, kdf_alg);
6282#else
6283 return PSA_ERROR_NOT_SUPPORTED;
6284#endif /* AT_LEAST_ONE_BUILTIN_KDF */
6285 } else if (PSA_ALG_IS_KEY_DERIVATION(alg)) {
6286#if defined(AT_LEAST_ONE_BUILTIN_KDF)
6287 status = psa_key_derivation_setup_kdf(operation, alg);
6288#else
6289 return PSA_ERROR_NOT_SUPPORTED;
6290#endif /* AT_LEAST_ONE_BUILTIN_KDF */
6291 } else {
6292 return PSA_ERROR_INVALID_ARGUMENT;
6293 }
6294
6295 if (status == PSA_SUCCESS) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006296 operation->alg = alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01006297 }
6298 return status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006299}
6300
Przemek Stekiel69c46792022-06-10 12:59:51 +02006301#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006302static psa_status_t psa_hkdf_input(psa_hkdf_key_derivation_t *hkdf,
6303 psa_algorithm_t kdf_alg,
6304 psa_key_derivation_step_t step,
6305 const uint8_t *data,
6306 size_t data_length)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006307{
Gilles Peskine449bd832023-01-11 14:50:10 +01006308 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006309 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006310 switch (step) {
Gilles Peskine03410b52019-05-16 16:05:19 +02006311 case PSA_KEY_DERIVATION_INPUT_SALT:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006312#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006313 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
6314 return PSA_ERROR_INVALID_ARGUMENT;
6315 }
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006316#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND */
Gilles Peskine449bd832023-01-11 14:50:10 +01006317 if (hkdf->state != HKDF_STATE_INIT) {
6318 return PSA_ERROR_BAD_STATE;
6319 } else {
6320 status = psa_key_derivation_start_hmac(&hkdf->hmac,
6321 hash_alg,
6322 data, data_length);
6323 if (status != PSA_SUCCESS) {
6324 return status;
6325 }
Steven Cooremand1ed1d92021-04-29 19:11:25 +02006326 hkdf->state = HKDF_STATE_STARTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01006327 return PSA_SUCCESS;
Steven Cooremand1ed1d92021-04-29 19:11:25 +02006328 }
Gilles Peskine03410b52019-05-16 16:05:19 +02006329 case PSA_KEY_DERIVATION_INPUT_SECRET:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006330#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006331 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
Przemek Stekiel2fb0dcd2022-05-19 10:34:37 +02006332 /* We shouldn't be in different state as HKDF_EXPAND only allows
6333 * two inputs: SECRET (this case) and INFO which does not modify
6334 * the state. It could happen only if the hkdf
6335 * object was corrupted. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006336 if (hkdf->state != HKDF_STATE_INIT) {
6337 return PSA_ERROR_BAD_STATE;
6338 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006339
Przemek Stekiel2fb0dcd2022-05-19 10:34:37 +02006340 /* Allow only input that fits expected prk size */
Gilles Peskine449bd832023-01-11 14:50:10 +01006341 if (data_length != PSA_HASH_LENGTH(hash_alg)) {
6342 return PSA_ERROR_INVALID_ARGUMENT;
6343 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006344
Gilles Peskine449bd832023-01-11 14:50:10 +01006345 memcpy(hkdf->prk, data, data_length);
6346 } else
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006347#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND */
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006348 {
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006349 /* HKDF: If no salt was provided, use an empty salt.
6350 * HKDF-EXTRACT: salt is mandatory. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006351 if (hkdf->state == HKDF_STATE_INIT) {
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006352#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006353 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6354 return PSA_ERROR_BAD_STATE;
6355 }
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006356#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01006357 status = psa_key_derivation_start_hmac(&hkdf->hmac,
6358 hash_alg,
6359 NULL, 0);
6360 if (status != PSA_SUCCESS) {
6361 return status;
6362 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006363 hkdf->state = HKDF_STATE_STARTED;
6364 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006365 if (hkdf->state != HKDF_STATE_STARTED) {
6366 return PSA_ERROR_BAD_STATE;
6367 }
6368 status = psa_mac_update(&hkdf->hmac,
6369 data, data_length);
6370 if (status != PSA_SUCCESS) {
6371 return status;
6372 }
6373 status = psa_mac_sign_finish(&hkdf->hmac,
6374 hkdf->prk,
6375 sizeof(hkdf->prk),
6376 &data_length);
6377 if (status != PSA_SUCCESS) {
6378 return status;
6379 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006380 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006381
Gilles Peskine2b522db2019-04-12 15:11:49 +02006382 hkdf->state = HKDF_STATE_KEYED;
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006383 hkdf->block_number = 0;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006384#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006385 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006386 /* The only block of output is the PRK. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006387 memcpy(hkdf->output_block, hkdf->prk, PSA_HASH_LENGTH(hash_alg));
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006388 hkdf->offset_in_block = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01006389 } else
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006390#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006391 {
6392 /* Block 0 is empty, and the next block will be
6393 * generated by psa_key_derivation_hkdf_read(). */
Gilles Peskine449bd832023-01-11 14:50:10 +01006394 hkdf->offset_in_block = PSA_HASH_LENGTH(hash_alg);
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006395 }
6396
Gilles Peskine449bd832023-01-11 14:50:10 +01006397 return PSA_SUCCESS;
Gilles Peskine03410b52019-05-16 16:05:19 +02006398 case PSA_KEY_DERIVATION_INPUT_INFO:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006399#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006400 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6401 return PSA_ERROR_INVALID_ARGUMENT;
6402 }
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006403#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Przemek Stekielcde3f782022-06-03 16:12:27 +02006404#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006405 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg) &&
6406 hkdf->state == HKDF_STATE_INIT) {
6407 return PSA_ERROR_BAD_STATE;
6408 }
Przemek Stekielcde3f782022-06-03 16:12:27 +02006409#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01006410 if (hkdf->state == HKDF_STATE_OUTPUT) {
6411 return PSA_ERROR_BAD_STATE;
6412 }
6413 if (hkdf->info_set) {
6414 return PSA_ERROR_BAD_STATE;
6415 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006416 hkdf->info_length = data_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01006417 if (data_length != 0) {
6418 hkdf->info = mbedtls_calloc(1, data_length);
6419 if (hkdf->info == NULL) {
6420 return PSA_ERROR_INSUFFICIENT_MEMORY;
6421 }
6422 memcpy(hkdf->info, data, data_length);
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006423 }
6424 hkdf->info_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01006425 return PSA_SUCCESS;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006426 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006427 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006428 }
6429}
Przemek Stekiel69c46792022-06-10 12:59:51 +02006430#endif /* BUILTIN_ALG_ANY_HKDF */
Janos Follathb03233e2019-06-11 15:30:30 +01006431
John Durkop07cc04a2020-11-16 22:08:34 -08006432#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
6433 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006434static psa_status_t psa_tls12_prf_set_seed(psa_tls12_prf_key_derivation_t *prf,
6435 const uint8_t *data,
6436 size_t data_length)
Janos Follathf08e2652019-06-13 09:05:41 +01006437{
Gilles Peskine449bd832023-01-11 14:50:10 +01006438 if (prf->state != PSA_TLS12_PRF_STATE_INIT) {
6439 return PSA_ERROR_BAD_STATE;
6440 }
Janos Follathf08e2652019-06-13 09:05:41 +01006441
Gilles Peskine449bd832023-01-11 14:50:10 +01006442 if (data_length != 0) {
6443 prf->seed = mbedtls_calloc(1, data_length);
6444 if (prf->seed == NULL) {
6445 return PSA_ERROR_INSUFFICIENT_MEMORY;
6446 }
Janos Follathf08e2652019-06-13 09:05:41 +01006447
Gilles Peskine449bd832023-01-11 14:50:10 +01006448 memcpy(prf->seed, data, data_length);
Janos Follathd6dce9f2019-07-04 09:11:38 +01006449 prf->seed_length = data_length;
6450 }
Janos Follathf08e2652019-06-13 09:05:41 +01006451
Gilles Peskine43f958b2020-12-13 14:55:14 +01006452 prf->state = PSA_TLS12_PRF_STATE_SEED_SET;
Janos Follathf08e2652019-06-13 09:05:41 +01006453
Gilles Peskine449bd832023-01-11 14:50:10 +01006454 return PSA_SUCCESS;
Janos Follathf08e2652019-06-13 09:05:41 +01006455}
6456
Gilles Peskine449bd832023-01-11 14:50:10 +01006457static psa_status_t psa_tls12_prf_set_key(psa_tls12_prf_key_derivation_t *prf,
6458 const uint8_t *data,
6459 size_t data_length)
Janos Follath81550542019-06-13 14:26:34 +01006460{
Gilles Peskine449bd832023-01-11 14:50:10 +01006461 if (prf->state != PSA_TLS12_PRF_STATE_SEED_SET &&
6462 prf->state != PSA_TLS12_PRF_STATE_OTHER_KEY_SET) {
6463 return PSA_ERROR_BAD_STATE;
6464 }
Janos Follath81550542019-06-13 14:26:34 +01006465
Gilles Peskine449bd832023-01-11 14:50:10 +01006466 if (data_length != 0) {
6467 prf->secret = mbedtls_calloc(1, data_length);
6468 if (prf->secret == NULL) {
6469 return PSA_ERROR_INSUFFICIENT_MEMORY;
6470 }
Steven Cooremana6df6042021-04-29 19:32:25 +02006471
Gilles Peskine449bd832023-01-11 14:50:10 +01006472 memcpy(prf->secret, data, data_length);
Steven Cooremana6df6042021-04-29 19:32:25 +02006473 prf->secret_length = data_length;
6474 }
Janos Follath81550542019-06-13 14:26:34 +01006475
Gilles Peskine43f958b2020-12-13 14:55:14 +01006476 prf->state = PSA_TLS12_PRF_STATE_KEY_SET;
Janos Follath81550542019-06-13 14:26:34 +01006477
Gilles Peskine449bd832023-01-11 14:50:10 +01006478 return PSA_SUCCESS;
Janos Follath81550542019-06-13 14:26:34 +01006479}
6480
Gilles Peskine449bd832023-01-11 14:50:10 +01006481static psa_status_t psa_tls12_prf_set_label(psa_tls12_prf_key_derivation_t *prf,
6482 const uint8_t *data,
6483 size_t data_length)
Janos Follath63028dd2019-06-13 09:15:47 +01006484{
Gilles Peskine449bd832023-01-11 14:50:10 +01006485 if (prf->state != PSA_TLS12_PRF_STATE_KEY_SET) {
6486 return PSA_ERROR_BAD_STATE;
6487 }
Janos Follath63028dd2019-06-13 09:15:47 +01006488
Gilles Peskine449bd832023-01-11 14:50:10 +01006489 if (data_length != 0) {
6490 prf->label = mbedtls_calloc(1, data_length);
6491 if (prf->label == NULL) {
6492 return PSA_ERROR_INSUFFICIENT_MEMORY;
6493 }
Janos Follath63028dd2019-06-13 09:15:47 +01006494
Gilles Peskine449bd832023-01-11 14:50:10 +01006495 memcpy(prf->label, data, data_length);
Janos Follathd6dce9f2019-07-04 09:11:38 +01006496 prf->label_length = data_length;
6497 }
Janos Follath63028dd2019-06-13 09:15:47 +01006498
Gilles Peskine43f958b2020-12-13 14:55:14 +01006499 prf->state = PSA_TLS12_PRF_STATE_LABEL_SET;
Janos Follath63028dd2019-06-13 09:15:47 +01006500
Gilles Peskine449bd832023-01-11 14:50:10 +01006501 return PSA_SUCCESS;
Janos Follath63028dd2019-06-13 09:15:47 +01006502}
6503
Gilles Peskine449bd832023-01-11 14:50:10 +01006504static psa_status_t psa_tls12_prf_input(psa_tls12_prf_key_derivation_t *prf,
6505 psa_key_derivation_step_t step,
6506 const uint8_t *data,
6507 size_t data_length)
Janos Follathb03233e2019-06-11 15:30:30 +01006508{
Gilles Peskine449bd832023-01-11 14:50:10 +01006509 switch (step) {
Janos Follathf08e2652019-06-13 09:05:41 +01006510 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskine449bd832023-01-11 14:50:10 +01006511 return psa_tls12_prf_set_seed(prf, data, data_length);
Janos Follath81550542019-06-13 14:26:34 +01006512 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006513 return psa_tls12_prf_set_key(prf, data, data_length);
Janos Follath63028dd2019-06-13 09:15:47 +01006514 case PSA_KEY_DERIVATION_INPUT_LABEL:
Gilles Peskine449bd832023-01-11 14:50:10 +01006515 return psa_tls12_prf_set_label(prf, data, data_length);
Janos Follathb03233e2019-06-11 15:30:30 +01006516 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006517 return PSA_ERROR_INVALID_ARGUMENT;
Janos Follathb03233e2019-06-11 15:30:30 +01006518 }
6519}
John Durkop07cc04a2020-11-16 22:08:34 -08006520#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
6521 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
6522
6523#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
6524static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
6525 psa_tls12_prf_key_derivation_t *prf,
John Durkop07cc04a2020-11-16 22:08:34 -08006526 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006527 size_t data_length)
John Durkop07cc04a2020-11-16 22:08:34 -08006528{
6529 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006530 const size_t pms_len = (prf->state == PSA_TLS12_PRF_STATE_OTHER_KEY_SET ?
6531 4 + data_length + prf->other_secret_length :
6532 4 + 2 * data_length);
John Durkop07cc04a2020-11-16 22:08:34 -08006533
Gilles Peskine449bd832023-01-11 14:50:10 +01006534 if (data_length > PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE) {
6535 return PSA_ERROR_INVALID_ARGUMENT;
6536 }
John Durkop07cc04a2020-11-16 22:08:34 -08006537
Gilles Peskine449bd832023-01-11 14:50:10 +01006538 uint8_t *pms = mbedtls_calloc(1, pms_len);
6539 if (pms == NULL) {
6540 return PSA_ERROR_INSUFFICIENT_MEMORY;
6541 }
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02006542 uint8_t *cur = pms;
6543
6544 /* pure-PSK:
6545 * Quoting RFC 4279, Section 2:
John Durkop07cc04a2020-11-16 22:08:34 -08006546 *
6547 * The premaster secret is formed as follows: if the PSK is N octets
6548 * long, concatenate a uint16 with the value N, N zero octets, a second
6549 * uint16 with the value N, and the PSK itself.
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02006550 *
6551 * mixed-PSK:
6552 * In a DHE-PSK, RSA-PSK, ECDHE-PSK the premaster secret is formed as
6553 * follows: concatenate a uint16 with the length of the other secret,
6554 * the other secret itself, uint16 with the length of PSK, and the
6555 * PSK itself.
6556 * For details please check:
6557 * - RFC 4279, Section 4 for the definition of RSA-PSK,
6558 * - RFC 4279, Section 3 for the definition of DHE-PSK,
6559 * - RFC 5489 for the definition of ECDHE-PSK.
John Durkop07cc04a2020-11-16 22:08:34 -08006560 */
6561
Gilles Peskine449bd832023-01-11 14:50:10 +01006562 if (prf->state == PSA_TLS12_PRF_STATE_OTHER_KEY_SET) {
6563 *cur++ = MBEDTLS_BYTE_1(prf->other_secret_length);
6564 *cur++ = MBEDTLS_BYTE_0(prf->other_secret_length);
6565 if (prf->other_secret_length != 0) {
6566 memcpy(cur, prf->other_secret, prf->other_secret_length);
6567 mbedtls_platform_zeroize(prf->other_secret, prf->other_secret_length);
Przemek Stekiel2503f7e2022-04-12 12:08:01 +02006568 cur += prf->other_secret_length;
6569 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006570 } else {
6571 *cur++ = MBEDTLS_BYTE_1(data_length);
6572 *cur++ = MBEDTLS_BYTE_0(data_length);
6573 memset(cur, 0, data_length);
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02006574 cur += data_length;
6575 }
6576
Gilles Peskine449bd832023-01-11 14:50:10 +01006577 *cur++ = MBEDTLS_BYTE_1(data_length);
6578 *cur++ = MBEDTLS_BYTE_0(data_length);
6579 memcpy(cur, data, data_length);
John Durkop07cc04a2020-11-16 22:08:34 -08006580 cur += data_length;
6581
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00006582 status = psa_tls12_prf_set_key(prf, pms, (size_t) (cur - pms));
John Durkop07cc04a2020-11-16 22:08:34 -08006583
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01006584 mbedtls_zeroize_and_free(pms, pms_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01006585 return status;
John Durkop07cc04a2020-11-16 22:08:34 -08006586}
Janos Follath6660f0e2019-06-17 08:44:03 +01006587
Przemek Stekiele47201b2022-04-19 13:53:28 +02006588static psa_status_t psa_tls12_prf_psk_to_ms_set_other_key(
6589 psa_tls12_prf_key_derivation_t *prf,
6590 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006591 size_t data_length)
Przemek Stekiele47201b2022-04-19 13:53:28 +02006592{
Gilles Peskine449bd832023-01-11 14:50:10 +01006593 if (prf->state != PSA_TLS12_PRF_STATE_SEED_SET) {
6594 return PSA_ERROR_BAD_STATE;
Przemek Stekiele47201b2022-04-19 13:53:28 +02006595 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006596
6597 if (data_length != 0) {
6598 prf->other_secret = mbedtls_calloc(1, data_length);
6599 if (prf->other_secret == NULL) {
6600 return PSA_ERROR_INSUFFICIENT_MEMORY;
6601 }
6602
6603 memcpy(prf->other_secret, data, data_length);
6604 prf->other_secret_length = data_length;
6605 } else {
Przemek Stekiele47201b2022-04-19 13:53:28 +02006606 prf->other_secret_length = 0;
6607 }
6608
6609 prf->state = PSA_TLS12_PRF_STATE_OTHER_KEY_SET;
6610
Gilles Peskine449bd832023-01-11 14:50:10 +01006611 return PSA_SUCCESS;
Przemek Stekiele47201b2022-04-19 13:53:28 +02006612}
6613
Janos Follath6660f0e2019-06-17 08:44:03 +01006614static psa_status_t psa_tls12_prf_psk_to_ms_input(
6615 psa_tls12_prf_key_derivation_t *prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01006616 psa_key_derivation_step_t step,
6617 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006618 size_t data_length)
Janos Follath6660f0e2019-06-17 08:44:03 +01006619{
Gilles Peskine449bd832023-01-11 14:50:10 +01006620 switch (step) {
Przemek Stekiele47201b2022-04-19 13:53:28 +02006621 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006622 return psa_tls12_prf_psk_to_ms_set_key(prf,
6623 data, data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02006624 break;
6625 case PSA_KEY_DERIVATION_INPUT_OTHER_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006626 return psa_tls12_prf_psk_to_ms_set_other_key(prf,
6627 data,
6628 data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02006629 break;
6630 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006631 return psa_tls12_prf_input(prf, step, data, data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02006632 break;
Janos Follath6660f0e2019-06-17 08:44:03 +01006633
Przemek Stekiele47201b2022-04-19 13:53:28 +02006634 }
Janos Follath6660f0e2019-06-17 08:44:03 +01006635}
John Durkop07cc04a2020-11-16 22:08:34 -08006636#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006637
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006638#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
6639static psa_status_t psa_tls12_ecjpake_to_pms_input(
6640 psa_tls12_ecjpake_to_pms_t *ecjpake,
Andrzej Kurek702776f2022-09-16 06:22:44 -04006641 psa_key_derivation_step_t step,
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006642 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006643 size_t data_length)
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006644{
Gilles Peskine449bd832023-01-11 14:50:10 +01006645 if (data_length != PSA_TLS12_ECJPAKE_TO_PMS_INPUT_SIZE ||
6646 step != PSA_KEY_DERIVATION_INPUT_SECRET) {
6647 return PSA_ERROR_INVALID_ARGUMENT;
Andrzej Kurek5603efd2022-09-26 10:49:16 -04006648 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006649
6650 /* Check if the passed point is in an uncompressed form */
Gilles Peskine449bd832023-01-11 14:50:10 +01006651 if (data[0] != 0x04) {
6652 return PSA_ERROR_INVALID_ARGUMENT;
6653 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006654
6655 /* Only K.X has to be extracted - bytes 1 to 32 inclusive. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006656 memcpy(ecjpake->data, data + 1, PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE);
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006657
Gilles Peskine449bd832023-01-11 14:50:10 +01006658 return PSA_SUCCESS;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006659}
6660#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306661
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306662#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306663static psa_status_t psa_pbkdf2_set_input_cost(
6664 psa_pbkdf2_key_derivation_t *pbkdf2,
6665 psa_key_derivation_step_t step,
6666 uint64_t data)
6667{
6668 if (step != PSA_KEY_DERIVATION_INPUT_COST) {
6669 return PSA_ERROR_INVALID_ARGUMENT;
6670 }
6671
6672 if (pbkdf2->state != PSA_PBKDF2_STATE_INIT) {
6673 return PSA_ERROR_BAD_STATE;
6674 }
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05306675
Kusumit Ghoderaoe66a8ad2023-05-24 12:30:43 +05306676 if (data > PSA_VENDOR_PBKDF2_MAX_ITERATIONS) {
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05306677 return PSA_ERROR_NOT_SUPPORTED;
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306678 }
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05306679
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306680 if (data == 0) {
6681 return PSA_ERROR_INVALID_ARGUMENT;
6682 }
Kusumit Ghoderaoe66a8ad2023-05-24 12:30:43 +05306683
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306684 pbkdf2->input_cost = data;
6685 pbkdf2->state = PSA_PBKDF2_STATE_INPUT_COST_SET;
6686
6687 return PSA_SUCCESS;
6688}
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306689
6690static psa_status_t psa_pbkdf2_set_salt(psa_pbkdf2_key_derivation_t *pbkdf2,
6691 const uint8_t *data,
6692 size_t data_length)
6693{
Gilles Peskineead17662023-08-20 22:02:51 +02006694 if (pbkdf2->state == PSA_PBKDF2_STATE_INPUT_COST_SET) {
6695 pbkdf2->state = PSA_PBKDF2_STATE_SALT_SET;
6696 } else if (pbkdf2->state == PSA_PBKDF2_STATE_SALT_SET) {
6697 /* Appending to existing salt. No state change. */
6698 } else {
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306699 return PSA_ERROR_BAD_STATE;
6700 }
6701
Gilles Peskineca57d782023-07-20 19:08:06 +02006702 if (data_length == 0) {
Gilles Peskineead17662023-08-20 22:02:51 +02006703 /* Appending an empty string, nothing to do. */
6704 } else {
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306705 uint8_t *next_salt;
Kusumit Ghoderaob538bb72023-05-24 12:32:14 +05306706
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306707 next_salt = mbedtls_calloc(1, data_length + pbkdf2->salt_length);
6708 if (next_salt == NULL) {
Kusumit Ghoderaod0422f32023-05-08 15:56:19 +05306709 return PSA_ERROR_INSUFFICIENT_MEMORY;
6710 }
6711
Gilles Peskineead17662023-08-20 22:02:51 +02006712 if (pbkdf2->salt_length != 0) {
6713 memcpy(next_salt, pbkdf2->salt, pbkdf2->salt_length);
6714 }
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306715 memcpy(next_salt + pbkdf2->salt_length, data, data_length);
Kusumit Ghoderaod0422f32023-05-08 15:56:19 +05306716 pbkdf2->salt_length += data_length;
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306717 mbedtls_free(pbkdf2->salt);
6718 pbkdf2->salt = next_salt;
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306719 }
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306720 return PSA_SUCCESS;
6721}
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306722
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05306723#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306724static psa_status_t psa_pbkdf2_hmac_set_password(psa_algorithm_t hash_alg,
Kusumit Ghoderaoaac9a582023-05-24 14:19:17 +05306725 const uint8_t *input,
6726 size_t input_len,
6727 uint8_t *output,
Kusumit Ghoderao91f99f52023-05-24 22:21:48 +05306728 size_t *output_len)
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306729{
6730 psa_status_t status = PSA_SUCCESS;
6731 if (input_len > PSA_HASH_BLOCK_LENGTH(hash_alg)) {
6732 status = psa_hash_compute(hash_alg, input, input_len, output,
Kusumit Ghoderao91f99f52023-05-24 22:21:48 +05306733 PSA_HMAC_MAX_HASH_BLOCK_SIZE, output_len);
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306734 } else {
6735 memcpy(output, input, input_len);
Kusumit Ghoderao91f99f52023-05-24 22:21:48 +05306736 *output_len = PSA_HASH_BLOCK_LENGTH(hash_alg);
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306737 }
6738 return status;
6739}
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05306740#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC */
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306741
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05306742#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128)
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306743static psa_status_t psa_pbkdf2_cmac_set_password(const uint8_t *input,
6744 size_t input_len,
6745 uint8_t *output,
6746 size_t *output_len)
6747{
6748 psa_status_t status = PSA_SUCCESS;
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306749 if (input_len != PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC)) {
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306750 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Kusumit Ghoderao3fde8fe2023-06-27 10:41:43 +05306751 uint8_t zeros[16] = { 0 };
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306752 psa_set_key_type(&attributes, PSA_KEY_TYPE_AES);
6753 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(sizeof(zeros)));
6754 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306755 /* Passing PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC) as
Kusumit Ghoderao5f3345a2023-07-27 21:21:38 +05306756 * mac_size as the driver function sets mac_output_length = mac_size
6757 * on success. See https://github.com/Mbed-TLS/mbedtls/issues/7801 */
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306758 status = psa_driver_wrapper_mac_compute(&attributes,
6759 zeros, sizeof(zeros),
6760 PSA_ALG_CMAC, input, input_len,
6761 output,
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306762 PSA_MAC_LENGTH(PSA_KEY_TYPE_AES,
6763 128U,
6764 PSA_ALG_CMAC),
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306765 output_len);
6766 } else {
6767 memcpy(output, input, input_len);
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306768 *output_len = PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC);
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306769 }
6770 return status;
6771}
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05306772#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128 */
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306773
6774static psa_status_t psa_pbkdf2_set_password(psa_pbkdf2_key_derivation_t *pbkdf2,
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306775 psa_algorithm_t kdf_alg,
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306776 const uint8_t *data,
6777 size_t data_length)
6778{
Kusumit Ghoderaoaac9a582023-05-24 14:19:17 +05306779 psa_status_t status = PSA_SUCCESS;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306780 if (pbkdf2->state != PSA_PBKDF2_STATE_SALT_SET) {
6781 return PSA_ERROR_BAD_STATE;
6782 }
6783
Kusumit Ghoderaof3e696d2023-07-28 13:30:50 +05306784#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306785 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
6786 psa_algorithm_t hash_alg = PSA_ALG_PBKDF2_HMAC_GET_HASH(kdf_alg);
6787 status = psa_pbkdf2_hmac_set_password(hash_alg, data, data_length,
6788 pbkdf2->password,
6789 &pbkdf2->password_length);
Kusumit Ghoderaof3e696d2023-07-28 13:30:50 +05306790 } else
6791#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC */
6792#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128)
6793 if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306794 status = psa_pbkdf2_cmac_set_password(data, data_length,
6795 pbkdf2->password,
6796 &pbkdf2->password_length);
Kusumit Ghoderaof3e696d2023-07-28 13:30:50 +05306797 } else
6798#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128 */
6799 {
6800 return PSA_ERROR_INVALID_ARGUMENT;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306801 }
6802
6803 pbkdf2->state = PSA_PBKDF2_STATE_PASSWORD_SET;
6804
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306805 return status;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306806}
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05306807
6808static psa_status_t psa_pbkdf2_input(psa_pbkdf2_key_derivation_t *pbkdf2,
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306809 psa_algorithm_t kdf_alg,
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05306810 psa_key_derivation_step_t step,
6811 const uint8_t *data,
6812 size_t data_length)
6813{
6814 switch (step) {
6815 case PSA_KEY_DERIVATION_INPUT_SALT:
6816 return psa_pbkdf2_set_salt(pbkdf2, data, data_length);
6817 case PSA_KEY_DERIVATION_INPUT_PASSWORD:
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306818 return psa_pbkdf2_set_password(pbkdf2, kdf_alg, data, data_length);
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05306819 default:
6820 return PSA_ERROR_INVALID_ARGUMENT;
6821 }
6822}
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306823#endif /* PSA_HAVE_SOFT_PBKDF2 */
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306824
Gilles Peskineb8965192019-09-24 16:21:10 +02006825/** Check whether the given key type is acceptable for the given
6826 * input step of a key derivation.
6827 *
6828 * Secret inputs must have the type #PSA_KEY_TYPE_DERIVE.
6829 * Non-secret inputs must have the type #PSA_KEY_TYPE_RAW_DATA.
6830 * Both secret and non-secret inputs can alternatively have the type
6831 * #PSA_KEY_TYPE_NONE, which is never the type of a key object, meaning
6832 * that the input was passed as a buffer rather than via a key object.
6833 */
Gilles Peskine224b0d62019-09-23 18:13:17 +02006834static int psa_key_derivation_check_input_type(
6835 psa_key_derivation_step_t step,
Gilles Peskine449bd832023-01-11 14:50:10 +01006836 psa_key_type_t key_type)
Gilles Peskine224b0d62019-09-23 18:13:17 +02006837{
Gilles Peskine449bd832023-01-11 14:50:10 +01006838 switch (step) {
Gilles Peskine224b0d62019-09-23 18:13:17 +02006839 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006840 if (key_type == PSA_KEY_TYPE_DERIVE) {
6841 return PSA_SUCCESS;
6842 }
6843 if (key_type == PSA_KEY_TYPE_NONE) {
6844 return PSA_SUCCESS;
6845 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02006846 break;
Przemek Stekiela7695a22022-04-07 15:39:01 +02006847 case PSA_KEY_DERIVATION_INPUT_OTHER_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006848 if (key_type == PSA_KEY_TYPE_DERIVE) {
6849 return PSA_SUCCESS;
6850 }
6851 if (key_type == PSA_KEY_TYPE_NONE) {
6852 return PSA_SUCCESS;
6853 }
Przemek Stekiela7695a22022-04-07 15:39:01 +02006854 break;
Gilles Peskine224b0d62019-09-23 18:13:17 +02006855 case PSA_KEY_DERIVATION_INPUT_LABEL:
6856 case PSA_KEY_DERIVATION_INPUT_SALT:
6857 case PSA_KEY_DERIVATION_INPUT_INFO:
6858 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskine449bd832023-01-11 14:50:10 +01006859 if (key_type == PSA_KEY_TYPE_RAW_DATA) {
6860 return PSA_SUCCESS;
6861 }
6862 if (key_type == PSA_KEY_TYPE_NONE) {
6863 return PSA_SUCCESS;
6864 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02006865 break;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306866 case PSA_KEY_DERIVATION_INPUT_PASSWORD:
6867 if (key_type == PSA_KEY_TYPE_PASSWORD) {
6868 return PSA_SUCCESS;
6869 }
6870 if (key_type == PSA_KEY_TYPE_DERIVE) {
6871 return PSA_SUCCESS;
6872 }
6873 if (key_type == PSA_KEY_TYPE_NONE) {
6874 return PSA_SUCCESS;
6875 }
6876 break;
Gilles Peskine224b0d62019-09-23 18:13:17 +02006877 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006878 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine224b0d62019-09-23 18:13:17 +02006879}
6880
Janos Follathb80a94e2019-06-12 15:54:46 +01006881static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006882 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01006883 psa_key_derivation_step_t step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02006884 psa_key_type_t key_type,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01006885 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006886 size_t data_length)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006887{
Gilles Peskine46d7faf2019-09-23 19:22:55 +02006888 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006889 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
Gilles Peskine46d7faf2019-09-23 19:22:55 +02006890
Gilles Peskine449bd832023-01-11 14:50:10 +01006891 status = psa_key_derivation_check_input_type(step, key_type);
6892 if (status != PSA_SUCCESS) {
Gilles Peskine224b0d62019-09-23 18:13:17 +02006893 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006894 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02006895
Przemek Stekiel69c46792022-06-10 12:59:51 +02006896#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006897 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
6898 status = psa_hkdf_input(&operation->ctx.hkdf, kdf_alg,
6899 step, data, data_length);
6900 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02006901#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08006902#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006903 if (PSA_ALG_IS_TLS12_PRF(kdf_alg)) {
6904 status = psa_tls12_prf_input(&operation->ctx.tls12_prf,
6905 step, data, data_length);
6906 } else
John Durkop07cc04a2020-11-16 22:08:34 -08006907#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF */
6908#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006909 if (PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
6910 status = psa_tls12_prf_psk_to_ms_input(&operation->ctx.tls12_prf,
6911 step, data, data_length);
6912 } else
John Durkop07cc04a2020-11-16 22:08:34 -08006913#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006914#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006915 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006916 status = psa_tls12_ecjpake_to_pms_input(
Gilles Peskine449bd832023-01-11 14:50:10 +01006917 &operation->ctx.tls12_ecjpake_to_pms, step, data, data_length);
6918 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006919#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306920#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05306921 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306922 status = psa_pbkdf2_input(&operation->ctx.pbkdf2, kdf_alg,
6923 step, data, data_length);
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05306924 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306925#endif /* PSA_HAVE_SOFT_PBKDF2 */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006926 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006927 /* This can't happen unless the operation object was not initialized */
Steven Cooreman74afe472021-02-10 17:19:22 +01006928 (void) data;
6929 (void) data_length;
6930 (void) kdf_alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01006931 return PSA_ERROR_BAD_STATE;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006932 }
6933
Gilles Peskine224b0d62019-09-23 18:13:17 +02006934exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01006935 if (status != PSA_SUCCESS) {
6936 psa_key_derivation_abort(operation);
6937 }
6938 return status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006939}
6940
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05306941static psa_status_t psa_key_derivation_input_integer_internal(
6942 psa_key_derivation_operation_t *operation,
6943 psa_key_derivation_step_t step,
6944 uint64_t value)
6945{
6946 psa_status_t status;
6947 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
6948
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306949#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05306950 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306951 status = psa_pbkdf2_set_input_cost(
6952 &operation->ctx.pbkdf2, step, value);
6953 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306954#endif /* PSA_HAVE_SOFT_PBKDF2 */
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05306955 {
Kusumit Ghoderao3a18dee2023-04-07 16:16:27 +05306956 (void) step;
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05306957 (void) value;
6958 (void) kdf_alg;
Kusumit Ghoderaoa14ae5a2023-04-19 14:16:26 +05306959 status = PSA_ERROR_INVALID_ARGUMENT;
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05306960 }
6961
6962 if (status != PSA_SUCCESS) {
6963 psa_key_derivation_abort(operation);
6964 }
6965 return status;
6966}
6967
Janos Follath51f4a0f2019-06-14 11:35:55 +01006968psa_status_t psa_key_derivation_input_bytes(
6969 psa_key_derivation_operation_t *operation,
6970 psa_key_derivation_step_t step,
6971 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006972 size_t data_length)
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01006973{
Gilles Peskine449bd832023-01-11 14:50:10 +01006974 return psa_key_derivation_input_internal(operation, step,
6975 PSA_KEY_TYPE_NONE,
6976 data, data_length);
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01006977}
6978
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05306979psa_status_t psa_key_derivation_input_integer(
6980 psa_key_derivation_operation_t *operation,
6981 psa_key_derivation_step_t step,
6982 uint64_t value)
6983{
6984 return psa_key_derivation_input_integer_internal(operation, step, value);
6985}
6986
Janos Follath51f4a0f2019-06-14 11:35:55 +01006987psa_status_t psa_key_derivation_input_key(
6988 psa_key_derivation_operation_t *operation,
6989 psa_key_derivation_step_t step,
Gilles Peskine449bd832023-01-11 14:50:10 +01006990 mbedtls_svc_key_id_t key)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006991{
Ronald Cronf95a2b12020-10-22 15:24:49 +02006992 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01006993 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006994 psa_key_slot_t *slot;
Gilles Peskine178c9aa2019-09-24 18:21:06 +02006995
Ronald Cron5c522922020-11-14 16:35:34 +01006996 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01006997 key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg);
6998 if (status != PSA_SUCCESS) {
6999 psa_key_derivation_abort(operation);
7000 return status;
Gilles Peskine593773d2019-09-23 18:17:40 +02007001 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02007002
Kusumit Ghoderao3128c5d2023-05-03 12:27:57 +05307003 /* Passing a key object as a SECRET or PASSWORD input unlocks the
7004 * permission to output to a key object. */
7005 if (step == PSA_KEY_DERIVATION_INPUT_SECRET ||
7006 step == PSA_KEY_DERIVATION_INPUT_PASSWORD) {
Gilles Peskine178c9aa2019-09-24 18:21:06 +02007007 operation->can_output_key = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01007008 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02007009
Gilles Peskine449bd832023-01-11 14:50:10 +01007010 status = psa_key_derivation_input_internal(operation,
7011 step, slot->attr.type,
7012 slot->key.data,
7013 slot->key.bytes);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007014
Ryan Everett1b70a072024-01-04 10:32:49 +00007015 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007016
Gilles Peskine449bd832023-01-11 14:50:10 +01007017 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007018}
Gilles Peskineea0fb492018-07-12 17:17:20 +02007019
7020
7021
7022/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02007023/* Key agreement */
7024/****************************************************************/
7025
Gilles Peskine449bd832023-01-11 14:50:10 +01007026psa_status_t psa_key_agreement_raw_builtin(const psa_key_attributes_t *attributes,
7027 const uint8_t *key_buffer,
7028 size_t key_buffer_size,
7029 psa_algorithm_t alg,
7030 const uint8_t *peer_key,
7031 size_t peer_key_length,
7032 uint8_t *shared_secret,
7033 size_t shared_secret_size,
7034 size_t *shared_secret_length)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02007035{
Gilles Peskine449bd832023-01-11 14:50:10 +01007036 switch (alg) {
John Durkop6ba40d12020-11-10 08:50:04 -08007037#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskine0216fe12019-04-11 21:23:21 +02007038 case PSA_ALG_ECDH:
Gilles Peskine449bd832023-01-11 14:50:10 +01007039 return mbedtls_psa_key_agreement_ecdh(attributes, key_buffer,
7040 key_buffer_size, alg,
7041 peer_key, peer_key_length,
7042 shared_secret,
7043 shared_secret_size,
7044 shared_secret_length);
Gilles Peskine01d718c2018-09-18 12:01:02 +02007045#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Przemek Stekielfb3dd542022-12-01 14:59:15 +01007046
7047#if defined(MBEDTLS_PSA_BUILTIN_ALG_FFDH)
7048 case PSA_ALG_FFDH:
Przemek Stekiel152bb462023-06-01 11:52:39 +02007049 return mbedtls_psa_ffdh_key_agreement(attributes,
Przemek Stekiel359f4622022-12-05 14:11:55 +01007050 peer_key,
7051 peer_key_length,
7052 key_buffer,
7053 key_buffer_size,
7054 shared_secret,
7055 shared_secret_size,
7056 shared_secret_length);
Przemek Stekielfb3dd542022-12-01 14:59:15 +01007057#endif /* MBEDTLS_PSA_BUILTIN_ALG_FFDH */
7058
Gilles Peskine01d718c2018-09-18 12:01:02 +02007059 default:
Aditya Deshpande17845b82022-10-13 17:21:01 +01007060 (void) attributes;
7061 (void) key_buffer;
7062 (void) key_buffer_size;
Gilles Peskine93f85002018-11-16 16:43:31 +01007063 (void) peer_key;
7064 (void) peer_key_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02007065 (void) shared_secret;
7066 (void) shared_secret_size;
7067 (void) shared_secret_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01007068 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine01d718c2018-09-18 12:01:02 +02007069 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02007070}
Gilles Peskine01d718c2018-09-18 12:01:02 +02007071
Aditya Deshpande17845b82022-10-13 17:21:01 +01007072/** Internal function for raw key agreement
7073 * Calls the driver wrapper which will hand off key agreement task
Aditya Deshpande40c05cc2022-10-14 16:41:40 +01007074 * to the driver's implementation if a driver is present.
7075 * Fallback specified in the driver wrapper is built-in raw key agreement
Aditya Deshpande17845b82022-10-13 17:21:01 +01007076 * (psa_key_agreement_raw_builtin).
7077 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007078static psa_status_t psa_key_agreement_raw_internal(psa_algorithm_t alg,
7079 psa_key_slot_t *private_key,
7080 const uint8_t *peer_key,
7081 size_t peer_key_length,
7082 uint8_t *shared_secret,
7083 size_t shared_secret_size,
7084 size_t *shared_secret_length)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02007085{
Gilles Peskine449bd832023-01-11 14:50:10 +01007086 if (!PSA_ALG_IS_RAW_KEY_AGREEMENT(alg)) {
7087 return PSA_ERROR_NOT_SUPPORTED;
7088 }
Aditya Deshpande17845b82022-10-13 17:21:01 +01007089
7090 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01007091 .core = private_key->attr
Aditya Deshpande17845b82022-10-13 17:21:01 +01007092 };
7093
Gilles Peskine449bd832023-01-11 14:50:10 +01007094 return psa_driver_wrapper_key_agreement(&attributes,
7095 private_key->key.data,
7096 private_key->key.bytes, alg,
7097 peer_key, peer_key_length,
7098 shared_secret,
7099 shared_secret_size,
7100 shared_secret_length);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007101}
7102
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02007103/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine01d718c2018-09-18 12:01:02 +02007104 * to potentially free embedded data structures and wipe confidential data.
7105 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007106static psa_status_t psa_key_agreement_internal(psa_key_derivation_operation_t *operation,
7107 psa_key_derivation_step_t step,
7108 psa_key_slot_t *private_key,
7109 const uint8_t *peer_key,
7110 size_t peer_key_length)
Gilles Peskine01d718c2018-09-18 12:01:02 +02007111{
7112 psa_status_t status;
Aditya Deshpande2f7fd762022-11-22 11:10:34 +00007113 uint8_t shared_secret[PSA_RAW_KEY_AGREEMENT_OUTPUT_MAX_SIZE];
Gilles Peskine01d718c2018-09-18 12:01:02 +02007114 size_t shared_secret_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007115 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE(operation->alg);
Gilles Peskine01d718c2018-09-18 12:01:02 +02007116
7117 /* Step 1: run the secret agreement algorithm to generate the shared
7118 * secret. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007119 status = psa_key_agreement_raw_internal(ka_alg,
7120 private_key,
7121 peer_key, peer_key_length,
7122 shared_secret,
7123 sizeof(shared_secret),
7124 &shared_secret_length);
7125 if (status != PSA_SUCCESS) {
Gilles Peskine12313cd2018-06-20 00:20:32 +02007126 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007127 }
Gilles Peskine12313cd2018-06-20 00:20:32 +02007128
Gilles Peskineb0b255c2018-07-06 17:01:38 +02007129 /* Step 2: set up the key derivation to generate key material from
Gilles Peskine224b0d62019-09-23 18:13:17 +02007130 * the shared secret. A shared secret is permitted wherever a key
7131 * of type DERIVE is permitted. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007132 status = psa_key_derivation_input_internal(operation, step,
7133 PSA_KEY_TYPE_DERIVE,
7134 shared_secret,
7135 shared_secret_length);
Gilles Peskine12313cd2018-06-20 00:20:32 +02007136exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007137 mbedtls_platform_zeroize(shared_secret, shared_secret_length);
7138 return status;
Gilles Peskine12313cd2018-06-20 00:20:32 +02007139}
7140
Gilles Peskine449bd832023-01-11 14:50:10 +01007141psa_status_t psa_key_derivation_key_agreement(psa_key_derivation_operation_t *operation,
7142 psa_key_derivation_step_t step,
7143 mbedtls_svc_key_id_t private_key,
7144 const uint8_t *peer_key,
7145 size_t peer_key_length)
Gilles Peskine12313cd2018-06-20 00:20:32 +02007146{
Ronald Cronf95a2b12020-10-22 15:24:49 +02007147 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01007148 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01007149 psa_key_slot_t *slot;
Ronald Cronf95a2b12020-10-22 15:24:49 +02007150
Gilles Peskine449bd832023-01-11 14:50:10 +01007151 if (!PSA_ALG_IS_KEY_AGREEMENT(operation->alg)) {
7152 return PSA_ERROR_INVALID_ARGUMENT;
7153 }
Ronald Cron5c522922020-11-14 16:35:34 +01007154 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01007155 private_key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg);
7156 if (status != PSA_SUCCESS) {
7157 return status;
7158 }
7159 status = psa_key_agreement_internal(operation, step,
7160 slot,
7161 peer_key, peer_key_length);
7162 if (status != PSA_SUCCESS) {
7163 psa_key_derivation_abort(operation);
7164 } else {
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007165 /* If a private key has been added as SECRET, we allow the derived
7166 * key material to be used as a key in PSA Crypto. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007167 if (step == PSA_KEY_DERIVATION_INPUT_SECRET) {
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007168 operation->can_output_key = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01007169 }
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007170 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007171
Ryan Everett1b70a072024-01-04 10:32:49 +00007172 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007173
Gilles Peskine449bd832023-01-11 14:50:10 +01007174 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskineaf3baab2018-06-27 22:55:52 +02007175}
7176
Gilles Peskine449bd832023-01-11 14:50:10 +01007177psa_status_t psa_raw_key_agreement(psa_algorithm_t alg,
7178 mbedtls_svc_key_id_t private_key,
7179 const uint8_t *peer_key,
7180 size_t peer_key_length,
7181 uint8_t *output,
7182 size_t output_size,
7183 size_t *output_length)
Gilles Peskine0216fe12019-04-11 21:23:21 +02007184{
Ronald Cronf95a2b12020-10-22 15:24:49 +02007185 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01007186 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +02007187 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007188 size_t expected_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02007189
Gilles Peskine449bd832023-01-11 14:50:10 +01007190 if (!PSA_ALG_IS_KEY_AGREEMENT(alg)) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007191 status = PSA_ERROR_INVALID_ARGUMENT;
7192 goto exit;
7193 }
Ronald Cron5c522922020-11-14 16:35:34 +01007194 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01007195 private_key, &slot, PSA_KEY_USAGE_DERIVE, alg);
7196 if (status != PSA_SUCCESS) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007197 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007198 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02007199
Gilles Peskine3e561302022-04-14 00:17:15 +02007200 /* PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() is in general an upper bound
7201 * for the output size. The PSA specification only guarantees that this
7202 * function works if output_size >= PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE(...),
7203 * but it might be nice to allow smaller buffers if the output fits.
7204 * At the time of writing this comment, with only ECDH implemented,
7205 * PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() is exact so the point is moot.
7206 * If FFDH is implemented, PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() can easily
7207 * be exact for it as well. */
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007208 expected_length =
Gilles Peskine449bd832023-01-11 14:50:10 +01007209 PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE(slot->attr.type, slot->attr.bits);
7210 if (output_size < expected_length) {
Gilles Peskine3e561302022-04-14 00:17:15 +02007211 status = PSA_ERROR_BUFFER_TOO_SMALL;
7212 goto exit;
7213 }
7214
Gilles Peskine449bd832023-01-11 14:50:10 +01007215 status = psa_key_agreement_raw_internal(alg, slot,
7216 peer_key, peer_key_length,
7217 output, output_size,
7218 output_length);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007219
7220exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007221 if (status != PSA_SUCCESS) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007222 /* If an error happens and is not handled properly, the output
7223 * may be used as a key to protect sensitive data. Arrange for such
7224 * a key to be random, which is likely to result in decryption or
7225 * verification errors. This is better than filling the buffer with
7226 * some constant data such as zeros, which would result in the data
7227 * being protected with a reproducible, easily knowable key.
7228 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007229 psa_generate_random(output, output_size);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007230 *output_length = output_size;
7231 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007232
Ryan Everetta103ec92024-01-31 13:59:57 +00007233 unlock_status = psa_unregister_read_under_mutex(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007234
Gilles Peskine449bd832023-01-11 14:50:10 +01007235 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine0216fe12019-04-11 21:23:21 +02007236}
Gilles Peskine86a440b2018-11-12 18:39:40 +01007237
7238
Gilles Peskine30524eb2020-11-13 17:02:26 +01007239
Gilles Peskine86a440b2018-11-12 18:39:40 +01007240/****************************************************************/
7241/* Random generation */
Gilles Peskine53d991e2018-07-12 01:14:59 +02007242/****************************************************************/
Gilles Peskine12313cd2018-06-20 00:20:32 +02007243
Gilles Peskine672a7712023-04-28 21:00:28 +02007244#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
7245#include "entropy_poll.h"
7246#endif
7247
Gilles Peskine30524eb2020-11-13 17:02:26 +01007248/** Initialize the PSA random generator.
7249 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007250static void mbedtls_psa_random_init(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01007251{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007252#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine449bd832023-01-11 14:50:10 +01007253 memset(rng, 0, sizeof(*rng));
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007254#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
7255
Gilles Peskine30524eb2020-11-13 17:02:26 +01007256 /* Set default configuration if
7257 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007258 if (rng->entropy_init == NULL) {
Gilles Peskine30524eb2020-11-13 17:02:26 +01007259 rng->entropy_init = mbedtls_entropy_init;
Gilles Peskine449bd832023-01-11 14:50:10 +01007260 }
7261 if (rng->entropy_free == NULL) {
Gilles Peskine30524eb2020-11-13 17:02:26 +01007262 rng->entropy_free = mbedtls_entropy_free;
Gilles Peskine449bd832023-01-11 14:50:10 +01007263 }
Gilles Peskine30524eb2020-11-13 17:02:26 +01007264
Gilles Peskine449bd832023-01-11 14:50:10 +01007265 rng->entropy_init(&rng->entropy);
Gilles Peskine30524eb2020-11-13 17:02:26 +01007266#if defined(MBEDTLS_PSA_INJECT_ENTROPY) && \
7267 defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
7268 /* The PSA entropy injection feature depends on using NV seed as an entropy
7269 * source. Add NV seed as an entropy source for PSA entropy injection. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007270 mbedtls_entropy_add_source(&rng->entropy,
7271 mbedtls_nv_seed_poll, NULL,
7272 MBEDTLS_ENTROPY_BLOCK_SIZE,
7273 MBEDTLS_ENTROPY_SOURCE_STRONG);
Gilles Peskine30524eb2020-11-13 17:02:26 +01007274#endif
7275
Gilles Peskine449bd832023-01-11 14:50:10 +01007276 mbedtls_psa_drbg_init(MBEDTLS_PSA_RANDOM_STATE);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007277#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007278}
7279
7280/** Deinitialize the PSA random generator.
7281 */
Valerio Setti83e0de82023-11-24 12:13:05 +01007282static void mbedtls_psa_random_free(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01007283{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007284#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Valerio Setti83e0de82023-11-24 12:13:05 +01007285 memset(rng, 0, sizeof(*rng));
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007286#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Valerio Setti83e0de82023-11-24 12:13:05 +01007287 mbedtls_psa_drbg_free(MBEDTLS_PSA_RANDOM_STATE);
7288 rng->entropy_free(&rng->entropy);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007289#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007290}
7291
7292/** Seed the PSA random generator.
7293 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007294static psa_status_t mbedtls_psa_random_seed(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01007295{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007296#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
7297 /* Do nothing: the external RNG seeds itself. */
7298 (void) rng;
Gilles Peskine449bd832023-01-11 14:50:10 +01007299 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007300#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007301 const unsigned char drbg_seed[] = "PSA";
Gilles Peskine449bd832023-01-11 14:50:10 +01007302 int ret = mbedtls_psa_drbg_seed(&rng->entropy,
7303 drbg_seed, sizeof(drbg_seed) - 1);
7304 return mbedtls_to_psa_error(ret);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007305#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007306}
7307
Gilles Peskine449bd832023-01-11 14:50:10 +01007308psa_status_t psa_generate_random(uint8_t *output,
7309 size_t output_size)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007310{
Gilles Peskinee59236f2018-01-27 23:32:46 +01007311 GUARD_MODULE_INITIALIZED;
7312
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007313#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
7314
7315 size_t output_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007316 psa_status_t status = mbedtls_psa_external_get_random(&global_data.rng,
7317 output, output_size,
7318 &output_length);
7319 if (status != PSA_SUCCESS) {
7320 return status;
7321 }
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007322 /* Breaking up a request into smaller chunks is currently not supported
Tom Cosgrove1797b052022-12-04 17:19:59 +00007323 * for the external RNG interface. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007324 if (output_length != output_size) {
7325 return PSA_ERROR_INSUFFICIENT_ENTROPY;
7326 }
7327 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007328
7329#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
7330
Gilles Peskine449bd832023-01-11 14:50:10 +01007331 while (output_size > 0) {
Gilles Peskine71ddab92021-01-04 21:01:07 +01007332 size_t request_size =
Gilles Peskine449bd832023-01-11 14:50:10 +01007333 (output_size > MBEDTLS_PSA_RANDOM_MAX_REQUEST ?
7334 MBEDTLS_PSA_RANDOM_MAX_REQUEST :
7335 output_size);
7336 int ret = mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE,
7337 output, request_size);
7338 if (ret != 0) {
7339 return mbedtls_to_psa_error(ret);
7340 }
Gilles Peskine71ddab92021-01-04 21:01:07 +01007341 output_size -= request_size;
7342 output += request_size;
Gilles Peskinef181eca2019-08-07 13:49:00 +02007343 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007344 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007345#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskinee59236f2018-01-27 23:32:46 +01007346}
7347
Gilles Peskine8814fc42020-12-14 15:33:44 +01007348/* Wrapper function allowing the classic API to use the PSA RNG.
Gilles Peskine9c3e0602021-01-05 16:03:55 +01007349 *
7350 * `mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE, ...)` calls
7351 * `psa_generate_random(...)`. The state parameter is ignored since the
7352 * PSA API doesn't support passing an explicit state.
7353 *
7354 * In the non-external case, psa_generate_random() calls an
7355 * `mbedtls_xxx_drbg_random` function which has exactly the same signature
7356 * and semantics as mbedtls_psa_get_random(). As an optimization,
7357 * instead of doing this back-and-forth between the PSA API and the
7358 * classic API, psa_crypto_random_impl.h defines `mbedtls_psa_get_random`
7359 * as a constant function pointer to `mbedtls_xxx_drbg_random`.
Gilles Peskine8814fc42020-12-14 15:33:44 +01007360 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007361#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
7362int mbedtls_psa_get_random(void *p_rng,
7363 unsigned char *output,
7364 size_t output_size)
Gilles Peskine8814fc42020-12-14 15:33:44 +01007365{
Gilles Peskine9c3e0602021-01-05 16:03:55 +01007366 /* This function takes a pointer to the RNG state because that's what
7367 * classic mbedtls functions using an RNG expect. The PSA RNG manages
7368 * its own state internally and doesn't let the caller access that state.
7369 * So we just ignore the state parameter, and in practice we'll pass
7370 * NULL. */
Gilles Peskine8814fc42020-12-14 15:33:44 +01007371 (void) p_rng;
Gilles Peskine449bd832023-01-11 14:50:10 +01007372 psa_status_t status = psa_generate_random(output, output_size);
7373 if (status == PSA_SUCCESS) {
7374 return 0;
7375 } else {
7376 return MBEDTLS_ERR_ENTROPY_SOURCE_FAILED;
7377 }
Gilles Peskine8814fc42020-12-14 15:33:44 +01007378}
7379#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
7380
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01007381#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
Gilles Peskine449bd832023-01-11 14:50:10 +01007382psa_status_t mbedtls_psa_inject_entropy(const uint8_t *seed,
7383 size_t seed_size)
Netanel Gonen2bcd3122018-11-19 11:53:02 +02007384{
Gilles Peskine449bd832023-01-11 14:50:10 +01007385 if (global_data.initialized) {
7386 return PSA_ERROR_NOT_PERMITTED;
7387 }
Netanel Gonen21f37cb2018-11-19 11:53:55 +02007388
Gilles Peskine449bd832023-01-11 14:50:10 +01007389 if (((seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM) ||
7390 (seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE)) ||
7391 (seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE)) {
7392 return PSA_ERROR_INVALID_ARGUMENT;
7393 }
Netanel Gonen21f37cb2018-11-19 11:53:55 +02007394
Gilles Peskine449bd832023-01-11 14:50:10 +01007395 return mbedtls_psa_storage_inject_entropy(seed, seed_size);
Netanel Gonen2bcd3122018-11-19 11:53:02 +02007396}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01007397#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02007398
Ronald Cron3772afe2021-02-08 16:10:05 +01007399/** Validate the key type and size for key generation
Ronald Cron01b2aba2020-10-05 09:42:02 +02007400 *
Ronald Cron3772afe2021-02-08 16:10:05 +01007401 * \param type The key type
7402 * \param bits The number of bits of the key
Ronald Cron01b2aba2020-10-05 09:42:02 +02007403 *
7404 * \retval #PSA_SUCCESS
Ronald Cron3772afe2021-02-08 16:10:05 +01007405 * The key type and size are valid.
Ronald Cron01b2aba2020-10-05 09:42:02 +02007406 * \retval #PSA_ERROR_INVALID_ARGUMENT
7407 * The size in bits of the key is not valid.
7408 * \retval #PSA_ERROR_NOT_SUPPORTED
7409 * The type and/or the size in bits of the key or the combination of
7410 * the two is not supported.
7411 */
Ronald Cron3772afe2021-02-08 16:10:05 +01007412static psa_status_t psa_validate_key_type_and_size_for_key_generation(
Gilles Peskine449bd832023-01-11 14:50:10 +01007413 psa_key_type_t type, size_t bits)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007414{
Ronald Cronf3bb7612020-10-02 20:11:59 +02007415 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007416
Gilles Peskine449bd832023-01-11 14:50:10 +01007417 if (key_type_is_raw_bytes(type)) {
7418 status = psa_validate_unstructured_key_bit_size(type, bits);
7419 if (status != PSA_SUCCESS) {
7420 return status;
7421 }
7422 } else
Valerio Settif6d4dfb2023-07-10 10:55:12 +02007423#if defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007424 if (PSA_KEY_TYPE_IS_RSA(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
7425 if (bits > PSA_VENDOR_RSA_MAX_KEY_BITS) {
7426 return PSA_ERROR_NOT_SUPPORTED;
7427 }
Waleed Elmelegyd7bdbbe2023-07-20 16:26:58 +00007428 if (bits < PSA_VENDOR_RSA_GENERATE_MIN_KEY_BITS) {
Waleed Elmelegyab570712023-07-05 16:40:58 +00007429 return PSA_ERROR_NOT_SUPPORTED;
7430 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +02007431
Ronald Cron01b2aba2020-10-05 09:42:02 +02007432 /* Accept only byte-aligned keys, for the same reasons as
7433 * in psa_import_rsa_key(). */
Gilles Peskine449bd832023-01-11 14:50:10 +01007434 if (bits % 8 != 0) {
7435 return PSA_ERROR_NOT_SUPPORTED;
7436 }
7437 } else
Valerio Settif6d4dfb2023-07-10 10:55:12 +02007438#endif /* defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02007439
Valerio Setti6a9d0ee2023-06-21 10:07:21 +02007440#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007441 if (PSA_KEY_TYPE_IS_ECC(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
Ronald Crond81ab562021-02-16 09:01:16 +01007442 /* To avoid empty block, return successfully here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007443 return PSA_SUCCESS;
7444 } else
Valerio Setti6a9d0ee2023-06-21 10:07:21 +02007445#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_GENERATE) */
Przemek Stekielfedd1342022-12-01 15:00:02 +01007446
Valerio Settia55f0422023-07-10 15:34:41 +02007447#if defined(PSA_WANT_KEY_TYPE_DH_KEY_PAIR_GENERATE)
Przemek Stekielfedd1342022-12-01 15:00:02 +01007448 if (PSA_KEY_TYPE_IS_DH(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
Przemek Stekield1cf1ba2023-04-27 12:04:21 +02007449 if (psa_is_dh_key_size_valid(bits) == 0) {
Przemek Stekielfedd1342022-12-01 15:00:02 +01007450 return PSA_ERROR_NOT_SUPPORTED;
7451 }
7452 } else
Valerio Settia55f0422023-07-10 15:34:41 +02007453#endif /* defined(PSA_WANT_KEY_TYPE_DH_KEY_PAIR_GENERATE) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02007454 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007455 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007456 }
7457
Gilles Peskine449bd832023-01-11 14:50:10 +01007458 return PSA_SUCCESS;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007459}
7460
Ronald Cron55ed0592020-10-05 10:30:40 +02007461psa_status_t psa_generate_key_internal(
Ronald Cron2a38a6b2020-10-02 20:02:04 +02007462 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01007463 uint8_t *key_buffer, size_t key_buffer_size, size_t *key_buffer_length)
Ronald Cron01b2aba2020-10-05 09:42:02 +02007464{
7465 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2a38a6b2020-10-02 20:02:04 +02007466 psa_key_type_t type = attributes->core.type;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007467
Gilles Peskine449bd832023-01-11 14:50:10 +01007468 if ((attributes->domain_parameters == NULL) &&
7469 (attributes->domain_parameters_size != 0)) {
7470 return PSA_ERROR_INVALID_ARGUMENT;
7471 }
Ronald Cron01b2aba2020-10-05 09:42:02 +02007472
Gilles Peskine449bd832023-01-11 14:50:10 +01007473 if (key_type_is_raw_bytes(type)) {
7474 status = psa_generate_random(key_buffer, key_buffer_size);
7475 if (status != PSA_SUCCESS) {
7476 return status;
7477 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +02007478
David Brown12ca5032021-02-11 11:02:00 -07007479#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01007480 if (type == PSA_KEY_TYPE_DES) {
7481 psa_des_set_key_parity(key_buffer, key_buffer_size);
7482 }
David Brown8107e312021-02-12 08:08:46 -07007483#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine449bd832023-01-11 14:50:10 +01007484 } else
Gilles Peskinee59236f2018-01-27 23:32:46 +01007485
Valerio Setti76df8c12023-07-11 14:11:28 +02007486#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007487 if (type == PSA_KEY_TYPE_RSA_KEY_PAIR) {
7488 return mbedtls_psa_rsa_generate_key(attributes,
7489 key_buffer,
7490 key_buffer_size,
7491 key_buffer_length);
7492 } else
Valerio Setti76df8c12023-07-11 14:11:28 +02007493#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_GENERATE) */
Gilles Peskinee59236f2018-01-27 23:32:46 +01007494
Valerio Settibfeaf5b2023-06-20 13:27:46 +02007495#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007496 if (PSA_KEY_TYPE_IS_ECC(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
7497 return mbedtls_psa_ecp_generate_key(attributes,
7498 key_buffer,
7499 key_buffer_size,
7500 key_buffer_length);
7501 } else
Valerio Settibfeaf5b2023-06-20 13:27:46 +02007502#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_GENERATE) */
Przemek Stekielfedd1342022-12-01 15:00:02 +01007503
Valerio Settia55f0422023-07-10 15:34:41 +02007504#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_GENERATE)
Przemek Stekielfedd1342022-12-01 15:00:02 +01007505 if (PSA_KEY_TYPE_IS_DH(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
7506 return mbedtls_psa_ffdh_generate_key(attributes,
7507 key_buffer,
7508 key_buffer_size,
7509 key_buffer_length);
7510 } else
Valerio Settia55f0422023-07-10 15:34:41 +02007511#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_GENERATE) */
Steven Cooreman29149862020-08-05 15:43:42 +02007512 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007513 (void) key_buffer_length;
7514 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman29149862020-08-05 15:43:42 +02007515 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01007516
Gilles Peskine449bd832023-01-11 14:50:10 +01007517 return PSA_SUCCESS;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02007518}
Darryl Green0c6575a2018-11-07 16:05:30 +00007519
Gilles Peskine449bd832023-01-11 14:50:10 +01007520psa_status_t psa_generate_key(const psa_key_attributes_t *attributes,
7521 mbedtls_svc_key_id_t *key)
Gilles Peskineff5f0e72019-04-18 12:53:30 +02007522{
7523 psa_status_t status;
7524 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02007525 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cron2b56bc82020-10-05 10:02:26 +02007526 size_t key_buffer_size;
Gilles Peskine11792082019-08-06 18:36:36 +02007527
Ronald Cron81709fc2020-11-14 12:10:32 +01007528 *key = MBEDTLS_SVC_KEY_ID_INIT;
7529
Gilles Peskine0f84d622019-09-12 19:03:13 +02007530 /* Reject any attempt to create a zero-length key so that we don't
7531 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007532 if (psa_get_key_bits(attributes) == 0) {
7533 return PSA_ERROR_INVALID_ARGUMENT;
7534 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02007535
Przemyslaw Stekielc0fe8202021-10-07 11:08:56 +02007536 /* Reject any attempt to create a public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007537 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(attributes->core.type)) {
7538 return PSA_ERROR_INVALID_ARGUMENT;
7539 }
Przemyslaw Stekielc0fe8202021-10-07 11:08:56 +02007540
Gilles Peskine449bd832023-01-11 14:50:10 +01007541 status = psa_start_key_creation(PSA_KEY_CREATION_GENERATE, attributes,
7542 &slot, &driver);
7543 if (status != PSA_SUCCESS) {
Gilles Peskine11792082019-08-06 18:36:36 +02007544 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007545 }
Gilles Peskine11792082019-08-06 18:36:36 +02007546
Ronald Cron977c2472020-10-13 08:32:21 +02007547 /* In the case of a transparent key or an opaque key stored in local
Archana449608b2021-09-08 15:36:05 +05307548 * storage ( thus not in the case of generating a key in a secure element
7549 * with storage ( MBEDTLS_PSA_CRYPTO_SE_C ) ),we have to allocate a
7550 * buffer to hold the generated key material. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007551 if (slot->key.data == NULL) {
7552 if (PSA_KEY_LIFETIME_GET_LOCATION(attributes->core.lifetime) ==
7553 PSA_KEY_LOCATION_LOCAL_STORAGE) {
Ronald Cron3772afe2021-02-08 16:10:05 +01007554 status = psa_validate_key_type_and_size_for_key_generation(
Gilles Peskine449bd832023-01-11 14:50:10 +01007555 attributes->core.type, attributes->core.bits);
7556 if (status != PSA_SUCCESS) {
Ronald Cron3772afe2021-02-08 16:10:05 +01007557 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007558 }
Ronald Cron3772afe2021-02-08 16:10:05 +01007559
7560 key_buffer_size = PSA_EXPORT_KEY_OUTPUT_SIZE(
Gilles Peskine449bd832023-01-11 14:50:10 +01007561 attributes->core.type,
7562 attributes->core.bits);
7563 } else {
Ronald Cron977c2472020-10-13 08:32:21 +02007564 status = psa_driver_wrapper_get_key_buffer_size(
Gilles Peskine449bd832023-01-11 14:50:10 +01007565 attributes, &key_buffer_size);
7566 if (status != PSA_SUCCESS) {
Ronald Cron3772afe2021-02-08 16:10:05 +01007567 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007568 }
Ronald Cron977c2472020-10-13 08:32:21 +02007569 }
Ronald Cron977c2472020-10-13 08:32:21 +02007570
Gilles Peskine449bd832023-01-11 14:50:10 +01007571 status = psa_allocate_buffer_to_slot(slot, key_buffer_size);
7572 if (status != PSA_SUCCESS) {
Ronald Cron977c2472020-10-13 08:32:21 +02007573 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007574 }
Ronald Cron977c2472020-10-13 08:32:21 +02007575 }
7576
Gilles Peskine449bd832023-01-11 14:50:10 +01007577 status = psa_driver_wrapper_generate_key(attributes,
7578 slot->key.data, slot->key.bytes, &slot->key.bytes);
Gilles Peskine11792082019-08-06 18:36:36 +02007579
Gilles Peskine449bd832023-01-11 14:50:10 +01007580 if (status != PSA_SUCCESS) {
7581 psa_remove_key_data_from_memory(slot);
7582 }
Ronald Cron2b56bc82020-10-05 10:02:26 +02007583
Gilles Peskine11792082019-08-06 18:36:36 +02007584exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007585 if (status == PSA_SUCCESS) {
7586 status = psa_finish_key_creation(slot, driver, key);
7587 }
7588 if (status != PSA_SUCCESS) {
7589 psa_fail_key_creation(slot, driver);
7590 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007591
Gilles Peskine449bd832023-01-11 14:50:10 +01007592 return status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007593}
7594
Gilles Peskinee59236f2018-01-27 23:32:46 +01007595/****************************************************************/
7596/* Module setup */
7597/****************************************************************/
7598
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007599#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine5e769522018-11-20 21:59:56 +01007600psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
Gilles Peskine449bd832023-01-11 14:50:10 +01007601 void (* entropy_init)(mbedtls_entropy_context *ctx),
7602 void (* entropy_free)(mbedtls_entropy_context *ctx))
Gilles Peskine5e769522018-11-20 21:59:56 +01007603{
Gilles Peskine449bd832023-01-11 14:50:10 +01007604 if (global_data.rng_state != RNG_NOT_INITIALIZED) {
7605 return PSA_ERROR_BAD_STATE;
7606 }
Gilles Peskine30524eb2020-11-13 17:02:26 +01007607 global_data.rng.entropy_init = entropy_init;
7608 global_data.rng.entropy_free = entropy_free;
Gilles Peskine449bd832023-01-11 14:50:10 +01007609 return PSA_SUCCESS;
Gilles Peskine5e769522018-11-20 21:59:56 +01007610}
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007611#endif /* !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) */
Gilles Peskine5e769522018-11-20 21:59:56 +01007612
Gilles Peskine449bd832023-01-11 14:50:10 +01007613void mbedtls_psa_crypto_free(void)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007614{
Gilles Peskine449bd832023-01-11 14:50:10 +01007615 psa_wipe_all_key_slots();
Valerio Setti83e0de82023-11-24 12:13:05 +01007616 if (global_data.rng_state != RNG_NOT_INITIALIZED) {
7617 mbedtls_psa_random_free(&global_data.rng);
7618 }
Gilles Peskinec6b69072018-11-20 21:42:52 +01007619 /* Wipe all remaining data, including configuration.
7620 * In particular, this sets all state indicator to the value
7621 * indicating "uninitialized". */
Gilles Peskine449bd832023-01-11 14:50:10 +01007622 mbedtls_platform_zeroize(&global_data, sizeof(global_data));
Ronald Cron9ba76912021-04-10 16:57:30 +02007623
7624 /* Terminate drivers */
Gilles Peskine449bd832023-01-11 14:50:10 +01007625 psa_driver_wrapper_free();
Gilles Peskinee59236f2018-01-27 23:32:46 +01007626}
7627
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007628#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
7629/** Recover a transaction that was interrupted by a power failure.
7630 *
7631 * This function is called during initialization, before psa_crypto_init()
7632 * returns. If this function returns a failure status, the initialization
7633 * fails.
7634 */
7635static psa_status_t psa_crypto_recover_transaction(
Gilles Peskine449bd832023-01-11 14:50:10 +01007636 const psa_crypto_transaction_t *transaction)
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007637{
Gilles Peskine449bd832023-01-11 14:50:10 +01007638 switch (transaction->unknown.type) {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007639 case PSA_CRYPTO_TRANSACTION_CREATE_KEY:
7640 case PSA_CRYPTO_TRANSACTION_DESTROY_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01007641 /* TODO - fall through to the failure case until this
7642 * is implemented.
7643 * https://github.com/ARMmbed/mbed-crypto/issues/218
7644 */
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007645 default:
7646 /* We found an unsupported transaction in the storage.
7647 * We don't know what state the storage is in. Give up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007648 return PSA_ERROR_DATA_INVALID;
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007649 }
7650}
7651#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
7652
Gilles Peskine449bd832023-01-11 14:50:10 +01007653psa_status_t psa_crypto_init(void)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007654{
Gilles Peskine66fb1262018-12-10 16:29:04 +01007655 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007656
Gilles Peskinec6b69072018-11-20 21:42:52 +01007657 /* Double initialization is explicitly allowed. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007658 if (global_data.initialized != 0) {
7659 return PSA_SUCCESS;
7660 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01007661
Manuel Pégourié-Gonnard7abdf7e2023-03-09 11:17:43 +01007662 /* Init drivers */
7663 status = psa_driver_wrapper_init();
7664 if (status != PSA_SUCCESS) {
7665 goto exit;
7666 }
7667 global_data.drivers_initialized = 1;
7668
Valerio Setti402cfba2023-11-13 10:24:32 +01007669 status = psa_initialize_key_slots();
7670 if (status != PSA_SUCCESS) {
7671 goto exit;
7672 }
7673
Gilles Peskine30524eb2020-11-13 17:02:26 +01007674 /* Initialize and seed the random generator. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007675 mbedtls_psa_random_init(&global_data.rng);
Gilles Peskinec6b69072018-11-20 21:42:52 +01007676 global_data.rng_state = RNG_INITIALIZED;
Gilles Peskine449bd832023-01-11 14:50:10 +01007677 status = mbedtls_psa_random_seed(&global_data.rng);
7678 if (status != PSA_SUCCESS) {
Gilles Peskinee59236f2018-01-27 23:32:46 +01007679 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007680 }
Gilles Peskinec6b69072018-11-20 21:42:52 +01007681 global_data.rng_state = RNG_SEEDED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007682
Gilles Peskine4b734222019-07-24 15:56:31 +02007683#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007684 status = psa_crypto_load_transaction();
7685 if (status == PSA_SUCCESS) {
7686 status = psa_crypto_recover_transaction(&psa_crypto_transaction);
7687 if (status != PSA_SUCCESS) {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007688 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007689 }
7690 status = psa_crypto_stop_transaction();
7691 } else if (status == PSA_ERROR_DOES_NOT_EXIST) {
Gilles Peskinefc762652019-07-22 19:30:34 +02007692 /* There's no transaction to complete. It's all good. */
7693 status = PSA_SUCCESS;
7694 }
Gilles Peskine4b734222019-07-24 15:56:31 +02007695#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
Gilles Peskinefc762652019-07-22 19:30:34 +02007696
Gilles Peskinec6b69072018-11-20 21:42:52 +01007697 /* All done. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01007698 global_data.initialized = 1;
7699
7700exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007701 if (status != PSA_SUCCESS) {
7702 mbedtls_psa_crypto_free();
7703 }
7704 return status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007705}
7706
Yanray Wangffc3c482023-07-11 12:01:04 +08007707#if defined(PSA_WANT_ALG_SOME_PAKE)
Przemek Stekielca8d2b22023-01-17 16:21:33 +01007708psa_status_t psa_crypto_driver_pake_get_password_len(
7709 const psa_crypto_driver_pake_inputs_t *inputs,
7710 size_t *password_len)
7711{
7712 if (inputs->password_len == 0) {
7713 return PSA_ERROR_BAD_STATE;
7714 }
7715
7716 *password_len = inputs->password_len;
7717
7718 return PSA_SUCCESS;
7719}
7720
7721psa_status_t psa_crypto_driver_pake_get_password(
7722 const psa_crypto_driver_pake_inputs_t *inputs,
7723 uint8_t *buffer, size_t buffer_size, size_t *buffer_length)
7724{
7725 if (inputs->password_len == 0) {
7726 return PSA_ERROR_BAD_STATE;
7727 }
7728
7729 if (buffer_size < inputs->password_len) {
7730 return PSA_ERROR_BUFFER_TOO_SMALL;
7731 }
7732
7733 memcpy(buffer, inputs->password, inputs->password_len);
7734 *buffer_length = inputs->password_len;
7735
7736 return PSA_SUCCESS;
7737}
7738
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007739psa_status_t psa_crypto_driver_pake_get_user_len(
7740 const psa_crypto_driver_pake_inputs_t *inputs,
7741 size_t *user_len)
7742{
7743 if (inputs->user_len == 0) {
7744 return PSA_ERROR_BAD_STATE;
7745 }
7746
7747 *user_len = inputs->user_len;
7748
7749 return PSA_SUCCESS;
7750}
7751
7752psa_status_t psa_crypto_driver_pake_get_user(
7753 const psa_crypto_driver_pake_inputs_t *inputs,
Przemek Stekielc0e62502023-03-14 11:49:36 +01007754 uint8_t *user_id, size_t user_id_size, size_t *user_id_len)
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007755{
7756 if (inputs->user_len == 0) {
7757 return PSA_ERROR_BAD_STATE;
7758 }
7759
Przemek Stekielc0e62502023-03-14 11:49:36 +01007760 if (user_id_size < inputs->user_len) {
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007761 return PSA_ERROR_BUFFER_TOO_SMALL;
7762 }
7763
Przemek Stekielc0e62502023-03-14 11:49:36 +01007764 memcpy(user_id, inputs->user, inputs->user_len);
7765 *user_id_len = inputs->user_len;
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007766
7767 return PSA_SUCCESS;
7768}
7769
7770psa_status_t psa_crypto_driver_pake_get_peer_len(
7771 const psa_crypto_driver_pake_inputs_t *inputs,
7772 size_t *peer_len)
7773{
7774 if (inputs->peer_len == 0) {
7775 return PSA_ERROR_BAD_STATE;
7776 }
7777
7778 *peer_len = inputs->peer_len;
7779
7780 return PSA_SUCCESS;
7781}
7782
7783psa_status_t psa_crypto_driver_pake_get_peer(
7784 const psa_crypto_driver_pake_inputs_t *inputs,
Przemek Stekielc0e62502023-03-14 11:49:36 +01007785 uint8_t *peer_id, size_t peer_id_size, size_t *peer_id_length)
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007786{
7787 if (inputs->peer_len == 0) {
7788 return PSA_ERROR_BAD_STATE;
7789 }
7790
Przemek Stekielc0e62502023-03-14 11:49:36 +01007791 if (peer_id_size < inputs->peer_len) {
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007792 return PSA_ERROR_BUFFER_TOO_SMALL;
7793 }
7794
Przemek Stekielc0e62502023-03-14 11:49:36 +01007795 memcpy(peer_id, inputs->peer, inputs->peer_len);
7796 *peer_id_length = inputs->peer_len;
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007797
7798 return PSA_SUCCESS;
7799}
7800
Przemek Stekielca8d2b22023-01-17 16:21:33 +01007801psa_status_t psa_crypto_driver_pake_get_cipher_suite(
7802 const psa_crypto_driver_pake_inputs_t *inputs,
7803 psa_pake_cipher_suite_t *cipher_suite)
7804{
7805 if (inputs->cipher_suite.algorithm == PSA_ALG_NONE) {
7806 return PSA_ERROR_BAD_STATE;
7807 }
7808
7809 *cipher_suite = inputs->cipher_suite;
7810
7811 return PSA_SUCCESS;
7812}
7813
Neil Armstronga7d08c32022-06-01 18:21:20 +02007814psa_status_t psa_pake_setup(
7815 psa_pake_operation_t *operation,
7816 const psa_pake_cipher_suite_t *cipher_suite)
7817{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007818 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007819
Przemek Stekiel1c3cfb42023-01-26 10:35:02 +01007820 if (operation->stage != PSA_PAKE_OPERATION_STAGE_SETUP) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007821 status = PSA_ERROR_BAD_STATE;
7822 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007823 }
7824
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01007825 if (PSA_ALG_IS_PAKE(cipher_suite->algorithm) == 0 ||
Przemek Stekiel51eac532022-12-07 11:04:51 +01007826 PSA_ALG_IS_HASH(cipher_suite->hash) == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007827 status = PSA_ERROR_INVALID_ARGUMENT;
7828 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007829 }
7830
Przemek Stekiel51eac532022-12-07 11:04:51 +01007831 memset(&operation->data.inputs, 0, sizeof(operation->data.inputs));
7832
Przemek Stekiele12ed362022-12-21 12:54:46 +01007833 operation->alg = cipher_suite->algorithm;
Przemek Stekiel656b2592023-03-22 13:15:33 +01007834 operation->primitive = PSA_PAKE_PRIMITIVE(cipher_suite->type,
7835 cipher_suite->family, cipher_suite->bits);
Przemek Stekiel51eac532022-12-07 11:04:51 +01007836 operation->data.inputs.cipher_suite = *cipher_suite;
7837
Przemek Stekiel4aa99402023-02-27 13:00:57 +01007838#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01007839 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01007840 psa_jpake_computation_stage_t *computation_stage =
Przemek Stekieldde6a912023-01-26 08:46:37 +01007841 &operation->computation_stage.jpake;
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01007842
David Horstmann16f01512023-06-14 17:21:07 +01007843 memset(computation_stage, 0, sizeof(*computation_stage));
David Horstmanne7f21e62023-05-12 18:17:21 +01007844 computation_stage->step = PSA_PAKE_STEP_KEY_SHARE;
Przemek Stekiel80a88492023-02-20 13:32:22 +01007845 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007846#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01007847 {
7848 status = PSA_ERROR_NOT_SUPPORTED;
7849 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01007850 }
7851
Przemek Stekiel1c3cfb42023-01-26 10:35:02 +01007852 operation->stage = PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS;
7853
Przemek Stekiel51eac532022-12-07 11:04:51 +01007854 return PSA_SUCCESS;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007855exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007856 psa_pake_abort(operation);
7857 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02007858}
7859
7860psa_status_t psa_pake_set_password_key(
7861 psa_pake_operation_t *operation,
7862 mbedtls_svc_key_id_t password)
7863{
Neil Armstrong5ae60962022-09-15 11:29:46 +02007864 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel6c764412022-11-22 14:05:12 +01007865 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
7866 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007867 psa_key_attributes_t attributes;
7868 psa_key_type_t type;
Neil Armstrong5ae60962022-09-15 11:29:46 +02007869
Przemek Stekiel51eac532022-12-07 11:04:51 +01007870 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007871 status = PSA_ERROR_BAD_STATE;
7872 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007873 }
7874
Przemek Stekiel6c764412022-11-22 14:05:12 +01007875 status = psa_get_and_lock_key_slot_with_policy(password, &slot,
7876 PSA_KEY_USAGE_DERIVE,
Przemek Stekield5d28a22023-01-26 10:46:05 +01007877 operation->alg);
Neil Armstrong5ae60962022-09-15 11:29:46 +02007878 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007879 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02007880 }
7881
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007882 attributes = (psa_key_attributes_t) {
Przemek Stekiel6c764412022-11-22 14:05:12 +01007883 .core = slot->attr
7884 };
Neil Armstrong5ae60962022-09-15 11:29:46 +02007885
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007886 type = psa_get_key_type(&attributes);
Neil Armstrong5ae60962022-09-15 11:29:46 +02007887
Przemek Stekiel51eac532022-12-07 11:04:51 +01007888 if (type != PSA_KEY_TYPE_PASSWORD &&
7889 type != PSA_KEY_TYPE_PASSWORD_HASH) {
7890 status = PSA_ERROR_INVALID_ARGUMENT;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007891 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007892 }
7893
Przemek Stekiel51eac532022-12-07 11:04:51 +01007894 operation->data.inputs.password = mbedtls_calloc(1, slot->key.bytes);
7895 if (operation->data.inputs.password == NULL) {
Przemek Stekiele12ed362022-12-21 12:54:46 +01007896 status = PSA_ERROR_INSUFFICIENT_MEMORY;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007897 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007898 }
7899
7900 memcpy(operation->data.inputs.password, slot->key.data, slot->key.bytes);
7901 operation->data.inputs.password_len = slot->key.bytes;
Przemek Stekiel9dd24402023-01-26 15:06:09 +01007902 operation->data.inputs.attributes = attributes;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007903exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007904 if (status != PSA_SUCCESS) {
7905 psa_pake_abort(operation);
7906 }
Ryan Everett1b70a072024-01-04 10:32:49 +00007907 unlock_status = psa_unregister_read(slot);
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007908 return (status == PSA_SUCCESS) ? unlock_status : status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02007909}
7910
7911psa_status_t psa_pake_set_user(
7912 psa_pake_operation_t *operation,
7913 const uint8_t *user_id,
7914 size_t user_id_len)
7915{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007916 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007917
7918 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007919 status = PSA_ERROR_BAD_STATE;
7920 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02007921 }
7922
Przemek Stekiel51eac532022-12-07 11:04:51 +01007923 if (user_id_len == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007924 status = PSA_ERROR_INVALID_ARGUMENT;
7925 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02007926 }
7927
Przemek Stekielf309d6b2023-03-10 09:54:45 +01007928 if (operation->data.inputs.user_len != 0) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007929 status = PSA_ERROR_BAD_STATE;
7930 goto exit;
7931 }
7932
Przemek Stekielf309d6b2023-03-10 09:54:45 +01007933 operation->data.inputs.user = mbedtls_calloc(1, user_id_len);
7934 if (operation->data.inputs.user == NULL) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007935 status = PSA_ERROR_INSUFFICIENT_MEMORY;
7936 goto exit;
7937 }
7938
Przemek Stekielf309d6b2023-03-10 09:54:45 +01007939 memcpy(operation->data.inputs.user, user_id, user_id_len);
7940 operation->data.inputs.user_len = user_id_len;
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007941
7942 return PSA_SUCCESS;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007943exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007944 psa_pake_abort(operation);
7945 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02007946}
7947
7948psa_status_t psa_pake_set_peer(
7949 psa_pake_operation_t *operation,
7950 const uint8_t *peer_id,
7951 size_t peer_id_len)
7952{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007953 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007954
7955 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007956 status = PSA_ERROR_BAD_STATE;
7957 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02007958 }
7959
Przemek Stekiel51eac532022-12-07 11:04:51 +01007960 if (peer_id_len == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007961 status = PSA_ERROR_INVALID_ARGUMENT;
7962 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02007963 }
7964
Przemek Stekielf309d6b2023-03-10 09:54:45 +01007965 if (operation->data.inputs.peer_len != 0) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007966 status = PSA_ERROR_BAD_STATE;
7967 goto exit;
7968 }
7969
Przemek Stekielf309d6b2023-03-10 09:54:45 +01007970 operation->data.inputs.peer = mbedtls_calloc(1, peer_id_len);
7971 if (operation->data.inputs.peer == NULL) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007972 status = PSA_ERROR_INSUFFICIENT_MEMORY;
7973 goto exit;
7974 }
7975
Przemek Stekielf309d6b2023-03-10 09:54:45 +01007976 memcpy(operation->data.inputs.peer, peer_id, peer_id_len);
7977 operation->data.inputs.peer_len = peer_id_len;
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007978
7979 return PSA_SUCCESS;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007980exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007981 psa_pake_abort(operation);
7982 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02007983}
7984
7985psa_status_t psa_pake_set_role(
7986 psa_pake_operation_t *operation,
7987 psa_pake_role_t role)
7988{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007989 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007990
Przemek Stekiel51eac532022-12-07 11:04:51 +01007991 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007992 status = PSA_ERROR_BAD_STATE;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007993 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007994 }
7995
Przemek Stekiel09104b82023-03-06 14:11:51 +01007996 switch (operation->alg) {
7997#if defined(PSA_WANT_ALG_JPAKE)
7998 case PSA_ALG_JPAKE:
7999 if (role == PSA_PAKE_ROLE_NONE) {
8000 return PSA_SUCCESS;
8001 }
8002 status = PSA_ERROR_INVALID_ARGUMENT;
8003 break;
8004#endif
8005 default:
8006 (void) role;
8007 status = PSA_ERROR_NOT_SUPPORTED;
8008 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008009 }
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008010exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008011 psa_pake_abort(operation);
8012 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008013}
8014
David Horstmanne7f21e62023-05-12 18:17:21 +01008015/* Auxiliary function to convert core computation stage to single driver step. */
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008016#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiel251e86a2023-02-17 14:30:50 +01008017static psa_crypto_driver_pake_step_t convert_jpake_computation_stage_to_driver_step(
Przemek Stekieldde6a912023-01-26 08:46:37 +01008018 psa_jpake_computation_stage_t *stage)
Przemek Stekielb09c4872023-01-17 12:05:38 +01008019{
David Horstmann74a3d8c2023-06-14 18:28:19 +01008020 psa_crypto_driver_pake_step_t key_share_step;
David Horstmann5da95602023-06-08 15:37:12 +01008021 if (stage->round == PSA_JPAKE_FIRST) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008022 int is_x1;
David Horstmann74a3d8c2023-06-14 18:28:19 +01008023
David Horstmann024e5c52023-06-14 15:48:21 +01008024 if (stage->io_mode == PSA_JPAKE_OUTPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008025 is_x1 = (stage->outputs < 1);
8026 } else {
8027 is_x1 = (stage->inputs < 1);
8028 }
8029
David Horstmann74a3d8c2023-06-14 18:28:19 +01008030 key_share_step = is_x1 ?
8031 PSA_JPAKE_X1_STEP_KEY_SHARE :
8032 PSA_JPAKE_X2_STEP_KEY_SHARE;
David Horstmann5da95602023-06-08 15:37:12 +01008033 } else if (stage->round == PSA_JPAKE_SECOND) {
David Horstmann74a3d8c2023-06-14 18:28:19 +01008034 key_share_step = (stage->io_mode == PSA_JPAKE_OUTPUT) ?
8035 PSA_JPAKE_X2S_STEP_KEY_SHARE :
8036 PSA_JPAKE_X4S_STEP_KEY_SHARE;
8037 } else {
8038 return PSA_JPAKE_STEP_INVALID;
Przemek Stekielb09c4872023-01-17 12:05:38 +01008039 }
Agathiyan Bragadeesh387bfa52023-07-17 17:01:33 +01008040 return (psa_crypto_driver_pake_step_t) (key_share_step + stage->step - PSA_PAKE_STEP_KEY_SHARE);
Przemek Stekielb09c4872023-01-17 12:05:38 +01008041}
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008042#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekielb09c4872023-01-17 12:05:38 +01008043
Przemek Stekiel2797d372022-12-22 11:19:22 +01008044static psa_status_t psa_pake_complete_inputs(
8045 psa_pake_operation_t *operation)
8046{
Przemek Stekiel2797d372022-12-22 11:19:22 +01008047 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel18620a32023-01-17 16:34:52 +01008048 /* Create copy of the inputs on stack as inputs share memory
8049 with the driver context which will be setup by the driver. */
8050 psa_crypto_driver_pake_inputs_t inputs = operation->data.inputs;
Przemek Stekiel2797d372022-12-22 11:19:22 +01008051
Przemek Stekielfde11282023-03-13 16:06:09 +01008052 if (inputs.password_len == 0) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01008053 return PSA_ERROR_BAD_STATE;
8054 }
8055
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008056 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekielfde11282023-03-13 16:06:09 +01008057 if (inputs.user_len == 0 || inputs.peer_len == 0) {
8058 return PSA_ERROR_BAD_STATE;
8059 }
Przemek Stekieldff21d32023-02-14 20:09:10 +01008060 }
8061
Przemek Stekiel18620a32023-01-17 16:34:52 +01008062 /* Clear driver context */
8063 mbedtls_platform_zeroize(&operation->data, sizeof(operation->data));
8064
8065 status = psa_driver_wrapper_pake_setup(operation, &inputs);
Przemek Stekiel2797d372022-12-22 11:19:22 +01008066
8067 /* Driver is responsible for creating its own copy of the password. */
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01008068 mbedtls_zeroize_and_free(inputs.password, inputs.password_len);
Przemek Stekiel2797d372022-12-22 11:19:22 +01008069
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008070 /* User and peer are translated to role. */
8071 mbedtls_free(inputs.user);
8072 mbedtls_free(inputs.peer);
8073
Przemek Stekiel2797d372022-12-22 11:19:22 +01008074 if (status == PSA_SUCCESS) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008075#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiel2797d372022-12-22 11:19:22 +01008076 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekield93de322023-02-24 08:39:04 +01008077 operation->stage = PSA_PAKE_OPERATION_STAGE_COMPUTATION;
Przemek Stekiel80a88492023-02-20 13:32:22 +01008078 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008079#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01008080 {
8081 status = PSA_ERROR_NOT_SUPPORTED;
Przemek Stekiel2797d372022-12-22 11:19:22 +01008082 }
Przemek Stekiel2797d372022-12-22 11:19:22 +01008083 }
Przemek Stekiel2797d372022-12-22 11:19:22 +01008084 return status;
8085}
8086
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008087#if defined(PSA_WANT_ALG_JPAKE)
David Horstmanne7f21e62023-05-12 18:17:21 +01008088static psa_status_t psa_jpake_prologue(
Przemek Stekiele12ed362022-12-21 12:54:46 +01008089 psa_pake_operation_t *operation,
David Horstmanne7f21e62023-05-12 18:17:21 +01008090 psa_pake_step_t step,
David Horstmann00ad6bf2023-06-14 15:44:24 +01008091 psa_jpake_io_mode_t io_mode)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008092{
Przemek Stekiele12ed362022-12-21 12:54:46 +01008093 if (step != PSA_PAKE_STEP_KEY_SHARE &&
8094 step != PSA_PAKE_STEP_ZK_PUBLIC &&
8095 step != PSA_PAKE_STEP_ZK_PROOF) {
8096 return PSA_ERROR_INVALID_ARGUMENT;
8097 }
8098
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008099 psa_jpake_computation_stage_t *computation_stage =
8100 &operation->computation_stage.jpake;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008101
David Horstmann5da95602023-06-08 15:37:12 +01008102 if (computation_stage->round != PSA_JPAKE_FIRST &&
8103 computation_stage->round != PSA_JPAKE_SECOND) {
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008104 return PSA_ERROR_BAD_STATE;
8105 }
8106
David Horstmanne7f21e62023-05-12 18:17:21 +01008107 /* Check that the step we are given is the one we were expecting */
8108 if (step != computation_stage->step) {
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008109 return PSA_ERROR_BAD_STATE;
8110 }
8111
David Horstmanne7f21e62023-05-12 18:17:21 +01008112 if (step == PSA_PAKE_STEP_KEY_SHARE &&
8113 computation_stage->inputs == 0 &&
8114 computation_stage->outputs == 0) {
8115 /* Start of the round, so function decides whether we are inputting
8116 * or outputting */
David Horstmann024e5c52023-06-14 15:48:21 +01008117 computation_stage->io_mode = io_mode;
8118 } else if (computation_stage->io_mode != io_mode) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008119 /* Middle of the round so the mode we are in must match the function
8120 * called by the user */
8121 return PSA_ERROR_BAD_STATE;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008122 }
8123
8124 return PSA_SUCCESS;
8125}
8126
David Horstmanne7f21e62023-05-12 18:17:21 +01008127static psa_status_t psa_jpake_epilogue(
8128 psa_pake_operation_t *operation,
David Horstmann00ad6bf2023-06-14 15:44:24 +01008129 psa_jpake_io_mode_t io_mode)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008130{
David Horstmanne7f21e62023-05-12 18:17:21 +01008131 psa_jpake_computation_stage_t *stage =
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008132 &operation->computation_stage.jpake;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008133
David Horstmanne7f21e62023-05-12 18:17:21 +01008134 if (stage->step == PSA_PAKE_STEP_ZK_PROOF) {
8135 /* End of an input/output */
David Horstmann00ad6bf2023-06-14 15:44:24 +01008136 if (io_mode == PSA_JPAKE_INPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008137 stage->inputs++;
David Horstmann246ec5a2023-06-27 10:33:06 +01008138 if (stage->inputs == PSA_JPAKE_EXPECTED_INPUTS(stage->round)) {
David Horstmann024e5c52023-06-14 15:48:21 +01008139 stage->io_mode = PSA_JPAKE_OUTPUT;
David Horstmanne7f21e62023-05-12 18:17:21 +01008140 }
8141 }
David Horstmann00ad6bf2023-06-14 15:44:24 +01008142 if (io_mode == PSA_JPAKE_OUTPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008143 stage->outputs++;
David Horstmann246ec5a2023-06-27 10:33:06 +01008144 if (stage->outputs == PSA_JPAKE_EXPECTED_OUTPUTS(stage->round)) {
David Horstmann024e5c52023-06-14 15:48:21 +01008145 stage->io_mode = PSA_JPAKE_INPUT;
David Horstmanne7f21e62023-05-12 18:17:21 +01008146 }
8147 }
David Horstmann246ec5a2023-06-27 10:33:06 +01008148 if (stage->inputs == PSA_JPAKE_EXPECTED_INPUTS(stage->round) &&
8149 stage->outputs == PSA_JPAKE_EXPECTED_OUTPUTS(stage->round)) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008150 /* End of a round, move to the next round */
8151 stage->inputs = 0;
8152 stage->outputs = 0;
8153 stage->round++;
8154 }
8155 stage->step = PSA_PAKE_STEP_KEY_SHARE;
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008156 } else {
David Horstmanne7f21e62023-05-12 18:17:21 +01008157 stage->step++;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008158 }
Przemek Stekiele12ed362022-12-21 12:54:46 +01008159 return PSA_SUCCESS;
8160}
David Horstmanne7f21e62023-05-12 18:17:21 +01008161
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008162#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008163
Neil Armstronga7d08c32022-06-01 18:21:20 +02008164psa_status_t psa_pake_output(
8165 psa_pake_operation_t *operation,
8166 psa_pake_step_t step,
8167 uint8_t *output,
8168 size_t output_size,
8169 size_t *output_length)
8170{
Przemek Stekiel51eac532022-12-07 11:04:51 +01008171 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008172 psa_crypto_driver_pake_step_t driver_step = PSA_JPAKE_STEP_INVALID;
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008173 *output_length = 0;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008174
8175 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01008176 status = psa_pake_complete_inputs(operation);
8177 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008178 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008179 }
8180 }
8181
8182 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008183 status = PSA_ERROR_BAD_STATE;
8184 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008185 }
8186
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008187 if (output_size == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008188 status = PSA_ERROR_INVALID_ARGUMENT;
8189 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008190 }
8191
Przemek Stekiele12ed362022-12-21 12:54:46 +01008192 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008193#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008194 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008195 status = psa_jpake_prologue(operation, step, PSA_JPAKE_OUTPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008196 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008197 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008198 }
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008199 driver_step = convert_jpake_computation_stage_to_driver_step(
8200 &operation->computation_stage.jpake);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008201 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008202#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008203 default:
Przemek Stekiel80a88492023-02-20 13:32:22 +01008204 (void) step;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008205 status = PSA_ERROR_NOT_SUPPORTED;
8206 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008207 }
8208
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008209 status = psa_driver_wrapper_pake_output(operation, driver_step,
8210 output, output_size, output_length);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008211
8212 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008213 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008214 }
8215
8216 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008217#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008218 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008219 status = psa_jpake_epilogue(operation, PSA_JPAKE_OUTPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008220 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008221 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008222 }
8223 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008224#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008225 default:
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008226 status = PSA_ERROR_NOT_SUPPORTED;
8227 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008228 }
8229
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008230 return PSA_SUCCESS;
8231exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008232 psa_pake_abort(operation);
8233 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008234}
8235
8236psa_status_t psa_pake_input(
8237 psa_pake_operation_t *operation,
8238 psa_pake_step_t step,
8239 const uint8_t *input,
8240 size_t input_length)
8241{
Przemek Stekiel51eac532022-12-07 11:04:51 +01008242 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008243 psa_crypto_driver_pake_step_t driver_step = PSA_JPAKE_STEP_INVALID;
Przemek Stekiel256c75d2023-03-23 14:09:34 +01008244 const size_t max_input_length = (size_t) PSA_PAKE_INPUT_SIZE(operation->alg,
8245 operation->primitive,
8246 step);
Przemek Stekiel51eac532022-12-07 11:04:51 +01008247
8248 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01008249 status = psa_pake_complete_inputs(operation);
8250 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008251 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008252 }
8253 }
8254
8255 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008256 status = PSA_ERROR_BAD_STATE;
8257 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008258 }
8259
Przemek Stekiel256c75d2023-03-23 14:09:34 +01008260 if (input_length == 0 || input_length > max_input_length) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008261 status = PSA_ERROR_INVALID_ARGUMENT;
8262 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008263 }
8264
Przemek Stekiele12ed362022-12-21 12:54:46 +01008265 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008266#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008267 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008268 status = psa_jpake_prologue(operation, step, PSA_JPAKE_INPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008269 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008270 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008271 }
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008272 driver_step = convert_jpake_computation_stage_to_driver_step(
8273 &operation->computation_stage.jpake);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008274 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008275#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008276 default:
Przemek Stekiel80a88492023-02-20 13:32:22 +01008277 (void) step;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008278 status = PSA_ERROR_NOT_SUPPORTED;
8279 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008280 }
8281
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008282 status = psa_driver_wrapper_pake_input(operation, driver_step,
8283 input, input_length);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008284
8285 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008286 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008287 }
8288
8289 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008290#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008291 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008292 status = psa_jpake_epilogue(operation, PSA_JPAKE_INPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008293 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008294 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008295 }
8296 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008297#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008298 default:
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008299 status = PSA_ERROR_NOT_SUPPORTED;
8300 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008301 }
8302
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008303 return PSA_SUCCESS;
8304exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008305 psa_pake_abort(operation);
8306 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008307}
8308
8309psa_status_t psa_pake_get_implicit_key(
8310 psa_pake_operation_t *operation,
8311 psa_key_derivation_operation_t *output)
8312{
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008313 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008314 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel251e86a2023-02-17 14:30:50 +01008315 uint8_t shared_key[MBEDTLS_PSA_JPAKE_BUFFER_SIZE];
Przemek Stekiel0c781802022-11-29 14:53:13 +01008316 size_t shared_key_len = 0;
8317
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008318 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008319 status = PSA_ERROR_BAD_STATE;
8320 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008321 }
8322
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008323#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008324 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008325 psa_jpake_computation_stage_t *computation_stage =
Przemek Stekiel083745e2023-02-23 17:28:23 +01008326 &operation->computation_stage.jpake;
David Horstmann5da95602023-06-08 15:37:12 +01008327 if (computation_stage->round != PSA_JPAKE_FINISHED) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008328 status = PSA_ERROR_BAD_STATE;
8329 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008330 }
Przemek Stekiel80a88492023-02-20 13:32:22 +01008331 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008332#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01008333 {
8334 status = PSA_ERROR_NOT_SUPPORTED;
8335 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008336 }
8337
Przemek Stekiel0c781802022-11-29 14:53:13 +01008338 status = psa_driver_wrapper_pake_get_implicit_key(operation,
8339 shared_key,
Przemek Stekiel6b648622023-02-19 22:55:33 +01008340 sizeof(shared_key),
Przemek Stekiel0c781802022-11-29 14:53:13 +01008341 &shared_key_len);
8342
8343 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008344 goto exit;
Przemek Stekiel0c781802022-11-29 14:53:13 +01008345 }
8346
8347 status = psa_key_derivation_input_bytes(output,
8348 PSA_KEY_DERIVATION_INPUT_SECRET,
8349 shared_key,
8350 shared_key_len);
8351
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008352 mbedtls_platform_zeroize(shared_key, sizeof(shared_key));
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008353exit:
8354 abort_status = psa_pake_abort(operation);
8355 return status == PSA_SUCCESS ? abort_status : status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008356}
8357
8358psa_status_t psa_pake_abort(
8359 psa_pake_operation_t *operation)
8360{
Przemek Stekield69dca92023-01-31 19:59:20 +01008361 psa_status_t status = PSA_SUCCESS;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008362
Przemek Stekield69dca92023-01-31 19:59:20 +01008363 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008364 status = psa_driver_wrapper_pake_abort(operation);
Neil Armstrong5ae60962022-09-15 11:29:46 +02008365 }
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008366
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008367 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
8368 if (operation->data.inputs.password != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01008369 mbedtls_zeroize_and_free(operation->data.inputs.password,
Przemek Stekielaa183422023-03-06 14:21:44 +01008370 operation->data.inputs.password_len);
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008371 }
8372 if (operation->data.inputs.user != NULL) {
8373 mbedtls_free(operation->data.inputs.user);
8374 }
8375 if (operation->data.inputs.peer != NULL) {
8376 mbedtls_free(operation->data.inputs.peer);
8377 }
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008378 }
Przemek Stekield69dca92023-01-31 19:59:20 +01008379 memset(operation, 0, sizeof(psa_pake_operation_t));
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008380
Przemek Stekield69dca92023-01-31 19:59:20 +01008381 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008382}
Tom Cosgrove6d62fac2023-05-10 14:40:05 +01008383#endif /* PSA_WANT_ALG_SOME_PAKE */
Neil Armstronga7d08c32022-06-01 18:21:20 +02008384
Gilles Peskinee59236f2018-01-27 23:32:46 +01008385#endif /* MBEDTLS_PSA_CRYPTO_C */