blob: 98823de4c65ef779c69ce00b919a9b54b48cf006 [file] [log] [blame]
Gilles Peskinee59236f2018-01-27 23:32:46 +01001/*
2 * PSA crypto layer on top of Mbed TLS crypto
3 */
Bence Szépkúti86974652020-06-15 11:59:37 +02004/*
Bence Szépkúti1e148272020-08-07 13:07:28 +02005 * Copyright The Mbed TLS Contributors
Dave Rodgman16799db2023-11-02 19:47:20 +00006 * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
Gilles Peskinee59236f2018-01-27 23:32:46 +01007 */
8
Gilles Peskinedb09ef62020-06-03 01:43:33 +02009#include "common.h"
Ronald Cronafbc7ed2023-01-24 16:02:04 +010010#include "psa_crypto_core_common.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010011
12#if defined(MBEDTLS_PSA_CRYPTO_C)
mohammad160327010052018-07-03 13:16:15 +030013
John Durkop07cc04a2020-11-16 22:08:34 -080014#if defined(MBEDTLS_PSA_CRYPTO_CONFIG)
15#include "check_crypto_config.h"
16#endif
17
Gilles Peskinee59236f2018-01-27 23:32:46 +010018#include "psa/crypto.h"
Przemyslaw Stekiel705fb0f2021-11-24 08:47:29 +010019#include "psa/crypto_values.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010020
Ronald Crond6d28882020-12-14 14:56:02 +010021#include "psa_crypto_cipher.h"
Gilles Peskine039b90c2018-12-07 18:24:41 +010022#include "psa_crypto_core.h"
Gilles Peskine5e769522018-11-20 21:59:56 +010023#include "psa_crypto_invasive.h"
Xiaokang Qiane9c39c42023-08-09 08:50:19 +000024#include "psa_crypto_driver_wrappers.h"
Xiaokang Qianfe9666b2023-09-11 10:36:20 +000025#include "psa_crypto_driver_wrappers_no_static.h"
Ronald Cron00b7bfc2020-11-25 15:25:26 +010026#include "psa_crypto_ecp.h"
Przemek Stekiel359f4622022-12-05 14:11:55 +010027#include "psa_crypto_ffdh.h"
Steven Cooreman5f88e772021-03-15 11:07:12 +010028#include "psa_crypto_hash.h"
Steven Cooreman82c66b62021-03-19 17:39:17 +010029#include "psa_crypto_mac.h"
Ronald Cron00b7bfc2020-11-25 15:25:26 +010030#include "psa_crypto_rsa.h"
Ronald Cron7023db52020-11-20 18:17:42 +010031#include "psa_crypto_ecp.h"
Gilles Peskinea8ade162019-06-26 11:24:49 +020032#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined0890212019-06-24 14:34:43 +020033#include "psa_crypto_se.h"
Gilles Peskinea8ade162019-06-26 11:24:49 +020034#endif
Gilles Peskine961849f2018-11-30 18:54:54 +010035#include "psa_crypto_slot_management.h"
Darryl Greend49a4992018-06-18 17:27:26 +010036/* Include internal declarations that are useful for implementing persistently
37 * stored keys. */
38#include "psa_crypto_storage.h"
39
Gilles Peskineb2b64d32020-12-14 16:43:58 +010040#include "psa_crypto_random_impl.h"
Gilles Peskine90edc992020-11-13 15:39:19 +010041
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010042#include <stdlib.h>
43#include <string.h>
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010044#include "mbedtls/platform.h"
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010045
Gilles Peskine1c49f1a2020-11-13 18:46:25 +010046#include "mbedtls/aes.h"
Gilles Peskine9a944802018-06-21 09:35:35 +020047#include "mbedtls/asn1.h"
Jaeden Amero25384a22019-01-10 10:23:21 +000048#include "mbedtls/asn1write.h"
Gilles Peskinea81d85b2018-06-26 16:10:23 +020049#include "mbedtls/bignum.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010050#include "mbedtls/camellia.h"
Gilles Peskine26869f22019-05-06 15:25:00 +020051#include "mbedtls/chacha20.h"
52#include "mbedtls/chachapoly.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010053#include "mbedtls/cipher.h"
54#include "mbedtls/ccm.h"
55#include "mbedtls/cmac.h"
Dave Rodgman78701152023-08-29 14:20:18 +010056#include "mbedtls/constant_time.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010057#include "mbedtls/des.h"
Gilles Peskineb7ecdf02018-09-18 12:11:27 +020058#include "mbedtls/ecdh.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010059#include "mbedtls/ecp.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010060#include "mbedtls/entropy.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010061#include "mbedtls/error.h"
62#include "mbedtls/gcm.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010063#include "mbedtls/md5.h"
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010064#include "mbedtls/pk.h"
Chris Jonesdaacb592021-03-09 17:03:29 +000065#include "pk_wrap.h"
Gilles Peskine3f108122018-12-07 18:14:53 +010066#include "mbedtls/platform_util.h"
Janos Follath24eed8d2019-11-22 13:21:35 +000067#include "mbedtls/error.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010068#include "mbedtls/ripemd160.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010069#include "mbedtls/rsa.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010070#include "mbedtls/sha1.h"
71#include "mbedtls/sha256.h"
72#include "mbedtls/sha512.h"
Valerio Setti384fbde2024-01-02 13:26:40 +010073#include "mbedtls/psa_util.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010074
Przemek Stekiel75fe3fb2022-06-09 14:44:55 +020075#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF) || \
76 defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT) || \
77 defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Przemek Stekiel69c46792022-06-10 12:59:51 +020078#define BUILTIN_ALG_ANY_HKDF 1
Przemek Stekiel75fe3fb2022-06-09 14:44:55 +020079#endif
80
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010081/****************************************************************/
82/* Global data, support functions and library management */
83/****************************************************************/
84
Gilles Peskine449bd832023-01-11 14:50:10 +010085static int key_type_is_raw_bytes(psa_key_type_t type)
Gilles Peskine48c0ea12018-06-21 14:15:31 +020086{
Gilles Peskine449bd832023-01-11 14:50:10 +010087 return PSA_KEY_TYPE_IS_UNSTRUCTURED(type);
Gilles Peskine48c0ea12018-06-21 14:15:31 +020088}
89
Gilles Peskine5a3c50e2018-12-04 12:27:09 +010090/* Values for psa_global_data_t::rng_state */
91#define RNG_NOT_INITIALIZED 0
92#define RNG_INITIALIZED 1
93#define RNG_SEEDED 2
Gilles Peskinec6b69072018-11-20 21:42:52 +010094
Gilles Peskine449bd832023-01-11 14:50:10 +010095typedef struct {
Dave Rodgman864f5942023-08-16 18:04:44 +010096 uint8_t initialized;
97 uint8_t rng_state;
98 uint8_t drivers_initialized;
Gilles Peskine2d8a1822021-11-08 22:20:03 +010099 mbedtls_psa_random_context_t rng;
Gilles Peskinee59236f2018-01-27 23:32:46 +0100100} psa_global_data_t;
101
102static psa_global_data_t global_data;
103
Gilles Peskine5894e8e2020-12-14 14:54:06 +0100104#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
105mbedtls_psa_drbg_context_t *const mbedtls_psa_random_state =
106 &global_data.rng.drbg;
107#endif
108
itayzafrir0adf0fc2018-09-06 16:24:41 +0300109#define GUARD_MODULE_INITIALIZED \
Gilles Peskine449bd832023-01-11 14:50:10 +0100110 if (global_data.initialized == 0) \
111 return PSA_ERROR_BAD_STATE;
itayzafrir0adf0fc2018-09-06 16:24:41 +0300112
Manuel Pégourié-Gonnard7abdf7e2023-03-09 11:17:43 +0100113int psa_can_do_hash(psa_algorithm_t hash_alg)
114{
115 (void) hash_alg;
116 return global_data.drivers_initialized;
117}
Valerio Settic6f004f2023-12-12 11:27:36 +0100118
Valerio Setti1fff4f22023-12-28 14:19:34 +0100119int psa_can_do_cipher(psa_key_type_t key_type, psa_algorithm_t cipher_alg)
Valerio Settic6f004f2023-12-12 11:27:36 +0100120{
Valerio Setti1fff4f22023-12-28 14:19:34 +0100121 (void) key_type;
Valerio Settic6f004f2023-12-12 11:27:36 +0100122 (void) cipher_alg;
123 return global_data.drivers_initialized;
124}
125
126
Valerio Settia55f0422023-07-10 15:34:41 +0200127#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_IMPORT) || \
Przemek Stekiel53410502023-04-28 13:18:43 +0200128 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY) || \
Valerio Settia55f0422023-07-10 15:34:41 +0200129 defined(PSA_WANT_KEY_TYPE_DH_KEY_PAIR_GENERATE)
Przemek Stekiel134cc2e2023-05-05 10:13:37 +0200130static int psa_is_dh_key_size_valid(size_t bits)
131{
Valerio Setti504a1022024-01-17 15:19:30 +0100132 switch (bits) {
133#if defined(PSA_WANT_DH_RFC7919_2048)
134 case 2048:
135 return 1;
136#endif /* PSA_WANT_DH_RFC7919_2048 */
137#if defined(PSA_WANT_DH_RFC7919_3072)
138 case 3072:
139 return 1;
140#endif /* PSA_WANT_DH_RFC7919_3072 */
141#if defined(PSA_WANT_DH_RFC7919_4096)
142 case 4096:
143 return 1;
144#endif /* PSA_WANT_DH_RFC7919_4096 */
145#if defined(PSA_WANT_DH_RFC7919_6144)
146 case 6144:
147 return 1;
148#endif /* PSA_WANT_DH_RFC7919_6144 */
149#if defined(PSA_WANT_DH_RFC7919_8192)
150 case 8192:
151 return 1;
152#endif /* PSA_WANT_DH_RFC7919_8192 */
153 default:
154 return 0;
Przemek Stekield1cf1ba2023-04-27 12:04:21 +0200155 }
Przemek Stekield1cf1ba2023-04-27 12:04:21 +0200156}
Valerio Settia55f0422023-07-10 15:34:41 +0200157#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_IMPORT ||
Przemek Stekiel53410502023-04-28 13:18:43 +0200158 MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY ||
Valerio Settia55f0422023-07-10 15:34:41 +0200159 PSA_WANT_KEY_TYPE_DH_KEY_PAIR_GENERATE */
Manuel Pégourié-Gonnard7abdf7e2023-03-09 11:17:43 +0100160
Gilles Peskine449bd832023-01-11 14:50:10 +0100161psa_status_t mbedtls_to_psa_error(int ret)
Gilles Peskinee59236f2018-01-27 23:32:46 +0100162{
Gilles Peskinedbf68962021-01-06 20:04:23 +0100163 /* Mbed TLS error codes can combine a high-level error code and a
164 * low-level error code. The low-level error usually reflects the
165 * root cause better, so dispatch on that preferably. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100166 int low_level_ret = -(-ret & 0x007f);
167 switch (low_level_ret != 0 ? low_level_ret : ret) {
Gilles Peskinee59236f2018-01-27 23:32:46 +0100168 case 0:
Gilles Peskine449bd832023-01-11 14:50:10 +0100169 return PSA_SUCCESS;
Gilles Peskinea5905292018-02-07 20:59:33 +0100170
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100171#if defined(MBEDTLS_AES_C)
Gilles Peskinea5905292018-02-07 20:59:33 +0100172 case MBEDTLS_ERR_AES_INVALID_KEY_LENGTH:
173 case MBEDTLS_ERR_AES_INVALID_INPUT_LENGTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100174 return PSA_ERROR_NOT_SUPPORTED;
Dave Rodgman09a9e582023-08-31 11:05:22 +0100175 case MBEDTLS_ERR_AES_BAD_INPUT_DATA:
176 return PSA_ERROR_INVALID_ARGUMENT;
Dave Rodgman509b5672023-08-16 19:26:23 +0100177#endif
178
179#if defined(MBEDTLS_ASN1_PARSE_C) || defined(MBEDTLS_ASN1_WRITE_C)
Gilles Peskine9a944802018-06-21 09:35:35 +0200180 case MBEDTLS_ERR_ASN1_OUT_OF_DATA:
181 case MBEDTLS_ERR_ASN1_UNEXPECTED_TAG:
182 case MBEDTLS_ERR_ASN1_INVALID_LENGTH:
183 case MBEDTLS_ERR_ASN1_LENGTH_MISMATCH:
184 case MBEDTLS_ERR_ASN1_INVALID_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100185 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine9a944802018-06-21 09:35:35 +0200186 case MBEDTLS_ERR_ASN1_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100187 return PSA_ERROR_INSUFFICIENT_MEMORY;
Gilles Peskine9a944802018-06-21 09:35:35 +0200188 case MBEDTLS_ERR_ASN1_BUF_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +0100189 return PSA_ERROR_BUFFER_TOO_SMALL;
Dave Rodgman509b5672023-08-16 19:26:23 +0100190#endif
Gilles Peskine9a944802018-06-21 09:35:35 +0200191
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100192#if defined(MBEDTLS_CAMELLIA_C)
Jaeden Amero892cd6d2019-02-11 12:21:12 +0000193 case MBEDTLS_ERR_CAMELLIA_BAD_INPUT_DATA:
Gilles Peskinea5905292018-02-07 20:59:33 +0100194 case MBEDTLS_ERR_CAMELLIA_INVALID_INPUT_LENGTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100195 return PSA_ERROR_NOT_SUPPORTED;
Dave Rodgman509b5672023-08-16 19:26:23 +0100196#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100197
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100198#if defined(MBEDTLS_CCM_C)
Gilles Peskinea5905292018-02-07 20:59:33 +0100199 case MBEDTLS_ERR_CCM_BAD_INPUT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100200 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100201 case MBEDTLS_ERR_CCM_AUTH_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100202 return PSA_ERROR_INVALID_SIGNATURE;
Dave Rodgman509b5672023-08-16 19:26:23 +0100203#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100204
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100205#if defined(MBEDTLS_CHACHA20_C)
Gilles Peskine26869f22019-05-06 15:25:00 +0200206 case MBEDTLS_ERR_CHACHA20_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100207 return PSA_ERROR_INVALID_ARGUMENT;
Dave Rodgman509b5672023-08-16 19:26:23 +0100208#endif
Gilles Peskine26869f22019-05-06 15:25:00 +0200209
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100210#if defined(MBEDTLS_CHACHAPOLY_C)
Gilles Peskine26869f22019-05-06 15:25:00 +0200211 case MBEDTLS_ERR_CHACHAPOLY_BAD_STATE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100212 return PSA_ERROR_BAD_STATE;
Gilles Peskine26869f22019-05-06 15:25:00 +0200213 case MBEDTLS_ERR_CHACHAPOLY_AUTH_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100214 return PSA_ERROR_INVALID_SIGNATURE;
Dave Rodgman509b5672023-08-16 19:26:23 +0100215#endif
Gilles Peskine26869f22019-05-06 15:25:00 +0200216
Dave Rodgman509b5672023-08-16 19:26:23 +0100217#if defined(MBEDTLS_CIPHER_C)
Gilles Peskinea5905292018-02-07 20:59:33 +0100218 case MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100219 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea5905292018-02-07 20:59:33 +0100220 case MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100221 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100222 case MBEDTLS_ERR_CIPHER_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100223 return PSA_ERROR_INSUFFICIENT_MEMORY;
Gilles Peskinea5905292018-02-07 20:59:33 +0100224 case MBEDTLS_ERR_CIPHER_INVALID_PADDING:
Gilles Peskine449bd832023-01-11 14:50:10 +0100225 return PSA_ERROR_INVALID_PADDING;
Gilles Peskinea5905292018-02-07 20:59:33 +0100226 case MBEDTLS_ERR_CIPHER_FULL_BLOCK_EXPECTED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100227 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100228 case MBEDTLS_ERR_CIPHER_AUTH_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100229 return PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskinea5905292018-02-07 20:59:33 +0100230 case MBEDTLS_ERR_CIPHER_INVALID_CONTEXT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100231 return PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman509b5672023-08-16 19:26:23 +0100232#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100233
Gilles Peskine449bd832023-01-11 14:50:10 +0100234#if !(defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) || \
235 defined(MBEDTLS_PSA_HMAC_DRBG_MD_TYPE))
Gilles Peskinebee96c82020-11-23 21:00:09 +0100236 /* Only check CTR_DRBG error codes if underlying mbedtls_xxx
237 * functions are passed a CTR_DRBG instance. */
Gilles Peskinea5905292018-02-07 20:59:33 +0100238 case MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100239 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskinea5905292018-02-07 20:59:33 +0100240 case MBEDTLS_ERR_CTR_DRBG_REQUEST_TOO_BIG:
241 case MBEDTLS_ERR_CTR_DRBG_INPUT_TOO_BIG:
Gilles Peskine449bd832023-01-11 14:50:10 +0100242 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea5905292018-02-07 20:59:33 +0100243 case MBEDTLS_ERR_CTR_DRBG_FILE_IO_ERROR:
Gilles Peskine449bd832023-01-11 14:50:10 +0100244 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskine82e57d12020-11-13 21:31:17 +0100245#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100246
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100247#if defined(MBEDTLS_DES_C)
Gilles Peskinea5905292018-02-07 20:59:33 +0100248 case MBEDTLS_ERR_DES_INVALID_INPUT_LENGTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100249 return PSA_ERROR_NOT_SUPPORTED;
Dave Rodgman509b5672023-08-16 19:26:23 +0100250#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100251
Gilles Peskinee59236f2018-01-27 23:32:46 +0100252 case MBEDTLS_ERR_ENTROPY_NO_SOURCES_DEFINED:
253 case MBEDTLS_ERR_ENTROPY_NO_STRONG_SOURCE:
254 case MBEDTLS_ERR_ENTROPY_SOURCE_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100255 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskinea5905292018-02-07 20:59:33 +0100256
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100257#if defined(MBEDTLS_GCM_C)
Gilles Peskinea5905292018-02-07 20:59:33 +0100258 case MBEDTLS_ERR_GCM_AUTH_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100259 return PSA_ERROR_INVALID_SIGNATURE;
Mateusz Starzykf28261f2021-09-30 16:39:07 +0200260 case MBEDTLS_ERR_GCM_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +0100261 return PSA_ERROR_BUFFER_TOO_SMALL;
Gilles Peskinea5905292018-02-07 20:59:33 +0100262 case MBEDTLS_ERR_GCM_BAD_INPUT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100263 return PSA_ERROR_INVALID_ARGUMENT;
Dave Rodgman509b5672023-08-16 19:26:23 +0100264#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100265
Gilles Peskine82e57d12020-11-13 21:31:17 +0100266#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) && \
Gilles Peskine449bd832023-01-11 14:50:10 +0100267 defined(MBEDTLS_PSA_HMAC_DRBG_MD_TYPE)
Gilles Peskinebee96c82020-11-23 21:00:09 +0100268 /* Only check HMAC_DRBG error codes if underlying mbedtls_xxx
269 * functions are passed a HMAC_DRBG instance. */
Gilles Peskine82e57d12020-11-13 21:31:17 +0100270 case MBEDTLS_ERR_HMAC_DRBG_ENTROPY_SOURCE_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100271 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskine82e57d12020-11-13 21:31:17 +0100272 case MBEDTLS_ERR_HMAC_DRBG_REQUEST_TOO_BIG:
273 case MBEDTLS_ERR_HMAC_DRBG_INPUT_TOO_BIG:
Gilles Peskine449bd832023-01-11 14:50:10 +0100274 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine82e57d12020-11-13 21:31:17 +0100275 case MBEDTLS_ERR_HMAC_DRBG_FILE_IO_ERROR:
Gilles Peskine449bd832023-01-11 14:50:10 +0100276 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskine82e57d12020-11-13 21:31:17 +0100277#endif
278
Dave Rodgmandea266f2023-08-31 11:52:43 +0100279#if defined(MBEDTLS_MD_LIGHT)
Gilles Peskinea5905292018-02-07 20:59:33 +0100280 case MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100281 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea5905292018-02-07 20:59:33 +0100282 case MBEDTLS_ERR_MD_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100283 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100284 case MBEDTLS_ERR_MD_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100285 return PSA_ERROR_INSUFFICIENT_MEMORY;
Dave Rodgman509b5672023-08-16 19:26:23 +0100286#if defined(MBEDTLS_FS_IO)
Gilles Peskinea5905292018-02-07 20:59:33 +0100287 case MBEDTLS_ERR_MD_FILE_IO_ERROR:
Gilles Peskine449bd832023-01-11 14:50:10 +0100288 return PSA_ERROR_STORAGE_FAILURE;
Dave Rodgman509b5672023-08-16 19:26:23 +0100289#endif
290#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100291
Dave Rodgman509b5672023-08-16 19:26:23 +0100292#if defined(MBEDTLS_BIGNUM_C)
293#if defined(MBEDTLS_FS_IO)
Gilles Peskinef76aa772018-10-29 19:24:33 +0100294 case MBEDTLS_ERR_MPI_FILE_IO_ERROR:
Gilles Peskine449bd832023-01-11 14:50:10 +0100295 return PSA_ERROR_STORAGE_FAILURE;
Dave Rodgman509b5672023-08-16 19:26:23 +0100296#endif
Gilles Peskinef76aa772018-10-29 19:24:33 +0100297 case MBEDTLS_ERR_MPI_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100298 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100299 case MBEDTLS_ERR_MPI_INVALID_CHARACTER:
Gilles Peskine449bd832023-01-11 14:50:10 +0100300 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100301 case MBEDTLS_ERR_MPI_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +0100302 return PSA_ERROR_BUFFER_TOO_SMALL;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100303 case MBEDTLS_ERR_MPI_NEGATIVE_VALUE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100304 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100305 case MBEDTLS_ERR_MPI_DIVISION_BY_ZERO:
Gilles Peskine449bd832023-01-11 14:50:10 +0100306 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100307 case MBEDTLS_ERR_MPI_NOT_ACCEPTABLE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100308 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100309 case MBEDTLS_ERR_MPI_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100310 return PSA_ERROR_INSUFFICIENT_MEMORY;
Dave Rodgman509b5672023-08-16 19:26:23 +0100311#endif
Gilles Peskinef76aa772018-10-29 19:24:33 +0100312
Dave Rodgman509b5672023-08-16 19:26:23 +0100313#if defined(MBEDTLS_PK_C)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100314 case MBEDTLS_ERR_PK_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100315 return PSA_ERROR_INSUFFICIENT_MEMORY;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100316 case MBEDTLS_ERR_PK_TYPE_MISMATCH:
317 case MBEDTLS_ERR_PK_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100318 return PSA_ERROR_INVALID_ARGUMENT;
Dave Rodgman509b5672023-08-16 19:26:23 +0100319#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) || defined(MBEDTLS_FS_IO) || \
320 defined(MBEDTLS_PSA_ITS_FILE_C)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100321 case MBEDTLS_ERR_PK_FILE_IO_ERROR:
Gilles Peskine449bd832023-01-11 14:50:10 +0100322 return PSA_ERROR_STORAGE_FAILURE;
Dave Rodgman509b5672023-08-16 19:26:23 +0100323#endif
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100324 case MBEDTLS_ERR_PK_KEY_INVALID_VERSION:
325 case MBEDTLS_ERR_PK_KEY_INVALID_FORMAT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100326 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100327 case MBEDTLS_ERR_PK_UNKNOWN_PK_ALG:
Gilles Peskine449bd832023-01-11 14:50:10 +0100328 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100329 case MBEDTLS_ERR_PK_PASSWORD_REQUIRED:
330 case MBEDTLS_ERR_PK_PASSWORD_MISMATCH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100331 return PSA_ERROR_NOT_PERMITTED;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100332 case MBEDTLS_ERR_PK_INVALID_PUBKEY:
Gilles Peskine449bd832023-01-11 14:50:10 +0100333 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100334 case MBEDTLS_ERR_PK_INVALID_ALG:
335 case MBEDTLS_ERR_PK_UNKNOWN_NAMED_CURVE:
336 case MBEDTLS_ERR_PK_FEATURE_UNAVAILABLE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100337 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100338 case MBEDTLS_ERR_PK_SIG_LEN_MISMATCH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100339 return PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskinef9f1bdf2021-06-23 20:32:27 +0200340 case MBEDTLS_ERR_PK_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +0100341 return PSA_ERROR_BUFFER_TOO_SMALL;
Dave Rodgman509b5672023-08-16 19:26:23 +0100342#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100343
Gilles Peskineff2d2002019-05-06 15:26:23 +0200344 case MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100345 return PSA_ERROR_HARDWARE_FAILURE;
Gilles Peskineff2d2002019-05-06 15:26:23 +0200346 case MBEDTLS_ERR_PLATFORM_FEATURE_UNSUPPORTED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100347 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskineff2d2002019-05-06 15:26:23 +0200348
Dave Rodgman509b5672023-08-16 19:26:23 +0100349#if defined(MBEDTLS_RSA_C)
Gilles Peskinea5905292018-02-07 20:59:33 +0100350 case MBEDTLS_ERR_RSA_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100351 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100352 case MBEDTLS_ERR_RSA_INVALID_PADDING:
Gilles Peskine449bd832023-01-11 14:50:10 +0100353 return PSA_ERROR_INVALID_PADDING;
Gilles Peskinea5905292018-02-07 20:59:33 +0100354 case MBEDTLS_ERR_RSA_KEY_GEN_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100355 return PSA_ERROR_HARDWARE_FAILURE;
Gilles Peskinea5905292018-02-07 20:59:33 +0100356 case MBEDTLS_ERR_RSA_KEY_CHECK_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100357 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100358 case MBEDTLS_ERR_RSA_PUBLIC_FAILED:
359 case MBEDTLS_ERR_RSA_PRIVATE_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100360 return PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinea5905292018-02-07 20:59:33 +0100361 case MBEDTLS_ERR_RSA_VERIFY_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100362 return PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskinea5905292018-02-07 20:59:33 +0100363 case MBEDTLS_ERR_RSA_OUTPUT_TOO_LARGE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100364 return PSA_ERROR_BUFFER_TOO_SMALL;
Gilles Peskinea5905292018-02-07 20:59:33 +0100365 case MBEDTLS_ERR_RSA_RNG_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100366 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Dave Rodgman509b5672023-08-16 19:26:23 +0100367#endif
Manuel Pégourié-Gonnard93c08472021-04-15 12:23:55 +0200368
Dave Rodgman1dab4452023-09-01 09:59:51 +0100369#if defined(MBEDTLS_ECP_LIGHT)
itayzafrir5c753392018-05-08 11:18:38 +0300370 case MBEDTLS_ERR_ECP_BAD_INPUT_DATA:
itayzafrir7b30f8b2018-05-09 16:07:36 +0300371 case MBEDTLS_ERR_ECP_INVALID_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +0100372 return PSA_ERROR_INVALID_ARGUMENT;
itayzafrir7b30f8b2018-05-09 16:07:36 +0300373 case MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +0100374 return PSA_ERROR_BUFFER_TOO_SMALL;
itayzafrir7b30f8b2018-05-09 16:07:36 +0300375 case MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100376 return PSA_ERROR_NOT_SUPPORTED;
itayzafrir7b30f8b2018-05-09 16:07:36 +0300377 case MBEDTLS_ERR_ECP_SIG_LEN_MISMATCH:
378 case MBEDTLS_ERR_ECP_VERIFY_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100379 return PSA_ERROR_INVALID_SIGNATURE;
itayzafrir7b30f8b2018-05-09 16:07:36 +0300380 case MBEDTLS_ERR_ECP_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100381 return PSA_ERROR_INSUFFICIENT_MEMORY;
Gilles Peskine40d81602020-11-25 00:09:47 +0100382 case MBEDTLS_ERR_ECP_RANDOM_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100383 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskine40d81602020-11-25 00:09:47 +0100384
Dave Rodgman509b5672023-08-16 19:26:23 +0100385#if defined(MBEDTLS_ECP_RESTARTABLE)
Paul Elliott588f8ed2022-12-02 18:10:26 +0000386 case MBEDTLS_ERR_ECP_IN_PROGRESS:
387 return PSA_OPERATION_INCOMPLETE;
Dave Rodgman509b5672023-08-16 19:26:23 +0100388#endif
389#endif
Paul Elliott588f8ed2022-12-02 18:10:26 +0000390
Janos Follatha13b9052019-11-22 12:48:59 +0000391 case MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100392 return PSA_ERROR_CORRUPTION_DETECTED;
itayzafrir5c753392018-05-08 11:18:38 +0300393
Gilles Peskinee59236f2018-01-27 23:32:46 +0100394 default:
Gilles Peskine449bd832023-01-11 14:50:10 +0100395 return PSA_ERROR_GENERIC_ERROR;
Gilles Peskinee59236f2018-01-27 23:32:46 +0100396 }
397}
398
Paul Elliottdc42ca82023-02-24 18:11:59 +0000399/**
400 * \brief For output buffers which contain "tags"
401 * (outputs that may be checked for validity like
402 * hashes, MACs and signatures), fill the unused
403 * part of the output buffer (the whole buffer on
404 * error, the trailing part on success) with
405 * something that isn't a valid tag (barring an
406 * attack on the tag and deliberately-crafted
407 * input), in case the caller doesn't check the
408 * return status properly.
409 *
410 * \param output_buffer Pointer to buffer to wipe. May not be NULL
411 * unless \p output_buffer_size is zero.
412 * \param status Status of function called to generate
413 * output_buffer originally
414 * \param output_buffer_size Size of output buffer. If zero, \p output_buffer
415 * could be NULL.
416 * \param output_buffer_length Length of data written to output_buffer, must be
417 * less than \p output_buffer_size
418 */
419static void psa_wipe_tag_output_buffer(uint8_t *output_buffer, psa_status_t status,
Paul Elliott7118d172023-02-26 16:57:05 +0000420 size_t output_buffer_size, size_t output_buffer_length)
421{
Paul Elliottdc42ca82023-02-24 18:11:59 +0000422 size_t offset = 0;
423
424 if (output_buffer_size == 0) {
425 /* If output_buffer_size is 0 then we have nothing to do. We must not
426 call memset because output_buffer may be NULL in this case */
427 return;
428 }
429
430 if (status == PSA_SUCCESS) {
431 offset = output_buffer_length;
432 }
433
434 memset(output_buffer + offset, '!', output_buffer_size - offset);
435}
436
Gilles Peskineb0b255c2018-07-06 17:01:38 +0200437
Gilles Peskine449bd832023-01-11 14:50:10 +0100438psa_status_t psa_validate_unstructured_key_bit_size(psa_key_type_t type,
439 size_t bits)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200440{
441 /* Check that the bit size is acceptable for the key type */
Gilles Peskine449bd832023-01-11 14:50:10 +0100442 switch (type) {
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200443 case PSA_KEY_TYPE_RAW_DATA:
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200444 case PSA_KEY_TYPE_HMAC:
Gilles Peskineea0fb492018-07-12 17:17:20 +0200445 case PSA_KEY_TYPE_DERIVE:
Neil Armstrong4b5710f2022-05-25 11:30:27 +0200446 case PSA_KEY_TYPE_PASSWORD:
447 case PSA_KEY_TYPE_PASSWORD_HASH:
Gilles Peskineea0fb492018-07-12 17:17:20 +0200448 break;
Ronald Cron1f0db802021-03-12 09:59:30 +0100449#if defined(PSA_WANT_KEY_TYPE_AES)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200450 case PSA_KEY_TYPE_AES:
Gilles Peskine449bd832023-01-11 14:50:10 +0100451 if (bits != 128 && bits != 192 && bits != 256) {
452 return PSA_ERROR_INVALID_ARGUMENT;
453 }
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200454 break;
455#endif
Gilles Peskine6c12a1e2021-09-21 11:59:39 +0200456#if defined(PSA_WANT_KEY_TYPE_ARIA)
457 case PSA_KEY_TYPE_ARIA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100458 if (bits != 128 && bits != 192 && bits != 256) {
459 return PSA_ERROR_INVALID_ARGUMENT;
460 }
Gilles Peskine6c12a1e2021-09-21 11:59:39 +0200461 break;
462#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100463#if defined(PSA_WANT_KEY_TYPE_CAMELLIA)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200464 case PSA_KEY_TYPE_CAMELLIA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100465 if (bits != 128 && bits != 192 && bits != 256) {
466 return PSA_ERROR_INVALID_ARGUMENT;
467 }
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200468 break;
469#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100470#if defined(PSA_WANT_KEY_TYPE_DES)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200471 case PSA_KEY_TYPE_DES:
Gilles Peskine449bd832023-01-11 14:50:10 +0100472 if (bits != 64 && bits != 128 && bits != 192) {
473 return PSA_ERROR_INVALID_ARGUMENT;
474 }
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200475 break;
476#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100477#if defined(PSA_WANT_KEY_TYPE_CHACHA20)
Gilles Peskine26869f22019-05-06 15:25:00 +0200478 case PSA_KEY_TYPE_CHACHA20:
Gilles Peskine449bd832023-01-11 14:50:10 +0100479 if (bits != 256) {
480 return PSA_ERROR_INVALID_ARGUMENT;
481 }
Gilles Peskine26869f22019-05-06 15:25:00 +0200482 break;
483#endif
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200484 default:
Gilles Peskine449bd832023-01-11 14:50:10 +0100485 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200486 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100487 if (bits % 8 != 0) {
488 return PSA_ERROR_INVALID_ARGUMENT;
489 }
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200490
Gilles Peskine449bd832023-01-11 14:50:10 +0100491 return PSA_SUCCESS;
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200492}
493
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100494/** Check whether a given key type is valid for use with a given MAC algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100495 *
Steven Cooremancd640932021-03-08 12:00:27 +0100496 * Upon successful return of this function, the behavior of #PSA_MAC_LENGTH
497 * when called with the validated \p algorithm and \p key_type is well-defined.
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100498 *
499 * \param[in] algorithm The specific MAC algorithm (can be wildcard).
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100500 * \param[in] key_type The key type of the key to be used with the
501 * \p algorithm.
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100502 *
503 * \retval #PSA_SUCCESS
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100504 * The \p key_type is valid for use with the \p algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100505 * \retval #PSA_ERROR_INVALID_ARGUMENT
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100506 * The \p key_type is not valid for use with the \p algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100507 */
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100508MBEDTLS_STATIC_TESTABLE psa_status_t psa_mac_key_can_do(
Steven Cooreman58c94d32021-03-02 21:31:17 +0100509 psa_algorithm_t algorithm,
Gilles Peskine449bd832023-01-11 14:50:10 +0100510 psa_key_type_t key_type)
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100511{
Gilles Peskine449bd832023-01-11 14:50:10 +0100512 if (PSA_ALG_IS_HMAC(algorithm)) {
513 if (key_type == PSA_KEY_TYPE_HMAC) {
514 return PSA_SUCCESS;
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100515 }
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100516 }
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100517
Gilles Peskine449bd832023-01-11 14:50:10 +0100518 if (PSA_ALG_IS_BLOCK_CIPHER_MAC(algorithm)) {
519 /* Check that we're calling PSA_BLOCK_CIPHER_BLOCK_LENGTH with a cipher
520 * key. */
521 if ((key_type & PSA_KEY_TYPE_CATEGORY_MASK) ==
522 PSA_KEY_TYPE_CATEGORY_SYMMETRIC) {
523 /* PSA_BLOCK_CIPHER_BLOCK_LENGTH returns 1 for stream ciphers and
524 * the block length (larger than 1) for block ciphers. */
525 if (PSA_BLOCK_CIPHER_BLOCK_LENGTH(key_type) > 1) {
526 return PSA_SUCCESS;
527 }
528 }
529 }
530
531 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100532}
533
Gilles Peskine449bd832023-01-11 14:50:10 +0100534psa_status_t psa_allocate_buffer_to_slot(psa_key_slot_t *slot,
535 size_t buffer_length)
Steven Cooreman75b74362020-07-28 14:30:13 +0200536{
Gilles Peskine449bd832023-01-11 14:50:10 +0100537 if (slot->key.data != NULL) {
538 return PSA_ERROR_ALREADY_EXISTS;
539 }
Steven Cooreman75b74362020-07-28 14:30:13 +0200540
Gilles Peskine449bd832023-01-11 14:50:10 +0100541 slot->key.data = mbedtls_calloc(1, buffer_length);
542 if (slot->key.data == NULL) {
543 return PSA_ERROR_INSUFFICIENT_MEMORY;
544 }
Steven Cooreman75b74362020-07-28 14:30:13 +0200545
Ronald Cronea0f8a62020-11-25 17:52:23 +0100546 slot->key.bytes = buffer_length;
Gilles Peskine449bd832023-01-11 14:50:10 +0100547 return PSA_SUCCESS;
Steven Cooreman75b74362020-07-28 14:30:13 +0200548}
549
Gilles Peskine449bd832023-01-11 14:50:10 +0100550psa_status_t psa_copy_key_material_into_slot(psa_key_slot_t *slot,
551 const uint8_t *data,
552 size_t data_length)
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200553{
Gilles Peskine449bd832023-01-11 14:50:10 +0100554 psa_status_t status = psa_allocate_buffer_to_slot(slot,
555 data_length);
556 if (status != PSA_SUCCESS) {
557 return status;
558 }
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200559
Gilles Peskine449bd832023-01-11 14:50:10 +0100560 memcpy(slot->key.data, data, data_length);
561 return PSA_SUCCESS;
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200562}
563
Ronald Crona0fe59f2020-11-29 11:14:53 +0100564psa_status_t psa_import_key_into_slot(
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100565 const psa_key_attributes_t *attributes,
566 const uint8_t *data, size_t data_length,
567 uint8_t *key_buffer, size_t key_buffer_size,
Gilles Peskine449bd832023-01-11 14:50:10 +0100568 size_t *key_buffer_length, size_t *bits)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100569{
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100570 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
571 psa_key_type_t type = attributes->core.type;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100572
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200573 /* zero-length keys are never supported. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100574 if (data_length == 0) {
575 return PSA_ERROR_NOT_SUPPORTED;
576 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200577
Gilles Peskine449bd832023-01-11 14:50:10 +0100578 if (key_type_is_raw_bytes(type)) {
579 *bits = PSA_BYTES_TO_BITS(data_length);
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200580
Gilles Peskine449bd832023-01-11 14:50:10 +0100581 status = psa_validate_unstructured_key_bit_size(attributes->core.type,
582 *bits);
583 if (status != PSA_SUCCESS) {
584 return status;
585 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200586
Ronald Crondd04d422020-11-28 15:14:42 +0100587 /* Copy the key material. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100588 memcpy(key_buffer, data, data_length);
Ronald Crondd04d422020-11-28 15:14:42 +0100589 *key_buffer_length = data_length;
Gilles Peskine449bd832023-01-11 14:50:10 +0100590 (void) key_buffer_size;
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200591
Gilles Peskine449bd832023-01-11 14:50:10 +0100592 return PSA_SUCCESS;
593 } else if (PSA_KEY_TYPE_IS_ASYMMETRIC(type)) {
Valerio Settia55f0422023-07-10 15:34:41 +0200594#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_IMPORT) || \
Przemek Stekiel6d85afa2023-04-28 11:42:17 +0200595 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY)
Przemek Stekiel472b3f32022-12-01 14:38:49 +0100596 if (PSA_KEY_TYPE_IS_DH(type)) {
Przemek Stekield1cf1ba2023-04-27 12:04:21 +0200597 if (psa_is_dh_key_size_valid(PSA_BYTES_TO_BITS(data_length)) == 0) {
Valerio Setti504a1022024-01-17 15:19:30 +0100598 return PSA_ERROR_NOT_SUPPORTED;
Przemek Stekiel472b3f32022-12-01 14:38:49 +0100599 }
Przemek Stekiel33c91eb2023-05-30 15:16:35 +0200600 return mbedtls_psa_ffdh_import_key(attributes,
601 data, data_length,
602 key_buffer, key_buffer_size,
603 key_buffer_length,
604 bits);
Przemek Stekiel472b3f32022-12-01 14:38:49 +0100605 }
Valerio Settia55f0422023-07-10 15:34:41 +0200606#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_IMPORT) ||
Przemek Stekiel6d85afa2023-04-28 11:42:17 +0200607 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY) */
Valerio Setti27c501a2023-06-27 16:58:52 +0200608#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_IMPORT) || \
Gilles Peskine449bd832023-01-11 14:50:10 +0100609 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
610 if (PSA_KEY_TYPE_IS_ECC(type)) {
611 return mbedtls_psa_ecp_import_key(attributes,
612 data, data_length,
613 key_buffer, key_buffer_size,
614 key_buffer_length,
615 bits);
Steven Cooreman40120f62020-10-29 11:42:22 +0100616 }
Valerio Setti27c501a2023-06-27 16:58:52 +0200617#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_IMPORT) ||
John Durkop9814fa22020-11-04 12:28:15 -0800618 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
Valerio Settife478902023-07-25 12:27:19 +0200619#if (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) && \
620 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) || \
Gilles Peskine449bd832023-01-11 14:50:10 +0100621 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
622 if (PSA_KEY_TYPE_IS_RSA(type)) {
623 return mbedtls_psa_rsa_import_key(attributes,
624 data, data_length,
625 key_buffer, key_buffer_size,
626 key_buffer_length,
627 bits);
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200628 }
Valerio Settife478902023-07-25 12:27:19 +0200629#endif /* (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) &&
630 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) ||
John Durkop9814fa22020-11-04 12:28:15 -0800631 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100632 }
Steven Cooreman40120f62020-10-29 11:42:22 +0100633
Gilles Peskine449bd832023-01-11 14:50:10 +0100634 return PSA_ERROR_NOT_SUPPORTED;
Darryl Green06fd18d2018-07-16 11:21:11 +0100635}
636
Gilles Peskinef603c712019-01-19 13:40:11 +0100637/** Calculate the intersection of two algorithm usage policies.
638 *
639 * Return 0 (which allows no operation) on incompatibility.
640 */
641static psa_algorithm_t psa_key_policy_algorithm_intersection(
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100642 psa_key_type_t key_type,
Gilles Peskinef603c712019-01-19 13:40:11 +0100643 psa_algorithm_t alg1,
Gilles Peskine449bd832023-01-11 14:50:10 +0100644 psa_algorithm_t alg2)
Gilles Peskinef603c712019-01-19 13:40:11 +0100645{
Gilles Peskine549ea862019-05-22 11:45:59 +0200646 /* Common case: both sides actually specify the same policy. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100647 if (alg1 == alg2) {
648 return alg1;
649 }
Steven Cooreman03488022021-02-18 12:07:20 +0100650 /* If the policies are from the same hash-and-sign family, check
651 * if one is a wildcard. If so the other has the specific algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100652 if (PSA_ALG_IS_SIGN_HASH(alg1) &&
653 PSA_ALG_IS_SIGN_HASH(alg2) &&
654 (alg1 & ~PSA_ALG_HASH_MASK) == (alg2 & ~PSA_ALG_HASH_MASK)) {
655 if (PSA_ALG_SIGN_GET_HASH(alg1) == PSA_ALG_ANY_HASH) {
656 return alg2;
657 }
658 if (PSA_ALG_SIGN_GET_HASH(alg2) == PSA_ALG_ANY_HASH) {
659 return alg1;
660 }
Steven Cooreman03488022021-02-18 12:07:20 +0100661 }
662 /* If the policies are from the same AEAD family, check whether
Steven Cooreman7de9e2d2021-02-22 17:05:56 +0100663 * one of them is a minimum-tag-length wildcard. Calculate the most
Steven Cooreman03488022021-02-18 12:07:20 +0100664 * restrictive tag length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100665 if (PSA_ALG_IS_AEAD(alg1) && PSA_ALG_IS_AEAD(alg2) &&
666 (PSA_ALG_AEAD_WITH_SHORTENED_TAG(alg1, 0) ==
667 PSA_ALG_AEAD_WITH_SHORTENED_TAG(alg2, 0))) {
668 size_t alg1_len = PSA_ALG_AEAD_GET_TAG_LENGTH(alg1);
669 size_t alg2_len = PSA_ALG_AEAD_GET_TAG_LENGTH(alg2);
Steven Cooremancd640932021-03-08 12:00:27 +0100670 size_t restricted_len = alg1_len > alg2_len ? alg1_len : alg2_len;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100671
Steven Cooreman7de9e2d2021-02-22 17:05:56 +0100672 /* If both are wildcards, return most restrictive wildcard */
Gilles Peskine449bd832023-01-11 14:50:10 +0100673 if (((alg1 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0) &&
674 ((alg2 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0)) {
675 return PSA_ALG_AEAD_WITH_AT_LEAST_THIS_LENGTH_TAG(
676 alg1, restricted_len);
Steven Cooreman03488022021-02-18 12:07:20 +0100677 }
678 /* If only one is a wildcard, return specific algorithm if compatible. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100679 if (((alg1 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0) &&
680 (alg1_len <= alg2_len)) {
681 return alg2;
Steven Cooreman03488022021-02-18 12:07:20 +0100682 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100683 if (((alg2 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0) &&
684 (alg2_len <= alg1_len)) {
685 return alg1;
Steven Cooreman03488022021-02-18 12:07:20 +0100686 }
687 }
688 /* If the policies are from the same MAC family, check whether one
689 * of them is a minimum-MAC-length policy. Calculate the most
690 * restrictive tag length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100691 if (PSA_ALG_IS_MAC(alg1) && PSA_ALG_IS_MAC(alg2) &&
692 (PSA_ALG_FULL_LENGTH_MAC(alg1) ==
693 PSA_ALG_FULL_LENGTH_MAC(alg2))) {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100694 /* Validate the combination of key type and algorithm. Since the base
695 * algorithm of alg1 and alg2 are the same, we only need this once. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100696 if (PSA_SUCCESS != psa_mac_key_can_do(alg1, key_type)) {
697 return 0;
698 }
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100699
Steven Cooreman31a876d2021-03-03 20:47:40 +0100700 /* Get the (exact or at-least) output lengths for both sides of the
701 * requested intersection. None of the currently supported algorithms
702 * have an output length dependent on the actual key size, so setting it
703 * to a bogus value of 0 is currently OK.
704 *
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100705 * Note that for at-least-this-length wildcard algorithms, the output
706 * length is set to the shortest allowed length, which allows us to
707 * calculate the most restrictive tag length for the intersection. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100708 size_t alg1_len = PSA_MAC_LENGTH(key_type, 0, alg1);
709 size_t alg2_len = PSA_MAC_LENGTH(key_type, 0, alg2);
Steven Cooremancd640932021-03-08 12:00:27 +0100710 size_t restricted_len = alg1_len > alg2_len ? alg1_len : alg2_len;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100711
Steven Cooremana1d83222021-02-25 10:20:29 +0100712 /* If both are wildcards, return most restrictive wildcard */
Gilles Peskine449bd832023-01-11 14:50:10 +0100713 if (((alg1 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0) &&
714 ((alg2 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0)) {
715 return PSA_ALG_AT_LEAST_THIS_LENGTH_MAC(alg1, restricted_len);
Steven Cooreman03488022021-02-18 12:07:20 +0100716 }
Steven Cooreman31a876d2021-03-03 20:47:40 +0100717
718 /* If only one is an at-least-this-length policy, the intersection would
719 * be the other (fixed-length) policy as long as said fixed length is
720 * equal to or larger than the shortest allowed length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100721 if ((alg1 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0) {
722 return (alg1_len <= alg2_len) ? alg2 : 0;
Steven Cooreman03488022021-02-18 12:07:20 +0100723 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100724 if ((alg2 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0) {
725 return (alg2_len <= alg1_len) ? alg1 : 0;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100726 }
Steven Cooreman31a876d2021-03-03 20:47:40 +0100727
Steven Cooremancd640932021-03-08 12:00:27 +0100728 /* If none of them are wildcards, check whether they define the same tag
729 * length. This is still possible here when one is default-length and
730 * the other specific-length. Ensure to always return the
731 * specific-length version for the intersection. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100732 if (alg1_len == alg2_len) {
733 return PSA_ALG_TRUNCATED_MAC(alg1, alg1_len);
734 }
Gilles Peskinef603c712019-01-19 13:40:11 +0100735 }
736 /* If the policies are incompatible, allow nothing. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100737 return 0;
Gilles Peskinef603c712019-01-19 13:40:11 +0100738}
739
Gilles Peskine449bd832023-01-11 14:50:10 +0100740static int psa_key_algorithm_permits(psa_key_type_t key_type,
741 psa_algorithm_t policy_alg,
742 psa_algorithm_t requested_alg)
Gilles Peskined6f371b2019-05-10 19:33:38 +0200743{
Gilles Peskine549ea862019-05-22 11:45:59 +0200744 /* Common case: the policy only allows requested_alg. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100745 if (requested_alg == policy_alg) {
746 return 1;
747 }
Steven Cooreman03488022021-02-18 12:07:20 +0100748 /* If policy_alg is a hash-and-sign with a wildcard for the hash,
749 * and requested_alg is the same hash-and-sign family with any hash,
750 * then requested_alg is compliant with policy_alg. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100751 if (PSA_ALG_IS_SIGN_HASH(requested_alg) &&
752 PSA_ALG_SIGN_GET_HASH(policy_alg) == PSA_ALG_ANY_HASH) {
753 return (policy_alg & ~PSA_ALG_HASH_MASK) ==
754 (requested_alg & ~PSA_ALG_HASH_MASK);
Steven Cooreman03488022021-02-18 12:07:20 +0100755 }
756 /* If policy_alg is a wildcard AEAD algorithm of the same base as
757 * the requested algorithm, check the requested tag length to be
758 * equal-length or longer than the wildcard-specified length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100759 if (PSA_ALG_IS_AEAD(policy_alg) &&
760 PSA_ALG_IS_AEAD(requested_alg) &&
761 (PSA_ALG_AEAD_WITH_SHORTENED_TAG(policy_alg, 0) ==
762 PSA_ALG_AEAD_WITH_SHORTENED_TAG(requested_alg, 0)) &&
763 ((policy_alg & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0)) {
764 return PSA_ALG_AEAD_GET_TAG_LENGTH(policy_alg) <=
765 PSA_ALG_AEAD_GET_TAG_LENGTH(requested_alg);
Steven Cooreman03488022021-02-18 12:07:20 +0100766 }
Steven Cooremancd640932021-03-08 12:00:27 +0100767 /* If policy_alg is a MAC algorithm of the same base as the requested
768 * algorithm, check whether their MAC lengths are compatible. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100769 if (PSA_ALG_IS_MAC(policy_alg) &&
770 PSA_ALG_IS_MAC(requested_alg) &&
771 (PSA_ALG_FULL_LENGTH_MAC(policy_alg) ==
772 PSA_ALG_FULL_LENGTH_MAC(requested_alg))) {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100773 /* Validate the combination of key type and algorithm. Since the policy
774 * and requested algorithms are the same, we only need this once. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100775 if (PSA_SUCCESS != psa_mac_key_can_do(policy_alg, key_type)) {
776 return 0;
777 }
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100778
Steven Cooreman31a876d2021-03-03 20:47:40 +0100779 /* Get both the requested output length for the algorithm which is to be
780 * verified, and the default output length for the base algorithm.
781 * Note that none of the currently supported algorithms have an output
782 * length dependent on actual key size, so setting it to a bogus value
783 * of 0 is currently OK. */
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100784 size_t requested_output_length = PSA_MAC_LENGTH(
Gilles Peskine449bd832023-01-11 14:50:10 +0100785 key_type, 0, requested_alg);
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100786 size_t default_output_length = PSA_MAC_LENGTH(
Gilles Peskine449bd832023-01-11 14:50:10 +0100787 key_type, 0,
788 PSA_ALG_FULL_LENGTH_MAC(requested_alg));
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100789
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100790 /* If the policy is default-length, only allow an algorithm with
791 * a declared exact-length matching the default. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100792 if (PSA_MAC_TRUNCATED_LENGTH(policy_alg) == 0) {
793 return requested_output_length == default_output_length;
794 }
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100795
796 /* If the requested algorithm is default-length, allow it if the policy
Steven Cooremancd640932021-03-08 12:00:27 +0100797 * length exactly matches the default length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100798 if (PSA_MAC_TRUNCATED_LENGTH(requested_alg) == 0 &&
799 PSA_MAC_TRUNCATED_LENGTH(policy_alg) == default_output_length) {
800 return 1;
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100801 }
802
Steven Cooremancd640932021-03-08 12:00:27 +0100803 /* If policy_alg is an at-least-this-length wildcard MAC algorithm,
804 * check for the requested MAC length to be equal to or longer than the
805 * minimum allowed length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100806 if ((policy_alg & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0) {
807 return PSA_MAC_TRUNCATED_LENGTH(policy_alg) <=
808 requested_output_length;
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100809 }
Gilles Peskined6f371b2019-05-10 19:33:38 +0200810 }
Steven Cooremance48e852020-10-05 16:02:45 +0200811 /* If policy_alg is a generic key agreement operation, then using it for
Steven Cooremanfa5e6312020-10-15 17:07:12 +0200812 * a key derivation with that key agreement should also be allowed. This
813 * behaviour is expected to be defined in a future specification version. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100814 if (PSA_ALG_IS_RAW_KEY_AGREEMENT(policy_alg) &&
815 PSA_ALG_IS_KEY_AGREEMENT(requested_alg)) {
816 return PSA_ALG_KEY_AGREEMENT_GET_BASE(requested_alg) ==
817 policy_alg;
Steven Cooremance48e852020-10-05 16:02:45 +0200818 }
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100819 /* If it isn't explicitly permitted, it's forbidden. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100820 return 0;
Gilles Peskined6f371b2019-05-10 19:33:38 +0200821}
822
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100823/** Test whether a policy permits an algorithm.
824 *
825 * The caller must test usage flags separately.
Steven Cooreman7e39f052021-02-23 14:18:32 +0100826 *
Steven Cooreman5a172672021-03-02 21:27:42 +0100827 * \note This function requires providing the key type for which the policy is
828 * being validated, since some algorithm policy definitions (e.g. MAC)
829 * have different properties depending on what kind of cipher it is
830 * combined with.
831 *
Steven Cooreman7e39f052021-02-23 14:18:32 +0100832 * \retval PSA_SUCCESS When \p alg is a specific algorithm
833 * allowed by the \p policy.
834 * \retval PSA_ERROR_INVALID_ARGUMENT When \p alg is not a specific algorithm
835 * \retval PSA_ERROR_NOT_PERMITTED When \p alg is a specific algorithm, but
836 * the \p policy does not allow it.
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100837 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100838static psa_status_t psa_key_policy_permits(const psa_key_policy_t *policy,
839 psa_key_type_t key_type,
840 psa_algorithm_t alg)
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100841{
Steven Cooremand788fab2021-02-25 11:29:17 +0100842 /* '0' is not a valid algorithm */
Gilles Peskine449bd832023-01-11 14:50:10 +0100843 if (alg == 0) {
844 return PSA_ERROR_INVALID_ARGUMENT;
845 }
Steven Cooremand788fab2021-02-25 11:29:17 +0100846
Steven Cooreman7e39f052021-02-23 14:18:32 +0100847 /* A requested algorithm cannot be a wildcard. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100848 if (PSA_ALG_IS_WILDCARD(alg)) {
849 return PSA_ERROR_INVALID_ARGUMENT;
850 }
Steven Cooreman7e39f052021-02-23 14:18:32 +0100851
Gilles Peskine449bd832023-01-11 14:50:10 +0100852 if (psa_key_algorithm_permits(key_type, policy->alg, alg) ||
853 psa_key_algorithm_permits(key_type, policy->alg2, alg)) {
854 return PSA_SUCCESS;
855 } else {
856 return PSA_ERROR_NOT_PERMITTED;
857 }
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100858}
859
Gilles Peskinef603c712019-01-19 13:40:11 +0100860/** Restrict a key policy based on a constraint.
861 *
Steven Cooreman5a172672021-03-02 21:27:42 +0100862 * \note This function requires providing the key type for which the policy is
863 * being restricted, since some algorithm policy definitions (e.g. MAC)
864 * have different properties depending on what kind of cipher it is
865 * combined with.
866 *
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100867 * \param[in] key_type The key type for which to restrict the policy
Gilles Peskinef603c712019-01-19 13:40:11 +0100868 * \param[in,out] policy The policy to restrict.
869 * \param[in] constraint The policy constraint to apply.
870 *
871 * \retval #PSA_SUCCESS
872 * \c *policy contains the intersection of the original value of
873 * \c *policy and \c *constraint.
874 * \retval #PSA_ERROR_INVALID_ARGUMENT
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100875 * \c key_type, \c *policy and \c *constraint are incompatible.
Gilles Peskinef603c712019-01-19 13:40:11 +0100876 * \c *policy is unchanged.
877 */
878static psa_status_t psa_restrict_key_policy(
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100879 psa_key_type_t key_type,
Gilles Peskinef603c712019-01-19 13:40:11 +0100880 psa_key_policy_t *policy,
Gilles Peskine449bd832023-01-11 14:50:10 +0100881 const psa_key_policy_t *constraint)
Gilles Peskinef603c712019-01-19 13:40:11 +0100882{
883 psa_algorithm_t intersection_alg =
Gilles Peskine449bd832023-01-11 14:50:10 +0100884 psa_key_policy_algorithm_intersection(key_type, policy->alg,
885 constraint->alg);
Gilles Peskined6f371b2019-05-10 19:33:38 +0200886 psa_algorithm_t intersection_alg2 =
Gilles Peskine449bd832023-01-11 14:50:10 +0100887 psa_key_policy_algorithm_intersection(key_type, policy->alg2,
888 constraint->alg2);
889 if (intersection_alg == 0 && policy->alg != 0 && constraint->alg != 0) {
890 return PSA_ERROR_INVALID_ARGUMENT;
891 }
892 if (intersection_alg2 == 0 && policy->alg2 != 0 && constraint->alg2 != 0) {
893 return PSA_ERROR_INVALID_ARGUMENT;
894 }
Gilles Peskinef603c712019-01-19 13:40:11 +0100895 policy->usage &= constraint->usage;
896 policy->alg = intersection_alg;
Gilles Peskined6f371b2019-05-10 19:33:38 +0200897 policy->alg2 = intersection_alg2;
Gilles Peskine449bd832023-01-11 14:50:10 +0100898 return PSA_SUCCESS;
Gilles Peskinef603c712019-01-19 13:40:11 +0100899}
900
Przemek Stekiel061f6942022-11-30 10:51:35 +0100901/** Get the description of a key given its identifier and policy constraints
902 * and lock it.
903 *
904 * The key must have allow all the usage flags set in \p usage. If \p alg is
905 * nonzero, the key must allow operations with this algorithm. If \p alg is
906 * zero, the algorithm is not checked.
907 *
908 * In case of a persistent key, the function loads the description of the key
909 * into a key slot if not already done.
910 *
Ryan Everett098c6652024-01-03 13:03:36 +0000911 * On success, the returned key slot has been registered for reading.
912 * It is the responsibility of the caller to call psa_unregister_read(slot)
913 * when they have finished reading the contents of the slot.
Przemek Stekiel061f6942022-11-30 10:51:35 +0100914 */
915static psa_status_t psa_get_and_lock_key_slot_with_policy(
Ronald Cron5c522922020-11-14 16:35:34 +0100916 mbedtls_svc_key_id_t key,
917 psa_key_slot_t **p_slot,
918 psa_key_usage_t usage,
Gilles Peskine449bd832023-01-11 14:50:10 +0100919 psa_algorithm_t alg)
Darryl Green06fd18d2018-07-16 11:21:11 +0100920{
Ronald Cronf95a2b12020-10-22 15:24:49 +0200921 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel9a5b8122022-12-22 13:34:47 +0100922 psa_key_slot_t *slot = NULL;
Darryl Green06fd18d2018-07-16 11:21:11 +0100923
Gilles Peskine449bd832023-01-11 14:50:10 +0100924 status = psa_get_and_lock_key_slot(key, p_slot);
925 if (status != PSA_SUCCESS) {
926 return status;
927 }
Ronald Cronf95a2b12020-10-22 15:24:49 +0200928 slot = *p_slot;
Darryl Green06fd18d2018-07-16 11:21:11 +0100929
930 /* Enforce that usage policy for the key slot contains all the flags
931 * required by the usage parameter. There is one exception: public
932 * keys can always be exported, so we treat public key objects as
933 * if they had the export flag. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100934 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(slot->attr.type)) {
Darryl Green06fd18d2018-07-16 11:21:11 +0100935 usage &= ~PSA_KEY_USAGE_EXPORT;
Gilles Peskine449bd832023-01-11 14:50:10 +0100936 }
Ronald Cronf95a2b12020-10-22 15:24:49 +0200937
Gilles Peskine449bd832023-01-11 14:50:10 +0100938 if ((slot->attr.policy.usage & usage) != usage) {
Steven Cooreman328f11c2021-03-02 11:44:51 +0100939 status = PSA_ERROR_NOT_PERMITTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +0200940 goto error;
Steven Cooreman328f11c2021-03-02 11:44:51 +0100941 }
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100942
Shaun Case8b0ecbc2021-12-20 21:14:10 -0800943 /* Enforce that the usage policy permits the requested algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100944 if (alg != 0) {
945 status = psa_key_policy_permits(&slot->attr.policy,
946 slot->attr.type,
947 alg);
948 if (status != PSA_SUCCESS) {
Steven Cooreman7e39f052021-02-23 14:18:32 +0100949 goto error;
Gilles Peskine449bd832023-01-11 14:50:10 +0100950 }
Steven Cooreman7e39f052021-02-23 14:18:32 +0100951 }
Darryl Green06fd18d2018-07-16 11:21:11 +0100952
Gilles Peskine449bd832023-01-11 14:50:10 +0100953 return PSA_SUCCESS;
Ronald Cronf95a2b12020-10-22 15:24:49 +0200954
955error:
956 *p_slot = NULL;
Ryan Everett098c6652024-01-03 13:03:36 +0000957 psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +0200958
Gilles Peskine449bd832023-01-11 14:50:10 +0100959 return status;
Darryl Green06fd18d2018-07-16 11:21:11 +0100960}
Darryl Green940d72c2018-07-13 13:18:51 +0100961
Ronald Cron5c522922020-11-14 16:35:34 +0100962/** Get a key slot containing a transparent key and lock it.
Gilles Peskine28f8f302019-07-24 13:30:31 +0200963 *
964 * A transparent key is a key for which the key material is directly
Ronald Cronddae0f52021-08-24 15:39:44 +0200965 * available, as opposed to a key in a secure element and/or to be used
966 * by a secure element.
Gilles Peskine28f8f302019-07-24 13:30:31 +0200967 *
Ronald Cronddae0f52021-08-24 15:39:44 +0200968 * This is a temporary function that may be used instead of
969 * psa_get_and_lock_key_slot_with_policy() when there is no opaque key support
970 * for a cryptographic operation.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200971 *
Ryan Everett098c6652024-01-03 13:03:36 +0000972 * On success, the returned key slot has been registered for reading.
973 * It is the responsibility of the caller to call psa_unregister_read(slot)
974 * when they have finished reading the contents of the slot.
Gilles Peskine28f8f302019-07-24 13:30:31 +0200975 */
Ronald Cron5c522922020-11-14 16:35:34 +0100976static psa_status_t psa_get_and_lock_transparent_key_slot_with_policy(
977 mbedtls_svc_key_id_t key,
978 psa_key_slot_t **p_slot,
979 psa_key_usage_t usage,
Gilles Peskine449bd832023-01-11 14:50:10 +0100980 psa_algorithm_t alg)
Gilles Peskine28f8f302019-07-24 13:30:31 +0200981{
Gilles Peskine449bd832023-01-11 14:50:10 +0100982 psa_status_t status = psa_get_and_lock_key_slot_with_policy(key, p_slot,
983 usage, alg);
984 if (status != PSA_SUCCESS) {
985 return status;
Gilles Peskine28f8f302019-07-24 13:30:31 +0200986 }
Ronald Cronf95a2b12020-10-22 15:24:49 +0200987
Gilles Peskine449bd832023-01-11 14:50:10 +0100988 if (psa_key_lifetime_is_external((*p_slot)->attr.lifetime)) {
Ryan Everett098c6652024-01-03 13:03:36 +0000989 psa_unregister_read(*p_slot);
Gilles Peskine449bd832023-01-11 14:50:10 +0100990 *p_slot = NULL;
991 return PSA_ERROR_NOT_SUPPORTED;
992 }
993
994 return PSA_SUCCESS;
Gilles Peskine28f8f302019-07-24 13:30:31 +0200995}
Gilles Peskine28f8f302019-07-24 13:30:31 +0200996
Gilles Peskine449bd832023-01-11 14:50:10 +0100997psa_status_t psa_remove_key_data_from_memory(psa_key_slot_t *slot)
Darryl Green40225ba2018-11-15 14:48:15 +0000998{
Gilles Peskine449bd832023-01-11 14:50:10 +0100999 if (slot->key.data != NULL) {
Tom Cosgrove52f7e182023-08-01 09:08:48 +01001000 mbedtls_zeroize_and_free(slot->key.data, slot->key.bytes);
Gilles Peskine449bd832023-01-11 14:50:10 +01001001 }
Ronald Cronea0f8a62020-11-25 17:52:23 +01001002
Ronald Cronea0f8a62020-11-25 17:52:23 +01001003 slot->key.data = NULL;
1004 slot->key.bytes = 0;
Darryl Green40225ba2018-11-15 14:48:15 +00001005
Gilles Peskine449bd832023-01-11 14:50:10 +01001006 return PSA_SUCCESS;
Darryl Green40225ba2018-11-15 14:48:15 +00001007}
1008
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001009/** Completely wipe a slot in memory, including its policy.
1010 * Persistent storage is not affected. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001011psa_status_t psa_wipe_key_slot(psa_key_slot_t *slot)
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001012{
Gilles Peskine449bd832023-01-11 14:50:10 +01001013 psa_status_t status = psa_remove_key_data_from_memory(slot);
Ronald Cronddd3d052020-10-30 14:07:07 +01001014
Gilles Peskine449bd832023-01-11 14:50:10 +01001015 /*
1016 * As the return error code may not be handled in case of multiple errors,
Ryan Everett7ed542e2024-01-17 11:39:09 +00001017 * do our best to report an unexpected amount of registered readers or
1018 * an unexpected state.
1019 * Assert with MBEDTLS_TEST_HOOK_TEST_ASSERT that the slot is valid for
1020 * wiping.
Gilles Peskine449bd832023-01-11 14:50:10 +01001021 * if the MBEDTLS_TEST_HOOKS configuration option is enabled and the
1022 * function is called as part of the execution of a test suite, the
1023 * execution of the test suite is stopped in error if the assertion fails.
1024 */
Ryan Everett7ed542e2024-01-17 11:39:09 +00001025 switch (slot->state) {
1026 case PSA_SLOT_FULL:
1027 /* In this state psa_wipe_key_slot() must only be called if the
1028 * caller is the last reader. */
1029 case PSA_SLOT_PENDING_DELETION:
1030 /* In this state psa_wipe_key_slot() must only be called if the
1031 * caller is the last reader. */
1032 if (slot->registered_readers != 1) {
1033 MBEDTLS_TEST_HOOK_TEST_ASSERT(slot->registered_readers == 1);
1034 status = PSA_ERROR_CORRUPTION_DETECTED;
1035 }
1036 break;
1037 case PSA_SLOT_FILLING:
1038 /* In this state registered_readers must be 0. */
1039 if (slot->registered_readers != 0) {
1040 MBEDTLS_TEST_HOOK_TEST_ASSERT(slot->registered_readers == 0);
1041 status = PSA_ERROR_CORRUPTION_DETECTED;
1042 }
1043 break;
1044 case PSA_SLOT_EMPTY:
1045 /* The slot is already empty, it cannot be wiped. */
1046 MBEDTLS_TEST_HOOK_TEST_ASSERT(slot->state != PSA_SLOT_EMPTY);
1047 status = PSA_ERROR_CORRUPTION_DETECTED;
1048 break;
1049 default:
1050 /* The slot's state is invalid. */
1051 status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronddd3d052020-10-30 14:07:07 +01001052 }
1053
Gilles Peskine3f7cd622019-08-13 15:01:08 +02001054 /* Multipart operations may still be using the key. This is safe
1055 * because all multipart operation objects are independent from
1056 * the key slot: if they need to access the key after the setup
1057 * phase, they have a copy of the key. Note that this means that
1058 * key material can linger until all operations are completed. */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001059 /* At this point, key material and other type-specific content has
1060 * been wiped. Clear remaining metadata. We can call memset and not
Ryan Everettaa33c512023-12-21 17:32:07 +00001061 * zeroize because the metadata is not particularly sensitive.
1062 * This memset also sets the slot's state to PSA_SLOT_EMPTY. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001063 memset(slot, 0, sizeof(*slot));
1064 return status;
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001065}
1066
Gilles Peskine449bd832023-01-11 14:50:10 +01001067psa_status_t psa_destroy_key(mbedtls_svc_key_id_t key)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001068{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001069 psa_key_slot_t *slot;
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001070 psa_status_t status; /* status of the last operation */
1071 psa_status_t overall_status = PSA_SUCCESS;
Gilles Peskine354f7672019-07-12 23:46:38 +02001072#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1073 psa_se_drv_table_entry_t *driver;
1074#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001075
Gilles Peskine449bd832023-01-11 14:50:10 +01001076 if (mbedtls_svc_key_id_is_null(key)) {
1077 return PSA_SUCCESS;
1078 }
Gilles Peskine1841cf42019-10-08 15:48:25 +02001079
Ronald Cronf2911112020-10-29 17:51:10 +01001080 /*
Ryan Everett7ed542e2024-01-17 11:39:09 +00001081 * Get the description of the key in a key slot, and register to read it.
1082 * In the case of a persistent key, this will load the key description
1083 * from persistent memory if not done yet.
1084 * We cannot avoid this loading as without it we don't know if
Ronald Cronf2911112020-10-29 17:51:10 +01001085 * the key is operated by an SE or not and this information is needed by
Ryan Everett7ed542e2024-01-17 11:39:09 +00001086 * the current implementation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001087 status = psa_get_and_lock_key_slot(key, &slot);
1088 if (status != PSA_SUCCESS) {
1089 return status;
1090 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001091
Ryan Everettc053d962024-01-25 17:56:32 +00001092#if defined(MBEDTLS_THREADING_C)
Ryan Everett763971f2024-01-29 17:13:36 +00001093 /* We cannot unlock between setting the state to PENDING_DELETION
1094 * and destroying the key in storage, as otherwise another thread
1095 * could load the key into a new slot and the key will not be
1096 * fully destroyed. */
Ryan Everettc053d962024-01-25 17:56:32 +00001097 PSA_THREADING_CHK_GOTO_EXIT(mbedtls_mutex_lock(
1098 &mbedtls_threading_key_slot_mutex));
1099#endif
Ryan Everett7ed542e2024-01-17 11:39:09 +00001100 /* Set the key slot containing the key description's state to
1101 * PENDING_DELETION. This stops new operations from registering
1102 * to read the slot. Current readers can safely continue to access
1103 * the key within the slot; the last registered reader will
1104 * automatically wipe the slot when they call psa_unregister_read().
1105 * If the key is persistent, we can now delete the copy of the key
1106 * from memory. If the key is opaque, we require the driver to
1107 * deal with the deletion. */
Ryan Everettc053d962024-01-25 17:56:32 +00001108 status = psa_key_slot_state_transition(slot, PSA_SLOT_FULL,
1109 PSA_SLOT_PENDING_DELETION);
1110
1111 if (status != PSA_SUCCESS) {
1112 goto exit;
1113 }
Ronald Cronf2911112020-10-29 17:51:10 +01001114
Gilles Peskine449bd832023-01-11 14:50:10 +01001115 if (PSA_KEY_LIFETIME_IS_READ_ONLY(slot->attr.lifetime)) {
Gilles Peskine6687cd02021-04-21 22:32:05 +02001116 /* Refuse the destruction of a read-only key (which may or may not work
1117 * if we attempt it, depending on whether the key is merely read-only
1118 * by policy or actually physically read-only).
Gilles Peskinef9a046e2021-06-07 23:27:54 +02001119 * Just do the best we can, which is to wipe the copy in memory
1120 * (done in this function's cleanup code). */
1121 overall_status = PSA_ERROR_NOT_PERMITTED;
1122 goto exit;
Gilles Peskine6687cd02021-04-21 22:32:05 +02001123 }
1124
Gilles Peskine354f7672019-07-12 23:46:38 +02001125#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001126 driver = psa_get_se_driver_entry(slot->attr.lifetime);
1127 if (driver != NULL) {
Gilles Peskine60450a42019-07-25 11:32:45 +02001128 /* For a key in a secure element, we need to do three things:
1129 * remove the key file in internal storage, destroy the
1130 * key inside the secure element, and update the driver's
1131 * persistent data. Start a transaction that will encompass these
1132 * three actions. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001133 psa_crypto_prepare_transaction(PSA_CRYPTO_TRANSACTION_DESTROY_KEY);
Gilles Peskine8e338702019-07-30 20:06:31 +02001134 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Gilles Peskine449bd832023-01-11 14:50:10 +01001135 psa_crypto_transaction.key.slot = psa_key_slot_get_slot_number(slot);
Gilles Peskine8e338702019-07-30 20:06:31 +02001136 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskine449bd832023-01-11 14:50:10 +01001137 status = psa_crypto_save_transaction();
1138 if (status != PSA_SUCCESS) {
1139 (void) psa_crypto_stop_transaction();
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001140 /* We should still try to destroy the key in the secure
1141 * element and the key metadata in storage. This is especially
1142 * important if the error is that the storage is full.
1143 * But how to do it exactly without risking an inconsistent
1144 * state after a reset?
1145 * https://github.com/ARMmbed/mbed-crypto/issues/215
1146 */
1147 overall_status = status;
1148 goto exit;
Gilles Peskinefc762652019-07-22 19:30:34 +02001149 }
1150
Gilles Peskine449bd832023-01-11 14:50:10 +01001151 status = psa_destroy_se_key(driver,
1152 psa_key_slot_get_slot_number(slot));
1153 if (overall_status == PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001154 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001155 }
Gilles Peskinefc762652019-07-22 19:30:34 +02001156 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001157#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1158
Darryl Greend49a4992018-06-18 17:27:26 +01001159#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001160 if (!PSA_KEY_LIFETIME_IS_VOLATILE(slot->attr.lifetime)) {
Ryan Everett4a0ba802024-01-17 14:12:33 +00001161 /* Destroy the copy of the persistent key from storage.
Ryan Everett7ed542e2024-01-17 11:39:09 +00001162 * The slot will still hold a copy of the key until the last reader
1163 * unregisters. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001164 status = psa_destroy_persistent_key(slot->attr.id);
1165 if (overall_status == PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001166 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001167 }
Darryl Greend49a4992018-06-18 17:27:26 +01001168 }
1169#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
Gilles Peskine354f7672019-07-12 23:46:38 +02001170
Gilles Peskinefc762652019-07-22 19:30:34 +02001171#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001172 if (driver != NULL) {
1173 status = psa_save_se_persistent_data(driver);
1174 if (overall_status == PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001175 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001176 }
1177 status = psa_crypto_stop_transaction();
1178 if (overall_status == PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001179 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001180 }
Gilles Peskinefc762652019-07-22 19:30:34 +02001181 }
1182#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1183
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001184exit:
Ryan Everett7ed542e2024-01-17 11:39:09 +00001185 /* Unregister from reading the slot. If we are the last active reader
1186 * then this will wipe the slot. */
1187 status = psa_unregister_read(slot);
1188 /* Prioritize CORRUPTION_DETECTED from unregistering over
1189 * a storage error. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001190 if (status != PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001191 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001192 }
Ryan Everettc053d962024-01-25 17:56:32 +00001193
1194#if defined(MBEDTLS_THREADING_C)
Ryan Everett7fee4f72024-02-09 14:11:27 +00001195 /* Don't overwrite existing errors if the unlock fails. */
1196 status = overall_status;
Ryan Everettc053d962024-01-25 17:56:32 +00001197 PSA_THREADING_CHK_RET(mbedtls_mutex_unlock(
1198 &mbedtls_threading_key_slot_mutex));
1199#endif
1200
Gilles Peskine449bd832023-01-11 14:50:10 +01001201 return overall_status;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001202}
1203
Valerio Settib2bcedb2023-07-10 11:24:00 +02001204#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT) || \
John Durkop0e005192020-10-31 22:06:54 -07001205 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskineb699f072019-04-26 16:06:02 +02001206static psa_status_t psa_get_rsa_public_exponent(
1207 const mbedtls_rsa_context *rsa,
Gilles Peskine449bd832023-01-11 14:50:10 +01001208 psa_key_attributes_t *attributes)
Gilles Peskineb699f072019-04-26 16:06:02 +02001209{
1210 mbedtls_mpi mpi;
Janos Follath24eed8d2019-11-22 13:21:35 +00001211 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb699f072019-04-26 16:06:02 +02001212 uint8_t *buffer = NULL;
1213 size_t buflen;
Gilles Peskine449bd832023-01-11 14:50:10 +01001214 mbedtls_mpi_init(&mpi);
Gilles Peskineb699f072019-04-26 16:06:02 +02001215
Gilles Peskine449bd832023-01-11 14:50:10 +01001216 ret = mbedtls_rsa_export(rsa, NULL, NULL, NULL, NULL, &mpi);
1217 if (ret != 0) {
Gilles Peskineb699f072019-04-26 16:06:02 +02001218 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001219 }
1220 if (mbedtls_mpi_cmp_int(&mpi, 65537) == 0) {
Gilles Peskine772c8b12019-04-26 17:37:21 +02001221 /* It's the default value, which is reported as an empty string,
1222 * so there's nothing to do. */
1223 goto exit;
1224 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001225
Gilles Peskine449bd832023-01-11 14:50:10 +01001226 buflen = mbedtls_mpi_size(&mpi);
1227 buffer = mbedtls_calloc(1, buflen);
1228 if (buffer == NULL) {
Gilles Peskineb699f072019-04-26 16:06:02 +02001229 ret = MBEDTLS_ERR_MPI_ALLOC_FAILED;
1230 goto exit;
1231 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001232 ret = mbedtls_mpi_write_binary(&mpi, buffer, buflen);
1233 if (ret != 0) {
Gilles Peskineb699f072019-04-26 16:06:02 +02001234 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001235 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001236 attributes->domain_parameters = buffer;
1237 attributes->domain_parameters_size = buflen;
1238
1239exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01001240 mbedtls_mpi_free(&mpi);
1241 if (ret != 0) {
1242 mbedtls_free(buffer);
1243 }
1244 return mbedtls_to_psa_error(ret);
Gilles Peskineb699f072019-04-26 16:06:02 +02001245}
Valerio Settib2bcedb2023-07-10 11:24:00 +02001246#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT) ||
John Durkop9814fa22020-11-04 12:28:15 -08001247 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001248
Gilles Peskinebfd322f2019-07-23 11:58:03 +02001249/** Retrieve all the publicly-accessible attributes of a key.
1250 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001251psa_status_t psa_get_key_attributes(mbedtls_svc_key_id_t key,
1252 psa_key_attributes_t *attributes)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001253{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001254 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001255 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001256 psa_key_slot_t *slot;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001257
Gilles Peskine449bd832023-01-11 14:50:10 +01001258 psa_reset_key_attributes(attributes);
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001259
Gilles Peskine449bd832023-01-11 14:50:10 +01001260 status = psa_get_and_lock_key_slot_with_policy(key, &slot, 0, 0);
1261 if (status != PSA_SUCCESS) {
1262 return status;
1263 }
Gilles Peskineb870b182018-07-06 16:02:09 +02001264
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001265 attributes->core = slot->attr;
Gilles Peskine449bd832023-01-11 14:50:10 +01001266 attributes->core.flags &= (MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1267 MBEDTLS_PSA_KA_MASK_DUAL_USE);
Gilles Peskinec8000c02019-08-02 20:15:51 +02001268
1269#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001270 if (psa_get_se_driver_entry(slot->attr.lifetime) != NULL) {
1271 psa_set_key_slot_number(attributes,
1272 psa_key_slot_get_slot_number(slot));
1273 }
Gilles Peskinec8000c02019-08-02 20:15:51 +02001274#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineb699f072019-04-26 16:06:02 +02001275
Gilles Peskine449bd832023-01-11 14:50:10 +01001276 switch (slot->attr.type) {
Valerio Settib2bcedb2023-07-10 11:24:00 +02001277#if (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) && \
1278 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) || \
John Durkop0e005192020-10-31 22:06:54 -07001279 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02001280 case PSA_KEY_TYPE_RSA_KEY_PAIR:
Gilles Peskineb699f072019-04-26 16:06:02 +02001281 case PSA_KEY_TYPE_RSA_PUBLIC_KEY:
Pengyu Lvf75893b2023-12-08 17:21:39 +08001282 /* TODO: This is a temporary situation where domain parameters are deprecated,
1283 * but we need it for namely generating an RSA key with a non-default exponent.
1284 * This would be improved after https://github.com/Mbed-TLS/mbedtls/issues/6494.
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001285 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001286 if (!psa_key_lifetime_is_external(slot->attr.lifetime)) {
Steven Cooremana2371e52020-07-28 14:30:39 +02001287 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02001288
Ronald Cron90857082020-11-25 14:58:33 +01001289 status = mbedtls_psa_rsa_load_representation(
Gilles Peskine449bd832023-01-11 14:50:10 +01001290 slot->attr.type,
1291 slot->key.data,
1292 slot->key.bytes,
1293 &rsa);
1294 if (status != PSA_SUCCESS) {
Steven Cooremana01795d2020-07-24 22:48:15 +02001295 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01001296 }
Steven Cooremana01795d2020-07-24 22:48:15 +02001297
Gilles Peskine449bd832023-01-11 14:50:10 +01001298 status = psa_get_rsa_public_exponent(rsa,
1299 attributes);
1300 mbedtls_rsa_free(rsa);
1301 mbedtls_free(rsa);
Steven Cooremana01795d2020-07-24 22:48:15 +02001302 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001303 break;
Pengyu Lve9efbc22023-12-08 16:59:08 +08001304#else
1305 case PSA_KEY_TYPE_RSA_KEY_PAIR:
1306 case PSA_KEY_TYPE_RSA_PUBLIC_KEY:
1307 attributes->domain_parameters = NULL;
1308 attributes->domain_parameters_size = SIZE_MAX;
1309 break;
Valerio Settib2bcedb2023-07-10 11:24:00 +02001310#endif /* (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) && \
1311 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) ||
John Durkop9814fa22020-11-04 12:28:15 -08001312 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001313 default:
1314 /* Nothing else to do. */
1315 break;
1316 }
1317
Gilles Peskine449bd832023-01-11 14:50:10 +01001318 if (status != PSA_SUCCESS) {
1319 psa_reset_key_attributes(attributes);
1320 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001321
Ryan Everett1b70a072024-01-04 10:32:49 +00001322 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02001323
Gilles Peskine449bd832023-01-11 14:50:10 +01001324 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001325}
1326
Gilles Peskinec8000c02019-08-02 20:15:51 +02001327#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1328psa_status_t psa_get_key_slot_number(
1329 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01001330 psa_key_slot_number_t *slot_number)
Gilles Peskinec8000c02019-08-02 20:15:51 +02001331{
Gilles Peskine449bd832023-01-11 14:50:10 +01001332 if (attributes->core.flags & MBEDTLS_PSA_KA_FLAG_HAS_SLOT_NUMBER) {
Gilles Peskinec8000c02019-08-02 20:15:51 +02001333 *slot_number = attributes->slot_number;
Gilles Peskine449bd832023-01-11 14:50:10 +01001334 return PSA_SUCCESS;
1335 } else {
1336 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinec8000c02019-08-02 20:15:51 +02001337 }
Gilles Peskinec8000c02019-08-02 20:15:51 +02001338}
1339#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1340
Gilles Peskine449bd832023-01-11 14:50:10 +01001341static psa_status_t psa_export_key_buffer_internal(const uint8_t *key_buffer,
1342 size_t key_buffer_size,
1343 uint8_t *data,
1344 size_t data_size,
1345 size_t *data_length)
Steven Cooremana01795d2020-07-24 22:48:15 +02001346{
Gilles Peskine449bd832023-01-11 14:50:10 +01001347 if (key_buffer_size > data_size) {
1348 return PSA_ERROR_BUFFER_TOO_SMALL;
1349 }
1350 memcpy(data, key_buffer, key_buffer_size);
1351 memset(data + key_buffer_size, 0,
1352 data_size - key_buffer_size);
Ronald Crond18b5f82020-11-25 16:46:05 +01001353 *data_length = key_buffer_size;
Gilles Peskine449bd832023-01-11 14:50:10 +01001354 return PSA_SUCCESS;
Steven Cooremana01795d2020-07-24 22:48:15 +02001355}
1356
Ronald Cron7285cda2020-11-26 14:46:37 +01001357psa_status_t psa_export_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001358 const psa_key_attributes_t *attributes,
1359 const uint8_t *key_buffer, size_t key_buffer_size,
Gilles Peskine449bd832023-01-11 14:50:10 +01001360 uint8_t *data, size_t data_size, size_t *data_length)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001361{
Ronald Crond18b5f82020-11-25 16:46:05 +01001362 psa_key_type_t type = attributes->core.type;
1363
Gilles Peskine449bd832023-01-11 14:50:10 +01001364 if (key_type_is_raw_bytes(type) ||
1365 PSA_KEY_TYPE_IS_RSA(type) ||
Przemek Stekiel472b3f32022-12-01 14:38:49 +01001366 PSA_KEY_TYPE_IS_ECC(type) ||
1367 PSA_KEY_TYPE_IS_DH(type)) {
Gilles Peskine449bd832023-01-11 14:50:10 +01001368 return psa_export_key_buffer_internal(
1369 key_buffer, key_buffer_size,
1370 data, data_size, data_length);
1371 } else {
Ronald Cron9486f9d2020-11-26 13:36:23 +01001372 /* This shouldn't happen in the reference implementation, but
1373 it is valid for a special-purpose implementation to omit
1374 support for exporting certain key types. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001375 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron9486f9d2020-11-26 13:36:23 +01001376 }
1377}
1378
Gilles Peskine449bd832023-01-11 14:50:10 +01001379psa_status_t psa_export_key(mbedtls_svc_key_id_t key,
1380 uint8_t *data,
1381 size_t data_size,
1382 size_t *data_length)
Ronald Cron9486f9d2020-11-26 13:36:23 +01001383{
1384 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
1385 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
1386 psa_key_slot_t *slot;
1387
Ronald Crone907e552021-01-18 13:22:38 +01001388 /* Reject a zero-length output buffer now, since this can never be a
1389 * valid key representation. This way we know that data must be a valid
1390 * pointer and we can do things like memset(data, ..., data_size). */
Gilles Peskine449bd832023-01-11 14:50:10 +01001391 if (data_size == 0) {
1392 return PSA_ERROR_BUFFER_TOO_SMALL;
1393 }
Ronald Crone907e552021-01-18 13:22:38 +01001394
Ronald Cron9486f9d2020-11-26 13:36:23 +01001395 /* Set the key to empty now, so that even when there are errors, we always
1396 * set data_length to a value between 0 and data_size. On error, setting
1397 * the key to empty is a good choice because an empty key representation is
1398 * unlikely to be accepted anywhere. */
Jaeden Amerof24c7f82018-06-27 17:20:43 +01001399 *data_length = 0;
1400
Ronald Cron9486f9d2020-11-26 13:36:23 +01001401 /* Export requires the EXPORT flag. There is an exception for public keys,
1402 * which don't require any flag, but
1403 * psa_get_and_lock_key_slot_with_policy() takes care of this.
1404 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001405 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
1406 PSA_KEY_USAGE_EXPORT, 0);
1407 if (status != PSA_SUCCESS) {
1408 return status;
1409 }
mohammad160306e79202018-03-28 13:17:44 +03001410
Ronald Crond18b5f82020-11-25 16:46:05 +01001411 psa_key_attributes_t attributes = {
1412 .core = slot->attr
1413 };
Gilles Peskine449bd832023-01-11 14:50:10 +01001414 status = psa_driver_wrapper_export_key(&attributes,
1415 slot->key.data, slot->key.bytes,
1416 data, data_size, data_length);
Ronald Cron9486f9d2020-11-26 13:36:23 +01001417
Ryan Everett1b70a072024-01-04 10:32:49 +00001418 unlock_status = psa_unregister_read(slot);
Ronald Cron9486f9d2020-11-26 13:36:23 +01001419
Gilles Peskine449bd832023-01-11 14:50:10 +01001420 return (status == PSA_SUCCESS) ? unlock_status : status;
Ronald Cron9486f9d2020-11-26 13:36:23 +01001421}
1422
Ronald Cron7285cda2020-11-26 14:46:37 +01001423psa_status_t psa_export_public_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001424 const psa_key_attributes_t *attributes,
1425 const uint8_t *key_buffer,
1426 size_t key_buffer_size,
1427 uint8_t *data,
1428 size_t data_size,
Gilles Peskine449bd832023-01-11 14:50:10 +01001429 size_t *data_length)
Ronald Cron9486f9d2020-11-26 13:36:23 +01001430{
Ronald Crond18b5f82020-11-25 16:46:05 +01001431 psa_key_type_t type = attributes->core.type;
Ronald Crond18b5f82020-11-25 16:46:05 +01001432
Przemek Stekiel6fd72b62023-04-27 10:20:56 +02001433 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(type) &&
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001434 (PSA_KEY_TYPE_IS_RSA(type) || PSA_KEY_TYPE_IS_ECC(type) ||
1435 PSA_KEY_TYPE_IS_DH(type))) {
Przemek Stekiel6fd72b62023-04-27 10:20:56 +02001436 /* Exporting public -> public */
1437 return psa_export_key_buffer_internal(
1438 key_buffer, key_buffer_size,
1439 data, data_size, data_length);
1440 } else if (PSA_KEY_TYPE_IS_RSA(type)) {
Valerio Settib2bcedb2023-07-10 11:24:00 +02001441#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT) || \
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001442 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
1443 return mbedtls_psa_rsa_export_public_key(attributes,
1444 key_buffer,
1445 key_buffer_size,
1446 data,
1447 data_size,
1448 data_length);
Darryl Green9e2d7a02018-07-24 16:33:30 +01001449#else
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001450 /* We don't know how to convert a private RSA key to public. */
1451 return PSA_ERROR_NOT_SUPPORTED;
Valerio Settib2bcedb2023-07-10 11:24:00 +02001452#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT) ||
John Durkop9814fa22020-11-04 12:28:15 -08001453 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Przemek Stekiel6fd72b62023-04-27 10:20:56 +02001454 } else if (PSA_KEY_TYPE_IS_ECC(type)) {
Valerio Setti27c501a2023-06-27 16:58:52 +02001455#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_EXPORT) || \
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001456 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
1457 return mbedtls_psa_ecp_export_public_key(attributes,
1458 key_buffer,
1459 key_buffer_size,
1460 data,
1461 data_size,
1462 data_length);
Steven Cooreman560c28a2020-07-24 23:20:24 +02001463#else
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001464 /* We don't know how to convert a private ECC key to public */
1465 return PSA_ERROR_NOT_SUPPORTED;
Valerio Setti27c501a2023-06-27 16:58:52 +02001466#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_EXPORT) ||
John Durkop9814fa22020-11-04 12:28:15 -08001467 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
Przemek Stekiel6fd72b62023-04-27 10:20:56 +02001468 } else if (PSA_KEY_TYPE_IS_DH(type)) {
Valerio Settia55f0422023-07-10 15:34:41 +02001469#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_EXPORT) || \
Przemek Stekiel6d85afa2023-04-28 11:42:17 +02001470 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY)
Przemek Stekiel152bb462023-06-01 11:52:39 +02001471 return mbedtls_psa_ffdh_export_public_key(attributes,
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001472 key_buffer,
1473 key_buffer_size,
1474 data, data_size,
1475 data_length);
Przemek Stekiel472b3f32022-12-01 14:38:49 +01001476#else
Przemek Stekiel472b3f32022-12-01 14:38:49 +01001477 return PSA_ERROR_NOT_SUPPORTED;
Valerio Settia55f0422023-07-10 15:34:41 +02001478#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_EXPORT) ||
Przemek Stekiel6d85afa2023-04-28 11:42:17 +02001479 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY) */
Gilles Peskine449bd832023-01-11 14:50:10 +01001480 } else {
Przemek Stekiel0b11ee02023-05-16 13:26:06 +02001481 (void) key_buffer;
1482 (void) key_buffer_size;
1483 (void) data;
1484 (void) data_size;
1485 (void) data_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01001486 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman560c28a2020-07-24 23:20:24 +02001487 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001488}
Ronald Crond18b5f82020-11-25 16:46:05 +01001489
Gilles Peskine449bd832023-01-11 14:50:10 +01001490psa_status_t psa_export_public_key(mbedtls_svc_key_id_t key,
1491 uint8_t *data,
1492 size_t data_size,
1493 size_t *data_length)
Moran Pekerdd4ea382018-04-03 15:30:03 +03001494{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001495 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001496 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001497 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01001498 psa_key_attributes_t attributes;
Darryl Greendd8fb772018-11-07 16:00:44 +00001499
Ronald Crone907e552021-01-18 13:22:38 +01001500 /* Reject a zero-length output buffer now, since this can never be a
1501 * valid key representation. This way we know that data must be a valid
1502 * pointer and we can do things like memset(data, ..., data_size). */
Gilles Peskine449bd832023-01-11 14:50:10 +01001503 if (data_size == 0) {
1504 return PSA_ERROR_BUFFER_TOO_SMALL;
1505 }
Ronald Crone907e552021-01-18 13:22:38 +01001506
Darryl Greendd8fb772018-11-07 16:00:44 +00001507 /* Set the key to empty now, so that even when there are errors, we always
1508 * set data_length to a value between 0 and data_size. On error, setting
1509 * the key to empty is a good choice because an empty key representation is
1510 * unlikely to be accepted anywhere. */
1511 *data_length = 0;
1512
1513 /* Exporting a public key doesn't require a usage flag. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001514 status = psa_get_and_lock_key_slot_with_policy(key, &slot, 0, 0);
1515 if (status != PSA_SUCCESS) {
1516 return status;
1517 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001518
Gilles Peskine449bd832023-01-11 14:50:10 +01001519 if (!PSA_KEY_TYPE_IS_ASYMMETRIC(slot->attr.type)) {
1520 status = PSA_ERROR_INVALID_ARGUMENT;
1521 goto exit;
Ronald Cron9486f9d2020-11-26 13:36:23 +01001522 }
1523
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01001524 attributes = (psa_key_attributes_t) {
Ronald Crond18b5f82020-11-25 16:46:05 +01001525 .core = slot->attr
1526 };
Ronald Cron67227982020-11-26 15:16:05 +01001527 status = psa_driver_wrapper_export_public_key(
Ronald Crond18b5f82020-11-25 16:46:05 +01001528 &attributes, slot->key.data, slot->key.bytes,
Gilles Peskine449bd832023-01-11 14:50:10 +01001529 data, data_size, data_length);
Ronald Cron9486f9d2020-11-26 13:36:23 +01001530
1531exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00001532 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02001533
Gilles Peskine449bd832023-01-11 14:50:10 +01001534 return (status == PSA_SUCCESS) ? unlock_status : status;
Moran Pekerdd4ea382018-04-03 15:30:03 +03001535}
1536
Tom Cosgrove6ef9bb32023-03-08 14:19:51 +00001537MBEDTLS_STATIC_ASSERT(
1538 (MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE) == 0,
1539 "One or more key attribute flag is listed as both external-only and dual-use")
1540MBEDTLS_STATIC_ASSERT(
1541 (PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE) == 0,
1542 "One or more key attribute flag is listed as both internal-only and dual-use")
1543MBEDTLS_STATIC_ASSERT(
1544 (PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY) == 0,
1545 "One or more key attribute flag is listed as both internal-only and external-only")
Gilles Peskine91e8c332019-08-02 19:19:39 +02001546
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001547/** Validate that a key policy is internally well-formed.
1548 *
1549 * This function only rejects invalid policies. It does not validate the
1550 * consistency of the policy with respect to other attributes of the key
1551 * such as the key type.
1552 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001553static psa_status_t psa_validate_key_policy(const psa_key_policy_t *policy)
Gilles Peskine4747d192019-04-17 15:05:45 +02001554{
Gilles Peskine449bd832023-01-11 14:50:10 +01001555 if ((policy->usage & ~(PSA_KEY_USAGE_EXPORT |
1556 PSA_KEY_USAGE_COPY |
1557 PSA_KEY_USAGE_ENCRYPT |
1558 PSA_KEY_USAGE_DECRYPT |
1559 PSA_KEY_USAGE_SIGN_MESSAGE |
1560 PSA_KEY_USAGE_VERIFY_MESSAGE |
1561 PSA_KEY_USAGE_SIGN_HASH |
1562 PSA_KEY_USAGE_VERIFY_HASH |
1563 PSA_KEY_USAGE_VERIFY_DERIVATION |
1564 PSA_KEY_USAGE_DERIVE)) != 0) {
1565 return PSA_ERROR_INVALID_ARGUMENT;
1566 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001567
Gilles Peskine449bd832023-01-11 14:50:10 +01001568 return PSA_SUCCESS;
Gilles Peskine4747d192019-04-17 15:05:45 +02001569}
1570
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001571/** Validate the internal consistency of key attributes.
1572 *
1573 * This function only rejects invalid attribute values. If does not
1574 * validate the consistency of the attributes with any key data that may
1575 * be involved in the creation of the key.
1576 *
1577 * Call this function early in the key creation process.
1578 *
1579 * \param[in] attributes Key attributes for the new key.
1580 * \param[out] p_drv On any return, the driver for the key, if any.
1581 * NULL for a transparent key.
1582 *
1583 */
1584static psa_status_t psa_validate_key_attributes(
1585 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01001586 psa_se_drv_table_entry_t **p_drv)
Darryl Green0c6575a2018-11-07 16:05:30 +00001587{
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001588 psa_status_t status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine449bd832023-01-11 14:50:10 +01001589 psa_key_lifetime_t lifetime = psa_get_key_lifetime(attributes);
1590 mbedtls_svc_key_id_t key = psa_get_key_id(attributes);
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001591
Gilles Peskine449bd832023-01-11 14:50:10 +01001592 status = psa_validate_key_location(lifetime, p_drv);
1593 if (status != PSA_SUCCESS) {
1594 return status;
Ronald Crond2ed4812020-07-17 16:11:30 +02001595 }
1596
Gilles Peskine449bd832023-01-11 14:50:10 +01001597 status = psa_validate_key_persistence(lifetime);
1598 if (status != PSA_SUCCESS) {
1599 return status;
1600 }
1601
1602 if (PSA_KEY_LIFETIME_IS_VOLATILE(lifetime)) {
1603 if (MBEDTLS_SVC_KEY_ID_GET_KEY_ID(key) != 0) {
1604 return PSA_ERROR_INVALID_ARGUMENT;
1605 }
1606 } else {
1607 if (!psa_is_valid_key_id(psa_get_key_id(attributes), 0)) {
1608 return PSA_ERROR_INVALID_ARGUMENT;
1609 }
1610 }
1611
1612 status = psa_validate_key_policy(&attributes->core.policy);
1613 if (status != PSA_SUCCESS) {
1614 return status;
1615 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001616
1617 /* Refuse to create overly large keys.
1618 * Note that this doesn't trigger on import if the attributes don't
1619 * explicitly specify a size (so psa_get_key_bits returns 0), so
1620 * psa_import_key() needs its own checks. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001621 if (psa_get_key_bits(attributes) > PSA_MAX_KEY_BITS) {
1622 return PSA_ERROR_NOT_SUPPORTED;
1623 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001624
Gilles Peskine91e8c332019-08-02 19:19:39 +02001625 /* Reject invalid flags. These should not be reachable through the API. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001626 if (attributes->core.flags & ~(MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1627 MBEDTLS_PSA_KA_MASK_DUAL_USE)) {
1628 return PSA_ERROR_INVALID_ARGUMENT;
1629 }
Gilles Peskine91e8c332019-08-02 19:19:39 +02001630
Gilles Peskine449bd832023-01-11 14:50:10 +01001631 return PSA_SUCCESS;
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001632}
1633
Gilles Peskine4747d192019-04-17 15:05:45 +02001634/** Prepare a key slot to receive key material.
1635 *
1636 * This function allocates a key slot and sets its metadata.
1637 *
1638 * If this function fails, call psa_fail_key_creation().
1639 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001640 * This function is intended to be used as follows:
1641 * -# Call psa_start_key_creation() to allocate a key slot, prepare
Ronald Croncf56a0a2020-08-04 09:51:30 +02001642 * it with the specified attributes, and in case of a volatile key assign it
1643 * a volatile key identifier.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001644 * -# Populate the slot with the key material.
1645 * -# Call psa_finish_key_creation() to finalize the creation of the slot.
1646 * In case of failure at any step, stop the sequence and call
1647 * psa_fail_key_creation().
1648 *
Ryan Everettb69118e2024-01-02 15:54:32 +00001649 * On success, the key slot's state is PSA_SLOT_FILLING.
1650 * It is the responsibility of the caller to change the slot's state to
1651 * PSA_SLOT_EMPTY/FULL once key creation has finished.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001652 *
Gilles Peskinedf179142019-07-15 22:02:14 +02001653 * \param method An identification of the calling function.
Gilles Peskine011e4282019-06-26 18:34:38 +02001654 * \param[in] attributes Key attributes for the new key.
Gilles Peskine011e4282019-06-26 18:34:38 +02001655 * \param[out] p_slot On success, a pointer to the prepared slot.
1656 * \param[out] p_drv On any return, the driver for the key, if any.
1657 * NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001658 *
1659 * \retval #PSA_SUCCESS
1660 * The key slot is ready to receive key material.
1661 * \return If this function fails, the key slot is an invalid state.
1662 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001663 */
1664static psa_status_t psa_start_key_creation(
Gilles Peskinedf179142019-07-15 22:02:14 +02001665 psa_key_creation_method_t method,
Gilles Peskine4747d192019-04-17 15:05:45 +02001666 const psa_key_attributes_t *attributes,
Gilles Peskine011e4282019-06-26 18:34:38 +02001667 psa_key_slot_t **p_slot,
Gilles Peskine449bd832023-01-11 14:50:10 +01001668 psa_se_drv_table_entry_t **p_drv)
Gilles Peskine4747d192019-04-17 15:05:45 +02001669{
1670 psa_status_t status;
Ronald Cron2a993152020-07-17 14:13:26 +02001671 psa_key_id_t volatile_key_id;
Gilles Peskine4747d192019-04-17 15:05:45 +02001672 psa_key_slot_t *slot;
1673
Gilles Peskinedf179142019-07-15 22:02:14 +02001674 (void) method;
Gilles Peskine011e4282019-06-26 18:34:38 +02001675 *p_drv = NULL;
1676
Gilles Peskine449bd832023-01-11 14:50:10 +01001677 status = psa_validate_key_attributes(attributes, p_drv);
1678 if (status != PSA_SUCCESS) {
1679 return status;
1680 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001681
Ryan Everettb69118e2024-01-02 15:54:32 +00001682 status = psa_reserve_free_key_slot(&volatile_key_id, p_slot);
Gilles Peskine449bd832023-01-11 14:50:10 +01001683 if (status != PSA_SUCCESS) {
1684 return status;
1685 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001686 slot = *p_slot;
1687
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001688 /* We're storing the declared bit-size of the key. It's up to each
1689 * creation mechanism to verify that this information is correct.
1690 * It's automatically correct for mechanisms that use the bit-size as
Gilles Peskineb46bef22019-07-30 21:32:04 +02001691 * an input (generate, device) but not for those where the bit-size
Ronald Cronc4d1b512020-07-31 11:26:37 +02001692 * is optional (import, copy). In case of a volatile key, assign it the
1693 * volatile key identifier associated to the slot returned to contain its
1694 * definition. */
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001695
1696 slot->attr = attributes->core;
Gilles Peskine449bd832023-01-11 14:50:10 +01001697 if (PSA_KEY_LIFETIME_IS_VOLATILE(slot->attr.lifetime)) {
Ronald Cronc4d1b512020-07-31 11:26:37 +02001698#if !defined(MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER)
1699 slot->attr.id = volatile_key_id;
1700#else
1701 slot->attr.id.key_id = volatile_key_id;
1702#endif
1703 }
Gilles Peskinec744d992019-07-30 17:26:54 +02001704
Gilles Peskine91e8c332019-08-02 19:19:39 +02001705 /* Erase external-only flags from the internal copy. To access
Gilles Peskine013f5472019-08-07 15:42:14 +02001706 * external-only flags, query `attributes`. Thanks to the check
1707 * in psa_validate_key_attributes(), this leaves the dual-use
Ryan Everettb69118e2024-01-02 15:54:32 +00001708 * flags and any internal flag that psa_reserve_free_key_slot()
Gilles Peskine013f5472019-08-07 15:42:14 +02001709 * may have set. */
1710 slot->attr.flags &= ~MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY;
Gilles Peskine91e8c332019-08-02 19:19:39 +02001711
Gilles Peskinecbaff462019-07-12 23:46:04 +02001712#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001713 /* For a key in a secure element, we need to do three things
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001714 * when creating or registering a persistent key:
Gilles Peskine60450a42019-07-25 11:32:45 +02001715 * create the key file in internal storage, create the
1716 * key inside the secure element, and update the driver's
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001717 * persistent data. This is done by starting a transaction that will
1718 * encompass these three actions.
1719 * For registering a volatile key, we just need to find an appropriate
1720 * slot number inside the SE. Since the key is designated volatile, creating
1721 * a transaction is not required. */
Gilles Peskine60450a42019-07-25 11:32:45 +02001722 /* The first thing to do is to find a slot number for the new key.
1723 * We save the slot number in persistent storage as part of the
1724 * transaction data. It will be needed to recover if the power
1725 * fails during the key creation process, to clean up on the secure
1726 * element side after restarting. Obtaining a slot number from the
1727 * secure element driver updates its persistent state, but we do not yet
1728 * save the driver's persistent state, so that if the power fails,
Gilles Peskinefc762652019-07-22 19:30:34 +02001729 * we can roll back to a state where the key doesn't exist. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001730 if (*p_drv != NULL) {
Ronald Cronea0f8a62020-11-25 17:52:23 +01001731 psa_key_slot_number_t slot_number;
Gilles Peskine449bd832023-01-11 14:50:10 +01001732 status = psa_find_se_slot_for_key(attributes, method, *p_drv,
1733 &slot_number);
1734 if (status != PSA_SUCCESS) {
1735 return status;
1736 }
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001737
Gilles Peskine449bd832023-01-11 14:50:10 +01001738 if (!PSA_KEY_LIFETIME_IS_VOLATILE(attributes->core.lifetime)) {
1739 psa_crypto_prepare_transaction(PSA_CRYPTO_TRANSACTION_CREATE_KEY);
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001740 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001741 psa_crypto_transaction.key.slot = slot_number;
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001742 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskine449bd832023-01-11 14:50:10 +01001743 status = psa_crypto_save_transaction();
1744 if (status != PSA_SUCCESS) {
1745 (void) psa_crypto_stop_transaction();
1746 return status;
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001747 }
Gilles Peskine66be51c2019-07-25 18:02:52 +02001748 }
Ronald Cronea0f8a62020-11-25 17:52:23 +01001749
1750 status = psa_copy_key_material_into_slot(
Gilles Peskine449bd832023-01-11 14:50:10 +01001751 slot, (uint8_t *) (&slot_number), sizeof(slot_number));
Darryl Green0c6575a2018-11-07 16:05:30 +00001752 }
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001753
Gilles Peskine449bd832023-01-11 14:50:10 +01001754 if (*p_drv == NULL && method == PSA_KEY_CREATION_REGISTER) {
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001755 /* Key registration only makes sense with a secure element. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001756 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001757 }
Gilles Peskinecbaff462019-07-12 23:46:04 +02001758#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1759
Gilles Peskine449bd832023-01-11 14:50:10 +01001760 return PSA_SUCCESS;
Darryl Green0c6575a2018-11-07 16:05:30 +00001761}
Gilles Peskine4747d192019-04-17 15:05:45 +02001762
1763/** Finalize the creation of a key once its key material has been set.
1764 *
1765 * This entails writing the key to persistent storage.
1766 *
1767 * If this function fails, call psa_fail_key_creation().
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001768 * See the documentation of psa_start_key_creation() for the intended use
1769 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001770 *
Ryan Everettb69118e2024-01-02 15:54:32 +00001771 * If the finalization succeeds, the function sets the key slot's state to
1772 * PSA_SLOT_FULL, and the key slot can no longer be accessed as part of the
1773 * key creation process.
Ronald Cron50972942020-11-14 11:28:25 +01001774 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001775 * \param[in,out] slot Pointer to the slot with key material.
1776 * \param[in] driver The secure element driver for the key,
1777 * or NULL for a transparent key.
Ronald Cron81709fc2020-11-14 12:10:32 +01001778 * \param[out] key On success, identifier of the key. Note that the
1779 * key identifier is also stored in the key slot.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001780 *
1781 * \retval #PSA_SUCCESS
Ronald Croncf56a0a2020-08-04 09:51:30 +02001782 * The key was successfully created.
Gilles Peskineed733552023-02-14 19:21:09 +01001783 * \retval #PSA_ERROR_INSUFFICIENT_MEMORY \emptydescription
1784 * \retval #PSA_ERROR_INSUFFICIENT_STORAGE \emptydescription
1785 * \retval #PSA_ERROR_ALREADY_EXISTS \emptydescription
1786 * \retval #PSA_ERROR_DATA_INVALID \emptydescription
1787 * \retval #PSA_ERROR_DATA_CORRUPT \emptydescription
1788 * \retval #PSA_ERROR_STORAGE_FAILURE \emptydescription
gabor-mezei-arm452b0a32020-11-09 17:42:55 +01001789 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001790 * \return If this function fails, the key slot is an invalid state.
1791 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001792 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001793static psa_status_t psa_finish_key_creation(
1794 psa_key_slot_t *slot,
Ronald Cron81709fc2020-11-14 12:10:32 +01001795 psa_se_drv_table_entry_t *driver,
1796 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02001797{
1798 psa_status_t status = PSA_SUCCESS;
Gilles Peskine30afafd2019-04-25 13:47:40 +02001799 (void) slot;
Gilles Peskine011e4282019-06-26 18:34:38 +02001800 (void) driver;
Gilles Peskine4747d192019-04-17 15:05:45 +02001801
1802#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001803 if (!PSA_KEY_LIFETIME_IS_VOLATILE(slot->attr.lifetime)) {
Gilles Peskine1df83d42019-07-23 16:13:14 +02001804#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001805 if (driver != NULL) {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001806 psa_se_key_data_storage_t data;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001807 psa_key_slot_number_t slot_number =
Gilles Peskine449bd832023-01-11 14:50:10 +01001808 psa_key_slot_get_slot_number(slot);
Ronald Cronea0f8a62020-11-25 17:52:23 +01001809
Tom Cosgrove6ef9bb32023-03-08 14:19:51 +00001810 MBEDTLS_STATIC_ASSERT(sizeof(slot_number) ==
1811 sizeof(data.slot_number),
1812 "Slot number size does not match psa_se_key_data_storage_t");
1813
Gilles Peskine449bd832023-01-11 14:50:10 +01001814 memcpy(&data.slot_number, &slot_number, sizeof(slot_number));
1815 status = psa_save_persistent_key(&slot->attr,
1816 (uint8_t *) &data,
1817 sizeof(data));
1818 } else
Gilles Peskine1df83d42019-07-23 16:13:14 +02001819#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1820 {
Steven Cooreman40120f62020-10-29 11:42:22 +01001821 /* Key material is saved in export representation in the slot, so
1822 * just pass the slot buffer for storage. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001823 status = psa_save_persistent_key(&slot->attr,
1824 slot->key.data,
1825 slot->key.bytes);
Gilles Peskine1df83d42019-07-23 16:13:14 +02001826 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001827 }
Darryl Green0c6575a2018-11-07 16:05:30 +00001828#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
1829
Gilles Peskinecbaff462019-07-12 23:46:04 +02001830#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001831 /* Finish the transaction for a key creation. This does not
1832 * happen when registering an existing key. Detect this case
1833 * by checking whether a transaction is in progress (actual
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001834 * creation of a persistent key in a secure element requires a transaction,
1835 * but registration or volatile key creation doesn't use one). */
Gilles Peskine449bd832023-01-11 14:50:10 +01001836 if (driver != NULL &&
1837 psa_crypto_transaction.unknown.type == PSA_CRYPTO_TRANSACTION_CREATE_KEY) {
1838 status = psa_save_se_persistent_data(driver);
1839 if (status != PSA_SUCCESS) {
1840 psa_destroy_persistent_key(slot->attr.id);
1841 return status;
Gilles Peskinecbaff462019-07-12 23:46:04 +02001842 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001843 status = psa_crypto_stop_transaction();
Gilles Peskinecbaff462019-07-12 23:46:04 +02001844 }
1845#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1846
Gilles Peskine449bd832023-01-11 14:50:10 +01001847 if (status == PSA_SUCCESS) {
Ronald Cron81709fc2020-11-14 12:10:32 +01001848 *key = slot->attr.id;
Ryan Everettb69118e2024-01-02 15:54:32 +00001849 status = psa_key_slot_state_transition(slot, PSA_SLOT_FILLING,
1850 PSA_SLOT_FULL);
Gilles Peskine449bd832023-01-11 14:50:10 +01001851 if (status != PSA_SUCCESS) {
Ronald Cron81709fc2020-11-14 12:10:32 +01001852 *key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01001853 }
Ronald Cron81709fc2020-11-14 12:10:32 +01001854 }
Ronald Cron50972942020-11-14 11:28:25 +01001855
Gilles Peskine449bd832023-01-11 14:50:10 +01001856 return status;
Gilles Peskine4747d192019-04-17 15:05:45 +02001857}
1858
1859/** Abort the creation of a key.
1860 *
1861 * You may call this function after calling psa_start_key_creation(),
1862 * or after psa_finish_key_creation() fails. In other circumstances, this
1863 * function may not clean up persistent storage.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001864 * See the documentation of psa_start_key_creation() for the intended use
Ryan Everettb69118e2024-01-02 15:54:32 +00001865 * of this function. Sets the slot's state to PSA_SLOT_EMPTY.
Gilles Peskine4747d192019-04-17 15:05:45 +02001866 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001867 * \param[in,out] slot Pointer to the slot with key material.
1868 * \param[in] driver The secure element driver for the key,
1869 * or NULL for a transparent key.
Gilles Peskine4747d192019-04-17 15:05:45 +02001870 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001871static void psa_fail_key_creation(psa_key_slot_t *slot,
1872 psa_se_drv_table_entry_t *driver)
Gilles Peskine4747d192019-04-17 15:05:45 +02001873{
Gilles Peskine011e4282019-06-26 18:34:38 +02001874 (void) driver;
1875
Gilles Peskine449bd832023-01-11 14:50:10 +01001876 if (slot == NULL) {
Gilles Peskine4747d192019-04-17 15:05:45 +02001877 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01001878 }
Gilles Peskine011e4282019-06-26 18:34:38 +02001879
1880#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001881 /* TODO: If the key has already been created in the secure
Gilles Peskine011e4282019-06-26 18:34:38 +02001882 * element, and the failure happened later (when saving metadata
1883 * to internal storage), we need to destroy the key in the secure
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001884 * element.
1885 * https://github.com/ARMmbed/mbed-crypto/issues/217
1886 */
Gilles Peskinefc762652019-07-22 19:30:34 +02001887
Gilles Peskined7729582019-08-05 15:55:54 +02001888 /* Abort the ongoing transaction if any (there may not be one if
1889 * the creation process failed before starting one, or if the
1890 * key creation is a registration of a key in a secure element).
1891 * Earlier functions must already have done what it takes to undo any
1892 * partial creation. All that's left is to update the transaction data
1893 * itself. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001894 (void) psa_crypto_stop_transaction();
Gilles Peskine011e4282019-06-26 18:34:38 +02001895#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1896
Gilles Peskine449bd832023-01-11 14:50:10 +01001897 psa_wipe_key_slot(slot);
Gilles Peskine4747d192019-04-17 15:05:45 +02001898}
1899
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001900/** Validate optional attributes during key creation.
1901 *
1902 * Some key attributes are optional during key creation. If they are
1903 * specified in the attributes structure, check that they are consistent
1904 * with the data in the slot.
1905 *
1906 * This function should be called near the end of key creation, after
1907 * the slot in memory is fully populated but before saving persistent data.
1908 */
1909static psa_status_t psa_validate_optional_attributes(
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001910 const psa_key_slot_t *slot,
Gilles Peskine449bd832023-01-11 14:50:10 +01001911 const psa_key_attributes_t *attributes)
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001912{
Gilles Peskine449bd832023-01-11 14:50:10 +01001913 if (attributes->core.type != 0) {
1914 if (attributes->core.type != slot->attr.type) {
1915 return PSA_ERROR_INVALID_ARGUMENT;
1916 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001917 }
1918
Gilles Peskine449bd832023-01-11 14:50:10 +01001919 if (attributes->domain_parameters_size != 0) {
Valerio Settib2bcedb2023-07-10 11:24:00 +02001920#if (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) && \
1921 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01001922 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
1923 if (PSA_KEY_TYPE_IS_RSA(slot->attr.type)) {
Steven Cooremana2371e52020-07-28 14:30:39 +02001924 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman75b74362020-07-28 14:30:13 +02001925 mbedtls_mpi actual, required;
Steven Cooreman6d839f02020-07-30 11:36:45 +02001926 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooremana01795d2020-07-24 22:48:15 +02001927
Ronald Cron90857082020-11-25 14:58:33 +01001928 psa_status_t status = mbedtls_psa_rsa_load_representation(
Gilles Peskine449bd832023-01-11 14:50:10 +01001929 slot->attr.type,
1930 slot->key.data,
1931 slot->key.bytes,
1932 &rsa);
1933 if (status != PSA_SUCCESS) {
1934 return status;
1935 }
Steven Cooreman75b74362020-07-28 14:30:13 +02001936
Gilles Peskine449bd832023-01-11 14:50:10 +01001937 mbedtls_mpi_init(&actual);
1938 mbedtls_mpi_init(&required);
1939 ret = mbedtls_rsa_export(rsa,
1940 NULL, NULL, NULL, NULL, &actual);
1941 mbedtls_rsa_free(rsa);
1942 mbedtls_free(rsa);
1943 if (ret != 0) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001944 goto rsa_exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001945 }
1946 ret = mbedtls_mpi_read_binary(&required,
1947 attributes->domain_parameters,
1948 attributes->domain_parameters_size);
1949 if (ret != 0) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001950 goto rsa_exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001951 }
1952 if (mbedtls_mpi_cmp_mpi(&actual, &required) != 0) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001953 ret = MBEDTLS_ERR_RSA_BAD_INPUT_DATA;
Gilles Peskine449bd832023-01-11 14:50:10 +01001954 }
1955rsa_exit:
1956 mbedtls_mpi_free(&actual);
1957 mbedtls_mpi_free(&required);
1958 if (ret != 0) {
1959 return mbedtls_to_psa_error(ret);
1960 }
1961 } else
Valerio Settib2bcedb2023-07-10 11:24:00 +02001962#endif /* (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) &&
1963 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) ||
John Durkop9814fa22020-11-04 12:28:15 -08001964 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001965 {
Gilles Peskine449bd832023-01-11 14:50:10 +01001966 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001967 }
1968 }
1969
Gilles Peskine449bd832023-01-11 14:50:10 +01001970 if (attributes->core.bits != 0) {
1971 if (attributes->core.bits != slot->attr.bits) {
1972 return PSA_ERROR_INVALID_ARGUMENT;
1973 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001974 }
1975
Gilles Peskine449bd832023-01-11 14:50:10 +01001976 return PSA_SUCCESS;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001977}
1978
Gilles Peskine449bd832023-01-11 14:50:10 +01001979psa_status_t psa_import_key(const psa_key_attributes_t *attributes,
1980 const uint8_t *data,
1981 size_t data_length,
1982 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02001983{
1984 psa_status_t status;
1985 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001986 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001987 size_t bits;
Archanad8a83dc2021-06-14 10:04:16 +05301988 size_t storage_size = data_length;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001989
Ronald Cron81709fc2020-11-14 12:10:32 +01001990 *key = MBEDTLS_SVC_KEY_ID_INIT;
1991
Gilles Peskine0f84d622019-09-12 19:03:13 +02001992 /* Reject zero-length symmetric keys (including raw data key objects).
1993 * This also rejects any key which might be encoded as an empty string,
1994 * which is never valid. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001995 if (data_length == 0) {
1996 return PSA_ERROR_INVALID_ARGUMENT;
1997 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02001998
Archana449608b2021-09-08 15:36:05 +05301999 /* Ensure that the bytes-to-bits conversion cannot overflow. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002000 if (data_length > SIZE_MAX / 8) {
2001 return PSA_ERROR_NOT_SUPPORTED;
2002 }
Archana6ed4bda2021-08-04 10:47:15 +05302003
Gilles Peskine449bd832023-01-11 14:50:10 +01002004 status = psa_start_key_creation(PSA_KEY_CREATION_IMPORT, attributes,
2005 &slot, &driver);
2006 if (status != PSA_SUCCESS) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002007 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002008 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002009
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002010 /* In the case of a transparent key or an opaque key stored in local
Archana449608b2021-09-08 15:36:05 +05302011 * storage ( thus not in the case of importing a key in a secure element
2012 * with storage ( MBEDTLS_PSA_CRYPTO_SE_C ) ),we have to allocate a
2013 * buffer to hold the imported key material. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002014 if (slot->key.data == NULL) {
2015 if (psa_key_lifetime_is_external(attributes->core.lifetime)) {
Archana449608b2021-09-08 15:36:05 +05302016 status = psa_driver_wrapper_get_key_buffer_size_from_key_data(
Gilles Peskine449bd832023-01-11 14:50:10 +01002017 attributes, data, data_length, &storage_size);
2018 if (status != PSA_SUCCESS) {
Archanad8a83dc2021-06-14 10:04:16 +05302019 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002020 }
Archanad8a83dc2021-06-14 10:04:16 +05302021 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002022 status = psa_allocate_buffer_to_slot(slot, storage_size);
2023 if (status != PSA_SUCCESS) {
Gilles Peskineb46bef22019-07-30 21:32:04 +02002024 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002025 }
Gilles Peskine5d309672019-07-12 23:47:28 +02002026 }
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002027
2028 bits = slot->attr.bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01002029 status = psa_driver_wrapper_import_key(attributes,
2030 data, data_length,
2031 slot->key.data,
2032 slot->key.bytes,
2033 &slot->key.bytes, &bits);
2034 if (status != PSA_SUCCESS) {
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002035 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002036 }
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002037
Gilles Peskine449bd832023-01-11 14:50:10 +01002038 if (slot->attr.bits == 0) {
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002039 slot->attr.bits = (psa_key_bits_t) bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01002040 } else if (bits != slot->attr.bits) {
Steven Cooremanac3434f2021-01-15 17:36:02 +01002041 status = PSA_ERROR_INVALID_ARGUMENT;
2042 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02002043 }
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01002044
Archana6ed4bda2021-08-04 10:47:15 +05302045 /* Enforce a size limit, and in particular ensure that the bit
2046 * size fits in its representation type.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01002047 if (bits > PSA_MAX_KEY_BITS) {
Archana6ed4bda2021-08-04 10:47:15 +05302048 status = PSA_ERROR_NOT_SUPPORTED;
2049 goto exit;
2050 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002051 status = psa_validate_optional_attributes(slot, attributes);
2052 if (status != PSA_SUCCESS) {
Gilles Peskine18017402019-07-24 20:25:59 +02002053 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002054 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002055
Gilles Peskine449bd832023-01-11 14:50:10 +01002056 status = psa_finish_key_creation(slot, driver, key);
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002057exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002058 if (status != PSA_SUCCESS) {
2059 psa_fail_key_creation(slot, driver);
2060 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002061
Gilles Peskine449bd832023-01-11 14:50:10 +01002062 return status;
Gilles Peskine4747d192019-04-17 15:05:45 +02002063}
2064
Gilles Peskined7729582019-08-05 15:55:54 +02002065#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2066psa_status_t mbedtls_psa_register_se_key(
Gilles Peskine449bd832023-01-11 14:50:10 +01002067 const psa_key_attributes_t *attributes)
Gilles Peskined7729582019-08-05 15:55:54 +02002068{
2069 psa_status_t status;
2070 psa_key_slot_t *slot = NULL;
2071 psa_se_drv_table_entry_t *driver = NULL;
Ronald Croncf56a0a2020-08-04 09:51:30 +02002072 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskined7729582019-08-05 15:55:54 +02002073
2074 /* Leaving attributes unspecified is not currently supported.
2075 * It could make sense to query the key type and size from the
2076 * secure element, but not all secure elements support this
2077 * and the driver HAL doesn't currently support it. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002078 if (psa_get_key_type(attributes) == PSA_KEY_TYPE_NONE) {
2079 return PSA_ERROR_NOT_SUPPORTED;
2080 }
2081 if (psa_get_key_bits(attributes) == 0) {
2082 return PSA_ERROR_NOT_SUPPORTED;
2083 }
Gilles Peskined7729582019-08-05 15:55:54 +02002084
Gilles Peskine449bd832023-01-11 14:50:10 +01002085 status = psa_start_key_creation(PSA_KEY_CREATION_REGISTER, attributes,
2086 &slot, &driver);
2087 if (status != PSA_SUCCESS) {
Gilles Peskined7729582019-08-05 15:55:54 +02002088 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002089 }
Gilles Peskined7729582019-08-05 15:55:54 +02002090
Gilles Peskine449bd832023-01-11 14:50:10 +01002091 status = psa_finish_key_creation(slot, driver, &key);
Gilles Peskined7729582019-08-05 15:55:54 +02002092
2093exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002094 if (status != PSA_SUCCESS) {
2095 psa_fail_key_creation(slot, driver);
2096 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002097
Gilles Peskined7729582019-08-05 15:55:54 +02002098 /* Registration doesn't keep the key in RAM. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002099 psa_close_key(key);
2100 return status;
Gilles Peskined7729582019-08-05 15:55:54 +02002101}
2102#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2103
Gilles Peskine449bd832023-01-11 14:50:10 +01002104psa_status_t psa_copy_key(mbedtls_svc_key_id_t source_key,
2105 const psa_key_attributes_t *specified_attributes,
2106 mbedtls_svc_key_id_t *target_key)
Gilles Peskinef603c712019-01-19 13:40:11 +01002107{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002108 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01002109 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinef603c712019-01-19 13:40:11 +01002110 psa_key_slot_t *source_slot = NULL;
2111 psa_key_slot_t *target_slot = NULL;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002112 psa_key_attributes_t actual_attributes = *specified_attributes;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002113 psa_se_drv_table_entry_t *driver = NULL;
Archana8a180362021-07-05 02:18:48 +05302114 size_t storage_size = 0;
Gilles Peskinef603c712019-01-19 13:40:11 +01002115
Ronald Cron81709fc2020-11-14 12:10:32 +01002116 *target_key = MBEDTLS_SVC_KEY_ID_INIT;
2117
Archana8a180362021-07-05 02:18:48 +05302118 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002119 source_key, &source_slot, PSA_KEY_USAGE_COPY, 0);
2120 if (status != PSA_SUCCESS) {
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002121 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002122 }
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002123
Gilles Peskine449bd832023-01-11 14:50:10 +01002124 status = psa_validate_optional_attributes(source_slot,
2125 specified_attributes);
2126 if (status != PSA_SUCCESS) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002127 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002128 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002129
Archana9d17bf42021-09-10 06:22:44 +05302130 /* The target key type and number of bits have been validated by
2131 * psa_validate_optional_attributes() to be either equal to zero or
2132 * equal to the ones of the source key. So it is safe to inherit
2133 * them from the source key now."
Archana374fe5b2021-09-08 15:50:28 +05302134 * */
Archana9d17bf42021-09-10 06:22:44 +05302135 actual_attributes.core.bits = source_slot->attr.bits;
2136 actual_attributes.core.type = source_slot->attr.type;
Archana374fe5b2021-09-08 15:50:28 +05302137
2138
Gilles Peskine449bd832023-01-11 14:50:10 +01002139 status = psa_restrict_key_policy(source_slot->attr.type,
2140 &actual_attributes.core.policy,
2141 &source_slot->attr.policy);
2142 if (status != PSA_SUCCESS) {
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002143 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002144 }
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002145
Gilles Peskine449bd832023-01-11 14:50:10 +01002146 status = psa_start_key_creation(PSA_KEY_CREATION_COPY, &actual_attributes,
2147 &target_slot, &driver);
2148 if (status != PSA_SUCCESS) {
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002149 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002150 }
2151 if (PSA_KEY_LIFETIME_GET_LOCATION(target_slot->attr.lifetime) !=
2152 PSA_KEY_LIFETIME_GET_LOCATION(source_slot->attr.lifetime)) {
Archana8a180362021-07-05 02:18:48 +05302153 /*
Archana9d17bf42021-09-10 06:22:44 +05302154 * If the source and target keys are stored in different locations,
Archana8a180362021-07-05 02:18:48 +05302155 * the source key would need to be exported as plaintext and re-imported
2156 * in the other location. This has security implications which have not
Archana449608b2021-09-08 15:36:05 +05302157 * been fully mapped. For now, this can be achieved through
Archana8a180362021-07-05 02:18:48 +05302158 * appropriate API invocations from the application, if needed.
2159 * */
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002160 status = PSA_ERROR_NOT_SUPPORTED;
2161 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002162 }
Archana8a180362021-07-05 02:18:48 +05302163 /*
2164 * When the source and target keys are within the same location,
Archana449608b2021-09-08 15:36:05 +05302165 * - For transparent keys it is a blind copy without any driver invocation,
Archana8a180362021-07-05 02:18:48 +05302166 * - For opaque keys this translates to an invocation of the drivers'
2167 * copy_key entry point through the dispatch layer.
2168 * */
Gilles Peskine449bd832023-01-11 14:50:10 +01002169 if (psa_key_lifetime_is_external(actual_attributes.core.lifetime)) {
2170 status = psa_driver_wrapper_get_key_buffer_size(&actual_attributes,
2171 &storage_size);
2172 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302173 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002174 }
Archana374fe5b2021-09-08 15:50:28 +05302175
Gilles Peskine449bd832023-01-11 14:50:10 +01002176 status = psa_allocate_buffer_to_slot(target_slot, storage_size);
2177 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302178 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002179 }
Archana374fe5b2021-09-08 15:50:28 +05302180
Gilles Peskine449bd832023-01-11 14:50:10 +01002181 status = psa_driver_wrapper_copy_key(&actual_attributes,
2182 source_slot->key.data,
2183 source_slot->key.bytes,
2184 target_slot->key.data,
2185 target_slot->key.bytes,
2186 &target_slot->key.bytes);
2187 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302188 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002189 }
2190 } else {
2191 status = psa_copy_key_material_into_slot(target_slot,
Archana9d17bf42021-09-10 06:22:44 +05302192 source_slot->key.data,
Gilles Peskine449bd832023-01-11 14:50:10 +01002193 source_slot->key.bytes);
2194 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302195 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002196 }
Archana8a180362021-07-05 02:18:48 +05302197 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002198 status = psa_finish_key_creation(target_slot, driver, target_key);
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002199exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002200 if (status != PSA_SUCCESS) {
2201 psa_fail_key_creation(target_slot, driver);
2202 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002203
Ryan Everett1b70a072024-01-04 10:32:49 +00002204 unlock_status = psa_unregister_read(source_slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02002205
Gilles Peskine449bd832023-01-11 14:50:10 +01002206 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskinef603c712019-01-19 13:40:11 +01002207}
2208
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02002209
2210
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01002211/****************************************************************/
Gilles Peskine20035e32018-02-03 22:44:14 +01002212/* Message digests */
2213/****************************************************************/
2214
Gilles Peskine449bd832023-01-11 14:50:10 +01002215psa_status_t psa_hash_abort(psa_hash_operation_t *operation)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002216{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002217 /* Aborting a non-active operation is allowed */
Gilles Peskine449bd832023-01-11 14:50:10 +01002218 if (operation->id == 0) {
2219 return PSA_SUCCESS;
2220 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002221
Gilles Peskine449bd832023-01-11 14:50:10 +01002222 psa_status_t status = psa_driver_wrapper_hash_abort(operation);
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002223 operation->id = 0;
2224
Gilles Peskine449bd832023-01-11 14:50:10 +01002225 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002226}
2227
Gilles Peskine449bd832023-01-11 14:50:10 +01002228psa_status_t psa_hash_setup(psa_hash_operation_t *operation,
2229 psa_algorithm_t alg)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002230{
Dave Rodgman685b6a72021-06-24 11:49:14 +01002231 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002232
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002233 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002234 if (operation->id != 0) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002235 status = PSA_ERROR_BAD_STATE;
2236 goto exit;
2237 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002238
Gilles Peskine449bd832023-01-11 14:50:10 +01002239 if (!PSA_ALG_IS_HASH(alg)) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002240 status = PSA_ERROR_INVALID_ARGUMENT;
2241 goto exit;
2242 }
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002243
Steven Cooremanb6bf4bb2021-03-15 19:00:14 +01002244 /* Ensure all of the context is zeroized, since PSA_HASH_OPERATION_INIT only
2245 * directly zeroes the int-sized dummy member of the context union. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002246 memset(&operation->ctx, 0, sizeof(operation->ctx));
Steven Cooreman893232f2021-03-15 12:23:37 +01002247
Gilles Peskine449bd832023-01-11 14:50:10 +01002248 status = psa_driver_wrapper_hash_setup(operation, alg);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002249
2250exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002251 if (status != PSA_SUCCESS) {
2252 psa_hash_abort(operation);
2253 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002254
2255 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002256}
2257
Gilles Peskine449bd832023-01-11 14:50:10 +01002258psa_status_t psa_hash_update(psa_hash_operation_t *operation,
2259 const uint8_t *input,
2260 size_t input_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002261{
Dave Rodgman685b6a72021-06-24 11:49:14 +01002262 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2263
Gilles Peskine449bd832023-01-11 14:50:10 +01002264 if (operation->id == 0) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002265 status = PSA_ERROR_BAD_STATE;
2266 goto exit;
2267 }
Gilles Peskine94e44542018-07-12 16:58:43 +02002268
Steven Cooremanc8288352021-03-04 14:02:19 +01002269 /* Don't require hash implementations to behave correctly on a
2270 * zero-length input, which may have an invalid pointer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002271 if (input_length == 0) {
2272 return PSA_SUCCESS;
2273 }
Steven Cooremanc8288352021-03-04 14:02:19 +01002274
Gilles Peskine449bd832023-01-11 14:50:10 +01002275 status = psa_driver_wrapper_hash_update(operation, input, input_length);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002276
2277exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002278 if (status != PSA_SUCCESS) {
2279 psa_hash_abort(operation);
2280 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002281
Gilles Peskine449bd832023-01-11 14:50:10 +01002282 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002283}
2284
Gilles Peskine449bd832023-01-11 14:50:10 +01002285psa_status_t psa_hash_finish(psa_hash_operation_t *operation,
2286 uint8_t *hash,
2287 size_t hash_size,
2288 size_t *hash_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002289{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002290 *hash_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002291 if (operation->id == 0) {
2292 return PSA_ERROR_BAD_STATE;
2293 }
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002294
Steven Cooreman1e582352021-02-18 17:24:37 +01002295 psa_status_t status = psa_driver_wrapper_hash_finish(
Gilles Peskine449bd832023-01-11 14:50:10 +01002296 operation, hash, hash_size, hash_length);
2297 psa_hash_abort(operation);
2298 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002299}
2300
Gilles Peskine449bd832023-01-11 14:50:10 +01002301psa_status_t psa_hash_verify(psa_hash_operation_t *operation,
2302 const uint8_t *hash,
2303 size_t hash_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002304{
Ronald Cron69a63422021-10-18 09:47:58 +02002305 uint8_t actual_hash[PSA_HASH_MAX_SIZE];
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002306 size_t actual_hash_length;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002307 psa_status_t status = psa_hash_finish(
Gilles Peskine449bd832023-01-11 14:50:10 +01002308 operation,
2309 actual_hash, sizeof(actual_hash),
2310 &actual_hash_length);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002311
Gilles Peskine449bd832023-01-11 14:50:10 +01002312 if (status != PSA_SUCCESS) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002313 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002314 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002315
Gilles Peskine449bd832023-01-11 14:50:10 +01002316 if (actual_hash_length != hash_length) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002317 status = PSA_ERROR_INVALID_SIGNATURE;
2318 goto exit;
2319 }
2320
Dave Rodgman78701152023-08-29 14:20:18 +01002321 if (mbedtls_ct_memcmp(hash, actual_hash, actual_hash_length) != 0) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002322 status = PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01002323 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002324
2325exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002326 mbedtls_platform_zeroize(actual_hash, sizeof(actual_hash));
2327 if (status != PSA_SUCCESS) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002328 psa_hash_abort(operation);
Gilles Peskine449bd832023-01-11 14:50:10 +01002329 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002330
Gilles Peskine449bd832023-01-11 14:50:10 +01002331 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002332}
2333
Gilles Peskine449bd832023-01-11 14:50:10 +01002334psa_status_t psa_hash_compute(psa_algorithm_t alg,
2335 const uint8_t *input, size_t input_length,
2336 uint8_t *hash, size_t hash_size,
2337 size_t *hash_length)
Gilles Peskine0a749c82019-11-28 19:33:58 +01002338{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002339 *hash_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002340 if (!PSA_ALG_IS_HASH(alg)) {
2341 return PSA_ERROR_INVALID_ARGUMENT;
2342 }
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002343
Gilles Peskine449bd832023-01-11 14:50:10 +01002344 return psa_driver_wrapper_hash_compute(alg, input, input_length,
2345 hash, hash_size, hash_length);
Gilles Peskine0a749c82019-11-28 19:33:58 +01002346}
2347
Gilles Peskine449bd832023-01-11 14:50:10 +01002348psa_status_t psa_hash_compare(psa_algorithm_t alg,
2349 const uint8_t *input, size_t input_length,
2350 const uint8_t *hash, size_t hash_length)
Gilles Peskine0a749c82019-11-28 19:33:58 +01002351{
Ronald Cron69a63422021-10-18 09:47:58 +02002352 uint8_t actual_hash[PSA_HASH_MAX_SIZE];
Steven Cooreman84d670d2021-02-18 16:22:53 +01002353 size_t actual_hash_length;
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002354
Gilles Peskine449bd832023-01-11 14:50:10 +01002355 if (!PSA_ALG_IS_HASH(alg)) {
2356 return PSA_ERROR_INVALID_ARGUMENT;
2357 }
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002358
Steven Cooreman1e582352021-02-18 17:24:37 +01002359 psa_status_t status = psa_driver_wrapper_hash_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01002360 alg, input, input_length,
2361 actual_hash, sizeof(actual_hash),
2362 &actual_hash_length);
2363 if (status != PSA_SUCCESS) {
Gilles Peskine60aebec2021-12-13 12:33:18 +01002364 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002365 }
2366 if (actual_hash_length != hash_length) {
Gilles Peskine60aebec2021-12-13 12:33:18 +01002367 status = PSA_ERROR_INVALID_SIGNATURE;
2368 goto exit;
2369 }
Dave Rodgman78701152023-08-29 14:20:18 +01002370 if (mbedtls_ct_memcmp(hash, actual_hash, actual_hash_length) != 0) {
Gilles Peskine60aebec2021-12-13 12:33:18 +01002371 status = PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01002372 }
Gilles Peskine60aebec2021-12-13 12:33:18 +01002373
2374exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002375 mbedtls_platform_zeroize(actual_hash, sizeof(actual_hash));
2376 return status;
Gilles Peskine0a749c82019-11-28 19:33:58 +01002377}
2378
Gilles Peskine449bd832023-01-11 14:50:10 +01002379psa_status_t psa_hash_clone(const psa_hash_operation_t *source_operation,
2380 psa_hash_operation_t *target_operation)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002381{
Gilles Peskine449bd832023-01-11 14:50:10 +01002382 if (source_operation->id == 0 ||
2383 target_operation->id != 0) {
2384 return PSA_ERROR_BAD_STATE;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002385 }
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002386
Gilles Peskine449bd832023-01-11 14:50:10 +01002387 psa_status_t status = psa_driver_wrapper_hash_clone(source_operation,
2388 target_operation);
2389 if (status != PSA_SUCCESS) {
2390 psa_hash_abort(target_operation);
2391 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002392
Gilles Peskine449bd832023-01-11 14:50:10 +01002393 return status;
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002394}
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002395
2396
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002397/****************************************************************/
Gilles Peskine8c9def32018-02-08 10:02:12 +01002398/* MAC */
2399/****************************************************************/
2400
Gilles Peskine449bd832023-01-11 14:50:10 +01002401psa_status_t psa_mac_abort(psa_mac_operation_t *operation)
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002402{
Steven Cooremane6804192021-03-19 18:28:56 +01002403 /* Aborting a non-active operation is allowed */
Gilles Peskine449bd832023-01-11 14:50:10 +01002404 if (operation->id == 0) {
2405 return PSA_SUCCESS;
2406 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002407
Gilles Peskine449bd832023-01-11 14:50:10 +01002408 psa_status_t status = psa_driver_wrapper_mac_abort(operation);
Steven Cooreman72f736a2021-05-07 14:14:37 +02002409 operation->mac_size = 0;
2410 operation->is_sign = 0;
Steven Cooremane6804192021-03-19 18:28:56 +01002411 operation->id = 0;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002412
Gilles Peskine449bd832023-01-11 14:50:10 +01002413 return status;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002414}
2415
Ronald Cron2dff3b22021-06-17 16:33:22 +02002416static psa_status_t psa_mac_finalize_alg_and_key_validation(
2417 psa_algorithm_t alg,
Ronald Cron79bdd822021-06-17 16:46:44 +02002418 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01002419 uint8_t *mac_size)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002420{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002421 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002422 psa_key_type_t key_type = psa_get_key_type(attributes);
2423 size_t key_bits = psa_get_key_bits(attributes);
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002424
Gilles Peskine449bd832023-01-11 14:50:10 +01002425 if (!PSA_ALG_IS_MAC(alg)) {
2426 return PSA_ERROR_INVALID_ARGUMENT;
2427 }
Steven Cooremane6804192021-03-19 18:28:56 +01002428
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002429 /* Validate the combination of key type and algorithm */
Gilles Peskine449bd832023-01-11 14:50:10 +01002430 status = psa_mac_key_can_do(alg, key_type);
2431 if (status != PSA_SUCCESS) {
2432 return status;
2433 }
Steven Cooreman15472f82021-03-02 16:16:22 +01002434
Steven Cooremand1a68f12021-05-10 11:13:41 +02002435 /* Get the output length for the algorithm and key combination */
Gilles Peskine449bd832023-01-11 14:50:10 +01002436 *mac_size = PSA_MAC_LENGTH(key_type, key_bits, alg);
Steven Cooreman15472f82021-03-02 16:16:22 +01002437
Gilles Peskine449bd832023-01-11 14:50:10 +01002438 if (*mac_size < 4) {
Steven Cooreman15472f82021-03-02 16:16:22 +01002439 /* A very short MAC is too short for security since it can be
2440 * brute-forced. Ancient protocols with 32-bit MACs do exist,
2441 * so we make this our minimum, even though 32 bits is still
2442 * too small for security. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002443 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman15472f82021-03-02 16:16:22 +01002444 }
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02002445
Gilles Peskine449bd832023-01-11 14:50:10 +01002446 if (*mac_size > PSA_MAC_LENGTH(key_type, key_bits,
2447 PSA_ALG_FULL_LENGTH_MAC(alg))) {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002448 /* It's impossible to "truncate" to a larger length than the full length
2449 * of the algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002450 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002451 }
2452
Gilles Peskine449bd832023-01-11 14:50:10 +01002453 if (*mac_size > PSA_MAC_MAX_SIZE) {
Gilles Peskinea9b6c802022-03-16 13:54:49 +01002454 /* PSA_MAC_LENGTH returns the correct length even for a MAC algorithm
2455 * that is disabled in the compile-time configuration. The result can
2456 * therefore be larger than PSA_MAC_MAX_SIZE, which does take the
2457 * configuration into account. In this case, force a return of
2458 * PSA_ERROR_NOT_SUPPORTED here. Otherwise psa_mac_verify(), or
2459 * psa_mac_compute(mac_size=PSA_MAC_MAX_SIZE), would return
2460 * PSA_ERROR_BUFFER_TOO_SMALL for an unsupported algorithm whose MAC size
2461 * is larger than PSA_MAC_MAX_SIZE, which is misleading and which breaks
2462 * systematically generated tests. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002463 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea9b6c802022-03-16 13:54:49 +01002464 }
2465
Gilles Peskine449bd832023-01-11 14:50:10 +01002466 return PSA_SUCCESS;
Ronald Cron2dff3b22021-06-17 16:33:22 +02002467}
2468
Gilles Peskine449bd832023-01-11 14:50:10 +01002469static psa_status_t psa_mac_setup(psa_mac_operation_t *operation,
2470 mbedtls_svc_key_id_t key,
2471 psa_algorithm_t alg,
2472 int is_sign)
Gilles Peskinee59236f2018-01-27 23:32:46 +01002473{
2474 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2475 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman54648242021-06-24 11:49:45 +01002476 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002477 psa_key_attributes_t attributes;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002478
2479 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002480 if (operation->id != 0) {
Dave Rodgman54648242021-06-24 11:49:45 +01002481 status = PSA_ERROR_BAD_STATE;
2482 goto exit;
2483 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002484
2485 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002486 key,
2487 &slot,
2488 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
2489 alg);
2490 if (status != PSA_SUCCESS) {
Dave Rodgman54648242021-06-24 11:49:45 +01002491 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002492 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002493
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002494 attributes = (psa_key_attributes_t) {
Gilles Peskine8c9def32018-02-08 10:02:12 +01002495 .core = slot->attr
2496 };
2497
Gilles Peskine449bd832023-01-11 14:50:10 +01002498 status = psa_mac_finalize_alg_and_key_validation(alg, &attributes,
2499 &operation->mac_size);
2500 if (status != PSA_SUCCESS) {
Gilles Peskine8c9def32018-02-08 10:02:12 +01002501 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002502 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002503
2504 operation->is_sign = is_sign;
Steven Cooremane6804192021-03-19 18:28:56 +01002505 /* Dispatch the MAC setup call with validated input */
Gilles Peskine449bd832023-01-11 14:50:10 +01002506 if (is_sign) {
2507 status = psa_driver_wrapper_mac_sign_setup(operation,
2508 &attributes,
2509 slot->key.data,
2510 slot->key.bytes,
2511 alg);
2512 } else {
2513 status = psa_driver_wrapper_mac_verify_setup(operation,
2514 &attributes,
2515 slot->key.data,
2516 slot->key.bytes,
2517 alg);
Gilles Peskine8c9def32018-02-08 10:02:12 +01002518 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002519
Gilles Peskinefbfac682018-07-08 20:51:54 +02002520exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002521 if (status != PSA_SUCCESS) {
2522 psa_mac_abort(operation);
2523 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002524
Ryan Everett1b70a072024-01-04 10:32:49 +00002525 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02002526
Gilles Peskine449bd832023-01-11 14:50:10 +01002527 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002528}
2529
Gilles Peskine449bd832023-01-11 14:50:10 +01002530psa_status_t psa_mac_sign_setup(psa_mac_operation_t *operation,
2531 mbedtls_svc_key_id_t key,
2532 psa_algorithm_t alg)
Gilles Peskine89167cb2018-07-08 20:12:23 +02002533{
Gilles Peskine449bd832023-01-11 14:50:10 +01002534 return psa_mac_setup(operation, key, alg, 1);
Gilles Peskine89167cb2018-07-08 20:12:23 +02002535}
2536
Gilles Peskine449bd832023-01-11 14:50:10 +01002537psa_status_t psa_mac_verify_setup(psa_mac_operation_t *operation,
2538 mbedtls_svc_key_id_t key,
2539 psa_algorithm_t alg)
Gilles Peskine89167cb2018-07-08 20:12:23 +02002540{
Gilles Peskine449bd832023-01-11 14:50:10 +01002541 return psa_mac_setup(operation, key, alg, 0);
Gilles Peskine89167cb2018-07-08 20:12:23 +02002542}
2543
Gilles Peskine449bd832023-01-11 14:50:10 +01002544psa_status_t psa_mac_update(psa_mac_operation_t *operation,
2545 const uint8_t *input,
2546 size_t input_length)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002547{
Gilles Peskine449bd832023-01-11 14:50:10 +01002548 if (operation->id == 0) {
2549 return PSA_ERROR_BAD_STATE;
2550 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002551
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002552 /* Don't require hash implementations to behave correctly on a
2553 * zero-length input, which may have an invalid pointer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002554 if (input_length == 0) {
2555 return PSA_SUCCESS;
2556 }
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03002557
Gilles Peskine449bd832023-01-11 14:50:10 +01002558 psa_status_t status = psa_driver_wrapper_mac_update(operation,
2559 input, input_length);
2560 if (status != PSA_SUCCESS) {
2561 psa_mac_abort(operation);
2562 }
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002563
Gilles Peskine449bd832023-01-11 14:50:10 +01002564 return status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002565}
2566
Gilles Peskine449bd832023-01-11 14:50:10 +01002567psa_status_t psa_mac_sign_finish(psa_mac_operation_t *operation,
2568 uint8_t *mac,
2569 size_t mac_size,
2570 size_t *mac_length)
mohammad16036df908f2018-04-02 08:34:15 -07002571{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002572 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2573 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002574
Gilles Peskine449bd832023-01-11 14:50:10 +01002575 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002576 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002577 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002578 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002579
Gilles Peskine449bd832023-01-11 14:50:10 +01002580 if (!operation->is_sign) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002581 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002582 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002583 }
Steven Cooreman72f736a2021-05-07 14:14:37 +02002584
Steven Cooreman8af5c5c2021-05-11 11:09:13 +02002585 /* Sanity check. This will guarantee that mac_size != 0 (and so mac != NULL)
2586 * once all the error checks are done. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002587 if (operation->mac_size == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002588 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002589 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002590 }
Steven Cooreman8af5c5c2021-05-11 11:09:13 +02002591
Gilles Peskine449bd832023-01-11 14:50:10 +01002592 if (mac_size < operation->mac_size) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002593 status = PSA_ERROR_BUFFER_TOO_SMALL;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002594 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002595 }
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002596
Gilles Peskine449bd832023-01-11 14:50:10 +01002597 status = psa_driver_wrapper_mac_sign_finish(operation,
2598 mac, operation->mac_size,
2599 mac_length);
Steven Cooreman72f736a2021-05-07 14:14:37 +02002600
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002601exit:
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002602 /* In case of success, set the potential excess room in the output buffer
2603 * to an invalid value, to avoid potentially leaking a longer MAC.
2604 * In case of error, set the output length and content to a safe default,
2605 * such that in case the caller misses an error check, the output would be
2606 * an unachievable MAC.
2607 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002608 if (status != PSA_SUCCESS) {
Steven Cooreman72f736a2021-05-07 14:14:37 +02002609 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002610 operation->mac_size = 0;
Steven Cooreman72f736a2021-05-07 14:14:37 +02002611 }
mohammad16036df908f2018-04-02 08:34:15 -07002612
Paul Elliottdc42ca82023-02-24 18:11:59 +00002613 psa_wipe_tag_output_buffer(mac, status, mac_size, *mac_length);
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002614
Gilles Peskine449bd832023-01-11 14:50:10 +01002615 abort_status = psa_mac_abort(operation);
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002616
Gilles Peskine449bd832023-01-11 14:50:10 +01002617 return status == PSA_SUCCESS ? abort_status : status;
mohammad16036df908f2018-04-02 08:34:15 -07002618}
2619
Gilles Peskine449bd832023-01-11 14:50:10 +01002620psa_status_t psa_mac_verify_finish(psa_mac_operation_t *operation,
2621 const uint8_t *mac,
2622 size_t mac_length)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002623{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002624 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2625 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002626
Gilles Peskine449bd832023-01-11 14:50:10 +01002627 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002628 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002629 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002630 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002631
Gilles Peskine449bd832023-01-11 14:50:10 +01002632 if (operation->is_sign) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002633 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002634 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002635 }
Steven Cooreman72f736a2021-05-07 14:14:37 +02002636
Gilles Peskine449bd832023-01-11 14:50:10 +01002637 if (operation->mac_size != mac_length) {
Steven Cooreman72f736a2021-05-07 14:14:37 +02002638 status = PSA_ERROR_INVALID_SIGNATURE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002639 goto exit;
Steven Cooreman72f736a2021-05-07 14:14:37 +02002640 }
2641
Gilles Peskine449bd832023-01-11 14:50:10 +01002642 status = psa_driver_wrapper_mac_verify_finish(operation,
2643 mac, mac_length);
Steven Cooreman72f736a2021-05-07 14:14:37 +02002644
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002645exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002646 abort_status = psa_mac_abort(operation);
mohammad16036df908f2018-04-02 08:34:15 -07002647
Gilles Peskine449bd832023-01-11 14:50:10 +01002648 return status == PSA_SUCCESS ? abort_status : status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002649}
2650
Gilles Peskine449bd832023-01-11 14:50:10 +01002651static psa_status_t psa_mac_compute_internal(mbedtls_svc_key_id_t key,
2652 psa_algorithm_t alg,
2653 const uint8_t *input,
2654 size_t input_length,
2655 uint8_t *mac,
2656 size_t mac_size,
2657 size_t *mac_length,
2658 int is_sign)
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002659{
2660 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron51131b52021-06-17 17:17:20 +02002661 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2662 psa_key_slot_t *slot;
2663 uint8_t operation_mac_size = 0;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002664 psa_key_attributes_t attributes;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002665
Ronald Cron51131b52021-06-17 17:17:20 +02002666 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002667 key,
2668 &slot,
2669 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
2670 alg);
2671 if (status != PSA_SUCCESS) {
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002672 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002673 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002674
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002675 attributes = (psa_key_attributes_t) {
Ronald Cron51131b52021-06-17 17:17:20 +02002676 .core = slot->attr
2677 };
2678
Gilles Peskine449bd832023-01-11 14:50:10 +01002679 status = psa_mac_finalize_alg_and_key_validation(alg, &attributes,
2680 &operation_mac_size);
2681 if (status != PSA_SUCCESS) {
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002682 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002683 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002684
Gilles Peskine449bd832023-01-11 14:50:10 +01002685 if (mac_size < operation_mac_size) {
Ronald Cron51131b52021-06-17 17:17:20 +02002686 status = PSA_ERROR_BUFFER_TOO_SMALL;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002687 goto exit;
Ronald Cron51131b52021-06-17 17:17:20 +02002688 }
2689
2690 status = psa_driver_wrapper_mac_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01002691 &attributes,
2692 slot->key.data, slot->key.bytes,
2693 alg,
2694 input, input_length,
2695 mac, operation_mac_size, mac_length);
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002696
2697exit:
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002698 /* In case of success, set the potential excess room in the output buffer
2699 * to an invalid value, to avoid potentially leaking a longer MAC.
2700 * In case of error, set the output length and content to a safe default,
2701 * such that in case the caller misses an error check, the output would be
2702 * an unachievable MAC.
2703 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002704 if (status != PSA_SUCCESS) {
Ronald Cron51131b52021-06-17 17:17:20 +02002705 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002706 operation_mac_size = 0;
Ronald Cron51131b52021-06-17 17:17:20 +02002707 }
Paul Elliottdc42ca82023-02-24 18:11:59 +00002708
2709 psa_wipe_tag_output_buffer(mac, status, mac_size, *mac_length);
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002710
Ryan Everett1b70a072024-01-04 10:32:49 +00002711 unlock_status = psa_unregister_read(slot);
Ronald Cron51131b52021-06-17 17:17:20 +02002712
Gilles Peskine449bd832023-01-11 14:50:10 +01002713 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002714}
2715
Gilles Peskine449bd832023-01-11 14:50:10 +01002716psa_status_t psa_mac_compute(mbedtls_svc_key_id_t key,
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002717 psa_algorithm_t alg,
2718 const uint8_t *input,
2719 size_t input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002720 uint8_t *mac,
2721 size_t mac_size,
2722 size_t *mac_length)
2723{
2724 return psa_mac_compute_internal(key, alg,
2725 input, input_length,
2726 mac, mac_size, mac_length, 1);
2727}
2728
2729psa_status_t psa_mac_verify(mbedtls_svc_key_id_t key,
2730 psa_algorithm_t alg,
2731 const uint8_t *input,
2732 size_t input_length,
2733 const uint8_t *mac,
2734 size_t mac_length)
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002735{
2736 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Crona587cbc2021-06-18 14:51:29 +02002737 uint8_t actual_mac[PSA_MAC_MAX_SIZE];
2738 size_t actual_mac_length;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002739
Gilles Peskine449bd832023-01-11 14:50:10 +01002740 status = psa_mac_compute_internal(key, alg,
2741 input, input_length,
2742 actual_mac, sizeof(actual_mac),
2743 &actual_mac_length, 0);
2744 if (status != PSA_SUCCESS) {
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002745 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002746 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002747
Gilles Peskine449bd832023-01-11 14:50:10 +01002748 if (mac_length != actual_mac_length) {
Ronald Crona587cbc2021-06-18 14:51:29 +02002749 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002750 goto exit;
Ronald Crona587cbc2021-06-18 14:51:29 +02002751 }
Dave Rodgman78701152023-08-29 14:20:18 +01002752 if (mbedtls_ct_memcmp(mac, actual_mac, actual_mac_length) != 0) {
Ronald Crona587cbc2021-06-18 14:51:29 +02002753 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002754 goto exit;
Ronald Crona587cbc2021-06-18 14:51:29 +02002755 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002756
2757exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002758 mbedtls_platform_zeroize(actual_mac, sizeof(actual_mac));
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002759
Gilles Peskine449bd832023-01-11 14:50:10 +01002760 return status;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002761}
Gilles Peskinee59236f2018-01-27 23:32:46 +01002762
Gilles Peskinee59236f2018-01-27 23:32:46 +01002763/****************************************************************/
2764/* Asymmetric cryptography */
2765/****************************************************************/
2766
Gilles Peskine449bd832023-01-11 14:50:10 +01002767static psa_status_t psa_sign_verify_check_alg(int input_is_message,
2768 psa_algorithm_t alg)
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002769{
Gilles Peskine449bd832023-01-11 14:50:10 +01002770 if (input_is_message) {
2771 if (!PSA_ALG_IS_SIGN_MESSAGE(alg)) {
2772 return PSA_ERROR_INVALID_ARGUMENT;
2773 }
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002774
Gilles Peskine449bd832023-01-11 14:50:10 +01002775 if (PSA_ALG_IS_SIGN_HASH(alg)) {
2776 if (!PSA_ALG_IS_HASH(PSA_ALG_SIGN_GET_HASH(alg))) {
2777 return PSA_ERROR_INVALID_ARGUMENT;
2778 }
2779 }
2780 } else {
2781 if (!PSA_ALG_IS_SIGN_HASH(alg)) {
2782 return PSA_ERROR_INVALID_ARGUMENT;
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002783 }
2784 }
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002785
Gilles Peskine449bd832023-01-11 14:50:10 +01002786 return PSA_SUCCESS;
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002787}
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002788
Gilles Peskine449bd832023-01-11 14:50:10 +01002789static psa_status_t psa_sign_internal(mbedtls_svc_key_id_t key,
2790 int input_is_message,
2791 psa_algorithm_t alg,
2792 const uint8_t *input,
2793 size_t input_length,
2794 uint8_t *signature,
2795 size_t signature_size,
2796 size_t *signature_length)
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002797{
2798 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2799 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2800 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002801 psa_key_attributes_t attributes;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002802
2803 *signature_length = 0;
2804
Gilles Peskine449bd832023-01-11 14:50:10 +01002805 status = psa_sign_verify_check_alg(input_is_message, alg);
2806 if (status != PSA_SUCCESS) {
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002807 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002808 }
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002809
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002810 /* Immediately reject a zero-length signature buffer. This guarantees
gabor-mezei-arm12b4f342021-05-05 13:54:55 +02002811 * that signature must be a valid pointer. (On the other hand, the input
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002812 * buffer can in principle be empty since it doesn't actually have
2813 * to be a hash.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01002814 if (signature_size == 0) {
2815 return PSA_ERROR_BUFFER_TOO_SMALL;
2816 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002817
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002818 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002819 key, &slot,
2820 input_is_message ? PSA_KEY_USAGE_SIGN_MESSAGE :
2821 PSA_KEY_USAGE_SIGN_HASH,
2822 alg);
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002823
Gilles Peskine449bd832023-01-11 14:50:10 +01002824 if (status != PSA_SUCCESS) {
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002825 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002826 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002827
Gilles Peskine449bd832023-01-11 14:50:10 +01002828 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002829 status = PSA_ERROR_INVALID_ARGUMENT;
2830 goto exit;
2831 }
2832
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002833 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01002834 .core = slot->attr
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002835 };
2836
Gilles Peskine449bd832023-01-11 14:50:10 +01002837 if (input_is_message) {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002838 status = psa_driver_wrapper_sign_message(
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002839 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002840 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002841 signature, signature_size, signature_length);
2842 } else {
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002843
2844 status = psa_driver_wrapper_sign_hash(
2845 &attributes, slot->key.data, slot->key.bytes,
2846 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002847 signature, signature_size, signature_length);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002848 }
2849
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002850
2851exit:
Paul Elliott59200a22023-02-21 15:07:40 +00002852 psa_wipe_tag_output_buffer(signature, status, signature_size,
2853 *signature_length);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002854
Ryan Everett1b70a072024-01-04 10:32:49 +00002855 unlock_status = psa_unregister_read(slot);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002856
Gilles Peskine449bd832023-01-11 14:50:10 +01002857 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002858}
2859
Gilles Peskine449bd832023-01-11 14:50:10 +01002860static psa_status_t psa_verify_internal(mbedtls_svc_key_id_t key,
2861 int input_is_message,
2862 psa_algorithm_t alg,
2863 const uint8_t *input,
2864 size_t input_length,
2865 const uint8_t *signature,
2866 size_t signature_length)
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002867{
2868 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2869 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2870 psa_key_slot_t *slot;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002871
Gilles Peskine449bd832023-01-11 14:50:10 +01002872 status = psa_sign_verify_check_alg(input_is_message, alg);
2873 if (status != PSA_SUCCESS) {
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002874 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002875 }
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002876
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002877 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002878 key, &slot,
2879 input_is_message ? PSA_KEY_USAGE_VERIFY_MESSAGE :
2880 PSA_KEY_USAGE_VERIFY_HASH,
2881 alg);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002882
Gilles Peskine449bd832023-01-11 14:50:10 +01002883 if (status != PSA_SUCCESS) {
2884 return status;
2885 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002886
2887 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01002888 .core = slot->attr
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002889 };
2890
Gilles Peskine449bd832023-01-11 14:50:10 +01002891 if (input_is_message) {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002892 status = psa_driver_wrapper_verify_message(
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002893 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002894 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002895 signature, signature_length);
2896 } else {
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002897 status = psa_driver_wrapper_verify_hash(
2898 &attributes, slot->key.data, slot->key.bytes,
2899 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002900 signature, signature_length);
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002901 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002902
Ryan Everett1b70a072024-01-04 10:32:49 +00002903 unlock_status = psa_unregister_read(slot);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002904
Gilles Peskine449bd832023-01-11 14:50:10 +01002905 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002906
2907}
2908
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002909psa_status_t psa_sign_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002910 const psa_key_attributes_t *attributes,
2911 const uint8_t *key_buffer,
2912 size_t key_buffer_size,
2913 psa_algorithm_t alg,
2914 const uint8_t *input,
2915 size_t input_length,
2916 uint8_t *signature,
2917 size_t signature_size,
Gilles Peskine449bd832023-01-11 14:50:10 +01002918 size_t *signature_length)
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002919{
2920 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002921
Gilles Peskine449bd832023-01-11 14:50:10 +01002922 if (PSA_ALG_IS_SIGN_HASH(alg)) {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002923 size_t hash_length;
2924 uint8_t hash[PSA_HASH_MAX_SIZE];
2925
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002926 status = psa_driver_wrapper_hash_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01002927 PSA_ALG_SIGN_GET_HASH(alg),
2928 input, input_length,
2929 hash, sizeof(hash), &hash_length);
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002930
Gilles Peskine449bd832023-01-11 14:50:10 +01002931 if (status != PSA_SUCCESS) {
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002932 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002933 }
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002934
2935 return psa_driver_wrapper_sign_hash(
Gilles Peskine449bd832023-01-11 14:50:10 +01002936 attributes, key_buffer, key_buffer_size,
2937 alg, hash, hash_length,
2938 signature, signature_size, signature_length);
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002939 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002940
Gilles Peskine449bd832023-01-11 14:50:10 +01002941 return PSA_ERROR_NOT_SUPPORTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002942}
2943
Gilles Peskine449bd832023-01-11 14:50:10 +01002944psa_status_t psa_sign_message(mbedtls_svc_key_id_t key,
2945 psa_algorithm_t alg,
2946 const uint8_t *input,
2947 size_t input_length,
2948 uint8_t *signature,
2949 size_t signature_size,
2950 size_t *signature_length)
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002951{
2952 return psa_sign_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002953 key, 1, alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002954 signature, signature_size, signature_length);
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002955}
2956
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002957psa_status_t psa_verify_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002958 const psa_key_attributes_t *attributes,
2959 const uint8_t *key_buffer,
2960 size_t key_buffer_size,
2961 psa_algorithm_t alg,
2962 const uint8_t *input,
2963 size_t input_length,
2964 const uint8_t *signature,
Gilles Peskine449bd832023-01-11 14:50:10 +01002965 size_t signature_length)
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002966{
2967 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002968
Gilles Peskine449bd832023-01-11 14:50:10 +01002969 if (PSA_ALG_IS_SIGN_HASH(alg)) {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002970 size_t hash_length;
2971 uint8_t hash[PSA_HASH_MAX_SIZE];
2972
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002973 status = psa_driver_wrapper_hash_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01002974 PSA_ALG_SIGN_GET_HASH(alg),
2975 input, input_length,
2976 hash, sizeof(hash), &hash_length);
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002977
Gilles Peskine449bd832023-01-11 14:50:10 +01002978 if (status != PSA_SUCCESS) {
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002979 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002980 }
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002981
2982 return psa_driver_wrapper_verify_hash(
Gilles Peskine449bd832023-01-11 14:50:10 +01002983 attributes, key_buffer, key_buffer_size,
2984 alg, hash, hash_length,
2985 signature, signature_length);
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002986 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002987
Gilles Peskine449bd832023-01-11 14:50:10 +01002988 return PSA_ERROR_NOT_SUPPORTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002989}
2990
Gilles Peskine449bd832023-01-11 14:50:10 +01002991psa_status_t psa_verify_message(mbedtls_svc_key_id_t key,
2992 psa_algorithm_t alg,
2993 const uint8_t *input,
2994 size_t input_length,
2995 const uint8_t *signature,
2996 size_t signature_length)
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002997{
2998 return psa_verify_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002999 key, 1, alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003000 signature, signature_length);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003001}
3002
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02003003psa_status_t psa_sign_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01003004 const psa_key_attributes_t *attributes,
3005 const uint8_t *key_buffer, size_t key_buffer_size,
3006 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003007 uint8_t *signature, size_t signature_size, size_t *signature_length)
Gilles Peskinee59236f2018-01-27 23:32:46 +01003008{
Gilles Peskine449bd832023-01-11 14:50:10 +01003009 if (attributes->core.type == PSA_KEY_TYPE_RSA_KEY_PAIR) {
3010 if (PSA_ALG_IS_RSA_PKCS1V15_SIGN(alg) ||
3011 PSA_ALG_IS_RSA_PSS(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003012#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003013 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
3014 return mbedtls_psa_rsa_sign_hash(
3015 attributes,
3016 key_buffer, key_buffer_size,
3017 alg, hash, hash_length,
3018 signature, signature_size, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01003019#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
3020 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003021 } else {
3022 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanacda8342020-07-24 23:09:52 +02003023 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003024 } else if (PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3025 if (PSA_ALG_IS_ECDSA(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003026#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003027 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3028 return mbedtls_psa_ecdsa_sign_hash(
3029 attributes,
3030 key_buffer, key_buffer_size,
3031 alg, hash, hash_length,
3032 signature, signature_size, signature_length);
Gilles Peskinee59236f2018-01-27 23:32:46 +01003033#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3034 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003035 } else {
3036 return PSA_ERROR_INVALID_ARGUMENT;
Ronald Cron4501c982021-03-19 20:09:32 +01003037 }
Ronald Cron8a494f32021-02-17 09:49:51 +01003038 }
Ronald Cron4501c982021-03-19 20:09:32 +01003039
Gilles Peskine449bd832023-01-11 14:50:10 +01003040 (void) key_buffer;
3041 (void) key_buffer_size;
3042 (void) hash;
3043 (void) hash_length;
3044 (void) signature;
3045 (void) signature_size;
3046 (void) signature_length;
Ronald Cron4501c982021-03-19 20:09:32 +01003047
Gilles Peskine449bd832023-01-11 14:50:10 +01003048 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron18659932020-12-08 16:32:23 +01003049}
Gilles Peskinee59236f2018-01-27 23:32:46 +01003050
Gilles Peskine449bd832023-01-11 14:50:10 +01003051psa_status_t psa_sign_hash(mbedtls_svc_key_id_t key,
3052 psa_algorithm_t alg,
3053 const uint8_t *hash,
3054 size_t hash_length,
3055 uint8_t *signature,
3056 size_t signature_size,
3057 size_t *signature_length)
Gilles Peskinee59236f2018-01-27 23:32:46 +01003058{
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003059 return psa_sign_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02003060 key, 0, alg, hash, hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003061 signature, signature_size, signature_length);
itayzafrir5c753392018-05-08 11:18:38 +03003062}
3063
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02003064psa_status_t psa_verify_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01003065 const psa_key_attributes_t *attributes,
3066 const uint8_t *key_buffer, size_t key_buffer_size,
3067 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003068 const uint8_t *signature, size_t signature_length)
itayzafrir5c753392018-05-08 11:18:38 +03003069{
Gilles Peskine449bd832023-01-11 14:50:10 +01003070 if (PSA_KEY_TYPE_IS_RSA(attributes->core.type)) {
3071 if (PSA_ALG_IS_RSA_PKCS1V15_SIGN(alg) ||
3072 PSA_ALG_IS_RSA_PSS(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003073#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003074 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
3075 return mbedtls_psa_rsa_verify_hash(
3076 attributes,
3077 key_buffer, key_buffer_size,
3078 alg, hash, hash_length,
3079 signature, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01003080#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
3081 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003082 } else {
3083 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanacda8342020-07-24 23:09:52 +02003084 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003085 } else if (PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3086 if (PSA_ALG_IS_ECDSA(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003087#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003088 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3089 return mbedtls_psa_ecdsa_verify_hash(
3090 attributes,
3091 key_buffer, key_buffer_size,
3092 alg, hash, hash_length,
3093 signature, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01003094#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3095 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003096 } else {
3097 return PSA_ERROR_INVALID_ARGUMENT;
Ronald Cron4501c982021-03-19 20:09:32 +01003098 }
Ronald Cron8a494f32021-02-17 09:49:51 +01003099 }
Ronald Cron4501c982021-03-19 20:09:32 +01003100
Gilles Peskine449bd832023-01-11 14:50:10 +01003101 (void) key_buffer;
3102 (void) key_buffer_size;
3103 (void) hash;
3104 (void) hash_length;
3105 (void) signature;
3106 (void) signature_length;
Ronald Cron4501c982021-03-19 20:09:32 +01003107
Gilles Peskine449bd832023-01-11 14:50:10 +01003108 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron18659932020-12-08 16:32:23 +01003109}
3110
Gilles Peskine449bd832023-01-11 14:50:10 +01003111psa_status_t psa_verify_hash(mbedtls_svc_key_id_t key,
3112 psa_algorithm_t alg,
3113 const uint8_t *hash,
3114 size_t hash_length,
3115 const uint8_t *signature,
3116 size_t signature_length)
itayzafrir5c753392018-05-08 11:18:38 +03003117{
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003118 return psa_verify_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02003119 key, 0, alg, hash, hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003120 signature, signature_length);
Gilles Peskinee59236f2018-01-27 23:32:46 +01003121}
3122
Gilles Peskine449bd832023-01-11 14:50:10 +01003123psa_status_t psa_asymmetric_encrypt(mbedtls_svc_key_id_t key,
3124 psa_algorithm_t alg,
3125 const uint8_t *input,
3126 size_t input_length,
3127 const uint8_t *salt,
3128 size_t salt_length,
3129 uint8_t *output,
3130 size_t output_size,
3131 size_t *output_length)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003132{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003133 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003134 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003135 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003136 psa_key_attributes_t attributes;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003137
Darryl Green5cc689a2018-07-24 15:34:10 +01003138 (void) input;
3139 (void) input_length;
3140 (void) salt;
3141 (void) output;
3142 (void) output_size;
3143
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003144 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003145
Gilles Peskine449bd832023-01-11 14:50:10 +01003146 if (!PSA_ALG_IS_RSA_OAEP(alg) && salt_length != 0) {
3147 return PSA_ERROR_INVALID_ARGUMENT;
3148 }
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003149
Valerio Setti5bb454a2024-01-15 10:43:16 +01003150 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01003151 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg);
3152 if (status != PSA_SUCCESS) {
3153 return status;
3154 }
3155 if (!(PSA_KEY_TYPE_IS_PUBLIC_KEY(slot->attr.type) ||
3156 PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type))) {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003157 status = PSA_ERROR_INVALID_ARGUMENT;
3158 goto exit;
3159 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003160
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003161 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01003162 .core = slot->attr
Przemyslaw Stekiel19e61422021-12-09 11:09:11 +01003163 };
Steven Cooremana2371e52020-07-28 14:30:39 +02003164
Przemyslaw Stekiel19e61422021-12-09 11:09:11 +01003165 status = psa_driver_wrapper_asymmetric_encrypt(
3166 &attributes, slot->key.data, slot->key.bytes,
3167 alg, input, input_length, salt, salt_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003168 output, output_size, output_length);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003169exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00003170 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003171
Gilles Peskine449bd832023-01-11 14:50:10 +01003172 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003173}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003174
Gilles Peskine449bd832023-01-11 14:50:10 +01003175psa_status_t psa_asymmetric_decrypt(mbedtls_svc_key_id_t key,
3176 psa_algorithm_t alg,
3177 const uint8_t *input,
3178 size_t input_length,
3179 const uint8_t *salt,
3180 size_t salt_length,
3181 uint8_t *output,
3182 size_t output_size,
3183 size_t *output_length)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003184{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003185 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003186 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003187 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003188 psa_key_attributes_t attributes;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003189
Darryl Green5cc689a2018-07-24 15:34:10 +01003190 (void) input;
3191 (void) input_length;
3192 (void) salt;
3193 (void) output;
3194 (void) output_size;
3195
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003196 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003197
Gilles Peskine449bd832023-01-11 14:50:10 +01003198 if (!PSA_ALG_IS_RSA_OAEP(alg) && salt_length != 0) {
3199 return PSA_ERROR_INVALID_ARGUMENT;
3200 }
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003201
Valerio Setti5bb454a2024-01-15 10:43:16 +01003202 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01003203 key, &slot, PSA_KEY_USAGE_DECRYPT, alg);
3204 if (status != PSA_SUCCESS) {
3205 return status;
3206 }
3207 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003208 status = PSA_ERROR_INVALID_ARGUMENT;
3209 goto exit;
3210 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003211
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003212 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01003213 .core = slot->attr
Przemyslaw Stekiel8d45c002021-12-13 08:58:19 +01003214 };
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003215
Przemyslaw Stekiel8d45c002021-12-13 08:58:19 +01003216 status = psa_driver_wrapper_asymmetric_decrypt(
3217 &attributes, slot->key.data, slot->key.bytes,
3218 alg, input, input_length, salt, salt_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003219 output, output_size, output_length);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003220
3221exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00003222 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003223
Gilles Peskine449bd832023-01-11 14:50:10 +01003224 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003225}
Gilles Peskinee59236f2018-01-27 23:32:46 +01003226
Paul Elliott9fe12f62022-11-30 19:16:02 +00003227/****************************************************************/
3228/* Asymmetric interruptible cryptography */
3229/****************************************************************/
3230
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003231static uint32_t psa_interruptible_max_ops = PSA_INTERRUPTIBLE_MAX_OPS_UNLIMITED;
3232
Paul Elliott9fe12f62022-11-30 19:16:02 +00003233void psa_interruptible_set_max_ops(uint32_t max_ops)
3234{
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003235 psa_interruptible_max_ops = max_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003236}
3237
3238uint32_t psa_interruptible_get_max_ops(void)
3239{
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003240 return psa_interruptible_max_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003241}
3242
Paul Elliott9fe12f62022-11-30 19:16:02 +00003243uint32_t psa_sign_hash_get_num_ops(
3244 const psa_sign_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
3249uint32_t psa_verify_hash_get_num_ops(
3250 const psa_verify_hash_interruptible_operation_t *operation)
3251{
Paul Elliott296ede92022-12-15 17:00:30 +00003252 return operation->num_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003253}
3254
Paul Elliott59ad9452022-12-18 15:09:02 +00003255static psa_status_t psa_sign_hash_abort_internal(
3256 psa_sign_hash_interruptible_operation_t *operation)
3257{
3258 if (operation->id == 0) {
3259 /* The object has (apparently) been initialized but it is not (yet)
3260 * in use. It's ok to call abort on such an object, and there's
3261 * nothing to do. */
3262 return PSA_SUCCESS;
3263 }
3264
3265 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3266
3267 status = psa_driver_wrapper_sign_hash_abort(operation);
3268
3269 operation->id = 0;
3270
Paul Elliotte6145dc2023-02-07 12:51:21 +00003271 /* Do not clear either the error_occurred or num_ops elements here as they
3272 * only want to be cleared by the application calling abort, not by abort
3273 * being called at completion of an operation. */
3274
Paul Elliott59ad9452022-12-18 15:09:02 +00003275 return status;
3276}
3277
Paul Elliott9fe12f62022-11-30 19:16:02 +00003278psa_status_t psa_sign_hash_start(
3279 psa_sign_hash_interruptible_operation_t *operation,
3280 mbedtls_svc_key_id_t key, psa_algorithm_t alg,
3281 const uint8_t *hash, size_t hash_length)
3282{
3283 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3284 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3285 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003286 psa_key_attributes_t attributes;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003287
Paul Elliottc9774412023-02-06 15:14:07 +00003288 /* Check that start has not been previously called, or operation has not
3289 * previously errored. */
3290 if (operation->id != 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003291 return PSA_ERROR_BAD_STATE;
3292 }
3293
Paul Elliott9fe12f62022-11-30 19:16:02 +00003294 status = psa_sign_verify_check_alg(0, alg);
3295 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003296 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003297 return status;
3298 }
3299
3300 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
3301 PSA_KEY_USAGE_SIGN_HASH,
3302 alg);
3303
3304 if (status != PSA_SUCCESS) {
3305 goto exit;
3306 }
3307
3308 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
3309 status = PSA_ERROR_INVALID_ARGUMENT;
3310 goto exit;
3311 }
3312
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003313 attributes = (psa_key_attributes_t) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003314 .core = slot->attr
3315 };
3316
Paul Elliott296ede92022-12-15 17:00:30 +00003317 /* Ensure ops count gets reset, in case of operation re-use. */
3318 operation->num_ops = 0;
3319
Paul Elliott9fe12f62022-11-30 19:16:02 +00003320 status = psa_driver_wrapper_sign_hash_start(operation, &attributes,
3321 slot->key.data,
3322 slot->key.bytes, alg,
3323 hash, hash_length);
3324exit:
3325
3326 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003327 operation->error_occurred = 1;
Paul Elliott59ad9452022-12-18 15:09:02 +00003328 psa_sign_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003329 }
3330
Ryan Everett1b70a072024-01-04 10:32:49 +00003331 unlock_status = psa_unregister_read(slot);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003332
Paul Elliottc9774412023-02-06 15:14:07 +00003333 if (unlock_status != PSA_SUCCESS) {
3334 operation->error_occurred = 1;
3335 }
Paul Elliott9fe12f62022-11-30 19:16:02 +00003336
Paul Elliottc9774412023-02-06 15:14:07 +00003337 return (status == PSA_SUCCESS) ? unlock_status : status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003338}
3339
3340
3341psa_status_t psa_sign_hash_complete(
3342 psa_sign_hash_interruptible_operation_t *operation,
3343 uint8_t *signature, size_t signature_size,
3344 size_t *signature_length)
3345{
3346 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3347
3348 *signature_length = 0;
3349
Paul Elliottc9774412023-02-06 15:14:07 +00003350 /* Check that start has been called first, and that operation has not
3351 * previously errored. */
3352 if (operation->id == 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003353 status = PSA_ERROR_BAD_STATE;
3354 goto exit;
3355 }
3356
Paul Elliott096abc42023-02-03 18:33:23 +00003357 /* Immediately reject a zero-length signature buffer. This guarantees that
3358 * signature must be a valid pointer. */
Paul Elliott9fe12f62022-11-30 19:16:02 +00003359 if (signature_size == 0) {
3360 status = PSA_ERROR_BUFFER_TOO_SMALL;
3361 goto exit;
3362 }
3363
3364 status = psa_driver_wrapper_sign_hash_complete(operation, signature,
3365 signature_size,
3366 signature_length);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003367
Paul Elliott296ede92022-12-15 17:00:30 +00003368 /* Update ops count with work done. */
Paul Elliottde1114c2023-02-07 12:43:11 +00003369 operation->num_ops = psa_driver_wrapper_sign_hash_get_num_ops(operation);
Paul Elliott296ede92022-12-15 17:00:30 +00003370
Paul Elliottebe225c2023-02-10 14:32:53 +00003371exit:
3372
Paul Elliott59200a22023-02-21 15:07:40 +00003373 psa_wipe_tag_output_buffer(signature, status, signature_size,
3374 *signature_length);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003375
Paul Elliott53bb3122023-02-10 14:22:22 +00003376 if (status != PSA_OPERATION_INCOMPLETE) {
Paul Elliottc9774412023-02-06 15:14:07 +00003377 if (status != PSA_SUCCESS) {
3378 operation->error_occurred = 1;
3379 }
3380
Paul Elliott59ad9452022-12-18 15:09:02 +00003381 psa_sign_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003382 }
3383
3384 return status;
3385}
3386
3387psa_status_t psa_sign_hash_abort(
3388 psa_sign_hash_interruptible_operation_t *operation)
3389{
Paul Elliott59ad9452022-12-18 15:09:02 +00003390 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3391
3392 status = psa_sign_hash_abort_internal(operation);
3393
3394 /* We clear the number of ops done here, so that it is not cleared when
3395 * the operation fails or succeeds, only on manual abort. */
3396 operation->num_ops = 0;
3397
Paul Elliottc9774412023-02-06 15:14:07 +00003398 /* Likewise, failure state. */
3399 operation->error_occurred = 0;
3400
Paul Elliott59ad9452022-12-18 15:09:02 +00003401 return status;
3402}
3403
3404static psa_status_t psa_verify_hash_abort_internal(
3405 psa_verify_hash_interruptible_operation_t *operation)
3406{
Paul Elliott9fe12f62022-11-30 19:16:02 +00003407 if (operation->id == 0) {
3408 /* The object has (apparently) been initialized but it is not (yet)
3409 * in use. It's ok to call abort on such an object, and there's
3410 * nothing to do. */
3411 return PSA_SUCCESS;
3412 }
3413
Paul Elliott59ad9452022-12-18 15:09:02 +00003414 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3415
3416 status = psa_driver_wrapper_verify_hash_abort(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003417
3418 operation->id = 0;
3419
Paul Elliotte6145dc2023-02-07 12:51:21 +00003420 /* Do not clear either the error_occurred or num_ops elements here as they
3421 * only want to be cleared by the application calling abort, not by abort
3422 * being called at completion of an operation. */
3423
Paul Elliott59ad9452022-12-18 15:09:02 +00003424 return status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003425}
3426
3427psa_status_t psa_verify_hash_start(
3428 psa_verify_hash_interruptible_operation_t *operation,
3429 mbedtls_svc_key_id_t key, psa_algorithm_t alg,
3430 const uint8_t *hash, size_t hash_length,
3431 const uint8_t *signature, size_t signature_length)
3432{
3433 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3434 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3435 psa_key_slot_t *slot;
3436
Paul Elliottc9774412023-02-06 15:14:07 +00003437 /* Check that start has not been previously called, or operation has not
3438 * previously errored. */
3439 if (operation->id != 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003440 return PSA_ERROR_BAD_STATE;
3441 }
3442
3443 status = psa_sign_verify_check_alg(0, alg);
3444 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003445 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003446 return status;
3447 }
3448
3449 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
3450 PSA_KEY_USAGE_VERIFY_HASH,
3451 alg);
3452
3453 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003454 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003455 return status;
3456 }
3457
3458 psa_key_attributes_t attributes = {
3459 .core = slot->attr
3460 };
3461
Paul Elliott296ede92022-12-15 17:00:30 +00003462 /* Ensure ops count gets reset, in case of operation re-use. */
3463 operation->num_ops = 0;
3464
Paul Elliott9fe12f62022-11-30 19:16:02 +00003465 status = psa_driver_wrapper_verify_hash_start(operation, &attributes,
3466 slot->key.data,
3467 slot->key.bytes,
3468 alg, hash, hash_length,
3469 signature, signature_length);
3470
3471 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003472 operation->error_occurred = 1;
Paul Elliott59ad9452022-12-18 15:09:02 +00003473 psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003474 }
3475
Ryan Everett1b70a072024-01-04 10:32:49 +00003476 unlock_status = psa_unregister_read(slot);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003477
Paul Elliottc9774412023-02-06 15:14:07 +00003478 if (unlock_status != PSA_SUCCESS) {
3479 operation->error_occurred = 1;
3480 }
Paul Elliott9fe12f62022-11-30 19:16:02 +00003481
Paul Elliottc9774412023-02-06 15:14:07 +00003482 return (status == PSA_SUCCESS) ? unlock_status : status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003483}
3484
3485psa_status_t psa_verify_hash_complete(
3486 psa_verify_hash_interruptible_operation_t *operation)
3487{
3488 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3489
Paul Elliottc9774412023-02-06 15:14:07 +00003490 /* Check that start has been called first, and that operation has not
3491 * previously errored. */
3492 if (operation->id == 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003493 status = PSA_ERROR_BAD_STATE;
3494 goto exit;
3495 }
3496
3497 status = psa_driver_wrapper_verify_hash_complete(operation);
3498
Paul Elliott296ede92022-12-15 17:00:30 +00003499 /* Update ops count with work done. */
Paul Elliottde1114c2023-02-07 12:43:11 +00003500 operation->num_ops = psa_driver_wrapper_verify_hash_get_num_ops(
Paul Elliott296ede92022-12-15 17:00:30 +00003501 operation);
3502
Paul Elliottebe225c2023-02-10 14:32:53 +00003503exit:
3504
Paul Elliott9fe12f62022-11-30 19:16:02 +00003505 if (status != PSA_OPERATION_INCOMPLETE) {
Paul Elliottc9774412023-02-06 15:14:07 +00003506 if (status != PSA_SUCCESS) {
3507 operation->error_occurred = 1;
3508 }
3509
Paul Elliott59ad9452022-12-18 15:09:02 +00003510 psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003511 }
3512
3513 return status;
3514}
3515
3516psa_status_t psa_verify_hash_abort(
3517 psa_verify_hash_interruptible_operation_t *operation)
3518{
Paul Elliott59ad9452022-12-18 15:09:02 +00003519 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003520
Paul Elliott59ad9452022-12-18 15:09:02 +00003521 status = psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003522
Paul Elliott59ad9452022-12-18 15:09:02 +00003523 /* We clear the number of ops done here, so that it is not cleared when
3524 * the operation fails or succeeds, only on manual abort. */
3525 operation->num_ops = 0;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003526
Paul Elliottc9774412023-02-06 15:14:07 +00003527 /* Likewise, failure state. */
3528 operation->error_occurred = 0;
3529
Paul Elliott59ad9452022-12-18 15:09:02 +00003530 return status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003531}
3532
Paul Elliott588f8ed2022-12-02 18:10:26 +00003533/****************************************************************/
3534/* Asymmetric interruptible cryptography internal */
3535/* implementations */
3536/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003537
Paul Elliott588f8ed2022-12-02 18:10:26 +00003538void mbedtls_psa_interruptible_set_max_ops(uint32_t max_ops)
3539{
Paul Elliott7cc4e812023-01-10 17:14:11 +00003540
Paul Elliott588f8ed2022-12-02 18:10:26 +00003541#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3542 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3543 defined(MBEDTLS_ECP_RESTARTABLE)
3544
3545 /* Internal implementation uses zero to indicate infinite number max ops,
3546 * therefore avoid this value, and set to minimum possible. */
3547 if (max_ops == 0) {
3548 max_ops = 1;
3549 }
3550
Paul Elliott588f8ed2022-12-02 18:10:26 +00003551 mbedtls_ecp_set_max_ops(max_ops);
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003552#else
3553 (void) max_ops;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003554#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3555 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3556 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3557}
3558
Paul Elliott588f8ed2022-12-02 18:10:26 +00003559uint32_t mbedtls_psa_sign_hash_get_num_ops(
Paul Elliottf8e5b562023-02-19 18:43:45 +00003560 const mbedtls_psa_sign_hash_interruptible_operation_t *operation)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003561{
3562#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3563 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3564 defined(MBEDTLS_ECP_RESTARTABLE)
3565
Paul Elliott93d9ca82023-02-15 18:14:21 +00003566 return operation->num_ops;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003567#else
3568 (void) operation;
3569 return 0;
3570#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3571 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3572 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3573}
3574
3575uint32_t mbedtls_psa_verify_hash_get_num_ops(
Paul Elliottf8e5b562023-02-19 18:43:45 +00003576 const mbedtls_psa_verify_hash_interruptible_operation_t *operation)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003577{
3578 #if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3579 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3580 defined(MBEDTLS_ECP_RESTARTABLE)
3581
Paul Elliott93d9ca82023-02-15 18:14:21 +00003582 return operation->num_ops;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003583#else
3584 (void) operation;
3585 return 0;
3586#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3587 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3588 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3589}
3590
3591psa_status_t mbedtls_psa_sign_hash_start(
3592 mbedtls_psa_sign_hash_interruptible_operation_t *operation,
3593 const psa_key_attributes_t *attributes, const uint8_t *key_buffer,
3594 size_t key_buffer_size, psa_algorithm_t alg,
3595 const uint8_t *hash, size_t hash_length)
3596{
3597 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott0290a762023-02-09 14:30:24 +00003598 size_t required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003599
Paul Elliott068fe072023-01-16 13:59:15 +00003600 if (!PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3601 return PSA_ERROR_NOT_SUPPORTED;
3602 }
3603
3604 if (!PSA_ALG_IS_ECDSA(alg)) {
Paul Elliott813f9cd2023-02-05 15:28:46 +00003605 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott068fe072023-01-16 13:59:15 +00003606 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003607
3608#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Paul Elliott068fe072023-01-16 13:59:15 +00003609 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3610 defined(MBEDTLS_ECP_RESTARTABLE)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003611
Paul Elliotta1c94092023-02-15 16:38:04 +00003612 mbedtls_ecdsa_restart_init(&operation->restart_ctx);
3613
Paul Elliott93d9ca82023-02-15 18:14:21 +00003614 /* Ensure num_ops is zero'ed in case of context re-use. */
3615 operation->num_ops = 0;
3616
Paul Elliott068fe072023-01-16 13:59:15 +00003617 status = mbedtls_psa_ecp_load_representation(attributes->core.type,
3618 attributes->core.bits,
3619 key_buffer,
3620 key_buffer_size,
3621 &operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003622
Paul Elliott068fe072023-01-16 13:59:15 +00003623 if (status != PSA_SUCCESS) {
3624 return status;
3625 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003626
Paul Elliott1bc59df2023-02-05 13:41:57 +00003627 operation->coordinate_bytes = PSA_BITS_TO_BYTES(
Paul Elliottc569fc22023-02-10 13:02:54 +00003628 operation->ctx->grp.nbits);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003629
Paul Elliott068fe072023-01-16 13:59:15 +00003630 psa_algorithm_t hash_alg = PSA_ALG_SIGN_GET_HASH(alg);
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02003631 operation->md_alg = mbedtls_md_type_from_psa_alg(hash_alg);
Paul Elliott068fe072023-01-16 13:59:15 +00003632 operation->alg = alg;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003633
Paul Elliott0290a762023-02-09 14:30:24 +00003634 /* We only need to store the same length of hash as the private key size
3635 * here, it would be truncated by the internal implementation anyway. */
3636 required_hash_length = (hash_length < operation->coordinate_bytes ?
3637 hash_length : operation->coordinate_bytes);
3638
Paul Elliottba70ad42023-02-15 18:23:53 +00003639 if (required_hash_length > sizeof(operation->hash)) {
3640 /* Shouldn't happen, but better safe than sorry. */
3641 return PSA_ERROR_CORRUPTION_DETECTED;
3642 }
3643
Paul Elliott0290a762023-02-09 14:30:24 +00003644 memcpy(operation->hash, hash, required_hash_length);
3645 operation->hash_length = required_hash_length;
Paul Elliott068fe072023-01-16 13:59:15 +00003646
3647 return PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003648
3649#else
Paul Elliott068fe072023-01-16 13:59:15 +00003650 (void) operation;
3651 (void) key_buffer;
3652 (void) key_buffer_size;
3653 (void) alg;
3654 (void) hash;
3655 (void) hash_length;
3656 (void) status;
Paul Elliott0290a762023-02-09 14:30:24 +00003657 (void) required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003658
Paul Elliott068fe072023-01-16 13:59:15 +00003659 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003660#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3661 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3662 * defined( MBEDTLS_ECP_RESTARTABLE ) */
Paul Elliott588f8ed2022-12-02 18:10:26 +00003663}
3664
3665psa_status_t mbedtls_psa_sign_hash_complete(
3666 mbedtls_psa_sign_hash_interruptible_operation_t *operation,
3667 uint8_t *signature, size_t signature_size,
3668 size_t *signature_length)
3669{
Paul Elliott588f8ed2022-12-02 18:10:26 +00003670#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3671 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3672 defined(MBEDTLS_ECP_RESTARTABLE)
3673
Paul Elliotta1c94092023-02-15 16:38:04 +00003674 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott1243f932023-02-07 11:21:10 +00003675 mbedtls_mpi r;
3676 mbedtls_mpi s;
3677
Paul Elliott46845252023-02-03 14:59:11 +00003678 mbedtls_mpi_init(&r);
3679 mbedtls_mpi_init(&s);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003680
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003681 /* Ensure max_ops is set to the current value (or default). */
3682 mbedtls_psa_interruptible_set_max_ops(psa_interruptible_get_max_ops());
3683
Paul Elliotta1c94092023-02-15 16:38:04 +00003684 if (signature_size < 2 * operation->coordinate_bytes) {
3685 status = PSA_ERROR_BUFFER_TOO_SMALL;
3686 goto exit;
3687 }
3688
Paul Elliott588f8ed2022-12-02 18:10:26 +00003689 if (PSA_ALG_ECDSA_IS_DETERMINISTIC(operation->alg)) {
Paul Elliott46845252023-02-03 14:59:11 +00003690
Paul Elliott588f8ed2022-12-02 18:10:26 +00003691#if defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3692 status = mbedtls_to_psa_error(
3693 mbedtls_ecdsa_sign_det_restartable(&operation->ctx->grp,
Paul Elliott46845252023-02-03 14:59:11 +00003694 &r,
3695 &s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003696 &operation->ctx->d,
3697 operation->hash,
3698 operation->hash_length,
3699 operation->md_alg,
3700 mbedtls_psa_get_random,
3701 MBEDTLS_PSA_RANDOM_STATE,
3702 &operation->restart_ctx));
3703#else /* defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Paul Elliott724bd252023-02-08 12:35:08 +00003704 status = PSA_ERROR_NOT_SUPPORTED;
3705 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003706#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
3707 } else {
Paul Elliott588f8ed2022-12-02 18:10:26 +00003708 status = mbedtls_to_psa_error(
3709 mbedtls_ecdsa_sign_restartable(&operation->ctx->grp,
Paul Elliott46845252023-02-03 14:59:11 +00003710 &r,
3711 &s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003712 &operation->ctx->d,
3713 operation->hash,
3714 operation->hash_length,
3715 mbedtls_psa_get_random,
3716 MBEDTLS_PSA_RANDOM_STATE,
3717 mbedtls_psa_get_random,
3718 MBEDTLS_PSA_RANDOM_STATE,
3719 &operation->restart_ctx));
3720 }
3721
Paul Elliottf8e5b562023-02-19 18:43:45 +00003722 /* Hide the fact that the restart context only holds a delta of number of
3723 * ops done during the last operation, not an absolute value. */
3724 operation->num_ops += operation->restart_ctx.ecp.ops_done;
3725
Paul Elliott724bd252023-02-08 12:35:08 +00003726 if (status == PSA_SUCCESS) {
Paul Elliott588f8ed2022-12-02 18:10:26 +00003727 status = mbedtls_to_psa_error(
Paul Elliott46845252023-02-03 14:59:11 +00003728 mbedtls_mpi_write_binary(&r,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003729 signature,
Paul Elliott1bc59df2023-02-05 13:41:57 +00003730 operation->coordinate_bytes)
3731 );
Paul Elliott588f8ed2022-12-02 18:10:26 +00003732
3733 if (status != PSA_SUCCESS) {
Paul Elliott724bd252023-02-08 12:35:08 +00003734 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003735 }
3736
3737 status = mbedtls_to_psa_error(
Paul Elliott46845252023-02-03 14:59:11 +00003738 mbedtls_mpi_write_binary(&s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003739 signature +
Paul Elliott1bc59df2023-02-05 13:41:57 +00003740 operation->coordinate_bytes,
3741 operation->coordinate_bytes)
3742 );
Paul Elliott588f8ed2022-12-02 18:10:26 +00003743
3744 if (status != PSA_SUCCESS) {
Paul Elliott724bd252023-02-08 12:35:08 +00003745 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003746 }
3747
Paul Elliott1bc59df2023-02-05 13:41:57 +00003748 *signature_length = operation->coordinate_bytes * 2;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003749
Paul Elliott724bd252023-02-08 12:35:08 +00003750 status = PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003751 }
Paul Elliott724bd252023-02-08 12:35:08 +00003752
3753exit:
3754
3755 mbedtls_mpi_free(&r);
3756 mbedtls_mpi_free(&s);
3757 return status;
3758
Paul Elliott588f8ed2022-12-02 18:10:26 +00003759 #else
3760
3761 (void) operation;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003762 (void) signature;
3763 (void) signature_size;
3764 (void) signature_length;
3765
3766 return PSA_ERROR_NOT_SUPPORTED;
3767
3768#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3769 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3770 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3771}
3772
3773psa_status_t mbedtls_psa_sign_hash_abort(
3774 mbedtls_psa_sign_hash_interruptible_operation_t *operation)
3775{
3776
3777#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3778 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3779 defined(MBEDTLS_ECP_RESTARTABLE)
3780
3781 if (operation->ctx) {
3782 mbedtls_ecdsa_free(operation->ctx);
3783 mbedtls_free(operation->ctx);
Paul Elliottf9c91a72023-02-05 18:06:38 +00003784 operation->ctx = NULL;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003785 }
3786
3787 mbedtls_ecdsa_restart_free(&operation->restart_ctx);
3788
Paul Elliott93d9ca82023-02-15 18:14:21 +00003789 operation->num_ops = 0;
3790
Paul Elliott588f8ed2022-12-02 18:10:26 +00003791 return PSA_SUCCESS;
3792
3793#else
3794
3795 (void) operation;
3796
3797 return PSA_ERROR_NOT_SUPPORTED;
3798
3799#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3800 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3801 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3802}
3803
3804psa_status_t mbedtls_psa_verify_hash_start(
3805 mbedtls_psa_verify_hash_interruptible_operation_t *operation,
3806 const psa_key_attributes_t *attributes,
3807 const uint8_t *key_buffer, size_t key_buffer_size,
3808 psa_algorithm_t alg,
3809 const uint8_t *hash, size_t hash_length,
3810 const uint8_t *signature, size_t signature_length)
3811{
3812 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott1bc59df2023-02-05 13:41:57 +00003813 size_t coordinate_bytes = 0;
Paul Elliott0290a762023-02-09 14:30:24 +00003814 size_t required_hash_length = 0;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003815
Paul Elliott068fe072023-01-16 13:59:15 +00003816 if (!PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3817 return PSA_ERROR_NOT_SUPPORTED;
3818 }
3819
3820 if (!PSA_ALG_IS_ECDSA(alg)) {
Paul Elliott813f9cd2023-02-05 15:28:46 +00003821 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott068fe072023-01-16 13:59:15 +00003822 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003823
3824#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Paul Elliott068fe072023-01-16 13:59:15 +00003825 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3826 defined(MBEDTLS_ECP_RESTARTABLE)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003827
Paul Elliotta1c94092023-02-15 16:38:04 +00003828 mbedtls_ecdsa_restart_init(&operation->restart_ctx);
3829 mbedtls_mpi_init(&operation->r);
3830 mbedtls_mpi_init(&operation->s);
3831
Paul Elliott93d9ca82023-02-15 18:14:21 +00003832 /* Ensure num_ops is zero'ed in case of context re-use. */
3833 operation->num_ops = 0;
3834
Paul Elliott068fe072023-01-16 13:59:15 +00003835 status = mbedtls_psa_ecp_load_representation(attributes->core.type,
3836 attributes->core.bits,
3837 key_buffer,
3838 key_buffer_size,
3839 &operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003840
Paul Elliott068fe072023-01-16 13:59:15 +00003841 if (status != PSA_SUCCESS) {
3842 return status;
3843 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003844
Paul Elliottc569fc22023-02-10 13:02:54 +00003845 coordinate_bytes = PSA_BITS_TO_BYTES(operation->ctx->grp.nbits);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003846
Paul Elliott1bc59df2023-02-05 13:41:57 +00003847 if (signature_length != 2 * coordinate_bytes) {
Paul Elliott068fe072023-01-16 13:59:15 +00003848 return PSA_ERROR_INVALID_SIGNATURE;
3849 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003850
Paul Elliott068fe072023-01-16 13:59:15 +00003851 status = mbedtls_to_psa_error(
3852 mbedtls_mpi_read_binary(&operation->r,
3853 signature,
Paul Elliott1bc59df2023-02-05 13:41:57 +00003854 coordinate_bytes));
Paul Elliott588f8ed2022-12-02 18:10:26 +00003855
Paul Elliott068fe072023-01-16 13:59:15 +00003856 if (status != PSA_SUCCESS) {
3857 return status;
3858 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003859
Paul Elliott068fe072023-01-16 13:59:15 +00003860 status = mbedtls_to_psa_error(
3861 mbedtls_mpi_read_binary(&operation->s,
3862 signature +
Paul Elliott1bc59df2023-02-05 13:41:57 +00003863 coordinate_bytes,
3864 coordinate_bytes));
Paul Elliott588f8ed2022-12-02 18:10:26 +00003865
Paul Elliott068fe072023-01-16 13:59:15 +00003866 if (status != PSA_SUCCESS) {
3867 return status;
3868 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003869
Paul Elliott2c9843f2023-02-15 17:32:42 +00003870 status = mbedtls_psa_ecp_load_public_part(operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003871
Paul Elliott2c9843f2023-02-15 17:32:42 +00003872 if (status != PSA_SUCCESS) {
3873 return status;
Paul Elliott068fe072023-01-16 13:59:15 +00003874 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003875
Paul Elliott0290a762023-02-09 14:30:24 +00003876 /* We only need to store the same length of hash as the private key size
3877 * here, it would be truncated by the internal implementation anyway. */
3878 required_hash_length = (hash_length < coordinate_bytes ? hash_length :
3879 coordinate_bytes);
3880
Paul Elliottba70ad42023-02-15 18:23:53 +00003881 if (required_hash_length > sizeof(operation->hash)) {
3882 /* Shouldn't happen, but better safe than sorry. */
3883 return PSA_ERROR_CORRUPTION_DETECTED;
3884 }
3885
Paul Elliott0290a762023-02-09 14:30:24 +00003886 memcpy(operation->hash, hash, required_hash_length);
3887 operation->hash_length = required_hash_length;
Paul Elliott068fe072023-01-16 13:59:15 +00003888
3889 return PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003890#else
Paul Elliott068fe072023-01-16 13:59:15 +00003891 (void) operation;
3892 (void) key_buffer;
3893 (void) key_buffer_size;
3894 (void) alg;
3895 (void) hash;
3896 (void) hash_length;
3897 (void) signature;
3898 (void) signature_length;
3899 (void) status;
Paul Elliott1243f932023-02-07 11:21:10 +00003900 (void) coordinate_bytes;
Paul Elliott0290a762023-02-09 14:30:24 +00003901 (void) required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003902
Paul Elliott068fe072023-01-16 13:59:15 +00003903 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003904#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3905 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3906 * defined( MBEDTLS_ECP_RESTARTABLE ) */
Paul Elliott588f8ed2022-12-02 18:10:26 +00003907}
3908
3909psa_status_t mbedtls_psa_verify_hash_complete(
3910 mbedtls_psa_verify_hash_interruptible_operation_t *operation)
3911{
3912
3913#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3914 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3915 defined(MBEDTLS_ECP_RESTARTABLE)
3916
Paul Elliottf8e5b562023-02-19 18:43:45 +00003917 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3918
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003919 /* Ensure max_ops is set to the current value (or default). */
3920 mbedtls_psa_interruptible_set_max_ops(psa_interruptible_get_max_ops());
3921
Paul Elliottf8e5b562023-02-19 18:43:45 +00003922 status = mbedtls_to_psa_error(
Paul Elliott588f8ed2022-12-02 18:10:26 +00003923 mbedtls_ecdsa_verify_restartable(&operation->ctx->grp,
3924 operation->hash,
3925 operation->hash_length,
3926 &operation->ctx->Q,
3927 &operation->r,
3928 &operation->s,
3929 &operation->restart_ctx));
3930
Paul Elliottf8e5b562023-02-19 18:43:45 +00003931 /* Hide the fact that the restart context only holds a delta of number of
3932 * ops done during the last operation, not an absolute value. */
3933 operation->num_ops += operation->restart_ctx.ecp.ops_done;
3934
3935 return status;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003936#else
3937 (void) operation;
3938
3939 return PSA_ERROR_NOT_SUPPORTED;
3940
3941#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3942 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3943 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3944}
3945
3946psa_status_t mbedtls_psa_verify_hash_abort(
3947 mbedtls_psa_verify_hash_interruptible_operation_t *operation)
3948{
3949
3950#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3951 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3952 defined(MBEDTLS_ECP_RESTARTABLE)
3953
3954 if (operation->ctx) {
3955 mbedtls_ecdsa_free(operation->ctx);
3956 mbedtls_free(operation->ctx);
Paul Elliottf9c91a72023-02-05 18:06:38 +00003957 operation->ctx = NULL;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003958 }
3959
3960 mbedtls_ecdsa_restart_free(&operation->restart_ctx);
3961
Paul Elliott93d9ca82023-02-15 18:14:21 +00003962 operation->num_ops = 0;
3963
Paul Elliott588f8ed2022-12-02 18:10:26 +00003964 mbedtls_mpi_free(&operation->r);
3965 mbedtls_mpi_free(&operation->s);
3966
3967 return PSA_SUCCESS;
3968
3969#else
3970 (void) operation;
3971
3972 return PSA_ERROR_NOT_SUPPORTED;
3973
3974#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3975 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3976 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3977}
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003978
mohammad1603503973b2018-03-12 15:59:30 +02003979/****************************************************************/
3980/* Symmetric cryptography */
3981/****************************************************************/
3982
Gilles Peskine449bd832023-01-11 14:50:10 +01003983static psa_status_t psa_cipher_setup(psa_cipher_operation_t *operation,
3984 mbedtls_svc_key_id_t key,
3985 psa_algorithm_t alg,
3986 mbedtls_operation_t cipher_operation)
Ronald Cronab99ac22020-10-01 16:38:28 +02003987{
3988 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3989 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman54648242021-06-24 11:49:45 +01003990 psa_key_slot_t *slot = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01003991 psa_key_usage_t usage = (cipher_operation == MBEDTLS_ENCRYPT ?
3992 PSA_KEY_USAGE_ENCRYPT :
3993 PSA_KEY_USAGE_DECRYPT);
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003994 psa_key_attributes_t attributes;
Ronald Cronab99ac22020-10-01 16:38:28 +02003995
3996 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003997 if (operation->id != 0) {
Dave Rodgman54648242021-06-24 11:49:45 +01003998 status = PSA_ERROR_BAD_STATE;
3999 goto exit;
4000 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004001
Gilles Peskine449bd832023-01-11 14:50:10 +01004002 if (!PSA_ALG_IS_CIPHER(alg)) {
Dave Rodgman54648242021-06-24 11:49:45 +01004003 status = PSA_ERROR_INVALID_ARGUMENT;
4004 goto exit;
4005 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004006
Gilles Peskine449bd832023-01-11 14:50:10 +01004007 status = psa_get_and_lock_key_slot_with_policy(key, &slot, usage, alg);
4008 if (status != PSA_SUCCESS) {
Ronald Cronab99ac22020-10-01 16:38:28 +02004009 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004010 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004011
Ronald Cron49fafa92021-03-10 08:34:23 +01004012 /* Initialize the operation struct members, except for id. The id member
Ronald Cronab99ac22020-10-01 16:38:28 +02004013 * is used to indicate to psa_cipher_abort that there are resources to free,
Ronald Cron49fafa92021-03-10 08:34:23 +01004014 * so we only set it (in the driver wrapper) after resources have been
4015 * allocated/initialized. */
Ronald Cronab99ac22020-10-01 16:38:28 +02004016 operation->iv_set = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004017 if (alg == PSA_ALG_ECB_NO_PADDING) {
Ronald Cronab99ac22020-10-01 16:38:28 +02004018 operation->iv_required = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004019 } else {
Ronald Cronab99ac22020-10-01 16:38:28 +02004020 operation->iv_required = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004021 }
4022 operation->default_iv_length = PSA_CIPHER_IV_LENGTH(slot->attr.type, alg);
Ronald Cronab99ac22020-10-01 16:38:28 +02004023
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004024 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004025 .core = slot->attr
Ronald Crona4af55f2020-12-14 14:36:06 +01004026 };
4027
Ronald Cronab99ac22020-10-01 16:38:28 +02004028 /* Try doing the operation through a driver before using software fallback. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004029 if (cipher_operation == MBEDTLS_ENCRYPT) {
4030 status = psa_driver_wrapper_cipher_encrypt_setup(operation,
4031 &attributes,
4032 slot->key.data,
4033 slot->key.bytes,
4034 alg);
4035 } else {
4036 status = psa_driver_wrapper_cipher_decrypt_setup(operation,
4037 &attributes,
4038 slot->key.data,
4039 slot->key.bytes,
4040 alg);
4041 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004042
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004043exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004044 if (status != PSA_SUCCESS) {
4045 psa_cipher_abort(operation);
4046 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004047
Ryan Everett1b70a072024-01-04 10:32:49 +00004048 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02004049
Gilles Peskine449bd832023-01-11 14:50:10 +01004050 return (status == PSA_SUCCESS) ? unlock_status : status;
mohammad1603503973b2018-03-12 15:59:30 +02004051}
4052
Gilles Peskine449bd832023-01-11 14:50:10 +01004053psa_status_t psa_cipher_encrypt_setup(psa_cipher_operation_t *operation,
4054 mbedtls_svc_key_id_t key,
4055 psa_algorithm_t alg)
mohammad16038481e742018-03-18 13:57:31 +02004056{
Gilles Peskine449bd832023-01-11 14:50:10 +01004057 return psa_cipher_setup(operation, key, alg, MBEDTLS_ENCRYPT);
mohammad16038481e742018-03-18 13:57:31 +02004058}
4059
Gilles Peskine449bd832023-01-11 14:50:10 +01004060psa_status_t psa_cipher_decrypt_setup(psa_cipher_operation_t *operation,
4061 mbedtls_svc_key_id_t key,
4062 psa_algorithm_t alg)
mohammad16038481e742018-03-18 13:57:31 +02004063{
Gilles Peskine449bd832023-01-11 14:50:10 +01004064 return psa_cipher_setup(operation, key, alg, MBEDTLS_DECRYPT);
mohammad16038481e742018-03-18 13:57:31 +02004065}
4066
Gilles Peskine449bd832023-01-11 14:50:10 +01004067psa_status_t psa_cipher_generate_iv(psa_cipher_operation_t *operation,
4068 uint8_t *iv,
4069 size_t iv_size,
4070 size_t *iv_length)
mohammad1603503973b2018-03-12 15:59:30 +02004071{
Ronald Cron6d051732020-10-01 14:10:20 +02004072 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2fb90522021-07-05 12:31:44 +02004073 uint8_t local_iv[PSA_CIPHER_IV_MAX_SIZE];
Sergeybef1f632023-03-06 15:25:06 -07004074 size_t default_iv_length = 0;
Ronald Cron5618a392021-03-26 09:52:26 +01004075
Gilles Peskine449bd832023-01-11 14:50:10 +01004076 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004077 status = PSA_ERROR_BAD_STATE;
4078 goto exit;
Ronald Cronc45b4af2020-09-29 16:18:05 +02004079 }
4080
Gilles Peskine449bd832023-01-11 14:50:10 +01004081 if (operation->iv_set || !operation->iv_required) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004082 status = PSA_ERROR_BAD_STATE;
4083 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004084 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004085
Ronald Cron2fb90522021-07-05 12:31:44 +02004086 default_iv_length = operation->default_iv_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01004087 if (iv_size < default_iv_length) {
Ronald Cron5618a392021-03-26 09:52:26 +01004088 status = PSA_ERROR_BUFFER_TOO_SMALL;
4089 goto exit;
4090 }
Gilles Peskinee553c652018-06-04 16:22:46 +02004091
Gilles Peskine449bd832023-01-11 14:50:10 +01004092 if (default_iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Ronald Cron2fb90522021-07-05 12:31:44 +02004093 status = PSA_ERROR_GENERIC_ERROR;
4094 goto exit;
4095 }
4096
Gilles Peskine449bd832023-01-11 14:50:10 +01004097 status = psa_generate_random(local_iv, default_iv_length);
4098 if (status != PSA_SUCCESS) {
Ronald Cron5618a392021-03-26 09:52:26 +01004099 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004100 }
Ronald Cron5618a392021-03-26 09:52:26 +01004101
Gilles Peskine449bd832023-01-11 14:50:10 +01004102 status = psa_driver_wrapper_cipher_set_iv(operation,
4103 local_iv, default_iv_length);
Ronald Cron5618a392021-03-26 09:52:26 +01004104
4105exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004106 if (status == PSA_SUCCESS) {
4107 memcpy(iv, local_iv, default_iv_length);
Ronald Cron2fb90522021-07-05 12:31:44 +02004108 *iv_length = default_iv_length;
Steven Cooreman7df02922020-09-09 15:28:49 +02004109 operation->iv_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004110 } else {
Ronald Cron2fb90522021-07-05 12:31:44 +02004111 *iv_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004112 psa_cipher_abort(operation);
Ronald Cron2fb90522021-07-05 12:31:44 +02004113 }
Ronald Cron6d051732020-10-01 14:10:20 +02004114
Gilles Peskine449bd832023-01-11 14:50:10 +01004115 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004116}
4117
Gilles Peskine449bd832023-01-11 14:50:10 +01004118psa_status_t psa_cipher_set_iv(psa_cipher_operation_t *operation,
4119 const uint8_t *iv,
4120 size_t iv_length)
mohammad1603503973b2018-03-12 15:59:30 +02004121{
Ronald Cron6d051732020-10-01 14:10:20 +02004122 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronc45b4af2020-09-29 16:18:05 +02004123
Gilles Peskine449bd832023-01-11 14:50:10 +01004124 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004125 status = PSA_ERROR_BAD_STATE;
4126 goto exit;
4127 }
Ronald Cronc45b4af2020-09-29 16:18:05 +02004128
Gilles Peskine449bd832023-01-11 14:50:10 +01004129 if (operation->iv_set || !operation->iv_required) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004130 status = PSA_ERROR_BAD_STATE;
4131 goto exit;
4132 }
Ronald Crona0d68172021-03-26 10:15:08 +01004133
Gilles Peskine449bd832023-01-11 14:50:10 +01004134 if (iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004135 status = PSA_ERROR_INVALID_ARGUMENT;
4136 goto exit;
4137 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004138
Gilles Peskine449bd832023-01-11 14:50:10 +01004139 status = psa_driver_wrapper_cipher_set_iv(operation,
4140 iv,
4141 iv_length);
Steven Cooremand3feccd2020-09-01 15:56:14 +02004142
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004143exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004144 if (status == PSA_SUCCESS) {
itayzafrir534bd7c2018-08-02 13:56:32 +03004145 operation->iv_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004146 } else {
4147 psa_cipher_abort(operation);
4148 }
4149 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004150}
4151
Gilles Peskine449bd832023-01-11 14:50:10 +01004152psa_status_t psa_cipher_update(psa_cipher_operation_t *operation,
4153 const uint8_t *input,
4154 size_t input_length,
4155 uint8_t *output,
4156 size_t output_size,
4157 size_t *output_length)
mohammad1603503973b2018-03-12 15:59:30 +02004158{
Steven Cooremanffecb7b2020-08-25 15:13:13 +02004159 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron6d051732020-10-01 14:10:20 +02004160
Gilles Peskine449bd832023-01-11 14:50:10 +01004161 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004162 status = PSA_ERROR_BAD_STATE;
4163 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004164 }
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004165
Gilles Peskine449bd832023-01-11 14:50:10 +01004166 if (operation->iv_required && !operation->iv_set) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004167 status = PSA_ERROR_BAD_STATE;
4168 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004169 }
Jaeden Ameroab439972019-02-15 14:12:05 +00004170
Gilles Peskine449bd832023-01-11 14:50:10 +01004171 status = psa_driver_wrapper_cipher_update(operation,
4172 input,
4173 input_length,
4174 output,
4175 output_size,
4176 output_length);
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004177
4178exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004179 if (status != PSA_SUCCESS) {
4180 psa_cipher_abort(operation);
4181 }
Ronald Cron6d051732020-10-01 14:10:20 +02004182
Gilles Peskine449bd832023-01-11 14:50:10 +01004183 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004184}
4185
Gilles Peskine449bd832023-01-11 14:50:10 +01004186psa_status_t psa_cipher_finish(psa_cipher_operation_t *operation,
4187 uint8_t *output,
4188 size_t output_size,
4189 size_t *output_length)
mohammad1603503973b2018-03-12 15:59:30 +02004190{
David Saadab4ecc272019-02-14 13:48:10 +02004191 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Ronald Cron6d051732020-10-01 14:10:20 +02004192
Gilles Peskine449bd832023-01-11 14:50:10 +01004193 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004194 status = PSA_ERROR_BAD_STATE;
4195 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004196 }
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004197
Gilles Peskine449bd832023-01-11 14:50:10 +01004198 if (operation->iv_required && !operation->iv_set) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004199 status = PSA_ERROR_BAD_STATE;
4200 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004201 }
Moran Pekerbed71a22018-04-22 20:19:20 +03004202
Gilles Peskine449bd832023-01-11 14:50:10 +01004203 status = psa_driver_wrapper_cipher_finish(operation,
4204 output,
4205 output_size,
4206 output_length);
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004207
4208exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004209 if (status == PSA_SUCCESS) {
4210 return psa_cipher_abort(operation);
4211 } else {
Steven Cooremanef8575e2020-09-11 11:44:50 +02004212 *output_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004213 (void) psa_cipher_abort(operation);
Janos Follath315b51c2018-07-09 16:04:51 +01004214
Gilles Peskine449bd832023-01-11 14:50:10 +01004215 return status;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004216 }
mohammad1603503973b2018-03-12 15:59:30 +02004217}
4218
Gilles Peskine449bd832023-01-11 14:50:10 +01004219psa_status_t psa_cipher_abort(psa_cipher_operation_t *operation)
Gilles Peskinee553c652018-06-04 16:22:46 +02004220{
Gilles Peskine449bd832023-01-11 14:50:10 +01004221 if (operation->id == 0) {
Steven Cooremana07b9972020-09-10 14:54:14 +02004222 /* The object has (apparently) been initialized but it is not (yet)
Gilles Peskine81736312018-06-26 15:04:31 +02004223 * in use. It's ok to call abort on such an object, and there's
4224 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004225 return PSA_SUCCESS;
Gilles Peskine81736312018-06-26 15:04:31 +02004226 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004227
Gilles Peskine449bd832023-01-11 14:50:10 +01004228 psa_driver_wrapper_cipher_abort(operation);
Gilles Peskinee553c652018-06-04 16:22:46 +02004229
Ronald Cron49fafa92021-03-10 08:34:23 +01004230 operation->id = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004231 operation->iv_set = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004232 operation->iv_required = 0;
Moran Peker41deec42018-04-04 15:43:05 +03004233
Gilles Peskine449bd832023-01-11 14:50:10 +01004234 return PSA_SUCCESS;
mohammad1603503973b2018-03-12 15:59:30 +02004235}
4236
Gilles Peskine449bd832023-01-11 14:50:10 +01004237psa_status_t psa_cipher_encrypt(mbedtls_svc_key_id_t key,
4238 psa_algorithm_t alg,
4239 const uint8_t *input,
4240 size_t input_length,
4241 uint8_t *output,
4242 size_t output_size,
4243 size_t *output_length)
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004244{
4245 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004246 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron23919522021-07-08 19:00:07 +02004247 psa_key_slot_t *slot = NULL;
Ronald Cronc6e6f502021-07-09 18:44:58 +02004248 uint8_t local_iv[PSA_CIPHER_IV_MAX_SIZE];
4249 size_t default_iv_length = 0;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004250 psa_key_attributes_t attributes;
gabor-mezei-arm6f4e5bb2021-06-25 15:21:11 +02004251
Gilles Peskine449bd832023-01-11 14:50:10 +01004252 if (!PSA_ALG_IS_CIPHER(alg)) {
Ronald Cron23919522021-07-08 19:00:07 +02004253 status = PSA_ERROR_INVALID_ARGUMENT;
4254 goto exit;
4255 }
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004256
Gilles Peskine449bd832023-01-11 14:50:10 +01004257 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
4258 PSA_KEY_USAGE_ENCRYPT,
4259 alg);
4260 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004261 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004262 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004263
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004264 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004265 .core = slot->attr
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004266 };
4267
Gilles Peskine449bd832023-01-11 14:50:10 +01004268 default_iv_length = PSA_CIPHER_IV_LENGTH(slot->attr.type, alg);
4269 if (default_iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Ronald Cronc6e6f502021-07-09 18:44:58 +02004270 status = PSA_ERROR_GENERIC_ERROR;
4271 goto exit;
4272 }
4273
Gilles Peskine449bd832023-01-11 14:50:10 +01004274 if (default_iv_length > 0) {
4275 if (output_size < default_iv_length) {
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004276 status = PSA_ERROR_BUFFER_TOO_SMALL;
4277 goto exit;
4278 }
4279
Gilles Peskine449bd832023-01-11 14:50:10 +01004280 status = psa_generate_random(local_iv, default_iv_length);
4281 if (status != PSA_SUCCESS) {
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004282 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004283 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004284 }
4285
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004286 status = psa_driver_wrapper_cipher_encrypt(
4287 &attributes, slot->key.data, slot->key.bytes,
Ronald Cronc6e6f502021-07-09 18:44:58 +02004288 alg, local_iv, default_iv_length, input, input_length,
Ronald Cronafbc7ed2023-01-24 16:02:04 +01004289 psa_crypto_buffer_offset(output, default_iv_length),
Gilles Peskine449bd832023-01-11 14:50:10 +01004290 output_size - default_iv_length, output_length);
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004291
4292exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00004293 unlock_status = psa_unregister_read(slot);
Gilles Peskine449bd832023-01-11 14:50:10 +01004294 if (status == PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004295 status = unlock_status;
Ronald Cronc6e6f502021-07-09 18:44:58 +02004296 }
Ronald Cron23919522021-07-08 19:00:07 +02004297
Gilles Peskine449bd832023-01-11 14:50:10 +01004298 if (status == PSA_SUCCESS) {
4299 if (default_iv_length > 0) {
4300 memcpy(output, local_iv, default_iv_length);
4301 }
4302 *output_length += default_iv_length;
4303 } else {
4304 *output_length = 0;
4305 }
4306
4307 return status;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004308}
4309
Gilles Peskine449bd832023-01-11 14:50:10 +01004310psa_status_t psa_cipher_decrypt(mbedtls_svc_key_id_t key,
4311 psa_algorithm_t alg,
4312 const uint8_t *input,
4313 size_t input_length,
4314 uint8_t *output,
4315 size_t output_size,
4316 size_t *output_length)
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004317{
4318 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004319 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron23919522021-07-08 19:00:07 +02004320 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004321 psa_key_attributes_t attributes;
gabor-mezei-arm6f4e5bb2021-06-25 15:21:11 +02004322
Gilles Peskine449bd832023-01-11 14:50:10 +01004323 if (!PSA_ALG_IS_CIPHER(alg)) {
Ronald Cron23919522021-07-08 19:00:07 +02004324 status = PSA_ERROR_INVALID_ARGUMENT;
4325 goto exit;
4326 }
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004327
Gilles Peskine449bd832023-01-11 14:50:10 +01004328 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
4329 PSA_KEY_USAGE_DECRYPT,
4330 alg);
4331 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004332 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004333 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004334
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004335 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004336 .core = slot->attr
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004337 };
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004338
Gilles Peskine449bd832023-01-11 14:50:10 +01004339 if (alg == PSA_ALG_CCM_STAR_NO_TAG &&
4340 input_length < PSA_BLOCK_CIPHER_BLOCK_LENGTH(slot->attr.type)) {
Mateusz Starzyk594215b2021-10-14 12:23:06 +02004341 status = PSA_ERROR_INVALID_ARGUMENT;
4342 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004343 } else if (input_length < PSA_CIPHER_IV_LENGTH(slot->attr.type, alg)) {
gabor-mezei-arm258ae072021-06-25 15:25:38 +02004344 status = PSA_ERROR_INVALID_ARGUMENT;
4345 goto exit;
4346 }
4347
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004348 status = psa_driver_wrapper_cipher_decrypt(
4349 &attributes, slot->key.data, slot->key.bytes,
4350 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004351 output, output_size, output_length);
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004352
gabor-mezei-arm258ae072021-06-25 15:25:38 +02004353exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00004354 unlock_status = psa_unregister_read(slot);
Gilles Peskine449bd832023-01-11 14:50:10 +01004355 if (status == PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004356 status = unlock_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01004357 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004358
Gilles Peskine449bd832023-01-11 14:50:10 +01004359 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004360 *output_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004361 }
Ronald Cron23919522021-07-08 19:00:07 +02004362
Gilles Peskine449bd832023-01-11 14:50:10 +01004363 return status;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004364}
4365
4366
mohammad16035955c982018-04-26 00:53:03 +03004367/****************************************************************/
4368/* AEAD */
4369/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004370
Paul Elliottbaff51c2021-09-28 17:44:45 +01004371/* Helper function to get the base algorithm from its variants. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004372static psa_algorithm_t psa_aead_get_base_algorithm(psa_algorithm_t alg)
Paul Elliottbaff51c2021-09-28 17:44:45 +01004373{
Gilles Peskine449bd832023-01-11 14:50:10 +01004374 return PSA_ALG_AEAD_WITH_DEFAULT_LENGTH_TAG(alg);
Paul Elliottbaff51c2021-09-28 17:44:45 +01004375}
4376
4377/* Helper function to perform common nonce length checks. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004378static psa_status_t psa_aead_check_nonce_length(psa_algorithm_t alg,
4379 size_t nonce_length)
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004380{
Gilles Peskine449bd832023-01-11 14:50:10 +01004381 psa_algorithm_t base_alg = psa_aead_get_base_algorithm(alg);
Paul Elliottbaff51c2021-09-28 17:44:45 +01004382
Gilles Peskine449bd832023-01-11 14:50:10 +01004383 switch (base_alg) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004384#if defined(PSA_WANT_ALG_GCM)
4385 case PSA_ALG_GCM:
4386 /* Not checking max nonce size here as GCM spec allows almost
Gilles Peskine449bd832023-01-11 14:50:10 +01004387 * arbitrarily large nonces. Please note that we do not generally
4388 * recommend the usage of nonces of greater length than
4389 * PSA_AEAD_NONCE_MAX_SIZE, as large nonces are hashed to a shorter
4390 * size, which can then lead to collisions if you encrypt a very
4391 * large number of messages.*/
4392 if (nonce_length != 0) {
4393 return PSA_SUCCESS;
4394 }
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004395 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004396#endif /* PSA_WANT_ALG_GCM */
4397#if defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004398 case PSA_ALG_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01004399 if (nonce_length >= 7 && nonce_length <= 13) {
4400 return PSA_SUCCESS;
4401 }
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004402 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004403#endif /* PSA_WANT_ALG_CCM */
4404#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004405 case PSA_ALG_CHACHA20_POLY1305:
Gilles Peskine449bd832023-01-11 14:50:10 +01004406 if (nonce_length == 12) {
4407 return PSA_SUCCESS;
4408 } else if (nonce_length == 8) {
4409 return PSA_ERROR_NOT_SUPPORTED;
4410 }
Bence Szépkúti6d48e202021-11-15 20:04:15 +01004411 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004412#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004413 default:
Przemek Stekiel4c499272022-09-27 13:55:37 +02004414 (void) nonce_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01004415 return PSA_ERROR_NOT_SUPPORTED;
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004416 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004417
Gilles Peskine449bd832023-01-11 14:50:10 +01004418 return PSA_ERROR_INVALID_ARGUMENT;
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004419}
4420
Gilles Peskine449bd832023-01-11 14:50:10 +01004421static psa_status_t psa_aead_check_algorithm(psa_algorithm_t alg)
Bence Szépkútiaa3a6e42022-01-13 16:26:03 +01004422{
Gilles Peskine449bd832023-01-11 14:50:10 +01004423 if (!PSA_ALG_IS_AEAD(alg) || PSA_ALG_IS_WILDCARD(alg)) {
4424 return PSA_ERROR_INVALID_ARGUMENT;
4425 }
Bence Szépkúti08f34652021-12-08 21:07:13 +01004426
Gilles Peskine449bd832023-01-11 14:50:10 +01004427 return PSA_SUCCESS;
Bence Szépkúti08f34652021-12-08 21:07:13 +01004428}
4429
Gilles Peskine449bd832023-01-11 14:50:10 +01004430psa_status_t psa_aead_encrypt(mbedtls_svc_key_id_t key,
4431 psa_algorithm_t alg,
4432 const uint8_t *nonce,
4433 size_t nonce_length,
4434 const uint8_t *additional_data,
4435 size_t additional_data_length,
4436 const uint8_t *plaintext,
4437 size_t plaintext_length,
4438 uint8_t *ciphertext,
4439 size_t ciphertext_size,
4440 size_t *ciphertext_length)
mohammad16035955c982018-04-26 00:53:03 +03004441{
Ronald Cron215633c2021-03-16 17:15:37 +01004442 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4443 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02004444
mohammad1603f08a5502018-06-03 15:05:47 +03004445 *ciphertext_length = 0;
mohammad1603e58e6842018-05-09 04:58:32 -07004446
Gilles Peskine449bd832023-01-11 14:50:10 +01004447 status = psa_aead_check_algorithm(alg);
4448 if (status != PSA_SUCCESS) {
4449 return status;
4450 }
Steven Cooremanea7ab132021-03-17 16:28:00 +01004451
Ronald Cron9a986162021-03-26 12:40:07 +01004452 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01004453 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg);
4454 if (status != PSA_SUCCESS) {
4455 return status;
4456 }
mohammad16035955c982018-04-26 00:53:03 +03004457
Ronald Cron215633c2021-03-16 17:15:37 +01004458 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01004459 .core = slot->attr
Ronald Cron215633c2021-03-16 17:15:37 +01004460 };
mohammad16035955c982018-04-26 00:53:03 +03004461
Gilles Peskine449bd832023-01-11 14:50:10 +01004462 status = psa_aead_check_nonce_length(alg, nonce_length);
4463 if (status != PSA_SUCCESS) {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004464 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004465 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004466
Ronald Cronde822812021-03-17 16:08:20 +01004467 status = psa_driver_wrapper_aead_encrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01004468 &attributes, slot->key.data, slot->key.bytes,
4469 alg,
4470 nonce, nonce_length,
4471 additional_data, additional_data_length,
4472 plaintext, plaintext_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004473 ciphertext, ciphertext_size, ciphertext_length);
Gilles Peskine2d277862018-06-18 15:41:12 +02004474
Gilles Peskine449bd832023-01-11 14:50:10 +01004475 if (status != PSA_SUCCESS && ciphertext_size != 0) {
4476 memset(ciphertext, 0, ciphertext_size);
4477 }
Gilles Peskine2d277862018-06-18 15:41:12 +02004478
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004479exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00004480 psa_unregister_read(slot);
mohammad16035955c982018-04-26 00:53:03 +03004481
Gilles Peskine449bd832023-01-11 14:50:10 +01004482 return status;
Gilles Peskineee652a32018-06-01 19:23:52 +02004483}
4484
Gilles Peskine449bd832023-01-11 14:50:10 +01004485psa_status_t psa_aead_decrypt(mbedtls_svc_key_id_t key,
4486 psa_algorithm_t alg,
4487 const uint8_t *nonce,
4488 size_t nonce_length,
4489 const uint8_t *additional_data,
4490 size_t additional_data_length,
4491 const uint8_t *ciphertext,
4492 size_t ciphertext_length,
4493 uint8_t *plaintext,
4494 size_t plaintext_size,
4495 size_t *plaintext_length)
mohammad16035955c982018-04-26 00:53:03 +03004496{
Ronald Cron215633c2021-03-16 17:15:37 +01004497 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4498 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02004499
Gilles Peskineee652a32018-06-01 19:23:52 +02004500 *plaintext_length = 0;
mohammad16039e5a5152018-04-26 12:07:35 +03004501
Gilles Peskine449bd832023-01-11 14:50:10 +01004502 status = psa_aead_check_algorithm(alg);
4503 if (status != PSA_SUCCESS) {
4504 return status;
4505 }
Steven Cooremanea7ab132021-03-17 16:28:00 +01004506
Ronald Cron9a986162021-03-26 12:40:07 +01004507 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01004508 key, &slot, PSA_KEY_USAGE_DECRYPT, alg);
4509 if (status != PSA_SUCCESS) {
4510 return status;
4511 }
mohammad16035955c982018-04-26 00:53:03 +03004512
Ronald Cron215633c2021-03-16 17:15:37 +01004513 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01004514 .core = slot->attr
Ronald Cron215633c2021-03-16 17:15:37 +01004515 };
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004516
Gilles Peskine449bd832023-01-11 14:50:10 +01004517 status = psa_aead_check_nonce_length(alg, nonce_length);
4518 if (status != PSA_SUCCESS) {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004519 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004520 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004521
Ronald Cronde822812021-03-17 16:08:20 +01004522 status = psa_driver_wrapper_aead_decrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01004523 &attributes, slot->key.data, slot->key.bytes,
4524 alg,
4525 nonce, nonce_length,
4526 additional_data, additional_data_length,
4527 ciphertext, ciphertext_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004528 plaintext, plaintext_size, plaintext_length);
Gilles Peskinea40d7742018-06-01 16:28:30 +02004529
Gilles Peskine449bd832023-01-11 14:50:10 +01004530 if (status != PSA_SUCCESS && plaintext_size != 0) {
4531 memset(plaintext, 0, plaintext_size);
4532 }
mohammad160360a64d02018-06-03 17:20:42 +03004533
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004534exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00004535 psa_unregister_read(slot);
Ronald Cron215633c2021-03-16 17:15:37 +01004536
Gilles Peskine449bd832023-01-11 14:50:10 +01004537 return status;
mohammad16035955c982018-04-26 00:53:03 +03004538}
4539
Gilles Peskine449bd832023-01-11 14:50:10 +01004540static psa_status_t psa_validate_tag_length(psa_algorithm_t alg)
4541{
4542 const uint8_t tag_len = PSA_ALG_AEAD_GET_TAG_LENGTH(alg);
Andrzej Kurekf8816012021-12-19 17:00:12 +01004543
Gilles Peskine449bd832023-01-11 14:50:10 +01004544 switch (PSA_ALG_AEAD_WITH_SHORTENED_TAG(alg, 0)) {
Przemek Stekiel86679c72022-10-06 17:06:56 +02004545#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004546 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004547 /* CCM allows the following tag lengths: 4, 6, 8, 10, 12, 14, 16.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004548 if (tag_len < 4 || tag_len > 16 || tag_len % 2) {
4549 return PSA_ERROR_INVALID_ARGUMENT;
4550 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01004551 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02004552#endif /* PSA_WANT_ALG_CCM */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004553
Przemek Stekiel86679c72022-10-06 17:06:56 +02004554#if defined(PSA_WANT_ALG_GCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004555 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_GCM, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004556 /* GCM allows the following tag lengths: 4, 8, 12, 13, 14, 15, 16. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004557 if (tag_len != 4 && tag_len != 8 && (tag_len < 12 || tag_len > 16)) {
4558 return PSA_ERROR_INVALID_ARGUMENT;
4559 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01004560 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02004561#endif /* PSA_WANT_ALG_GCM */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004562
Przemek Stekiel86679c72022-10-06 17:06:56 +02004563#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Gilles Peskine449bd832023-01-11 14:50:10 +01004564 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CHACHA20_POLY1305, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004565 /* We only support the default tag length. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004566 if (tag_len != 16) {
4567 return PSA_ERROR_INVALID_ARGUMENT;
4568 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01004569 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02004570#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004571
4572 default:
4573 (void) tag_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004574 return PSA_ERROR_NOT_SUPPORTED;
Andrzej Kurekf8816012021-12-19 17:00:12 +01004575 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004576 return PSA_SUCCESS;
Andrzej Kurekf8816012021-12-19 17:00:12 +01004577}
4578
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004579/* Set the key for a multipart authenticated operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004580static psa_status_t psa_aead_setup(psa_aead_operation_t *operation,
4581 int is_encrypt,
4582 mbedtls_svc_key_id_t key,
4583 psa_algorithm_t alg)
Paul Elliottc2b71442021-06-24 18:17:52 +01004584{
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004585 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4586 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
4587 psa_key_slot_t *slot = NULL;
4588 psa_key_usage_t key_usage = 0;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004589 psa_key_attributes_t attributes;
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004590
Gilles Peskine449bd832023-01-11 14:50:10 +01004591 status = psa_aead_check_algorithm(alg);
4592 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004593 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004594 }
Paul Elliottc2b71442021-06-24 18:17:52 +01004595
Gilles Peskine449bd832023-01-11 14:50:10 +01004596 if (operation->id != 0) {
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 (operation->nonce_set || operation->lengths_set ||
4602 operation->ad_started || operation->body_started) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004603 status = PSA_ERROR_BAD_STATE;
4604 goto exit;
Paul Elliottc2b71442021-06-24 18:17:52 +01004605 }
4606
Gilles Peskine449bd832023-01-11 14:50:10 +01004607 if (is_encrypt) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004608 key_usage = PSA_KEY_USAGE_ENCRYPT;
Gilles Peskine449bd832023-01-11 14:50:10 +01004609 } else {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004610 key_usage = PSA_KEY_USAGE_DECRYPT;
Gilles Peskine449bd832023-01-11 14:50:10 +01004611 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004612
Gilles Peskine449bd832023-01-11 14:50:10 +01004613 status = psa_get_and_lock_key_slot_with_policy(key, &slot, key_usage,
4614 alg);
4615 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004616 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004617 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004618
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004619 attributes = (psa_key_attributes_t) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004620 .core = slot->attr
4621 };
4622
Gilles Peskine449bd832023-01-11 14:50:10 +01004623 if ((status = psa_validate_tag_length(alg)) != PSA_SUCCESS) {
Przemek Stekiel6ab50762022-10-08 17:54:30 +02004624 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004625 }
Przemek Stekiel6ab50762022-10-08 17:54:30 +02004626
Gilles Peskine449bd832023-01-11 14:50:10 +01004627 if (is_encrypt) {
4628 status = psa_driver_wrapper_aead_encrypt_setup(operation,
4629 &attributes,
4630 slot->key.data,
4631 slot->key.bytes,
4632 alg);
4633 } else {
4634 status = psa_driver_wrapper_aead_decrypt_setup(operation,
4635 &attributes,
4636 slot->key.data,
4637 slot->key.bytes,
4638 alg);
4639 }
4640 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004641 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004642 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004643
Gilles Peskine449bd832023-01-11 14:50:10 +01004644 operation->key_type = psa_get_key_type(&attributes);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004645
4646exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00004647 unlock_status = psa_unregister_read(slot);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004648
Gilles Peskine449bd832023-01-11 14:50:10 +01004649 if (status == PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004650 status = unlock_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01004651 operation->alg = psa_aead_get_base_algorithm(alg);
Paul Elliottd9343f22021-08-23 18:59:49 +01004652 operation->is_encrypt = is_encrypt;
Gilles Peskine449bd832023-01-11 14:50:10 +01004653 } else {
4654 psa_aead_abort(operation);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004655 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004656
Gilles Peskine449bd832023-01-11 14:50:10 +01004657 return status;
Paul Elliottc2b71442021-06-24 18:17:52 +01004658}
4659
Paul Elliott302ff6b2021-04-20 18:10:30 +01004660/* Set the key for a multipart authenticated encryption operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004661psa_status_t psa_aead_encrypt_setup(psa_aead_operation_t *operation,
4662 mbedtls_svc_key_id_t key,
4663 psa_algorithm_t alg)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004664{
Gilles Peskine449bd832023-01-11 14:50:10 +01004665 return psa_aead_setup(operation, 1, key, alg);
Paul Elliott302ff6b2021-04-20 18:10:30 +01004666}
4667
4668/* Set the key for a multipart authenticated decryption operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004669psa_status_t psa_aead_decrypt_setup(psa_aead_operation_t *operation,
4670 mbedtls_svc_key_id_t key,
4671 psa_algorithm_t alg)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004672{
Gilles Peskine449bd832023-01-11 14:50:10 +01004673 return psa_aead_setup(operation, 0, key, alg);
Paul Elliott302ff6b2021-04-20 18:10:30 +01004674}
4675
4676/* Generate a random nonce / IV for multipart AEAD operation */
Gilles Peskine449bd832023-01-11 14:50:10 +01004677psa_status_t psa_aead_generate_nonce(psa_aead_operation_t *operation,
4678 uint8_t *nonce,
4679 size_t nonce_size,
4680 size_t *nonce_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004681{
4682 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Croncae59092021-11-26 18:53:58 +01004683 uint8_t local_nonce[PSA_AEAD_NONCE_MAX_SIZE];
Sergeybef1f632023-03-06 15:25:06 -07004684 size_t required_nonce_size = 0;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004685
Paul Elliott8eb9daf2021-06-04 16:42:21 +01004686 *nonce_length = 0;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004687
Gilles Peskine449bd832023-01-11 14:50:10 +01004688 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004689 status = PSA_ERROR_BAD_STATE;
4690 goto exit;
4691 }
4692
Gilles Peskine449bd832023-01-11 14:50:10 +01004693 if (operation->nonce_set || !operation->is_encrypt) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004694 status = PSA_ERROR_BAD_STATE;
4695 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004696 }
4697
Paul Elliotte193ea82021-10-01 13:00:16 +01004698 /* For CCM, this size may not be correct according to the PSA
4699 * specification. The PSA Crypto 1.0.1 specification states:
4700 *
4701 * CCM encodes the plaintext length pLen in L octets, with L the smallest
4702 * integer >= 2 where pLen < 2^(8L). The nonce length is then 15 - L bytes.
4703 *
4704 * However this restriction that L has to be the smallest integer is not
4705 * applied in practice, and it is not implementable here since the
4706 * plaintext length may or may not be known at this time. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004707 required_nonce_size = PSA_AEAD_NONCE_LENGTH(operation->key_type,
4708 operation->alg);
4709 if (nonce_size < required_nonce_size) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004710 status = PSA_ERROR_BUFFER_TOO_SMALL;
4711 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004712 }
4713
Gilles Peskine449bd832023-01-11 14:50:10 +01004714 status = psa_generate_random(local_nonce, required_nonce_size);
4715 if (status != PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004716 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004717 }
Paul Elliott302ff6b2021-04-20 18:10:30 +01004718
Gilles Peskine449bd832023-01-11 14:50:10 +01004719 status = psa_aead_set_nonce(operation, local_nonce, required_nonce_size);
Paul Elliott302ff6b2021-04-20 18:10:30 +01004720
Paul Elliott39dc6b82021-05-11 19:16:09 +01004721exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004722 if (status == PSA_SUCCESS) {
4723 memcpy(nonce, local_nonce, required_nonce_size);
Paul Elliott39dc6b82021-05-11 19:16:09 +01004724 *nonce_length = required_nonce_size;
Gilles Peskine449bd832023-01-11 14:50:10 +01004725 } else {
4726 psa_aead_abort(operation);
Ronald Croncae59092021-11-26 18:53:58 +01004727 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01004728
Gilles Peskine449bd832023-01-11 14:50:10 +01004729 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004730}
4731
4732/* Set the nonce for a multipart authenticated encryption or decryption
4733 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004734psa_status_t psa_aead_set_nonce(psa_aead_operation_t *operation,
4735 const uint8_t *nonce,
4736 size_t nonce_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004737{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004738 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4739
Gilles Peskine449bd832023-01-11 14:50:10 +01004740 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004741 status = PSA_ERROR_BAD_STATE;
4742 goto exit;
4743 }
4744
Gilles Peskine449bd832023-01-11 14:50:10 +01004745 if (operation->nonce_set) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004746 status = PSA_ERROR_BAD_STATE;
4747 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004748 }
4749
Gilles Peskine449bd832023-01-11 14:50:10 +01004750 status = psa_aead_check_nonce_length(operation->alg, nonce_length);
4751 if (status != PSA_SUCCESS) {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004752 status = PSA_ERROR_INVALID_ARGUMENT;
4753 goto exit;
Paul Elliott4ed1ed12021-09-27 18:09:28 +01004754 }
Paul Elliott1a98aca2021-05-20 18:24:07 +01004755
Gilles Peskine449bd832023-01-11 14:50:10 +01004756 status = psa_driver_wrapper_aead_set_nonce(operation, nonce,
4757 nonce_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004758
Paul Elliott39dc6b82021-05-11 19:16:09 +01004759exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004760 if (status == PSA_SUCCESS) {
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004761 operation->nonce_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004762 } else {
4763 psa_aead_abort(operation);
4764 }
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004765
Gilles Peskine449bd832023-01-11 14:50:10 +01004766 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004767}
4768
4769/* Declare the lengths of the message and additional data for multipart AEAD. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004770psa_status_t psa_aead_set_lengths(psa_aead_operation_t *operation,
4771 size_t ad_length,
4772 size_t plaintext_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004773{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004774 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4775
Gilles Peskine449bd832023-01-11 14:50:10 +01004776 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004777 status = PSA_ERROR_BAD_STATE;
4778 goto exit;
4779 }
4780
Gilles Peskine449bd832023-01-11 14:50:10 +01004781 if (operation->lengths_set || operation->ad_started ||
4782 operation->body_started) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004783 status = PSA_ERROR_BAD_STATE;
4784 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004785 }
4786
Gilles Peskine449bd832023-01-11 14:50:10 +01004787 switch (operation->alg) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004788#if defined(PSA_WANT_ALG_GCM)
4789 case PSA_ALG_GCM:
4790 /* Lengths can only be too large for GCM if size_t is bigger than 32
Gilles Peskine449bd832023-01-11 14:50:10 +01004791 * bits. Without the guard this code will generate warnings on 32bit
4792 * builds. */
Paul Elliott325d3742021-09-27 17:56:28 +01004793#if SIZE_MAX > UINT32_MAX
Gilles Peskine449bd832023-01-11 14:50:10 +01004794 if (((uint64_t) ad_length) >> 61 != 0 ||
4795 ((uint64_t) plaintext_length) > 0xFFFFFFFE0ull) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004796 status = PSA_ERROR_INVALID_ARGUMENT;
4797 goto exit;
4798 }
Paul Elliott325d3742021-09-27 17:56:28 +01004799#endif
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004800 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004801#endif /* PSA_WANT_ALG_GCM */
4802#if defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004803 case PSA_ALG_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01004804 if (ad_length > 0xFF00) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004805 status = PSA_ERROR_INVALID_ARGUMENT;
4806 goto exit;
4807 }
4808 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004809#endif /* PSA_WANT_ALG_CCM */
4810#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004811 case PSA_ALG_CHACHA20_POLY1305:
4812 /* No length restrictions for ChaChaPoly. */
4813 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004814#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004815 default:
4816 break;
4817 }
Paul Elliott325d3742021-09-27 17:56:28 +01004818
Gilles Peskine449bd832023-01-11 14:50:10 +01004819 status = psa_driver_wrapper_aead_set_lengths(operation, ad_length,
4820 plaintext_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004821
Paul Elliott39dc6b82021-05-11 19:16:09 +01004822exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004823 if (status == PSA_SUCCESS) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01004824 operation->ad_remaining = ad_length;
4825 operation->body_remaining = plaintext_length;
Paul Elliott39dc6b82021-05-11 19:16:09 +01004826 operation->lengths_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004827 } else {
4828 psa_aead_abort(operation);
Paul Elliottee4ffe02021-05-20 17:25:06 +01004829 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01004830
Gilles Peskine449bd832023-01-11 14:50:10 +01004831 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004832}
Paul Elliott3d7d52c2021-09-01 10:33:14 +01004833
4834/* Pass additional data to an active multipart AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004835psa_status_t psa_aead_update_ad(psa_aead_operation_t *operation,
4836 const uint8_t *input,
4837 size_t input_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004838{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004839 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4840
Gilles Peskine449bd832023-01-11 14:50:10 +01004841 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004842 status = PSA_ERROR_BAD_STATE;
4843 goto exit;
4844 }
4845
Gilles Peskine449bd832023-01-11 14:50:10 +01004846 if (!operation->nonce_set || operation->body_started) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004847 status = PSA_ERROR_BAD_STATE;
4848 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004849 }
4850
Gilles Peskine449bd832023-01-11 14:50:10 +01004851 if (operation->lengths_set) {
4852 if (operation->ad_remaining < input_length) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01004853 status = PSA_ERROR_INVALID_ARGUMENT;
4854 goto exit;
4855 }
4856
4857 operation->ad_remaining -= input_length;
4858 }
Paul Elliotte193ea82021-10-01 13:00:16 +01004859#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004860 else if (operation->alg == PSA_ALG_CCM) {
Paul Elliotte193ea82021-10-01 13:00:16 +01004861 status = PSA_ERROR_BAD_STATE;
4862 goto exit;
4863 }
4864#endif /* PSA_WANT_ALG_CCM */
Paul Elliottee4ffe02021-05-20 17:25:06 +01004865
Gilles Peskine449bd832023-01-11 14:50:10 +01004866 status = psa_driver_wrapper_aead_update_ad(operation, input,
4867 input_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004868
Paul Elliott39dc6b82021-05-11 19:16:09 +01004869exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004870 if (status == PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004871 operation->ad_started = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004872 } else {
4873 psa_aead_abort(operation);
4874 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01004875
Gilles Peskine449bd832023-01-11 14:50:10 +01004876 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004877}
4878
4879/* Encrypt or decrypt a message fragment in an active multipart AEAD
4880 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004881psa_status_t psa_aead_update(psa_aead_operation_t *operation,
4882 const uint8_t *input,
4883 size_t input_length,
4884 uint8_t *output,
4885 size_t output_size,
4886 size_t *output_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004887{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004888 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004889
4890 *output_length = 0;
4891
Gilles Peskine449bd832023-01-11 14:50:10 +01004892 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004893 status = PSA_ERROR_BAD_STATE;
4894 goto exit;
4895 }
4896
Gilles Peskine449bd832023-01-11 14:50:10 +01004897 if (!operation->nonce_set) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004898 status = PSA_ERROR_BAD_STATE;
4899 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004900 }
4901
Gilles Peskine449bd832023-01-11 14:50:10 +01004902 if (operation->lengths_set) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01004903 /* Additional data length was supplied, but not all the additional
4904 data was supplied.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004905 if (operation->ad_remaining != 0) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01004906 status = PSA_ERROR_INVALID_ARGUMENT;
4907 goto exit;
4908 }
4909
4910 /* Too much data provided. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004911 if (operation->body_remaining < input_length) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01004912 status = PSA_ERROR_INVALID_ARGUMENT;
4913 goto exit;
4914 }
4915
4916 operation->body_remaining -= input_length;
4917 }
Paul Elliotte193ea82021-10-01 13:00:16 +01004918#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004919 else if (operation->alg == PSA_ALG_CCM) {
Paul Elliotte193ea82021-10-01 13:00:16 +01004920 status = PSA_ERROR_BAD_STATE;
4921 goto exit;
4922 }
4923#endif /* PSA_WANT_ALG_CCM */
Paul Elliottee4ffe02021-05-20 17:25:06 +01004924
Gilles Peskine449bd832023-01-11 14:50:10 +01004925 status = psa_driver_wrapper_aead_update(operation, input, input_length,
4926 output, output_size,
4927 output_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004928
Paul Elliott39dc6b82021-05-11 19:16:09 +01004929exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004930 if (status == PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004931 operation->body_started = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004932 } else {
4933 psa_aead_abort(operation);
4934 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01004935
Gilles Peskine449bd832023-01-11 14:50:10 +01004936 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004937}
4938
Gilles Peskine449bd832023-01-11 14:50:10 +01004939static psa_status_t psa_aead_final_checks(const psa_aead_operation_t *operation)
Paul Elliottad53dcc2021-06-23 08:50:14 +01004940{
Gilles Peskine449bd832023-01-11 14:50:10 +01004941 if (operation->id == 0 || !operation->nonce_set) {
4942 return PSA_ERROR_BAD_STATE;
4943 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01004944
Gilles Peskine449bd832023-01-11 14:50:10 +01004945 if (operation->lengths_set && (operation->ad_remaining != 0 ||
4946 operation->body_remaining != 0)) {
4947 return PSA_ERROR_INVALID_ARGUMENT;
4948 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01004949
Gilles Peskine449bd832023-01-11 14:50:10 +01004950 return PSA_SUCCESS;
Paul Elliottad53dcc2021-06-23 08:50:14 +01004951}
4952
Paul Elliott302ff6b2021-04-20 18:10:30 +01004953/* Finish encrypting a message in a multipart AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004954psa_status_t psa_aead_finish(psa_aead_operation_t *operation,
4955 uint8_t *ciphertext,
4956 size_t ciphertext_size,
4957 size_t *ciphertext_length,
4958 uint8_t *tag,
4959 size_t tag_size,
4960 size_t *tag_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004961{
Paul Elliott39dc6b82021-05-11 19:16:09 +01004962 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4963
Paul Elliott302ff6b2021-04-20 18:10:30 +01004964 *ciphertext_length = 0;
Paul Elliottf88a5652021-06-22 17:53:45 +01004965 *tag_length = tag_size;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004966
Gilles Peskine449bd832023-01-11 14:50:10 +01004967 status = psa_aead_final_checks(operation);
4968 if (status != PSA_SUCCESS) {
Paul Elliottad53dcc2021-06-23 08:50:14 +01004969 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004970 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01004971
Gilles Peskine449bd832023-01-11 14:50:10 +01004972 if (!operation->is_encrypt) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004973 status = PSA_ERROR_BAD_STATE;
4974 goto exit;
4975 }
4976
Gilles Peskine449bd832023-01-11 14:50:10 +01004977 status = psa_driver_wrapper_aead_finish(operation, ciphertext,
4978 ciphertext_size,
4979 ciphertext_length,
4980 tag, tag_size, tag_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004981
Paul Elliott39dc6b82021-05-11 19:16:09 +01004982exit:
Paul Elliottdc42ca82023-02-24 18:11:59 +00004983
4984
Paul Elliottf47b0952021-05-21 18:02:33 +01004985 /* In case the operation fails and the user fails to check for failure or
Paul Elliott4c916e82021-09-19 18:34:50 +01004986 * the zero tag size, make sure the tag is set to something implausible.
4987 * Even if the operation succeeds, make sure we clear the rest of the
4988 * buffer to prevent potential leakage of anything previously placed in
4989 * the same buffer.*/
Paul Elliottdc42ca82023-02-24 18:11:59 +00004990 psa_wipe_tag_output_buffer(tag, status, tag_size, *tag_length);
Paul Elliottf47b0952021-05-21 18:02:33 +01004991
Gilles Peskine449bd832023-01-11 14:50:10 +01004992 psa_aead_abort(operation);
Paul Elliott39dc6b82021-05-11 19:16:09 +01004993
Gilles Peskine449bd832023-01-11 14:50:10 +01004994 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004995}
4996
4997/* Finish authenticating and decrypting a message in a multipart AEAD
4998 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004999psa_status_t psa_aead_verify(psa_aead_operation_t *operation,
5000 uint8_t *plaintext,
5001 size_t plaintext_size,
5002 size_t *plaintext_length,
5003 const uint8_t *tag,
5004 size_t tag_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005005{
Paul Elliott39dc6b82021-05-11 19:16:09 +01005006 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5007
Paul Elliott302ff6b2021-04-20 18:10:30 +01005008 *plaintext_length = 0;
5009
Gilles Peskine449bd832023-01-11 14:50:10 +01005010 status = psa_aead_final_checks(operation);
5011 if (status != PSA_SUCCESS) {
Paul Elliottad53dcc2021-06-23 08:50:14 +01005012 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005013 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01005014
Gilles Peskine449bd832023-01-11 14:50:10 +01005015 if (operation->is_encrypt) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005016 status = PSA_ERROR_BAD_STATE;
5017 goto exit;
5018 }
5019
Gilles Peskine449bd832023-01-11 14:50:10 +01005020 status = psa_driver_wrapper_aead_verify(operation, plaintext,
5021 plaintext_size,
5022 plaintext_length,
5023 tag, tag_length);
Paul Elliott39dc6b82021-05-11 19:16:09 +01005024
5025exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005026 psa_aead_abort(operation);
Paul Elliott39dc6b82021-05-11 19:16:09 +01005027
Gilles Peskine449bd832023-01-11 14:50:10 +01005028 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005029}
5030
5031/* Abort an AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005032psa_status_t psa_aead_abort(psa_aead_operation_t *operation)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005033{
5034 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5035
Gilles Peskine449bd832023-01-11 14:50:10 +01005036 if (operation->id == 0) {
Paul Elliott302ff6b2021-04-20 18:10:30 +01005037 /* The object has (apparently) been initialized but it is not (yet)
5038 * in use. It's ok to call abort on such an object, and there's
5039 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005040 return PSA_SUCCESS;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005041 }
5042
Gilles Peskine449bd832023-01-11 14:50:10 +01005043 status = psa_driver_wrapper_aead_abort(operation);
Paul Elliott302ff6b2021-04-20 18:10:30 +01005044
Gilles Peskine449bd832023-01-11 14:50:10 +01005045 memset(operation, 0, sizeof(*operation));
Paul Elliott302ff6b2021-04-20 18:10:30 +01005046
Gilles Peskine449bd832023-01-11 14:50:10 +01005047 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005048}
5049
Gilles Peskinee59236f2018-01-27 23:32:46 +01005050/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02005051/* Generators */
5052/****************************************************************/
5053
Przemek Stekiel69c46792022-06-10 12:59:51 +02005054#if defined(BUILTIN_ALG_ANY_HKDF) || \
John Durkop07cc04a2020-11-16 22:08:34 -08005055 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005056 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) || \
Kusumit Ghoderaoaf0b5342023-05-03 11:58:46 +05305057 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS) || \
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305058 defined(PSA_HAVE_SOFT_PBKDF2)
John Durkop07cc04a2020-11-16 22:08:34 -08005059#define AT_LEAST_ONE_BUILTIN_KDF
Steven Cooreman094a77e2021-05-06 17:58:36 +02005060#endif /* At least one builtin KDF */
5061
Przemek Stekiel69c46792022-06-10 12:59:51 +02005062#if defined(BUILTIN_ALG_ANY_HKDF) || \
Steven Cooreman094a77e2021-05-06 17:58:36 +02005063 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5064 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
5065static psa_status_t psa_key_derivation_start_hmac(
5066 psa_mac_operation_t *operation,
5067 psa_algorithm_t hash_alg,
5068 const uint8_t *hmac_key,
Gilles Peskine449bd832023-01-11 14:50:10 +01005069 size_t hmac_key_length)
Steven Cooreman094a77e2021-05-06 17:58:36 +02005070{
5071 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5072 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01005073 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
5074 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(hmac_key_length));
5075 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_HASH);
Steven Cooreman094a77e2021-05-06 17:58:36 +02005076
Steven Cooreman72f736a2021-05-07 14:14:37 +02005077 operation->is_sign = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005078 operation->mac_size = PSA_HASH_LENGTH(hash_alg);
Steven Cooreman72f736a2021-05-07 14:14:37 +02005079
Gilles Peskine449bd832023-01-11 14:50:10 +01005080 status = psa_driver_wrapper_mac_sign_setup(operation,
5081 &attributes,
5082 hmac_key, hmac_key_length,
5083 PSA_ALG_HMAC(hash_alg));
Steven Cooreman094a77e2021-05-06 17:58:36 +02005084
Gilles Peskine449bd832023-01-11 14:50:10 +01005085 psa_reset_key_attributes(&attributes);
5086 return status;
Steven Cooreman094a77e2021-05-06 17:58:36 +02005087}
5088#endif /* KDF algorithms reliant on HMAC */
John Durkop07cc04a2020-11-16 22:08:34 -08005089
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005090#define HKDF_STATE_INIT 0 /* no input yet */
5091#define HKDF_STATE_STARTED 1 /* got salt */
5092#define HKDF_STATE_KEYED 2 /* got key */
5093#define HKDF_STATE_OUTPUT 3 /* output started */
5094
Gilles Peskinecbe66502019-05-16 16:59:18 +02005095static psa_algorithm_t psa_key_derivation_get_kdf_alg(
Gilles Peskine449bd832023-01-11 14:50:10 +01005096 const psa_key_derivation_operation_t *operation)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005097{
Gilles Peskine449bd832023-01-11 14:50:10 +01005098 if (PSA_ALG_IS_KEY_AGREEMENT(operation->alg)) {
5099 return PSA_ALG_KEY_AGREEMENT_GET_KDF(operation->alg);
5100 } else {
5101 return operation->alg;
5102 }
Gilles Peskine969c5d62019-01-16 15:53:06 +01005103}
5104
Gilles Peskine449bd832023-01-11 14:50:10 +01005105psa_status_t psa_key_derivation_abort(psa_key_derivation_operation_t *operation)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005106{
5107 psa_status_t status = PSA_SUCCESS;
Gilles Peskine449bd832023-01-11 14:50:10 +01005108 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
5109 if (kdf_alg == 0) {
Gilles Peskineeab56e42018-07-12 17:12:33 +02005110 /* The object has (apparently) been initialized but it is not
5111 * in use. It's ok to call abort on such an object, and there's
5112 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005113 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02005114#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01005115 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
5116 mbedtls_free(operation->ctx.hkdf.info);
5117 status = psa_mac_abort(&operation->ctx.hkdf.hmac);
5118 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02005119#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08005120#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5121 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005122 if (PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
5123 /* TLS-1.2 PSK-to-MS KDF uses the same core as TLS-1.2 PRF */
5124 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
5125 if (operation->ctx.tls12_prf.secret != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005126 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.secret,
Gilles Peskine449bd832023-01-11 14:50:10 +01005127 operation->ctx.tls12_prf.secret_length);
Steven Cooremana6df6042021-04-29 19:32:25 +02005128 }
5129
Gilles Peskine449bd832023-01-11 14:50:10 +01005130 if (operation->ctx.tls12_prf.seed != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005131 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.seed,
Gilles Peskine449bd832023-01-11 14:50:10 +01005132 operation->ctx.tls12_prf.seed_length);
Janos Follath6a1d2622019-06-11 10:37:28 +01005133 }
5134
Gilles Peskine449bd832023-01-11 14:50:10 +01005135 if (operation->ctx.tls12_prf.label != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005136 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.label,
Gilles Peskine449bd832023-01-11 14:50:10 +01005137 operation->ctx.tls12_prf.label_length);
Janos Follath6a1d2622019-06-11 10:37:28 +01005138 }
Przemek Stekiel6c764412022-11-22 14:05:12 +01005139#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005140 if (operation->ctx.tls12_prf.other_secret != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005141 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.other_secret,
Gilles Peskine449bd832023-01-11 14:50:10 +01005142 operation->ctx.tls12_prf.other_secret_length);
Przemek Stekiele3ee2212022-04-07 14:29:56 +02005143 }
Przemek Stekiel6c764412022-11-22 14:05:12 +01005144#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Steven Cooremana6df6042021-04-29 19:32:25 +02005145 status = PSA_SUCCESS;
Janos Follath6a1d2622019-06-11 10:37:28 +01005146
5147 /* We leave the fields Ai and output_block to be erased safely by the
5148 * mbedtls_platform_zeroize() in the end of this function. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005149 } else
John Durkop07cc04a2020-11-16 22:08:34 -08005150#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
5151 * defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005152#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005153 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
5154 mbedtls_platform_zeroize(operation->ctx.tls12_ecjpake_to_pms.data,
5155 sizeof(operation->ctx.tls12_ecjpake_to_pms.data));
5156 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005157#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS) */
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305158#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05305159 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305160 if (operation->ctx.pbkdf2.salt != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005161 mbedtls_zeroize_and_free(operation->ctx.pbkdf2.salt,
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305162 operation->ctx.pbkdf2.salt_length);
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305163 }
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305164
5165 status = PSA_SUCCESS;
5166 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305167#endif /* defined(PSA_HAVE_SOFT_PBKDF2) */
Gilles Peskineeab56e42018-07-12 17:12:33 +02005168 {
5169 status = PSA_ERROR_BAD_STATE;
5170 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005171 mbedtls_platform_zeroize(operation, sizeof(*operation));
5172 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005173}
5174
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005175psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskine449bd832023-01-11 14:50:10 +01005176 size_t *capacity)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005177{
Gilles Peskine449bd832023-01-11 14:50:10 +01005178 if (operation->alg == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005179 /* This is a blank key derivation operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005180 return PSA_ERROR_BAD_STATE;
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005181 }
5182
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005183 *capacity = operation->capacity;
Gilles Peskine449bd832023-01-11 14:50:10 +01005184 return PSA_SUCCESS;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005185}
5186
Gilles Peskine449bd832023-01-11 14:50:10 +01005187psa_status_t psa_key_derivation_set_capacity(psa_key_derivation_operation_t *operation,
5188 size_t capacity)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005189{
Gilles Peskine449bd832023-01-11 14:50:10 +01005190 if (operation->alg == 0) {
5191 return PSA_ERROR_BAD_STATE;
5192 }
5193 if (capacity > operation->capacity) {
5194 return PSA_ERROR_INVALID_ARGUMENT;
5195 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005196 operation->capacity = capacity;
Gilles Peskine449bd832023-01-11 14:50:10 +01005197 return PSA_SUCCESS;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005198}
5199
Przemek Stekiel69c46792022-06-10 12:59:51 +02005200#if defined(BUILTIN_ALG_ANY_HKDF)
Przemek Stekiel03d948c2022-05-19 11:45:20 +02005201/* Read some bytes from an HKDF-based operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005202static psa_status_t psa_key_derivation_hkdf_read(psa_hkdf_key_derivation_t *hkdf,
5203 psa_algorithm_t kdf_alg,
5204 uint8_t *output,
5205 size_t output_length)
Gilles Peskinebef7f142018-07-12 17:22:21 +02005206{
Gilles Peskine449bd832023-01-11 14:50:10 +01005207 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
5208 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Steven Cooremand1ed1d92021-04-29 19:11:25 +02005209 size_t hmac_output_length;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005210 psa_status_t status;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005211#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01005212 const uint8_t last_block = PSA_ALG_IS_HKDF_EXTRACT(kdf_alg) ? 0 : 0xff;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005213#else
5214 const uint8_t last_block = 0xff;
5215#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskinebef7f142018-07-12 17:22:21 +02005216
Gilles Peskine449bd832023-01-11 14:50:10 +01005217 if (hkdf->state < HKDF_STATE_KEYED ||
5218 (!hkdf->info_set
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005219#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01005220 && !PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005221#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01005222 )) {
5223 return PSA_ERROR_BAD_STATE;
5224 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005225 hkdf->state = HKDF_STATE_OUTPUT;
5226
Gilles Peskine449bd832023-01-11 14:50:10 +01005227 while (output_length != 0) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005228 /* Copy what remains of the current block */
5229 uint8_t n = hash_length - hkdf->offset_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005230 if (n > output_length) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005231 n = (uint8_t) output_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01005232 }
5233 memcpy(output, hkdf->output_block + hkdf->offset_in_block, n);
Gilles Peskinebef7f142018-07-12 17:22:21 +02005234 output += n;
5235 output_length -= n;
5236 hkdf->offset_in_block += n;
Gilles Peskine449bd832023-01-11 14:50:10 +01005237 if (output_length == 0) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005238 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01005239 }
Przemek Stekiel03d948c2022-05-19 11:45:20 +02005240 /* We can't be wanting more output after the last block, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005241 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005242 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02005243 * object was corrupted or if this function is called directly
5244 * inside the library. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005245 if (hkdf->block_number == last_block) {
5246 return PSA_ERROR_BAD_STATE;
5247 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02005248
5249 /* We need a new block */
5250 ++hkdf->block_number;
5251 hkdf->offset_in_block = 0;
Steven Cooremand1ed1d92021-04-29 19:11:25 +02005252
Gilles Peskine449bd832023-01-11 14:50:10 +01005253 status = psa_key_derivation_start_hmac(&hkdf->hmac,
5254 hash_alg,
5255 hkdf->prk,
5256 hash_length);
5257 if (status != PSA_SUCCESS) {
5258 return status;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005259 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005260
5261 if (hkdf->block_number != 1) {
5262 status = psa_mac_update(&hkdf->hmac,
5263 hkdf->output_block,
5264 hash_length);
5265 if (status != PSA_SUCCESS) {
5266 return status;
5267 }
5268 }
5269 status = psa_mac_update(&hkdf->hmac,
5270 hkdf->info,
5271 hkdf->info_length);
5272 if (status != PSA_SUCCESS) {
5273 return status;
5274 }
5275 status = psa_mac_update(&hkdf->hmac,
5276 &hkdf->block_number, 1);
5277 if (status != PSA_SUCCESS) {
5278 return status;
5279 }
5280 status = psa_mac_sign_finish(&hkdf->hmac,
5281 hkdf->output_block,
5282 sizeof(hkdf->output_block),
5283 &hmac_output_length);
5284 if (status != PSA_SUCCESS) {
5285 return status;
5286 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02005287 }
5288
Gilles Peskine449bd832023-01-11 14:50:10 +01005289 return PSA_SUCCESS;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005290}
Przemek Stekiel69c46792022-06-10 12:59:51 +02005291#endif /* BUILTIN_ALG_ANY_HKDF */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005292
John Durkop07cc04a2020-11-16 22:08:34 -08005293#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5294 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follath7742fee2019-06-17 12:58:10 +01005295static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
5296 psa_tls12_prf_key_derivation_t *tls12_prf,
Gilles Peskine449bd832023-01-11 14:50:10 +01005297 psa_algorithm_t alg)
Janos Follath7742fee2019-06-17 12:58:10 +01005298{
Gilles Peskine449bd832023-01-11 14:50:10 +01005299 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(alg);
5300 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Steven Cooremana6df6042021-04-29 19:32:25 +02005301 psa_mac_operation_t hmac = PSA_MAC_OPERATION_INIT;
5302 size_t hmac_output_length;
Janos Follathea29bfb2019-06-19 12:21:20 +01005303 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005304
Janos Follath7742fee2019-06-17 12:58:10 +01005305 /* We can't be wanting more output after block 0xff, otherwise
5306 * the capacity check in psa_key_derivation_output_bytes() would have
5307 * prevented this call. It could happen only if the operation
5308 * object was corrupted or if this function is called directly
5309 * inside the library. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005310 if (tls12_prf->block_number == 0xff) {
5311 return PSA_ERROR_CORRUPTION_DETECTED;
5312 }
Janos Follath7742fee2019-06-17 12:58:10 +01005313
5314 /* We need a new block */
5315 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01005316 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01005317
5318 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
5319 *
5320 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
5321 *
5322 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
5323 * HMAC_hash(secret, A(2) + seed) +
5324 * HMAC_hash(secret, A(3) + seed) + ...
5325 *
5326 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01005327 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01005328 *
Janos Follathea29bfb2019-06-19 12:21:20 +01005329 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01005330 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01005331 * is currently extracted as `output_block` and where i is
5332 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01005333 */
5334
Gilles Peskine449bd832023-01-11 14:50:10 +01005335 status = psa_key_derivation_start_hmac(&hmac,
5336 hash_alg,
5337 tls12_prf->secret,
5338 tls12_prf->secret_length);
5339 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005340 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005341 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005342
5343 /* Calculate A(i) where i = tls12_prf->block_number. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005344 if (tls12_prf->block_number == 1) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005345 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
5346 * the variable seed and in this instance means it in the context of the
5347 * P_hash function, where seed = label + seed.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01005348 status = psa_mac_update(&hmac,
5349 tls12_prf->label,
5350 tls12_prf->label_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 status = psa_mac_update(&hmac,
5355 tls12_prf->seed,
5356 tls12_prf->seed_length);
5357 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005358 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005359 }
5360 } else {
Janos Follathea29bfb2019-06-19 12:21:20 +01005361 /* A(i) = HMAC_hash(secret, A(i-1)) */
Gilles Peskine449bd832023-01-11 14:50:10 +01005362 status = psa_mac_update(&hmac, tls12_prf->Ai, hash_length);
5363 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005364 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005365 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005366 }
5367
Gilles Peskine449bd832023-01-11 14:50:10 +01005368 status = psa_mac_sign_finish(&hmac,
5369 tls12_prf->Ai, hash_length,
5370 &hmac_output_length);
5371 if (hmac_output_length != hash_length) {
Steven Cooremana6df6042021-04-29 19:32:25 +02005372 status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01005373 }
5374 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005375 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005376 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005377
5378 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
Gilles Peskine449bd832023-01-11 14:50:10 +01005379 status = psa_key_derivation_start_hmac(&hmac,
5380 hash_alg,
5381 tls12_prf->secret,
5382 tls12_prf->secret_length);
5383 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005384 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005385 }
5386 status = psa_mac_update(&hmac, tls12_prf->Ai, hash_length);
5387 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005388 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005389 }
5390 status = psa_mac_update(&hmac, tls12_prf->label, tls12_prf->label_length);
5391 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005392 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005393 }
5394 status = psa_mac_update(&hmac, tls12_prf->seed, tls12_prf->seed_length);
5395 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005396 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005397 }
5398 status = psa_mac_sign_finish(&hmac,
5399 tls12_prf->output_block, hash_length,
5400 &hmac_output_length);
5401 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005402 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005403 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005404
Janos Follath7742fee2019-06-17 12:58:10 +01005405
5406cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01005407 cleanup_status = psa_mac_abort(&hmac);
5408 if (status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005409 status = cleanup_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01005410 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005411
Gilles Peskine449bd832023-01-11 14:50:10 +01005412 return status;
Janos Follath7742fee2019-06-17 12:58:10 +01005413}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005414
Janos Follath844eb0e2019-06-19 12:10:49 +01005415static psa_status_t psa_key_derivation_tls12_prf_read(
5416 psa_tls12_prf_key_derivation_t *tls12_prf,
5417 psa_algorithm_t alg,
5418 uint8_t *output,
Gilles Peskine449bd832023-01-11 14:50:10 +01005419 size_t output_length)
Janos Follath844eb0e2019-06-19 12:10:49 +01005420{
Gilles Peskine449bd832023-01-11 14:50:10 +01005421 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH(alg);
5422 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Janos Follath844eb0e2019-06-19 12:10:49 +01005423 psa_status_t status;
5424 uint8_t offset, length;
5425
Gilles Peskine449bd832023-01-11 14:50:10 +01005426 switch (tls12_prf->state) {
Gilles Peskineb1edaec2021-06-11 22:41:46 +02005427 case PSA_TLS12_PRF_STATE_LABEL_SET:
5428 tls12_prf->state = PSA_TLS12_PRF_STATE_OUTPUT;
5429 break;
5430 case PSA_TLS12_PRF_STATE_OUTPUT:
5431 break;
5432 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005433 return PSA_ERROR_BAD_STATE;
Gilles Peskineb1edaec2021-06-11 22:41:46 +02005434 }
5435
Gilles Peskine449bd832023-01-11 14:50:10 +01005436 while (output_length != 0) {
Janos Follath844eb0e2019-06-19 12:10:49 +01005437 /* Check if we have fully processed the current block. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005438 if (tls12_prf->left_in_block == 0) {
5439 status = psa_key_derivation_tls12_prf_generate_next_block(tls12_prf,
5440 alg);
5441 if (status != PSA_SUCCESS) {
5442 return status;
5443 }
Janos Follath844eb0e2019-06-19 12:10:49 +01005444
5445 continue;
5446 }
5447
Gilles Peskine449bd832023-01-11 14:50:10 +01005448 if (tls12_prf->left_in_block > output_length) {
Janos Follath844eb0e2019-06-19 12:10:49 +01005449 length = (uint8_t) output_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01005450 } else {
Janos Follath844eb0e2019-06-19 12:10:49 +01005451 length = tls12_prf->left_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005452 }
Janos Follath844eb0e2019-06-19 12:10:49 +01005453
5454 offset = hash_length - tls12_prf->left_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005455 memcpy(output, tls12_prf->output_block + offset, length);
Janos Follath844eb0e2019-06-19 12:10:49 +01005456 output += length;
5457 output_length -= length;
5458 tls12_prf->left_in_block -= length;
5459 }
5460
Gilles Peskine449bd832023-01-11 14:50:10 +01005461 return PSA_SUCCESS;
Janos Follath844eb0e2019-06-19 12:10:49 +01005462}
John Durkop07cc04a2020-11-16 22:08:34 -08005463#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
5464 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskinebef7f142018-07-12 17:22:21 +02005465
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005466#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
5467static psa_status_t psa_key_derivation_tls12_ecjpake_to_pms_read(
5468 psa_tls12_ecjpake_to_pms_t *ecjpake,
5469 uint8_t *output,
Gilles Peskine449bd832023-01-11 14:50:10 +01005470 size_t output_length)
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005471{
5472 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Andrzej Kurek5603efd2022-09-26 10:49:16 -04005473 size_t output_size = 0;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005474
Gilles Peskine449bd832023-01-11 14:50:10 +01005475 if (output_length != 32) {
5476 return PSA_ERROR_INVALID_ARGUMENT;
5477 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005478
Gilles Peskine449bd832023-01-11 14:50:10 +01005479 status = psa_hash_compute(PSA_ALG_SHA_256, ecjpake->data,
5480 PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE, output, output_length,
5481 &output_size);
5482 if (status != PSA_SUCCESS) {
5483 return status;
5484 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005485
Gilles Peskine449bd832023-01-11 14:50:10 +01005486 if (output_size != output_length) {
5487 return PSA_ERROR_GENERIC_ERROR;
5488 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005489
Gilles Peskine449bd832023-01-11 14:50:10 +01005490 return PSA_SUCCESS;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005491}
5492#endif
5493
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305494#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305495static psa_status_t psa_key_derivation_pbkdf2_generate_block(
5496 psa_pbkdf2_key_derivation_t *pbkdf2,
5497 psa_algorithm_t prf_alg,
5498 uint8_t prf_output_length,
5499 psa_key_attributes_t *attributes)
5500{
5501 psa_status_t status;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305502 psa_mac_operation_t mac_operation = PSA_MAC_OPERATION_INIT;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305503 size_t mac_output_length;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305504 uint8_t U_i[PSA_MAC_MAX_SIZE];
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305505 uint8_t *U_accumulator = pbkdf2->output_block;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305506 uint64_t i;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305507 uint8_t block_counter[4];
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305508
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305509 mac_operation.is_sign = 1;
5510 mac_operation.mac_size = prf_output_length;
5511 MBEDTLS_PUT_UINT32_BE(pbkdf2->block_number, block_counter, 0);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305512
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305513 status = psa_driver_wrapper_mac_sign_setup(&mac_operation,
5514 attributes,
5515 pbkdf2->password,
5516 pbkdf2->password_length,
5517 prf_alg);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305518 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305519 goto cleanup;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305520 }
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305521 status = psa_mac_update(&mac_operation, pbkdf2->salt, pbkdf2->salt_length);
5522 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305523 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305524 }
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305525 status = psa_mac_update(&mac_operation, block_counter, sizeof(block_counter));
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305526 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305527 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305528 }
5529 status = psa_mac_sign_finish(&mac_operation, U_i, sizeof(U_i),
5530 &mac_output_length);
5531 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305532 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305533 }
5534
5535 if (mac_output_length != prf_output_length) {
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305536 status = PSA_ERROR_CORRUPTION_DETECTED;
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305537 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305538 }
5539
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305540 memcpy(U_accumulator, U_i, prf_output_length);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305541
5542 for (i = 1; i < pbkdf2->input_cost; i++) {
Kusumit Ghoderao4536bb62023-06-22 15:42:59 +05305543 /* We are passing prf_output_length as mac_size because the driver
5544 * function directly sets mac_output_length as mac_size upon success.
Kusumit Ghoderao5f3345a2023-07-27 21:21:38 +05305545 * See https://github.com/Mbed-TLS/mbedtls/issues/7801 */
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305546 status = psa_driver_wrapper_mac_compute(attributes,
5547 pbkdf2->password,
5548 pbkdf2->password_length,
5549 prf_alg, U_i, prf_output_length,
Kusumit Ghoderao4536bb62023-06-22 15:42:59 +05305550 U_i, prf_output_length,
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305551 &mac_output_length);
5552 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305553 goto cleanup;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305554 }
5555
Kusumit Ghoderao109ee3d2023-06-08 16:36:45 +05305556 mbedtls_xor(U_accumulator, U_accumulator, U_i, prf_output_length);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305557 }
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305558
5559cleanup:
5560 /* Zeroise buffers to clear sensitive data from memory. */
5561 mbedtls_platform_zeroize(U_i, PSA_MAC_MAX_SIZE);
5562 return status;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305563}
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05305564
5565static psa_status_t psa_key_derivation_pbkdf2_read(
5566 psa_pbkdf2_key_derivation_t *pbkdf2,
5567 psa_algorithm_t kdf_alg,
5568 uint8_t *output,
5569 size_t output_length)
5570{
5571 psa_status_t status;
5572 psa_algorithm_t prf_alg;
5573 uint8_t prf_output_length;
5574 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
5575 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(pbkdf2->password_length));
5576 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
5577
5578 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
5579 prf_alg = PSA_ALG_HMAC(PSA_ALG_PBKDF2_HMAC_GET_HASH(kdf_alg));
5580 prf_output_length = PSA_HASH_LENGTH(prf_alg);
5581 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
Kusumit Ghoderaoa2520a52023-06-22 15:42:19 +05305582 } else if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
5583 prf_alg = PSA_ALG_CMAC;
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05305584 prf_output_length = PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC);
Kusumit Ghoderaoa2520a52023-06-22 15:42:19 +05305585 psa_set_key_type(&attributes, PSA_KEY_TYPE_AES);
Kusumit Ghoderaod9ec1af2023-06-08 20:19:51 +05305586 } else {
5587 return PSA_ERROR_INVALID_ARGUMENT;
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05305588 }
5589
5590 switch (pbkdf2->state) {
5591 case PSA_PBKDF2_STATE_PASSWORD_SET:
5592 /* Initially we need a new block so bytes_used is equal to block size*/
5593 pbkdf2->bytes_used = prf_output_length;
5594 pbkdf2->state = PSA_PBKDF2_STATE_OUTPUT;
5595 break;
5596 case PSA_PBKDF2_STATE_OUTPUT:
5597 break;
5598 default:
5599 return PSA_ERROR_BAD_STATE;
5600 }
5601
5602 while (output_length != 0) {
5603 uint8_t n = prf_output_length - pbkdf2->bytes_used;
5604 if (n > output_length) {
5605 n = (uint8_t) output_length;
5606 }
5607 memcpy(output, pbkdf2->output_block + pbkdf2->bytes_used, n);
5608 output += n;
5609 output_length -= n;
5610 pbkdf2->bytes_used += n;
5611
5612 if (output_length == 0) {
5613 break;
5614 }
5615
5616 /* We need a new block */
5617 pbkdf2->bytes_used = 0;
5618 pbkdf2->block_number++;
5619
5620 status = psa_key_derivation_pbkdf2_generate_block(pbkdf2, prf_alg,
5621 prf_output_length,
5622 &attributes);
5623 if (status != PSA_SUCCESS) {
5624 return status;
5625 }
5626 }
5627
5628 return PSA_SUCCESS;
5629}
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305630#endif /* PSA_HAVE_SOFT_PBKDF2 */
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305631
Janos Follath6c6c8fc2019-06-17 12:38:20 +01005632psa_status_t psa_key_derivation_output_bytes(
5633 psa_key_derivation_operation_t *operation,
5634 uint8_t *output,
Gilles Peskine449bd832023-01-11 14:50:10 +01005635 size_t output_length)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005636{
5637 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01005638 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
Gilles Peskineeab56e42018-07-12 17:12:33 +02005639
Gilles Peskine449bd832023-01-11 14:50:10 +01005640 if (operation->alg == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005641 /* This is a blank operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005642 return PSA_ERROR_BAD_STATE;
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005643 }
5644
Gilles Peskine449bd832023-01-11 14:50:10 +01005645 if (output_length > operation->capacity) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005646 operation->capacity = 0;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005647 /* Go through the error path to wipe all confidential data now
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005648 * that the operation object is useless. */
David Saadab4ecc272019-02-14 13:48:10 +02005649 status = PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005650 goto exit;
5651 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005652 if (output_length == 0 && operation->capacity == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005653 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005654 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02005655 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
5656 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005657 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02005658 * output_length > 0. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005659 return PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005660 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005661 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005662
Przemek Stekiel69c46792022-06-10 12:59:51 +02005663#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01005664 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
5665 status = psa_key_derivation_hkdf_read(&operation->ctx.hkdf, kdf_alg,
5666 output, output_length);
5667 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02005668#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08005669#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5670 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005671 if (PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
5672 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
5673 status = psa_key_derivation_tls12_prf_read(&operation->ctx.tls12_prf,
5674 kdf_alg, output,
5675 output_length);
5676 } else
John Durkop07cc04a2020-11-16 22:08:34 -08005677#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
5678 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005679#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005680 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005681 status = psa_key_derivation_tls12_ecjpake_to_pms_read(
Gilles Peskine449bd832023-01-11 14:50:10 +01005682 &operation->ctx.tls12_ecjpake_to_pms, output, output_length);
5683 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005684#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305685#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05305686 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05305687 status = psa_key_derivation_pbkdf2_read(&operation->ctx.pbkdf2, kdf_alg,
5688 output, output_length);
Kusumit Ghoderao056f0c52023-05-03 15:58:34 +05305689 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305690#endif /* PSA_HAVE_SOFT_PBKDF2 */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005691
Gilles Peskineeab56e42018-07-12 17:12:33 +02005692 {
Steven Cooreman74afe472021-02-10 17:19:22 +01005693 (void) kdf_alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01005694 return PSA_ERROR_BAD_STATE;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005695 }
5696
5697exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005698 if (status != PSA_SUCCESS) {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005699 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005700 * This allows us to differentiate between exhausted operations and
5701 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
5702 * operations. */
5703 psa_algorithm_t alg = operation->alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01005704 psa_key_derivation_abort(operation);
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005705 operation->alg = alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01005706 memset(output, '!', output_length);
Gilles Peskineeab56e42018-07-12 17:12:33 +02005707 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005708 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005709}
5710
David Brown7807bf72021-02-09 16:28:23 -07005711#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01005712static void psa_des_set_key_parity(uint8_t *data, size_t data_size)
Gilles Peskine08542d82018-07-19 17:05:42 +02005713{
Gilles Peskine449bd832023-01-11 14:50:10 +01005714 if (data_size >= 8) {
5715 mbedtls_des_key_set_parity(data);
5716 }
5717 if (data_size >= 16) {
5718 mbedtls_des_key_set_parity(data + 8);
5719 }
5720 if (data_size >= 24) {
5721 mbedtls_des_key_set_parity(data + 16);
5722 }
Gilles Peskine08542d82018-07-19 17:05:42 +02005723}
David Brown7807bf72021-02-09 16:28:23 -07005724#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine08542d82018-07-19 17:05:42 +02005725
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005726/*
Gilles Peskine449bd832023-01-11 14:50:10 +01005727 * ECC keys on a Weierstrass elliptic curve require the generation
5728 * of a private key which is an integer
5729 * in the range [1, N - 1], where N is the boundary of the private key domain:
5730 * N is the prime p for Diffie-Hellman, or the order of the
5731 * curve’s base point for ECC.
5732 *
5733 * Let m be the bit size of N, such that 2^m > N >= 2^(m-1).
5734 * This function generates the private key using the following process:
5735 *
5736 * 1. Draw a byte string of length ceiling(m/8) bytes.
5737 * 2. If m is not a multiple of 8, set the most significant
5738 * (8 * ceiling(m/8) - m) bits of the first byte in the string to zero.
5739 * 3. Convert the string to integer k by decoding it as a big-endian byte string.
5740 * 4. If k > N - 2, discard the result and return to step 1.
5741 * 5. Output k + 1 as the private key.
5742 *
5743 * This method allows compliance to NIST standards, specifically the methods titled
5744 * Key-Pair Generation by Testing Candidates in the following publications:
5745 * - NIST Special Publication 800-56A: Recommendation for Pair-Wise Key-Establishment
5746 * Schemes Using Discrete Logarithm Cryptography [SP800-56A] §5.6.1.1.4 for
5747 * Diffie-Hellman keys.
5748 *
5749 * - [SP800-56A] §5.6.1.2.2 or FIPS Publication 186-4: Digital Signature
5750 * Standard (DSS) [FIPS186-4] §B.4.2 for elliptic curve keys.
5751 *
5752 * Note: Function allocates memory for *data buffer, so given *data should be
5753 * always NULL.
5754 */
Valerio Setti86587ab2023-06-27 13:09:30 +02005755#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE)
5756#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE)
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01005757static psa_status_t psa_generate_derived_ecc_key_weierstrass_helper(
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005758 psa_key_slot_t *slot,
5759 size_t bits,
5760 psa_key_derivation_operation_t *operation,
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005761 uint8_t **data
5762 )
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005763{
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005764 unsigned key_out_of_range = 1;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005765 mbedtls_mpi k;
5766 mbedtls_mpi diff_N_2;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005767 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Przemek Stekiela81aed22022-03-01 15:13:30 +01005768 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01005769 size_t m;
5770 size_t m_bytes;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005771
Gilles Peskine449bd832023-01-11 14:50:10 +01005772 mbedtls_mpi_init(&k);
5773 mbedtls_mpi_init(&diff_N_2);
Przemyslaw Stekiel1dfd1222021-11-18 13:35:00 +01005774
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005775 psa_ecc_family_t curve = PSA_KEY_TYPE_ECC_GET_FAMILY(
Gilles Peskine449bd832023-01-11 14:50:10 +01005776 slot->attr.type);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005777 mbedtls_ecp_group_id grp_id =
Valerio Settid36c3132023-12-21 14:03:51 +01005778 mbedtls_ecc_group_from_psa(curve, bits);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005779
Gilles Peskine449bd832023-01-11 14:50:10 +01005780 if (grp_id == MBEDTLS_ECP_DP_NONE) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005781 ret = MBEDTLS_ERR_ASN1_INVALID_DATA;
Przemyslaw Stekiel871a3362021-12-02 08:46:39 +01005782 goto cleanup;
5783 }
5784
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005785 mbedtls_ecp_group ecp_group;
Gilles Peskine449bd832023-01-11 14:50:10 +01005786 mbedtls_ecp_group_init(&ecp_group);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005787
Gilles Peskine449bd832023-01-11 14:50:10 +01005788 MBEDTLS_MPI_CHK(mbedtls_ecp_group_load(&ecp_group, grp_id));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005789
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005790 /* N is the boundary of the private key domain (ecp_group.N). */
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005791 /* Let m be the bit size of N. */
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01005792 m = ecp_group.nbits;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005793
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01005794 m_bytes = PSA_BITS_TO_BYTES(m);
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005795
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005796 /* Calculate N - 2 - it will be needed later. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005797 MBEDTLS_MPI_CHK(mbedtls_mpi_sub_int(&diff_N_2, &ecp_group.N, 2));
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005798
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005799 /* Note: This function is always called with *data == NULL and it
5800 * allocates memory for the data buffer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005801 *data = mbedtls_calloc(1, m_bytes);
5802 if (*data == NULL) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005803 ret = MBEDTLS_ERR_ASN1_ALLOC_FAILED;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005804 goto cleanup;
5805 }
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005806
Gilles Peskine449bd832023-01-11 14:50:10 +01005807 while (key_out_of_range) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005808 /* 1. Draw a byte string of length ceiling(m/8) bytes. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005809 if ((status = psa_key_derivation_output_bytes(operation, *data, m_bytes)) != 0) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005810 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005811 }
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005812
5813 /* 2. If m is not a multiple of 8 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005814 if (m % 8 != 0) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005815 /* Set the most significant
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005816 * (8 * ceiling(m/8) - m) bits of the first byte in
5817 * the string to zero.
5818 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005819 uint8_t clear_bit_mask = (1 << (m % 8)) - 1;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005820 (*data)[0] &= clear_bit_mask;
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005821 }
5822
5823 /* 3. Convert the string to integer k by decoding it as a
Gilles Peskine449bd832023-01-11 14:50:10 +01005824 * big-endian byte string.
5825 */
5826 MBEDTLS_MPI_CHK(mbedtls_mpi_read_binary(&k, *data, m_bytes));
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005827
5828 /* 4. If k > N - 2, discard the result and return to step 1.
Gilles Peskine449bd832023-01-11 14:50:10 +01005829 * Result of comparison is returned. When it indicates error
5830 * then this function is called again.
5831 */
5832 MBEDTLS_MPI_CHK(mbedtls_mpi_lt_mpi_ct(&diff_N_2, &k, &key_out_of_range));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005833 }
5834
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005835 /* 5. Output k + 1 as the private key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005836 MBEDTLS_MPI_CHK(mbedtls_mpi_add_int(&k, &k, 1));
5837 MBEDTLS_MPI_CHK(mbedtls_mpi_write_binary(&k, *data, m_bytes));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005838cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01005839 if (ret != 0) {
5840 status = mbedtls_to_psa_error(ret);
5841 }
5842 if (status != PSA_SUCCESS) {
5843 mbedtls_free(*data);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005844 *data = NULL;
5845 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005846 mbedtls_mpi_free(&k);
5847 mbedtls_mpi_free(&diff_N_2);
5848 return status;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005849}
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005850
5851/* ECC keys on a Montgomery elliptic curve draws a byte string whose length
5852 * is determined by the curve, and sets the mandatory bits accordingly. That is:
5853 *
5854 * - Curve25519 (PSA_ECC_FAMILY_MONTGOMERY, 255 bits):
5855 * draw a 32-byte string and process it as specified in
5856 * Elliptic Curves for Security [RFC7748] §5.
5857 *
5858 * - Curve448 (PSA_ECC_FAMILY_MONTGOMERY, 448 bits):
5859 * draw a 56-byte string and process it as specified in [RFC7748] §5.
5860 *
5861 * Note: Function allocates memory for *data buffer, so given *data should be
5862 * always NULL.
5863 */
5864
5865static psa_status_t psa_generate_derived_ecc_key_montgomery_helper(
5866 size_t bits,
5867 psa_key_derivation_operation_t *operation,
5868 uint8_t **data
5869 )
5870{
5871 size_t output_length;
Przemek Stekiela81aed22022-03-01 15:13:30 +01005872 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005873
Gilles Peskine449bd832023-01-11 14:50:10 +01005874 switch (bits) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005875 case 255:
5876 output_length = 32;
5877 break;
5878 case 448:
5879 output_length = 56;
5880 break;
5881 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005882 return PSA_ERROR_INVALID_ARGUMENT;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005883 break;
5884 }
5885
Gilles Peskine449bd832023-01-11 14:50:10 +01005886 *data = mbedtls_calloc(1, output_length);
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005887
Gilles Peskine449bd832023-01-11 14:50:10 +01005888 if (*data == NULL) {
5889 return PSA_ERROR_INSUFFICIENT_MEMORY;
5890 }
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005891
Gilles Peskine449bd832023-01-11 14:50:10 +01005892 status = psa_key_derivation_output_bytes(operation, *data, output_length);
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005893
Gilles Peskine449bd832023-01-11 14:50:10 +01005894 if (status != PSA_SUCCESS) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005895 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01005896 }
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005897
Gilles Peskine449bd832023-01-11 14:50:10 +01005898 switch (bits) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005899 case 255:
5900 (*data)[0] &= 248;
5901 (*data)[31] &= 127;
5902 (*data)[31] |= 64;
5903 break;
5904 case 448:
5905 (*data)[0] &= 252;
5906 (*data)[55] |= 128;
5907 break;
5908 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005909 return PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005910 break;
5911 }
5912
5913 return status;
5914}
Valerio Setti86587ab2023-06-27 13:09:30 +02005915#else /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE */
5916static psa_status_t psa_generate_derived_ecc_key_weierstrass_helper(
5917 psa_key_slot_t *slot, size_t bits,
5918 psa_key_derivation_operation_t *operation, uint8_t **data)
5919{
5920 (void) slot;
5921 (void) bits;
5922 (void) operation;
5923 (void) data;
5924 return PSA_ERROR_NOT_SUPPORTED;
5925}
5926
5927static psa_status_t psa_generate_derived_ecc_key_montgomery_helper(
5928 size_t bits, psa_key_derivation_operation_t *operation, uint8_t **data)
5929{
5930 (void) bits;
5931 (void) operation;
5932 (void) data;
5933 return PSA_ERROR_NOT_SUPPORTED;
5934}
5935#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE */
5936#endif /* PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE */
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005937
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01005938static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005939 psa_key_slot_t *slot,
5940 size_t bits,
Gilles Peskine449bd832023-01-11 14:50:10 +01005941 psa_key_derivation_operation_t *operation)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005942{
5943 uint8_t *data = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01005944 size_t bytes = PSA_BITS_TO_BYTES(bits);
Archanad8a83dc2021-06-14 10:04:16 +05305945 size_t storage_size = bytes;
Przemek Stekiela81aed22022-03-01 15:13:30 +01005946 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01005947 psa_key_attributes_t attributes;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005948
Gilles Peskine449bd832023-01-11 14:50:10 +01005949 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(slot->attr.type)) {
5950 return PSA_ERROR_INVALID_ARGUMENT;
5951 }
Gilles Peskineeab56e42018-07-12 17:12:33 +02005952
Valerio Setti8ffdb5d2023-06-20 13:14:08 +02005953#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE) || \
Valerio Settidd24f292023-06-26 12:21:17 +02005954 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE)
Gilles Peskine449bd832023-01-11 14:50:10 +01005955 if (PSA_KEY_TYPE_IS_ECC(slot->attr.type)) {
5956 psa_ecc_family_t curve = PSA_KEY_TYPE_ECC_GET_FAMILY(slot->attr.type);
5957 if (PSA_ECC_FAMILY_IS_WEIERSTRASS(curve)) {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01005958 /* Weierstrass elliptic curve */
Gilles Peskine449bd832023-01-11 14:50:10 +01005959 status = psa_generate_derived_ecc_key_weierstrass_helper(slot, bits, operation, &data);
5960 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005961 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005962 }
5963 } else {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01005964 /* Montgomery elliptic curve */
Gilles Peskine449bd832023-01-11 14:50:10 +01005965 status = psa_generate_derived_ecc_key_montgomery_helper(bits, operation, &data);
5966 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01005967 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005968 }
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01005969 }
Przemyslaw Stekiel1dfd1222021-11-18 13:35:00 +01005970 } else
Valerio Setti8ffdb5d2023-06-20 13:14:08 +02005971#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE) ||
Valerio Settidd24f292023-06-26 12:21:17 +02005972 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE) */
Gilles Peskine449bd832023-01-11 14:50:10 +01005973 if (key_type_is_raw_bytes(slot->attr.type)) {
5974 if (bits % 8 != 0) {
5975 return PSA_ERROR_INVALID_ARGUMENT;
5976 }
5977 data = mbedtls_calloc(1, bytes);
5978 if (data == NULL) {
5979 return PSA_ERROR_INSUFFICIENT_MEMORY;
5980 }
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01005981
Gilles Peskine449bd832023-01-11 14:50:10 +01005982 status = psa_key_derivation_output_bytes(operation, data, bytes);
5983 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01005984 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005985 }
David Brown12ca5032021-02-11 11:02:00 -07005986#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01005987 if (slot->attr.type == PSA_KEY_TYPE_DES) {
5988 psa_des_set_key_parity(data, bytes);
5989 }
Przemek Stekielf110dc02022-03-01 14:48:05 +01005990#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES) */
Gilles Peskine449bd832023-01-11 14:50:10 +01005991 } else {
5992 return PSA_ERROR_NOT_SUPPORTED;
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01005993 }
Ronald Crondd04d422020-11-28 15:14:42 +01005994
Ronald Cronbf33c932020-11-28 18:06:53 +01005995 slot->attr.bits = (psa_key_bits_t) bits;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01005996 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01005997 .core = slot->attr
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01005998 };
5999
Gilles Peskine449bd832023-01-11 14:50:10 +01006000 if (psa_key_lifetime_is_external(attributes.core.lifetime)) {
6001 status = psa_driver_wrapper_get_key_buffer_size(&attributes,
6002 &storage_size);
6003 if (status != PSA_SUCCESS) {
Archanad8a83dc2021-06-14 10:04:16 +05306004 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006005 }
Archanad8a83dc2021-06-14 10:04:16 +05306006 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006007 status = psa_allocate_buffer_to_slot(slot, storage_size);
6008 if (status != PSA_SUCCESS) {
Archanad8a83dc2021-06-14 10:04:16 +05306009 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006010 }
Archanad8a83dc2021-06-14 10:04:16 +05306011
Gilles Peskine449bd832023-01-11 14:50:10 +01006012 status = psa_driver_wrapper_import_key(&attributes,
6013 data, bytes,
6014 slot->key.data,
6015 slot->key.bytes,
6016 &slot->key.bytes, &bits);
6017 if (bits != slot->attr.bits) {
Ronald Cronbf33c932020-11-28 18:06:53 +01006018 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine449bd832023-01-11 14:50:10 +01006019 }
Gilles Peskineeab56e42018-07-12 17:12:33 +02006020
6021exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01006022 mbedtls_free(data);
6023 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02006024}
6025
Gilles Peskinef0765fa2024-02-12 16:46:16 +01006026static const psa_key_generation_method_t default_method = PSA_KEY_GENERATION_METHOD_INIT;
6027
6028static int psa_key_generation_method_is_default(
6029 const psa_key_generation_method_t *method,
6030 size_t method_length)
6031{
6032 if (method_length != sizeof(*method)) {
6033 return 0;
6034 }
6035 if (method->flags != 0) {
6036 return 0;
6037 }
6038 return 1;
6039}
6040
6041psa_status_t psa_key_derivation_output_key_ext(
6042 const psa_key_attributes_t *attributes,
6043 psa_key_derivation_operation_t *operation,
6044 const psa_key_generation_method_t *method,
6045 size_t method_length,
6046 mbedtls_svc_key_id_t *key)
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006047{
6048 psa_status_t status;
6049 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02006050 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine0f84d622019-09-12 19:03:13 +02006051
Ronald Cron81709fc2020-11-14 12:10:32 +01006052 *key = MBEDTLS_SVC_KEY_ID_INIT;
6053
Gilles Peskine0f84d622019-09-12 19:03:13 +02006054 /* Reject any attempt to create a zero-length key so that we don't
6055 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006056 if (psa_get_key_bits(attributes) == 0) {
6057 return PSA_ERROR_INVALID_ARGUMENT;
6058 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02006059
Gilles Peskinef0765fa2024-02-12 16:46:16 +01006060 if (method_length < sizeof(*method)) {
6061 return PSA_ERROR_INVALID_ARGUMENT;
6062 }
6063 if (!psa_key_generation_method_is_default(method, method_length)) {
6064 return PSA_ERROR_INVALID_ARGUMENT;
6065 }
6066
Gilles Peskine449bd832023-01-11 14:50:10 +01006067 if (operation->alg == PSA_ALG_NONE) {
6068 return PSA_ERROR_BAD_STATE;
6069 }
Dave Rodgmand69da6c2021-11-16 10:32:48 +00006070
Gilles Peskine449bd832023-01-11 14:50:10 +01006071 if (!operation->can_output_key) {
6072 return PSA_ERROR_NOT_PERMITTED;
6073 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02006074
Gilles Peskine449bd832023-01-11 14:50:10 +01006075 status = psa_start_key_creation(PSA_KEY_CREATION_DERIVE, attributes,
6076 &slot, &driver);
Gilles Peskinef4ee6622019-07-24 13:44:30 +02006077#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006078 if (driver != NULL) {
Gilles Peskinef4ee6622019-07-24 13:44:30 +02006079 /* Deriving a key in a secure element is not implemented yet. */
6080 status = PSA_ERROR_NOT_SUPPORTED;
6081 }
6082#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine449bd832023-01-11 14:50:10 +01006083 if (status == PSA_SUCCESS) {
6084 status = psa_generate_derived_key_internal(slot,
6085 attributes->core.bits,
6086 operation);
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006087 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006088 if (status == PSA_SUCCESS) {
6089 status = psa_finish_key_creation(slot, driver, key);
6090 }
6091 if (status != PSA_SUCCESS) {
6092 psa_fail_key_creation(slot, driver);
6093 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02006094
Gilles Peskine449bd832023-01-11 14:50:10 +01006095 return status;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006096}
6097
Gilles Peskinef0765fa2024-02-12 16:46:16 +01006098psa_status_t psa_key_derivation_output_key(
6099 const psa_key_attributes_t *attributes,
6100 psa_key_derivation_operation_t *operation,
6101 mbedtls_svc_key_id_t *key)
6102{
6103 return psa_key_derivation_output_key_ext(
6104 attributes, operation,
6105 &default_method, sizeof(default_method),
6106 key);
6107}
Gilles Peskineeab56e42018-07-12 17:12:33 +02006108
6109
6110/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02006111/* Key derivation */
6112/****************************************************************/
6113
Steven Cooreman932ffb72021-02-15 12:14:32 +01006114#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006115static int is_kdf_alg_supported(psa_algorithm_t kdf_alg)
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006116{
6117#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006118 if (PSA_ALG_IS_HKDF(kdf_alg)) {
6119 return 1;
6120 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006121#endif
Przemek Stekielb57a44b2022-06-06 08:33:45 +02006122#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006123 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6124 return 1;
6125 }
Przemek Stekielb57a44b2022-06-06 08:33:45 +02006126#endif
6127#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006128 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
6129 return 1;
6130 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006131#endif
6132#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006133 if (PSA_ALG_IS_TLS12_PRF(kdf_alg)) {
6134 return 1;
6135 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006136#endif
6137#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006138 if (PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
6139 return 1;
6140 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006141#endif
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006142#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006143 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
6144 return 1;
6145 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006146#endif
Kusumit Ghoderaod132cac2023-05-03 12:00:27 +05306147#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
6148 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
6149 return 1;
6150 }
6151#endif
Kusumit Ghoderao2cd64962023-06-22 15:38:57 +05306152#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128)
6153 if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
6154 return 1;
6155 }
6156#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006157 return 0;
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006158}
6159
Gilles Peskine449bd832023-01-11 14:50:10 +01006160static psa_status_t psa_hash_try_support(psa_algorithm_t alg)
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006161{
6162 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01006163 psa_status_t status = psa_hash_setup(&operation, alg);
6164 psa_hash_abort(&operation);
6165 return status;
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006166}
6167
Kusumit Ghoderao86e83dd2023-12-01 16:38:26 +05306168static psa_status_t psa_key_derivation_set_maximum_capacity(
6169 psa_key_derivation_operation_t *operation,
6170 psa_algorithm_t kdf_alg)
6171{
6172#if defined(PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS)
6173 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
6174 operation->capacity = PSA_HASH_LENGTH(PSA_ALG_SHA_256);
6175 return PSA_SUCCESS;
6176 }
6177#endif
6178#if defined(PSA_WANT_ALG_PBKDF2_AES_CMAC_PRF_128)
6179 if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
6180#if (SIZE_MAX > UINT32_MAX)
Kusumit Ghoderao7d4db632023-12-07 16:17:46 +05306181 operation->capacity = UINT32_MAX * (size_t) PSA_MAC_LENGTH(
Kusumit Ghoderaod3f70d32023-12-06 16:20:04 +05306182 PSA_KEY_TYPE_AES,
6183 128U,
6184 PSA_ALG_CMAC);
Kusumit Ghoderao86e83dd2023-12-01 16:38:26 +05306185#else
6186 operation->capacity = SIZE_MAX;
6187#endif
6188 return PSA_SUCCESS;
6189 }
6190#endif /* PSA_WANT_ALG_PBKDF2_AES_CMAC_PRF_128 */
6191
6192 /* After this point, if kdf_alg is not valid then value of hash_alg may be
6193 * invalid or meaningless but it does not affect this function */
6194 psa_algorithm_t hash_alg = PSA_ALG_GET_HASH(kdf_alg);
6195 size_t hash_size = PSA_HASH_LENGTH(hash_alg);
Kusumit Ghoderaod3f70d32023-12-06 16:20:04 +05306196 if (hash_size == 0) {
6197 return PSA_ERROR_NOT_SUPPORTED;
6198 }
Kusumit Ghoderao86e83dd2023-12-01 16:38:26 +05306199
6200 /* Make sure that hash_alg is a supported hash algorithm. Otherwise
6201 * we might fail later, which is somewhat unfriendly and potentially
6202 * risk-prone. */
6203 psa_status_t status = psa_hash_try_support(hash_alg);
6204 if (status != PSA_SUCCESS) {
6205 return status;
6206 }
6207
6208#if defined(PSA_WANT_ALG_HKDF)
6209 if (PSA_ALG_IS_HKDF(kdf_alg)) {
6210 operation->capacity = 255 * hash_size;
6211 } else
6212#endif
6213#if defined(PSA_WANT_ALG_HKDF_EXTRACT)
6214 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6215 operation->capacity = hash_size;
6216 } else
6217#endif
6218#if defined(PSA_WANT_ALG_HKDF_EXPAND)
6219 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
6220 operation->capacity = 255 * hash_size;
6221 } else
6222#endif
6223#if defined(PSA_WANT_ALG_TLS12_PRF)
6224 if (PSA_ALG_IS_TLS12_PRF(kdf_alg) &&
6225 (hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384)) {
6226 operation->capacity = SIZE_MAX;
6227 } else
6228#endif
6229#if defined(PSA_WANT_ALG_TLS12_PSK_TO_MS)
6230 if (PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg) &&
6231 (hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384)) {
6232 /* Master Secret is always 48 bytes
6233 * https://datatracker.ietf.org/doc/html/rfc5246.html#section-8.1 */
6234 operation->capacity = 48U;
6235 } else
6236#endif
6237#if defined(PSA_WANT_ALG_PBKDF2_HMAC)
6238 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
6239#if (SIZE_MAX > UINT32_MAX)
6240 operation->capacity = UINT32_MAX * hash_size;
6241#else
6242 operation->capacity = SIZE_MAX;
6243#endif
6244 } else
6245#endif /* PSA_WANT_ALG_PBKDF2_HMAC */
6246 {
Kusumit Ghoderaod3f70d32023-12-06 16:20:04 +05306247 (void) hash_size;
Kusumit Ghoderao86e83dd2023-12-01 16:38:26 +05306248 status = PSA_ERROR_NOT_SUPPORTED;
6249 }
6250 return status;
6251}
6252
Gilles Peskine969c5d62019-01-16 15:53:06 +01006253static psa_status_t psa_key_derivation_setup_kdf(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006254 psa_key_derivation_operation_t *operation,
Gilles Peskine449bd832023-01-11 14:50:10 +01006255 psa_algorithm_t kdf_alg)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006256{
Janos Follath5fe19732019-06-20 15:09:30 +01006257 /* Make sure that operation->ctx is properly zero-initialised. (Macro
6258 * initialisers for this union leave some bytes unspecified.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01006259 memset(&operation->ctx, 0, sizeof(operation->ctx));
Janos Follath5fe19732019-06-20 15:09:30 +01006260
Gilles Peskine969c5d62019-01-16 15:53:06 +01006261 /* Make sure that kdf_alg is a supported key derivation algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006262 if (!is_kdf_alg_supported(kdf_alg)) {
6263 return PSA_ERROR_NOT_SUPPORTED;
6264 }
John Durkop07cc04a2020-11-16 22:08:34 -08006265
Kusumit Ghoderao86e83dd2023-12-01 16:38:26 +05306266 psa_status_t status = psa_key_derivation_set_maximum_capacity(operation,
6267 kdf_alg);
Kusumit Ghoderao5f3a9382023-09-13 16:28:12 +05306268 return status;
Gilles Peskine969c5d62019-01-16 15:53:06 +01006269}
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006270
Gilles Peskine449bd832023-01-11 14:50:10 +01006271static psa_status_t psa_key_agreement_try_support(psa_algorithm_t alg)
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006272{
6273#if defined(PSA_WANT_ALG_ECDH)
Gilles Peskine449bd832023-01-11 14:50:10 +01006274 if (alg == PSA_ALG_ECDH) {
6275 return PSA_SUCCESS;
6276 }
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006277#endif
Przemek Stekielfb3dd542022-12-01 14:59:15 +01006278#if defined(PSA_WANT_ALG_FFDH)
6279 if (alg == PSA_ALG_FFDH) {
6280 return PSA_SUCCESS;
6281 }
6282#endif
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006283 (void) alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01006284 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006285}
Gilles Peskinebb3814c2022-12-16 01:12:12 +01006286
6287static int psa_key_derivation_allows_free_form_secret_input(
6288 psa_algorithm_t kdf_alg)
6289{
6290#if defined(PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS)
6291 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
6292 return 0;
6293 }
6294#endif
6295 (void) kdf_alg;
6296 return 1;
6297}
John Durkop07cc04a2020-11-16 22:08:34 -08006298#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01006299
Gilles Peskine449bd832023-01-11 14:50:10 +01006300psa_status_t psa_key_derivation_setup(psa_key_derivation_operation_t *operation,
6301 psa_algorithm_t alg)
Gilles Peskine969c5d62019-01-16 15:53:06 +01006302{
6303 psa_status_t status;
6304
Gilles Peskine449bd832023-01-11 14:50:10 +01006305 if (operation->alg != 0) {
6306 return PSA_ERROR_BAD_STATE;
Gilles Peskine969c5d62019-01-16 15:53:06 +01006307 }
Gilles Peskine969c5d62019-01-16 15:53:06 +01006308
Gilles Peskine449bd832023-01-11 14:50:10 +01006309 if (PSA_ALG_IS_RAW_KEY_AGREEMENT(alg)) {
6310 return PSA_ERROR_INVALID_ARGUMENT;
6311 } else if (PSA_ALG_IS_KEY_AGREEMENT(alg)) {
6312#if defined(AT_LEAST_ONE_BUILTIN_KDF)
6313 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF(alg);
6314 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE(alg);
6315 status = psa_key_agreement_try_support(ka_alg);
6316 if (status != PSA_SUCCESS) {
6317 return status;
6318 }
Gilles Peskinebb3814c2022-12-16 01:12:12 +01006319 if (!psa_key_derivation_allows_free_form_secret_input(kdf_alg)) {
6320 return PSA_ERROR_INVALID_ARGUMENT;
6321 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006322 status = psa_key_derivation_setup_kdf(operation, kdf_alg);
6323#else
6324 return PSA_ERROR_NOT_SUPPORTED;
6325#endif /* AT_LEAST_ONE_BUILTIN_KDF */
6326 } else if (PSA_ALG_IS_KEY_DERIVATION(alg)) {
6327#if defined(AT_LEAST_ONE_BUILTIN_KDF)
6328 status = psa_key_derivation_setup_kdf(operation, alg);
6329#else
6330 return PSA_ERROR_NOT_SUPPORTED;
6331#endif /* AT_LEAST_ONE_BUILTIN_KDF */
6332 } else {
6333 return PSA_ERROR_INVALID_ARGUMENT;
6334 }
6335
6336 if (status == PSA_SUCCESS) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006337 operation->alg = alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01006338 }
6339 return status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006340}
6341
Przemek Stekiel69c46792022-06-10 12:59:51 +02006342#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006343static psa_status_t psa_hkdf_input(psa_hkdf_key_derivation_t *hkdf,
6344 psa_algorithm_t kdf_alg,
6345 psa_key_derivation_step_t step,
6346 const uint8_t *data,
6347 size_t data_length)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006348{
Gilles Peskine449bd832023-01-11 14:50:10 +01006349 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006350 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006351 switch (step) {
Gilles Peskine03410b52019-05-16 16:05:19 +02006352 case PSA_KEY_DERIVATION_INPUT_SALT:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006353#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006354 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
6355 return PSA_ERROR_INVALID_ARGUMENT;
6356 }
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006357#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND */
Gilles Peskine449bd832023-01-11 14:50:10 +01006358 if (hkdf->state != HKDF_STATE_INIT) {
6359 return PSA_ERROR_BAD_STATE;
6360 } else {
6361 status = psa_key_derivation_start_hmac(&hkdf->hmac,
6362 hash_alg,
6363 data, data_length);
6364 if (status != PSA_SUCCESS) {
6365 return status;
6366 }
Steven Cooremand1ed1d92021-04-29 19:11:25 +02006367 hkdf->state = HKDF_STATE_STARTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01006368 return PSA_SUCCESS;
Steven Cooremand1ed1d92021-04-29 19:11:25 +02006369 }
Gilles Peskine03410b52019-05-16 16:05:19 +02006370 case PSA_KEY_DERIVATION_INPUT_SECRET:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006371#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006372 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
Przemek Stekiel2fb0dcd2022-05-19 10:34:37 +02006373 /* We shouldn't be in different state as HKDF_EXPAND only allows
6374 * two inputs: SECRET (this case) and INFO which does not modify
6375 * the state. It could happen only if the hkdf
6376 * object was corrupted. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006377 if (hkdf->state != HKDF_STATE_INIT) {
6378 return PSA_ERROR_BAD_STATE;
6379 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006380
Przemek Stekiel2fb0dcd2022-05-19 10:34:37 +02006381 /* Allow only input that fits expected prk size */
Gilles Peskine449bd832023-01-11 14:50:10 +01006382 if (data_length != PSA_HASH_LENGTH(hash_alg)) {
6383 return PSA_ERROR_INVALID_ARGUMENT;
6384 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006385
Gilles Peskine449bd832023-01-11 14:50:10 +01006386 memcpy(hkdf->prk, data, data_length);
6387 } else
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006388#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND */
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006389 {
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006390 /* HKDF: If no salt was provided, use an empty salt.
6391 * HKDF-EXTRACT: salt is mandatory. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006392 if (hkdf->state == HKDF_STATE_INIT) {
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006393#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006394 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6395 return PSA_ERROR_BAD_STATE;
6396 }
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006397#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01006398 status = psa_key_derivation_start_hmac(&hkdf->hmac,
6399 hash_alg,
6400 NULL, 0);
6401 if (status != PSA_SUCCESS) {
6402 return status;
6403 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006404 hkdf->state = HKDF_STATE_STARTED;
6405 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006406 if (hkdf->state != HKDF_STATE_STARTED) {
6407 return PSA_ERROR_BAD_STATE;
6408 }
6409 status = psa_mac_update(&hkdf->hmac,
6410 data, data_length);
6411 if (status != PSA_SUCCESS) {
6412 return status;
6413 }
6414 status = psa_mac_sign_finish(&hkdf->hmac,
6415 hkdf->prk,
6416 sizeof(hkdf->prk),
6417 &data_length);
6418 if (status != PSA_SUCCESS) {
6419 return status;
6420 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006421 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006422
Gilles Peskine2b522db2019-04-12 15:11:49 +02006423 hkdf->state = HKDF_STATE_KEYED;
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006424 hkdf->block_number = 0;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006425#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006426 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006427 /* The only block of output is the PRK. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006428 memcpy(hkdf->output_block, hkdf->prk, PSA_HASH_LENGTH(hash_alg));
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006429 hkdf->offset_in_block = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01006430 } else
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006431#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006432 {
6433 /* Block 0 is empty, and the next block will be
6434 * generated by psa_key_derivation_hkdf_read(). */
Gilles Peskine449bd832023-01-11 14:50:10 +01006435 hkdf->offset_in_block = PSA_HASH_LENGTH(hash_alg);
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006436 }
6437
Gilles Peskine449bd832023-01-11 14:50:10 +01006438 return PSA_SUCCESS;
Gilles Peskine03410b52019-05-16 16:05:19 +02006439 case PSA_KEY_DERIVATION_INPUT_INFO:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006440#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006441 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6442 return PSA_ERROR_INVALID_ARGUMENT;
6443 }
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006444#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Przemek Stekielcde3f782022-06-03 16:12:27 +02006445#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006446 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg) &&
6447 hkdf->state == HKDF_STATE_INIT) {
6448 return PSA_ERROR_BAD_STATE;
6449 }
Przemek Stekielcde3f782022-06-03 16:12:27 +02006450#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01006451 if (hkdf->state == HKDF_STATE_OUTPUT) {
6452 return PSA_ERROR_BAD_STATE;
6453 }
6454 if (hkdf->info_set) {
6455 return PSA_ERROR_BAD_STATE;
6456 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006457 hkdf->info_length = data_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01006458 if (data_length != 0) {
6459 hkdf->info = mbedtls_calloc(1, data_length);
6460 if (hkdf->info == NULL) {
6461 return PSA_ERROR_INSUFFICIENT_MEMORY;
6462 }
6463 memcpy(hkdf->info, data, data_length);
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006464 }
6465 hkdf->info_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01006466 return PSA_SUCCESS;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006467 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006468 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006469 }
6470}
Przemek Stekiel69c46792022-06-10 12:59:51 +02006471#endif /* BUILTIN_ALG_ANY_HKDF */
Janos Follathb03233e2019-06-11 15:30:30 +01006472
John Durkop07cc04a2020-11-16 22:08:34 -08006473#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
6474 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006475static psa_status_t psa_tls12_prf_set_seed(psa_tls12_prf_key_derivation_t *prf,
6476 const uint8_t *data,
6477 size_t data_length)
Janos Follathf08e2652019-06-13 09:05:41 +01006478{
Gilles Peskine449bd832023-01-11 14:50:10 +01006479 if (prf->state != PSA_TLS12_PRF_STATE_INIT) {
6480 return PSA_ERROR_BAD_STATE;
6481 }
Janos Follathf08e2652019-06-13 09:05:41 +01006482
Gilles Peskine449bd832023-01-11 14:50:10 +01006483 if (data_length != 0) {
6484 prf->seed = mbedtls_calloc(1, data_length);
6485 if (prf->seed == NULL) {
6486 return PSA_ERROR_INSUFFICIENT_MEMORY;
6487 }
Janos Follathf08e2652019-06-13 09:05:41 +01006488
Gilles Peskine449bd832023-01-11 14:50:10 +01006489 memcpy(prf->seed, data, data_length);
Janos Follathd6dce9f2019-07-04 09:11:38 +01006490 prf->seed_length = data_length;
6491 }
Janos Follathf08e2652019-06-13 09:05:41 +01006492
Gilles Peskine43f958b2020-12-13 14:55:14 +01006493 prf->state = PSA_TLS12_PRF_STATE_SEED_SET;
Janos Follathf08e2652019-06-13 09:05:41 +01006494
Gilles Peskine449bd832023-01-11 14:50:10 +01006495 return PSA_SUCCESS;
Janos Follathf08e2652019-06-13 09:05:41 +01006496}
6497
Gilles Peskine449bd832023-01-11 14:50:10 +01006498static psa_status_t psa_tls12_prf_set_key(psa_tls12_prf_key_derivation_t *prf,
6499 const uint8_t *data,
6500 size_t data_length)
Janos Follath81550542019-06-13 14:26:34 +01006501{
Gilles Peskine449bd832023-01-11 14:50:10 +01006502 if (prf->state != PSA_TLS12_PRF_STATE_SEED_SET &&
6503 prf->state != PSA_TLS12_PRF_STATE_OTHER_KEY_SET) {
6504 return PSA_ERROR_BAD_STATE;
6505 }
Janos Follath81550542019-06-13 14:26:34 +01006506
Gilles Peskine449bd832023-01-11 14:50:10 +01006507 if (data_length != 0) {
6508 prf->secret = mbedtls_calloc(1, data_length);
6509 if (prf->secret == NULL) {
6510 return PSA_ERROR_INSUFFICIENT_MEMORY;
6511 }
Steven Cooremana6df6042021-04-29 19:32:25 +02006512
Gilles Peskine449bd832023-01-11 14:50:10 +01006513 memcpy(prf->secret, data, data_length);
Steven Cooremana6df6042021-04-29 19:32:25 +02006514 prf->secret_length = data_length;
6515 }
Janos Follath81550542019-06-13 14:26:34 +01006516
Gilles Peskine43f958b2020-12-13 14:55:14 +01006517 prf->state = PSA_TLS12_PRF_STATE_KEY_SET;
Janos Follath81550542019-06-13 14:26:34 +01006518
Gilles Peskine449bd832023-01-11 14:50:10 +01006519 return PSA_SUCCESS;
Janos Follath81550542019-06-13 14:26:34 +01006520}
6521
Gilles Peskine449bd832023-01-11 14:50:10 +01006522static psa_status_t psa_tls12_prf_set_label(psa_tls12_prf_key_derivation_t *prf,
6523 const uint8_t *data,
6524 size_t data_length)
Janos Follath63028dd2019-06-13 09:15:47 +01006525{
Gilles Peskine449bd832023-01-11 14:50:10 +01006526 if (prf->state != PSA_TLS12_PRF_STATE_KEY_SET) {
6527 return PSA_ERROR_BAD_STATE;
6528 }
Janos Follath63028dd2019-06-13 09:15:47 +01006529
Gilles Peskine449bd832023-01-11 14:50:10 +01006530 if (data_length != 0) {
6531 prf->label = mbedtls_calloc(1, data_length);
6532 if (prf->label == NULL) {
6533 return PSA_ERROR_INSUFFICIENT_MEMORY;
6534 }
Janos Follath63028dd2019-06-13 09:15:47 +01006535
Gilles Peskine449bd832023-01-11 14:50:10 +01006536 memcpy(prf->label, data, data_length);
Janos Follathd6dce9f2019-07-04 09:11:38 +01006537 prf->label_length = data_length;
6538 }
Janos Follath63028dd2019-06-13 09:15:47 +01006539
Gilles Peskine43f958b2020-12-13 14:55:14 +01006540 prf->state = PSA_TLS12_PRF_STATE_LABEL_SET;
Janos Follath63028dd2019-06-13 09:15:47 +01006541
Gilles Peskine449bd832023-01-11 14:50:10 +01006542 return PSA_SUCCESS;
Janos Follath63028dd2019-06-13 09:15:47 +01006543}
6544
Gilles Peskine449bd832023-01-11 14:50:10 +01006545static psa_status_t psa_tls12_prf_input(psa_tls12_prf_key_derivation_t *prf,
6546 psa_key_derivation_step_t step,
6547 const uint8_t *data,
6548 size_t data_length)
Janos Follathb03233e2019-06-11 15:30:30 +01006549{
Gilles Peskine449bd832023-01-11 14:50:10 +01006550 switch (step) {
Janos Follathf08e2652019-06-13 09:05:41 +01006551 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskine449bd832023-01-11 14:50:10 +01006552 return psa_tls12_prf_set_seed(prf, data, data_length);
Janos Follath81550542019-06-13 14:26:34 +01006553 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006554 return psa_tls12_prf_set_key(prf, data, data_length);
Janos Follath63028dd2019-06-13 09:15:47 +01006555 case PSA_KEY_DERIVATION_INPUT_LABEL:
Gilles Peskine449bd832023-01-11 14:50:10 +01006556 return psa_tls12_prf_set_label(prf, data, data_length);
Janos Follathb03233e2019-06-11 15:30:30 +01006557 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006558 return PSA_ERROR_INVALID_ARGUMENT;
Janos Follathb03233e2019-06-11 15:30:30 +01006559 }
6560}
John Durkop07cc04a2020-11-16 22:08:34 -08006561#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
6562 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
6563
6564#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
6565static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
6566 psa_tls12_prf_key_derivation_t *prf,
John Durkop07cc04a2020-11-16 22:08:34 -08006567 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006568 size_t data_length)
John Durkop07cc04a2020-11-16 22:08:34 -08006569{
6570 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006571 const size_t pms_len = (prf->state == PSA_TLS12_PRF_STATE_OTHER_KEY_SET ?
6572 4 + data_length + prf->other_secret_length :
6573 4 + 2 * data_length);
John Durkop07cc04a2020-11-16 22:08:34 -08006574
Gilles Peskine449bd832023-01-11 14:50:10 +01006575 if (data_length > PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE) {
6576 return PSA_ERROR_INVALID_ARGUMENT;
6577 }
John Durkop07cc04a2020-11-16 22:08:34 -08006578
Gilles Peskine449bd832023-01-11 14:50:10 +01006579 uint8_t *pms = mbedtls_calloc(1, pms_len);
6580 if (pms == NULL) {
6581 return PSA_ERROR_INSUFFICIENT_MEMORY;
6582 }
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02006583 uint8_t *cur = pms;
6584
6585 /* pure-PSK:
6586 * Quoting RFC 4279, Section 2:
John Durkop07cc04a2020-11-16 22:08:34 -08006587 *
6588 * The premaster secret is formed as follows: if the PSK is N octets
6589 * long, concatenate a uint16 with the value N, N zero octets, a second
6590 * uint16 with the value N, and the PSK itself.
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02006591 *
6592 * mixed-PSK:
6593 * In a DHE-PSK, RSA-PSK, ECDHE-PSK the premaster secret is formed as
6594 * follows: concatenate a uint16 with the length of the other secret,
6595 * the other secret itself, uint16 with the length of PSK, and the
6596 * PSK itself.
6597 * For details please check:
6598 * - RFC 4279, Section 4 for the definition of RSA-PSK,
6599 * - RFC 4279, Section 3 for the definition of DHE-PSK,
6600 * - RFC 5489 for the definition of ECDHE-PSK.
John Durkop07cc04a2020-11-16 22:08:34 -08006601 */
6602
Gilles Peskine449bd832023-01-11 14:50:10 +01006603 if (prf->state == PSA_TLS12_PRF_STATE_OTHER_KEY_SET) {
6604 *cur++ = MBEDTLS_BYTE_1(prf->other_secret_length);
6605 *cur++ = MBEDTLS_BYTE_0(prf->other_secret_length);
6606 if (prf->other_secret_length != 0) {
6607 memcpy(cur, prf->other_secret, prf->other_secret_length);
6608 mbedtls_platform_zeroize(prf->other_secret, prf->other_secret_length);
Przemek Stekiel2503f7e2022-04-12 12:08:01 +02006609 cur += prf->other_secret_length;
6610 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006611 } else {
6612 *cur++ = MBEDTLS_BYTE_1(data_length);
6613 *cur++ = MBEDTLS_BYTE_0(data_length);
6614 memset(cur, 0, data_length);
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02006615 cur += data_length;
6616 }
6617
Gilles Peskine449bd832023-01-11 14:50:10 +01006618 *cur++ = MBEDTLS_BYTE_1(data_length);
6619 *cur++ = MBEDTLS_BYTE_0(data_length);
6620 memcpy(cur, data, data_length);
John Durkop07cc04a2020-11-16 22:08:34 -08006621 cur += data_length;
6622
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00006623 status = psa_tls12_prf_set_key(prf, pms, (size_t) (cur - pms));
John Durkop07cc04a2020-11-16 22:08:34 -08006624
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01006625 mbedtls_zeroize_and_free(pms, pms_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01006626 return status;
John Durkop07cc04a2020-11-16 22:08:34 -08006627}
Janos Follath6660f0e2019-06-17 08:44:03 +01006628
Przemek Stekiele47201b2022-04-19 13:53:28 +02006629static psa_status_t psa_tls12_prf_psk_to_ms_set_other_key(
6630 psa_tls12_prf_key_derivation_t *prf,
6631 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006632 size_t data_length)
Przemek Stekiele47201b2022-04-19 13:53:28 +02006633{
Gilles Peskine449bd832023-01-11 14:50:10 +01006634 if (prf->state != PSA_TLS12_PRF_STATE_SEED_SET) {
6635 return PSA_ERROR_BAD_STATE;
Przemek Stekiele47201b2022-04-19 13:53:28 +02006636 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006637
6638 if (data_length != 0) {
6639 prf->other_secret = mbedtls_calloc(1, data_length);
6640 if (prf->other_secret == NULL) {
6641 return PSA_ERROR_INSUFFICIENT_MEMORY;
6642 }
6643
6644 memcpy(prf->other_secret, data, data_length);
6645 prf->other_secret_length = data_length;
6646 } else {
Przemek Stekiele47201b2022-04-19 13:53:28 +02006647 prf->other_secret_length = 0;
6648 }
6649
6650 prf->state = PSA_TLS12_PRF_STATE_OTHER_KEY_SET;
6651
Gilles Peskine449bd832023-01-11 14:50:10 +01006652 return PSA_SUCCESS;
Przemek Stekiele47201b2022-04-19 13:53:28 +02006653}
6654
Janos Follath6660f0e2019-06-17 08:44:03 +01006655static psa_status_t psa_tls12_prf_psk_to_ms_input(
6656 psa_tls12_prf_key_derivation_t *prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01006657 psa_key_derivation_step_t step,
6658 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006659 size_t data_length)
Janos Follath6660f0e2019-06-17 08:44:03 +01006660{
Gilles Peskine449bd832023-01-11 14:50:10 +01006661 switch (step) {
Przemek Stekiele47201b2022-04-19 13:53:28 +02006662 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006663 return psa_tls12_prf_psk_to_ms_set_key(prf,
6664 data, data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02006665 break;
6666 case PSA_KEY_DERIVATION_INPUT_OTHER_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006667 return psa_tls12_prf_psk_to_ms_set_other_key(prf,
6668 data,
6669 data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02006670 break;
6671 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006672 return psa_tls12_prf_input(prf, step, data, data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02006673 break;
Janos Follath6660f0e2019-06-17 08:44:03 +01006674
Przemek Stekiele47201b2022-04-19 13:53:28 +02006675 }
Janos Follath6660f0e2019-06-17 08:44:03 +01006676}
John Durkop07cc04a2020-11-16 22:08:34 -08006677#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006678
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006679#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
6680static psa_status_t psa_tls12_ecjpake_to_pms_input(
6681 psa_tls12_ecjpake_to_pms_t *ecjpake,
Andrzej Kurek702776f2022-09-16 06:22:44 -04006682 psa_key_derivation_step_t step,
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006683 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006684 size_t data_length)
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006685{
Gilles Peskine449bd832023-01-11 14:50:10 +01006686 if (data_length != PSA_TLS12_ECJPAKE_TO_PMS_INPUT_SIZE ||
6687 step != PSA_KEY_DERIVATION_INPUT_SECRET) {
6688 return PSA_ERROR_INVALID_ARGUMENT;
Andrzej Kurek5603efd2022-09-26 10:49:16 -04006689 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006690
6691 /* Check if the passed point is in an uncompressed form */
Gilles Peskine449bd832023-01-11 14:50:10 +01006692 if (data[0] != 0x04) {
6693 return PSA_ERROR_INVALID_ARGUMENT;
6694 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006695
6696 /* Only K.X has to be extracted - bytes 1 to 32 inclusive. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006697 memcpy(ecjpake->data, data + 1, PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE);
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006698
Gilles Peskine449bd832023-01-11 14:50:10 +01006699 return PSA_SUCCESS;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006700}
6701#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306702
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306703#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306704static psa_status_t psa_pbkdf2_set_input_cost(
6705 psa_pbkdf2_key_derivation_t *pbkdf2,
6706 psa_key_derivation_step_t step,
6707 uint64_t data)
6708{
6709 if (step != PSA_KEY_DERIVATION_INPUT_COST) {
6710 return PSA_ERROR_INVALID_ARGUMENT;
6711 }
6712
6713 if (pbkdf2->state != PSA_PBKDF2_STATE_INIT) {
6714 return PSA_ERROR_BAD_STATE;
6715 }
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05306716
Kusumit Ghoderaoe66a8ad2023-05-24 12:30:43 +05306717 if (data > PSA_VENDOR_PBKDF2_MAX_ITERATIONS) {
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05306718 return PSA_ERROR_NOT_SUPPORTED;
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306719 }
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05306720
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306721 if (data == 0) {
6722 return PSA_ERROR_INVALID_ARGUMENT;
6723 }
Kusumit Ghoderaoe66a8ad2023-05-24 12:30:43 +05306724
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306725 pbkdf2->input_cost = data;
6726 pbkdf2->state = PSA_PBKDF2_STATE_INPUT_COST_SET;
6727
6728 return PSA_SUCCESS;
6729}
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306730
6731static psa_status_t psa_pbkdf2_set_salt(psa_pbkdf2_key_derivation_t *pbkdf2,
6732 const uint8_t *data,
6733 size_t data_length)
6734{
Gilles Peskineead17662023-08-20 22:02:51 +02006735 if (pbkdf2->state == PSA_PBKDF2_STATE_INPUT_COST_SET) {
6736 pbkdf2->state = PSA_PBKDF2_STATE_SALT_SET;
6737 } else if (pbkdf2->state == PSA_PBKDF2_STATE_SALT_SET) {
6738 /* Appending to existing salt. No state change. */
6739 } else {
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306740 return PSA_ERROR_BAD_STATE;
6741 }
6742
Gilles Peskineca57d782023-07-20 19:08:06 +02006743 if (data_length == 0) {
Gilles Peskineead17662023-08-20 22:02:51 +02006744 /* Appending an empty string, nothing to do. */
6745 } else {
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306746 uint8_t *next_salt;
Kusumit Ghoderaob538bb72023-05-24 12:32:14 +05306747
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306748 next_salt = mbedtls_calloc(1, data_length + pbkdf2->salt_length);
6749 if (next_salt == NULL) {
Kusumit Ghoderaod0422f32023-05-08 15:56:19 +05306750 return PSA_ERROR_INSUFFICIENT_MEMORY;
6751 }
6752
Gilles Peskineead17662023-08-20 22:02:51 +02006753 if (pbkdf2->salt_length != 0) {
6754 memcpy(next_salt, pbkdf2->salt, pbkdf2->salt_length);
6755 }
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306756 memcpy(next_salt + pbkdf2->salt_length, data, data_length);
Kusumit Ghoderaod0422f32023-05-08 15:56:19 +05306757 pbkdf2->salt_length += data_length;
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306758 mbedtls_free(pbkdf2->salt);
6759 pbkdf2->salt = next_salt;
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306760 }
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306761 return PSA_SUCCESS;
6762}
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306763
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05306764#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306765static psa_status_t psa_pbkdf2_hmac_set_password(psa_algorithm_t hash_alg,
Kusumit Ghoderaoaac9a582023-05-24 14:19:17 +05306766 const uint8_t *input,
6767 size_t input_len,
6768 uint8_t *output,
Kusumit Ghoderao91f99f52023-05-24 22:21:48 +05306769 size_t *output_len)
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306770{
6771 psa_status_t status = PSA_SUCCESS;
6772 if (input_len > PSA_HASH_BLOCK_LENGTH(hash_alg)) {
6773 status = psa_hash_compute(hash_alg, input, input_len, output,
Kusumit Ghoderao91f99f52023-05-24 22:21:48 +05306774 PSA_HMAC_MAX_HASH_BLOCK_SIZE, output_len);
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306775 } else {
6776 memcpy(output, input, input_len);
Kusumit Ghoderao91f99f52023-05-24 22:21:48 +05306777 *output_len = PSA_HASH_BLOCK_LENGTH(hash_alg);
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306778 }
6779 return status;
6780}
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05306781#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC */
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306782
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05306783#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128)
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306784static psa_status_t psa_pbkdf2_cmac_set_password(const uint8_t *input,
6785 size_t input_len,
6786 uint8_t *output,
6787 size_t *output_len)
6788{
6789 psa_status_t status = PSA_SUCCESS;
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306790 if (input_len != PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC)) {
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306791 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Kusumit Ghoderao3fde8fe2023-06-27 10:41:43 +05306792 uint8_t zeros[16] = { 0 };
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306793 psa_set_key_type(&attributes, PSA_KEY_TYPE_AES);
6794 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(sizeof(zeros)));
6795 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306796 /* Passing PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC) as
Kusumit Ghoderao5f3345a2023-07-27 21:21:38 +05306797 * mac_size as the driver function sets mac_output_length = mac_size
6798 * on success. See https://github.com/Mbed-TLS/mbedtls/issues/7801 */
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306799 status = psa_driver_wrapper_mac_compute(&attributes,
6800 zeros, sizeof(zeros),
6801 PSA_ALG_CMAC, input, input_len,
6802 output,
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306803 PSA_MAC_LENGTH(PSA_KEY_TYPE_AES,
6804 128U,
6805 PSA_ALG_CMAC),
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306806 output_len);
6807 } else {
6808 memcpy(output, input, input_len);
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306809 *output_len = PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC);
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306810 }
6811 return status;
6812}
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05306813#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128 */
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306814
6815static psa_status_t psa_pbkdf2_set_password(psa_pbkdf2_key_derivation_t *pbkdf2,
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306816 psa_algorithm_t kdf_alg,
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306817 const uint8_t *data,
6818 size_t data_length)
6819{
Kusumit Ghoderaoaac9a582023-05-24 14:19:17 +05306820 psa_status_t status = PSA_SUCCESS;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306821 if (pbkdf2->state != PSA_PBKDF2_STATE_SALT_SET) {
6822 return PSA_ERROR_BAD_STATE;
6823 }
6824
Kusumit Ghoderaof3e696d2023-07-28 13:30:50 +05306825#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306826 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
6827 psa_algorithm_t hash_alg = PSA_ALG_PBKDF2_HMAC_GET_HASH(kdf_alg);
6828 status = psa_pbkdf2_hmac_set_password(hash_alg, data, data_length,
6829 pbkdf2->password,
6830 &pbkdf2->password_length);
Kusumit Ghoderaof3e696d2023-07-28 13:30:50 +05306831 } else
6832#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC */
6833#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128)
6834 if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306835 status = psa_pbkdf2_cmac_set_password(data, data_length,
6836 pbkdf2->password,
6837 &pbkdf2->password_length);
Kusumit Ghoderaof3e696d2023-07-28 13:30:50 +05306838 } else
6839#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128 */
6840 {
6841 return PSA_ERROR_INVALID_ARGUMENT;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306842 }
6843
6844 pbkdf2->state = PSA_PBKDF2_STATE_PASSWORD_SET;
6845
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306846 return status;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306847}
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05306848
6849static psa_status_t psa_pbkdf2_input(psa_pbkdf2_key_derivation_t *pbkdf2,
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306850 psa_algorithm_t kdf_alg,
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05306851 psa_key_derivation_step_t step,
6852 const uint8_t *data,
6853 size_t data_length)
6854{
6855 switch (step) {
6856 case PSA_KEY_DERIVATION_INPUT_SALT:
6857 return psa_pbkdf2_set_salt(pbkdf2, data, data_length);
6858 case PSA_KEY_DERIVATION_INPUT_PASSWORD:
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306859 return psa_pbkdf2_set_password(pbkdf2, kdf_alg, data, data_length);
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05306860 default:
6861 return PSA_ERROR_INVALID_ARGUMENT;
6862 }
6863}
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306864#endif /* PSA_HAVE_SOFT_PBKDF2 */
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306865
Gilles Peskineb8965192019-09-24 16:21:10 +02006866/** Check whether the given key type is acceptable for the given
6867 * input step of a key derivation.
6868 *
6869 * Secret inputs must have the type #PSA_KEY_TYPE_DERIVE.
6870 * Non-secret inputs must have the type #PSA_KEY_TYPE_RAW_DATA.
6871 * Both secret and non-secret inputs can alternatively have the type
6872 * #PSA_KEY_TYPE_NONE, which is never the type of a key object, meaning
6873 * that the input was passed as a buffer rather than via a key object.
6874 */
Gilles Peskine224b0d62019-09-23 18:13:17 +02006875static int psa_key_derivation_check_input_type(
6876 psa_key_derivation_step_t step,
Gilles Peskine449bd832023-01-11 14:50:10 +01006877 psa_key_type_t key_type)
Gilles Peskine224b0d62019-09-23 18:13:17 +02006878{
Gilles Peskine449bd832023-01-11 14:50:10 +01006879 switch (step) {
Gilles Peskine224b0d62019-09-23 18:13:17 +02006880 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006881 if (key_type == PSA_KEY_TYPE_DERIVE) {
6882 return PSA_SUCCESS;
6883 }
6884 if (key_type == PSA_KEY_TYPE_NONE) {
6885 return PSA_SUCCESS;
6886 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02006887 break;
Przemek Stekiela7695a22022-04-07 15:39:01 +02006888 case PSA_KEY_DERIVATION_INPUT_OTHER_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006889 if (key_type == PSA_KEY_TYPE_DERIVE) {
6890 return PSA_SUCCESS;
6891 }
6892 if (key_type == PSA_KEY_TYPE_NONE) {
6893 return PSA_SUCCESS;
6894 }
Przemek Stekiela7695a22022-04-07 15:39:01 +02006895 break;
Gilles Peskine224b0d62019-09-23 18:13:17 +02006896 case PSA_KEY_DERIVATION_INPUT_LABEL:
6897 case PSA_KEY_DERIVATION_INPUT_SALT:
6898 case PSA_KEY_DERIVATION_INPUT_INFO:
6899 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskine449bd832023-01-11 14:50:10 +01006900 if (key_type == PSA_KEY_TYPE_RAW_DATA) {
6901 return PSA_SUCCESS;
6902 }
6903 if (key_type == PSA_KEY_TYPE_NONE) {
6904 return PSA_SUCCESS;
6905 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02006906 break;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306907 case PSA_KEY_DERIVATION_INPUT_PASSWORD:
6908 if (key_type == PSA_KEY_TYPE_PASSWORD) {
6909 return PSA_SUCCESS;
6910 }
6911 if (key_type == PSA_KEY_TYPE_DERIVE) {
6912 return PSA_SUCCESS;
6913 }
6914 if (key_type == PSA_KEY_TYPE_NONE) {
6915 return PSA_SUCCESS;
6916 }
6917 break;
Gilles Peskine224b0d62019-09-23 18:13:17 +02006918 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006919 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine224b0d62019-09-23 18:13:17 +02006920}
6921
Janos Follathb80a94e2019-06-12 15:54:46 +01006922static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006923 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01006924 psa_key_derivation_step_t step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02006925 psa_key_type_t key_type,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01006926 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006927 size_t data_length)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006928{
Gilles Peskine46d7faf2019-09-23 19:22:55 +02006929 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006930 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
Gilles Peskine46d7faf2019-09-23 19:22:55 +02006931
Gilles Peskine449bd832023-01-11 14:50:10 +01006932 status = psa_key_derivation_check_input_type(step, key_type);
6933 if (status != PSA_SUCCESS) {
Gilles Peskine224b0d62019-09-23 18:13:17 +02006934 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006935 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02006936
Przemek Stekiel69c46792022-06-10 12:59:51 +02006937#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006938 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
6939 status = psa_hkdf_input(&operation->ctx.hkdf, kdf_alg,
6940 step, data, data_length);
6941 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02006942#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08006943#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006944 if (PSA_ALG_IS_TLS12_PRF(kdf_alg)) {
6945 status = psa_tls12_prf_input(&operation->ctx.tls12_prf,
6946 step, data, data_length);
6947 } else
John Durkop07cc04a2020-11-16 22:08:34 -08006948#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF */
6949#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006950 if (PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
6951 status = psa_tls12_prf_psk_to_ms_input(&operation->ctx.tls12_prf,
6952 step, data, data_length);
6953 } else
John Durkop07cc04a2020-11-16 22:08:34 -08006954#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006955#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006956 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006957 status = psa_tls12_ecjpake_to_pms_input(
Gilles Peskine449bd832023-01-11 14:50:10 +01006958 &operation->ctx.tls12_ecjpake_to_pms, step, data, data_length);
6959 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006960#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306961#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05306962 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306963 status = psa_pbkdf2_input(&operation->ctx.pbkdf2, kdf_alg,
6964 step, data, data_length);
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05306965 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306966#endif /* PSA_HAVE_SOFT_PBKDF2 */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006967 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006968 /* This can't happen unless the operation object was not initialized */
Steven Cooreman74afe472021-02-10 17:19:22 +01006969 (void) data;
6970 (void) data_length;
6971 (void) kdf_alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01006972 return PSA_ERROR_BAD_STATE;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006973 }
6974
Gilles Peskine224b0d62019-09-23 18:13:17 +02006975exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01006976 if (status != PSA_SUCCESS) {
6977 psa_key_derivation_abort(operation);
6978 }
6979 return status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006980}
6981
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05306982static psa_status_t psa_key_derivation_input_integer_internal(
6983 psa_key_derivation_operation_t *operation,
6984 psa_key_derivation_step_t step,
6985 uint64_t value)
6986{
6987 psa_status_t status;
6988 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
6989
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306990#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05306991 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306992 status = psa_pbkdf2_set_input_cost(
6993 &operation->ctx.pbkdf2, step, value);
6994 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306995#endif /* PSA_HAVE_SOFT_PBKDF2 */
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05306996 {
Kusumit Ghoderao3a18dee2023-04-07 16:16:27 +05306997 (void) step;
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05306998 (void) value;
6999 (void) kdf_alg;
Kusumit Ghoderaoa14ae5a2023-04-19 14:16:26 +05307000 status = PSA_ERROR_INVALID_ARGUMENT;
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05307001 }
7002
7003 if (status != PSA_SUCCESS) {
7004 psa_key_derivation_abort(operation);
7005 }
7006 return status;
7007}
7008
Janos Follath51f4a0f2019-06-14 11:35:55 +01007009psa_status_t psa_key_derivation_input_bytes(
7010 psa_key_derivation_operation_t *operation,
7011 psa_key_derivation_step_t step,
7012 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01007013 size_t data_length)
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01007014{
Gilles Peskine449bd832023-01-11 14:50:10 +01007015 return psa_key_derivation_input_internal(operation, step,
7016 PSA_KEY_TYPE_NONE,
7017 data, data_length);
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01007018}
7019
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05307020psa_status_t psa_key_derivation_input_integer(
7021 psa_key_derivation_operation_t *operation,
7022 psa_key_derivation_step_t step,
7023 uint64_t value)
7024{
7025 return psa_key_derivation_input_integer_internal(operation, step, value);
7026}
7027
Janos Follath51f4a0f2019-06-14 11:35:55 +01007028psa_status_t psa_key_derivation_input_key(
7029 psa_key_derivation_operation_t *operation,
7030 psa_key_derivation_step_t step,
Gilles Peskine449bd832023-01-11 14:50:10 +01007031 mbedtls_svc_key_id_t key)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007032{
Ronald Cronf95a2b12020-10-22 15:24:49 +02007033 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01007034 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007035 psa_key_slot_t *slot;
Gilles Peskine178c9aa2019-09-24 18:21:06 +02007036
Ronald Cron5c522922020-11-14 16:35:34 +01007037 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01007038 key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg);
7039 if (status != PSA_SUCCESS) {
7040 psa_key_derivation_abort(operation);
7041 return status;
Gilles Peskine593773d2019-09-23 18:17:40 +02007042 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02007043
Kusumit Ghoderao3128c5d2023-05-03 12:27:57 +05307044 /* Passing a key object as a SECRET or PASSWORD input unlocks the
7045 * permission to output to a key object. */
7046 if (step == PSA_KEY_DERIVATION_INPUT_SECRET ||
7047 step == PSA_KEY_DERIVATION_INPUT_PASSWORD) {
Gilles Peskine178c9aa2019-09-24 18:21:06 +02007048 operation->can_output_key = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01007049 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02007050
Gilles Peskine449bd832023-01-11 14:50:10 +01007051 status = psa_key_derivation_input_internal(operation,
7052 step, slot->attr.type,
7053 slot->key.data,
7054 slot->key.bytes);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007055
Ryan Everett1b70a072024-01-04 10:32:49 +00007056 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007057
Gilles Peskine449bd832023-01-11 14:50:10 +01007058 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007059}
Gilles Peskineea0fb492018-07-12 17:17:20 +02007060
7061
7062
7063/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02007064/* Key agreement */
7065/****************************************************************/
7066
Gilles Peskine449bd832023-01-11 14:50:10 +01007067psa_status_t psa_key_agreement_raw_builtin(const psa_key_attributes_t *attributes,
7068 const uint8_t *key_buffer,
7069 size_t key_buffer_size,
7070 psa_algorithm_t alg,
7071 const uint8_t *peer_key,
7072 size_t peer_key_length,
7073 uint8_t *shared_secret,
7074 size_t shared_secret_size,
7075 size_t *shared_secret_length)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02007076{
Gilles Peskine449bd832023-01-11 14:50:10 +01007077 switch (alg) {
John Durkop6ba40d12020-11-10 08:50:04 -08007078#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskine0216fe12019-04-11 21:23:21 +02007079 case PSA_ALG_ECDH:
Gilles Peskine449bd832023-01-11 14:50:10 +01007080 return mbedtls_psa_key_agreement_ecdh(attributes, key_buffer,
7081 key_buffer_size, alg,
7082 peer_key, peer_key_length,
7083 shared_secret,
7084 shared_secret_size,
7085 shared_secret_length);
Gilles Peskine01d718c2018-09-18 12:01:02 +02007086#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Przemek Stekielfb3dd542022-12-01 14:59:15 +01007087
7088#if defined(MBEDTLS_PSA_BUILTIN_ALG_FFDH)
7089 case PSA_ALG_FFDH:
Przemek Stekiel152bb462023-06-01 11:52:39 +02007090 return mbedtls_psa_ffdh_key_agreement(attributes,
Przemek Stekiel359f4622022-12-05 14:11:55 +01007091 peer_key,
7092 peer_key_length,
7093 key_buffer,
7094 key_buffer_size,
7095 shared_secret,
7096 shared_secret_size,
7097 shared_secret_length);
Przemek Stekielfb3dd542022-12-01 14:59:15 +01007098#endif /* MBEDTLS_PSA_BUILTIN_ALG_FFDH */
7099
Gilles Peskine01d718c2018-09-18 12:01:02 +02007100 default:
Aditya Deshpande17845b82022-10-13 17:21:01 +01007101 (void) attributes;
7102 (void) key_buffer;
7103 (void) key_buffer_size;
Gilles Peskine93f85002018-11-16 16:43:31 +01007104 (void) peer_key;
7105 (void) peer_key_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02007106 (void) shared_secret;
7107 (void) shared_secret_size;
7108 (void) shared_secret_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01007109 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine01d718c2018-09-18 12:01:02 +02007110 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02007111}
Gilles Peskine01d718c2018-09-18 12:01:02 +02007112
Aditya Deshpande17845b82022-10-13 17:21:01 +01007113/** Internal function for raw key agreement
7114 * Calls the driver wrapper which will hand off key agreement task
Aditya Deshpande40c05cc2022-10-14 16:41:40 +01007115 * to the driver's implementation if a driver is present.
7116 * Fallback specified in the driver wrapper is built-in raw key agreement
Aditya Deshpande17845b82022-10-13 17:21:01 +01007117 * (psa_key_agreement_raw_builtin).
7118 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007119static psa_status_t psa_key_agreement_raw_internal(psa_algorithm_t alg,
7120 psa_key_slot_t *private_key,
7121 const uint8_t *peer_key,
7122 size_t peer_key_length,
7123 uint8_t *shared_secret,
7124 size_t shared_secret_size,
7125 size_t *shared_secret_length)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02007126{
Gilles Peskine449bd832023-01-11 14:50:10 +01007127 if (!PSA_ALG_IS_RAW_KEY_AGREEMENT(alg)) {
7128 return PSA_ERROR_NOT_SUPPORTED;
7129 }
Aditya Deshpande17845b82022-10-13 17:21:01 +01007130
7131 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01007132 .core = private_key->attr
Aditya Deshpande17845b82022-10-13 17:21:01 +01007133 };
7134
Gilles Peskine449bd832023-01-11 14:50:10 +01007135 return psa_driver_wrapper_key_agreement(&attributes,
7136 private_key->key.data,
7137 private_key->key.bytes, alg,
7138 peer_key, peer_key_length,
7139 shared_secret,
7140 shared_secret_size,
7141 shared_secret_length);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007142}
7143
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02007144/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine01d718c2018-09-18 12:01:02 +02007145 * to potentially free embedded data structures and wipe confidential data.
7146 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007147static psa_status_t psa_key_agreement_internal(psa_key_derivation_operation_t *operation,
7148 psa_key_derivation_step_t step,
7149 psa_key_slot_t *private_key,
7150 const uint8_t *peer_key,
7151 size_t peer_key_length)
Gilles Peskine01d718c2018-09-18 12:01:02 +02007152{
7153 psa_status_t status;
Aditya Deshpande2f7fd762022-11-22 11:10:34 +00007154 uint8_t shared_secret[PSA_RAW_KEY_AGREEMENT_OUTPUT_MAX_SIZE];
Gilles Peskine01d718c2018-09-18 12:01:02 +02007155 size_t shared_secret_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007156 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE(operation->alg);
Gilles Peskine01d718c2018-09-18 12:01:02 +02007157
7158 /* Step 1: run the secret agreement algorithm to generate the shared
7159 * secret. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007160 status = psa_key_agreement_raw_internal(ka_alg,
7161 private_key,
7162 peer_key, peer_key_length,
7163 shared_secret,
7164 sizeof(shared_secret),
7165 &shared_secret_length);
7166 if (status != PSA_SUCCESS) {
Gilles Peskine12313cd2018-06-20 00:20:32 +02007167 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007168 }
Gilles Peskine12313cd2018-06-20 00:20:32 +02007169
Gilles Peskineb0b255c2018-07-06 17:01:38 +02007170 /* Step 2: set up the key derivation to generate key material from
Gilles Peskine224b0d62019-09-23 18:13:17 +02007171 * the shared secret. A shared secret is permitted wherever a key
7172 * of type DERIVE is permitted. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007173 status = psa_key_derivation_input_internal(operation, step,
7174 PSA_KEY_TYPE_DERIVE,
7175 shared_secret,
7176 shared_secret_length);
Gilles Peskine12313cd2018-06-20 00:20:32 +02007177exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007178 mbedtls_platform_zeroize(shared_secret, shared_secret_length);
7179 return status;
Gilles Peskine12313cd2018-06-20 00:20:32 +02007180}
7181
Gilles Peskine449bd832023-01-11 14:50:10 +01007182psa_status_t psa_key_derivation_key_agreement(psa_key_derivation_operation_t *operation,
7183 psa_key_derivation_step_t step,
7184 mbedtls_svc_key_id_t private_key,
7185 const uint8_t *peer_key,
7186 size_t peer_key_length)
Gilles Peskine12313cd2018-06-20 00:20:32 +02007187{
Ronald Cronf95a2b12020-10-22 15:24:49 +02007188 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01007189 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01007190 psa_key_slot_t *slot;
Ronald Cronf95a2b12020-10-22 15:24:49 +02007191
Gilles Peskine449bd832023-01-11 14:50:10 +01007192 if (!PSA_ALG_IS_KEY_AGREEMENT(operation->alg)) {
7193 return PSA_ERROR_INVALID_ARGUMENT;
7194 }
Ronald Cron5c522922020-11-14 16:35:34 +01007195 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01007196 private_key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg);
7197 if (status != PSA_SUCCESS) {
7198 return status;
7199 }
7200 status = psa_key_agreement_internal(operation, step,
7201 slot,
7202 peer_key, peer_key_length);
7203 if (status != PSA_SUCCESS) {
7204 psa_key_derivation_abort(operation);
7205 } else {
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007206 /* If a private key has been added as SECRET, we allow the derived
7207 * key material to be used as a key in PSA Crypto. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007208 if (step == PSA_KEY_DERIVATION_INPUT_SECRET) {
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007209 operation->can_output_key = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01007210 }
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007211 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007212
Ryan Everett1b70a072024-01-04 10:32:49 +00007213 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007214
Gilles Peskine449bd832023-01-11 14:50:10 +01007215 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskineaf3baab2018-06-27 22:55:52 +02007216}
7217
Gilles Peskine449bd832023-01-11 14:50:10 +01007218psa_status_t psa_raw_key_agreement(psa_algorithm_t alg,
7219 mbedtls_svc_key_id_t private_key,
7220 const uint8_t *peer_key,
7221 size_t peer_key_length,
7222 uint8_t *output,
7223 size_t output_size,
7224 size_t *output_length)
Gilles Peskine0216fe12019-04-11 21:23:21 +02007225{
Ronald Cronf95a2b12020-10-22 15:24:49 +02007226 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01007227 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +02007228 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007229 size_t expected_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02007230
Gilles Peskine449bd832023-01-11 14:50:10 +01007231 if (!PSA_ALG_IS_KEY_AGREEMENT(alg)) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007232 status = PSA_ERROR_INVALID_ARGUMENT;
7233 goto exit;
7234 }
Ronald Cron5c522922020-11-14 16:35:34 +01007235 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01007236 private_key, &slot, PSA_KEY_USAGE_DERIVE, alg);
7237 if (status != PSA_SUCCESS) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007238 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007239 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02007240
Gilles Peskine3e561302022-04-14 00:17:15 +02007241 /* PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() is in general an upper bound
7242 * for the output size. The PSA specification only guarantees that this
7243 * function works if output_size >= PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE(...),
7244 * but it might be nice to allow smaller buffers if the output fits.
7245 * At the time of writing this comment, with only ECDH implemented,
7246 * PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() is exact so the point is moot.
7247 * If FFDH is implemented, PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() can easily
7248 * be exact for it as well. */
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007249 expected_length =
Gilles Peskine449bd832023-01-11 14:50:10 +01007250 PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE(slot->attr.type, slot->attr.bits);
7251 if (output_size < expected_length) {
Gilles Peskine3e561302022-04-14 00:17:15 +02007252 status = PSA_ERROR_BUFFER_TOO_SMALL;
7253 goto exit;
7254 }
7255
Gilles Peskine449bd832023-01-11 14:50:10 +01007256 status = psa_key_agreement_raw_internal(alg, slot,
7257 peer_key, peer_key_length,
7258 output, output_size,
7259 output_length);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007260
7261exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007262 if (status != PSA_SUCCESS) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007263 /* If an error happens and is not handled properly, the output
7264 * may be used as a key to protect sensitive data. Arrange for such
7265 * a key to be random, which is likely to result in decryption or
7266 * verification errors. This is better than filling the buffer with
7267 * some constant data such as zeros, which would result in the data
7268 * being protected with a reproducible, easily knowable key.
7269 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007270 psa_generate_random(output, output_size);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007271 *output_length = output_size;
7272 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007273
Ryan Everett1b70a072024-01-04 10:32:49 +00007274 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007275
Gilles Peskine449bd832023-01-11 14:50:10 +01007276 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine0216fe12019-04-11 21:23:21 +02007277}
Gilles Peskine86a440b2018-11-12 18:39:40 +01007278
7279
Gilles Peskine30524eb2020-11-13 17:02:26 +01007280
Gilles Peskine86a440b2018-11-12 18:39:40 +01007281/****************************************************************/
7282/* Random generation */
Gilles Peskine53d991e2018-07-12 01:14:59 +02007283/****************************************************************/
Gilles Peskine12313cd2018-06-20 00:20:32 +02007284
Gilles Peskine672a7712023-04-28 21:00:28 +02007285#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
7286#include "entropy_poll.h"
7287#endif
7288
Gilles Peskine30524eb2020-11-13 17:02:26 +01007289/** Initialize the PSA random generator.
7290 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007291static void mbedtls_psa_random_init(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01007292{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007293#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine449bd832023-01-11 14:50:10 +01007294 memset(rng, 0, sizeof(*rng));
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007295#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
7296
Gilles Peskine30524eb2020-11-13 17:02:26 +01007297 /* Set default configuration if
7298 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007299 if (rng->entropy_init == NULL) {
Gilles Peskine30524eb2020-11-13 17:02:26 +01007300 rng->entropy_init = mbedtls_entropy_init;
Gilles Peskine449bd832023-01-11 14:50:10 +01007301 }
7302 if (rng->entropy_free == NULL) {
Gilles Peskine30524eb2020-11-13 17:02:26 +01007303 rng->entropy_free = mbedtls_entropy_free;
Gilles Peskine449bd832023-01-11 14:50:10 +01007304 }
Gilles Peskine30524eb2020-11-13 17:02:26 +01007305
Gilles Peskine449bd832023-01-11 14:50:10 +01007306 rng->entropy_init(&rng->entropy);
Gilles Peskine30524eb2020-11-13 17:02:26 +01007307#if defined(MBEDTLS_PSA_INJECT_ENTROPY) && \
7308 defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
7309 /* The PSA entropy injection feature depends on using NV seed as an entropy
7310 * source. Add NV seed as an entropy source for PSA entropy injection. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007311 mbedtls_entropy_add_source(&rng->entropy,
7312 mbedtls_nv_seed_poll, NULL,
7313 MBEDTLS_ENTROPY_BLOCK_SIZE,
7314 MBEDTLS_ENTROPY_SOURCE_STRONG);
Gilles Peskine30524eb2020-11-13 17:02:26 +01007315#endif
7316
Gilles Peskine449bd832023-01-11 14:50:10 +01007317 mbedtls_psa_drbg_init(MBEDTLS_PSA_RANDOM_STATE);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007318#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007319}
7320
7321/** Deinitialize the PSA random generator.
7322 */
Valerio Setti83e0de82023-11-24 12:13:05 +01007323static void mbedtls_psa_random_free(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01007324{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007325#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Valerio Setti83e0de82023-11-24 12:13:05 +01007326 memset(rng, 0, sizeof(*rng));
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007327#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Valerio Setti83e0de82023-11-24 12:13:05 +01007328 mbedtls_psa_drbg_free(MBEDTLS_PSA_RANDOM_STATE);
7329 rng->entropy_free(&rng->entropy);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007330#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007331}
7332
7333/** Seed the PSA random generator.
7334 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007335static psa_status_t mbedtls_psa_random_seed(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01007336{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007337#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
7338 /* Do nothing: the external RNG seeds itself. */
7339 (void) rng;
Gilles Peskine449bd832023-01-11 14:50:10 +01007340 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007341#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007342 const unsigned char drbg_seed[] = "PSA";
Gilles Peskine449bd832023-01-11 14:50:10 +01007343 int ret = mbedtls_psa_drbg_seed(&rng->entropy,
7344 drbg_seed, sizeof(drbg_seed) - 1);
7345 return mbedtls_to_psa_error(ret);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007346#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007347}
7348
Gilles Peskine449bd832023-01-11 14:50:10 +01007349psa_status_t psa_generate_random(uint8_t *output,
7350 size_t output_size)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007351{
Gilles Peskinee59236f2018-01-27 23:32:46 +01007352 GUARD_MODULE_INITIALIZED;
7353
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007354#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
7355
7356 size_t output_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007357 psa_status_t status = mbedtls_psa_external_get_random(&global_data.rng,
7358 output, output_size,
7359 &output_length);
7360 if (status != PSA_SUCCESS) {
7361 return status;
7362 }
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007363 /* Breaking up a request into smaller chunks is currently not supported
Tom Cosgrove1797b052022-12-04 17:19:59 +00007364 * for the external RNG interface. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007365 if (output_length != output_size) {
7366 return PSA_ERROR_INSUFFICIENT_ENTROPY;
7367 }
7368 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007369
7370#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
7371
Gilles Peskine449bd832023-01-11 14:50:10 +01007372 while (output_size > 0) {
Gilles Peskine71ddab92021-01-04 21:01:07 +01007373 size_t request_size =
Gilles Peskine449bd832023-01-11 14:50:10 +01007374 (output_size > MBEDTLS_PSA_RANDOM_MAX_REQUEST ?
7375 MBEDTLS_PSA_RANDOM_MAX_REQUEST :
7376 output_size);
7377 int ret = mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE,
7378 output, request_size);
7379 if (ret != 0) {
7380 return mbedtls_to_psa_error(ret);
7381 }
Gilles Peskine71ddab92021-01-04 21:01:07 +01007382 output_size -= request_size;
7383 output += request_size;
Gilles Peskinef181eca2019-08-07 13:49:00 +02007384 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007385 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007386#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskinee59236f2018-01-27 23:32:46 +01007387}
7388
Gilles Peskine8814fc42020-12-14 15:33:44 +01007389/* Wrapper function allowing the classic API to use the PSA RNG.
Gilles Peskine9c3e0602021-01-05 16:03:55 +01007390 *
7391 * `mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE, ...)` calls
7392 * `psa_generate_random(...)`. The state parameter is ignored since the
7393 * PSA API doesn't support passing an explicit state.
7394 *
7395 * In the non-external case, psa_generate_random() calls an
7396 * `mbedtls_xxx_drbg_random` function which has exactly the same signature
7397 * and semantics as mbedtls_psa_get_random(). As an optimization,
7398 * instead of doing this back-and-forth between the PSA API and the
7399 * classic API, psa_crypto_random_impl.h defines `mbedtls_psa_get_random`
7400 * as a constant function pointer to `mbedtls_xxx_drbg_random`.
Gilles Peskine8814fc42020-12-14 15:33:44 +01007401 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007402#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
7403int mbedtls_psa_get_random(void *p_rng,
7404 unsigned char *output,
7405 size_t output_size)
Gilles Peskine8814fc42020-12-14 15:33:44 +01007406{
Gilles Peskine9c3e0602021-01-05 16:03:55 +01007407 /* This function takes a pointer to the RNG state because that's what
7408 * classic mbedtls functions using an RNG expect. The PSA RNG manages
7409 * its own state internally and doesn't let the caller access that state.
7410 * So we just ignore the state parameter, and in practice we'll pass
7411 * NULL. */
Gilles Peskine8814fc42020-12-14 15:33:44 +01007412 (void) p_rng;
Gilles Peskine449bd832023-01-11 14:50:10 +01007413 psa_status_t status = psa_generate_random(output, output_size);
7414 if (status == PSA_SUCCESS) {
7415 return 0;
7416 } else {
7417 return MBEDTLS_ERR_ENTROPY_SOURCE_FAILED;
7418 }
Gilles Peskine8814fc42020-12-14 15:33:44 +01007419}
7420#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
7421
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01007422#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
Gilles Peskine449bd832023-01-11 14:50:10 +01007423psa_status_t mbedtls_psa_inject_entropy(const uint8_t *seed,
7424 size_t seed_size)
Netanel Gonen2bcd3122018-11-19 11:53:02 +02007425{
Gilles Peskine449bd832023-01-11 14:50:10 +01007426 if (global_data.initialized) {
7427 return PSA_ERROR_NOT_PERMITTED;
7428 }
Netanel Gonen21f37cb2018-11-19 11:53:55 +02007429
Gilles Peskine449bd832023-01-11 14:50:10 +01007430 if (((seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM) ||
7431 (seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE)) ||
7432 (seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE)) {
7433 return PSA_ERROR_INVALID_ARGUMENT;
7434 }
Netanel Gonen21f37cb2018-11-19 11:53:55 +02007435
Gilles Peskine449bd832023-01-11 14:50:10 +01007436 return mbedtls_psa_storage_inject_entropy(seed, seed_size);
Netanel Gonen2bcd3122018-11-19 11:53:02 +02007437}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01007438#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02007439
Ronald Cron3772afe2021-02-08 16:10:05 +01007440/** Validate the key type and size for key generation
Ronald Cron01b2aba2020-10-05 09:42:02 +02007441 *
Ronald Cron3772afe2021-02-08 16:10:05 +01007442 * \param type The key type
7443 * \param bits The number of bits of the key
Ronald Cron01b2aba2020-10-05 09:42:02 +02007444 *
7445 * \retval #PSA_SUCCESS
Ronald Cron3772afe2021-02-08 16:10:05 +01007446 * The key type and size are valid.
Ronald Cron01b2aba2020-10-05 09:42:02 +02007447 * \retval #PSA_ERROR_INVALID_ARGUMENT
7448 * The size in bits of the key is not valid.
7449 * \retval #PSA_ERROR_NOT_SUPPORTED
7450 * The type and/or the size in bits of the key or the combination of
7451 * the two is not supported.
7452 */
Ronald Cron3772afe2021-02-08 16:10:05 +01007453static psa_status_t psa_validate_key_type_and_size_for_key_generation(
Gilles Peskine449bd832023-01-11 14:50:10 +01007454 psa_key_type_t type, size_t bits)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007455{
Ronald Cronf3bb7612020-10-02 20:11:59 +02007456 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007457
Gilles Peskine449bd832023-01-11 14:50:10 +01007458 if (key_type_is_raw_bytes(type)) {
7459 status = psa_validate_unstructured_key_bit_size(type, bits);
7460 if (status != PSA_SUCCESS) {
7461 return status;
7462 }
7463 } else
Valerio Settif6d4dfb2023-07-10 10:55:12 +02007464#if defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007465 if (PSA_KEY_TYPE_IS_RSA(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
7466 if (bits > PSA_VENDOR_RSA_MAX_KEY_BITS) {
7467 return PSA_ERROR_NOT_SUPPORTED;
7468 }
Waleed Elmelegyd7bdbbe2023-07-20 16:26:58 +00007469 if (bits < PSA_VENDOR_RSA_GENERATE_MIN_KEY_BITS) {
Waleed Elmelegyab570712023-07-05 16:40:58 +00007470 return PSA_ERROR_NOT_SUPPORTED;
7471 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +02007472
Ronald Cron01b2aba2020-10-05 09:42:02 +02007473 /* Accept only byte-aligned keys, for the same reasons as
7474 * in psa_import_rsa_key(). */
Gilles Peskine449bd832023-01-11 14:50:10 +01007475 if (bits % 8 != 0) {
7476 return PSA_ERROR_NOT_SUPPORTED;
7477 }
7478 } else
Valerio Settif6d4dfb2023-07-10 10:55:12 +02007479#endif /* defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02007480
Valerio Setti6a9d0ee2023-06-21 10:07:21 +02007481#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007482 if (PSA_KEY_TYPE_IS_ECC(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
Ronald Crond81ab562021-02-16 09:01:16 +01007483 /* To avoid empty block, return successfully here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007484 return PSA_SUCCESS;
7485 } else
Valerio Setti6a9d0ee2023-06-21 10:07:21 +02007486#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_GENERATE) */
Przemek Stekielfedd1342022-12-01 15:00:02 +01007487
Valerio Settia55f0422023-07-10 15:34:41 +02007488#if defined(PSA_WANT_KEY_TYPE_DH_KEY_PAIR_GENERATE)
Przemek Stekielfedd1342022-12-01 15:00:02 +01007489 if (PSA_KEY_TYPE_IS_DH(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
Przemek Stekield1cf1ba2023-04-27 12:04:21 +02007490 if (psa_is_dh_key_size_valid(bits) == 0) {
Przemek Stekielfedd1342022-12-01 15:00:02 +01007491 return PSA_ERROR_NOT_SUPPORTED;
7492 }
7493 } else
Valerio Settia55f0422023-07-10 15:34:41 +02007494#endif /* defined(PSA_WANT_KEY_TYPE_DH_KEY_PAIR_GENERATE) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02007495 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007496 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007497 }
7498
Gilles Peskine449bd832023-01-11 14:50:10 +01007499 return PSA_SUCCESS;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007500}
7501
Ronald Cron55ed0592020-10-05 10:30:40 +02007502psa_status_t psa_generate_key_internal(
Ronald Cron2a38a6b2020-10-02 20:02:04 +02007503 const psa_key_attributes_t *attributes,
Gilles Peskine7a18f962024-02-12 16:48:11 +01007504 const psa_key_generation_method_t *method, size_t method_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01007505 uint8_t *key_buffer, size_t key_buffer_size, size_t *key_buffer_length)
Ronald Cron01b2aba2020-10-05 09:42:02 +02007506{
7507 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2a38a6b2020-10-02 20:02:04 +02007508 psa_key_type_t type = attributes->core.type;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007509
Gilles Peskine7a18f962024-02-12 16:48:11 +01007510 /* Only used for RSA */
7511 (void) method;
7512 (void) method_length;
7513
Gilles Peskine449bd832023-01-11 14:50:10 +01007514 if ((attributes->domain_parameters == NULL) &&
7515 (attributes->domain_parameters_size != 0)) {
7516 return PSA_ERROR_INVALID_ARGUMENT;
7517 }
Ronald Cron01b2aba2020-10-05 09:42:02 +02007518
Gilles Peskine449bd832023-01-11 14:50:10 +01007519 if (key_type_is_raw_bytes(type)) {
7520 status = psa_generate_random(key_buffer, key_buffer_size);
7521 if (status != PSA_SUCCESS) {
7522 return status;
7523 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +02007524
David Brown12ca5032021-02-11 11:02:00 -07007525#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01007526 if (type == PSA_KEY_TYPE_DES) {
7527 psa_des_set_key_parity(key_buffer, key_buffer_size);
7528 }
David Brown8107e312021-02-12 08:08:46 -07007529#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine449bd832023-01-11 14:50:10 +01007530 } else
Gilles Peskinee59236f2018-01-27 23:32:46 +01007531
Valerio Setti76df8c12023-07-11 14:11:28 +02007532#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007533 if (type == PSA_KEY_TYPE_RSA_KEY_PAIR) {
Gilles Peskine7a18f962024-02-12 16:48:11 +01007534 /* Hack: if the method specifies a non-default e, pass it
7535 * via the domain parameters. TODO: refactor this code so
7536 * that mbedtls_psa_rsa_generate_key() gets e via a new
7537 * parameter instead. */
7538 psa_key_attributes_t override_attributes = *attributes;
7539 if (method_length > sizeof(*method)) {
7540 override_attributes.domain_parameters_size =
7541 method_length - offsetof(psa_key_generation_method_t, data);
7542 override_attributes.domain_parameters = (uint8_t *) &method->data;
7543 }
7544 return mbedtls_psa_rsa_generate_key(&override_attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01007545 key_buffer,
7546 key_buffer_size,
7547 key_buffer_length);
7548 } else
Valerio Setti76df8c12023-07-11 14:11:28 +02007549#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_GENERATE) */
Gilles Peskinee59236f2018-01-27 23:32:46 +01007550
Valerio Settibfeaf5b2023-06-20 13:27:46 +02007551#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007552 if (PSA_KEY_TYPE_IS_ECC(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
7553 return mbedtls_psa_ecp_generate_key(attributes,
7554 key_buffer,
7555 key_buffer_size,
7556 key_buffer_length);
7557 } else
Valerio Settibfeaf5b2023-06-20 13:27:46 +02007558#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_GENERATE) */
Przemek Stekielfedd1342022-12-01 15:00:02 +01007559
Valerio Settia55f0422023-07-10 15:34:41 +02007560#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_GENERATE)
Przemek Stekielfedd1342022-12-01 15:00:02 +01007561 if (PSA_KEY_TYPE_IS_DH(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
7562 return mbedtls_psa_ffdh_generate_key(attributes,
7563 key_buffer,
7564 key_buffer_size,
7565 key_buffer_length);
7566 } else
Valerio Settia55f0422023-07-10 15:34:41 +02007567#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_GENERATE) */
Steven Cooreman29149862020-08-05 15:43:42 +02007568 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007569 (void) key_buffer_length;
7570 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman29149862020-08-05 15:43:42 +02007571 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01007572
Gilles Peskine449bd832023-01-11 14:50:10 +01007573 return PSA_SUCCESS;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02007574}
Darryl Green0c6575a2018-11-07 16:05:30 +00007575
Gilles Peskinef0765fa2024-02-12 16:46:16 +01007576psa_status_t psa_generate_key_ext(const psa_key_attributes_t *attributes,
7577 const psa_key_generation_method_t *method,
7578 size_t method_length,
7579 mbedtls_svc_key_id_t *key)
Gilles Peskineff5f0e72019-04-18 12:53:30 +02007580{
7581 psa_status_t status;
7582 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02007583 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cron2b56bc82020-10-05 10:02:26 +02007584 size_t key_buffer_size;
Gilles Peskine11792082019-08-06 18:36:36 +02007585
Ronald Cron81709fc2020-11-14 12:10:32 +01007586 *key = MBEDTLS_SVC_KEY_ID_INIT;
7587
Gilles Peskine0f84d622019-09-12 19:03:13 +02007588 /* Reject any attempt to create a zero-length key so that we don't
7589 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007590 if (psa_get_key_bits(attributes) == 0) {
7591 return PSA_ERROR_INVALID_ARGUMENT;
7592 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02007593
Przemyslaw Stekielc0fe8202021-10-07 11:08:56 +02007594 /* Reject any attempt to create a public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007595 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(attributes->core.type)) {
7596 return PSA_ERROR_INVALID_ARGUMENT;
7597 }
Przemyslaw Stekielc0fe8202021-10-07 11:08:56 +02007598
Gilles Peskinef0765fa2024-02-12 16:46:16 +01007599 if (method_length < sizeof(*method)) {
7600 return PSA_ERROR_INVALID_ARGUMENT;
7601 }
Gilles Peskine7a18f962024-02-12 16:48:11 +01007602
7603#if defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE)
7604 if (attributes->core.type == PSA_KEY_TYPE_RSA_KEY_PAIR) {
7605 if (method->flags != 0) {
7606 return PSA_ERROR_INVALID_ARGUMENT;
7607 }
7608 } else
7609#endif
Gilles Peskinef0765fa2024-02-12 16:46:16 +01007610 if (!psa_key_generation_method_is_default(method, method_length)) {
7611 return PSA_ERROR_INVALID_ARGUMENT;
7612 }
7613
Gilles Peskine449bd832023-01-11 14:50:10 +01007614 status = psa_start_key_creation(PSA_KEY_CREATION_GENERATE, attributes,
7615 &slot, &driver);
7616 if (status != PSA_SUCCESS) {
Gilles Peskine11792082019-08-06 18:36:36 +02007617 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007618 }
Gilles Peskine11792082019-08-06 18:36:36 +02007619
Ronald Cron977c2472020-10-13 08:32:21 +02007620 /* In the case of a transparent key or an opaque key stored in local
Archana449608b2021-09-08 15:36:05 +05307621 * storage ( thus not in the case of generating a key in a secure element
7622 * with storage ( MBEDTLS_PSA_CRYPTO_SE_C ) ),we have to allocate a
7623 * buffer to hold the generated key material. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007624 if (slot->key.data == NULL) {
7625 if (PSA_KEY_LIFETIME_GET_LOCATION(attributes->core.lifetime) ==
7626 PSA_KEY_LOCATION_LOCAL_STORAGE) {
Ronald Cron3772afe2021-02-08 16:10:05 +01007627 status = psa_validate_key_type_and_size_for_key_generation(
Gilles Peskine449bd832023-01-11 14:50:10 +01007628 attributes->core.type, attributes->core.bits);
7629 if (status != PSA_SUCCESS) {
Ronald Cron3772afe2021-02-08 16:10:05 +01007630 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007631 }
Ronald Cron3772afe2021-02-08 16:10:05 +01007632
7633 key_buffer_size = PSA_EXPORT_KEY_OUTPUT_SIZE(
Gilles Peskine449bd832023-01-11 14:50:10 +01007634 attributes->core.type,
7635 attributes->core.bits);
7636 } else {
Ronald Cron977c2472020-10-13 08:32:21 +02007637 status = psa_driver_wrapper_get_key_buffer_size(
Gilles Peskine449bd832023-01-11 14:50:10 +01007638 attributes, &key_buffer_size);
7639 if (status != PSA_SUCCESS) {
Ronald Cron3772afe2021-02-08 16:10:05 +01007640 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007641 }
Ronald Cron977c2472020-10-13 08:32:21 +02007642 }
Ronald Cron977c2472020-10-13 08:32:21 +02007643
Gilles Peskine449bd832023-01-11 14:50:10 +01007644 status = psa_allocate_buffer_to_slot(slot, key_buffer_size);
7645 if (status != PSA_SUCCESS) {
Ronald Cron977c2472020-10-13 08:32:21 +02007646 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007647 }
Ronald Cron977c2472020-10-13 08:32:21 +02007648 }
7649
Gilles Peskine449bd832023-01-11 14:50:10 +01007650 status = psa_driver_wrapper_generate_key(attributes,
Gilles Peskine7a18f962024-02-12 16:48:11 +01007651 method, method_length,
7652 slot->key.data, slot->key.bytes,
7653 &slot->key.bytes);
Gilles Peskine449bd832023-01-11 14:50:10 +01007654 if (status != PSA_SUCCESS) {
7655 psa_remove_key_data_from_memory(slot);
7656 }
Ronald Cron2b56bc82020-10-05 10:02:26 +02007657
Gilles Peskine11792082019-08-06 18:36:36 +02007658exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007659 if (status == PSA_SUCCESS) {
7660 status = psa_finish_key_creation(slot, driver, key);
7661 }
7662 if (status != PSA_SUCCESS) {
7663 psa_fail_key_creation(slot, driver);
7664 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007665
Gilles Peskine449bd832023-01-11 14:50:10 +01007666 return status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007667}
7668
Gilles Peskinef0765fa2024-02-12 16:46:16 +01007669psa_status_t psa_generate_key(const psa_key_attributes_t *attributes,
7670 mbedtls_svc_key_id_t *key)
7671{
7672 return psa_generate_key_ext(attributes,
7673 &default_method, sizeof(default_method),
7674 key);
7675}
7676
Gilles Peskinee59236f2018-01-27 23:32:46 +01007677/****************************************************************/
7678/* Module setup */
7679/****************************************************************/
7680
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007681#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine5e769522018-11-20 21:59:56 +01007682psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
Gilles Peskine449bd832023-01-11 14:50:10 +01007683 void (* entropy_init)(mbedtls_entropy_context *ctx),
7684 void (* entropy_free)(mbedtls_entropy_context *ctx))
Gilles Peskine5e769522018-11-20 21:59:56 +01007685{
Gilles Peskine449bd832023-01-11 14:50:10 +01007686 if (global_data.rng_state != RNG_NOT_INITIALIZED) {
7687 return PSA_ERROR_BAD_STATE;
7688 }
Gilles Peskine30524eb2020-11-13 17:02:26 +01007689 global_data.rng.entropy_init = entropy_init;
7690 global_data.rng.entropy_free = entropy_free;
Gilles Peskine449bd832023-01-11 14:50:10 +01007691 return PSA_SUCCESS;
Gilles Peskine5e769522018-11-20 21:59:56 +01007692}
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007693#endif /* !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) */
Gilles Peskine5e769522018-11-20 21:59:56 +01007694
Gilles Peskine449bd832023-01-11 14:50:10 +01007695void mbedtls_psa_crypto_free(void)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007696{
Gilles Peskine449bd832023-01-11 14:50:10 +01007697 psa_wipe_all_key_slots();
Valerio Setti83e0de82023-11-24 12:13:05 +01007698 if (global_data.rng_state != RNG_NOT_INITIALIZED) {
7699 mbedtls_psa_random_free(&global_data.rng);
7700 }
Gilles Peskinec6b69072018-11-20 21:42:52 +01007701 /* Wipe all remaining data, including configuration.
7702 * In particular, this sets all state indicator to the value
7703 * indicating "uninitialized". */
Gilles Peskine449bd832023-01-11 14:50:10 +01007704 mbedtls_platform_zeroize(&global_data, sizeof(global_data));
Ronald Cron9ba76912021-04-10 16:57:30 +02007705
7706 /* Terminate drivers */
Gilles Peskine449bd832023-01-11 14:50:10 +01007707 psa_driver_wrapper_free();
Gilles Peskinee59236f2018-01-27 23:32:46 +01007708}
7709
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007710#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
7711/** Recover a transaction that was interrupted by a power failure.
7712 *
7713 * This function is called during initialization, before psa_crypto_init()
7714 * returns. If this function returns a failure status, the initialization
7715 * fails.
7716 */
7717static psa_status_t psa_crypto_recover_transaction(
Gilles Peskine449bd832023-01-11 14:50:10 +01007718 const psa_crypto_transaction_t *transaction)
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007719{
Gilles Peskine449bd832023-01-11 14:50:10 +01007720 switch (transaction->unknown.type) {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007721 case PSA_CRYPTO_TRANSACTION_CREATE_KEY:
7722 case PSA_CRYPTO_TRANSACTION_DESTROY_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01007723 /* TODO - fall through to the failure case until this
7724 * is implemented.
7725 * https://github.com/ARMmbed/mbed-crypto/issues/218
7726 */
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007727 default:
7728 /* We found an unsupported transaction in the storage.
7729 * We don't know what state the storage is in. Give up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007730 return PSA_ERROR_DATA_INVALID;
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007731 }
7732}
7733#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
7734
Gilles Peskine449bd832023-01-11 14:50:10 +01007735psa_status_t psa_crypto_init(void)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007736{
Gilles Peskine66fb1262018-12-10 16:29:04 +01007737 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007738
Gilles Peskinec6b69072018-11-20 21:42:52 +01007739 /* Double initialization is explicitly allowed. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007740 if (global_data.initialized != 0) {
7741 return PSA_SUCCESS;
7742 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01007743
Manuel Pégourié-Gonnard7abdf7e2023-03-09 11:17:43 +01007744 /* Init drivers */
7745 status = psa_driver_wrapper_init();
7746 if (status != PSA_SUCCESS) {
7747 goto exit;
7748 }
7749 global_data.drivers_initialized = 1;
7750
Valerio Setti402cfba2023-11-13 10:24:32 +01007751 status = psa_initialize_key_slots();
7752 if (status != PSA_SUCCESS) {
7753 goto exit;
7754 }
7755
Gilles Peskine30524eb2020-11-13 17:02:26 +01007756 /* Initialize and seed the random generator. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007757 mbedtls_psa_random_init(&global_data.rng);
Gilles Peskinec6b69072018-11-20 21:42:52 +01007758 global_data.rng_state = RNG_INITIALIZED;
Gilles Peskine449bd832023-01-11 14:50:10 +01007759 status = mbedtls_psa_random_seed(&global_data.rng);
7760 if (status != PSA_SUCCESS) {
Gilles Peskinee59236f2018-01-27 23:32:46 +01007761 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007762 }
Gilles Peskinec6b69072018-11-20 21:42:52 +01007763 global_data.rng_state = RNG_SEEDED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007764
Gilles Peskine4b734222019-07-24 15:56:31 +02007765#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007766 status = psa_crypto_load_transaction();
7767 if (status == PSA_SUCCESS) {
7768 status = psa_crypto_recover_transaction(&psa_crypto_transaction);
7769 if (status != PSA_SUCCESS) {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007770 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007771 }
7772 status = psa_crypto_stop_transaction();
7773 } else if (status == PSA_ERROR_DOES_NOT_EXIST) {
Gilles Peskinefc762652019-07-22 19:30:34 +02007774 /* There's no transaction to complete. It's all good. */
7775 status = PSA_SUCCESS;
7776 }
Gilles Peskine4b734222019-07-24 15:56:31 +02007777#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
Gilles Peskinefc762652019-07-22 19:30:34 +02007778
Gilles Peskinec6b69072018-11-20 21:42:52 +01007779 /* All done. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01007780 global_data.initialized = 1;
7781
7782exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007783 if (status != PSA_SUCCESS) {
7784 mbedtls_psa_crypto_free();
7785 }
7786 return status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007787}
7788
Yanray Wangffc3c482023-07-11 12:01:04 +08007789#if defined(PSA_WANT_ALG_SOME_PAKE)
Przemek Stekielca8d2b22023-01-17 16:21:33 +01007790psa_status_t psa_crypto_driver_pake_get_password_len(
7791 const psa_crypto_driver_pake_inputs_t *inputs,
7792 size_t *password_len)
7793{
7794 if (inputs->password_len == 0) {
7795 return PSA_ERROR_BAD_STATE;
7796 }
7797
7798 *password_len = inputs->password_len;
7799
7800 return PSA_SUCCESS;
7801}
7802
7803psa_status_t psa_crypto_driver_pake_get_password(
7804 const psa_crypto_driver_pake_inputs_t *inputs,
7805 uint8_t *buffer, size_t buffer_size, size_t *buffer_length)
7806{
7807 if (inputs->password_len == 0) {
7808 return PSA_ERROR_BAD_STATE;
7809 }
7810
7811 if (buffer_size < inputs->password_len) {
7812 return PSA_ERROR_BUFFER_TOO_SMALL;
7813 }
7814
7815 memcpy(buffer, inputs->password, inputs->password_len);
7816 *buffer_length = inputs->password_len;
7817
7818 return PSA_SUCCESS;
7819}
7820
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007821psa_status_t psa_crypto_driver_pake_get_user_len(
7822 const psa_crypto_driver_pake_inputs_t *inputs,
7823 size_t *user_len)
7824{
7825 if (inputs->user_len == 0) {
7826 return PSA_ERROR_BAD_STATE;
7827 }
7828
7829 *user_len = inputs->user_len;
7830
7831 return PSA_SUCCESS;
7832}
7833
7834psa_status_t psa_crypto_driver_pake_get_user(
7835 const psa_crypto_driver_pake_inputs_t *inputs,
Przemek Stekielc0e62502023-03-14 11:49:36 +01007836 uint8_t *user_id, size_t user_id_size, size_t *user_id_len)
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007837{
7838 if (inputs->user_len == 0) {
7839 return PSA_ERROR_BAD_STATE;
7840 }
7841
Przemek Stekielc0e62502023-03-14 11:49:36 +01007842 if (user_id_size < inputs->user_len) {
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007843 return PSA_ERROR_BUFFER_TOO_SMALL;
7844 }
7845
Przemek Stekielc0e62502023-03-14 11:49:36 +01007846 memcpy(user_id, inputs->user, inputs->user_len);
7847 *user_id_len = inputs->user_len;
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007848
7849 return PSA_SUCCESS;
7850}
7851
7852psa_status_t psa_crypto_driver_pake_get_peer_len(
7853 const psa_crypto_driver_pake_inputs_t *inputs,
7854 size_t *peer_len)
7855{
7856 if (inputs->peer_len == 0) {
7857 return PSA_ERROR_BAD_STATE;
7858 }
7859
7860 *peer_len = inputs->peer_len;
7861
7862 return PSA_SUCCESS;
7863}
7864
7865psa_status_t psa_crypto_driver_pake_get_peer(
7866 const psa_crypto_driver_pake_inputs_t *inputs,
Przemek Stekielc0e62502023-03-14 11:49:36 +01007867 uint8_t *peer_id, size_t peer_id_size, size_t *peer_id_length)
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007868{
7869 if (inputs->peer_len == 0) {
7870 return PSA_ERROR_BAD_STATE;
7871 }
7872
Przemek Stekielc0e62502023-03-14 11:49:36 +01007873 if (peer_id_size < inputs->peer_len) {
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007874 return PSA_ERROR_BUFFER_TOO_SMALL;
7875 }
7876
Przemek Stekielc0e62502023-03-14 11:49:36 +01007877 memcpy(peer_id, inputs->peer, inputs->peer_len);
7878 *peer_id_length = inputs->peer_len;
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007879
7880 return PSA_SUCCESS;
7881}
7882
Przemek Stekielca8d2b22023-01-17 16:21:33 +01007883psa_status_t psa_crypto_driver_pake_get_cipher_suite(
7884 const psa_crypto_driver_pake_inputs_t *inputs,
7885 psa_pake_cipher_suite_t *cipher_suite)
7886{
7887 if (inputs->cipher_suite.algorithm == PSA_ALG_NONE) {
7888 return PSA_ERROR_BAD_STATE;
7889 }
7890
7891 *cipher_suite = inputs->cipher_suite;
7892
7893 return PSA_SUCCESS;
7894}
7895
Neil Armstronga7d08c32022-06-01 18:21:20 +02007896psa_status_t psa_pake_setup(
7897 psa_pake_operation_t *operation,
7898 const psa_pake_cipher_suite_t *cipher_suite)
7899{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007900 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007901
Przemek Stekiel1c3cfb42023-01-26 10:35:02 +01007902 if (operation->stage != PSA_PAKE_OPERATION_STAGE_SETUP) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007903 status = PSA_ERROR_BAD_STATE;
7904 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007905 }
7906
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01007907 if (PSA_ALG_IS_PAKE(cipher_suite->algorithm) == 0 ||
Przemek Stekiel51eac532022-12-07 11:04:51 +01007908 PSA_ALG_IS_HASH(cipher_suite->hash) == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007909 status = PSA_ERROR_INVALID_ARGUMENT;
7910 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007911 }
7912
Przemek Stekiel51eac532022-12-07 11:04:51 +01007913 memset(&operation->data.inputs, 0, sizeof(operation->data.inputs));
7914
Przemek Stekiele12ed362022-12-21 12:54:46 +01007915 operation->alg = cipher_suite->algorithm;
Przemek Stekiel656b2592023-03-22 13:15:33 +01007916 operation->primitive = PSA_PAKE_PRIMITIVE(cipher_suite->type,
7917 cipher_suite->family, cipher_suite->bits);
Przemek Stekiel51eac532022-12-07 11:04:51 +01007918 operation->data.inputs.cipher_suite = *cipher_suite;
7919
Przemek Stekiel4aa99402023-02-27 13:00:57 +01007920#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01007921 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01007922 psa_jpake_computation_stage_t *computation_stage =
Przemek Stekieldde6a912023-01-26 08:46:37 +01007923 &operation->computation_stage.jpake;
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01007924
David Horstmann16f01512023-06-14 17:21:07 +01007925 memset(computation_stage, 0, sizeof(*computation_stage));
David Horstmanne7f21e62023-05-12 18:17:21 +01007926 computation_stage->step = PSA_PAKE_STEP_KEY_SHARE;
Przemek Stekiel80a88492023-02-20 13:32:22 +01007927 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007928#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01007929 {
7930 status = PSA_ERROR_NOT_SUPPORTED;
7931 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01007932 }
7933
Przemek Stekiel1c3cfb42023-01-26 10:35:02 +01007934 operation->stage = PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS;
7935
Przemek Stekiel51eac532022-12-07 11:04:51 +01007936 return PSA_SUCCESS;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007937exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007938 psa_pake_abort(operation);
7939 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02007940}
7941
7942psa_status_t psa_pake_set_password_key(
7943 psa_pake_operation_t *operation,
7944 mbedtls_svc_key_id_t password)
7945{
Neil Armstrong5ae60962022-09-15 11:29:46 +02007946 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel6c764412022-11-22 14:05:12 +01007947 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
7948 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007949 psa_key_attributes_t attributes;
7950 psa_key_type_t type;
Neil Armstrong5ae60962022-09-15 11:29:46 +02007951
Przemek Stekiel51eac532022-12-07 11:04:51 +01007952 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007953 status = PSA_ERROR_BAD_STATE;
7954 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007955 }
7956
Przemek Stekiel6c764412022-11-22 14:05:12 +01007957 status = psa_get_and_lock_key_slot_with_policy(password, &slot,
7958 PSA_KEY_USAGE_DERIVE,
Przemek Stekield5d28a22023-01-26 10:46:05 +01007959 operation->alg);
Neil Armstrong5ae60962022-09-15 11:29:46 +02007960 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007961 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02007962 }
7963
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007964 attributes = (psa_key_attributes_t) {
Przemek Stekiel6c764412022-11-22 14:05:12 +01007965 .core = slot->attr
7966 };
Neil Armstrong5ae60962022-09-15 11:29:46 +02007967
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007968 type = psa_get_key_type(&attributes);
Neil Armstrong5ae60962022-09-15 11:29:46 +02007969
Przemek Stekiel51eac532022-12-07 11:04:51 +01007970 if (type != PSA_KEY_TYPE_PASSWORD &&
7971 type != PSA_KEY_TYPE_PASSWORD_HASH) {
7972 status = PSA_ERROR_INVALID_ARGUMENT;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007973 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007974 }
7975
Przemek Stekiel51eac532022-12-07 11:04:51 +01007976 operation->data.inputs.password = mbedtls_calloc(1, slot->key.bytes);
7977 if (operation->data.inputs.password == NULL) {
Przemek Stekiele12ed362022-12-21 12:54:46 +01007978 status = PSA_ERROR_INSUFFICIENT_MEMORY;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007979 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007980 }
7981
7982 memcpy(operation->data.inputs.password, slot->key.data, slot->key.bytes);
7983 operation->data.inputs.password_len = slot->key.bytes;
Przemek Stekiel9dd24402023-01-26 15:06:09 +01007984 operation->data.inputs.attributes = attributes;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007985exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007986 if (status != PSA_SUCCESS) {
7987 psa_pake_abort(operation);
7988 }
Ryan Everett1b70a072024-01-04 10:32:49 +00007989 unlock_status = psa_unregister_read(slot);
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007990 return (status == PSA_SUCCESS) ? unlock_status : status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02007991}
7992
7993psa_status_t psa_pake_set_user(
7994 psa_pake_operation_t *operation,
7995 const uint8_t *user_id,
7996 size_t user_id_len)
7997{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007998 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007999
8000 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008001 status = PSA_ERROR_BAD_STATE;
8002 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008003 }
8004
Przemek Stekiel51eac532022-12-07 11:04:51 +01008005 if (user_id_len == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008006 status = PSA_ERROR_INVALID_ARGUMENT;
8007 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008008 }
8009
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008010 if (operation->data.inputs.user_len != 0) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008011 status = PSA_ERROR_BAD_STATE;
8012 goto exit;
8013 }
8014
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008015 operation->data.inputs.user = mbedtls_calloc(1, user_id_len);
8016 if (operation->data.inputs.user == NULL) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008017 status = PSA_ERROR_INSUFFICIENT_MEMORY;
8018 goto exit;
8019 }
8020
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008021 memcpy(operation->data.inputs.user, user_id, user_id_len);
8022 operation->data.inputs.user_len = user_id_len;
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008023
8024 return PSA_SUCCESS;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008025exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008026 psa_pake_abort(operation);
8027 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008028}
8029
8030psa_status_t psa_pake_set_peer(
8031 psa_pake_operation_t *operation,
8032 const uint8_t *peer_id,
8033 size_t peer_id_len)
8034{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008035 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008036
8037 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008038 status = PSA_ERROR_BAD_STATE;
8039 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008040 }
8041
Przemek Stekiel51eac532022-12-07 11:04:51 +01008042 if (peer_id_len == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008043 status = PSA_ERROR_INVALID_ARGUMENT;
8044 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008045 }
8046
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008047 if (operation->data.inputs.peer_len != 0) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008048 status = PSA_ERROR_BAD_STATE;
8049 goto exit;
8050 }
8051
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008052 operation->data.inputs.peer = mbedtls_calloc(1, peer_id_len);
8053 if (operation->data.inputs.peer == NULL) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008054 status = PSA_ERROR_INSUFFICIENT_MEMORY;
8055 goto exit;
8056 }
8057
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008058 memcpy(operation->data.inputs.peer, peer_id, peer_id_len);
8059 operation->data.inputs.peer_len = peer_id_len;
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008060
8061 return PSA_SUCCESS;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008062exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008063 psa_pake_abort(operation);
8064 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008065}
8066
8067psa_status_t psa_pake_set_role(
8068 psa_pake_operation_t *operation,
8069 psa_pake_role_t role)
8070{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008071 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008072
Przemek Stekiel51eac532022-12-07 11:04:51 +01008073 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008074 status = PSA_ERROR_BAD_STATE;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008075 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008076 }
8077
Przemek Stekiel09104b82023-03-06 14:11:51 +01008078 switch (operation->alg) {
8079#if defined(PSA_WANT_ALG_JPAKE)
8080 case PSA_ALG_JPAKE:
8081 if (role == PSA_PAKE_ROLE_NONE) {
8082 return PSA_SUCCESS;
8083 }
8084 status = PSA_ERROR_INVALID_ARGUMENT;
8085 break;
8086#endif
8087 default:
8088 (void) role;
8089 status = PSA_ERROR_NOT_SUPPORTED;
8090 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008091 }
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008092exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008093 psa_pake_abort(operation);
8094 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008095}
8096
David Horstmanne7f21e62023-05-12 18:17:21 +01008097/* Auxiliary function to convert core computation stage to single driver step. */
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008098#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiel251e86a2023-02-17 14:30:50 +01008099static psa_crypto_driver_pake_step_t convert_jpake_computation_stage_to_driver_step(
Przemek Stekieldde6a912023-01-26 08:46:37 +01008100 psa_jpake_computation_stage_t *stage)
Przemek Stekielb09c4872023-01-17 12:05:38 +01008101{
David Horstmann74a3d8c2023-06-14 18:28:19 +01008102 psa_crypto_driver_pake_step_t key_share_step;
David Horstmann5da95602023-06-08 15:37:12 +01008103 if (stage->round == PSA_JPAKE_FIRST) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008104 int is_x1;
David Horstmann74a3d8c2023-06-14 18:28:19 +01008105
David Horstmann024e5c52023-06-14 15:48:21 +01008106 if (stage->io_mode == PSA_JPAKE_OUTPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008107 is_x1 = (stage->outputs < 1);
8108 } else {
8109 is_x1 = (stage->inputs < 1);
8110 }
8111
David Horstmann74a3d8c2023-06-14 18:28:19 +01008112 key_share_step = is_x1 ?
8113 PSA_JPAKE_X1_STEP_KEY_SHARE :
8114 PSA_JPAKE_X2_STEP_KEY_SHARE;
David Horstmann5da95602023-06-08 15:37:12 +01008115 } else if (stage->round == PSA_JPAKE_SECOND) {
David Horstmann74a3d8c2023-06-14 18:28:19 +01008116 key_share_step = (stage->io_mode == PSA_JPAKE_OUTPUT) ?
8117 PSA_JPAKE_X2S_STEP_KEY_SHARE :
8118 PSA_JPAKE_X4S_STEP_KEY_SHARE;
8119 } else {
8120 return PSA_JPAKE_STEP_INVALID;
Przemek Stekielb09c4872023-01-17 12:05:38 +01008121 }
Agathiyan Bragadeesh387bfa52023-07-17 17:01:33 +01008122 return (psa_crypto_driver_pake_step_t) (key_share_step + stage->step - PSA_PAKE_STEP_KEY_SHARE);
Przemek Stekielb09c4872023-01-17 12:05:38 +01008123}
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008124#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekielb09c4872023-01-17 12:05:38 +01008125
Przemek Stekiel2797d372022-12-22 11:19:22 +01008126static psa_status_t psa_pake_complete_inputs(
8127 psa_pake_operation_t *operation)
8128{
Przemek Stekiel2797d372022-12-22 11:19:22 +01008129 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel18620a32023-01-17 16:34:52 +01008130 /* Create copy of the inputs on stack as inputs share memory
8131 with the driver context which will be setup by the driver. */
8132 psa_crypto_driver_pake_inputs_t inputs = operation->data.inputs;
Przemek Stekiel2797d372022-12-22 11:19:22 +01008133
Przemek Stekielfde11282023-03-13 16:06:09 +01008134 if (inputs.password_len == 0) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01008135 return PSA_ERROR_BAD_STATE;
8136 }
8137
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008138 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekielfde11282023-03-13 16:06:09 +01008139 if (inputs.user_len == 0 || inputs.peer_len == 0) {
8140 return PSA_ERROR_BAD_STATE;
8141 }
Przemek Stekieldff21d32023-02-14 20:09:10 +01008142 }
8143
Przemek Stekiel18620a32023-01-17 16:34:52 +01008144 /* Clear driver context */
8145 mbedtls_platform_zeroize(&operation->data, sizeof(operation->data));
8146
8147 status = psa_driver_wrapper_pake_setup(operation, &inputs);
Przemek Stekiel2797d372022-12-22 11:19:22 +01008148
8149 /* Driver is responsible for creating its own copy of the password. */
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01008150 mbedtls_zeroize_and_free(inputs.password, inputs.password_len);
Przemek Stekiel2797d372022-12-22 11:19:22 +01008151
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008152 /* User and peer are translated to role. */
8153 mbedtls_free(inputs.user);
8154 mbedtls_free(inputs.peer);
8155
Przemek Stekiel2797d372022-12-22 11:19:22 +01008156 if (status == PSA_SUCCESS) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008157#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiel2797d372022-12-22 11:19:22 +01008158 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekield93de322023-02-24 08:39:04 +01008159 operation->stage = PSA_PAKE_OPERATION_STAGE_COMPUTATION;
Przemek Stekiel80a88492023-02-20 13:32:22 +01008160 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008161#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01008162 {
8163 status = PSA_ERROR_NOT_SUPPORTED;
Przemek Stekiel2797d372022-12-22 11:19:22 +01008164 }
Przemek Stekiel2797d372022-12-22 11:19:22 +01008165 }
Przemek Stekiel2797d372022-12-22 11:19:22 +01008166 return status;
8167}
8168
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008169#if defined(PSA_WANT_ALG_JPAKE)
David Horstmanne7f21e62023-05-12 18:17:21 +01008170static psa_status_t psa_jpake_prologue(
Przemek Stekiele12ed362022-12-21 12:54:46 +01008171 psa_pake_operation_t *operation,
David Horstmanne7f21e62023-05-12 18:17:21 +01008172 psa_pake_step_t step,
David Horstmann00ad6bf2023-06-14 15:44:24 +01008173 psa_jpake_io_mode_t io_mode)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008174{
Przemek Stekiele12ed362022-12-21 12:54:46 +01008175 if (step != PSA_PAKE_STEP_KEY_SHARE &&
8176 step != PSA_PAKE_STEP_ZK_PUBLIC &&
8177 step != PSA_PAKE_STEP_ZK_PROOF) {
8178 return PSA_ERROR_INVALID_ARGUMENT;
8179 }
8180
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008181 psa_jpake_computation_stage_t *computation_stage =
8182 &operation->computation_stage.jpake;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008183
David Horstmann5da95602023-06-08 15:37:12 +01008184 if (computation_stage->round != PSA_JPAKE_FIRST &&
8185 computation_stage->round != PSA_JPAKE_SECOND) {
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008186 return PSA_ERROR_BAD_STATE;
8187 }
8188
David Horstmanne7f21e62023-05-12 18:17:21 +01008189 /* Check that the step we are given is the one we were expecting */
8190 if (step != computation_stage->step) {
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008191 return PSA_ERROR_BAD_STATE;
8192 }
8193
David Horstmanne7f21e62023-05-12 18:17:21 +01008194 if (step == PSA_PAKE_STEP_KEY_SHARE &&
8195 computation_stage->inputs == 0 &&
8196 computation_stage->outputs == 0) {
8197 /* Start of the round, so function decides whether we are inputting
8198 * or outputting */
David Horstmann024e5c52023-06-14 15:48:21 +01008199 computation_stage->io_mode = io_mode;
8200 } else if (computation_stage->io_mode != io_mode) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008201 /* Middle of the round so the mode we are in must match the function
8202 * called by the user */
8203 return PSA_ERROR_BAD_STATE;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008204 }
8205
8206 return PSA_SUCCESS;
8207}
8208
David Horstmanne7f21e62023-05-12 18:17:21 +01008209static psa_status_t psa_jpake_epilogue(
8210 psa_pake_operation_t *operation,
David Horstmann00ad6bf2023-06-14 15:44:24 +01008211 psa_jpake_io_mode_t io_mode)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008212{
David Horstmanne7f21e62023-05-12 18:17:21 +01008213 psa_jpake_computation_stage_t *stage =
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008214 &operation->computation_stage.jpake;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008215
David Horstmanne7f21e62023-05-12 18:17:21 +01008216 if (stage->step == PSA_PAKE_STEP_ZK_PROOF) {
8217 /* End of an input/output */
David Horstmann00ad6bf2023-06-14 15:44:24 +01008218 if (io_mode == PSA_JPAKE_INPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008219 stage->inputs++;
David Horstmann246ec5a2023-06-27 10:33:06 +01008220 if (stage->inputs == PSA_JPAKE_EXPECTED_INPUTS(stage->round)) {
David Horstmann024e5c52023-06-14 15:48:21 +01008221 stage->io_mode = PSA_JPAKE_OUTPUT;
David Horstmanne7f21e62023-05-12 18:17:21 +01008222 }
8223 }
David Horstmann00ad6bf2023-06-14 15:44:24 +01008224 if (io_mode == PSA_JPAKE_OUTPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008225 stage->outputs++;
David Horstmann246ec5a2023-06-27 10:33:06 +01008226 if (stage->outputs == PSA_JPAKE_EXPECTED_OUTPUTS(stage->round)) {
David Horstmann024e5c52023-06-14 15:48:21 +01008227 stage->io_mode = PSA_JPAKE_INPUT;
David Horstmanne7f21e62023-05-12 18:17:21 +01008228 }
8229 }
David Horstmann246ec5a2023-06-27 10:33:06 +01008230 if (stage->inputs == PSA_JPAKE_EXPECTED_INPUTS(stage->round) &&
8231 stage->outputs == PSA_JPAKE_EXPECTED_OUTPUTS(stage->round)) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008232 /* End of a round, move to the next round */
8233 stage->inputs = 0;
8234 stage->outputs = 0;
8235 stage->round++;
8236 }
8237 stage->step = PSA_PAKE_STEP_KEY_SHARE;
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008238 } else {
David Horstmanne7f21e62023-05-12 18:17:21 +01008239 stage->step++;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008240 }
Przemek Stekiele12ed362022-12-21 12:54:46 +01008241 return PSA_SUCCESS;
8242}
David Horstmanne7f21e62023-05-12 18:17:21 +01008243
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008244#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008245
Neil Armstronga7d08c32022-06-01 18:21:20 +02008246psa_status_t psa_pake_output(
8247 psa_pake_operation_t *operation,
8248 psa_pake_step_t step,
8249 uint8_t *output,
8250 size_t output_size,
8251 size_t *output_length)
8252{
Przemek Stekiel51eac532022-12-07 11:04:51 +01008253 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008254 psa_crypto_driver_pake_step_t driver_step = PSA_JPAKE_STEP_INVALID;
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008255 *output_length = 0;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008256
8257 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01008258 status = psa_pake_complete_inputs(operation);
8259 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008260 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008261 }
8262 }
8263
8264 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008265 status = PSA_ERROR_BAD_STATE;
8266 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008267 }
8268
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008269 if (output_size == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008270 status = PSA_ERROR_INVALID_ARGUMENT;
8271 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008272 }
8273
Przemek Stekiele12ed362022-12-21 12:54:46 +01008274 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008275#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008276 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008277 status = psa_jpake_prologue(operation, step, PSA_JPAKE_OUTPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008278 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008279 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008280 }
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008281 driver_step = convert_jpake_computation_stage_to_driver_step(
8282 &operation->computation_stage.jpake);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008283 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008284#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008285 default:
Przemek Stekiel80a88492023-02-20 13:32:22 +01008286 (void) step;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008287 status = PSA_ERROR_NOT_SUPPORTED;
8288 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008289 }
8290
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008291 status = psa_driver_wrapper_pake_output(operation, driver_step,
8292 output, output_size, output_length);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008293
8294 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008295 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008296 }
8297
8298 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008299#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008300 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008301 status = psa_jpake_epilogue(operation, PSA_JPAKE_OUTPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008302 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008303 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008304 }
8305 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008306#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008307 default:
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008308 status = PSA_ERROR_NOT_SUPPORTED;
8309 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008310 }
8311
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008312 return PSA_SUCCESS;
8313exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008314 psa_pake_abort(operation);
8315 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008316}
8317
8318psa_status_t psa_pake_input(
8319 psa_pake_operation_t *operation,
8320 psa_pake_step_t step,
8321 const uint8_t *input,
8322 size_t input_length)
8323{
Przemek Stekiel51eac532022-12-07 11:04:51 +01008324 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008325 psa_crypto_driver_pake_step_t driver_step = PSA_JPAKE_STEP_INVALID;
Przemek Stekiel256c75d2023-03-23 14:09:34 +01008326 const size_t max_input_length = (size_t) PSA_PAKE_INPUT_SIZE(operation->alg,
8327 operation->primitive,
8328 step);
Przemek Stekiel51eac532022-12-07 11:04:51 +01008329
8330 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01008331 status = psa_pake_complete_inputs(operation);
8332 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008333 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008334 }
8335 }
8336
8337 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008338 status = PSA_ERROR_BAD_STATE;
8339 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008340 }
8341
Przemek Stekiel256c75d2023-03-23 14:09:34 +01008342 if (input_length == 0 || input_length > max_input_length) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008343 status = PSA_ERROR_INVALID_ARGUMENT;
8344 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008345 }
8346
Przemek Stekiele12ed362022-12-21 12:54:46 +01008347 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008348#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008349 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008350 status = psa_jpake_prologue(operation, step, PSA_JPAKE_INPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008351 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008352 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008353 }
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008354 driver_step = convert_jpake_computation_stage_to_driver_step(
8355 &operation->computation_stage.jpake);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008356 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008357#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008358 default:
Przemek Stekiel80a88492023-02-20 13:32:22 +01008359 (void) step;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008360 status = PSA_ERROR_NOT_SUPPORTED;
8361 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008362 }
8363
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008364 status = psa_driver_wrapper_pake_input(operation, driver_step,
8365 input, input_length);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008366
8367 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008368 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008369 }
8370
8371 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008372#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008373 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008374 status = psa_jpake_epilogue(operation, PSA_JPAKE_INPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008375 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008376 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008377 }
8378 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008379#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008380 default:
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008381 status = PSA_ERROR_NOT_SUPPORTED;
8382 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008383 }
8384
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008385 return PSA_SUCCESS;
8386exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008387 psa_pake_abort(operation);
8388 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008389}
8390
8391psa_status_t psa_pake_get_implicit_key(
8392 psa_pake_operation_t *operation,
8393 psa_key_derivation_operation_t *output)
8394{
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008395 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008396 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel251e86a2023-02-17 14:30:50 +01008397 uint8_t shared_key[MBEDTLS_PSA_JPAKE_BUFFER_SIZE];
Przemek Stekiel0c781802022-11-29 14:53:13 +01008398 size_t shared_key_len = 0;
8399
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008400 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008401 status = PSA_ERROR_BAD_STATE;
8402 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008403 }
8404
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008405#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008406 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008407 psa_jpake_computation_stage_t *computation_stage =
Przemek Stekiel083745e2023-02-23 17:28:23 +01008408 &operation->computation_stage.jpake;
David Horstmann5da95602023-06-08 15:37:12 +01008409 if (computation_stage->round != PSA_JPAKE_FINISHED) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008410 status = PSA_ERROR_BAD_STATE;
8411 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008412 }
Przemek Stekiel80a88492023-02-20 13:32:22 +01008413 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008414#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01008415 {
8416 status = PSA_ERROR_NOT_SUPPORTED;
8417 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008418 }
8419
Przemek Stekiel0c781802022-11-29 14:53:13 +01008420 status = psa_driver_wrapper_pake_get_implicit_key(operation,
8421 shared_key,
Przemek Stekiel6b648622023-02-19 22:55:33 +01008422 sizeof(shared_key),
Przemek Stekiel0c781802022-11-29 14:53:13 +01008423 &shared_key_len);
8424
8425 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008426 goto exit;
Przemek Stekiel0c781802022-11-29 14:53:13 +01008427 }
8428
8429 status = psa_key_derivation_input_bytes(output,
8430 PSA_KEY_DERIVATION_INPUT_SECRET,
8431 shared_key,
8432 shared_key_len);
8433
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008434 mbedtls_platform_zeroize(shared_key, sizeof(shared_key));
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008435exit:
8436 abort_status = psa_pake_abort(operation);
8437 return status == PSA_SUCCESS ? abort_status : status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008438}
8439
8440psa_status_t psa_pake_abort(
8441 psa_pake_operation_t *operation)
8442{
Przemek Stekield69dca92023-01-31 19:59:20 +01008443 psa_status_t status = PSA_SUCCESS;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008444
Przemek Stekield69dca92023-01-31 19:59:20 +01008445 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008446 status = psa_driver_wrapper_pake_abort(operation);
Neil Armstrong5ae60962022-09-15 11:29:46 +02008447 }
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008448
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008449 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
8450 if (operation->data.inputs.password != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01008451 mbedtls_zeroize_and_free(operation->data.inputs.password,
Przemek Stekielaa183422023-03-06 14:21:44 +01008452 operation->data.inputs.password_len);
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008453 }
8454 if (operation->data.inputs.user != NULL) {
8455 mbedtls_free(operation->data.inputs.user);
8456 }
8457 if (operation->data.inputs.peer != NULL) {
8458 mbedtls_free(operation->data.inputs.peer);
8459 }
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008460 }
Przemek Stekield69dca92023-01-31 19:59:20 +01008461 memset(operation, 0, sizeof(psa_pake_operation_t));
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008462
Przemek Stekield69dca92023-01-31 19:59:20 +01008463 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008464}
Tom Cosgrove6d62fac2023-05-10 14:40:05 +01008465#endif /* PSA_WANT_ALG_SOME_PAKE */
Neil Armstronga7d08c32022-06-01 18:21:20 +02008466
Gilles Peskinee59236f2018-01-27 23:32:46 +01008467#endif /* MBEDTLS_PSA_CRYPTO_C */