blob: 0fe1fbccf10e56abb6fb47029599855bdb3b5dea [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;
Gilles Peskine2f107ae2024-02-28 01:26:46 +0100571 psa_key_type_t type = attributes->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 Peskine2f107ae2024-02-28 01:26:46 +0100581 status = psa_validate_unstructured_key_bit_size(attributes->type,
Gilles Peskine449bd832023-01-11 14:50:10 +0100582 *bits);
583 if (status != PSA_SUCCESS) {
584 return status;
585 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200586
Ronald Crondd04d422020-11-28 15:14:42 +0100587 /* Copy the key material. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100588 memcpy(key_buffer, data, data_length);
Ronald Crondd04d422020-11-28 15:14:42 +0100589 *key_buffer_length = data_length;
Gilles Peskine449bd832023-01-11 14:50:10 +0100590 (void) key_buffer_size;
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200591
Gilles Peskine449bd832023-01-11 14:50:10 +0100592 return PSA_SUCCESS;
593 } else if (PSA_KEY_TYPE_IS_ASYMMETRIC(type)) {
Valerio Settia55f0422023-07-10 15:34:41 +0200594#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_IMPORT) || \
Przemek Stekiel6d85afa2023-04-28 11:42:17 +0200595 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY)
Przemek Stekiel472b3f32022-12-01 14:38:49 +0100596 if (PSA_KEY_TYPE_IS_DH(type)) {
Przemek Stekield1cf1ba2023-04-27 12:04:21 +0200597 if (psa_is_dh_key_size_valid(PSA_BYTES_TO_BITS(data_length)) == 0) {
Valerio Setti504a1022024-01-17 15:19:30 +0100598 return PSA_ERROR_NOT_SUPPORTED;
Przemek Stekiel472b3f32022-12-01 14:38:49 +0100599 }
Przemek Stekiel33c91eb2023-05-30 15:16:35 +0200600 return mbedtls_psa_ffdh_import_key(attributes,
601 data, data_length,
602 key_buffer, key_buffer_size,
603 key_buffer_length,
604 bits);
Przemek Stekiel472b3f32022-12-01 14:38:49 +0100605 }
Valerio Settia55f0422023-07-10 15:34:41 +0200606#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_IMPORT) ||
Przemek Stekiel6d85afa2023-04-28 11:42:17 +0200607 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY) */
Valerio Setti27c501a2023-06-27 16:58:52 +0200608#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_IMPORT) || \
Gilles Peskine449bd832023-01-11 14:50:10 +0100609 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
610 if (PSA_KEY_TYPE_IS_ECC(type)) {
611 return mbedtls_psa_ecp_import_key(attributes,
612 data, data_length,
613 key_buffer, key_buffer_size,
614 key_buffer_length,
615 bits);
Steven Cooreman40120f62020-10-29 11:42:22 +0100616 }
Valerio Setti27c501a2023-06-27 16:58:52 +0200617#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_IMPORT) ||
John Durkop9814fa22020-11-04 12:28:15 -0800618 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
Valerio Settife478902023-07-25 12:27:19 +0200619#if (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) && \
620 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) || \
Gilles Peskine449bd832023-01-11 14:50:10 +0100621 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
622 if (PSA_KEY_TYPE_IS_RSA(type)) {
623 return mbedtls_psa_rsa_import_key(attributes,
624 data, data_length,
625 key_buffer, key_buffer_size,
626 key_buffer_length,
627 bits);
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200628 }
Valerio Settife478902023-07-25 12:27:19 +0200629#endif /* (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) &&
630 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) ||
John Durkop9814fa22020-11-04 12:28:15 -0800631 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100632 }
Steven Cooreman40120f62020-10-29 11:42:22 +0100633
Gilles Peskine449bd832023-01-11 14:50:10 +0100634 return PSA_ERROR_NOT_SUPPORTED;
Darryl Green06fd18d2018-07-16 11:21:11 +0100635}
636
Gilles Peskinef603c712019-01-19 13:40:11 +0100637/** Calculate the intersection of two algorithm usage policies.
638 *
639 * Return 0 (which allows no operation) on incompatibility.
640 */
641static psa_algorithm_t psa_key_policy_algorithm_intersection(
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100642 psa_key_type_t key_type,
Gilles Peskinef603c712019-01-19 13:40:11 +0100643 psa_algorithm_t alg1,
Gilles Peskine449bd832023-01-11 14:50:10 +0100644 psa_algorithm_t alg2)
Gilles Peskinef603c712019-01-19 13:40:11 +0100645{
Gilles Peskine549ea862019-05-22 11:45:59 +0200646 /* Common case: both sides actually specify the same policy. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100647 if (alg1 == alg2) {
648 return alg1;
649 }
Steven Cooreman03488022021-02-18 12:07:20 +0100650 /* If the policies are from the same hash-and-sign family, check
651 * if one is a wildcard. If so the other has the specific algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100652 if (PSA_ALG_IS_SIGN_HASH(alg1) &&
653 PSA_ALG_IS_SIGN_HASH(alg2) &&
654 (alg1 & ~PSA_ALG_HASH_MASK) == (alg2 & ~PSA_ALG_HASH_MASK)) {
655 if (PSA_ALG_SIGN_GET_HASH(alg1) == PSA_ALG_ANY_HASH) {
656 return alg2;
657 }
658 if (PSA_ALG_SIGN_GET_HASH(alg2) == PSA_ALG_ANY_HASH) {
659 return alg1;
660 }
Steven Cooreman03488022021-02-18 12:07:20 +0100661 }
662 /* If the policies are from the same AEAD family, check whether
Steven Cooreman7de9e2d2021-02-22 17:05:56 +0100663 * one of them is a minimum-tag-length wildcard. Calculate the most
Steven Cooreman03488022021-02-18 12:07:20 +0100664 * restrictive tag length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100665 if (PSA_ALG_IS_AEAD(alg1) && PSA_ALG_IS_AEAD(alg2) &&
666 (PSA_ALG_AEAD_WITH_SHORTENED_TAG(alg1, 0) ==
667 PSA_ALG_AEAD_WITH_SHORTENED_TAG(alg2, 0))) {
668 size_t alg1_len = PSA_ALG_AEAD_GET_TAG_LENGTH(alg1);
669 size_t alg2_len = PSA_ALG_AEAD_GET_TAG_LENGTH(alg2);
Steven Cooremancd640932021-03-08 12:00:27 +0100670 size_t restricted_len = alg1_len > alg2_len ? alg1_len : alg2_len;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100671
Steven Cooreman7de9e2d2021-02-22 17:05:56 +0100672 /* If both are wildcards, return most restrictive wildcard */
Gilles Peskine449bd832023-01-11 14:50:10 +0100673 if (((alg1 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0) &&
674 ((alg2 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0)) {
675 return PSA_ALG_AEAD_WITH_AT_LEAST_THIS_LENGTH_TAG(
676 alg1, restricted_len);
Steven Cooreman03488022021-02-18 12:07:20 +0100677 }
678 /* If only one is a wildcard, return specific algorithm if compatible. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100679 if (((alg1 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0) &&
680 (alg1_len <= alg2_len)) {
681 return alg2;
Steven Cooreman03488022021-02-18 12:07:20 +0100682 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100683 if (((alg2 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0) &&
684 (alg2_len <= alg1_len)) {
685 return alg1;
Steven Cooreman03488022021-02-18 12:07:20 +0100686 }
687 }
688 /* If the policies are from the same MAC family, check whether one
689 * of them is a minimum-MAC-length policy. Calculate the most
690 * restrictive tag length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100691 if (PSA_ALG_IS_MAC(alg1) && PSA_ALG_IS_MAC(alg2) &&
692 (PSA_ALG_FULL_LENGTH_MAC(alg1) ==
693 PSA_ALG_FULL_LENGTH_MAC(alg2))) {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100694 /* Validate the combination of key type and algorithm. Since the base
695 * algorithm of alg1 and alg2 are the same, we only need this once. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100696 if (PSA_SUCCESS != psa_mac_key_can_do(alg1, key_type)) {
697 return 0;
698 }
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100699
Steven Cooreman31a876d2021-03-03 20:47:40 +0100700 /* Get the (exact or at-least) output lengths for both sides of the
701 * requested intersection. None of the currently supported algorithms
702 * have an output length dependent on the actual key size, so setting it
703 * to a bogus value of 0 is currently OK.
704 *
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100705 * Note that for at-least-this-length wildcard algorithms, the output
706 * length is set to the shortest allowed length, which allows us to
707 * calculate the most restrictive tag length for the intersection. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100708 size_t alg1_len = PSA_MAC_LENGTH(key_type, 0, alg1);
709 size_t alg2_len = PSA_MAC_LENGTH(key_type, 0, alg2);
Steven Cooremancd640932021-03-08 12:00:27 +0100710 size_t restricted_len = alg1_len > alg2_len ? alg1_len : alg2_len;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100711
Steven Cooremana1d83222021-02-25 10:20:29 +0100712 /* If both are wildcards, return most restrictive wildcard */
Gilles Peskine449bd832023-01-11 14:50:10 +0100713 if (((alg1 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0) &&
714 ((alg2 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0)) {
715 return PSA_ALG_AT_LEAST_THIS_LENGTH_MAC(alg1, restricted_len);
Steven Cooreman03488022021-02-18 12:07:20 +0100716 }
Steven Cooreman31a876d2021-03-03 20:47:40 +0100717
718 /* If only one is an at-least-this-length policy, the intersection would
719 * be the other (fixed-length) policy as long as said fixed length is
720 * equal to or larger than the shortest allowed length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100721 if ((alg1 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0) {
722 return (alg1_len <= alg2_len) ? alg2 : 0;
Steven Cooreman03488022021-02-18 12:07:20 +0100723 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100724 if ((alg2 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0) {
725 return (alg2_len <= alg1_len) ? alg1 : 0;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100726 }
Steven Cooreman31a876d2021-03-03 20:47:40 +0100727
Steven Cooremancd640932021-03-08 12:00:27 +0100728 /* If none of them are wildcards, check whether they define the same tag
729 * length. This is still possible here when one is default-length and
730 * the other specific-length. Ensure to always return the
731 * specific-length version for the intersection. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100732 if (alg1_len == alg2_len) {
733 return PSA_ALG_TRUNCATED_MAC(alg1, alg1_len);
734 }
Gilles Peskinef603c712019-01-19 13:40:11 +0100735 }
736 /* If the policies are incompatible, allow nothing. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100737 return 0;
Gilles Peskinef603c712019-01-19 13:40:11 +0100738}
739
Gilles Peskine449bd832023-01-11 14:50:10 +0100740static int psa_key_algorithm_permits(psa_key_type_t key_type,
741 psa_algorithm_t policy_alg,
742 psa_algorithm_t requested_alg)
Gilles Peskined6f371b2019-05-10 19:33:38 +0200743{
Gilles Peskine549ea862019-05-22 11:45:59 +0200744 /* Common case: the policy only allows requested_alg. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100745 if (requested_alg == policy_alg) {
746 return 1;
747 }
Steven Cooreman03488022021-02-18 12:07:20 +0100748 /* If policy_alg is a hash-and-sign with a wildcard for the hash,
749 * and requested_alg is the same hash-and-sign family with any hash,
750 * then requested_alg is compliant with policy_alg. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100751 if (PSA_ALG_IS_SIGN_HASH(requested_alg) &&
752 PSA_ALG_SIGN_GET_HASH(policy_alg) == PSA_ALG_ANY_HASH) {
753 return (policy_alg & ~PSA_ALG_HASH_MASK) ==
754 (requested_alg & ~PSA_ALG_HASH_MASK);
Steven Cooreman03488022021-02-18 12:07:20 +0100755 }
756 /* If policy_alg is a wildcard AEAD algorithm of the same base as
757 * the requested algorithm, check the requested tag length to be
758 * equal-length or longer than the wildcard-specified length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100759 if (PSA_ALG_IS_AEAD(policy_alg) &&
760 PSA_ALG_IS_AEAD(requested_alg) &&
761 (PSA_ALG_AEAD_WITH_SHORTENED_TAG(policy_alg, 0) ==
762 PSA_ALG_AEAD_WITH_SHORTENED_TAG(requested_alg, 0)) &&
763 ((policy_alg & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0)) {
764 return PSA_ALG_AEAD_GET_TAG_LENGTH(policy_alg) <=
765 PSA_ALG_AEAD_GET_TAG_LENGTH(requested_alg);
Steven Cooreman03488022021-02-18 12:07:20 +0100766 }
Steven Cooremancd640932021-03-08 12:00:27 +0100767 /* If policy_alg is a MAC algorithm of the same base as the requested
768 * algorithm, check whether their MAC lengths are compatible. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100769 if (PSA_ALG_IS_MAC(policy_alg) &&
770 PSA_ALG_IS_MAC(requested_alg) &&
771 (PSA_ALG_FULL_LENGTH_MAC(policy_alg) ==
772 PSA_ALG_FULL_LENGTH_MAC(requested_alg))) {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100773 /* Validate the combination of key type and algorithm. Since the policy
774 * and requested algorithms are the same, we only need this once. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100775 if (PSA_SUCCESS != psa_mac_key_can_do(policy_alg, key_type)) {
776 return 0;
777 }
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100778
Steven Cooreman31a876d2021-03-03 20:47:40 +0100779 /* Get both the requested output length for the algorithm which is to be
780 * verified, and the default output length for the base algorithm.
781 * Note that none of the currently supported algorithms have an output
782 * length dependent on actual key size, so setting it to a bogus value
783 * of 0 is currently OK. */
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100784 size_t requested_output_length = PSA_MAC_LENGTH(
Gilles Peskine449bd832023-01-11 14:50:10 +0100785 key_type, 0, requested_alg);
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100786 size_t default_output_length = PSA_MAC_LENGTH(
Gilles Peskine449bd832023-01-11 14:50:10 +0100787 key_type, 0,
788 PSA_ALG_FULL_LENGTH_MAC(requested_alg));
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100789
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100790 /* If the policy is default-length, only allow an algorithm with
791 * a declared exact-length matching the default. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100792 if (PSA_MAC_TRUNCATED_LENGTH(policy_alg) == 0) {
793 return requested_output_length == default_output_length;
794 }
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100795
796 /* If the requested algorithm is default-length, allow it if the policy
Steven Cooremancd640932021-03-08 12:00:27 +0100797 * length exactly matches the default length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100798 if (PSA_MAC_TRUNCATED_LENGTH(requested_alg) == 0 &&
799 PSA_MAC_TRUNCATED_LENGTH(policy_alg) == default_output_length) {
800 return 1;
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100801 }
802
Steven Cooremancd640932021-03-08 12:00:27 +0100803 /* If policy_alg is an at-least-this-length wildcard MAC algorithm,
804 * check for the requested MAC length to be equal to or longer than the
805 * minimum allowed length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100806 if ((policy_alg & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0) {
807 return PSA_MAC_TRUNCATED_LENGTH(policy_alg) <=
808 requested_output_length;
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100809 }
Gilles Peskined6f371b2019-05-10 19:33:38 +0200810 }
Steven Cooremance48e852020-10-05 16:02:45 +0200811 /* If policy_alg is a generic key agreement operation, then using it for
Steven Cooremanfa5e6312020-10-15 17:07:12 +0200812 * a key derivation with that key agreement should also be allowed. This
813 * behaviour is expected to be defined in a future specification version. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100814 if (PSA_ALG_IS_RAW_KEY_AGREEMENT(policy_alg) &&
815 PSA_ALG_IS_KEY_AGREEMENT(requested_alg)) {
816 return PSA_ALG_KEY_AGREEMENT_GET_BASE(requested_alg) ==
817 policy_alg;
Steven Cooremance48e852020-10-05 16:02:45 +0200818 }
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100819 /* If it isn't explicitly permitted, it's forbidden. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100820 return 0;
Gilles Peskined6f371b2019-05-10 19:33:38 +0200821}
822
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100823/** Test whether a policy permits an algorithm.
824 *
825 * The caller must test usage flags separately.
Steven Cooreman7e39f052021-02-23 14:18:32 +0100826 *
Steven Cooreman5a172672021-03-02 21:27:42 +0100827 * \note This function requires providing the key type for which the policy is
828 * being validated, since some algorithm policy definitions (e.g. MAC)
829 * have different properties depending on what kind of cipher it is
830 * combined with.
831 *
Steven Cooreman7e39f052021-02-23 14:18:32 +0100832 * \retval PSA_SUCCESS When \p alg is a specific algorithm
833 * allowed by the \p policy.
834 * \retval PSA_ERROR_INVALID_ARGUMENT When \p alg is not a specific algorithm
835 * \retval PSA_ERROR_NOT_PERMITTED When \p alg is a specific algorithm, but
836 * the \p policy does not allow it.
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100837 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100838static psa_status_t psa_key_policy_permits(const psa_key_policy_t *policy,
839 psa_key_type_t key_type,
840 psa_algorithm_t alg)
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100841{
Steven Cooremand788fab2021-02-25 11:29:17 +0100842 /* '0' is not a valid algorithm */
Gilles Peskine449bd832023-01-11 14:50:10 +0100843 if (alg == 0) {
844 return PSA_ERROR_INVALID_ARGUMENT;
845 }
Steven Cooremand788fab2021-02-25 11:29:17 +0100846
Steven Cooreman7e39f052021-02-23 14:18:32 +0100847 /* A requested algorithm cannot be a wildcard. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100848 if (PSA_ALG_IS_WILDCARD(alg)) {
849 return PSA_ERROR_INVALID_ARGUMENT;
850 }
Steven Cooreman7e39f052021-02-23 14:18:32 +0100851
Gilles Peskine449bd832023-01-11 14:50:10 +0100852 if (psa_key_algorithm_permits(key_type, policy->alg, alg) ||
853 psa_key_algorithm_permits(key_type, policy->alg2, alg)) {
854 return PSA_SUCCESS;
855 } else {
856 return PSA_ERROR_NOT_PERMITTED;
857 }
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100858}
859
Gilles Peskinef603c712019-01-19 13:40:11 +0100860/** Restrict a key policy based on a constraint.
861 *
Steven Cooreman5a172672021-03-02 21:27:42 +0100862 * \note This function requires providing the key type for which the policy is
863 * being restricted, since some algorithm policy definitions (e.g. MAC)
864 * have different properties depending on what kind of cipher it is
865 * combined with.
866 *
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100867 * \param[in] key_type The key type for which to restrict the policy
Gilles Peskinef603c712019-01-19 13:40:11 +0100868 * \param[in,out] policy The policy to restrict.
869 * \param[in] constraint The policy constraint to apply.
870 *
871 * \retval #PSA_SUCCESS
872 * \c *policy contains the intersection of the original value of
873 * \c *policy and \c *constraint.
874 * \retval #PSA_ERROR_INVALID_ARGUMENT
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100875 * \c key_type, \c *policy and \c *constraint are incompatible.
Gilles Peskinef603c712019-01-19 13:40:11 +0100876 * \c *policy is unchanged.
877 */
878static psa_status_t psa_restrict_key_policy(
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100879 psa_key_type_t key_type,
Gilles Peskinef603c712019-01-19 13:40:11 +0100880 psa_key_policy_t *policy,
Gilles Peskine449bd832023-01-11 14:50:10 +0100881 const psa_key_policy_t *constraint)
Gilles Peskinef603c712019-01-19 13:40:11 +0100882{
883 psa_algorithm_t intersection_alg =
Gilles Peskine449bd832023-01-11 14:50:10 +0100884 psa_key_policy_algorithm_intersection(key_type, policy->alg,
885 constraint->alg);
Gilles Peskined6f371b2019-05-10 19:33:38 +0200886 psa_algorithm_t intersection_alg2 =
Gilles Peskine449bd832023-01-11 14:50:10 +0100887 psa_key_policy_algorithm_intersection(key_type, policy->alg2,
888 constraint->alg2);
889 if (intersection_alg == 0 && policy->alg != 0 && constraint->alg != 0) {
890 return PSA_ERROR_INVALID_ARGUMENT;
891 }
892 if (intersection_alg2 == 0 && policy->alg2 != 0 && constraint->alg2 != 0) {
893 return PSA_ERROR_INVALID_ARGUMENT;
894 }
Gilles Peskinef603c712019-01-19 13:40:11 +0100895 policy->usage &= constraint->usage;
896 policy->alg = intersection_alg;
Gilles Peskined6f371b2019-05-10 19:33:38 +0200897 policy->alg2 = intersection_alg2;
Gilles Peskine449bd832023-01-11 14:50:10 +0100898 return PSA_SUCCESS;
Gilles Peskinef603c712019-01-19 13:40:11 +0100899}
900
Przemek Stekiel061f6942022-11-30 10:51:35 +0100901/** Get the description of a key given its identifier and policy constraints
902 * and lock it.
903 *
904 * The key must have allow all the usage flags set in \p usage. If \p alg is
905 * nonzero, the key must allow operations with this algorithm. If \p alg is
906 * zero, the algorithm is not checked.
907 *
908 * In case of a persistent key, the function loads the description of the key
909 * into a key slot if not already done.
910 *
Ryan Everett098c6652024-01-03 13:03:36 +0000911 * On success, the returned key slot has been registered for reading.
Ryan Everett93cea572024-02-20 18:01:29 +0000912 * It is the responsibility of the caller to then unregister
913 * once they have finished reading the contents of the slot.
914 * The caller unregisters by calling psa_unregister_read() or
915 * psa_unregister_read_under_mutex(). psa_unregister_read() must be called
916 * if and only if the caller already holds the global key slot mutex
917 * (when mutexes are enabled). psa_unregister_read_under_mutex() encapsulates
918 * the unregister with mutex lock and unlock operations.
Przemek Stekiel061f6942022-11-30 10:51:35 +0100919 */
920static psa_status_t psa_get_and_lock_key_slot_with_policy(
Ronald Cron5c522922020-11-14 16:35:34 +0100921 mbedtls_svc_key_id_t key,
922 psa_key_slot_t **p_slot,
923 psa_key_usage_t usage,
Gilles Peskine449bd832023-01-11 14:50:10 +0100924 psa_algorithm_t alg)
Darryl Green06fd18d2018-07-16 11:21:11 +0100925{
Ronald Cronf95a2b12020-10-22 15:24:49 +0200926 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel9a5b8122022-12-22 13:34:47 +0100927 psa_key_slot_t *slot = NULL;
Darryl Green06fd18d2018-07-16 11:21:11 +0100928
Gilles Peskine449bd832023-01-11 14:50:10 +0100929 status = psa_get_and_lock_key_slot(key, p_slot);
930 if (status != PSA_SUCCESS) {
931 return status;
932 }
Ronald Cronf95a2b12020-10-22 15:24:49 +0200933 slot = *p_slot;
Darryl Green06fd18d2018-07-16 11:21:11 +0100934
935 /* Enforce that usage policy for the key slot contains all the flags
936 * required by the usage parameter. There is one exception: public
937 * keys can always be exported, so we treat public key objects as
938 * if they had the export flag. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100939 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(slot->attr.type)) {
Darryl Green06fd18d2018-07-16 11:21:11 +0100940 usage &= ~PSA_KEY_USAGE_EXPORT;
Gilles Peskine449bd832023-01-11 14:50:10 +0100941 }
Ronald Cronf95a2b12020-10-22 15:24:49 +0200942
Gilles Peskine449bd832023-01-11 14:50:10 +0100943 if ((slot->attr.policy.usage & usage) != usage) {
Steven Cooreman328f11c2021-03-02 11:44:51 +0100944 status = PSA_ERROR_NOT_PERMITTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +0200945 goto error;
Steven Cooreman328f11c2021-03-02 11:44:51 +0100946 }
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100947
Shaun Case8b0ecbc2021-12-20 21:14:10 -0800948 /* Enforce that the usage policy permits the requested algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100949 if (alg != 0) {
950 status = psa_key_policy_permits(&slot->attr.policy,
951 slot->attr.type,
952 alg);
953 if (status != PSA_SUCCESS) {
Steven Cooreman7e39f052021-02-23 14:18:32 +0100954 goto error;
Gilles Peskine449bd832023-01-11 14:50:10 +0100955 }
Steven Cooreman7e39f052021-02-23 14:18:32 +0100956 }
Darryl Green06fd18d2018-07-16 11:21:11 +0100957
Gilles Peskine449bd832023-01-11 14:50:10 +0100958 return PSA_SUCCESS;
Ronald Cronf95a2b12020-10-22 15:24:49 +0200959
960error:
961 *p_slot = NULL;
Ryan Everettfb792ca2024-01-31 13:40:05 +0000962 psa_unregister_read_under_mutex(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +0200963
Gilles Peskine449bd832023-01-11 14:50:10 +0100964 return status;
Darryl Green06fd18d2018-07-16 11:21:11 +0100965}
Darryl Green940d72c2018-07-13 13:18:51 +0100966
Ronald Cron5c522922020-11-14 16:35:34 +0100967/** Get a key slot containing a transparent key and lock it.
Gilles Peskine28f8f302019-07-24 13:30:31 +0200968 *
969 * A transparent key is a key for which the key material is directly
Ronald Cronddae0f52021-08-24 15:39:44 +0200970 * available, as opposed to a key in a secure element and/or to be used
971 * by a secure element.
Gilles Peskine28f8f302019-07-24 13:30:31 +0200972 *
Ronald Cronddae0f52021-08-24 15:39:44 +0200973 * This is a temporary function that may be used instead of
974 * psa_get_and_lock_key_slot_with_policy() when there is no opaque key support
975 * for a cryptographic operation.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200976 *
Ryan Everett098c6652024-01-03 13:03:36 +0000977 * On success, the returned key slot has been registered for reading.
Ryan Everett93cea572024-02-20 18:01:29 +0000978 * It is the responsibility of the caller to then unregister
979 * once they have finished reading the contents of the slot.
980 * The caller unregisters by calling psa_unregister_read() or
981 * psa_unregister_read_under_mutex(). psa_unregister_read() must be called
982 * if and only if the caller already holds the global key slot mutex
983 * (when mutexes are enabled). psa_unregister_read_under_mutex() encapsulates
984 * psa_unregister_read() with mutex lock and unlock operations.
Gilles Peskine28f8f302019-07-24 13:30:31 +0200985 */
Ronald Cron5c522922020-11-14 16:35:34 +0100986static psa_status_t psa_get_and_lock_transparent_key_slot_with_policy(
987 mbedtls_svc_key_id_t key,
988 psa_key_slot_t **p_slot,
989 psa_key_usage_t usage,
Gilles Peskine449bd832023-01-11 14:50:10 +0100990 psa_algorithm_t alg)
Gilles Peskine28f8f302019-07-24 13:30:31 +0200991{
Gilles Peskine449bd832023-01-11 14:50:10 +0100992 psa_status_t status = psa_get_and_lock_key_slot_with_policy(key, p_slot,
993 usage, alg);
994 if (status != PSA_SUCCESS) {
995 return status;
Gilles Peskine28f8f302019-07-24 13:30:31 +0200996 }
Ronald Cronf95a2b12020-10-22 15:24:49 +0200997
Gilles Peskine449bd832023-01-11 14:50:10 +0100998 if (psa_key_lifetime_is_external((*p_slot)->attr.lifetime)) {
Ryan Everettfb792ca2024-01-31 13:40:05 +0000999 psa_unregister_read_under_mutex(*p_slot);
Gilles Peskine449bd832023-01-11 14:50:10 +01001000 *p_slot = NULL;
1001 return PSA_ERROR_NOT_SUPPORTED;
1002 }
1003
1004 return PSA_SUCCESS;
Gilles Peskine28f8f302019-07-24 13:30:31 +02001005}
Gilles Peskine28f8f302019-07-24 13:30:31 +02001006
Gilles Peskine449bd832023-01-11 14:50:10 +01001007psa_status_t psa_remove_key_data_from_memory(psa_key_slot_t *slot)
Darryl Green40225ba2018-11-15 14:48:15 +00001008{
Gilles Peskine449bd832023-01-11 14:50:10 +01001009 if (slot->key.data != NULL) {
Tom Cosgrove52f7e182023-08-01 09:08:48 +01001010 mbedtls_zeroize_and_free(slot->key.data, slot->key.bytes);
Gilles Peskine449bd832023-01-11 14:50:10 +01001011 }
Ronald Cronea0f8a62020-11-25 17:52:23 +01001012
Ronald Cronea0f8a62020-11-25 17:52:23 +01001013 slot->key.data = NULL;
1014 slot->key.bytes = 0;
Darryl Green40225ba2018-11-15 14:48:15 +00001015
Gilles Peskine449bd832023-01-11 14:50:10 +01001016 return PSA_SUCCESS;
Darryl Green40225ba2018-11-15 14:48:15 +00001017}
1018
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001019/** Completely wipe a slot in memory, including its policy.
1020 * Persistent storage is not affected. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001021psa_status_t psa_wipe_key_slot(psa_key_slot_t *slot)
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001022{
Gilles Peskine449bd832023-01-11 14:50:10 +01001023 psa_status_t status = psa_remove_key_data_from_memory(slot);
Ronald Cronddd3d052020-10-30 14:07:07 +01001024
Gilles Peskine449bd832023-01-11 14:50:10 +01001025 /*
1026 * As the return error code may not be handled in case of multiple errors,
Ryan Everett7ed542e2024-01-17 11:39:09 +00001027 * do our best to report an unexpected amount of registered readers or
1028 * an unexpected state.
1029 * Assert with MBEDTLS_TEST_HOOK_TEST_ASSERT that the slot is valid for
1030 * wiping.
Gilles Peskine449bd832023-01-11 14:50:10 +01001031 * if the MBEDTLS_TEST_HOOKS configuration option is enabled and the
1032 * function is called as part of the execution of a test suite, the
1033 * execution of the test suite is stopped in error if the assertion fails.
1034 */
Ryan Everett7ed542e2024-01-17 11:39:09 +00001035 switch (slot->state) {
1036 case PSA_SLOT_FULL:
1037 /* In this state psa_wipe_key_slot() must only be called if the
1038 * caller is the last reader. */
1039 case PSA_SLOT_PENDING_DELETION:
1040 /* In this state psa_wipe_key_slot() must only be called if the
1041 * caller is the last reader. */
1042 if (slot->registered_readers != 1) {
1043 MBEDTLS_TEST_HOOK_TEST_ASSERT(slot->registered_readers == 1);
1044 status = PSA_ERROR_CORRUPTION_DETECTED;
1045 }
1046 break;
1047 case PSA_SLOT_FILLING:
1048 /* In this state registered_readers must be 0. */
1049 if (slot->registered_readers != 0) {
1050 MBEDTLS_TEST_HOOK_TEST_ASSERT(slot->registered_readers == 0);
1051 status = PSA_ERROR_CORRUPTION_DETECTED;
1052 }
1053 break;
1054 case PSA_SLOT_EMPTY:
1055 /* The slot is already empty, it cannot be wiped. */
1056 MBEDTLS_TEST_HOOK_TEST_ASSERT(slot->state != PSA_SLOT_EMPTY);
1057 status = PSA_ERROR_CORRUPTION_DETECTED;
1058 break;
1059 default:
1060 /* The slot's state is invalid. */
1061 status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronddd3d052020-10-30 14:07:07 +01001062 }
1063
Gilles Peskine3f7cd622019-08-13 15:01:08 +02001064 /* Multipart operations may still be using the key. This is safe
1065 * because all multipart operation objects are independent from
1066 * the key slot: if they need to access the key after the setup
1067 * phase, they have a copy of the key. Note that this means that
1068 * key material can linger until all operations are completed. */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001069 /* At this point, key material and other type-specific content has
1070 * been wiped. Clear remaining metadata. We can call memset and not
Ryan Everettaa33c512023-12-21 17:32:07 +00001071 * zeroize because the metadata is not particularly sensitive.
1072 * This memset also sets the slot's state to PSA_SLOT_EMPTY. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001073 memset(slot, 0, sizeof(*slot));
1074 return status;
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001075}
1076
Gilles Peskine449bd832023-01-11 14:50:10 +01001077psa_status_t psa_destroy_key(mbedtls_svc_key_id_t key)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001078{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001079 psa_key_slot_t *slot;
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001080 psa_status_t status; /* status of the last operation */
1081 psa_status_t overall_status = PSA_SUCCESS;
Gilles Peskine354f7672019-07-12 23:46:38 +02001082#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1083 psa_se_drv_table_entry_t *driver;
1084#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001085
Gilles Peskine449bd832023-01-11 14:50:10 +01001086 if (mbedtls_svc_key_id_is_null(key)) {
1087 return PSA_SUCCESS;
1088 }
Gilles Peskine1841cf42019-10-08 15:48:25 +02001089
Ronald Cronf2911112020-10-29 17:51:10 +01001090 /*
Ryan Everett7ed542e2024-01-17 11:39:09 +00001091 * Get the description of the key in a key slot, and register to read it.
1092 * In the case of a persistent key, this will load the key description
1093 * from persistent memory if not done yet.
1094 * We cannot avoid this loading as without it we don't know if
Ronald Cronf2911112020-10-29 17:51:10 +01001095 * the key is operated by an SE or not and this information is needed by
Ryan Everett7ed542e2024-01-17 11:39:09 +00001096 * the current implementation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001097 status = psa_get_and_lock_key_slot(key, &slot);
1098 if (status != PSA_SUCCESS) {
1099 return status;
1100 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001101
Ryan Everettc053d962024-01-25 17:56:32 +00001102#if defined(MBEDTLS_THREADING_C)
Ryan Everett763971f2024-01-29 17:13:36 +00001103 /* We cannot unlock between setting the state to PENDING_DELETION
1104 * and destroying the key in storage, as otherwise another thread
1105 * could load the key into a new slot and the key will not be
1106 * fully destroyed. */
Ryan Everettc053d962024-01-25 17:56:32 +00001107 PSA_THREADING_CHK_GOTO_EXIT(mbedtls_mutex_lock(
1108 &mbedtls_threading_key_slot_mutex));
Ryan Everettd868b742024-03-08 18:35:09 +00001109
1110 if (slot->state == PSA_SLOT_PENDING_DELETION) {
1111 /* Another thread has destroyed the key between us locking the slot
1112 * and us gaining the mutex. Unregister from the slot,
1113 * and report that the key does not exist. */
1114 status = psa_unregister_read(slot);
1115
1116 PSA_THREADING_CHK_RET(mbedtls_mutex_unlock(
1117 &mbedtls_threading_key_slot_mutex));
1118 return (status == PSA_SUCCESS) ? PSA_ERROR_INVALID_HANDLE : status;
1119 }
Ryan Everettc053d962024-01-25 17:56:32 +00001120#endif
Ryan Everett7ed542e2024-01-17 11:39:09 +00001121 /* Set the key slot containing the key description's state to
1122 * PENDING_DELETION. This stops new operations from registering
1123 * to read the slot. Current readers can safely continue to access
1124 * the key within the slot; the last registered reader will
1125 * automatically wipe the slot when they call psa_unregister_read().
1126 * If the key is persistent, we can now delete the copy of the key
1127 * from memory. If the key is opaque, we require the driver to
1128 * deal with the deletion. */
Ryan Everettd868b742024-03-08 18:35:09 +00001129 overall_status = psa_key_slot_state_transition(slot, PSA_SLOT_FULL,
1130 PSA_SLOT_PENDING_DELETION);
Ryan Everettc053d962024-01-25 17:56:32 +00001131
Ryan Everettd868b742024-03-08 18:35:09 +00001132 if (overall_status != PSA_SUCCESS) {
Ryan Everettc053d962024-01-25 17:56:32 +00001133 goto exit;
1134 }
Ronald Cronf2911112020-10-29 17:51:10 +01001135
Gilles Peskine449bd832023-01-11 14:50:10 +01001136 if (PSA_KEY_LIFETIME_IS_READ_ONLY(slot->attr.lifetime)) {
Gilles Peskine6687cd02021-04-21 22:32:05 +02001137 /* Refuse the destruction of a read-only key (which may or may not work
1138 * if we attempt it, depending on whether the key is merely read-only
1139 * by policy or actually physically read-only).
Gilles Peskinef9a046e2021-06-07 23:27:54 +02001140 * Just do the best we can, which is to wipe the copy in memory
1141 * (done in this function's cleanup code). */
1142 overall_status = PSA_ERROR_NOT_PERMITTED;
1143 goto exit;
Gilles Peskine6687cd02021-04-21 22:32:05 +02001144 }
1145
Gilles Peskine354f7672019-07-12 23:46:38 +02001146#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001147 driver = psa_get_se_driver_entry(slot->attr.lifetime);
1148 if (driver != NULL) {
Gilles Peskine60450a42019-07-25 11:32:45 +02001149 /* For a key in a secure element, we need to do three things:
1150 * remove the key file in internal storage, destroy the
1151 * key inside the secure element, and update the driver's
1152 * persistent data. Start a transaction that will encompass these
1153 * three actions. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001154 psa_crypto_prepare_transaction(PSA_CRYPTO_TRANSACTION_DESTROY_KEY);
Gilles Peskine8e338702019-07-30 20:06:31 +02001155 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Gilles Peskine449bd832023-01-11 14:50:10 +01001156 psa_crypto_transaction.key.slot = psa_key_slot_get_slot_number(slot);
Gilles Peskine8e338702019-07-30 20:06:31 +02001157 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskine449bd832023-01-11 14:50:10 +01001158 status = psa_crypto_save_transaction();
1159 if (status != PSA_SUCCESS) {
1160 (void) psa_crypto_stop_transaction();
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001161 /* We should still try to destroy the key in the secure
1162 * element and the key metadata in storage. This is especially
1163 * important if the error is that the storage is full.
1164 * But how to do it exactly without risking an inconsistent
1165 * state after a reset?
1166 * https://github.com/ARMmbed/mbed-crypto/issues/215
1167 */
1168 overall_status = status;
1169 goto exit;
Gilles Peskinefc762652019-07-22 19:30:34 +02001170 }
1171
Gilles Peskine449bd832023-01-11 14:50:10 +01001172 status = psa_destroy_se_key(driver,
1173 psa_key_slot_get_slot_number(slot));
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 }
Gilles Peskinefc762652019-07-22 19:30:34 +02001177 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001178#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1179
Darryl Greend49a4992018-06-18 17:27:26 +01001180#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001181 if (!PSA_KEY_LIFETIME_IS_VOLATILE(slot->attr.lifetime)) {
Ryan Everett4a0ba802024-01-17 14:12:33 +00001182 /* Destroy the copy of the persistent key from storage.
Ryan Everett7ed542e2024-01-17 11:39:09 +00001183 * The slot will still hold a copy of the key until the last reader
1184 * unregisters. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001185 status = psa_destroy_persistent_key(slot->attr.id);
1186 if (overall_status == PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001187 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001188 }
Darryl Greend49a4992018-06-18 17:27:26 +01001189 }
1190#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
Gilles Peskine354f7672019-07-12 23:46:38 +02001191
Gilles Peskinefc762652019-07-22 19:30:34 +02001192#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001193 if (driver != NULL) {
1194 status = psa_save_se_persistent_data(driver);
1195 if (overall_status == PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001196 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001197 }
1198 status = psa_crypto_stop_transaction();
1199 if (overall_status == PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001200 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001201 }
Gilles Peskinefc762652019-07-22 19:30:34 +02001202 }
1203#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1204
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001205exit:
Ryan Everett7ed542e2024-01-17 11:39:09 +00001206 /* Unregister from reading the slot. If we are the last active reader
1207 * then this will wipe the slot. */
1208 status = psa_unregister_read(slot);
1209 /* Prioritize CORRUPTION_DETECTED from unregistering over
1210 * a storage error. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001211 if (status != PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001212 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001213 }
Ryan Everettc053d962024-01-25 17:56:32 +00001214
1215#if defined(MBEDTLS_THREADING_C)
Ryan Everett7fee4f72024-02-09 14:11:27 +00001216 /* Don't overwrite existing errors if the unlock fails. */
1217 status = overall_status;
Ryan Everettc053d962024-01-25 17:56:32 +00001218 PSA_THREADING_CHK_RET(mbedtls_mutex_unlock(
1219 &mbedtls_threading_key_slot_mutex));
1220#endif
1221
Gilles Peskine449bd832023-01-11 14:50:10 +01001222 return overall_status;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001223}
1224
Gilles Peskinebfd322f2019-07-23 11:58:03 +02001225/** Retrieve all the publicly-accessible attributes of a key.
1226 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001227psa_status_t psa_get_key_attributes(mbedtls_svc_key_id_t key,
1228 psa_key_attributes_t *attributes)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001229{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001230 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001231 psa_key_slot_t *slot;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001232
Gilles Peskine449bd832023-01-11 14:50:10 +01001233 psa_reset_key_attributes(attributes);
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001234
Gilles Peskine449bd832023-01-11 14:50:10 +01001235 status = psa_get_and_lock_key_slot_with_policy(key, &slot, 0, 0);
1236 if (status != PSA_SUCCESS) {
1237 return status;
1238 }
Gilles Peskineb870b182018-07-06 16:02:09 +02001239
Gilles Peskine7fad3ef2024-02-28 01:08:27 +01001240 *attributes = slot->attr;
Gilles Peskinec8000c02019-08-02 20:15:51 +02001241
1242#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001243 if (psa_get_se_driver_entry(slot->attr.lifetime) != NULL) {
1244 psa_set_key_slot_number(attributes,
1245 psa_key_slot_get_slot_number(slot));
1246 }
Gilles Peskinec8000c02019-08-02 20:15:51 +02001247#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineb699f072019-04-26 16:06:02 +02001248
Gilles Peskine97c0b2f2024-02-16 00:49:46 +01001249 return psa_unregister_read_under_mutex(slot);
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001250}
1251
Gilles Peskinec8000c02019-08-02 20:15:51 +02001252#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1253psa_status_t psa_get_key_slot_number(
1254 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01001255 psa_key_slot_number_t *slot_number)
Gilles Peskinec8000c02019-08-02 20:15:51 +02001256{
Gilles Peskine972539c2024-02-28 01:49:45 +01001257 if (attributes->has_slot_number) {
Gilles Peskine2f107ae2024-02-28 01:26:46 +01001258 *slot_number = attributes->slot_number;
Gilles Peskine449bd832023-01-11 14:50:10 +01001259 return PSA_SUCCESS;
1260 } else {
1261 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinec8000c02019-08-02 20:15:51 +02001262 }
Gilles Peskinec8000c02019-08-02 20:15:51 +02001263}
1264#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1265
Gilles Peskine449bd832023-01-11 14:50:10 +01001266static psa_status_t psa_export_key_buffer_internal(const uint8_t *key_buffer,
1267 size_t key_buffer_size,
1268 uint8_t *data,
1269 size_t data_size,
1270 size_t *data_length)
Steven Cooremana01795d2020-07-24 22:48:15 +02001271{
Gilles Peskine449bd832023-01-11 14:50:10 +01001272 if (key_buffer_size > data_size) {
1273 return PSA_ERROR_BUFFER_TOO_SMALL;
1274 }
1275 memcpy(data, key_buffer, key_buffer_size);
1276 memset(data + key_buffer_size, 0,
1277 data_size - key_buffer_size);
Ronald Crond18b5f82020-11-25 16:46:05 +01001278 *data_length = key_buffer_size;
Gilles Peskine449bd832023-01-11 14:50:10 +01001279 return PSA_SUCCESS;
Steven Cooremana01795d2020-07-24 22:48:15 +02001280}
1281
Ronald Cron7285cda2020-11-26 14:46:37 +01001282psa_status_t psa_export_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001283 const psa_key_attributes_t *attributes,
1284 const uint8_t *key_buffer, size_t key_buffer_size,
Gilles Peskine449bd832023-01-11 14:50:10 +01001285 uint8_t *data, size_t data_size, size_t *data_length)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001286{
Gilles Peskine2f107ae2024-02-28 01:26:46 +01001287 psa_key_type_t type = attributes->type;
Ronald Crond18b5f82020-11-25 16:46:05 +01001288
Gilles Peskine449bd832023-01-11 14:50:10 +01001289 if (key_type_is_raw_bytes(type) ||
1290 PSA_KEY_TYPE_IS_RSA(type) ||
Przemek Stekiel472b3f32022-12-01 14:38:49 +01001291 PSA_KEY_TYPE_IS_ECC(type) ||
1292 PSA_KEY_TYPE_IS_DH(type)) {
Gilles Peskine449bd832023-01-11 14:50:10 +01001293 return psa_export_key_buffer_internal(
1294 key_buffer, key_buffer_size,
1295 data, data_size, data_length);
1296 } else {
Ronald Cron9486f9d2020-11-26 13:36:23 +01001297 /* This shouldn't happen in the reference implementation, but
1298 it is valid for a special-purpose implementation to omit
1299 support for exporting certain key types. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001300 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron9486f9d2020-11-26 13:36:23 +01001301 }
1302}
1303
Gilles Peskine449bd832023-01-11 14:50:10 +01001304psa_status_t psa_export_key(mbedtls_svc_key_id_t key,
1305 uint8_t *data,
1306 size_t data_size,
1307 size_t *data_length)
Ronald Cron9486f9d2020-11-26 13:36:23 +01001308{
1309 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
1310 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
1311 psa_key_slot_t *slot;
1312
Ronald Crone907e552021-01-18 13:22:38 +01001313 /* Reject a zero-length output buffer now, since this can never be a
1314 * valid key representation. This way we know that data must be a valid
1315 * pointer and we can do things like memset(data, ..., data_size). */
Gilles Peskine449bd832023-01-11 14:50:10 +01001316 if (data_size == 0) {
1317 return PSA_ERROR_BUFFER_TOO_SMALL;
1318 }
Ronald Crone907e552021-01-18 13:22:38 +01001319
Ronald Cron9486f9d2020-11-26 13:36:23 +01001320 /* Set the key to empty now, so that even when there are errors, we always
1321 * set data_length to a value between 0 and data_size. On error, setting
1322 * the key to empty is a good choice because an empty key representation is
1323 * unlikely to be accepted anywhere. */
Jaeden Amerof24c7f82018-06-27 17:20:43 +01001324 *data_length = 0;
1325
Ronald Cron9486f9d2020-11-26 13:36:23 +01001326 /* Export requires the EXPORT flag. There is an exception for public keys,
1327 * which don't require any flag, but
1328 * psa_get_and_lock_key_slot_with_policy() takes care of this.
1329 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001330 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
1331 PSA_KEY_USAGE_EXPORT, 0);
1332 if (status != PSA_SUCCESS) {
1333 return status;
1334 }
mohammad160306e79202018-03-28 13:17:44 +03001335
Gilles Peskine7a5d9202024-02-28 01:18:23 +01001336 status = psa_driver_wrapper_export_key(&slot->attr,
Gilles Peskine449bd832023-01-11 14:50:10 +01001337 slot->key.data, slot->key.bytes,
1338 data, data_size, data_length);
Ronald Cron9486f9d2020-11-26 13:36:23 +01001339
Ryan Everetta103ec92024-01-31 13:59:57 +00001340 unlock_status = psa_unregister_read_under_mutex(slot);
Ronald Cron9486f9d2020-11-26 13:36:23 +01001341
Gilles Peskine449bd832023-01-11 14:50:10 +01001342 return (status == PSA_SUCCESS) ? unlock_status : status;
Ronald Cron9486f9d2020-11-26 13:36:23 +01001343}
1344
Ronald Cron7285cda2020-11-26 14:46:37 +01001345psa_status_t psa_export_public_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001346 const psa_key_attributes_t *attributes,
1347 const uint8_t *key_buffer,
1348 size_t key_buffer_size,
1349 uint8_t *data,
1350 size_t data_size,
Gilles Peskine449bd832023-01-11 14:50:10 +01001351 size_t *data_length)
Ronald Cron9486f9d2020-11-26 13:36:23 +01001352{
Gilles Peskine2f107ae2024-02-28 01:26:46 +01001353 psa_key_type_t type = attributes->type;
Ronald Crond18b5f82020-11-25 16:46:05 +01001354
Przemek Stekiel6fd72b62023-04-27 10:20:56 +02001355 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(type) &&
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001356 (PSA_KEY_TYPE_IS_RSA(type) || PSA_KEY_TYPE_IS_ECC(type) ||
1357 PSA_KEY_TYPE_IS_DH(type))) {
Przemek Stekiel6fd72b62023-04-27 10:20:56 +02001358 /* Exporting public -> public */
1359 return psa_export_key_buffer_internal(
1360 key_buffer, key_buffer_size,
1361 data, data_size, data_length);
1362 } else if (PSA_KEY_TYPE_IS_RSA(type)) {
Valerio Settib2bcedb2023-07-10 11:24:00 +02001363#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT) || \
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001364 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
1365 return mbedtls_psa_rsa_export_public_key(attributes,
1366 key_buffer,
1367 key_buffer_size,
1368 data,
1369 data_size,
1370 data_length);
Darryl Green9e2d7a02018-07-24 16:33:30 +01001371#else
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001372 /* We don't know how to convert a private RSA key to public. */
1373 return PSA_ERROR_NOT_SUPPORTED;
Valerio Settib2bcedb2023-07-10 11:24:00 +02001374#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT) ||
John Durkop9814fa22020-11-04 12:28:15 -08001375 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Przemek Stekiel6fd72b62023-04-27 10:20:56 +02001376 } else if (PSA_KEY_TYPE_IS_ECC(type)) {
Valerio Setti27c501a2023-06-27 16:58:52 +02001377#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_EXPORT) || \
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001378 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
1379 return mbedtls_psa_ecp_export_public_key(attributes,
1380 key_buffer,
1381 key_buffer_size,
1382 data,
1383 data_size,
1384 data_length);
Steven Cooreman560c28a2020-07-24 23:20:24 +02001385#else
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001386 /* We don't know how to convert a private ECC key to public */
1387 return PSA_ERROR_NOT_SUPPORTED;
Valerio Setti27c501a2023-06-27 16:58:52 +02001388#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_EXPORT) ||
John Durkop9814fa22020-11-04 12:28:15 -08001389 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
Przemek Stekiel6fd72b62023-04-27 10:20:56 +02001390 } else if (PSA_KEY_TYPE_IS_DH(type)) {
Valerio Settia55f0422023-07-10 15:34:41 +02001391#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_EXPORT) || \
Przemek Stekiel6d85afa2023-04-28 11:42:17 +02001392 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY)
Przemek Stekiel152bb462023-06-01 11:52:39 +02001393 return mbedtls_psa_ffdh_export_public_key(attributes,
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001394 key_buffer,
1395 key_buffer_size,
1396 data, data_size,
1397 data_length);
Przemek Stekiel472b3f32022-12-01 14:38:49 +01001398#else
Przemek Stekiel472b3f32022-12-01 14:38:49 +01001399 return PSA_ERROR_NOT_SUPPORTED;
Valerio Settia55f0422023-07-10 15:34:41 +02001400#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_EXPORT) ||
Przemek Stekiel6d85afa2023-04-28 11:42:17 +02001401 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY) */
Gilles Peskine449bd832023-01-11 14:50:10 +01001402 } else {
Przemek Stekiel0b11ee02023-05-16 13:26:06 +02001403 (void) key_buffer;
1404 (void) key_buffer_size;
1405 (void) data;
1406 (void) data_size;
1407 (void) data_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01001408 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman560c28a2020-07-24 23:20:24 +02001409 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001410}
Ronald Crond18b5f82020-11-25 16:46:05 +01001411
Gilles Peskine449bd832023-01-11 14:50:10 +01001412psa_status_t psa_export_public_key(mbedtls_svc_key_id_t key,
1413 uint8_t *data,
1414 size_t data_size,
1415 size_t *data_length)
Moran Pekerdd4ea382018-04-03 15:30:03 +03001416{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001417 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001418 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001419 psa_key_slot_t *slot;
Darryl Greendd8fb772018-11-07 16:00:44 +00001420
Ronald Crone907e552021-01-18 13:22:38 +01001421 /* Reject a zero-length output buffer now, since this can never be a
1422 * valid key representation. This way we know that data must be a valid
1423 * pointer and we can do things like memset(data, ..., data_size). */
Gilles Peskine449bd832023-01-11 14:50:10 +01001424 if (data_size == 0) {
1425 return PSA_ERROR_BUFFER_TOO_SMALL;
1426 }
Ronald Crone907e552021-01-18 13:22:38 +01001427
Darryl Greendd8fb772018-11-07 16:00:44 +00001428 /* Set the key to empty now, so that even when there are errors, we always
1429 * set data_length to a value between 0 and data_size. On error, setting
1430 * the key to empty is a good choice because an empty key representation is
1431 * unlikely to be accepted anywhere. */
1432 *data_length = 0;
1433
1434 /* Exporting a public key doesn't require a usage flag. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001435 status = psa_get_and_lock_key_slot_with_policy(key, &slot, 0, 0);
1436 if (status != PSA_SUCCESS) {
1437 return status;
1438 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001439
Gilles Peskine449bd832023-01-11 14:50:10 +01001440 if (!PSA_KEY_TYPE_IS_ASYMMETRIC(slot->attr.type)) {
1441 status = PSA_ERROR_INVALID_ARGUMENT;
1442 goto exit;
Ronald Cron9486f9d2020-11-26 13:36:23 +01001443 }
1444
Ronald Cron67227982020-11-26 15:16:05 +01001445 status = psa_driver_wrapper_export_public_key(
Gilles Peskine7a5d9202024-02-28 01:18:23 +01001446 &slot->attr, slot->key.data, slot->key.bytes,
Gilles Peskine449bd832023-01-11 14:50:10 +01001447 data, data_size, data_length);
Ronald Cron9486f9d2020-11-26 13:36:23 +01001448
1449exit:
Ryan Everetta103ec92024-01-31 13:59:57 +00001450 unlock_status = psa_unregister_read_under_mutex(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02001451
Gilles Peskine449bd832023-01-11 14:50:10 +01001452 return (status == PSA_SUCCESS) ? unlock_status : status;
Moran Pekerdd4ea382018-04-03 15:30:03 +03001453}
1454
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001455/** Validate that a key policy is internally well-formed.
1456 *
1457 * This function only rejects invalid policies. It does not validate the
1458 * consistency of the policy with respect to other attributes of the key
1459 * such as the key type.
1460 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001461static psa_status_t psa_validate_key_policy(const psa_key_policy_t *policy)
Gilles Peskine4747d192019-04-17 15:05:45 +02001462{
Gilles Peskine449bd832023-01-11 14:50:10 +01001463 if ((policy->usage & ~(PSA_KEY_USAGE_EXPORT |
1464 PSA_KEY_USAGE_COPY |
1465 PSA_KEY_USAGE_ENCRYPT |
1466 PSA_KEY_USAGE_DECRYPT |
1467 PSA_KEY_USAGE_SIGN_MESSAGE |
1468 PSA_KEY_USAGE_VERIFY_MESSAGE |
1469 PSA_KEY_USAGE_SIGN_HASH |
1470 PSA_KEY_USAGE_VERIFY_HASH |
1471 PSA_KEY_USAGE_VERIFY_DERIVATION |
1472 PSA_KEY_USAGE_DERIVE)) != 0) {
1473 return PSA_ERROR_INVALID_ARGUMENT;
1474 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001475
Gilles Peskine449bd832023-01-11 14:50:10 +01001476 return PSA_SUCCESS;
Gilles Peskine4747d192019-04-17 15:05:45 +02001477}
1478
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001479/** Validate the internal consistency of key attributes.
1480 *
1481 * This function only rejects invalid attribute values. If does not
1482 * validate the consistency of the attributes with any key data that may
1483 * be involved in the creation of the key.
1484 *
1485 * Call this function early in the key creation process.
1486 *
1487 * \param[in] attributes Key attributes for the new key.
1488 * \param[out] p_drv On any return, the driver for the key, if any.
1489 * NULL for a transparent key.
1490 *
1491 */
1492static psa_status_t psa_validate_key_attributes(
1493 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01001494 psa_se_drv_table_entry_t **p_drv)
Darryl Green0c6575a2018-11-07 16:05:30 +00001495{
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001496 psa_status_t status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine449bd832023-01-11 14:50:10 +01001497 psa_key_lifetime_t lifetime = psa_get_key_lifetime(attributes);
1498 mbedtls_svc_key_id_t key = psa_get_key_id(attributes);
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001499
Gilles Peskine449bd832023-01-11 14:50:10 +01001500 status = psa_validate_key_location(lifetime, p_drv);
1501 if (status != PSA_SUCCESS) {
1502 return status;
Ronald Crond2ed4812020-07-17 16:11:30 +02001503 }
1504
Gilles Peskine449bd832023-01-11 14:50:10 +01001505 status = psa_validate_key_persistence(lifetime);
1506 if (status != PSA_SUCCESS) {
1507 return status;
1508 }
1509
1510 if (PSA_KEY_LIFETIME_IS_VOLATILE(lifetime)) {
1511 if (MBEDTLS_SVC_KEY_ID_GET_KEY_ID(key) != 0) {
1512 return PSA_ERROR_INVALID_ARGUMENT;
1513 }
1514 } else {
1515 if (!psa_is_valid_key_id(psa_get_key_id(attributes), 0)) {
1516 return PSA_ERROR_INVALID_ARGUMENT;
1517 }
1518 }
1519
Gilles Peskine2f107ae2024-02-28 01:26:46 +01001520 status = psa_validate_key_policy(&attributes->policy);
Gilles Peskine449bd832023-01-11 14:50:10 +01001521 if (status != PSA_SUCCESS) {
1522 return status;
1523 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001524
1525 /* Refuse to create overly large keys.
1526 * Note that this doesn't trigger on import if the attributes don't
1527 * explicitly specify a size (so psa_get_key_bits returns 0), so
1528 * psa_import_key() needs its own checks. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001529 if (psa_get_key_bits(attributes) > PSA_MAX_KEY_BITS) {
1530 return PSA_ERROR_NOT_SUPPORTED;
1531 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001532
Gilles Peskine449bd832023-01-11 14:50:10 +01001533 return PSA_SUCCESS;
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001534}
1535
Gilles Peskine4747d192019-04-17 15:05:45 +02001536/** Prepare a key slot to receive key material.
1537 *
1538 * This function allocates a key slot and sets its metadata.
1539 *
1540 * If this function fails, call psa_fail_key_creation().
1541 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001542 * This function is intended to be used as follows:
1543 * -# Call psa_start_key_creation() to allocate a key slot, prepare
Ronald Croncf56a0a2020-08-04 09:51:30 +02001544 * it with the specified attributes, and in case of a volatile key assign it
1545 * a volatile key identifier.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001546 * -# Populate the slot with the key material.
1547 * -# Call psa_finish_key_creation() to finalize the creation of the slot.
1548 * In case of failure at any step, stop the sequence and call
1549 * psa_fail_key_creation().
1550 *
Ryan Everettb69118e2024-01-02 15:54:32 +00001551 * On success, the key slot's state is PSA_SLOT_FILLING.
1552 * It is the responsibility of the caller to change the slot's state to
1553 * PSA_SLOT_EMPTY/FULL once key creation has finished.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001554 *
Gilles Peskinedf179142019-07-15 22:02:14 +02001555 * \param method An identification of the calling function.
Gilles Peskine011e4282019-06-26 18:34:38 +02001556 * \param[in] attributes Key attributes for the new key.
Gilles Peskine011e4282019-06-26 18:34:38 +02001557 * \param[out] p_slot On success, a pointer to the prepared slot.
1558 * \param[out] p_drv On any return, the driver for the key, if any.
1559 * NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001560 *
1561 * \retval #PSA_SUCCESS
1562 * The key slot is ready to receive key material.
1563 * \return If this function fails, the key slot is an invalid state.
1564 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001565 */
1566static psa_status_t psa_start_key_creation(
Gilles Peskinedf179142019-07-15 22:02:14 +02001567 psa_key_creation_method_t method,
Gilles Peskine4747d192019-04-17 15:05:45 +02001568 const psa_key_attributes_t *attributes,
Gilles Peskine011e4282019-06-26 18:34:38 +02001569 psa_key_slot_t **p_slot,
Gilles Peskine449bd832023-01-11 14:50:10 +01001570 psa_se_drv_table_entry_t **p_drv)
Gilles Peskine4747d192019-04-17 15:05:45 +02001571{
1572 psa_status_t status;
Ronald Cron2a993152020-07-17 14:13:26 +02001573 psa_key_id_t volatile_key_id;
Gilles Peskine4747d192019-04-17 15:05:45 +02001574 psa_key_slot_t *slot;
1575
Gilles Peskinedf179142019-07-15 22:02:14 +02001576 (void) method;
Gilles Peskine011e4282019-06-26 18:34:38 +02001577 *p_drv = NULL;
1578
Gilles Peskine449bd832023-01-11 14:50:10 +01001579 status = psa_validate_key_attributes(attributes, p_drv);
1580 if (status != PSA_SUCCESS) {
1581 return status;
1582 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001583
Ryan Everett3d8118d2024-01-30 16:58:47 +00001584#if defined(MBEDTLS_THREADING_C)
1585 PSA_THREADING_CHK_RET(mbedtls_mutex_lock(
1586 &mbedtls_threading_key_slot_mutex));
1587#endif
Ryan Everettb69118e2024-01-02 15:54:32 +00001588 status = psa_reserve_free_key_slot(&volatile_key_id, p_slot);
Ryan Everett3d8118d2024-01-30 16:58:47 +00001589#if defined(MBEDTLS_THREADING_C)
1590 PSA_THREADING_CHK_RET(mbedtls_mutex_unlock(
1591 &mbedtls_threading_key_slot_mutex));
1592#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001593 if (status != PSA_SUCCESS) {
1594 return status;
1595 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001596 slot = *p_slot;
1597
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001598 /* We're storing the declared bit-size of the key. It's up to each
1599 * creation mechanism to verify that this information is correct.
1600 * It's automatically correct for mechanisms that use the bit-size as
Gilles Peskineb46bef22019-07-30 21:32:04 +02001601 * an input (generate, device) but not for those where the bit-size
Ronald Cronc4d1b512020-07-31 11:26:37 +02001602 * is optional (import, copy). In case of a volatile key, assign it the
1603 * volatile key identifier associated to the slot returned to contain its
1604 * definition. */
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001605
Gilles Peskine7fad3ef2024-02-28 01:08:27 +01001606 slot->attr = *attributes;
Gilles Peskine449bd832023-01-11 14:50:10 +01001607 if (PSA_KEY_LIFETIME_IS_VOLATILE(slot->attr.lifetime)) {
Ronald Cronc4d1b512020-07-31 11:26:37 +02001608#if !defined(MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER)
1609 slot->attr.id = volatile_key_id;
1610#else
1611 slot->attr.id.key_id = volatile_key_id;
1612#endif
1613 }
Gilles Peskinec744d992019-07-30 17:26:54 +02001614
Gilles Peskinecbaff462019-07-12 23:46:04 +02001615#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001616 /* For a key in a secure element, we need to do three things
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001617 * when creating or registering a persistent key:
Gilles Peskine60450a42019-07-25 11:32:45 +02001618 * create the key file in internal storage, create the
1619 * key inside the secure element, and update the driver's
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001620 * persistent data. This is done by starting a transaction that will
1621 * encompass these three actions.
1622 * For registering a volatile key, we just need to find an appropriate
1623 * slot number inside the SE. Since the key is designated volatile, creating
1624 * a transaction is not required. */
Gilles Peskine60450a42019-07-25 11:32:45 +02001625 /* The first thing to do is to find a slot number for the new key.
1626 * We save the slot number in persistent storage as part of the
1627 * transaction data. It will be needed to recover if the power
1628 * fails during the key creation process, to clean up on the secure
1629 * element side after restarting. Obtaining a slot number from the
1630 * secure element driver updates its persistent state, but we do not yet
1631 * save the driver's persistent state, so that if the power fails,
Gilles Peskinefc762652019-07-22 19:30:34 +02001632 * we can roll back to a state where the key doesn't exist. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001633 if (*p_drv != NULL) {
Ronald Cronea0f8a62020-11-25 17:52:23 +01001634 psa_key_slot_number_t slot_number;
Gilles Peskine449bd832023-01-11 14:50:10 +01001635 status = psa_find_se_slot_for_key(attributes, method, *p_drv,
1636 &slot_number);
1637 if (status != PSA_SUCCESS) {
1638 return status;
1639 }
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001640
Gilles Peskine2f107ae2024-02-28 01:26:46 +01001641 if (!PSA_KEY_LIFETIME_IS_VOLATILE(attributes->lifetime)) {
Gilles Peskine449bd832023-01-11 14:50:10 +01001642 psa_crypto_prepare_transaction(PSA_CRYPTO_TRANSACTION_CREATE_KEY);
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001643 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001644 psa_crypto_transaction.key.slot = slot_number;
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001645 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskine449bd832023-01-11 14:50:10 +01001646 status = psa_crypto_save_transaction();
1647 if (status != PSA_SUCCESS) {
1648 (void) psa_crypto_stop_transaction();
1649 return status;
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001650 }
Gilles Peskine66be51c2019-07-25 18:02:52 +02001651 }
Ronald Cronea0f8a62020-11-25 17:52:23 +01001652
1653 status = psa_copy_key_material_into_slot(
Gilles Peskine449bd832023-01-11 14:50:10 +01001654 slot, (uint8_t *) (&slot_number), sizeof(slot_number));
Darryl Green0c6575a2018-11-07 16:05:30 +00001655 }
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001656
Gilles Peskine449bd832023-01-11 14:50:10 +01001657 if (*p_drv == NULL && method == PSA_KEY_CREATION_REGISTER) {
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001658 /* Key registration only makes sense with a secure element. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001659 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001660 }
Gilles Peskinecbaff462019-07-12 23:46:04 +02001661#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1662
Gilles Peskine449bd832023-01-11 14:50:10 +01001663 return PSA_SUCCESS;
Darryl Green0c6575a2018-11-07 16:05:30 +00001664}
Gilles Peskine4747d192019-04-17 15:05:45 +02001665
1666/** Finalize the creation of a key once its key material has been set.
1667 *
1668 * This entails writing the key to persistent storage.
1669 *
1670 * If this function fails, call psa_fail_key_creation().
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001671 * See the documentation of psa_start_key_creation() for the intended use
1672 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001673 *
Ryan Everettb69118e2024-01-02 15:54:32 +00001674 * If the finalization succeeds, the function sets the key slot's state to
1675 * PSA_SLOT_FULL, and the key slot can no longer be accessed as part of the
1676 * key creation process.
Ronald Cron50972942020-11-14 11:28:25 +01001677 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001678 * \param[in,out] slot Pointer to the slot with key material.
1679 * \param[in] driver The secure element driver for the key,
1680 * or NULL for a transparent key.
Ronald Cron81709fc2020-11-14 12:10:32 +01001681 * \param[out] key On success, identifier of the key. Note that the
1682 * key identifier is also stored in the key slot.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001683 *
1684 * \retval #PSA_SUCCESS
Ronald Croncf56a0a2020-08-04 09:51:30 +02001685 * The key was successfully created.
Gilles Peskineed733552023-02-14 19:21:09 +01001686 * \retval #PSA_ERROR_INSUFFICIENT_MEMORY \emptydescription
1687 * \retval #PSA_ERROR_INSUFFICIENT_STORAGE \emptydescription
1688 * \retval #PSA_ERROR_ALREADY_EXISTS \emptydescription
1689 * \retval #PSA_ERROR_DATA_INVALID \emptydescription
1690 * \retval #PSA_ERROR_DATA_CORRUPT \emptydescription
1691 * \retval #PSA_ERROR_STORAGE_FAILURE \emptydescription
gabor-mezei-arm452b0a32020-11-09 17:42:55 +01001692 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001693 * \return If this function fails, the key slot is an invalid state.
1694 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001695 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001696static psa_status_t psa_finish_key_creation(
1697 psa_key_slot_t *slot,
Ronald Cron81709fc2020-11-14 12:10:32 +01001698 psa_se_drv_table_entry_t *driver,
1699 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02001700{
1701 psa_status_t status = PSA_SUCCESS;
Gilles Peskine30afafd2019-04-25 13:47:40 +02001702 (void) slot;
Gilles Peskine011e4282019-06-26 18:34:38 +02001703 (void) driver;
Gilles Peskine4747d192019-04-17 15:05:45 +02001704
Ryan Everett91ffe5b2024-01-23 20:05:42 +00001705#if defined(MBEDTLS_THREADING_C)
1706 PSA_THREADING_CHK_RET(mbedtls_mutex_lock(
1707 &mbedtls_threading_key_slot_mutex));
1708#endif
1709
Gilles Peskine4747d192019-04-17 15:05:45 +02001710#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001711 if (!PSA_KEY_LIFETIME_IS_VOLATILE(slot->attr.lifetime)) {
Gilles Peskine1df83d42019-07-23 16:13:14 +02001712#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001713 if (driver != NULL) {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001714 psa_se_key_data_storage_t data;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001715 psa_key_slot_number_t slot_number =
Gilles Peskine449bd832023-01-11 14:50:10 +01001716 psa_key_slot_get_slot_number(slot);
Ronald Cronea0f8a62020-11-25 17:52:23 +01001717
Tom Cosgrove6ef9bb32023-03-08 14:19:51 +00001718 MBEDTLS_STATIC_ASSERT(sizeof(slot_number) ==
1719 sizeof(data.slot_number),
1720 "Slot number size does not match psa_se_key_data_storage_t");
1721
Gilles Peskine449bd832023-01-11 14:50:10 +01001722 memcpy(&data.slot_number, &slot_number, sizeof(slot_number));
1723 status = psa_save_persistent_key(&slot->attr,
1724 (uint8_t *) &data,
1725 sizeof(data));
1726 } else
Gilles Peskine1df83d42019-07-23 16:13:14 +02001727#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1728 {
Steven Cooreman40120f62020-10-29 11:42:22 +01001729 /* Key material is saved in export representation in the slot, so
1730 * just pass the slot buffer for storage. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001731 status = psa_save_persistent_key(&slot->attr,
1732 slot->key.data,
1733 slot->key.bytes);
Gilles Peskine1df83d42019-07-23 16:13:14 +02001734 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001735 }
Darryl Green0c6575a2018-11-07 16:05:30 +00001736#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
1737
Gilles Peskinecbaff462019-07-12 23:46:04 +02001738#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001739 /* Finish the transaction for a key creation. This does not
1740 * happen when registering an existing key. Detect this case
1741 * by checking whether a transaction is in progress (actual
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001742 * creation of a persistent key in a secure element requires a transaction,
1743 * but registration or volatile key creation doesn't use one). */
Gilles Peskine449bd832023-01-11 14:50:10 +01001744 if (driver != NULL &&
1745 psa_crypto_transaction.unknown.type == PSA_CRYPTO_TRANSACTION_CREATE_KEY) {
1746 status = psa_save_se_persistent_data(driver);
1747 if (status != PSA_SUCCESS) {
1748 psa_destroy_persistent_key(slot->attr.id);
Ryan Everett91ffe5b2024-01-23 20:05:42 +00001749
1750#if defined(MBEDTLS_THREADING_C)
1751 PSA_THREADING_CHK_RET(mbedtls_mutex_unlock(
1752 &mbedtls_threading_key_slot_mutex));
1753#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001754 return status;
Gilles Peskinecbaff462019-07-12 23:46:04 +02001755 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001756 status = psa_crypto_stop_transaction();
Gilles Peskinecbaff462019-07-12 23:46:04 +02001757 }
1758#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1759
Gilles Peskine449bd832023-01-11 14:50:10 +01001760 if (status == PSA_SUCCESS) {
Ronald Cron81709fc2020-11-14 12:10:32 +01001761 *key = slot->attr.id;
Ryan Everettb69118e2024-01-02 15:54:32 +00001762 status = psa_key_slot_state_transition(slot, PSA_SLOT_FILLING,
1763 PSA_SLOT_FULL);
Gilles Peskine449bd832023-01-11 14:50:10 +01001764 if (status != PSA_SUCCESS) {
Ronald Cron81709fc2020-11-14 12:10:32 +01001765 *key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01001766 }
Ronald Cron81709fc2020-11-14 12:10:32 +01001767 }
Ronald Cron50972942020-11-14 11:28:25 +01001768
Ryan Everett91ffe5b2024-01-23 20:05:42 +00001769#if defined(MBEDTLS_THREADING_C)
1770 PSA_THREADING_CHK_RET(mbedtls_mutex_unlock(
1771 &mbedtls_threading_key_slot_mutex));
1772#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001773 return status;
Gilles Peskine4747d192019-04-17 15:05:45 +02001774}
1775
1776/** Abort the creation of a key.
1777 *
1778 * You may call this function after calling psa_start_key_creation(),
1779 * or after psa_finish_key_creation() fails. In other circumstances, this
1780 * function may not clean up persistent storage.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001781 * See the documentation of psa_start_key_creation() for the intended use
Ryan Everettb69118e2024-01-02 15:54:32 +00001782 * of this function. Sets the slot's state to PSA_SLOT_EMPTY.
Gilles Peskine4747d192019-04-17 15:05:45 +02001783 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001784 * \param[in,out] slot Pointer to the slot with key material.
1785 * \param[in] driver The secure element driver for the key,
1786 * or NULL for a transparent key.
Gilles Peskine4747d192019-04-17 15:05:45 +02001787 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001788static void psa_fail_key_creation(psa_key_slot_t *slot,
1789 psa_se_drv_table_entry_t *driver)
Gilles Peskine4747d192019-04-17 15:05:45 +02001790{
Gilles Peskine011e4282019-06-26 18:34:38 +02001791 (void) driver;
1792
Gilles Peskine449bd832023-01-11 14:50:10 +01001793 if (slot == NULL) {
Gilles Peskine4747d192019-04-17 15:05:45 +02001794 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01001795 }
Gilles Peskine011e4282019-06-26 18:34:38 +02001796
Ryan Everettb7101442024-01-23 20:09:49 +00001797#if defined(MBEDTLS_THREADING_C)
Ryan Everett73feaf22024-02-14 11:36:41 +00001798 /* If the lock operation fails we still wipe the slot.
1799 * Operations will no longer work after a failed lock,
1800 * but we still need to wipe the slot of confidential data. */
Ryan Everettb7101442024-01-23 20:09:49 +00001801 mbedtls_mutex_lock(&mbedtls_threading_key_slot_mutex);
1802#endif
1803
Gilles Peskine011e4282019-06-26 18:34:38 +02001804#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001805 /* TODO: If the key has already been created in the secure
Gilles Peskine011e4282019-06-26 18:34:38 +02001806 * element, and the failure happened later (when saving metadata
1807 * to internal storage), we need to destroy the key in the secure
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001808 * element.
1809 * https://github.com/ARMmbed/mbed-crypto/issues/217
1810 */
Gilles Peskinefc762652019-07-22 19:30:34 +02001811
Gilles Peskined7729582019-08-05 15:55:54 +02001812 /* Abort the ongoing transaction if any (there may not be one if
1813 * the creation process failed before starting one, or if the
1814 * key creation is a registration of a key in a secure element).
1815 * Earlier functions must already have done what it takes to undo any
1816 * partial creation. All that's left is to update the transaction data
1817 * itself. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001818 (void) psa_crypto_stop_transaction();
Gilles Peskine011e4282019-06-26 18:34:38 +02001819#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1820
Gilles Peskine449bd832023-01-11 14:50:10 +01001821 psa_wipe_key_slot(slot);
Ryan Everettb7101442024-01-23 20:09:49 +00001822
1823#if defined(MBEDTLS_THREADING_C)
1824 mbedtls_mutex_unlock(&mbedtls_threading_key_slot_mutex);
1825#endif
Gilles Peskine4747d192019-04-17 15:05:45 +02001826}
1827
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001828/** Validate optional attributes during key creation.
1829 *
1830 * Some key attributes are optional during key creation. If they are
1831 * specified in the attributes structure, check that they are consistent
1832 * with the data in the slot.
1833 *
1834 * This function should be called near the end of key creation, after
1835 * the slot in memory is fully populated but before saving persistent data.
1836 */
1837static psa_status_t psa_validate_optional_attributes(
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001838 const psa_key_slot_t *slot,
Gilles Peskine449bd832023-01-11 14:50:10 +01001839 const psa_key_attributes_t *attributes)
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001840{
Gilles Peskine2f107ae2024-02-28 01:26:46 +01001841 if (attributes->type != 0) {
1842 if (attributes->type != slot->attr.type) {
Gilles Peskine449bd832023-01-11 14:50:10 +01001843 return PSA_ERROR_INVALID_ARGUMENT;
1844 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001845 }
1846
Gilles Peskine2f107ae2024-02-28 01:26:46 +01001847 if (attributes->bits != 0) {
1848 if (attributes->bits != slot->attr.bits) {
Gilles Peskine449bd832023-01-11 14:50:10 +01001849 return PSA_ERROR_INVALID_ARGUMENT;
1850 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001851 }
1852
Gilles Peskine449bd832023-01-11 14:50:10 +01001853 return PSA_SUCCESS;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001854}
1855
Gilles Peskine449bd832023-01-11 14:50:10 +01001856psa_status_t psa_import_key(const psa_key_attributes_t *attributes,
1857 const uint8_t *data,
1858 size_t data_length,
1859 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02001860{
1861 psa_status_t status;
1862 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001863 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001864 size_t bits;
Archanad8a83dc2021-06-14 10:04:16 +05301865 size_t storage_size = data_length;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001866
Ronald Cron81709fc2020-11-14 12:10:32 +01001867 *key = MBEDTLS_SVC_KEY_ID_INIT;
1868
Gilles Peskine0f84d622019-09-12 19:03:13 +02001869 /* Reject zero-length symmetric keys (including raw data key objects).
1870 * This also rejects any key which might be encoded as an empty string,
1871 * which is never valid. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001872 if (data_length == 0) {
1873 return PSA_ERROR_INVALID_ARGUMENT;
1874 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02001875
Archana449608b2021-09-08 15:36:05 +05301876 /* Ensure that the bytes-to-bits conversion cannot overflow. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001877 if (data_length > SIZE_MAX / 8) {
1878 return PSA_ERROR_NOT_SUPPORTED;
1879 }
Archana6ed4bda2021-08-04 10:47:15 +05301880
Gilles Peskine449bd832023-01-11 14:50:10 +01001881 status = psa_start_key_creation(PSA_KEY_CREATION_IMPORT, attributes,
1882 &slot, &driver);
1883 if (status != PSA_SUCCESS) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001884 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001885 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001886
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001887 /* In the case of a transparent key or an opaque key stored in local
Archana449608b2021-09-08 15:36:05 +05301888 * storage ( thus not in the case of importing a key in a secure element
1889 * with storage ( MBEDTLS_PSA_CRYPTO_SE_C ) ),we have to allocate a
1890 * buffer to hold the imported key material. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001891 if (slot->key.data == NULL) {
Gilles Peskine2f107ae2024-02-28 01:26:46 +01001892 if (psa_key_lifetime_is_external(attributes->lifetime)) {
Archana449608b2021-09-08 15:36:05 +05301893 status = psa_driver_wrapper_get_key_buffer_size_from_key_data(
Gilles Peskine449bd832023-01-11 14:50:10 +01001894 attributes, data, data_length, &storage_size);
1895 if (status != PSA_SUCCESS) {
Archanad8a83dc2021-06-14 10:04:16 +05301896 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001897 }
Archanad8a83dc2021-06-14 10:04:16 +05301898 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001899 status = psa_allocate_buffer_to_slot(slot, storage_size);
1900 if (status != PSA_SUCCESS) {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001901 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001902 }
Gilles Peskine5d309672019-07-12 23:47:28 +02001903 }
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001904
1905 bits = slot->attr.bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01001906 status = psa_driver_wrapper_import_key(attributes,
1907 data, data_length,
1908 slot->key.data,
1909 slot->key.bytes,
1910 &slot->key.bytes, &bits);
1911 if (status != PSA_SUCCESS) {
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001912 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001913 }
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001914
Gilles Peskine449bd832023-01-11 14:50:10 +01001915 if (slot->attr.bits == 0) {
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001916 slot->attr.bits = (psa_key_bits_t) bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01001917 } else if (bits != slot->attr.bits) {
Steven Cooremanac3434f2021-01-15 17:36:02 +01001918 status = PSA_ERROR_INVALID_ARGUMENT;
1919 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02001920 }
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01001921
Archana6ed4bda2021-08-04 10:47:15 +05301922 /* Enforce a size limit, and in particular ensure that the bit
1923 * size fits in its representation type.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01001924 if (bits > PSA_MAX_KEY_BITS) {
Archana6ed4bda2021-08-04 10:47:15 +05301925 status = PSA_ERROR_NOT_SUPPORTED;
1926 goto exit;
1927 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001928 status = psa_validate_optional_attributes(slot, attributes);
1929 if (status != PSA_SUCCESS) {
Gilles Peskine18017402019-07-24 20:25:59 +02001930 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001931 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001932
Gilles Peskine449bd832023-01-11 14:50:10 +01001933 status = psa_finish_key_creation(slot, driver, key);
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001934exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01001935 if (status != PSA_SUCCESS) {
1936 psa_fail_key_creation(slot, driver);
1937 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001938
Gilles Peskine449bd832023-01-11 14:50:10 +01001939 return status;
Gilles Peskine4747d192019-04-17 15:05:45 +02001940}
1941
Gilles Peskined7729582019-08-05 15:55:54 +02001942#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1943psa_status_t mbedtls_psa_register_se_key(
Gilles Peskine449bd832023-01-11 14:50:10 +01001944 const psa_key_attributes_t *attributes)
Gilles Peskined7729582019-08-05 15:55:54 +02001945{
1946 psa_status_t status;
1947 psa_key_slot_t *slot = NULL;
1948 psa_se_drv_table_entry_t *driver = NULL;
Ronald Croncf56a0a2020-08-04 09:51:30 +02001949 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskined7729582019-08-05 15:55:54 +02001950
1951 /* Leaving attributes unspecified is not currently supported.
1952 * It could make sense to query the key type and size from the
1953 * secure element, but not all secure elements support this
1954 * and the driver HAL doesn't currently support it. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001955 if (psa_get_key_type(attributes) == PSA_KEY_TYPE_NONE) {
1956 return PSA_ERROR_NOT_SUPPORTED;
1957 }
1958 if (psa_get_key_bits(attributes) == 0) {
1959 return PSA_ERROR_NOT_SUPPORTED;
1960 }
Gilles Peskined7729582019-08-05 15:55:54 +02001961
Gilles Peskine449bd832023-01-11 14:50:10 +01001962 status = psa_start_key_creation(PSA_KEY_CREATION_REGISTER, attributes,
1963 &slot, &driver);
1964 if (status != PSA_SUCCESS) {
Gilles Peskined7729582019-08-05 15:55:54 +02001965 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001966 }
Gilles Peskined7729582019-08-05 15:55:54 +02001967
Gilles Peskine449bd832023-01-11 14:50:10 +01001968 status = psa_finish_key_creation(slot, driver, &key);
Gilles Peskined7729582019-08-05 15:55:54 +02001969
1970exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01001971 if (status != PSA_SUCCESS) {
1972 psa_fail_key_creation(slot, driver);
1973 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001974
Gilles Peskined7729582019-08-05 15:55:54 +02001975 /* Registration doesn't keep the key in RAM. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001976 psa_close_key(key);
1977 return status;
Gilles Peskined7729582019-08-05 15:55:54 +02001978}
1979#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1980
Gilles Peskine449bd832023-01-11 14:50:10 +01001981psa_status_t psa_copy_key(mbedtls_svc_key_id_t source_key,
1982 const psa_key_attributes_t *specified_attributes,
1983 mbedtls_svc_key_id_t *target_key)
Gilles Peskinef603c712019-01-19 13:40:11 +01001984{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001985 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001986 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinef603c712019-01-19 13:40:11 +01001987 psa_key_slot_t *source_slot = NULL;
1988 psa_key_slot_t *target_slot = NULL;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001989 psa_key_attributes_t actual_attributes = *specified_attributes;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001990 psa_se_drv_table_entry_t *driver = NULL;
Archana8a180362021-07-05 02:18:48 +05301991 size_t storage_size = 0;
Gilles Peskinef603c712019-01-19 13:40:11 +01001992
Ronald Cron81709fc2020-11-14 12:10:32 +01001993 *target_key = MBEDTLS_SVC_KEY_ID_INIT;
1994
Archana8a180362021-07-05 02:18:48 +05301995 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01001996 source_key, &source_slot, PSA_KEY_USAGE_COPY, 0);
1997 if (status != PSA_SUCCESS) {
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001998 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001999 }
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002000
Gilles Peskine449bd832023-01-11 14:50:10 +01002001 status = psa_validate_optional_attributes(source_slot,
2002 specified_attributes);
2003 if (status != PSA_SUCCESS) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002004 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002005 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002006
Archana9d17bf42021-09-10 06:22:44 +05302007 /* The target key type and number of bits have been validated by
2008 * psa_validate_optional_attributes() to be either equal to zero or
2009 * equal to the ones of the source key. So it is safe to inherit
2010 * them from the source key now."
Archana374fe5b2021-09-08 15:50:28 +05302011 * */
Gilles Peskine2f107ae2024-02-28 01:26:46 +01002012 actual_attributes.bits = source_slot->attr.bits;
2013 actual_attributes.type = source_slot->attr.type;
Archana374fe5b2021-09-08 15:50:28 +05302014
2015
Gilles Peskine449bd832023-01-11 14:50:10 +01002016 status = psa_restrict_key_policy(source_slot->attr.type,
Gilles Peskine2f107ae2024-02-28 01:26:46 +01002017 &actual_attributes.policy,
Gilles Peskine449bd832023-01-11 14:50:10 +01002018 &source_slot->attr.policy);
2019 if (status != PSA_SUCCESS) {
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002020 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002021 }
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002022
Gilles Peskine449bd832023-01-11 14:50:10 +01002023 status = psa_start_key_creation(PSA_KEY_CREATION_COPY, &actual_attributes,
2024 &target_slot, &driver);
2025 if (status != PSA_SUCCESS) {
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002026 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002027 }
2028 if (PSA_KEY_LIFETIME_GET_LOCATION(target_slot->attr.lifetime) !=
2029 PSA_KEY_LIFETIME_GET_LOCATION(source_slot->attr.lifetime)) {
Archana8a180362021-07-05 02:18:48 +05302030 /*
Archana9d17bf42021-09-10 06:22:44 +05302031 * If the source and target keys are stored in different locations,
Archana8a180362021-07-05 02:18:48 +05302032 * the source key would need to be exported as plaintext and re-imported
2033 * in the other location. This has security implications which have not
Archana449608b2021-09-08 15:36:05 +05302034 * been fully mapped. For now, this can be achieved through
Archana8a180362021-07-05 02:18:48 +05302035 * appropriate API invocations from the application, if needed.
2036 * */
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002037 status = PSA_ERROR_NOT_SUPPORTED;
2038 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002039 }
Archana8a180362021-07-05 02:18:48 +05302040 /*
2041 * When the source and target keys are within the same location,
Archana449608b2021-09-08 15:36:05 +05302042 * - For transparent keys it is a blind copy without any driver invocation,
Archana8a180362021-07-05 02:18:48 +05302043 * - For opaque keys this translates to an invocation of the drivers'
2044 * copy_key entry point through the dispatch layer.
2045 * */
Gilles Peskine2f107ae2024-02-28 01:26:46 +01002046 if (psa_key_lifetime_is_external(actual_attributes.lifetime)) {
Gilles Peskine449bd832023-01-11 14:50:10 +01002047 status = psa_driver_wrapper_get_key_buffer_size(&actual_attributes,
2048 &storage_size);
2049 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302050 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002051 }
Archana374fe5b2021-09-08 15:50:28 +05302052
Gilles Peskine449bd832023-01-11 14:50:10 +01002053 status = psa_allocate_buffer_to_slot(target_slot, storage_size);
2054 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302055 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002056 }
Archana374fe5b2021-09-08 15:50:28 +05302057
Gilles Peskine449bd832023-01-11 14:50:10 +01002058 status = psa_driver_wrapper_copy_key(&actual_attributes,
2059 source_slot->key.data,
2060 source_slot->key.bytes,
2061 target_slot->key.data,
2062 target_slot->key.bytes,
2063 &target_slot->key.bytes);
2064 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302065 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002066 }
2067 } else {
2068 status = psa_copy_key_material_into_slot(target_slot,
Archana9d17bf42021-09-10 06:22:44 +05302069 source_slot->key.data,
Gilles Peskine449bd832023-01-11 14:50:10 +01002070 source_slot->key.bytes);
2071 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302072 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002073 }
Archana8a180362021-07-05 02:18:48 +05302074 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002075 status = psa_finish_key_creation(target_slot, driver, target_key);
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002076exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002077 if (status != PSA_SUCCESS) {
2078 psa_fail_key_creation(target_slot, driver);
2079 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002080
Ryan Everetta103ec92024-01-31 13:59:57 +00002081 unlock_status = psa_unregister_read_under_mutex(source_slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02002082
Gilles Peskine449bd832023-01-11 14:50:10 +01002083 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskinef603c712019-01-19 13:40:11 +01002084}
2085
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02002086
2087
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01002088/****************************************************************/
Gilles Peskine20035e32018-02-03 22:44:14 +01002089/* Message digests */
2090/****************************************************************/
2091
Gilles Peskine449bd832023-01-11 14:50:10 +01002092psa_status_t psa_hash_abort(psa_hash_operation_t *operation)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002093{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002094 /* Aborting a non-active operation is allowed */
Gilles Peskine449bd832023-01-11 14:50:10 +01002095 if (operation->id == 0) {
2096 return PSA_SUCCESS;
2097 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002098
Gilles Peskine449bd832023-01-11 14:50:10 +01002099 psa_status_t status = psa_driver_wrapper_hash_abort(operation);
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002100 operation->id = 0;
2101
Gilles Peskine449bd832023-01-11 14:50:10 +01002102 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002103}
2104
Gilles Peskine449bd832023-01-11 14:50:10 +01002105psa_status_t psa_hash_setup(psa_hash_operation_t *operation,
2106 psa_algorithm_t alg)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002107{
Dave Rodgman685b6a72021-06-24 11:49:14 +01002108 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002109
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002110 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002111 if (operation->id != 0) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002112 status = PSA_ERROR_BAD_STATE;
2113 goto exit;
2114 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002115
Gilles Peskine449bd832023-01-11 14:50:10 +01002116 if (!PSA_ALG_IS_HASH(alg)) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002117 status = PSA_ERROR_INVALID_ARGUMENT;
2118 goto exit;
2119 }
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002120
Steven Cooremanb6bf4bb2021-03-15 19:00:14 +01002121 /* Ensure all of the context is zeroized, since PSA_HASH_OPERATION_INIT only
2122 * directly zeroes the int-sized dummy member of the context union. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002123 memset(&operation->ctx, 0, sizeof(operation->ctx));
Steven Cooreman893232f2021-03-15 12:23:37 +01002124
Gilles Peskine449bd832023-01-11 14:50:10 +01002125 status = psa_driver_wrapper_hash_setup(operation, alg);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002126
2127exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002128 if (status != PSA_SUCCESS) {
2129 psa_hash_abort(operation);
2130 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002131
2132 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002133}
2134
Gilles Peskine449bd832023-01-11 14:50:10 +01002135psa_status_t psa_hash_update(psa_hash_operation_t *operation,
2136 const uint8_t *input,
2137 size_t input_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002138{
Dave Rodgman685b6a72021-06-24 11:49:14 +01002139 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2140
Gilles Peskine449bd832023-01-11 14:50:10 +01002141 if (operation->id == 0) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002142 status = PSA_ERROR_BAD_STATE;
2143 goto exit;
2144 }
Gilles Peskine94e44542018-07-12 16:58:43 +02002145
Steven Cooremanc8288352021-03-04 14:02:19 +01002146 /* Don't require hash implementations to behave correctly on a
2147 * zero-length input, which may have an invalid pointer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002148 if (input_length == 0) {
2149 return PSA_SUCCESS;
2150 }
Steven Cooremanc8288352021-03-04 14:02:19 +01002151
Gilles Peskine449bd832023-01-11 14:50:10 +01002152 status = psa_driver_wrapper_hash_update(operation, input, input_length);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002153
2154exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002155 if (status != PSA_SUCCESS) {
2156 psa_hash_abort(operation);
2157 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002158
Gilles Peskine449bd832023-01-11 14:50:10 +01002159 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002160}
2161
Gilles Peskine449bd832023-01-11 14:50:10 +01002162psa_status_t psa_hash_finish(psa_hash_operation_t *operation,
2163 uint8_t *hash,
2164 size_t hash_size,
2165 size_t *hash_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002166{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002167 *hash_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002168 if (operation->id == 0) {
2169 return PSA_ERROR_BAD_STATE;
2170 }
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002171
Steven Cooreman1e582352021-02-18 17:24:37 +01002172 psa_status_t status = psa_driver_wrapper_hash_finish(
Gilles Peskine449bd832023-01-11 14:50:10 +01002173 operation, hash, hash_size, hash_length);
2174 psa_hash_abort(operation);
2175 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002176}
2177
Gilles Peskine449bd832023-01-11 14:50:10 +01002178psa_status_t psa_hash_verify(psa_hash_operation_t *operation,
2179 const uint8_t *hash,
2180 size_t hash_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002181{
Ronald Cron69a63422021-10-18 09:47:58 +02002182 uint8_t actual_hash[PSA_HASH_MAX_SIZE];
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002183 size_t actual_hash_length;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002184 psa_status_t status = psa_hash_finish(
Gilles Peskine449bd832023-01-11 14:50:10 +01002185 operation,
2186 actual_hash, sizeof(actual_hash),
2187 &actual_hash_length);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002188
Gilles Peskine449bd832023-01-11 14:50:10 +01002189 if (status != PSA_SUCCESS) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002190 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002191 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002192
Gilles Peskine449bd832023-01-11 14:50:10 +01002193 if (actual_hash_length != hash_length) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002194 status = PSA_ERROR_INVALID_SIGNATURE;
2195 goto exit;
2196 }
2197
Dave Rodgman78701152023-08-29 14:20:18 +01002198 if (mbedtls_ct_memcmp(hash, actual_hash, actual_hash_length) != 0) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002199 status = PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01002200 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002201
2202exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002203 mbedtls_platform_zeroize(actual_hash, sizeof(actual_hash));
2204 if (status != PSA_SUCCESS) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002205 psa_hash_abort(operation);
Gilles Peskine449bd832023-01-11 14:50:10 +01002206 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002207
Gilles Peskine449bd832023-01-11 14:50:10 +01002208 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002209}
2210
Gilles Peskine449bd832023-01-11 14:50:10 +01002211psa_status_t psa_hash_compute(psa_algorithm_t alg,
2212 const uint8_t *input, size_t input_length,
2213 uint8_t *hash, size_t hash_size,
2214 size_t *hash_length)
Gilles Peskine0a749c82019-11-28 19:33:58 +01002215{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002216 *hash_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002217 if (!PSA_ALG_IS_HASH(alg)) {
2218 return PSA_ERROR_INVALID_ARGUMENT;
2219 }
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002220
Gilles Peskine449bd832023-01-11 14:50:10 +01002221 return psa_driver_wrapper_hash_compute(alg, input, input_length,
2222 hash, hash_size, hash_length);
Gilles Peskine0a749c82019-11-28 19:33:58 +01002223}
2224
Gilles Peskine449bd832023-01-11 14:50:10 +01002225psa_status_t psa_hash_compare(psa_algorithm_t alg,
2226 const uint8_t *input, size_t input_length,
2227 const uint8_t *hash, size_t hash_length)
Gilles Peskine0a749c82019-11-28 19:33:58 +01002228{
Ronald Cron69a63422021-10-18 09:47:58 +02002229 uint8_t actual_hash[PSA_HASH_MAX_SIZE];
Steven Cooreman84d670d2021-02-18 16:22:53 +01002230 size_t actual_hash_length;
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002231
Gilles Peskine449bd832023-01-11 14:50:10 +01002232 if (!PSA_ALG_IS_HASH(alg)) {
2233 return PSA_ERROR_INVALID_ARGUMENT;
2234 }
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002235
Steven Cooreman1e582352021-02-18 17:24:37 +01002236 psa_status_t status = psa_driver_wrapper_hash_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01002237 alg, input, input_length,
2238 actual_hash, sizeof(actual_hash),
2239 &actual_hash_length);
2240 if (status != PSA_SUCCESS) {
Gilles Peskine60aebec2021-12-13 12:33:18 +01002241 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002242 }
2243 if (actual_hash_length != hash_length) {
Gilles Peskine60aebec2021-12-13 12:33:18 +01002244 status = PSA_ERROR_INVALID_SIGNATURE;
2245 goto exit;
2246 }
Dave Rodgman78701152023-08-29 14:20:18 +01002247 if (mbedtls_ct_memcmp(hash, actual_hash, actual_hash_length) != 0) {
Gilles Peskine60aebec2021-12-13 12:33:18 +01002248 status = PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01002249 }
Gilles Peskine60aebec2021-12-13 12:33:18 +01002250
2251exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002252 mbedtls_platform_zeroize(actual_hash, sizeof(actual_hash));
2253 return status;
Gilles Peskine0a749c82019-11-28 19:33:58 +01002254}
2255
Gilles Peskine449bd832023-01-11 14:50:10 +01002256psa_status_t psa_hash_clone(const psa_hash_operation_t *source_operation,
2257 psa_hash_operation_t *target_operation)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002258{
Gilles Peskine449bd832023-01-11 14:50:10 +01002259 if (source_operation->id == 0 ||
2260 target_operation->id != 0) {
2261 return PSA_ERROR_BAD_STATE;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002262 }
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002263
Gilles Peskine449bd832023-01-11 14:50:10 +01002264 psa_status_t status = psa_driver_wrapper_hash_clone(source_operation,
2265 target_operation);
2266 if (status != PSA_SUCCESS) {
2267 psa_hash_abort(target_operation);
2268 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002269
Gilles Peskine449bd832023-01-11 14:50:10 +01002270 return status;
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002271}
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002272
2273
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002274/****************************************************************/
Gilles Peskine8c9def32018-02-08 10:02:12 +01002275/* MAC */
2276/****************************************************************/
2277
Gilles Peskine449bd832023-01-11 14:50:10 +01002278psa_status_t psa_mac_abort(psa_mac_operation_t *operation)
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002279{
Steven Cooremane6804192021-03-19 18:28:56 +01002280 /* Aborting a non-active operation is allowed */
Gilles Peskine449bd832023-01-11 14:50:10 +01002281 if (operation->id == 0) {
2282 return PSA_SUCCESS;
2283 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002284
Gilles Peskine449bd832023-01-11 14:50:10 +01002285 psa_status_t status = psa_driver_wrapper_mac_abort(operation);
Steven Cooreman72f736a2021-05-07 14:14:37 +02002286 operation->mac_size = 0;
2287 operation->is_sign = 0;
Steven Cooremane6804192021-03-19 18:28:56 +01002288 operation->id = 0;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002289
Gilles Peskine449bd832023-01-11 14:50:10 +01002290 return status;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002291}
2292
Ronald Cron2dff3b22021-06-17 16:33:22 +02002293static psa_status_t psa_mac_finalize_alg_and_key_validation(
2294 psa_algorithm_t alg,
Ronald Cron79bdd822021-06-17 16:46:44 +02002295 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01002296 uint8_t *mac_size)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002297{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002298 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002299 psa_key_type_t key_type = psa_get_key_type(attributes);
2300 size_t key_bits = psa_get_key_bits(attributes);
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002301
Gilles Peskine449bd832023-01-11 14:50:10 +01002302 if (!PSA_ALG_IS_MAC(alg)) {
2303 return PSA_ERROR_INVALID_ARGUMENT;
2304 }
Steven Cooremane6804192021-03-19 18:28:56 +01002305
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002306 /* Validate the combination of key type and algorithm */
Gilles Peskine449bd832023-01-11 14:50:10 +01002307 status = psa_mac_key_can_do(alg, key_type);
2308 if (status != PSA_SUCCESS) {
2309 return status;
2310 }
Steven Cooreman15472f82021-03-02 16:16:22 +01002311
Steven Cooremand1a68f12021-05-10 11:13:41 +02002312 /* Get the output length for the algorithm and key combination */
Gilles Peskine449bd832023-01-11 14:50:10 +01002313 *mac_size = PSA_MAC_LENGTH(key_type, key_bits, alg);
Steven Cooreman15472f82021-03-02 16:16:22 +01002314
Gilles Peskine449bd832023-01-11 14:50:10 +01002315 if (*mac_size < 4) {
Steven Cooreman15472f82021-03-02 16:16:22 +01002316 /* A very short MAC is too short for security since it can be
2317 * brute-forced. Ancient protocols with 32-bit MACs do exist,
2318 * so we make this our minimum, even though 32 bits is still
2319 * too small for security. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002320 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman15472f82021-03-02 16:16:22 +01002321 }
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02002322
Gilles Peskine449bd832023-01-11 14:50:10 +01002323 if (*mac_size > PSA_MAC_LENGTH(key_type, key_bits,
2324 PSA_ALG_FULL_LENGTH_MAC(alg))) {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002325 /* It's impossible to "truncate" to a larger length than the full length
2326 * of the algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002327 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002328 }
2329
Gilles Peskine449bd832023-01-11 14:50:10 +01002330 if (*mac_size > PSA_MAC_MAX_SIZE) {
Gilles Peskinea9b6c802022-03-16 13:54:49 +01002331 /* PSA_MAC_LENGTH returns the correct length even for a MAC algorithm
2332 * that is disabled in the compile-time configuration. The result can
2333 * therefore be larger than PSA_MAC_MAX_SIZE, which does take the
2334 * configuration into account. In this case, force a return of
2335 * PSA_ERROR_NOT_SUPPORTED here. Otherwise psa_mac_verify(), or
2336 * psa_mac_compute(mac_size=PSA_MAC_MAX_SIZE), would return
2337 * PSA_ERROR_BUFFER_TOO_SMALL for an unsupported algorithm whose MAC size
2338 * is larger than PSA_MAC_MAX_SIZE, which is misleading and which breaks
2339 * systematically generated tests. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002340 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea9b6c802022-03-16 13:54:49 +01002341 }
2342
Gilles Peskine449bd832023-01-11 14:50:10 +01002343 return PSA_SUCCESS;
Ronald Cron2dff3b22021-06-17 16:33:22 +02002344}
2345
Gilles Peskine449bd832023-01-11 14:50:10 +01002346static psa_status_t psa_mac_setup(psa_mac_operation_t *operation,
2347 mbedtls_svc_key_id_t key,
2348 psa_algorithm_t alg,
2349 int is_sign)
Gilles Peskinee59236f2018-01-27 23:32:46 +01002350{
2351 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2352 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman54648242021-06-24 11:49:45 +01002353 psa_key_slot_t *slot = NULL;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002354
2355 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002356 if (operation->id != 0) {
Dave Rodgman54648242021-06-24 11:49:45 +01002357 status = PSA_ERROR_BAD_STATE;
2358 goto exit;
2359 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002360
2361 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002362 key,
2363 &slot,
2364 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
2365 alg);
2366 if (status != PSA_SUCCESS) {
Dave Rodgman54648242021-06-24 11:49:45 +01002367 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002368 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002369
Gilles Peskine7a5d9202024-02-28 01:18:23 +01002370 status = psa_mac_finalize_alg_and_key_validation(alg, &slot->attr,
Gilles Peskine449bd832023-01-11 14:50:10 +01002371 &operation->mac_size);
2372 if (status != PSA_SUCCESS) {
Gilles Peskine8c9def32018-02-08 10:02:12 +01002373 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002374 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002375
2376 operation->is_sign = is_sign;
Steven Cooremane6804192021-03-19 18:28:56 +01002377 /* Dispatch the MAC setup call with validated input */
Gilles Peskine449bd832023-01-11 14:50:10 +01002378 if (is_sign) {
2379 status = psa_driver_wrapper_mac_sign_setup(operation,
Gilles Peskine7a5d9202024-02-28 01:18:23 +01002380 &slot->attr,
Gilles Peskine449bd832023-01-11 14:50:10 +01002381 slot->key.data,
2382 slot->key.bytes,
2383 alg);
2384 } else {
2385 status = psa_driver_wrapper_mac_verify_setup(operation,
Gilles Peskine7a5d9202024-02-28 01:18:23 +01002386 &slot->attr,
Gilles Peskine449bd832023-01-11 14:50:10 +01002387 slot->key.data,
2388 slot->key.bytes,
2389 alg);
Gilles Peskine8c9def32018-02-08 10:02:12 +01002390 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002391
Gilles Peskinefbfac682018-07-08 20:51:54 +02002392exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002393 if (status != PSA_SUCCESS) {
2394 psa_mac_abort(operation);
2395 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002396
Ryan Everettfb9857f2024-02-14 12:16:41 +00002397 unlock_status = psa_unregister_read_under_mutex(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02002398
Gilles Peskine449bd832023-01-11 14:50:10 +01002399 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002400}
2401
Gilles Peskine449bd832023-01-11 14:50:10 +01002402psa_status_t psa_mac_sign_setup(psa_mac_operation_t *operation,
2403 mbedtls_svc_key_id_t key,
2404 psa_algorithm_t alg)
Gilles Peskine89167cb2018-07-08 20:12:23 +02002405{
Gilles Peskine449bd832023-01-11 14:50:10 +01002406 return psa_mac_setup(operation, key, alg, 1);
Gilles Peskine89167cb2018-07-08 20:12:23 +02002407}
2408
Gilles Peskine449bd832023-01-11 14:50:10 +01002409psa_status_t psa_mac_verify_setup(psa_mac_operation_t *operation,
2410 mbedtls_svc_key_id_t key,
2411 psa_algorithm_t alg)
Gilles Peskine89167cb2018-07-08 20:12:23 +02002412{
Gilles Peskine449bd832023-01-11 14:50:10 +01002413 return psa_mac_setup(operation, key, alg, 0);
Gilles Peskine89167cb2018-07-08 20:12:23 +02002414}
2415
Gilles Peskine449bd832023-01-11 14:50:10 +01002416psa_status_t psa_mac_update(psa_mac_operation_t *operation,
2417 const uint8_t *input,
2418 size_t input_length)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002419{
Gilles Peskine449bd832023-01-11 14:50:10 +01002420 if (operation->id == 0) {
2421 return PSA_ERROR_BAD_STATE;
2422 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002423
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002424 /* Don't require hash implementations to behave correctly on a
2425 * zero-length input, which may have an invalid pointer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002426 if (input_length == 0) {
2427 return PSA_SUCCESS;
2428 }
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03002429
Gilles Peskine449bd832023-01-11 14:50:10 +01002430 psa_status_t status = psa_driver_wrapper_mac_update(operation,
2431 input, input_length);
2432 if (status != PSA_SUCCESS) {
2433 psa_mac_abort(operation);
2434 }
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002435
Gilles Peskine449bd832023-01-11 14:50:10 +01002436 return status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002437}
2438
Gilles Peskine449bd832023-01-11 14:50:10 +01002439psa_status_t psa_mac_sign_finish(psa_mac_operation_t *operation,
2440 uint8_t *mac,
2441 size_t mac_size,
2442 size_t *mac_length)
mohammad16036df908f2018-04-02 08:34:15 -07002443{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002444 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2445 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002446
Gilles Peskine449bd832023-01-11 14:50:10 +01002447 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002448 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002449 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002450 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002451
Gilles Peskine449bd832023-01-11 14:50:10 +01002452 if (!operation->is_sign) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002453 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002454 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002455 }
Steven Cooreman72f736a2021-05-07 14:14:37 +02002456
Steven Cooreman8af5c5c2021-05-11 11:09:13 +02002457 /* Sanity check. This will guarantee that mac_size != 0 (and so mac != NULL)
2458 * once all the error checks are done. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002459 if (operation->mac_size == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002460 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002461 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002462 }
Steven Cooreman8af5c5c2021-05-11 11:09:13 +02002463
Gilles Peskine449bd832023-01-11 14:50:10 +01002464 if (mac_size < operation->mac_size) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002465 status = PSA_ERROR_BUFFER_TOO_SMALL;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002466 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002467 }
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002468
Gilles Peskine449bd832023-01-11 14:50:10 +01002469 status = psa_driver_wrapper_mac_sign_finish(operation,
2470 mac, operation->mac_size,
2471 mac_length);
Steven Cooreman72f736a2021-05-07 14:14:37 +02002472
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002473exit:
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002474 /* In case of success, set the potential excess room in the output buffer
2475 * to an invalid value, to avoid potentially leaking a longer MAC.
2476 * In case of error, set the output length and content to a safe default,
2477 * such that in case the caller misses an error check, the output would be
2478 * an unachievable MAC.
2479 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002480 if (status != PSA_SUCCESS) {
Steven Cooreman72f736a2021-05-07 14:14:37 +02002481 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002482 operation->mac_size = 0;
Steven Cooreman72f736a2021-05-07 14:14:37 +02002483 }
mohammad16036df908f2018-04-02 08:34:15 -07002484
Paul Elliottdc42ca82023-02-24 18:11:59 +00002485 psa_wipe_tag_output_buffer(mac, status, mac_size, *mac_length);
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002486
Gilles Peskine449bd832023-01-11 14:50:10 +01002487 abort_status = psa_mac_abort(operation);
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002488
Gilles Peskine449bd832023-01-11 14:50:10 +01002489 return status == PSA_SUCCESS ? abort_status : status;
mohammad16036df908f2018-04-02 08:34:15 -07002490}
2491
Gilles Peskine449bd832023-01-11 14:50:10 +01002492psa_status_t psa_mac_verify_finish(psa_mac_operation_t *operation,
2493 const uint8_t *mac,
2494 size_t mac_length)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002495{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002496 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2497 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002498
Gilles Peskine449bd832023-01-11 14:50:10 +01002499 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002500 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002501 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002502 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002503
Gilles Peskine449bd832023-01-11 14:50:10 +01002504 if (operation->is_sign) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002505 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002506 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002507 }
Steven Cooreman72f736a2021-05-07 14:14:37 +02002508
Gilles Peskine449bd832023-01-11 14:50:10 +01002509 if (operation->mac_size != mac_length) {
Steven Cooreman72f736a2021-05-07 14:14:37 +02002510 status = PSA_ERROR_INVALID_SIGNATURE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002511 goto exit;
Steven Cooreman72f736a2021-05-07 14:14:37 +02002512 }
2513
Gilles Peskine449bd832023-01-11 14:50:10 +01002514 status = psa_driver_wrapper_mac_verify_finish(operation,
2515 mac, mac_length);
Steven Cooreman72f736a2021-05-07 14:14:37 +02002516
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002517exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002518 abort_status = psa_mac_abort(operation);
mohammad16036df908f2018-04-02 08:34:15 -07002519
Gilles Peskine449bd832023-01-11 14:50:10 +01002520 return status == PSA_SUCCESS ? abort_status : status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002521}
2522
Gilles Peskine449bd832023-01-11 14:50:10 +01002523static psa_status_t psa_mac_compute_internal(mbedtls_svc_key_id_t key,
2524 psa_algorithm_t alg,
2525 const uint8_t *input,
2526 size_t input_length,
2527 uint8_t *mac,
2528 size_t mac_size,
2529 size_t *mac_length,
2530 int is_sign)
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002531{
2532 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron51131b52021-06-17 17:17:20 +02002533 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2534 psa_key_slot_t *slot;
2535 uint8_t operation_mac_size = 0;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002536
Ronald Cron51131b52021-06-17 17:17:20 +02002537 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002538 key,
2539 &slot,
2540 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
2541 alg);
2542 if (status != PSA_SUCCESS) {
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002543 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002544 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002545
Gilles Peskine7a5d9202024-02-28 01:18:23 +01002546 status = psa_mac_finalize_alg_and_key_validation(alg, &slot->attr,
Gilles Peskine449bd832023-01-11 14:50:10 +01002547 &operation_mac_size);
2548 if (status != PSA_SUCCESS) {
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002549 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002550 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002551
Gilles Peskine449bd832023-01-11 14:50:10 +01002552 if (mac_size < operation_mac_size) {
Ronald Cron51131b52021-06-17 17:17:20 +02002553 status = PSA_ERROR_BUFFER_TOO_SMALL;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002554 goto exit;
Ronald Cron51131b52021-06-17 17:17:20 +02002555 }
2556
2557 status = psa_driver_wrapper_mac_compute(
Gilles Peskine7a5d9202024-02-28 01:18:23 +01002558 &slot->attr,
Gilles Peskine449bd832023-01-11 14:50:10 +01002559 slot->key.data, slot->key.bytes,
2560 alg,
2561 input, input_length,
2562 mac, operation_mac_size, mac_length);
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002563
2564exit:
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002565 /* In case of success, set the potential excess room in the output buffer
2566 * to an invalid value, to avoid potentially leaking a longer MAC.
2567 * In case of error, set the output length and content to a safe default,
2568 * such that in case the caller misses an error check, the output would be
2569 * an unachievable MAC.
2570 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002571 if (status != PSA_SUCCESS) {
Ronald Cron51131b52021-06-17 17:17:20 +02002572 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002573 operation_mac_size = 0;
Ronald Cron51131b52021-06-17 17:17:20 +02002574 }
Paul Elliottdc42ca82023-02-24 18:11:59 +00002575
2576 psa_wipe_tag_output_buffer(mac, status, mac_size, *mac_length);
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002577
Ryan Everetta103ec92024-01-31 13:59:57 +00002578 unlock_status = psa_unregister_read_under_mutex(slot);
Ronald Cron51131b52021-06-17 17:17:20 +02002579
Gilles Peskine449bd832023-01-11 14:50:10 +01002580 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002581}
2582
Gilles Peskine449bd832023-01-11 14:50:10 +01002583psa_status_t psa_mac_compute(mbedtls_svc_key_id_t key,
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002584 psa_algorithm_t alg,
2585 const uint8_t *input,
2586 size_t input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002587 uint8_t *mac,
2588 size_t mac_size,
2589 size_t *mac_length)
2590{
2591 return psa_mac_compute_internal(key, alg,
2592 input, input_length,
2593 mac, mac_size, mac_length, 1);
2594}
2595
2596psa_status_t psa_mac_verify(mbedtls_svc_key_id_t key,
2597 psa_algorithm_t alg,
2598 const uint8_t *input,
2599 size_t input_length,
2600 const uint8_t *mac,
2601 size_t mac_length)
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002602{
2603 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Crona587cbc2021-06-18 14:51:29 +02002604 uint8_t actual_mac[PSA_MAC_MAX_SIZE];
2605 size_t actual_mac_length;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002606
Gilles Peskine449bd832023-01-11 14:50:10 +01002607 status = psa_mac_compute_internal(key, alg,
2608 input, input_length,
2609 actual_mac, sizeof(actual_mac),
2610 &actual_mac_length, 0);
2611 if (status != PSA_SUCCESS) {
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002612 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002613 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002614
Gilles Peskine449bd832023-01-11 14:50:10 +01002615 if (mac_length != actual_mac_length) {
Ronald Crona587cbc2021-06-18 14:51:29 +02002616 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002617 goto exit;
Ronald Crona587cbc2021-06-18 14:51:29 +02002618 }
Dave Rodgman78701152023-08-29 14:20:18 +01002619 if (mbedtls_ct_memcmp(mac, actual_mac, actual_mac_length) != 0) {
Ronald Crona587cbc2021-06-18 14:51:29 +02002620 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002621 goto exit;
Ronald Crona587cbc2021-06-18 14:51:29 +02002622 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002623
2624exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002625 mbedtls_platform_zeroize(actual_mac, sizeof(actual_mac));
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002626
Gilles Peskine449bd832023-01-11 14:50:10 +01002627 return status;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002628}
Gilles Peskinee59236f2018-01-27 23:32:46 +01002629
Gilles Peskinee59236f2018-01-27 23:32:46 +01002630/****************************************************************/
2631/* Asymmetric cryptography */
2632/****************************************************************/
2633
Gilles Peskine449bd832023-01-11 14:50:10 +01002634static psa_status_t psa_sign_verify_check_alg(int input_is_message,
2635 psa_algorithm_t alg)
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002636{
Gilles Peskine449bd832023-01-11 14:50:10 +01002637 if (input_is_message) {
2638 if (!PSA_ALG_IS_SIGN_MESSAGE(alg)) {
2639 return PSA_ERROR_INVALID_ARGUMENT;
2640 }
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002641
Gilles Peskine449bd832023-01-11 14:50:10 +01002642 if (PSA_ALG_IS_SIGN_HASH(alg)) {
2643 if (!PSA_ALG_IS_HASH(PSA_ALG_SIGN_GET_HASH(alg))) {
2644 return PSA_ERROR_INVALID_ARGUMENT;
2645 }
2646 }
2647 } else {
2648 if (!PSA_ALG_IS_SIGN_HASH(alg)) {
2649 return PSA_ERROR_INVALID_ARGUMENT;
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002650 }
2651 }
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002652
Gilles Peskine449bd832023-01-11 14:50:10 +01002653 return PSA_SUCCESS;
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002654}
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002655
Gilles Peskine449bd832023-01-11 14:50:10 +01002656static psa_status_t psa_sign_internal(mbedtls_svc_key_id_t key,
2657 int input_is_message,
2658 psa_algorithm_t alg,
2659 const uint8_t *input,
2660 size_t input_length,
2661 uint8_t *signature,
2662 size_t signature_size,
2663 size_t *signature_length)
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002664{
2665 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2666 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2667 psa_key_slot_t *slot;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002668
2669 *signature_length = 0;
2670
Gilles Peskine449bd832023-01-11 14:50:10 +01002671 status = psa_sign_verify_check_alg(input_is_message, alg);
2672 if (status != PSA_SUCCESS) {
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002673 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002674 }
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002675
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002676 /* Immediately reject a zero-length signature buffer. This guarantees
gabor-mezei-arm12b4f342021-05-05 13:54:55 +02002677 * that signature must be a valid pointer. (On the other hand, the input
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002678 * buffer can in principle be empty since it doesn't actually have
2679 * to be a hash.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01002680 if (signature_size == 0) {
2681 return PSA_ERROR_BUFFER_TOO_SMALL;
2682 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002683
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002684 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002685 key, &slot,
2686 input_is_message ? PSA_KEY_USAGE_SIGN_MESSAGE :
2687 PSA_KEY_USAGE_SIGN_HASH,
2688 alg);
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002689
Gilles Peskine449bd832023-01-11 14:50:10 +01002690 if (status != PSA_SUCCESS) {
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002691 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002692 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002693
Gilles Peskine449bd832023-01-11 14:50:10 +01002694 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002695 status = PSA_ERROR_INVALID_ARGUMENT;
2696 goto exit;
2697 }
2698
Gilles Peskine449bd832023-01-11 14:50:10 +01002699 if (input_is_message) {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002700 status = psa_driver_wrapper_sign_message(
Gilles Peskine7a5d9202024-02-28 01:18:23 +01002701 &slot->attr, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002702 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002703 signature, signature_size, signature_length);
2704 } else {
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002705
2706 status = psa_driver_wrapper_sign_hash(
Gilles Peskine7a5d9202024-02-28 01:18:23 +01002707 &slot->attr, slot->key.data, slot->key.bytes,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002708 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002709 signature, signature_size, signature_length);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002710 }
2711
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002712
2713exit:
Paul Elliott59200a22023-02-21 15:07:40 +00002714 psa_wipe_tag_output_buffer(signature, status, signature_size,
2715 *signature_length);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002716
Ryan Everetta103ec92024-01-31 13:59:57 +00002717 unlock_status = psa_unregister_read_under_mutex(slot);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002718
Gilles Peskine449bd832023-01-11 14:50:10 +01002719 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002720}
2721
Gilles Peskine449bd832023-01-11 14:50:10 +01002722static psa_status_t psa_verify_internal(mbedtls_svc_key_id_t key,
2723 int input_is_message,
2724 psa_algorithm_t alg,
2725 const uint8_t *input,
2726 size_t input_length,
2727 const uint8_t *signature,
2728 size_t signature_length)
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002729{
2730 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2731 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2732 psa_key_slot_t *slot;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002733
Gilles Peskine449bd832023-01-11 14:50:10 +01002734 status = psa_sign_verify_check_alg(input_is_message, alg);
2735 if (status != PSA_SUCCESS) {
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002736 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002737 }
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002738
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002739 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002740 key, &slot,
2741 input_is_message ? PSA_KEY_USAGE_VERIFY_MESSAGE :
2742 PSA_KEY_USAGE_VERIFY_HASH,
2743 alg);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002744
Gilles Peskine449bd832023-01-11 14:50:10 +01002745 if (status != PSA_SUCCESS) {
2746 return status;
2747 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002748
Gilles Peskine449bd832023-01-11 14:50:10 +01002749 if (input_is_message) {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002750 status = psa_driver_wrapper_verify_message(
Gilles Peskine7a5d9202024-02-28 01:18:23 +01002751 &slot->attr, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002752 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002753 signature, signature_length);
2754 } else {
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002755 status = psa_driver_wrapper_verify_hash(
Gilles Peskine7a5d9202024-02-28 01:18:23 +01002756 &slot->attr, slot->key.data, slot->key.bytes,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002757 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002758 signature, signature_length);
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002759 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002760
Ryan Everetta103ec92024-01-31 13:59:57 +00002761 unlock_status = psa_unregister_read_under_mutex(slot);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002762
Gilles Peskine449bd832023-01-11 14:50:10 +01002763 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002764
2765}
2766
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002767psa_status_t psa_sign_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002768 const psa_key_attributes_t *attributes,
2769 const uint8_t *key_buffer,
2770 size_t key_buffer_size,
2771 psa_algorithm_t alg,
2772 const uint8_t *input,
2773 size_t input_length,
2774 uint8_t *signature,
2775 size_t signature_size,
Gilles Peskine449bd832023-01-11 14:50:10 +01002776 size_t *signature_length)
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002777{
2778 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002779
Gilles Peskine449bd832023-01-11 14:50:10 +01002780 if (PSA_ALG_IS_SIGN_HASH(alg)) {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002781 size_t hash_length;
2782 uint8_t hash[PSA_HASH_MAX_SIZE];
2783
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002784 status = psa_driver_wrapper_hash_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01002785 PSA_ALG_SIGN_GET_HASH(alg),
2786 input, input_length,
2787 hash, sizeof(hash), &hash_length);
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002788
Gilles Peskine449bd832023-01-11 14:50:10 +01002789 if (status != PSA_SUCCESS) {
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002790 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002791 }
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002792
2793 return psa_driver_wrapper_sign_hash(
Gilles Peskine449bd832023-01-11 14:50:10 +01002794 attributes, key_buffer, key_buffer_size,
2795 alg, hash, hash_length,
2796 signature, signature_size, signature_length);
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002797 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002798
Gilles Peskine449bd832023-01-11 14:50:10 +01002799 return PSA_ERROR_NOT_SUPPORTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002800}
2801
Gilles Peskine449bd832023-01-11 14:50:10 +01002802psa_status_t psa_sign_message(mbedtls_svc_key_id_t key,
2803 psa_algorithm_t alg,
2804 const uint8_t *input,
2805 size_t input_length,
2806 uint8_t *signature,
2807 size_t signature_size,
2808 size_t *signature_length)
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002809{
2810 return psa_sign_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002811 key, 1, alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002812 signature, signature_size, signature_length);
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002813}
2814
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002815psa_status_t psa_verify_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002816 const psa_key_attributes_t *attributes,
2817 const uint8_t *key_buffer,
2818 size_t key_buffer_size,
2819 psa_algorithm_t alg,
2820 const uint8_t *input,
2821 size_t input_length,
2822 const uint8_t *signature,
Gilles Peskine449bd832023-01-11 14:50:10 +01002823 size_t signature_length)
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002824{
2825 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002826
Gilles Peskine449bd832023-01-11 14:50:10 +01002827 if (PSA_ALG_IS_SIGN_HASH(alg)) {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002828 size_t hash_length;
2829 uint8_t hash[PSA_HASH_MAX_SIZE];
2830
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002831 status = psa_driver_wrapper_hash_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01002832 PSA_ALG_SIGN_GET_HASH(alg),
2833 input, input_length,
2834 hash, sizeof(hash), &hash_length);
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002835
Gilles Peskine449bd832023-01-11 14:50:10 +01002836 if (status != PSA_SUCCESS) {
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002837 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002838 }
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002839
2840 return psa_driver_wrapper_verify_hash(
Gilles Peskine449bd832023-01-11 14:50:10 +01002841 attributes, key_buffer, key_buffer_size,
2842 alg, hash, hash_length,
2843 signature, signature_length);
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002844 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002845
Gilles Peskine449bd832023-01-11 14:50:10 +01002846 return PSA_ERROR_NOT_SUPPORTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002847}
2848
Gilles Peskine449bd832023-01-11 14:50:10 +01002849psa_status_t psa_verify_message(mbedtls_svc_key_id_t key,
2850 psa_algorithm_t alg,
2851 const uint8_t *input,
2852 size_t input_length,
2853 const uint8_t *signature,
2854 size_t signature_length)
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002855{
2856 return psa_verify_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002857 key, 1, alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002858 signature, signature_length);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002859}
2860
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002861psa_status_t psa_sign_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01002862 const psa_key_attributes_t *attributes,
2863 const uint8_t *key_buffer, size_t key_buffer_size,
2864 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002865 uint8_t *signature, size_t signature_size, size_t *signature_length)
Gilles Peskinee59236f2018-01-27 23:32:46 +01002866{
Gilles Peskine2f107ae2024-02-28 01:26:46 +01002867 if (attributes->type == PSA_KEY_TYPE_RSA_KEY_PAIR) {
Gilles Peskine449bd832023-01-11 14:50:10 +01002868 if (PSA_ALG_IS_RSA_PKCS1V15_SIGN(alg) ||
2869 PSA_ALG_IS_RSA_PSS(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01002870#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01002871 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
2872 return mbedtls_psa_rsa_sign_hash(
2873 attributes,
2874 key_buffer, key_buffer_size,
2875 alg, hash, hash_length,
2876 signature, signature_size, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01002877#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
2878 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine449bd832023-01-11 14:50:10 +01002879 } else {
2880 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanacda8342020-07-24 23:09:52 +02002881 }
Gilles Peskine2f107ae2024-02-28 01:26:46 +01002882 } else if (PSA_KEY_TYPE_IS_ECC(attributes->type)) {
Gilles Peskine449bd832023-01-11 14:50:10 +01002883 if (PSA_ALG_IS_ECDSA(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01002884#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01002885 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
2886 return mbedtls_psa_ecdsa_sign_hash(
2887 attributes,
2888 key_buffer, key_buffer_size,
2889 alg, hash, hash_length,
2890 signature, signature_size, signature_length);
Gilles Peskinee59236f2018-01-27 23:32:46 +01002891#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
2892 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskine449bd832023-01-11 14:50:10 +01002893 } else {
2894 return PSA_ERROR_INVALID_ARGUMENT;
Ronald Cron4501c982021-03-19 20:09:32 +01002895 }
Ronald Cron8a494f32021-02-17 09:49:51 +01002896 }
Ronald Cron4501c982021-03-19 20:09:32 +01002897
Gilles Peskine449bd832023-01-11 14:50:10 +01002898 (void) key_buffer;
2899 (void) key_buffer_size;
2900 (void) hash;
2901 (void) hash_length;
2902 (void) signature;
2903 (void) signature_size;
2904 (void) signature_length;
Ronald Cron4501c982021-03-19 20:09:32 +01002905
Gilles Peskine449bd832023-01-11 14:50:10 +01002906 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron18659932020-12-08 16:32:23 +01002907}
Gilles Peskinee59236f2018-01-27 23:32:46 +01002908
Gilles Peskine449bd832023-01-11 14:50:10 +01002909psa_status_t psa_sign_hash(mbedtls_svc_key_id_t key,
2910 psa_algorithm_t alg,
2911 const uint8_t *hash,
2912 size_t hash_length,
2913 uint8_t *signature,
2914 size_t signature_size,
2915 size_t *signature_length)
Gilles Peskinee59236f2018-01-27 23:32:46 +01002916{
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002917 return psa_sign_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002918 key, 0, alg, hash, hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002919 signature, signature_size, signature_length);
itayzafrir5c753392018-05-08 11:18:38 +03002920}
2921
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002922psa_status_t psa_verify_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01002923 const psa_key_attributes_t *attributes,
2924 const uint8_t *key_buffer, size_t key_buffer_size,
2925 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002926 const uint8_t *signature, size_t signature_length)
itayzafrir5c753392018-05-08 11:18:38 +03002927{
Gilles Peskine2f107ae2024-02-28 01:26:46 +01002928 if (PSA_KEY_TYPE_IS_RSA(attributes->type)) {
Gilles Peskine449bd832023-01-11 14:50:10 +01002929 if (PSA_ALG_IS_RSA_PKCS1V15_SIGN(alg) ||
2930 PSA_ALG_IS_RSA_PSS(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01002931#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01002932 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
2933 return mbedtls_psa_rsa_verify_hash(
2934 attributes,
2935 key_buffer, key_buffer_size,
2936 alg, hash, hash_length,
2937 signature, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01002938#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
2939 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine449bd832023-01-11 14:50:10 +01002940 } else {
2941 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanacda8342020-07-24 23:09:52 +02002942 }
Gilles Peskine2f107ae2024-02-28 01:26:46 +01002943 } else if (PSA_KEY_TYPE_IS_ECC(attributes->type)) {
Gilles Peskine449bd832023-01-11 14:50:10 +01002944 if (PSA_ALG_IS_ECDSA(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01002945#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01002946 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
2947 return mbedtls_psa_ecdsa_verify_hash(
2948 attributes,
2949 key_buffer, key_buffer_size,
2950 alg, hash, hash_length,
2951 signature, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01002952#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
2953 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskine449bd832023-01-11 14:50:10 +01002954 } else {
2955 return PSA_ERROR_INVALID_ARGUMENT;
Ronald Cron4501c982021-03-19 20:09:32 +01002956 }
Ronald Cron8a494f32021-02-17 09:49:51 +01002957 }
Ronald Cron4501c982021-03-19 20:09:32 +01002958
Gilles Peskine449bd832023-01-11 14:50:10 +01002959 (void) key_buffer;
2960 (void) key_buffer_size;
2961 (void) hash;
2962 (void) hash_length;
2963 (void) signature;
2964 (void) signature_length;
Ronald Cron4501c982021-03-19 20:09:32 +01002965
Gilles Peskine449bd832023-01-11 14:50:10 +01002966 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron18659932020-12-08 16:32:23 +01002967}
2968
Gilles Peskine449bd832023-01-11 14:50:10 +01002969psa_status_t psa_verify_hash(mbedtls_svc_key_id_t key,
2970 psa_algorithm_t alg,
2971 const uint8_t *hash,
2972 size_t hash_length,
2973 const uint8_t *signature,
2974 size_t signature_length)
itayzafrir5c753392018-05-08 11:18:38 +03002975{
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002976 return psa_verify_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002977 key, 0, alg, hash, hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002978 signature, signature_length);
Gilles Peskinee59236f2018-01-27 23:32:46 +01002979}
2980
Gilles Peskine449bd832023-01-11 14:50:10 +01002981psa_status_t psa_asymmetric_encrypt(mbedtls_svc_key_id_t key,
2982 psa_algorithm_t alg,
2983 const uint8_t *input,
2984 size_t input_length,
2985 const uint8_t *salt,
2986 size_t salt_length,
2987 uint8_t *output,
2988 size_t output_size,
2989 size_t *output_length)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002990{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002991 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01002992 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01002993 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02002994
Darryl Green5cc689a2018-07-24 15:34:10 +01002995 (void) input;
2996 (void) input_length;
2997 (void) salt;
2998 (void) output;
2999 (void) output_size;
3000
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003001 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003002
Gilles Peskine449bd832023-01-11 14:50:10 +01003003 if (!PSA_ALG_IS_RSA_OAEP(alg) && salt_length != 0) {
3004 return PSA_ERROR_INVALID_ARGUMENT;
3005 }
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003006
Valerio Setti5bb454a2024-01-15 10:43:16 +01003007 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01003008 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg);
3009 if (status != PSA_SUCCESS) {
3010 return status;
3011 }
3012 if (!(PSA_KEY_TYPE_IS_PUBLIC_KEY(slot->attr.type) ||
3013 PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type))) {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003014 status = PSA_ERROR_INVALID_ARGUMENT;
3015 goto exit;
3016 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003017
Przemyslaw Stekiel19e61422021-12-09 11:09:11 +01003018 status = psa_driver_wrapper_asymmetric_encrypt(
Gilles Peskine7a5d9202024-02-28 01:18:23 +01003019 &slot->attr, slot->key.data, slot->key.bytes,
Przemyslaw Stekiel19e61422021-12-09 11:09:11 +01003020 alg, input, input_length, salt, salt_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003021 output, output_size, output_length);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003022exit:
Ryan Everetta103ec92024-01-31 13:59:57 +00003023 unlock_status = psa_unregister_read_under_mutex(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003024
Gilles Peskine449bd832023-01-11 14:50:10 +01003025 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003026}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003027
Gilles Peskine449bd832023-01-11 14:50:10 +01003028psa_status_t psa_asymmetric_decrypt(mbedtls_svc_key_id_t key,
3029 psa_algorithm_t alg,
3030 const uint8_t *input,
3031 size_t input_length,
3032 const uint8_t *salt,
3033 size_t salt_length,
3034 uint8_t *output,
3035 size_t output_size,
3036 size_t *output_length)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003037{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003038 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003039 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003040 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003041
Darryl Green5cc689a2018-07-24 15:34:10 +01003042 (void) input;
3043 (void) input_length;
3044 (void) salt;
3045 (void) output;
3046 (void) output_size;
3047
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003048 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003049
Gilles Peskine449bd832023-01-11 14:50:10 +01003050 if (!PSA_ALG_IS_RSA_OAEP(alg) && salt_length != 0) {
3051 return PSA_ERROR_INVALID_ARGUMENT;
3052 }
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003053
Valerio Setti5bb454a2024-01-15 10:43:16 +01003054 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01003055 key, &slot, PSA_KEY_USAGE_DECRYPT, alg);
3056 if (status != PSA_SUCCESS) {
3057 return status;
3058 }
3059 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003060 status = PSA_ERROR_INVALID_ARGUMENT;
3061 goto exit;
3062 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003063
Przemyslaw Stekiel8d45c002021-12-13 08:58:19 +01003064 status = psa_driver_wrapper_asymmetric_decrypt(
Gilles Peskine7a5d9202024-02-28 01:18:23 +01003065 &slot->attr, slot->key.data, slot->key.bytes,
Przemyslaw Stekiel8d45c002021-12-13 08:58:19 +01003066 alg, input, input_length, salt, salt_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003067 output, output_size, output_length);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003068
3069exit:
Ryan Everetta103ec92024-01-31 13:59:57 +00003070 unlock_status = psa_unregister_read_under_mutex(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003071
Gilles Peskine449bd832023-01-11 14:50:10 +01003072 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003073}
Gilles Peskinee59236f2018-01-27 23:32:46 +01003074
Paul Elliott9fe12f62022-11-30 19:16:02 +00003075/****************************************************************/
3076/* Asymmetric interruptible cryptography */
3077/****************************************************************/
3078
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003079static uint32_t psa_interruptible_max_ops = PSA_INTERRUPTIBLE_MAX_OPS_UNLIMITED;
3080
Paul Elliott9fe12f62022-11-30 19:16:02 +00003081void psa_interruptible_set_max_ops(uint32_t max_ops)
3082{
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003083 psa_interruptible_max_ops = max_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003084}
3085
3086uint32_t psa_interruptible_get_max_ops(void)
3087{
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003088 return psa_interruptible_max_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003089}
3090
Paul Elliott9fe12f62022-11-30 19:16:02 +00003091uint32_t psa_sign_hash_get_num_ops(
3092 const psa_sign_hash_interruptible_operation_t *operation)
3093{
Paul Elliott296ede92022-12-15 17:00:30 +00003094 return operation->num_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003095}
3096
3097uint32_t psa_verify_hash_get_num_ops(
3098 const psa_verify_hash_interruptible_operation_t *operation)
3099{
Paul Elliott296ede92022-12-15 17:00:30 +00003100 return operation->num_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003101}
3102
Paul Elliott59ad9452022-12-18 15:09:02 +00003103static psa_status_t psa_sign_hash_abort_internal(
3104 psa_sign_hash_interruptible_operation_t *operation)
3105{
3106 if (operation->id == 0) {
3107 /* The object has (apparently) been initialized but it is not (yet)
3108 * in use. It's ok to call abort on such an object, and there's
3109 * nothing to do. */
3110 return PSA_SUCCESS;
3111 }
3112
3113 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3114
3115 status = psa_driver_wrapper_sign_hash_abort(operation);
3116
3117 operation->id = 0;
3118
Paul Elliotte6145dc2023-02-07 12:51:21 +00003119 /* Do not clear either the error_occurred or num_ops elements here as they
3120 * only want to be cleared by the application calling abort, not by abort
3121 * being called at completion of an operation. */
3122
Paul Elliott59ad9452022-12-18 15:09:02 +00003123 return status;
3124}
3125
Paul Elliott9fe12f62022-11-30 19:16:02 +00003126psa_status_t psa_sign_hash_start(
3127 psa_sign_hash_interruptible_operation_t *operation,
3128 mbedtls_svc_key_id_t key, psa_algorithm_t alg,
3129 const uint8_t *hash, size_t hash_length)
3130{
3131 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3132 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3133 psa_key_slot_t *slot;
3134
Paul Elliottc9774412023-02-06 15:14:07 +00003135 /* Check that start has not been previously called, or operation has not
3136 * previously errored. */
3137 if (operation->id != 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003138 return PSA_ERROR_BAD_STATE;
3139 }
3140
Paul Elliott9fe12f62022-11-30 19:16:02 +00003141 status = psa_sign_verify_check_alg(0, alg);
3142 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003143 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003144 return status;
3145 }
3146
3147 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
3148 PSA_KEY_USAGE_SIGN_HASH,
3149 alg);
3150
3151 if (status != PSA_SUCCESS) {
3152 goto exit;
3153 }
3154
3155 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
3156 status = PSA_ERROR_INVALID_ARGUMENT;
3157 goto exit;
3158 }
3159
Paul Elliott296ede92022-12-15 17:00:30 +00003160 /* Ensure ops count gets reset, in case of operation re-use. */
3161 operation->num_ops = 0;
3162
Gilles Peskine7a5d9202024-02-28 01:18:23 +01003163 status = psa_driver_wrapper_sign_hash_start(operation, &slot->attr,
Paul Elliott9fe12f62022-11-30 19:16:02 +00003164 slot->key.data,
3165 slot->key.bytes, alg,
3166 hash, hash_length);
3167exit:
3168
3169 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003170 operation->error_occurred = 1;
Paul Elliott59ad9452022-12-18 15:09:02 +00003171 psa_sign_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003172 }
3173
Ryan Everettdcc03d52024-02-14 15:44:13 +00003174 unlock_status = psa_unregister_read_under_mutex(slot);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003175
Paul Elliottc9774412023-02-06 15:14:07 +00003176 if (unlock_status != PSA_SUCCESS) {
3177 operation->error_occurred = 1;
3178 }
Paul Elliott9fe12f62022-11-30 19:16:02 +00003179
Paul Elliottc9774412023-02-06 15:14:07 +00003180 return (status == PSA_SUCCESS) ? unlock_status : status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003181}
3182
3183
3184psa_status_t psa_sign_hash_complete(
3185 psa_sign_hash_interruptible_operation_t *operation,
3186 uint8_t *signature, size_t signature_size,
3187 size_t *signature_length)
3188{
3189 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3190
3191 *signature_length = 0;
3192
Paul Elliottc9774412023-02-06 15:14:07 +00003193 /* Check that start has been called first, and that operation has not
3194 * previously errored. */
3195 if (operation->id == 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003196 status = PSA_ERROR_BAD_STATE;
3197 goto exit;
3198 }
3199
Paul Elliott096abc42023-02-03 18:33:23 +00003200 /* Immediately reject a zero-length signature buffer. This guarantees that
3201 * signature must be a valid pointer. */
Paul Elliott9fe12f62022-11-30 19:16:02 +00003202 if (signature_size == 0) {
3203 status = PSA_ERROR_BUFFER_TOO_SMALL;
3204 goto exit;
3205 }
3206
3207 status = psa_driver_wrapper_sign_hash_complete(operation, signature,
3208 signature_size,
3209 signature_length);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003210
Paul Elliott296ede92022-12-15 17:00:30 +00003211 /* Update ops count with work done. */
Paul Elliottde1114c2023-02-07 12:43:11 +00003212 operation->num_ops = psa_driver_wrapper_sign_hash_get_num_ops(operation);
Paul Elliott296ede92022-12-15 17:00:30 +00003213
Paul Elliottebe225c2023-02-10 14:32:53 +00003214exit:
3215
Paul Elliott59200a22023-02-21 15:07:40 +00003216 psa_wipe_tag_output_buffer(signature, status, signature_size,
3217 *signature_length);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003218
Paul Elliott53bb3122023-02-10 14:22:22 +00003219 if (status != PSA_OPERATION_INCOMPLETE) {
Paul Elliottc9774412023-02-06 15:14:07 +00003220 if (status != PSA_SUCCESS) {
3221 operation->error_occurred = 1;
3222 }
3223
Paul Elliott59ad9452022-12-18 15:09:02 +00003224 psa_sign_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003225 }
3226
3227 return status;
3228}
3229
3230psa_status_t psa_sign_hash_abort(
3231 psa_sign_hash_interruptible_operation_t *operation)
3232{
Paul Elliott59ad9452022-12-18 15:09:02 +00003233 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3234
3235 status = psa_sign_hash_abort_internal(operation);
3236
3237 /* We clear the number of ops done here, so that it is not cleared when
3238 * the operation fails or succeeds, only on manual abort. */
3239 operation->num_ops = 0;
3240
Paul Elliottc9774412023-02-06 15:14:07 +00003241 /* Likewise, failure state. */
3242 operation->error_occurred = 0;
3243
Paul Elliott59ad9452022-12-18 15:09:02 +00003244 return status;
3245}
3246
3247static psa_status_t psa_verify_hash_abort_internal(
3248 psa_verify_hash_interruptible_operation_t *operation)
3249{
Paul Elliott9fe12f62022-11-30 19:16:02 +00003250 if (operation->id == 0) {
3251 /* The object has (apparently) been initialized but it is not (yet)
3252 * in use. It's ok to call abort on such an object, and there's
3253 * nothing to do. */
3254 return PSA_SUCCESS;
3255 }
3256
Paul Elliott59ad9452022-12-18 15:09:02 +00003257 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3258
3259 status = psa_driver_wrapper_verify_hash_abort(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003260
3261 operation->id = 0;
3262
Paul Elliotte6145dc2023-02-07 12:51:21 +00003263 /* Do not clear either the error_occurred or num_ops elements here as they
3264 * only want to be cleared by the application calling abort, not by abort
3265 * being called at completion of an operation. */
3266
Paul Elliott59ad9452022-12-18 15:09:02 +00003267 return status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003268}
3269
3270psa_status_t psa_verify_hash_start(
3271 psa_verify_hash_interruptible_operation_t *operation,
3272 mbedtls_svc_key_id_t key, psa_algorithm_t alg,
3273 const uint8_t *hash, size_t hash_length,
3274 const uint8_t *signature, size_t signature_length)
3275{
3276 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3277 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3278 psa_key_slot_t *slot;
3279
Paul Elliottc9774412023-02-06 15:14:07 +00003280 /* Check that start has not been previously called, or operation has not
3281 * previously errored. */
3282 if (operation->id != 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003283 return PSA_ERROR_BAD_STATE;
3284 }
3285
3286 status = psa_sign_verify_check_alg(0, alg);
3287 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003288 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003289 return status;
3290 }
3291
3292 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
3293 PSA_KEY_USAGE_VERIFY_HASH,
3294 alg);
3295
3296 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003297 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003298 return status;
3299 }
3300
Paul Elliott296ede92022-12-15 17:00:30 +00003301 /* Ensure ops count gets reset, in case of operation re-use. */
3302 operation->num_ops = 0;
3303
Gilles Peskine7a5d9202024-02-28 01:18:23 +01003304 status = psa_driver_wrapper_verify_hash_start(operation, &slot->attr,
Paul Elliott9fe12f62022-11-30 19:16:02 +00003305 slot->key.data,
3306 slot->key.bytes,
3307 alg, hash, hash_length,
3308 signature, signature_length);
3309
3310 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003311 operation->error_occurred = 1;
Paul Elliott59ad9452022-12-18 15:09:02 +00003312 psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003313 }
3314
Ryan Everett291267f2024-02-14 15:59:15 +00003315 unlock_status = psa_unregister_read_under_mutex(slot);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003316
Paul Elliottc9774412023-02-06 15:14:07 +00003317 if (unlock_status != PSA_SUCCESS) {
3318 operation->error_occurred = 1;
3319 }
Paul Elliott9fe12f62022-11-30 19:16:02 +00003320
Paul Elliottc9774412023-02-06 15:14:07 +00003321 return (status == PSA_SUCCESS) ? unlock_status : status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003322}
3323
3324psa_status_t psa_verify_hash_complete(
3325 psa_verify_hash_interruptible_operation_t *operation)
3326{
3327 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3328
Paul Elliottc9774412023-02-06 15:14:07 +00003329 /* Check that start has been called first, and that operation has not
3330 * previously errored. */
3331 if (operation->id == 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003332 status = PSA_ERROR_BAD_STATE;
3333 goto exit;
3334 }
3335
3336 status = psa_driver_wrapper_verify_hash_complete(operation);
3337
Paul Elliott296ede92022-12-15 17:00:30 +00003338 /* Update ops count with work done. */
Paul Elliottde1114c2023-02-07 12:43:11 +00003339 operation->num_ops = psa_driver_wrapper_verify_hash_get_num_ops(
Paul Elliott296ede92022-12-15 17:00:30 +00003340 operation);
3341
Paul Elliottebe225c2023-02-10 14:32:53 +00003342exit:
3343
Paul Elliott9fe12f62022-11-30 19:16:02 +00003344 if (status != PSA_OPERATION_INCOMPLETE) {
Paul Elliottc9774412023-02-06 15:14:07 +00003345 if (status != PSA_SUCCESS) {
3346 operation->error_occurred = 1;
3347 }
3348
Paul Elliott59ad9452022-12-18 15:09:02 +00003349 psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003350 }
3351
3352 return status;
3353}
3354
3355psa_status_t psa_verify_hash_abort(
3356 psa_verify_hash_interruptible_operation_t *operation)
3357{
Paul Elliott59ad9452022-12-18 15:09:02 +00003358 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003359
Paul Elliott59ad9452022-12-18 15:09:02 +00003360 status = psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003361
Paul Elliott59ad9452022-12-18 15:09:02 +00003362 /* We clear the number of ops done here, so that it is not cleared when
3363 * the operation fails or succeeds, only on manual abort. */
3364 operation->num_ops = 0;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003365
Paul Elliottc9774412023-02-06 15:14:07 +00003366 /* Likewise, failure state. */
3367 operation->error_occurred = 0;
3368
Paul Elliott59ad9452022-12-18 15:09:02 +00003369 return status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003370}
3371
Paul Elliott588f8ed2022-12-02 18:10:26 +00003372/****************************************************************/
3373/* Asymmetric interruptible cryptography internal */
3374/* implementations */
3375/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003376
Paul Elliott588f8ed2022-12-02 18:10:26 +00003377void mbedtls_psa_interruptible_set_max_ops(uint32_t max_ops)
3378{
Paul Elliott7cc4e812023-01-10 17:14:11 +00003379
Paul Elliott588f8ed2022-12-02 18:10:26 +00003380#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3381 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3382 defined(MBEDTLS_ECP_RESTARTABLE)
3383
3384 /* Internal implementation uses zero to indicate infinite number max ops,
3385 * therefore avoid this value, and set to minimum possible. */
3386 if (max_ops == 0) {
3387 max_ops = 1;
3388 }
3389
Paul Elliott588f8ed2022-12-02 18:10:26 +00003390 mbedtls_ecp_set_max_ops(max_ops);
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003391#else
3392 (void) max_ops;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003393#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3394 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3395 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3396}
3397
Paul Elliott588f8ed2022-12-02 18:10:26 +00003398uint32_t mbedtls_psa_sign_hash_get_num_ops(
Paul Elliottf8e5b562023-02-19 18:43:45 +00003399 const mbedtls_psa_sign_hash_interruptible_operation_t *operation)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003400{
3401#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3402 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3403 defined(MBEDTLS_ECP_RESTARTABLE)
3404
Paul Elliott93d9ca82023-02-15 18:14:21 +00003405 return operation->num_ops;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003406#else
3407 (void) operation;
3408 return 0;
3409#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3410 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3411 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3412}
3413
3414uint32_t mbedtls_psa_verify_hash_get_num_ops(
Paul Elliottf8e5b562023-02-19 18:43:45 +00003415 const mbedtls_psa_verify_hash_interruptible_operation_t *operation)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003416{
3417 #if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3418 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3419 defined(MBEDTLS_ECP_RESTARTABLE)
3420
Paul Elliott93d9ca82023-02-15 18:14:21 +00003421 return operation->num_ops;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003422#else
3423 (void) operation;
3424 return 0;
3425#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3426 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3427 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3428}
3429
3430psa_status_t mbedtls_psa_sign_hash_start(
3431 mbedtls_psa_sign_hash_interruptible_operation_t *operation,
3432 const psa_key_attributes_t *attributes, const uint8_t *key_buffer,
3433 size_t key_buffer_size, psa_algorithm_t alg,
3434 const uint8_t *hash, size_t hash_length)
3435{
3436 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott0290a762023-02-09 14:30:24 +00003437 size_t required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003438
Gilles Peskine2f107ae2024-02-28 01:26:46 +01003439 if (!PSA_KEY_TYPE_IS_ECC(attributes->type)) {
Paul Elliott068fe072023-01-16 13:59:15 +00003440 return PSA_ERROR_NOT_SUPPORTED;
3441 }
3442
3443 if (!PSA_ALG_IS_ECDSA(alg)) {
Paul Elliott813f9cd2023-02-05 15:28:46 +00003444 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott068fe072023-01-16 13:59:15 +00003445 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003446
3447#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Paul Elliott068fe072023-01-16 13:59:15 +00003448 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3449 defined(MBEDTLS_ECP_RESTARTABLE)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003450
Paul Elliotta1c94092023-02-15 16:38:04 +00003451 mbedtls_ecdsa_restart_init(&operation->restart_ctx);
3452
Paul Elliott93d9ca82023-02-15 18:14:21 +00003453 /* Ensure num_ops is zero'ed in case of context re-use. */
3454 operation->num_ops = 0;
3455
Gilles Peskine2f107ae2024-02-28 01:26:46 +01003456 status = mbedtls_psa_ecp_load_representation(attributes->type,
3457 attributes->bits,
Paul Elliott068fe072023-01-16 13:59:15 +00003458 key_buffer,
3459 key_buffer_size,
3460 &operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003461
Paul Elliott068fe072023-01-16 13:59:15 +00003462 if (status != PSA_SUCCESS) {
3463 return status;
3464 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003465
Paul Elliott1bc59df2023-02-05 13:41:57 +00003466 operation->coordinate_bytes = PSA_BITS_TO_BYTES(
Paul Elliottc569fc22023-02-10 13:02:54 +00003467 operation->ctx->grp.nbits);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003468
Paul Elliott068fe072023-01-16 13:59:15 +00003469 psa_algorithm_t hash_alg = PSA_ALG_SIGN_GET_HASH(alg);
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02003470 operation->md_alg = mbedtls_md_type_from_psa_alg(hash_alg);
Paul Elliott068fe072023-01-16 13:59:15 +00003471 operation->alg = alg;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003472
Paul Elliott0290a762023-02-09 14:30:24 +00003473 /* We only need to store the same length of hash as the private key size
3474 * here, it would be truncated by the internal implementation anyway. */
3475 required_hash_length = (hash_length < operation->coordinate_bytes ?
3476 hash_length : operation->coordinate_bytes);
3477
Paul Elliottba70ad42023-02-15 18:23:53 +00003478 if (required_hash_length > sizeof(operation->hash)) {
3479 /* Shouldn't happen, but better safe than sorry. */
3480 return PSA_ERROR_CORRUPTION_DETECTED;
3481 }
3482
Paul Elliott0290a762023-02-09 14:30:24 +00003483 memcpy(operation->hash, hash, required_hash_length);
3484 operation->hash_length = required_hash_length;
Paul Elliott068fe072023-01-16 13:59:15 +00003485
3486 return PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003487
3488#else
Paul Elliott068fe072023-01-16 13:59:15 +00003489 (void) operation;
3490 (void) key_buffer;
3491 (void) key_buffer_size;
3492 (void) alg;
3493 (void) hash;
3494 (void) hash_length;
3495 (void) status;
Paul Elliott0290a762023-02-09 14:30:24 +00003496 (void) required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003497
Paul Elliott068fe072023-01-16 13:59:15 +00003498 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003499#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3500 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3501 * defined( MBEDTLS_ECP_RESTARTABLE ) */
Paul Elliott588f8ed2022-12-02 18:10:26 +00003502}
3503
3504psa_status_t mbedtls_psa_sign_hash_complete(
3505 mbedtls_psa_sign_hash_interruptible_operation_t *operation,
3506 uint8_t *signature, size_t signature_size,
3507 size_t *signature_length)
3508{
Paul Elliott588f8ed2022-12-02 18:10:26 +00003509#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3510 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3511 defined(MBEDTLS_ECP_RESTARTABLE)
3512
Paul Elliotta1c94092023-02-15 16:38:04 +00003513 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott1243f932023-02-07 11:21:10 +00003514 mbedtls_mpi r;
3515 mbedtls_mpi s;
3516
Paul Elliott46845252023-02-03 14:59:11 +00003517 mbedtls_mpi_init(&r);
3518 mbedtls_mpi_init(&s);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003519
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003520 /* Ensure max_ops is set to the current value (or default). */
3521 mbedtls_psa_interruptible_set_max_ops(psa_interruptible_get_max_ops());
3522
Paul Elliotta1c94092023-02-15 16:38:04 +00003523 if (signature_size < 2 * operation->coordinate_bytes) {
3524 status = PSA_ERROR_BUFFER_TOO_SMALL;
3525 goto exit;
3526 }
3527
Paul Elliott588f8ed2022-12-02 18:10:26 +00003528 if (PSA_ALG_ECDSA_IS_DETERMINISTIC(operation->alg)) {
Paul Elliott46845252023-02-03 14:59:11 +00003529
Paul Elliott588f8ed2022-12-02 18:10:26 +00003530#if defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3531 status = mbedtls_to_psa_error(
3532 mbedtls_ecdsa_sign_det_restartable(&operation->ctx->grp,
Paul Elliott46845252023-02-03 14:59:11 +00003533 &r,
3534 &s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003535 &operation->ctx->d,
3536 operation->hash,
3537 operation->hash_length,
3538 operation->md_alg,
3539 mbedtls_psa_get_random,
3540 MBEDTLS_PSA_RANDOM_STATE,
3541 &operation->restart_ctx));
3542#else /* defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Paul Elliott724bd252023-02-08 12:35:08 +00003543 status = PSA_ERROR_NOT_SUPPORTED;
3544 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003545#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
3546 } else {
Paul Elliott588f8ed2022-12-02 18:10:26 +00003547 status = mbedtls_to_psa_error(
3548 mbedtls_ecdsa_sign_restartable(&operation->ctx->grp,
Paul Elliott46845252023-02-03 14:59:11 +00003549 &r,
3550 &s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003551 &operation->ctx->d,
3552 operation->hash,
3553 operation->hash_length,
3554 mbedtls_psa_get_random,
3555 MBEDTLS_PSA_RANDOM_STATE,
3556 mbedtls_psa_get_random,
3557 MBEDTLS_PSA_RANDOM_STATE,
3558 &operation->restart_ctx));
3559 }
3560
Paul Elliottf8e5b562023-02-19 18:43:45 +00003561 /* Hide the fact that the restart context only holds a delta of number of
3562 * ops done during the last operation, not an absolute value. */
3563 operation->num_ops += operation->restart_ctx.ecp.ops_done;
3564
Paul Elliott724bd252023-02-08 12:35:08 +00003565 if (status == PSA_SUCCESS) {
Paul Elliott588f8ed2022-12-02 18:10:26 +00003566 status = mbedtls_to_psa_error(
Paul Elliott46845252023-02-03 14:59:11 +00003567 mbedtls_mpi_write_binary(&r,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003568 signature,
Paul Elliott1bc59df2023-02-05 13:41:57 +00003569 operation->coordinate_bytes)
3570 );
Paul Elliott588f8ed2022-12-02 18:10:26 +00003571
3572 if (status != PSA_SUCCESS) {
Paul Elliott724bd252023-02-08 12:35:08 +00003573 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003574 }
3575
3576 status = mbedtls_to_psa_error(
Paul Elliott46845252023-02-03 14:59:11 +00003577 mbedtls_mpi_write_binary(&s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003578 signature +
Paul Elliott1bc59df2023-02-05 13:41:57 +00003579 operation->coordinate_bytes,
3580 operation->coordinate_bytes)
3581 );
Paul Elliott588f8ed2022-12-02 18:10:26 +00003582
3583 if (status != PSA_SUCCESS) {
Paul Elliott724bd252023-02-08 12:35:08 +00003584 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003585 }
3586
Paul Elliott1bc59df2023-02-05 13:41:57 +00003587 *signature_length = operation->coordinate_bytes * 2;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003588
Paul Elliott724bd252023-02-08 12:35:08 +00003589 status = PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003590 }
Paul Elliott724bd252023-02-08 12:35:08 +00003591
3592exit:
3593
3594 mbedtls_mpi_free(&r);
3595 mbedtls_mpi_free(&s);
3596 return status;
3597
Paul Elliott588f8ed2022-12-02 18:10:26 +00003598 #else
3599
3600 (void) operation;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003601 (void) signature;
3602 (void) signature_size;
3603 (void) signature_length;
3604
3605 return PSA_ERROR_NOT_SUPPORTED;
3606
3607#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3608 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3609 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3610}
3611
3612psa_status_t mbedtls_psa_sign_hash_abort(
3613 mbedtls_psa_sign_hash_interruptible_operation_t *operation)
3614{
3615
3616#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3617 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3618 defined(MBEDTLS_ECP_RESTARTABLE)
3619
3620 if (operation->ctx) {
3621 mbedtls_ecdsa_free(operation->ctx);
3622 mbedtls_free(operation->ctx);
Paul Elliottf9c91a72023-02-05 18:06:38 +00003623 operation->ctx = NULL;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003624 }
3625
3626 mbedtls_ecdsa_restart_free(&operation->restart_ctx);
3627
Paul Elliott93d9ca82023-02-15 18:14:21 +00003628 operation->num_ops = 0;
3629
Paul Elliott588f8ed2022-12-02 18:10:26 +00003630 return PSA_SUCCESS;
3631
3632#else
3633
3634 (void) operation;
3635
3636 return PSA_ERROR_NOT_SUPPORTED;
3637
3638#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3639 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3640 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3641}
3642
3643psa_status_t mbedtls_psa_verify_hash_start(
3644 mbedtls_psa_verify_hash_interruptible_operation_t *operation,
3645 const psa_key_attributes_t *attributes,
3646 const uint8_t *key_buffer, size_t key_buffer_size,
3647 psa_algorithm_t alg,
3648 const uint8_t *hash, size_t hash_length,
3649 const uint8_t *signature, size_t signature_length)
3650{
3651 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott1bc59df2023-02-05 13:41:57 +00003652 size_t coordinate_bytes = 0;
Paul Elliott0290a762023-02-09 14:30:24 +00003653 size_t required_hash_length = 0;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003654
Gilles Peskine2f107ae2024-02-28 01:26:46 +01003655 if (!PSA_KEY_TYPE_IS_ECC(attributes->type)) {
Paul Elliott068fe072023-01-16 13:59:15 +00003656 return PSA_ERROR_NOT_SUPPORTED;
3657 }
3658
3659 if (!PSA_ALG_IS_ECDSA(alg)) {
Paul Elliott813f9cd2023-02-05 15:28:46 +00003660 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott068fe072023-01-16 13:59:15 +00003661 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003662
3663#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Paul Elliott068fe072023-01-16 13:59:15 +00003664 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3665 defined(MBEDTLS_ECP_RESTARTABLE)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003666
Paul Elliotta1c94092023-02-15 16:38:04 +00003667 mbedtls_ecdsa_restart_init(&operation->restart_ctx);
3668 mbedtls_mpi_init(&operation->r);
3669 mbedtls_mpi_init(&operation->s);
3670
Paul Elliott93d9ca82023-02-15 18:14:21 +00003671 /* Ensure num_ops is zero'ed in case of context re-use. */
3672 operation->num_ops = 0;
3673
Gilles Peskine2f107ae2024-02-28 01:26:46 +01003674 status = mbedtls_psa_ecp_load_representation(attributes->type,
3675 attributes->bits,
Paul Elliott068fe072023-01-16 13:59:15 +00003676 key_buffer,
3677 key_buffer_size,
3678 &operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003679
Paul Elliott068fe072023-01-16 13:59:15 +00003680 if (status != PSA_SUCCESS) {
3681 return status;
3682 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003683
Paul Elliottc569fc22023-02-10 13:02:54 +00003684 coordinate_bytes = PSA_BITS_TO_BYTES(operation->ctx->grp.nbits);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003685
Paul Elliott1bc59df2023-02-05 13:41:57 +00003686 if (signature_length != 2 * coordinate_bytes) {
Paul Elliott068fe072023-01-16 13:59:15 +00003687 return PSA_ERROR_INVALID_SIGNATURE;
3688 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003689
Paul Elliott068fe072023-01-16 13:59:15 +00003690 status = mbedtls_to_psa_error(
3691 mbedtls_mpi_read_binary(&operation->r,
3692 signature,
Paul Elliott1bc59df2023-02-05 13:41:57 +00003693 coordinate_bytes));
Paul Elliott588f8ed2022-12-02 18:10:26 +00003694
Paul Elliott068fe072023-01-16 13:59:15 +00003695 if (status != PSA_SUCCESS) {
3696 return status;
3697 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003698
Paul Elliott068fe072023-01-16 13:59:15 +00003699 status = mbedtls_to_psa_error(
3700 mbedtls_mpi_read_binary(&operation->s,
3701 signature +
Paul Elliott1bc59df2023-02-05 13:41:57 +00003702 coordinate_bytes,
3703 coordinate_bytes));
Paul Elliott588f8ed2022-12-02 18:10:26 +00003704
Paul Elliott068fe072023-01-16 13:59:15 +00003705 if (status != PSA_SUCCESS) {
3706 return status;
3707 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003708
Paul Elliott2c9843f2023-02-15 17:32:42 +00003709 status = mbedtls_psa_ecp_load_public_part(operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003710
Paul Elliott2c9843f2023-02-15 17:32:42 +00003711 if (status != PSA_SUCCESS) {
3712 return status;
Paul Elliott068fe072023-01-16 13:59:15 +00003713 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003714
Paul Elliott0290a762023-02-09 14:30:24 +00003715 /* We only need to store the same length of hash as the private key size
3716 * here, it would be truncated by the internal implementation anyway. */
3717 required_hash_length = (hash_length < coordinate_bytes ? hash_length :
3718 coordinate_bytes);
3719
Paul Elliottba70ad42023-02-15 18:23:53 +00003720 if (required_hash_length > sizeof(operation->hash)) {
3721 /* Shouldn't happen, but better safe than sorry. */
3722 return PSA_ERROR_CORRUPTION_DETECTED;
3723 }
3724
Paul Elliott0290a762023-02-09 14:30:24 +00003725 memcpy(operation->hash, hash, required_hash_length);
3726 operation->hash_length = required_hash_length;
Paul Elliott068fe072023-01-16 13:59:15 +00003727
3728 return PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003729#else
Paul Elliott068fe072023-01-16 13:59:15 +00003730 (void) operation;
3731 (void) key_buffer;
3732 (void) key_buffer_size;
3733 (void) alg;
3734 (void) hash;
3735 (void) hash_length;
3736 (void) signature;
3737 (void) signature_length;
3738 (void) status;
Paul Elliott1243f932023-02-07 11:21:10 +00003739 (void) coordinate_bytes;
Paul Elliott0290a762023-02-09 14:30:24 +00003740 (void) required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003741
Paul Elliott068fe072023-01-16 13:59:15 +00003742 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003743#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3744 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3745 * defined( MBEDTLS_ECP_RESTARTABLE ) */
Paul Elliott588f8ed2022-12-02 18:10:26 +00003746}
3747
3748psa_status_t mbedtls_psa_verify_hash_complete(
3749 mbedtls_psa_verify_hash_interruptible_operation_t *operation)
3750{
3751
3752#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3753 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3754 defined(MBEDTLS_ECP_RESTARTABLE)
3755
Paul Elliottf8e5b562023-02-19 18:43:45 +00003756 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3757
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003758 /* Ensure max_ops is set to the current value (or default). */
3759 mbedtls_psa_interruptible_set_max_ops(psa_interruptible_get_max_ops());
3760
Paul Elliottf8e5b562023-02-19 18:43:45 +00003761 status = mbedtls_to_psa_error(
Paul Elliott588f8ed2022-12-02 18:10:26 +00003762 mbedtls_ecdsa_verify_restartable(&operation->ctx->grp,
3763 operation->hash,
3764 operation->hash_length,
3765 &operation->ctx->Q,
3766 &operation->r,
3767 &operation->s,
3768 &operation->restart_ctx));
3769
Paul Elliottf8e5b562023-02-19 18:43:45 +00003770 /* Hide the fact that the restart context only holds a delta of number of
3771 * ops done during the last operation, not an absolute value. */
3772 operation->num_ops += operation->restart_ctx.ecp.ops_done;
3773
3774 return status;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003775#else
3776 (void) operation;
3777
3778 return PSA_ERROR_NOT_SUPPORTED;
3779
3780#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3781 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3782 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3783}
3784
3785psa_status_t mbedtls_psa_verify_hash_abort(
3786 mbedtls_psa_verify_hash_interruptible_operation_t *operation)
3787{
3788
3789#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3790 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3791 defined(MBEDTLS_ECP_RESTARTABLE)
3792
3793 if (operation->ctx) {
3794 mbedtls_ecdsa_free(operation->ctx);
3795 mbedtls_free(operation->ctx);
Paul Elliottf9c91a72023-02-05 18:06:38 +00003796 operation->ctx = NULL;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003797 }
3798
3799 mbedtls_ecdsa_restart_free(&operation->restart_ctx);
3800
Paul Elliott93d9ca82023-02-15 18:14:21 +00003801 operation->num_ops = 0;
3802
Paul Elliott588f8ed2022-12-02 18:10:26 +00003803 mbedtls_mpi_free(&operation->r);
3804 mbedtls_mpi_free(&operation->s);
3805
3806 return PSA_SUCCESS;
3807
3808#else
3809 (void) operation;
3810
3811 return PSA_ERROR_NOT_SUPPORTED;
3812
3813#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3814 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3815 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3816}
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003817
mohammad1603503973b2018-03-12 15:59:30 +02003818/****************************************************************/
3819/* Symmetric cryptography */
3820/****************************************************************/
3821
Gilles Peskine449bd832023-01-11 14:50:10 +01003822static psa_status_t psa_cipher_setup(psa_cipher_operation_t *operation,
3823 mbedtls_svc_key_id_t key,
3824 psa_algorithm_t alg,
3825 mbedtls_operation_t cipher_operation)
Ronald Cronab99ac22020-10-01 16:38:28 +02003826{
3827 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3828 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman54648242021-06-24 11:49:45 +01003829 psa_key_slot_t *slot = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01003830 psa_key_usage_t usage = (cipher_operation == MBEDTLS_ENCRYPT ?
3831 PSA_KEY_USAGE_ENCRYPT :
3832 PSA_KEY_USAGE_DECRYPT);
Ronald Cronab99ac22020-10-01 16:38:28 +02003833
3834 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003835 if (operation->id != 0) {
Dave Rodgman54648242021-06-24 11:49:45 +01003836 status = PSA_ERROR_BAD_STATE;
3837 goto exit;
3838 }
Ronald Cronab99ac22020-10-01 16:38:28 +02003839
Gilles Peskine449bd832023-01-11 14:50:10 +01003840 if (!PSA_ALG_IS_CIPHER(alg)) {
Dave Rodgman54648242021-06-24 11:49:45 +01003841 status = PSA_ERROR_INVALID_ARGUMENT;
3842 goto exit;
3843 }
Ronald Cronab99ac22020-10-01 16:38:28 +02003844
Gilles Peskine449bd832023-01-11 14:50:10 +01003845 status = psa_get_and_lock_key_slot_with_policy(key, &slot, usage, alg);
3846 if (status != PSA_SUCCESS) {
Ronald Cronab99ac22020-10-01 16:38:28 +02003847 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01003848 }
Ronald Cronab99ac22020-10-01 16:38:28 +02003849
Ronald Cron49fafa92021-03-10 08:34:23 +01003850 /* Initialize the operation struct members, except for id. The id member
Ronald Cronab99ac22020-10-01 16:38:28 +02003851 * is used to indicate to psa_cipher_abort that there are resources to free,
Ronald Cron49fafa92021-03-10 08:34:23 +01003852 * so we only set it (in the driver wrapper) after resources have been
3853 * allocated/initialized. */
Ronald Cronab99ac22020-10-01 16:38:28 +02003854 operation->iv_set = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01003855 if (alg == PSA_ALG_ECB_NO_PADDING) {
Ronald Cronab99ac22020-10-01 16:38:28 +02003856 operation->iv_required = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01003857 } else {
Ronald Cronab99ac22020-10-01 16:38:28 +02003858 operation->iv_required = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003859 }
3860 operation->default_iv_length = PSA_CIPHER_IV_LENGTH(slot->attr.type, alg);
Ronald Cronab99ac22020-10-01 16:38:28 +02003861
3862 /* Try doing the operation through a driver before using software fallback. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003863 if (cipher_operation == MBEDTLS_ENCRYPT) {
3864 status = psa_driver_wrapper_cipher_encrypt_setup(operation,
Gilles Peskine7a5d9202024-02-28 01:18:23 +01003865 &slot->attr,
Gilles Peskine449bd832023-01-11 14:50:10 +01003866 slot->key.data,
3867 slot->key.bytes,
3868 alg);
3869 } else {
3870 status = psa_driver_wrapper_cipher_decrypt_setup(operation,
Gilles Peskine7a5d9202024-02-28 01:18:23 +01003871 &slot->attr,
Gilles Peskine449bd832023-01-11 14:50:10 +01003872 slot->key.data,
3873 slot->key.bytes,
3874 alg);
3875 }
Ronald Cronab99ac22020-10-01 16:38:28 +02003876
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003877exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01003878 if (status != PSA_SUCCESS) {
3879 psa_cipher_abort(operation);
3880 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003881
Ryan Everettc0053cc2024-02-14 16:27:13 +00003882 unlock_status = psa_unregister_read_under_mutex(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003883
Gilles Peskine449bd832023-01-11 14:50:10 +01003884 return (status == PSA_SUCCESS) ? unlock_status : status;
mohammad1603503973b2018-03-12 15:59:30 +02003885}
3886
Gilles Peskine449bd832023-01-11 14:50:10 +01003887psa_status_t psa_cipher_encrypt_setup(psa_cipher_operation_t *operation,
3888 mbedtls_svc_key_id_t key,
3889 psa_algorithm_t alg)
mohammad16038481e742018-03-18 13:57:31 +02003890{
Gilles Peskine449bd832023-01-11 14:50:10 +01003891 return psa_cipher_setup(operation, key, alg, MBEDTLS_ENCRYPT);
mohammad16038481e742018-03-18 13:57:31 +02003892}
3893
Gilles Peskine449bd832023-01-11 14:50:10 +01003894psa_status_t psa_cipher_decrypt_setup(psa_cipher_operation_t *operation,
3895 mbedtls_svc_key_id_t key,
3896 psa_algorithm_t alg)
mohammad16038481e742018-03-18 13:57:31 +02003897{
Gilles Peskine449bd832023-01-11 14:50:10 +01003898 return psa_cipher_setup(operation, key, alg, MBEDTLS_DECRYPT);
mohammad16038481e742018-03-18 13:57:31 +02003899}
3900
Gilles Peskine449bd832023-01-11 14:50:10 +01003901psa_status_t psa_cipher_generate_iv(psa_cipher_operation_t *operation,
3902 uint8_t *iv,
3903 size_t iv_size,
3904 size_t *iv_length)
mohammad1603503973b2018-03-12 15:59:30 +02003905{
Ronald Cron6d051732020-10-01 14:10:20 +02003906 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2fb90522021-07-05 12:31:44 +02003907 uint8_t local_iv[PSA_CIPHER_IV_MAX_SIZE];
Sergeybef1f632023-03-06 15:25:06 -07003908 size_t default_iv_length = 0;
Ronald Cron5618a392021-03-26 09:52:26 +01003909
Gilles Peskine449bd832023-01-11 14:50:10 +01003910 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003911 status = PSA_ERROR_BAD_STATE;
3912 goto exit;
Ronald Cronc45b4af2020-09-29 16:18:05 +02003913 }
3914
Gilles Peskine449bd832023-01-11 14:50:10 +01003915 if (operation->iv_set || !operation->iv_required) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003916 status = PSA_ERROR_BAD_STATE;
3917 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02003918 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02003919
Ronald Cron2fb90522021-07-05 12:31:44 +02003920 default_iv_length = operation->default_iv_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01003921 if (iv_size < default_iv_length) {
Ronald Cron5618a392021-03-26 09:52:26 +01003922 status = PSA_ERROR_BUFFER_TOO_SMALL;
3923 goto exit;
3924 }
Gilles Peskinee553c652018-06-04 16:22:46 +02003925
Gilles Peskine449bd832023-01-11 14:50:10 +01003926 if (default_iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Ronald Cron2fb90522021-07-05 12:31:44 +02003927 status = PSA_ERROR_GENERIC_ERROR;
3928 goto exit;
3929 }
3930
Gilles Peskine449bd832023-01-11 14:50:10 +01003931 status = psa_generate_random(local_iv, default_iv_length);
3932 if (status != PSA_SUCCESS) {
Ronald Cron5618a392021-03-26 09:52:26 +01003933 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01003934 }
Ronald Cron5618a392021-03-26 09:52:26 +01003935
Gilles Peskine449bd832023-01-11 14:50:10 +01003936 status = psa_driver_wrapper_cipher_set_iv(operation,
3937 local_iv, default_iv_length);
Ronald Cron5618a392021-03-26 09:52:26 +01003938
3939exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01003940 if (status == PSA_SUCCESS) {
3941 memcpy(iv, local_iv, default_iv_length);
Ronald Cron2fb90522021-07-05 12:31:44 +02003942 *iv_length = default_iv_length;
Steven Cooreman7df02922020-09-09 15:28:49 +02003943 operation->iv_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003944 } else {
Ronald Cron2fb90522021-07-05 12:31:44 +02003945 *iv_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01003946 psa_cipher_abort(operation);
Ronald Cron2fb90522021-07-05 12:31:44 +02003947 }
Ronald Cron6d051732020-10-01 14:10:20 +02003948
Gilles Peskine449bd832023-01-11 14:50:10 +01003949 return status;
mohammad1603503973b2018-03-12 15:59:30 +02003950}
3951
Gilles Peskine449bd832023-01-11 14:50:10 +01003952psa_status_t psa_cipher_set_iv(psa_cipher_operation_t *operation,
3953 const uint8_t *iv,
3954 size_t iv_length)
mohammad1603503973b2018-03-12 15:59:30 +02003955{
Ronald Cron6d051732020-10-01 14:10:20 +02003956 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronc45b4af2020-09-29 16:18:05 +02003957
Gilles Peskine449bd832023-01-11 14:50:10 +01003958 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003959 status = PSA_ERROR_BAD_STATE;
3960 goto exit;
3961 }
Ronald Cronc45b4af2020-09-29 16:18:05 +02003962
Gilles Peskine449bd832023-01-11 14:50:10 +01003963 if (operation->iv_set || !operation->iv_required) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003964 status = PSA_ERROR_BAD_STATE;
3965 goto exit;
3966 }
Ronald Crona0d68172021-03-26 10:15:08 +01003967
Gilles Peskine449bd832023-01-11 14:50:10 +01003968 if (iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003969 status = PSA_ERROR_INVALID_ARGUMENT;
3970 goto exit;
3971 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02003972
Gilles Peskine449bd832023-01-11 14:50:10 +01003973 status = psa_driver_wrapper_cipher_set_iv(operation,
3974 iv,
3975 iv_length);
Steven Cooremand3feccd2020-09-01 15:56:14 +02003976
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003977exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01003978 if (status == PSA_SUCCESS) {
itayzafrir534bd7c2018-08-02 13:56:32 +03003979 operation->iv_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003980 } else {
3981 psa_cipher_abort(operation);
3982 }
3983 return status;
mohammad1603503973b2018-03-12 15:59:30 +02003984}
3985
Gilles Peskine449bd832023-01-11 14:50:10 +01003986psa_status_t psa_cipher_update(psa_cipher_operation_t *operation,
3987 const uint8_t *input,
3988 size_t input_length,
3989 uint8_t *output,
3990 size_t output_size,
3991 size_t *output_length)
mohammad1603503973b2018-03-12 15:59:30 +02003992{
Steven Cooremanffecb7b2020-08-25 15:13:13 +02003993 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron6d051732020-10-01 14:10:20 +02003994
Gilles Peskine449bd832023-01-11 14:50:10 +01003995 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003996 status = PSA_ERROR_BAD_STATE;
3997 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02003998 }
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003999
Gilles Peskine449bd832023-01-11 14:50:10 +01004000 if (operation->iv_required && !operation->iv_set) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004001 status = PSA_ERROR_BAD_STATE;
4002 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004003 }
Jaeden Ameroab439972019-02-15 14:12:05 +00004004
Gilles Peskine449bd832023-01-11 14:50:10 +01004005 status = psa_driver_wrapper_cipher_update(operation,
4006 input,
4007 input_length,
4008 output,
4009 output_size,
4010 output_length);
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004011
4012exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004013 if (status != PSA_SUCCESS) {
4014 psa_cipher_abort(operation);
4015 }
Ronald Cron6d051732020-10-01 14:10:20 +02004016
Gilles Peskine449bd832023-01-11 14:50:10 +01004017 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004018}
4019
Gilles Peskine449bd832023-01-11 14:50:10 +01004020psa_status_t psa_cipher_finish(psa_cipher_operation_t *operation,
4021 uint8_t *output,
4022 size_t output_size,
4023 size_t *output_length)
mohammad1603503973b2018-03-12 15:59:30 +02004024{
David Saadab4ecc272019-02-14 13:48:10 +02004025 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Ronald Cron6d051732020-10-01 14:10:20 +02004026
Gilles Peskine449bd832023-01-11 14:50:10 +01004027 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004028 status = PSA_ERROR_BAD_STATE;
4029 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004030 }
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004031
Gilles Peskine449bd832023-01-11 14:50:10 +01004032 if (operation->iv_required && !operation->iv_set) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004033 status = PSA_ERROR_BAD_STATE;
4034 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004035 }
Moran Pekerbed71a22018-04-22 20:19:20 +03004036
Gilles Peskine449bd832023-01-11 14:50:10 +01004037 status = psa_driver_wrapper_cipher_finish(operation,
4038 output,
4039 output_size,
4040 output_length);
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004041
4042exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004043 if (status == PSA_SUCCESS) {
4044 return psa_cipher_abort(operation);
4045 } else {
Steven Cooremanef8575e2020-09-11 11:44:50 +02004046 *output_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004047 (void) psa_cipher_abort(operation);
Janos Follath315b51c2018-07-09 16:04:51 +01004048
Gilles Peskine449bd832023-01-11 14:50:10 +01004049 return status;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004050 }
mohammad1603503973b2018-03-12 15:59:30 +02004051}
4052
Gilles Peskine449bd832023-01-11 14:50:10 +01004053psa_status_t psa_cipher_abort(psa_cipher_operation_t *operation)
Gilles Peskinee553c652018-06-04 16:22:46 +02004054{
Gilles Peskine449bd832023-01-11 14:50:10 +01004055 if (operation->id == 0) {
Steven Cooremana07b9972020-09-10 14:54:14 +02004056 /* The object has (apparently) been initialized but it is not (yet)
Gilles Peskine81736312018-06-26 15:04:31 +02004057 * in use. It's ok to call abort on such an object, and there's
4058 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004059 return PSA_SUCCESS;
Gilles Peskine81736312018-06-26 15:04:31 +02004060 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004061
Gilles Peskine449bd832023-01-11 14:50:10 +01004062 psa_driver_wrapper_cipher_abort(operation);
Gilles Peskinee553c652018-06-04 16:22:46 +02004063
Ronald Cron49fafa92021-03-10 08:34:23 +01004064 operation->id = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004065 operation->iv_set = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004066 operation->iv_required = 0;
Moran Peker41deec42018-04-04 15:43:05 +03004067
Gilles Peskine449bd832023-01-11 14:50:10 +01004068 return PSA_SUCCESS;
mohammad1603503973b2018-03-12 15:59:30 +02004069}
4070
Gilles Peskine449bd832023-01-11 14:50:10 +01004071psa_status_t psa_cipher_encrypt(mbedtls_svc_key_id_t key,
4072 psa_algorithm_t alg,
4073 const uint8_t *input,
4074 size_t input_length,
4075 uint8_t *output,
4076 size_t output_size,
4077 size_t *output_length)
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004078{
4079 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004080 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron23919522021-07-08 19:00:07 +02004081 psa_key_slot_t *slot = NULL;
Ronald Cronc6e6f502021-07-09 18:44:58 +02004082 uint8_t local_iv[PSA_CIPHER_IV_MAX_SIZE];
4083 size_t default_iv_length = 0;
gabor-mezei-arm6f4e5bb2021-06-25 15:21:11 +02004084
Gilles Peskine449bd832023-01-11 14:50:10 +01004085 if (!PSA_ALG_IS_CIPHER(alg)) {
Ronald Cron23919522021-07-08 19:00:07 +02004086 status = PSA_ERROR_INVALID_ARGUMENT;
4087 goto exit;
4088 }
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004089
Gilles Peskine449bd832023-01-11 14:50:10 +01004090 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
4091 PSA_KEY_USAGE_ENCRYPT,
4092 alg);
4093 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004094 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004095 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004096
Gilles Peskine449bd832023-01-11 14:50:10 +01004097 default_iv_length = PSA_CIPHER_IV_LENGTH(slot->attr.type, alg);
4098 if (default_iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Ronald Cronc6e6f502021-07-09 18:44:58 +02004099 status = PSA_ERROR_GENERIC_ERROR;
4100 goto exit;
4101 }
4102
Gilles Peskine449bd832023-01-11 14:50:10 +01004103 if (default_iv_length > 0) {
4104 if (output_size < default_iv_length) {
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004105 status = PSA_ERROR_BUFFER_TOO_SMALL;
4106 goto exit;
4107 }
4108
Gilles Peskine449bd832023-01-11 14:50:10 +01004109 status = psa_generate_random(local_iv, default_iv_length);
4110 if (status != PSA_SUCCESS) {
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004111 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004112 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004113 }
4114
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004115 status = psa_driver_wrapper_cipher_encrypt(
Gilles Peskine7a5d9202024-02-28 01:18:23 +01004116 &slot->attr, slot->key.data, slot->key.bytes,
Ronald Cronc6e6f502021-07-09 18:44:58 +02004117 alg, local_iv, default_iv_length, input, input_length,
Ronald Cronafbc7ed2023-01-24 16:02:04 +01004118 psa_crypto_buffer_offset(output, default_iv_length),
Gilles Peskine449bd832023-01-11 14:50:10 +01004119 output_size - default_iv_length, output_length);
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004120
4121exit:
Ryan Everetta103ec92024-01-31 13:59:57 +00004122 unlock_status = psa_unregister_read_under_mutex(slot);
Gilles Peskine449bd832023-01-11 14:50:10 +01004123 if (status == PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004124 status = unlock_status;
Ronald Cronc6e6f502021-07-09 18:44:58 +02004125 }
Ronald Cron23919522021-07-08 19:00:07 +02004126
Gilles Peskine449bd832023-01-11 14:50:10 +01004127 if (status == PSA_SUCCESS) {
4128 if (default_iv_length > 0) {
4129 memcpy(output, local_iv, default_iv_length);
4130 }
4131 *output_length += default_iv_length;
4132 } else {
4133 *output_length = 0;
4134 }
4135
4136 return status;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004137}
4138
Gilles Peskine449bd832023-01-11 14:50:10 +01004139psa_status_t psa_cipher_decrypt(mbedtls_svc_key_id_t key,
4140 psa_algorithm_t alg,
4141 const uint8_t *input,
4142 size_t input_length,
4143 uint8_t *output,
4144 size_t output_size,
4145 size_t *output_length)
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004146{
4147 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004148 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron23919522021-07-08 19:00:07 +02004149 psa_key_slot_t *slot = NULL;
gabor-mezei-arm6f4e5bb2021-06-25 15:21:11 +02004150
Gilles Peskine449bd832023-01-11 14:50:10 +01004151 if (!PSA_ALG_IS_CIPHER(alg)) {
Ronald Cron23919522021-07-08 19:00:07 +02004152 status = PSA_ERROR_INVALID_ARGUMENT;
4153 goto exit;
4154 }
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004155
Gilles Peskine449bd832023-01-11 14:50:10 +01004156 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
4157 PSA_KEY_USAGE_DECRYPT,
4158 alg);
4159 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004160 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004161 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004162
Gilles Peskine449bd832023-01-11 14:50:10 +01004163 if (alg == PSA_ALG_CCM_STAR_NO_TAG &&
4164 input_length < PSA_BLOCK_CIPHER_BLOCK_LENGTH(slot->attr.type)) {
Mateusz Starzyk594215b2021-10-14 12:23:06 +02004165 status = PSA_ERROR_INVALID_ARGUMENT;
4166 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004167 } else if (input_length < PSA_CIPHER_IV_LENGTH(slot->attr.type, alg)) {
gabor-mezei-arm258ae072021-06-25 15:25:38 +02004168 status = PSA_ERROR_INVALID_ARGUMENT;
4169 goto exit;
4170 }
4171
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004172 status = psa_driver_wrapper_cipher_decrypt(
Gilles Peskine7a5d9202024-02-28 01:18:23 +01004173 &slot->attr, slot->key.data, slot->key.bytes,
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004174 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004175 output, output_size, output_length);
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004176
gabor-mezei-arm258ae072021-06-25 15:25:38 +02004177exit:
Ryan Everetta103ec92024-01-31 13:59:57 +00004178 unlock_status = psa_unregister_read_under_mutex(slot);
Gilles Peskine449bd832023-01-11 14:50:10 +01004179 if (status == PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004180 status = unlock_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01004181 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004182
Gilles Peskine449bd832023-01-11 14:50:10 +01004183 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004184 *output_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004185 }
Ronald Cron23919522021-07-08 19:00:07 +02004186
Gilles Peskine449bd832023-01-11 14:50:10 +01004187 return status;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004188}
4189
4190
mohammad16035955c982018-04-26 00:53:03 +03004191/****************************************************************/
4192/* AEAD */
4193/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004194
Paul Elliottbaff51c2021-09-28 17:44:45 +01004195/* Helper function to get the base algorithm from its variants. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004196static psa_algorithm_t psa_aead_get_base_algorithm(psa_algorithm_t alg)
Paul Elliottbaff51c2021-09-28 17:44:45 +01004197{
Gilles Peskine449bd832023-01-11 14:50:10 +01004198 return PSA_ALG_AEAD_WITH_DEFAULT_LENGTH_TAG(alg);
Paul Elliottbaff51c2021-09-28 17:44:45 +01004199}
4200
4201/* Helper function to perform common nonce length checks. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004202static psa_status_t psa_aead_check_nonce_length(psa_algorithm_t alg,
4203 size_t nonce_length)
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004204{
Gilles Peskine449bd832023-01-11 14:50:10 +01004205 psa_algorithm_t base_alg = psa_aead_get_base_algorithm(alg);
Paul Elliottbaff51c2021-09-28 17:44:45 +01004206
Gilles Peskine449bd832023-01-11 14:50:10 +01004207 switch (base_alg) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004208#if defined(PSA_WANT_ALG_GCM)
4209 case PSA_ALG_GCM:
4210 /* Not checking max nonce size here as GCM spec allows almost
Gilles Peskine449bd832023-01-11 14:50:10 +01004211 * arbitrarily large nonces. Please note that we do not generally
4212 * recommend the usage of nonces of greater length than
4213 * PSA_AEAD_NONCE_MAX_SIZE, as large nonces are hashed to a shorter
4214 * size, which can then lead to collisions if you encrypt a very
4215 * large number of messages.*/
4216 if (nonce_length != 0) {
4217 return PSA_SUCCESS;
4218 }
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004219 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004220#endif /* PSA_WANT_ALG_GCM */
4221#if defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004222 case PSA_ALG_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01004223 if (nonce_length >= 7 && nonce_length <= 13) {
4224 return PSA_SUCCESS;
4225 }
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004226 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004227#endif /* PSA_WANT_ALG_CCM */
4228#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004229 case PSA_ALG_CHACHA20_POLY1305:
Gilles Peskine449bd832023-01-11 14:50:10 +01004230 if (nonce_length == 12) {
4231 return PSA_SUCCESS;
4232 } else if (nonce_length == 8) {
4233 return PSA_ERROR_NOT_SUPPORTED;
4234 }
Bence Szépkúti6d48e202021-11-15 20:04:15 +01004235 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004236#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004237 default:
Przemek Stekiel4c499272022-09-27 13:55:37 +02004238 (void) nonce_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01004239 return PSA_ERROR_NOT_SUPPORTED;
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004240 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004241
Gilles Peskine449bd832023-01-11 14:50:10 +01004242 return PSA_ERROR_INVALID_ARGUMENT;
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004243}
4244
Gilles Peskine449bd832023-01-11 14:50:10 +01004245static psa_status_t psa_aead_check_algorithm(psa_algorithm_t alg)
Bence Szépkútiaa3a6e42022-01-13 16:26:03 +01004246{
Gilles Peskine449bd832023-01-11 14:50:10 +01004247 if (!PSA_ALG_IS_AEAD(alg) || PSA_ALG_IS_WILDCARD(alg)) {
4248 return PSA_ERROR_INVALID_ARGUMENT;
4249 }
Bence Szépkúti08f34652021-12-08 21:07:13 +01004250
Gilles Peskine449bd832023-01-11 14:50:10 +01004251 return PSA_SUCCESS;
Bence Szépkúti08f34652021-12-08 21:07:13 +01004252}
4253
Gilles Peskine449bd832023-01-11 14:50:10 +01004254psa_status_t psa_aead_encrypt(mbedtls_svc_key_id_t key,
4255 psa_algorithm_t alg,
4256 const uint8_t *nonce,
4257 size_t nonce_length,
4258 const uint8_t *additional_data,
4259 size_t additional_data_length,
4260 const uint8_t *plaintext,
4261 size_t plaintext_length,
4262 uint8_t *ciphertext,
4263 size_t ciphertext_size,
4264 size_t *ciphertext_length)
mohammad16035955c982018-04-26 00:53:03 +03004265{
Ronald Cron215633c2021-03-16 17:15:37 +01004266 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4267 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02004268
mohammad1603f08a5502018-06-03 15:05:47 +03004269 *ciphertext_length = 0;
mohammad1603e58e6842018-05-09 04:58:32 -07004270
Gilles Peskine449bd832023-01-11 14:50:10 +01004271 status = psa_aead_check_algorithm(alg);
4272 if (status != PSA_SUCCESS) {
4273 return status;
4274 }
Steven Cooremanea7ab132021-03-17 16:28:00 +01004275
Ronald Cron9a986162021-03-26 12:40:07 +01004276 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01004277 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg);
4278 if (status != PSA_SUCCESS) {
4279 return status;
4280 }
mohammad16035955c982018-04-26 00:53:03 +03004281
Gilles Peskine449bd832023-01-11 14:50:10 +01004282 status = psa_aead_check_nonce_length(alg, nonce_length);
4283 if (status != PSA_SUCCESS) {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004284 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004285 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004286
Ronald Cronde822812021-03-17 16:08:20 +01004287 status = psa_driver_wrapper_aead_encrypt(
Gilles Peskine7a5d9202024-02-28 01:18:23 +01004288 &slot->attr, slot->key.data, slot->key.bytes,
Ronald Cron215633c2021-03-16 17:15:37 +01004289 alg,
4290 nonce, nonce_length,
4291 additional_data, additional_data_length,
4292 plaintext, plaintext_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004293 ciphertext, ciphertext_size, ciphertext_length);
Gilles Peskine2d277862018-06-18 15:41:12 +02004294
Gilles Peskine449bd832023-01-11 14:50:10 +01004295 if (status != PSA_SUCCESS && ciphertext_size != 0) {
4296 memset(ciphertext, 0, ciphertext_size);
4297 }
Gilles Peskine2d277862018-06-18 15:41:12 +02004298
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004299exit:
Ryan Everetta103ec92024-01-31 13:59:57 +00004300 psa_unregister_read_under_mutex(slot);
mohammad16035955c982018-04-26 00:53:03 +03004301
Gilles Peskine449bd832023-01-11 14:50:10 +01004302 return status;
Gilles Peskineee652a32018-06-01 19:23:52 +02004303}
4304
Gilles Peskine449bd832023-01-11 14:50:10 +01004305psa_status_t psa_aead_decrypt(mbedtls_svc_key_id_t key,
4306 psa_algorithm_t alg,
4307 const uint8_t *nonce,
4308 size_t nonce_length,
4309 const uint8_t *additional_data,
4310 size_t additional_data_length,
4311 const uint8_t *ciphertext,
4312 size_t ciphertext_length,
4313 uint8_t *plaintext,
4314 size_t plaintext_size,
4315 size_t *plaintext_length)
mohammad16035955c982018-04-26 00:53:03 +03004316{
Ronald Cron215633c2021-03-16 17:15:37 +01004317 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4318 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02004319
Gilles Peskineee652a32018-06-01 19:23:52 +02004320 *plaintext_length = 0;
mohammad16039e5a5152018-04-26 12:07:35 +03004321
Gilles Peskine449bd832023-01-11 14:50:10 +01004322 status = psa_aead_check_algorithm(alg);
4323 if (status != PSA_SUCCESS) {
4324 return status;
4325 }
Steven Cooremanea7ab132021-03-17 16:28:00 +01004326
Ronald Cron9a986162021-03-26 12:40:07 +01004327 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01004328 key, &slot, PSA_KEY_USAGE_DECRYPT, alg);
4329 if (status != PSA_SUCCESS) {
4330 return status;
4331 }
mohammad16035955c982018-04-26 00:53:03 +03004332
Gilles Peskine449bd832023-01-11 14:50:10 +01004333 status = psa_aead_check_nonce_length(alg, nonce_length);
4334 if (status != PSA_SUCCESS) {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004335 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004336 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004337
Ronald Cronde822812021-03-17 16:08:20 +01004338 status = psa_driver_wrapper_aead_decrypt(
Gilles Peskine7a5d9202024-02-28 01:18:23 +01004339 &slot->attr, slot->key.data, slot->key.bytes,
Ronald Cron215633c2021-03-16 17:15:37 +01004340 alg,
4341 nonce, nonce_length,
4342 additional_data, additional_data_length,
4343 ciphertext, ciphertext_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004344 plaintext, plaintext_size, plaintext_length);
Gilles Peskinea40d7742018-06-01 16:28:30 +02004345
Gilles Peskine449bd832023-01-11 14:50:10 +01004346 if (status != PSA_SUCCESS && plaintext_size != 0) {
4347 memset(plaintext, 0, plaintext_size);
4348 }
mohammad160360a64d02018-06-03 17:20:42 +03004349
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004350exit:
Ryan Everetta103ec92024-01-31 13:59:57 +00004351 psa_unregister_read_under_mutex(slot);
Ronald Cron215633c2021-03-16 17:15:37 +01004352
Gilles Peskine449bd832023-01-11 14:50:10 +01004353 return status;
mohammad16035955c982018-04-26 00:53:03 +03004354}
4355
Gilles Peskine449bd832023-01-11 14:50:10 +01004356static psa_status_t psa_validate_tag_length(psa_algorithm_t alg)
4357{
4358 const uint8_t tag_len = PSA_ALG_AEAD_GET_TAG_LENGTH(alg);
Andrzej Kurekf8816012021-12-19 17:00:12 +01004359
Gilles Peskine449bd832023-01-11 14:50:10 +01004360 switch (PSA_ALG_AEAD_WITH_SHORTENED_TAG(alg, 0)) {
Przemek Stekiel86679c72022-10-06 17:06:56 +02004361#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004362 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004363 /* CCM allows the following tag lengths: 4, 6, 8, 10, 12, 14, 16.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004364 if (tag_len < 4 || tag_len > 16 || tag_len % 2) {
4365 return PSA_ERROR_INVALID_ARGUMENT;
4366 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01004367 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02004368#endif /* PSA_WANT_ALG_CCM */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004369
Przemek Stekiel86679c72022-10-06 17:06:56 +02004370#if defined(PSA_WANT_ALG_GCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004371 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_GCM, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004372 /* GCM allows the following tag lengths: 4, 8, 12, 13, 14, 15, 16. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004373 if (tag_len != 4 && tag_len != 8 && (tag_len < 12 || tag_len > 16)) {
4374 return PSA_ERROR_INVALID_ARGUMENT;
4375 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01004376 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02004377#endif /* PSA_WANT_ALG_GCM */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004378
Przemek Stekiel86679c72022-10-06 17:06:56 +02004379#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Gilles Peskine449bd832023-01-11 14:50:10 +01004380 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CHACHA20_POLY1305, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004381 /* We only support the default tag length. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004382 if (tag_len != 16) {
4383 return PSA_ERROR_INVALID_ARGUMENT;
4384 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01004385 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02004386#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004387
4388 default:
4389 (void) tag_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004390 return PSA_ERROR_NOT_SUPPORTED;
Andrzej Kurekf8816012021-12-19 17:00:12 +01004391 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004392 return PSA_SUCCESS;
Andrzej Kurekf8816012021-12-19 17:00:12 +01004393}
4394
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004395/* Set the key for a multipart authenticated operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004396static psa_status_t psa_aead_setup(psa_aead_operation_t *operation,
4397 int is_encrypt,
4398 mbedtls_svc_key_id_t key,
4399 psa_algorithm_t alg)
Paul Elliottc2b71442021-06-24 18:17:52 +01004400{
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004401 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4402 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
4403 psa_key_slot_t *slot = NULL;
4404 psa_key_usage_t key_usage = 0;
4405
Gilles Peskine449bd832023-01-11 14:50:10 +01004406 status = psa_aead_check_algorithm(alg);
4407 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004408 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004409 }
Paul Elliottc2b71442021-06-24 18:17:52 +01004410
Gilles Peskine449bd832023-01-11 14:50:10 +01004411 if (operation->id != 0) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004412 status = PSA_ERROR_BAD_STATE;
4413 goto exit;
Paul Elliottc2b71442021-06-24 18:17:52 +01004414 }
4415
Gilles Peskine449bd832023-01-11 14:50:10 +01004416 if (operation->nonce_set || operation->lengths_set ||
4417 operation->ad_started || operation->body_started) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004418 status = PSA_ERROR_BAD_STATE;
4419 goto exit;
Paul Elliottc2b71442021-06-24 18:17:52 +01004420 }
4421
Gilles Peskine449bd832023-01-11 14:50:10 +01004422 if (is_encrypt) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004423 key_usage = PSA_KEY_USAGE_ENCRYPT;
Gilles Peskine449bd832023-01-11 14:50:10 +01004424 } else {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004425 key_usage = PSA_KEY_USAGE_DECRYPT;
Gilles Peskine449bd832023-01-11 14:50:10 +01004426 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004427
Gilles Peskine449bd832023-01-11 14:50:10 +01004428 status = psa_get_and_lock_key_slot_with_policy(key, &slot, key_usage,
4429 alg);
4430 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004431 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004432 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004433
Gilles Peskine449bd832023-01-11 14:50:10 +01004434 if ((status = psa_validate_tag_length(alg)) != PSA_SUCCESS) {
Przemek Stekiel6ab50762022-10-08 17:54:30 +02004435 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004436 }
Przemek Stekiel6ab50762022-10-08 17:54:30 +02004437
Gilles Peskine449bd832023-01-11 14:50:10 +01004438 if (is_encrypt) {
4439 status = psa_driver_wrapper_aead_encrypt_setup(operation,
Gilles Peskine7a5d9202024-02-28 01:18:23 +01004440 &slot->attr,
Gilles Peskine449bd832023-01-11 14:50:10 +01004441 slot->key.data,
4442 slot->key.bytes,
4443 alg);
4444 } else {
4445 status = psa_driver_wrapper_aead_decrypt_setup(operation,
Gilles Peskine7a5d9202024-02-28 01:18:23 +01004446 &slot->attr,
Gilles Peskine449bd832023-01-11 14:50:10 +01004447 slot->key.data,
4448 slot->key.bytes,
4449 alg);
4450 }
4451 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004452 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004453 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004454
Gilles Peskine7a5d9202024-02-28 01:18:23 +01004455 operation->key_type = psa_get_key_type(&slot->attr);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004456
4457exit:
Ryan Everett9af70e52024-02-14 18:38:56 +00004458 unlock_status = psa_unregister_read_under_mutex(slot);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004459
Gilles Peskine449bd832023-01-11 14:50:10 +01004460 if (status == PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004461 status = unlock_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01004462 operation->alg = psa_aead_get_base_algorithm(alg);
Paul Elliottd9343f22021-08-23 18:59:49 +01004463 operation->is_encrypt = is_encrypt;
Gilles Peskine449bd832023-01-11 14:50:10 +01004464 } else {
4465 psa_aead_abort(operation);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004466 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004467
Gilles Peskine449bd832023-01-11 14:50:10 +01004468 return status;
Paul Elliottc2b71442021-06-24 18:17:52 +01004469}
4470
Paul Elliott302ff6b2021-04-20 18:10:30 +01004471/* Set the key for a multipart authenticated encryption operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004472psa_status_t psa_aead_encrypt_setup(psa_aead_operation_t *operation,
4473 mbedtls_svc_key_id_t key,
4474 psa_algorithm_t alg)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004475{
Gilles Peskine449bd832023-01-11 14:50:10 +01004476 return psa_aead_setup(operation, 1, key, alg);
Paul Elliott302ff6b2021-04-20 18:10:30 +01004477}
4478
4479/* Set the key for a multipart authenticated decryption operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004480psa_status_t psa_aead_decrypt_setup(psa_aead_operation_t *operation,
4481 mbedtls_svc_key_id_t key,
4482 psa_algorithm_t alg)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004483{
Gilles Peskine449bd832023-01-11 14:50:10 +01004484 return psa_aead_setup(operation, 0, key, alg);
Paul Elliott302ff6b2021-04-20 18:10:30 +01004485}
4486
4487/* Generate a random nonce / IV for multipart AEAD operation */
Gilles Peskine449bd832023-01-11 14:50:10 +01004488psa_status_t psa_aead_generate_nonce(psa_aead_operation_t *operation,
4489 uint8_t *nonce,
4490 size_t nonce_size,
4491 size_t *nonce_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004492{
4493 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Croncae59092021-11-26 18:53:58 +01004494 uint8_t local_nonce[PSA_AEAD_NONCE_MAX_SIZE];
Sergeybef1f632023-03-06 15:25:06 -07004495 size_t required_nonce_size = 0;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004496
Paul Elliott8eb9daf2021-06-04 16:42:21 +01004497 *nonce_length = 0;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004498
Gilles Peskine449bd832023-01-11 14:50:10 +01004499 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004500 status = PSA_ERROR_BAD_STATE;
4501 goto exit;
4502 }
4503
Gilles Peskine449bd832023-01-11 14:50:10 +01004504 if (operation->nonce_set || !operation->is_encrypt) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004505 status = PSA_ERROR_BAD_STATE;
4506 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004507 }
4508
Paul Elliotte193ea82021-10-01 13:00:16 +01004509 /* For CCM, this size may not be correct according to the PSA
4510 * specification. The PSA Crypto 1.0.1 specification states:
4511 *
4512 * CCM encodes the plaintext length pLen in L octets, with L the smallest
4513 * integer >= 2 where pLen < 2^(8L). The nonce length is then 15 - L bytes.
4514 *
4515 * However this restriction that L has to be the smallest integer is not
4516 * applied in practice, and it is not implementable here since the
4517 * plaintext length may or may not be known at this time. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004518 required_nonce_size = PSA_AEAD_NONCE_LENGTH(operation->key_type,
4519 operation->alg);
4520 if (nonce_size < required_nonce_size) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004521 status = PSA_ERROR_BUFFER_TOO_SMALL;
4522 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004523 }
4524
Gilles Peskine449bd832023-01-11 14:50:10 +01004525 status = psa_generate_random(local_nonce, required_nonce_size);
4526 if (status != PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004527 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004528 }
Paul Elliott302ff6b2021-04-20 18:10:30 +01004529
Gilles Peskine449bd832023-01-11 14:50:10 +01004530 status = psa_aead_set_nonce(operation, local_nonce, required_nonce_size);
Paul Elliott302ff6b2021-04-20 18:10:30 +01004531
Paul Elliott39dc6b82021-05-11 19:16:09 +01004532exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004533 if (status == PSA_SUCCESS) {
4534 memcpy(nonce, local_nonce, required_nonce_size);
Paul Elliott39dc6b82021-05-11 19:16:09 +01004535 *nonce_length = required_nonce_size;
Gilles Peskine449bd832023-01-11 14:50:10 +01004536 } else {
4537 psa_aead_abort(operation);
Ronald Croncae59092021-11-26 18:53:58 +01004538 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01004539
Gilles Peskine449bd832023-01-11 14:50:10 +01004540 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004541}
4542
4543/* Set the nonce for a multipart authenticated encryption or decryption
4544 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004545psa_status_t psa_aead_set_nonce(psa_aead_operation_t *operation,
4546 const uint8_t *nonce,
4547 size_t nonce_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004548{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004549 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4550
Gilles Peskine449bd832023-01-11 14:50:10 +01004551 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004552 status = PSA_ERROR_BAD_STATE;
4553 goto exit;
4554 }
4555
Gilles Peskine449bd832023-01-11 14:50:10 +01004556 if (operation->nonce_set) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004557 status = PSA_ERROR_BAD_STATE;
4558 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004559 }
4560
Gilles Peskine449bd832023-01-11 14:50:10 +01004561 status = psa_aead_check_nonce_length(operation->alg, nonce_length);
4562 if (status != PSA_SUCCESS) {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004563 status = PSA_ERROR_INVALID_ARGUMENT;
4564 goto exit;
Paul Elliott4ed1ed12021-09-27 18:09:28 +01004565 }
Paul Elliott1a98aca2021-05-20 18:24:07 +01004566
Gilles Peskine449bd832023-01-11 14:50:10 +01004567 status = psa_driver_wrapper_aead_set_nonce(operation, nonce,
4568 nonce_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004569
Paul Elliott39dc6b82021-05-11 19:16:09 +01004570exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004571 if (status == PSA_SUCCESS) {
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004572 operation->nonce_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004573 } else {
4574 psa_aead_abort(operation);
4575 }
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004576
Gilles Peskine449bd832023-01-11 14:50:10 +01004577 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004578}
4579
4580/* Declare the lengths of the message and additional data for multipart AEAD. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004581psa_status_t psa_aead_set_lengths(psa_aead_operation_t *operation,
4582 size_t ad_length,
4583 size_t plaintext_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004584{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004585 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4586
Gilles Peskine449bd832023-01-11 14:50:10 +01004587 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004588 status = PSA_ERROR_BAD_STATE;
4589 goto exit;
4590 }
4591
Gilles Peskine449bd832023-01-11 14:50:10 +01004592 if (operation->lengths_set || operation->ad_started ||
4593 operation->body_started) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004594 status = PSA_ERROR_BAD_STATE;
4595 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004596 }
4597
Gilles Peskine449bd832023-01-11 14:50:10 +01004598 switch (operation->alg) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004599#if defined(PSA_WANT_ALG_GCM)
4600 case PSA_ALG_GCM:
4601 /* Lengths can only be too large for GCM if size_t is bigger than 32
Gilles Peskine449bd832023-01-11 14:50:10 +01004602 * bits. Without the guard this code will generate warnings on 32bit
4603 * builds. */
Paul Elliott325d3742021-09-27 17:56:28 +01004604#if SIZE_MAX > UINT32_MAX
Gilles Peskine449bd832023-01-11 14:50:10 +01004605 if (((uint64_t) ad_length) >> 61 != 0 ||
4606 ((uint64_t) plaintext_length) > 0xFFFFFFFE0ull) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004607 status = PSA_ERROR_INVALID_ARGUMENT;
4608 goto exit;
4609 }
Paul Elliott325d3742021-09-27 17:56:28 +01004610#endif
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004611 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004612#endif /* PSA_WANT_ALG_GCM */
4613#if defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004614 case PSA_ALG_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01004615 if (ad_length > 0xFF00) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004616 status = PSA_ERROR_INVALID_ARGUMENT;
4617 goto exit;
4618 }
4619 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004620#endif /* PSA_WANT_ALG_CCM */
4621#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004622 case PSA_ALG_CHACHA20_POLY1305:
4623 /* No length restrictions for ChaChaPoly. */
4624 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004625#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004626 default:
4627 break;
4628 }
Paul Elliott325d3742021-09-27 17:56:28 +01004629
Gilles Peskine449bd832023-01-11 14:50:10 +01004630 status = psa_driver_wrapper_aead_set_lengths(operation, ad_length,
4631 plaintext_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004632
Paul Elliott39dc6b82021-05-11 19:16:09 +01004633exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004634 if (status == PSA_SUCCESS) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01004635 operation->ad_remaining = ad_length;
4636 operation->body_remaining = plaintext_length;
Paul Elliott39dc6b82021-05-11 19:16:09 +01004637 operation->lengths_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004638 } else {
4639 psa_aead_abort(operation);
Paul Elliottee4ffe02021-05-20 17:25:06 +01004640 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01004641
Gilles Peskine449bd832023-01-11 14:50:10 +01004642 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004643}
Paul Elliott3d7d52c2021-09-01 10:33:14 +01004644
4645/* Pass additional data to an active multipart AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004646psa_status_t psa_aead_update_ad(psa_aead_operation_t *operation,
4647 const uint8_t *input,
4648 size_t input_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004649{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004650 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4651
Gilles Peskine449bd832023-01-11 14:50:10 +01004652 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004653 status = PSA_ERROR_BAD_STATE;
4654 goto exit;
4655 }
4656
Gilles Peskine449bd832023-01-11 14:50:10 +01004657 if (!operation->nonce_set || operation->body_started) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004658 status = PSA_ERROR_BAD_STATE;
4659 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004660 }
4661
Gilles Peskine449bd832023-01-11 14:50:10 +01004662 if (operation->lengths_set) {
4663 if (operation->ad_remaining < input_length) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01004664 status = PSA_ERROR_INVALID_ARGUMENT;
4665 goto exit;
4666 }
4667
4668 operation->ad_remaining -= input_length;
4669 }
Paul Elliotte193ea82021-10-01 13:00:16 +01004670#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004671 else if (operation->alg == PSA_ALG_CCM) {
Paul Elliotte193ea82021-10-01 13:00:16 +01004672 status = PSA_ERROR_BAD_STATE;
4673 goto exit;
4674 }
4675#endif /* PSA_WANT_ALG_CCM */
Paul Elliottee4ffe02021-05-20 17:25:06 +01004676
Gilles Peskine449bd832023-01-11 14:50:10 +01004677 status = psa_driver_wrapper_aead_update_ad(operation, input,
4678 input_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004679
Paul Elliott39dc6b82021-05-11 19:16:09 +01004680exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004681 if (status == PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004682 operation->ad_started = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004683 } else {
4684 psa_aead_abort(operation);
4685 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01004686
Gilles Peskine449bd832023-01-11 14:50:10 +01004687 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004688}
4689
4690/* Encrypt or decrypt a message fragment in an active multipart AEAD
4691 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004692psa_status_t psa_aead_update(psa_aead_operation_t *operation,
4693 const uint8_t *input,
4694 size_t input_length,
4695 uint8_t *output,
4696 size_t output_size,
4697 size_t *output_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004698{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004699 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004700
4701 *output_length = 0;
4702
Gilles Peskine449bd832023-01-11 14:50:10 +01004703 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004704 status = PSA_ERROR_BAD_STATE;
4705 goto exit;
4706 }
4707
Gilles Peskine449bd832023-01-11 14:50:10 +01004708 if (!operation->nonce_set) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004709 status = PSA_ERROR_BAD_STATE;
4710 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004711 }
4712
Gilles Peskine449bd832023-01-11 14:50:10 +01004713 if (operation->lengths_set) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01004714 /* Additional data length was supplied, but not all the additional
4715 data was supplied.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004716 if (operation->ad_remaining != 0) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01004717 status = PSA_ERROR_INVALID_ARGUMENT;
4718 goto exit;
4719 }
4720
4721 /* Too much data provided. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004722 if (operation->body_remaining < input_length) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01004723 status = PSA_ERROR_INVALID_ARGUMENT;
4724 goto exit;
4725 }
4726
4727 operation->body_remaining -= input_length;
4728 }
Paul Elliotte193ea82021-10-01 13:00:16 +01004729#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004730 else if (operation->alg == PSA_ALG_CCM) {
Paul Elliotte193ea82021-10-01 13:00:16 +01004731 status = PSA_ERROR_BAD_STATE;
4732 goto exit;
4733 }
4734#endif /* PSA_WANT_ALG_CCM */
Paul Elliottee4ffe02021-05-20 17:25:06 +01004735
Gilles Peskine449bd832023-01-11 14:50:10 +01004736 status = psa_driver_wrapper_aead_update(operation, input, input_length,
4737 output, output_size,
4738 output_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004739
Paul Elliott39dc6b82021-05-11 19:16:09 +01004740exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004741 if (status == PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004742 operation->body_started = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004743 } else {
4744 psa_aead_abort(operation);
4745 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01004746
Gilles Peskine449bd832023-01-11 14:50:10 +01004747 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004748}
4749
Gilles Peskine449bd832023-01-11 14:50:10 +01004750static psa_status_t psa_aead_final_checks(const psa_aead_operation_t *operation)
Paul Elliottad53dcc2021-06-23 08:50:14 +01004751{
Gilles Peskine449bd832023-01-11 14:50:10 +01004752 if (operation->id == 0 || !operation->nonce_set) {
4753 return PSA_ERROR_BAD_STATE;
4754 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01004755
Gilles Peskine449bd832023-01-11 14:50:10 +01004756 if (operation->lengths_set && (operation->ad_remaining != 0 ||
4757 operation->body_remaining != 0)) {
4758 return PSA_ERROR_INVALID_ARGUMENT;
4759 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01004760
Gilles Peskine449bd832023-01-11 14:50:10 +01004761 return PSA_SUCCESS;
Paul Elliottad53dcc2021-06-23 08:50:14 +01004762}
4763
Paul Elliott302ff6b2021-04-20 18:10:30 +01004764/* Finish encrypting a message in a multipart AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004765psa_status_t psa_aead_finish(psa_aead_operation_t *operation,
4766 uint8_t *ciphertext,
4767 size_t ciphertext_size,
4768 size_t *ciphertext_length,
4769 uint8_t *tag,
4770 size_t tag_size,
4771 size_t *tag_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004772{
Paul Elliott39dc6b82021-05-11 19:16:09 +01004773 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4774
Paul Elliott302ff6b2021-04-20 18:10:30 +01004775 *ciphertext_length = 0;
Paul Elliottf88a5652021-06-22 17:53:45 +01004776 *tag_length = tag_size;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004777
Gilles Peskine449bd832023-01-11 14:50:10 +01004778 status = psa_aead_final_checks(operation);
4779 if (status != PSA_SUCCESS) {
Paul Elliottad53dcc2021-06-23 08:50:14 +01004780 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004781 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01004782
Gilles Peskine449bd832023-01-11 14:50:10 +01004783 if (!operation->is_encrypt) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004784 status = PSA_ERROR_BAD_STATE;
4785 goto exit;
4786 }
4787
Gilles Peskine449bd832023-01-11 14:50:10 +01004788 status = psa_driver_wrapper_aead_finish(operation, ciphertext,
4789 ciphertext_size,
4790 ciphertext_length,
4791 tag, tag_size, tag_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004792
Paul Elliott39dc6b82021-05-11 19:16:09 +01004793exit:
Paul Elliottdc42ca82023-02-24 18:11:59 +00004794
4795
Paul Elliottf47b0952021-05-21 18:02:33 +01004796 /* In case the operation fails and the user fails to check for failure or
Paul Elliott4c916e82021-09-19 18:34:50 +01004797 * the zero tag size, make sure the tag is set to something implausible.
4798 * Even if the operation succeeds, make sure we clear the rest of the
4799 * buffer to prevent potential leakage of anything previously placed in
4800 * the same buffer.*/
Paul Elliottdc42ca82023-02-24 18:11:59 +00004801 psa_wipe_tag_output_buffer(tag, status, tag_size, *tag_length);
Paul Elliottf47b0952021-05-21 18:02:33 +01004802
Gilles Peskine449bd832023-01-11 14:50:10 +01004803 psa_aead_abort(operation);
Paul Elliott39dc6b82021-05-11 19:16:09 +01004804
Gilles Peskine449bd832023-01-11 14:50:10 +01004805 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004806}
4807
4808/* Finish authenticating and decrypting a message in a multipart AEAD
4809 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004810psa_status_t psa_aead_verify(psa_aead_operation_t *operation,
4811 uint8_t *plaintext,
4812 size_t plaintext_size,
4813 size_t *plaintext_length,
4814 const uint8_t *tag,
4815 size_t tag_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004816{
Paul Elliott39dc6b82021-05-11 19:16:09 +01004817 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4818
Paul Elliott302ff6b2021-04-20 18:10:30 +01004819 *plaintext_length = 0;
4820
Gilles Peskine449bd832023-01-11 14:50:10 +01004821 status = psa_aead_final_checks(operation);
4822 if (status != PSA_SUCCESS) {
Paul Elliottad53dcc2021-06-23 08:50:14 +01004823 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004824 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01004825
Gilles Peskine449bd832023-01-11 14:50:10 +01004826 if (operation->is_encrypt) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004827 status = PSA_ERROR_BAD_STATE;
4828 goto exit;
4829 }
4830
Gilles Peskine449bd832023-01-11 14:50:10 +01004831 status = psa_driver_wrapper_aead_verify(operation, plaintext,
4832 plaintext_size,
4833 plaintext_length,
4834 tag, tag_length);
Paul Elliott39dc6b82021-05-11 19:16:09 +01004835
4836exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004837 psa_aead_abort(operation);
Paul Elliott39dc6b82021-05-11 19:16:09 +01004838
Gilles Peskine449bd832023-01-11 14:50:10 +01004839 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004840}
4841
4842/* Abort an AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004843psa_status_t psa_aead_abort(psa_aead_operation_t *operation)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004844{
4845 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4846
Gilles Peskine449bd832023-01-11 14:50:10 +01004847 if (operation->id == 0) {
Paul Elliott302ff6b2021-04-20 18:10:30 +01004848 /* The object has (apparently) been initialized but it is not (yet)
4849 * in use. It's ok to call abort on such an object, and there's
4850 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004851 return PSA_SUCCESS;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004852 }
4853
Gilles Peskine449bd832023-01-11 14:50:10 +01004854 status = psa_driver_wrapper_aead_abort(operation);
Paul Elliott302ff6b2021-04-20 18:10:30 +01004855
Gilles Peskine449bd832023-01-11 14:50:10 +01004856 memset(operation, 0, sizeof(*operation));
Paul Elliott302ff6b2021-04-20 18:10:30 +01004857
Gilles Peskine449bd832023-01-11 14:50:10 +01004858 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004859}
4860
Gilles Peskinee59236f2018-01-27 23:32:46 +01004861/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02004862/* Generators */
4863/****************************************************************/
4864
Przemek Stekiel69c46792022-06-10 12:59:51 +02004865#if defined(BUILTIN_ALG_ANY_HKDF) || \
John Durkop07cc04a2020-11-16 22:08:34 -08004866 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
Andrzej Kurek08d34b82022-07-29 10:00:16 -04004867 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) || \
Kusumit Ghoderaoaf0b5342023-05-03 11:58:46 +05304868 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS) || \
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05304869 defined(PSA_HAVE_SOFT_PBKDF2)
John Durkop07cc04a2020-11-16 22:08:34 -08004870#define AT_LEAST_ONE_BUILTIN_KDF
Steven Cooreman094a77e2021-05-06 17:58:36 +02004871#endif /* At least one builtin KDF */
4872
Przemek Stekiel69c46792022-06-10 12:59:51 +02004873#if defined(BUILTIN_ALG_ANY_HKDF) || \
Steven Cooreman094a77e2021-05-06 17:58:36 +02004874 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4875 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4876static psa_status_t psa_key_derivation_start_hmac(
4877 psa_mac_operation_t *operation,
4878 psa_algorithm_t hash_alg,
4879 const uint8_t *hmac_key,
Gilles Peskine449bd832023-01-11 14:50:10 +01004880 size_t hmac_key_length)
Steven Cooreman094a77e2021-05-06 17:58:36 +02004881{
4882 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4883 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01004884 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
4885 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(hmac_key_length));
4886 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_HASH);
Steven Cooreman094a77e2021-05-06 17:58:36 +02004887
Steven Cooreman72f736a2021-05-07 14:14:37 +02004888 operation->is_sign = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004889 operation->mac_size = PSA_HASH_LENGTH(hash_alg);
Steven Cooreman72f736a2021-05-07 14:14:37 +02004890
Gilles Peskine449bd832023-01-11 14:50:10 +01004891 status = psa_driver_wrapper_mac_sign_setup(operation,
4892 &attributes,
4893 hmac_key, hmac_key_length,
4894 PSA_ALG_HMAC(hash_alg));
Steven Cooreman094a77e2021-05-06 17:58:36 +02004895
Gilles Peskine449bd832023-01-11 14:50:10 +01004896 psa_reset_key_attributes(&attributes);
4897 return status;
Steven Cooreman094a77e2021-05-06 17:58:36 +02004898}
4899#endif /* KDF algorithms reliant on HMAC */
John Durkop07cc04a2020-11-16 22:08:34 -08004900
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004901#define HKDF_STATE_INIT 0 /* no input yet */
4902#define HKDF_STATE_STARTED 1 /* got salt */
4903#define HKDF_STATE_KEYED 2 /* got key */
4904#define HKDF_STATE_OUTPUT 3 /* output started */
4905
Gilles Peskinecbe66502019-05-16 16:59:18 +02004906static psa_algorithm_t psa_key_derivation_get_kdf_alg(
Gilles Peskine449bd832023-01-11 14:50:10 +01004907 const psa_key_derivation_operation_t *operation)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004908{
Gilles Peskine449bd832023-01-11 14:50:10 +01004909 if (PSA_ALG_IS_KEY_AGREEMENT(operation->alg)) {
4910 return PSA_ALG_KEY_AGREEMENT_GET_KDF(operation->alg);
4911 } else {
4912 return operation->alg;
4913 }
Gilles Peskine969c5d62019-01-16 15:53:06 +01004914}
4915
Gilles Peskine449bd832023-01-11 14:50:10 +01004916psa_status_t psa_key_derivation_abort(psa_key_derivation_operation_t *operation)
Gilles Peskineeab56e42018-07-12 17:12:33 +02004917{
4918 psa_status_t status = PSA_SUCCESS;
Gilles Peskine449bd832023-01-11 14:50:10 +01004919 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
4920 if (kdf_alg == 0) {
Gilles Peskineeab56e42018-07-12 17:12:33 +02004921 /* The object has (apparently) been initialized but it is not
4922 * in use. It's ok to call abort on such an object, and there's
4923 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004924 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02004925#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01004926 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
4927 mbedtls_free(operation->ctx.hkdf.info);
4928 status = psa_mac_abort(&operation->ctx.hkdf.hmac);
4929 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02004930#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08004931#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4932 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004933 if (PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
4934 /* TLS-1.2 PSK-to-MS KDF uses the same core as TLS-1.2 PRF */
4935 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
4936 if (operation->ctx.tls12_prf.secret != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01004937 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.secret,
Gilles Peskine449bd832023-01-11 14:50:10 +01004938 operation->ctx.tls12_prf.secret_length);
Steven Cooremana6df6042021-04-29 19:32:25 +02004939 }
4940
Gilles Peskine449bd832023-01-11 14:50:10 +01004941 if (operation->ctx.tls12_prf.seed != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01004942 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.seed,
Gilles Peskine449bd832023-01-11 14:50:10 +01004943 operation->ctx.tls12_prf.seed_length);
Janos Follath6a1d2622019-06-11 10:37:28 +01004944 }
4945
Gilles Peskine449bd832023-01-11 14:50:10 +01004946 if (operation->ctx.tls12_prf.label != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01004947 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.label,
Gilles Peskine449bd832023-01-11 14:50:10 +01004948 operation->ctx.tls12_prf.label_length);
Janos Follath6a1d2622019-06-11 10:37:28 +01004949 }
Przemek Stekiel6c764412022-11-22 14:05:12 +01004950#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004951 if (operation->ctx.tls12_prf.other_secret != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01004952 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.other_secret,
Gilles Peskine449bd832023-01-11 14:50:10 +01004953 operation->ctx.tls12_prf.other_secret_length);
Przemek Stekiele3ee2212022-04-07 14:29:56 +02004954 }
Przemek Stekiel6c764412022-11-22 14:05:12 +01004955#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Steven Cooremana6df6042021-04-29 19:32:25 +02004956 status = PSA_SUCCESS;
Janos Follath6a1d2622019-06-11 10:37:28 +01004957
4958 /* We leave the fields Ai and output_block to be erased safely by the
4959 * mbedtls_platform_zeroize() in the end of this function. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004960 } else
John Durkop07cc04a2020-11-16 22:08:34 -08004961#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
4962 * defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04004963#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004964 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
4965 mbedtls_platform_zeroize(operation->ctx.tls12_ecjpake_to_pms.data,
4966 sizeof(operation->ctx.tls12_ecjpake_to_pms.data));
4967 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04004968#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS) */
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05304969#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05304970 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05304971 if (operation->ctx.pbkdf2.salt != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01004972 mbedtls_zeroize_and_free(operation->ctx.pbkdf2.salt,
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05304973 operation->ctx.pbkdf2.salt_length);
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05304974 }
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05304975
4976 status = PSA_SUCCESS;
4977 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05304978#endif /* defined(PSA_HAVE_SOFT_PBKDF2) */
Gilles Peskineeab56e42018-07-12 17:12:33 +02004979 {
4980 status = PSA_ERROR_BAD_STATE;
4981 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004982 mbedtls_platform_zeroize(operation, sizeof(*operation));
4983 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004984}
4985
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004986psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskine449bd832023-01-11 14:50:10 +01004987 size_t *capacity)
Gilles Peskineeab56e42018-07-12 17:12:33 +02004988{
Gilles Peskine449bd832023-01-11 14:50:10 +01004989 if (operation->alg == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004990 /* This is a blank key derivation operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004991 return PSA_ERROR_BAD_STATE;
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004992 }
4993
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004994 *capacity = operation->capacity;
Gilles Peskine449bd832023-01-11 14:50:10 +01004995 return PSA_SUCCESS;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004996}
4997
Gilles Peskine449bd832023-01-11 14:50:10 +01004998psa_status_t psa_key_derivation_set_capacity(psa_key_derivation_operation_t *operation,
4999 size_t capacity)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005000{
Gilles Peskine449bd832023-01-11 14:50:10 +01005001 if (operation->alg == 0) {
5002 return PSA_ERROR_BAD_STATE;
5003 }
5004 if (capacity > operation->capacity) {
5005 return PSA_ERROR_INVALID_ARGUMENT;
5006 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005007 operation->capacity = capacity;
Gilles Peskine449bd832023-01-11 14:50:10 +01005008 return PSA_SUCCESS;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005009}
5010
Przemek Stekiel69c46792022-06-10 12:59:51 +02005011#if defined(BUILTIN_ALG_ANY_HKDF)
Przemek Stekiel03d948c2022-05-19 11:45:20 +02005012/* Read some bytes from an HKDF-based operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005013static psa_status_t psa_key_derivation_hkdf_read(psa_hkdf_key_derivation_t *hkdf,
5014 psa_algorithm_t kdf_alg,
5015 uint8_t *output,
5016 size_t output_length)
Gilles Peskinebef7f142018-07-12 17:22:21 +02005017{
Gilles Peskine449bd832023-01-11 14:50:10 +01005018 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
5019 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Steven Cooremand1ed1d92021-04-29 19:11:25 +02005020 size_t hmac_output_length;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005021 psa_status_t status;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005022#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01005023 const uint8_t last_block = PSA_ALG_IS_HKDF_EXTRACT(kdf_alg) ? 0 : 0xff;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005024#else
5025 const uint8_t last_block = 0xff;
5026#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskinebef7f142018-07-12 17:22:21 +02005027
Gilles Peskine449bd832023-01-11 14:50:10 +01005028 if (hkdf->state < HKDF_STATE_KEYED ||
5029 (!hkdf->info_set
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005030#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01005031 && !PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005032#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01005033 )) {
5034 return PSA_ERROR_BAD_STATE;
5035 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005036 hkdf->state = HKDF_STATE_OUTPUT;
5037
Gilles Peskine449bd832023-01-11 14:50:10 +01005038 while (output_length != 0) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005039 /* Copy what remains of the current block */
5040 uint8_t n = hash_length - hkdf->offset_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005041 if (n > output_length) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005042 n = (uint8_t) output_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01005043 }
5044 memcpy(output, hkdf->output_block + hkdf->offset_in_block, n);
Gilles Peskinebef7f142018-07-12 17:22:21 +02005045 output += n;
5046 output_length -= n;
5047 hkdf->offset_in_block += n;
Gilles Peskine449bd832023-01-11 14:50:10 +01005048 if (output_length == 0) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005049 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01005050 }
Przemek Stekiel03d948c2022-05-19 11:45:20 +02005051 /* We can't be wanting more output after the last block, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005052 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005053 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02005054 * object was corrupted or if this function is called directly
5055 * inside the library. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005056 if (hkdf->block_number == last_block) {
5057 return PSA_ERROR_BAD_STATE;
5058 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02005059
5060 /* We need a new block */
5061 ++hkdf->block_number;
5062 hkdf->offset_in_block = 0;
Steven Cooremand1ed1d92021-04-29 19:11:25 +02005063
Gilles Peskine449bd832023-01-11 14:50:10 +01005064 status = psa_key_derivation_start_hmac(&hkdf->hmac,
5065 hash_alg,
5066 hkdf->prk,
5067 hash_length);
5068 if (status != PSA_SUCCESS) {
5069 return status;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005070 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005071
5072 if (hkdf->block_number != 1) {
5073 status = psa_mac_update(&hkdf->hmac,
5074 hkdf->output_block,
5075 hash_length);
5076 if (status != PSA_SUCCESS) {
5077 return status;
5078 }
5079 }
5080 status = psa_mac_update(&hkdf->hmac,
5081 hkdf->info,
5082 hkdf->info_length);
5083 if (status != PSA_SUCCESS) {
5084 return status;
5085 }
5086 status = psa_mac_update(&hkdf->hmac,
5087 &hkdf->block_number, 1);
5088 if (status != PSA_SUCCESS) {
5089 return status;
5090 }
5091 status = psa_mac_sign_finish(&hkdf->hmac,
5092 hkdf->output_block,
5093 sizeof(hkdf->output_block),
5094 &hmac_output_length);
5095 if (status != PSA_SUCCESS) {
5096 return status;
5097 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02005098 }
5099
Gilles Peskine449bd832023-01-11 14:50:10 +01005100 return PSA_SUCCESS;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005101}
Przemek Stekiel69c46792022-06-10 12:59:51 +02005102#endif /* BUILTIN_ALG_ANY_HKDF */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005103
John Durkop07cc04a2020-11-16 22:08:34 -08005104#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5105 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follath7742fee2019-06-17 12:58:10 +01005106static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
5107 psa_tls12_prf_key_derivation_t *tls12_prf,
Gilles Peskine449bd832023-01-11 14:50:10 +01005108 psa_algorithm_t alg)
Janos Follath7742fee2019-06-17 12:58:10 +01005109{
Gilles Peskine449bd832023-01-11 14:50:10 +01005110 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(alg);
5111 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Steven Cooremana6df6042021-04-29 19:32:25 +02005112 psa_mac_operation_t hmac = PSA_MAC_OPERATION_INIT;
5113 size_t hmac_output_length;
Janos Follathea29bfb2019-06-19 12:21:20 +01005114 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005115
Janos Follath7742fee2019-06-17 12:58:10 +01005116 /* We can't be wanting more output after block 0xff, otherwise
5117 * the capacity check in psa_key_derivation_output_bytes() would have
5118 * prevented this call. It could happen only if the operation
5119 * object was corrupted or if this function is called directly
5120 * inside the library. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005121 if (tls12_prf->block_number == 0xff) {
5122 return PSA_ERROR_CORRUPTION_DETECTED;
5123 }
Janos Follath7742fee2019-06-17 12:58:10 +01005124
5125 /* We need a new block */
5126 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01005127 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01005128
5129 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
5130 *
5131 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
5132 *
5133 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
5134 * HMAC_hash(secret, A(2) + seed) +
5135 * HMAC_hash(secret, A(3) + seed) + ...
5136 *
5137 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01005138 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01005139 *
Janos Follathea29bfb2019-06-19 12:21:20 +01005140 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01005141 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01005142 * is currently extracted as `output_block` and where i is
5143 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01005144 */
5145
Gilles Peskine449bd832023-01-11 14:50:10 +01005146 status = psa_key_derivation_start_hmac(&hmac,
5147 hash_alg,
5148 tls12_prf->secret,
5149 tls12_prf->secret_length);
5150 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005151 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005152 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005153
5154 /* Calculate A(i) where i = tls12_prf->block_number. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005155 if (tls12_prf->block_number == 1) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005156 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
5157 * the variable seed and in this instance means it in the context of the
5158 * P_hash function, where seed = label + seed.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01005159 status = psa_mac_update(&hmac,
5160 tls12_prf->label,
5161 tls12_prf->label_length);
5162 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005163 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005164 }
5165 status = psa_mac_update(&hmac,
5166 tls12_prf->seed,
5167 tls12_prf->seed_length);
5168 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005169 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005170 }
5171 } else {
Janos Follathea29bfb2019-06-19 12:21:20 +01005172 /* A(i) = HMAC_hash(secret, A(i-1)) */
Gilles Peskine449bd832023-01-11 14:50:10 +01005173 status = psa_mac_update(&hmac, tls12_prf->Ai, hash_length);
5174 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005175 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005176 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005177 }
5178
Gilles Peskine449bd832023-01-11 14:50:10 +01005179 status = psa_mac_sign_finish(&hmac,
5180 tls12_prf->Ai, hash_length,
5181 &hmac_output_length);
5182 if (hmac_output_length != hash_length) {
Steven Cooremana6df6042021-04-29 19:32:25 +02005183 status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01005184 }
5185 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005186 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005187 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005188
5189 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
Gilles Peskine449bd832023-01-11 14:50:10 +01005190 status = psa_key_derivation_start_hmac(&hmac,
5191 hash_alg,
5192 tls12_prf->secret,
5193 tls12_prf->secret_length);
5194 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005195 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005196 }
5197 status = psa_mac_update(&hmac, tls12_prf->Ai, hash_length);
5198 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005199 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005200 }
5201 status = psa_mac_update(&hmac, tls12_prf->label, tls12_prf->label_length);
5202 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005203 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005204 }
5205 status = psa_mac_update(&hmac, tls12_prf->seed, tls12_prf->seed_length);
5206 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005207 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005208 }
5209 status = psa_mac_sign_finish(&hmac,
5210 tls12_prf->output_block, hash_length,
5211 &hmac_output_length);
5212 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005213 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005214 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005215
Janos Follath7742fee2019-06-17 12:58:10 +01005216
5217cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01005218 cleanup_status = psa_mac_abort(&hmac);
5219 if (status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005220 status = cleanup_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01005221 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005222
Gilles Peskine449bd832023-01-11 14:50:10 +01005223 return status;
Janos Follath7742fee2019-06-17 12:58:10 +01005224}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005225
Janos Follath844eb0e2019-06-19 12:10:49 +01005226static psa_status_t psa_key_derivation_tls12_prf_read(
5227 psa_tls12_prf_key_derivation_t *tls12_prf,
5228 psa_algorithm_t alg,
5229 uint8_t *output,
Gilles Peskine449bd832023-01-11 14:50:10 +01005230 size_t output_length)
Janos Follath844eb0e2019-06-19 12:10:49 +01005231{
Gilles Peskine449bd832023-01-11 14:50:10 +01005232 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH(alg);
5233 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Janos Follath844eb0e2019-06-19 12:10:49 +01005234 psa_status_t status;
5235 uint8_t offset, length;
5236
Gilles Peskine449bd832023-01-11 14:50:10 +01005237 switch (tls12_prf->state) {
Gilles Peskineb1edaec2021-06-11 22:41:46 +02005238 case PSA_TLS12_PRF_STATE_LABEL_SET:
5239 tls12_prf->state = PSA_TLS12_PRF_STATE_OUTPUT;
5240 break;
5241 case PSA_TLS12_PRF_STATE_OUTPUT:
5242 break;
5243 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005244 return PSA_ERROR_BAD_STATE;
Gilles Peskineb1edaec2021-06-11 22:41:46 +02005245 }
5246
Gilles Peskine449bd832023-01-11 14:50:10 +01005247 while (output_length != 0) {
Janos Follath844eb0e2019-06-19 12:10:49 +01005248 /* Check if we have fully processed the current block. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005249 if (tls12_prf->left_in_block == 0) {
5250 status = psa_key_derivation_tls12_prf_generate_next_block(tls12_prf,
5251 alg);
5252 if (status != PSA_SUCCESS) {
5253 return status;
5254 }
Janos Follath844eb0e2019-06-19 12:10:49 +01005255
5256 continue;
5257 }
5258
Gilles Peskine449bd832023-01-11 14:50:10 +01005259 if (tls12_prf->left_in_block > output_length) {
Janos Follath844eb0e2019-06-19 12:10:49 +01005260 length = (uint8_t) output_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01005261 } else {
Janos Follath844eb0e2019-06-19 12:10:49 +01005262 length = tls12_prf->left_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005263 }
Janos Follath844eb0e2019-06-19 12:10:49 +01005264
5265 offset = hash_length - tls12_prf->left_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005266 memcpy(output, tls12_prf->output_block + offset, length);
Janos Follath844eb0e2019-06-19 12:10:49 +01005267 output += length;
5268 output_length -= length;
5269 tls12_prf->left_in_block -= length;
5270 }
5271
Gilles Peskine449bd832023-01-11 14:50:10 +01005272 return PSA_SUCCESS;
Janos Follath844eb0e2019-06-19 12:10:49 +01005273}
John Durkop07cc04a2020-11-16 22:08:34 -08005274#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
5275 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskinebef7f142018-07-12 17:22:21 +02005276
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005277#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
5278static psa_status_t psa_key_derivation_tls12_ecjpake_to_pms_read(
5279 psa_tls12_ecjpake_to_pms_t *ecjpake,
5280 uint8_t *output,
Gilles Peskine449bd832023-01-11 14:50:10 +01005281 size_t output_length)
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005282{
5283 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Andrzej Kurek5603efd2022-09-26 10:49:16 -04005284 size_t output_size = 0;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005285
Gilles Peskine449bd832023-01-11 14:50:10 +01005286 if (output_length != 32) {
5287 return PSA_ERROR_INVALID_ARGUMENT;
5288 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005289
Gilles Peskine449bd832023-01-11 14:50:10 +01005290 status = psa_hash_compute(PSA_ALG_SHA_256, ecjpake->data,
5291 PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE, output, output_length,
5292 &output_size);
5293 if (status != PSA_SUCCESS) {
5294 return status;
5295 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005296
Gilles Peskine449bd832023-01-11 14:50:10 +01005297 if (output_size != output_length) {
5298 return PSA_ERROR_GENERIC_ERROR;
5299 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005300
Gilles Peskine449bd832023-01-11 14:50:10 +01005301 return PSA_SUCCESS;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005302}
5303#endif
5304
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305305#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305306static psa_status_t psa_key_derivation_pbkdf2_generate_block(
5307 psa_pbkdf2_key_derivation_t *pbkdf2,
5308 psa_algorithm_t prf_alg,
5309 uint8_t prf_output_length,
5310 psa_key_attributes_t *attributes)
5311{
5312 psa_status_t status;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305313 psa_mac_operation_t mac_operation = PSA_MAC_OPERATION_INIT;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305314 size_t mac_output_length;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305315 uint8_t U_i[PSA_MAC_MAX_SIZE];
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305316 uint8_t *U_accumulator = pbkdf2->output_block;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305317 uint64_t i;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305318 uint8_t block_counter[4];
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305319
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305320 mac_operation.is_sign = 1;
5321 mac_operation.mac_size = prf_output_length;
5322 MBEDTLS_PUT_UINT32_BE(pbkdf2->block_number, block_counter, 0);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305323
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305324 status = psa_driver_wrapper_mac_sign_setup(&mac_operation,
5325 attributes,
5326 pbkdf2->password,
5327 pbkdf2->password_length,
5328 prf_alg);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305329 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305330 goto cleanup;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305331 }
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305332 status = psa_mac_update(&mac_operation, pbkdf2->salt, pbkdf2->salt_length);
5333 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305334 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305335 }
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305336 status = psa_mac_update(&mac_operation, block_counter, sizeof(block_counter));
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305337 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305338 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305339 }
5340 status = psa_mac_sign_finish(&mac_operation, U_i, sizeof(U_i),
5341 &mac_output_length);
5342 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305343 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305344 }
5345
5346 if (mac_output_length != prf_output_length) {
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305347 status = PSA_ERROR_CORRUPTION_DETECTED;
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305348 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305349 }
5350
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305351 memcpy(U_accumulator, U_i, prf_output_length);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305352
5353 for (i = 1; i < pbkdf2->input_cost; i++) {
Kusumit Ghoderao4536bb62023-06-22 15:42:59 +05305354 /* We are passing prf_output_length as mac_size because the driver
5355 * function directly sets mac_output_length as mac_size upon success.
Kusumit Ghoderao5f3345a2023-07-27 21:21:38 +05305356 * See https://github.com/Mbed-TLS/mbedtls/issues/7801 */
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305357 status = psa_driver_wrapper_mac_compute(attributes,
5358 pbkdf2->password,
5359 pbkdf2->password_length,
5360 prf_alg, U_i, prf_output_length,
Kusumit Ghoderao4536bb62023-06-22 15:42:59 +05305361 U_i, prf_output_length,
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305362 &mac_output_length);
5363 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305364 goto cleanup;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305365 }
5366
Kusumit Ghoderao109ee3d2023-06-08 16:36:45 +05305367 mbedtls_xor(U_accumulator, U_accumulator, U_i, prf_output_length);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305368 }
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305369
5370cleanup:
5371 /* Zeroise buffers to clear sensitive data from memory. */
5372 mbedtls_platform_zeroize(U_i, PSA_MAC_MAX_SIZE);
5373 return status;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305374}
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05305375
5376static psa_status_t psa_key_derivation_pbkdf2_read(
5377 psa_pbkdf2_key_derivation_t *pbkdf2,
5378 psa_algorithm_t kdf_alg,
5379 uint8_t *output,
5380 size_t output_length)
5381{
5382 psa_status_t status;
5383 psa_algorithm_t prf_alg;
5384 uint8_t prf_output_length;
5385 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
5386 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(pbkdf2->password_length));
5387 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
5388
5389 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
5390 prf_alg = PSA_ALG_HMAC(PSA_ALG_PBKDF2_HMAC_GET_HASH(kdf_alg));
5391 prf_output_length = PSA_HASH_LENGTH(prf_alg);
5392 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
Kusumit Ghoderaoa2520a52023-06-22 15:42:19 +05305393 } else if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
5394 prf_alg = PSA_ALG_CMAC;
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05305395 prf_output_length = PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC);
Kusumit Ghoderaoa2520a52023-06-22 15:42:19 +05305396 psa_set_key_type(&attributes, PSA_KEY_TYPE_AES);
Kusumit Ghoderaod9ec1af2023-06-08 20:19:51 +05305397 } else {
5398 return PSA_ERROR_INVALID_ARGUMENT;
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05305399 }
5400
5401 switch (pbkdf2->state) {
5402 case PSA_PBKDF2_STATE_PASSWORD_SET:
5403 /* Initially we need a new block so bytes_used is equal to block size*/
5404 pbkdf2->bytes_used = prf_output_length;
5405 pbkdf2->state = PSA_PBKDF2_STATE_OUTPUT;
5406 break;
5407 case PSA_PBKDF2_STATE_OUTPUT:
5408 break;
5409 default:
5410 return PSA_ERROR_BAD_STATE;
5411 }
5412
5413 while (output_length != 0) {
5414 uint8_t n = prf_output_length - pbkdf2->bytes_used;
5415 if (n > output_length) {
5416 n = (uint8_t) output_length;
5417 }
5418 memcpy(output, pbkdf2->output_block + pbkdf2->bytes_used, n);
5419 output += n;
5420 output_length -= n;
5421 pbkdf2->bytes_used += n;
5422
5423 if (output_length == 0) {
5424 break;
5425 }
5426
5427 /* We need a new block */
5428 pbkdf2->bytes_used = 0;
5429 pbkdf2->block_number++;
5430
5431 status = psa_key_derivation_pbkdf2_generate_block(pbkdf2, prf_alg,
5432 prf_output_length,
5433 &attributes);
5434 if (status != PSA_SUCCESS) {
5435 return status;
5436 }
5437 }
5438
5439 return PSA_SUCCESS;
5440}
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305441#endif /* PSA_HAVE_SOFT_PBKDF2 */
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305442
Janos Follath6c6c8fc2019-06-17 12:38:20 +01005443psa_status_t psa_key_derivation_output_bytes(
5444 psa_key_derivation_operation_t *operation,
5445 uint8_t *output,
Gilles Peskine449bd832023-01-11 14:50:10 +01005446 size_t output_length)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005447{
5448 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01005449 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
Gilles Peskineeab56e42018-07-12 17:12:33 +02005450
Gilles Peskine449bd832023-01-11 14:50:10 +01005451 if (operation->alg == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005452 /* This is a blank operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005453 return PSA_ERROR_BAD_STATE;
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005454 }
5455
Gilles Peskine449bd832023-01-11 14:50:10 +01005456 if (output_length > operation->capacity) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005457 operation->capacity = 0;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005458 /* Go through the error path to wipe all confidential data now
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005459 * that the operation object is useless. */
David Saadab4ecc272019-02-14 13:48:10 +02005460 status = PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005461 goto exit;
5462 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005463 if (output_length == 0 && operation->capacity == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005464 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005465 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02005466 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
5467 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005468 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02005469 * output_length > 0. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005470 return PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005471 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005472 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005473
Przemek Stekiel69c46792022-06-10 12:59:51 +02005474#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01005475 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
5476 status = psa_key_derivation_hkdf_read(&operation->ctx.hkdf, kdf_alg,
5477 output, output_length);
5478 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02005479#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08005480#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5481 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005482 if (PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
5483 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
5484 status = psa_key_derivation_tls12_prf_read(&operation->ctx.tls12_prf,
5485 kdf_alg, output,
5486 output_length);
5487 } else
John Durkop07cc04a2020-11-16 22:08:34 -08005488#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
5489 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005490#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005491 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005492 status = psa_key_derivation_tls12_ecjpake_to_pms_read(
Gilles Peskine449bd832023-01-11 14:50:10 +01005493 &operation->ctx.tls12_ecjpake_to_pms, output, output_length);
5494 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005495#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305496#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05305497 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05305498 status = psa_key_derivation_pbkdf2_read(&operation->ctx.pbkdf2, kdf_alg,
5499 output, output_length);
Kusumit Ghoderao056f0c52023-05-03 15:58:34 +05305500 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305501#endif /* PSA_HAVE_SOFT_PBKDF2 */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005502
Gilles Peskineeab56e42018-07-12 17:12:33 +02005503 {
Steven Cooreman74afe472021-02-10 17:19:22 +01005504 (void) kdf_alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01005505 return PSA_ERROR_BAD_STATE;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005506 }
5507
5508exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005509 if (status != PSA_SUCCESS) {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005510 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005511 * This allows us to differentiate between exhausted operations and
5512 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
5513 * operations. */
5514 psa_algorithm_t alg = operation->alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01005515 psa_key_derivation_abort(operation);
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005516 operation->alg = alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01005517 memset(output, '!', output_length);
Gilles Peskineeab56e42018-07-12 17:12:33 +02005518 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005519 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005520}
5521
David Brown7807bf72021-02-09 16:28:23 -07005522#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01005523static void psa_des_set_key_parity(uint8_t *data, size_t data_size)
Gilles Peskine08542d82018-07-19 17:05:42 +02005524{
Gilles Peskine449bd832023-01-11 14:50:10 +01005525 if (data_size >= 8) {
5526 mbedtls_des_key_set_parity(data);
5527 }
5528 if (data_size >= 16) {
5529 mbedtls_des_key_set_parity(data + 8);
5530 }
5531 if (data_size >= 24) {
5532 mbedtls_des_key_set_parity(data + 16);
5533 }
Gilles Peskine08542d82018-07-19 17:05:42 +02005534}
David Brown7807bf72021-02-09 16:28:23 -07005535#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine08542d82018-07-19 17:05:42 +02005536
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005537/*
Gilles Peskine449bd832023-01-11 14:50:10 +01005538 * ECC keys on a Weierstrass elliptic curve require the generation
5539 * of a private key which is an integer
5540 * in the range [1, N - 1], where N is the boundary of the private key domain:
5541 * N is the prime p for Diffie-Hellman, or the order of the
5542 * curve’s base point for ECC.
5543 *
5544 * Let m be the bit size of N, such that 2^m > N >= 2^(m-1).
5545 * This function generates the private key using the following process:
5546 *
5547 * 1. Draw a byte string of length ceiling(m/8) bytes.
5548 * 2. If m is not a multiple of 8, set the most significant
5549 * (8 * ceiling(m/8) - m) bits of the first byte in the string to zero.
5550 * 3. Convert the string to integer k by decoding it as a big-endian byte string.
5551 * 4. If k > N - 2, discard the result and return to step 1.
5552 * 5. Output k + 1 as the private key.
5553 *
5554 * This method allows compliance to NIST standards, specifically the methods titled
5555 * Key-Pair Generation by Testing Candidates in the following publications:
5556 * - NIST Special Publication 800-56A: Recommendation for Pair-Wise Key-Establishment
5557 * Schemes Using Discrete Logarithm Cryptography [SP800-56A] §5.6.1.1.4 for
5558 * Diffie-Hellman keys.
5559 *
5560 * - [SP800-56A] §5.6.1.2.2 or FIPS Publication 186-4: Digital Signature
5561 * Standard (DSS) [FIPS186-4] §B.4.2 for elliptic curve keys.
5562 *
5563 * Note: Function allocates memory for *data buffer, so given *data should be
5564 * always NULL.
5565 */
Valerio Setti86587ab2023-06-27 13:09:30 +02005566#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE)
5567#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE)
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01005568static psa_status_t psa_generate_derived_ecc_key_weierstrass_helper(
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005569 psa_key_slot_t *slot,
5570 size_t bits,
5571 psa_key_derivation_operation_t *operation,
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005572 uint8_t **data
5573 )
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005574{
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005575 unsigned key_out_of_range = 1;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005576 mbedtls_mpi k;
5577 mbedtls_mpi diff_N_2;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005578 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Przemek Stekiela81aed22022-03-01 15:13:30 +01005579 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01005580 size_t m;
5581 size_t m_bytes;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005582
Gilles Peskine449bd832023-01-11 14:50:10 +01005583 mbedtls_mpi_init(&k);
5584 mbedtls_mpi_init(&diff_N_2);
Przemyslaw Stekiel1dfd1222021-11-18 13:35:00 +01005585
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005586 psa_ecc_family_t curve = PSA_KEY_TYPE_ECC_GET_FAMILY(
Gilles Peskine449bd832023-01-11 14:50:10 +01005587 slot->attr.type);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005588 mbedtls_ecp_group_id grp_id =
Valerio Settid36c3132023-12-21 14:03:51 +01005589 mbedtls_ecc_group_from_psa(curve, bits);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005590
Gilles Peskine449bd832023-01-11 14:50:10 +01005591 if (grp_id == MBEDTLS_ECP_DP_NONE) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005592 ret = MBEDTLS_ERR_ASN1_INVALID_DATA;
Przemyslaw Stekiel871a3362021-12-02 08:46:39 +01005593 goto cleanup;
5594 }
5595
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005596 mbedtls_ecp_group ecp_group;
Gilles Peskine449bd832023-01-11 14:50:10 +01005597 mbedtls_ecp_group_init(&ecp_group);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005598
Gilles Peskine449bd832023-01-11 14:50:10 +01005599 MBEDTLS_MPI_CHK(mbedtls_ecp_group_load(&ecp_group, grp_id));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005600
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005601 /* N is the boundary of the private key domain (ecp_group.N). */
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005602 /* Let m be the bit size of N. */
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01005603 m = ecp_group.nbits;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005604
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01005605 m_bytes = PSA_BITS_TO_BYTES(m);
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005606
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005607 /* Calculate N - 2 - it will be needed later. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005608 MBEDTLS_MPI_CHK(mbedtls_mpi_sub_int(&diff_N_2, &ecp_group.N, 2));
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005609
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005610 /* Note: This function is always called with *data == NULL and it
5611 * allocates memory for the data buffer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005612 *data = mbedtls_calloc(1, m_bytes);
5613 if (*data == NULL) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005614 ret = MBEDTLS_ERR_ASN1_ALLOC_FAILED;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005615 goto cleanup;
5616 }
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005617
Gilles Peskine449bd832023-01-11 14:50:10 +01005618 while (key_out_of_range) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005619 /* 1. Draw a byte string of length ceiling(m/8) bytes. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005620 if ((status = psa_key_derivation_output_bytes(operation, *data, m_bytes)) != 0) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005621 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005622 }
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005623
5624 /* 2. If m is not a multiple of 8 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005625 if (m % 8 != 0) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005626 /* Set the most significant
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005627 * (8 * ceiling(m/8) - m) bits of the first byte in
5628 * the string to zero.
5629 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005630 uint8_t clear_bit_mask = (1 << (m % 8)) - 1;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005631 (*data)[0] &= clear_bit_mask;
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005632 }
5633
5634 /* 3. Convert the string to integer k by decoding it as a
Gilles Peskine449bd832023-01-11 14:50:10 +01005635 * big-endian byte string.
5636 */
5637 MBEDTLS_MPI_CHK(mbedtls_mpi_read_binary(&k, *data, m_bytes));
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005638
5639 /* 4. If k > N - 2, discard the result and return to step 1.
Gilles Peskine449bd832023-01-11 14:50:10 +01005640 * Result of comparison is returned. When it indicates error
5641 * then this function is called again.
5642 */
5643 MBEDTLS_MPI_CHK(mbedtls_mpi_lt_mpi_ct(&diff_N_2, &k, &key_out_of_range));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005644 }
5645
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005646 /* 5. Output k + 1 as the private key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005647 MBEDTLS_MPI_CHK(mbedtls_mpi_add_int(&k, &k, 1));
5648 MBEDTLS_MPI_CHK(mbedtls_mpi_write_binary(&k, *data, m_bytes));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005649cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01005650 if (ret != 0) {
5651 status = mbedtls_to_psa_error(ret);
5652 }
5653 if (status != PSA_SUCCESS) {
5654 mbedtls_free(*data);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005655 *data = NULL;
5656 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005657 mbedtls_mpi_free(&k);
5658 mbedtls_mpi_free(&diff_N_2);
5659 return status;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005660}
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005661
5662/* ECC keys on a Montgomery elliptic curve draws a byte string whose length
5663 * is determined by the curve, and sets the mandatory bits accordingly. That is:
5664 *
5665 * - Curve25519 (PSA_ECC_FAMILY_MONTGOMERY, 255 bits):
5666 * draw a 32-byte string and process it as specified in
5667 * Elliptic Curves for Security [RFC7748] §5.
5668 *
5669 * - Curve448 (PSA_ECC_FAMILY_MONTGOMERY, 448 bits):
5670 * draw a 56-byte string and process it as specified in [RFC7748] §5.
5671 *
5672 * Note: Function allocates memory for *data buffer, so given *data should be
5673 * always NULL.
5674 */
5675
5676static psa_status_t psa_generate_derived_ecc_key_montgomery_helper(
5677 size_t bits,
5678 psa_key_derivation_operation_t *operation,
5679 uint8_t **data
5680 )
5681{
5682 size_t output_length;
Przemek Stekiela81aed22022-03-01 15:13:30 +01005683 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005684
Gilles Peskine449bd832023-01-11 14:50:10 +01005685 switch (bits) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005686 case 255:
5687 output_length = 32;
5688 break;
5689 case 448:
5690 output_length = 56;
5691 break;
5692 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005693 return PSA_ERROR_INVALID_ARGUMENT;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005694 break;
5695 }
5696
Gilles Peskine449bd832023-01-11 14:50:10 +01005697 *data = mbedtls_calloc(1, output_length);
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005698
Gilles Peskine449bd832023-01-11 14:50:10 +01005699 if (*data == NULL) {
5700 return PSA_ERROR_INSUFFICIENT_MEMORY;
5701 }
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005702
Gilles Peskine449bd832023-01-11 14:50:10 +01005703 status = psa_key_derivation_output_bytes(operation, *data, output_length);
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005704
Gilles Peskine449bd832023-01-11 14:50:10 +01005705 if (status != PSA_SUCCESS) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005706 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01005707 }
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005708
Gilles Peskine449bd832023-01-11 14:50:10 +01005709 switch (bits) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005710 case 255:
5711 (*data)[0] &= 248;
5712 (*data)[31] &= 127;
5713 (*data)[31] |= 64;
5714 break;
5715 case 448:
5716 (*data)[0] &= 252;
5717 (*data)[55] |= 128;
5718 break;
5719 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005720 return PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005721 break;
5722 }
5723
5724 return status;
5725}
Valerio Setti86587ab2023-06-27 13:09:30 +02005726#else /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE */
5727static psa_status_t psa_generate_derived_ecc_key_weierstrass_helper(
5728 psa_key_slot_t *slot, size_t bits,
5729 psa_key_derivation_operation_t *operation, uint8_t **data)
5730{
5731 (void) slot;
5732 (void) bits;
5733 (void) operation;
5734 (void) data;
5735 return PSA_ERROR_NOT_SUPPORTED;
5736}
5737
5738static psa_status_t psa_generate_derived_ecc_key_montgomery_helper(
5739 size_t bits, psa_key_derivation_operation_t *operation, uint8_t **data)
5740{
5741 (void) bits;
5742 (void) operation;
5743 (void) data;
5744 return PSA_ERROR_NOT_SUPPORTED;
5745}
5746#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE */
5747#endif /* PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE */
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005748
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01005749static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005750 psa_key_slot_t *slot,
5751 size_t bits,
Gilles Peskine449bd832023-01-11 14:50:10 +01005752 psa_key_derivation_operation_t *operation)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005753{
5754 uint8_t *data = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01005755 size_t bytes = PSA_BITS_TO_BYTES(bits);
Archanad8a83dc2021-06-14 10:04:16 +05305756 size_t storage_size = bytes;
Przemek Stekiela81aed22022-03-01 15:13:30 +01005757 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005758
Gilles Peskine449bd832023-01-11 14:50:10 +01005759 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(slot->attr.type)) {
5760 return PSA_ERROR_INVALID_ARGUMENT;
5761 }
Gilles Peskineeab56e42018-07-12 17:12:33 +02005762
Valerio Setti8ffdb5d2023-06-20 13:14:08 +02005763#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE) || \
Valerio Settidd24f292023-06-26 12:21:17 +02005764 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE)
Gilles Peskine449bd832023-01-11 14:50:10 +01005765 if (PSA_KEY_TYPE_IS_ECC(slot->attr.type)) {
5766 psa_ecc_family_t curve = PSA_KEY_TYPE_ECC_GET_FAMILY(slot->attr.type);
5767 if (PSA_ECC_FAMILY_IS_WEIERSTRASS(curve)) {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01005768 /* Weierstrass elliptic curve */
Gilles Peskine449bd832023-01-11 14:50:10 +01005769 status = psa_generate_derived_ecc_key_weierstrass_helper(slot, bits, operation, &data);
5770 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005771 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005772 }
5773 } else {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01005774 /* Montgomery elliptic curve */
Gilles Peskine449bd832023-01-11 14:50:10 +01005775 status = psa_generate_derived_ecc_key_montgomery_helper(bits, operation, &data);
5776 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01005777 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005778 }
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01005779 }
Przemyslaw Stekiel1dfd1222021-11-18 13:35:00 +01005780 } else
Valerio Setti8ffdb5d2023-06-20 13:14:08 +02005781#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE) ||
Valerio Settidd24f292023-06-26 12:21:17 +02005782 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE) */
Gilles Peskine449bd832023-01-11 14:50:10 +01005783 if (key_type_is_raw_bytes(slot->attr.type)) {
5784 if (bits % 8 != 0) {
5785 return PSA_ERROR_INVALID_ARGUMENT;
5786 }
5787 data = mbedtls_calloc(1, bytes);
5788 if (data == NULL) {
5789 return PSA_ERROR_INSUFFICIENT_MEMORY;
5790 }
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01005791
Gilles Peskine449bd832023-01-11 14:50:10 +01005792 status = psa_key_derivation_output_bytes(operation, data, bytes);
5793 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01005794 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005795 }
David Brown12ca5032021-02-11 11:02:00 -07005796#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01005797 if (slot->attr.type == PSA_KEY_TYPE_DES) {
5798 psa_des_set_key_parity(data, bytes);
5799 }
Przemek Stekielf110dc02022-03-01 14:48:05 +01005800#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES) */
Gilles Peskine449bd832023-01-11 14:50:10 +01005801 } else {
5802 return PSA_ERROR_NOT_SUPPORTED;
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01005803 }
Ronald Crondd04d422020-11-28 15:14:42 +01005804
Ronald Cronbf33c932020-11-28 18:06:53 +01005805 slot->attr.bits = (psa_key_bits_t) bits;
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01005806
Gilles Peskine2f107ae2024-02-28 01:26:46 +01005807 if (psa_key_lifetime_is_external(slot->attr.lifetime)) {
Gilles Peskine7a5d9202024-02-28 01:18:23 +01005808 status = psa_driver_wrapper_get_key_buffer_size(&slot->attr,
Gilles Peskine449bd832023-01-11 14:50:10 +01005809 &storage_size);
5810 if (status != PSA_SUCCESS) {
Archanad8a83dc2021-06-14 10:04:16 +05305811 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005812 }
Archanad8a83dc2021-06-14 10:04:16 +05305813 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005814 status = psa_allocate_buffer_to_slot(slot, storage_size);
5815 if (status != PSA_SUCCESS) {
Archanad8a83dc2021-06-14 10:04:16 +05305816 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005817 }
Archanad8a83dc2021-06-14 10:04:16 +05305818
Gilles Peskine7a5d9202024-02-28 01:18:23 +01005819 status = psa_driver_wrapper_import_key(&slot->attr,
Gilles Peskine449bd832023-01-11 14:50:10 +01005820 data, bytes,
5821 slot->key.data,
5822 slot->key.bytes,
5823 &slot->key.bytes, &bits);
5824 if (bits != slot->attr.bits) {
Ronald Cronbf33c932020-11-28 18:06:53 +01005825 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine449bd832023-01-11 14:50:10 +01005826 }
Gilles Peskineeab56e42018-07-12 17:12:33 +02005827
5828exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005829 mbedtls_free(data);
5830 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005831}
5832
Gilles Peskine092ce512024-02-20 12:31:24 +01005833static const psa_key_production_parameters_t default_production_parameters =
5834 PSA_KEY_PRODUCTION_PARAMETERS_INIT;
Gilles Peskinef0765fa2024-02-12 16:46:16 +01005835
Gilles Peskine092ce512024-02-20 12:31:24 +01005836int psa_key_production_parameters_are_default(
5837 const psa_key_production_parameters_t *params,
5838 size_t params_data_length)
Gilles Peskinef0765fa2024-02-12 16:46:16 +01005839{
Gilles Peskine092ce512024-02-20 12:31:24 +01005840 if (params->flags != 0) {
Gilles Peskinef0765fa2024-02-12 16:46:16 +01005841 return 0;
5842 }
Gilles Peskine092ce512024-02-20 12:31:24 +01005843 if (params_data_length != 0) {
Gilles Peskinef0765fa2024-02-12 16:46:16 +01005844 return 0;
5845 }
5846 return 1;
5847}
5848
5849psa_status_t psa_key_derivation_output_key_ext(
5850 const psa_key_attributes_t *attributes,
5851 psa_key_derivation_operation_t *operation,
Gilles Peskine092ce512024-02-20 12:31:24 +01005852 const psa_key_production_parameters_t *params,
5853 size_t params_data_length,
Gilles Peskinef0765fa2024-02-12 16:46:16 +01005854 mbedtls_svc_key_id_t *key)
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005855{
5856 psa_status_t status;
5857 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02005858 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine0f84d622019-09-12 19:03:13 +02005859
Ronald Cron81709fc2020-11-14 12:10:32 +01005860 *key = MBEDTLS_SVC_KEY_ID_INIT;
5861
Gilles Peskine0f84d622019-09-12 19:03:13 +02005862 /* Reject any attempt to create a zero-length key so that we don't
5863 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005864 if (psa_get_key_bits(attributes) == 0) {
5865 return PSA_ERROR_INVALID_ARGUMENT;
5866 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02005867
Gilles Peskine092ce512024-02-20 12:31:24 +01005868 if (!psa_key_production_parameters_are_default(params, params_data_length)) {
Gilles Peskinef0765fa2024-02-12 16:46:16 +01005869 return PSA_ERROR_INVALID_ARGUMENT;
5870 }
5871
Gilles Peskine449bd832023-01-11 14:50:10 +01005872 if (operation->alg == PSA_ALG_NONE) {
5873 return PSA_ERROR_BAD_STATE;
5874 }
Dave Rodgmand69da6c2021-11-16 10:32:48 +00005875
Gilles Peskine449bd832023-01-11 14:50:10 +01005876 if (!operation->can_output_key) {
5877 return PSA_ERROR_NOT_PERMITTED;
5878 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02005879
Gilles Peskine449bd832023-01-11 14:50:10 +01005880 status = psa_start_key_creation(PSA_KEY_CREATION_DERIVE, attributes,
5881 &slot, &driver);
Gilles Peskinef4ee6622019-07-24 13:44:30 +02005882#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005883 if (driver != NULL) {
Gilles Peskinef4ee6622019-07-24 13:44:30 +02005884 /* Deriving a key in a secure element is not implemented yet. */
5885 status = PSA_ERROR_NOT_SUPPORTED;
5886 }
5887#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine449bd832023-01-11 14:50:10 +01005888 if (status == PSA_SUCCESS) {
5889 status = psa_generate_derived_key_internal(slot,
Gilles Peskine2f107ae2024-02-28 01:26:46 +01005890 attributes->bits,
Gilles Peskine449bd832023-01-11 14:50:10 +01005891 operation);
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005892 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005893 if (status == PSA_SUCCESS) {
5894 status = psa_finish_key_creation(slot, driver, key);
5895 }
5896 if (status != PSA_SUCCESS) {
5897 psa_fail_key_creation(slot, driver);
5898 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02005899
Gilles Peskine449bd832023-01-11 14:50:10 +01005900 return status;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005901}
5902
Gilles Peskinef0765fa2024-02-12 16:46:16 +01005903psa_status_t psa_key_derivation_output_key(
5904 const psa_key_attributes_t *attributes,
5905 psa_key_derivation_operation_t *operation,
5906 mbedtls_svc_key_id_t *key)
5907{
Gilles Peskinec81393b2024-02-14 20:51:28 +01005908 return psa_key_derivation_output_key_ext(attributes, operation,
Gilles Peskine092ce512024-02-20 12:31:24 +01005909 &default_production_parameters, 0,
Gilles Peskinec81393b2024-02-14 20:51:28 +01005910 key);
Gilles Peskinef0765fa2024-02-12 16:46:16 +01005911}
Gilles Peskineeab56e42018-07-12 17:12:33 +02005912
5913
5914/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02005915/* Key derivation */
5916/****************************************************************/
5917
Steven Cooreman932ffb72021-02-15 12:14:32 +01005918#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01005919static int is_kdf_alg_supported(psa_algorithm_t kdf_alg)
Gilles Peskine9efde4f2021-04-29 21:10:00 +02005920{
5921#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01005922 if (PSA_ALG_IS_HKDF(kdf_alg)) {
5923 return 1;
5924 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02005925#endif
Przemek Stekielb57a44b2022-06-06 08:33:45 +02005926#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01005927 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
5928 return 1;
5929 }
Przemek Stekielb57a44b2022-06-06 08:33:45 +02005930#endif
5931#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01005932 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
5933 return 1;
5934 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02005935#endif
5936#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
Gilles Peskine449bd832023-01-11 14:50:10 +01005937 if (PSA_ALG_IS_TLS12_PRF(kdf_alg)) {
5938 return 1;
5939 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02005940#endif
5941#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005942 if (PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
5943 return 1;
5944 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02005945#endif
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005946#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005947 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
5948 return 1;
5949 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005950#endif
Kusumit Ghoderaod132cac2023-05-03 12:00:27 +05305951#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
5952 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
5953 return 1;
5954 }
5955#endif
Kusumit Ghoderao2cd64962023-06-22 15:38:57 +05305956#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128)
5957 if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
5958 return 1;
5959 }
5960#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005961 return 0;
Gilles Peskine9efde4f2021-04-29 21:10:00 +02005962}
5963
Gilles Peskine449bd832023-01-11 14:50:10 +01005964static psa_status_t psa_hash_try_support(psa_algorithm_t alg)
Gilles Peskine0cc417d2021-04-29 21:18:14 +02005965{
5966 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01005967 psa_status_t status = psa_hash_setup(&operation, alg);
5968 psa_hash_abort(&operation);
5969 return status;
Gilles Peskine0cc417d2021-04-29 21:18:14 +02005970}
5971
Kusumit Ghoderao86e83dd2023-12-01 16:38:26 +05305972static psa_status_t psa_key_derivation_set_maximum_capacity(
5973 psa_key_derivation_operation_t *operation,
5974 psa_algorithm_t kdf_alg)
5975{
5976#if defined(PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS)
5977 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
5978 operation->capacity = PSA_HASH_LENGTH(PSA_ALG_SHA_256);
5979 return PSA_SUCCESS;
5980 }
5981#endif
5982#if defined(PSA_WANT_ALG_PBKDF2_AES_CMAC_PRF_128)
5983 if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
5984#if (SIZE_MAX > UINT32_MAX)
Kusumit Ghoderao7d4db632023-12-07 16:17:46 +05305985 operation->capacity = UINT32_MAX * (size_t) PSA_MAC_LENGTH(
Kusumit Ghoderaod3f70d32023-12-06 16:20:04 +05305986 PSA_KEY_TYPE_AES,
5987 128U,
5988 PSA_ALG_CMAC);
Kusumit Ghoderao86e83dd2023-12-01 16:38:26 +05305989#else
5990 operation->capacity = SIZE_MAX;
5991#endif
5992 return PSA_SUCCESS;
5993 }
5994#endif /* PSA_WANT_ALG_PBKDF2_AES_CMAC_PRF_128 */
5995
5996 /* After this point, if kdf_alg is not valid then value of hash_alg may be
5997 * invalid or meaningless but it does not affect this function */
5998 psa_algorithm_t hash_alg = PSA_ALG_GET_HASH(kdf_alg);
5999 size_t hash_size = PSA_HASH_LENGTH(hash_alg);
Kusumit Ghoderaod3f70d32023-12-06 16:20:04 +05306000 if (hash_size == 0) {
6001 return PSA_ERROR_NOT_SUPPORTED;
6002 }
Kusumit Ghoderao86e83dd2023-12-01 16:38:26 +05306003
6004 /* Make sure that hash_alg is a supported hash algorithm. Otherwise
6005 * we might fail later, which is somewhat unfriendly and potentially
6006 * risk-prone. */
6007 psa_status_t status = psa_hash_try_support(hash_alg);
6008 if (status != PSA_SUCCESS) {
6009 return status;
6010 }
6011
6012#if defined(PSA_WANT_ALG_HKDF)
6013 if (PSA_ALG_IS_HKDF(kdf_alg)) {
6014 operation->capacity = 255 * hash_size;
6015 } else
6016#endif
6017#if defined(PSA_WANT_ALG_HKDF_EXTRACT)
6018 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6019 operation->capacity = hash_size;
6020 } else
6021#endif
6022#if defined(PSA_WANT_ALG_HKDF_EXPAND)
6023 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
6024 operation->capacity = 255 * hash_size;
6025 } else
6026#endif
6027#if defined(PSA_WANT_ALG_TLS12_PRF)
6028 if (PSA_ALG_IS_TLS12_PRF(kdf_alg) &&
6029 (hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384)) {
6030 operation->capacity = SIZE_MAX;
6031 } else
6032#endif
6033#if defined(PSA_WANT_ALG_TLS12_PSK_TO_MS)
6034 if (PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg) &&
6035 (hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384)) {
6036 /* Master Secret is always 48 bytes
6037 * https://datatracker.ietf.org/doc/html/rfc5246.html#section-8.1 */
6038 operation->capacity = 48U;
6039 } else
6040#endif
6041#if defined(PSA_WANT_ALG_PBKDF2_HMAC)
6042 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
6043#if (SIZE_MAX > UINT32_MAX)
6044 operation->capacity = UINT32_MAX * hash_size;
6045#else
6046 operation->capacity = SIZE_MAX;
6047#endif
6048 } else
6049#endif /* PSA_WANT_ALG_PBKDF2_HMAC */
6050 {
Kusumit Ghoderaod3f70d32023-12-06 16:20:04 +05306051 (void) hash_size;
Kusumit Ghoderao86e83dd2023-12-01 16:38:26 +05306052 status = PSA_ERROR_NOT_SUPPORTED;
6053 }
6054 return status;
6055}
6056
Gilles Peskine969c5d62019-01-16 15:53:06 +01006057static psa_status_t psa_key_derivation_setup_kdf(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006058 psa_key_derivation_operation_t *operation,
Gilles Peskine449bd832023-01-11 14:50:10 +01006059 psa_algorithm_t kdf_alg)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006060{
Janos Follath5fe19732019-06-20 15:09:30 +01006061 /* Make sure that operation->ctx is properly zero-initialised. (Macro
6062 * initialisers for this union leave some bytes unspecified.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01006063 memset(&operation->ctx, 0, sizeof(operation->ctx));
Janos Follath5fe19732019-06-20 15:09:30 +01006064
Gilles Peskine969c5d62019-01-16 15:53:06 +01006065 /* Make sure that kdf_alg is a supported key derivation algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006066 if (!is_kdf_alg_supported(kdf_alg)) {
6067 return PSA_ERROR_NOT_SUPPORTED;
6068 }
John Durkop07cc04a2020-11-16 22:08:34 -08006069
Kusumit Ghoderao86e83dd2023-12-01 16:38:26 +05306070 psa_status_t status = psa_key_derivation_set_maximum_capacity(operation,
6071 kdf_alg);
Kusumit Ghoderao5f3a9382023-09-13 16:28:12 +05306072 return status;
Gilles Peskine969c5d62019-01-16 15:53:06 +01006073}
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006074
Gilles Peskine449bd832023-01-11 14:50:10 +01006075static psa_status_t psa_key_agreement_try_support(psa_algorithm_t alg)
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006076{
6077#if defined(PSA_WANT_ALG_ECDH)
Gilles Peskine449bd832023-01-11 14:50:10 +01006078 if (alg == PSA_ALG_ECDH) {
6079 return PSA_SUCCESS;
6080 }
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006081#endif
Przemek Stekielfb3dd542022-12-01 14:59:15 +01006082#if defined(PSA_WANT_ALG_FFDH)
6083 if (alg == PSA_ALG_FFDH) {
6084 return PSA_SUCCESS;
6085 }
6086#endif
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006087 (void) alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01006088 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006089}
Gilles Peskinebb3814c2022-12-16 01:12:12 +01006090
6091static int psa_key_derivation_allows_free_form_secret_input(
6092 psa_algorithm_t kdf_alg)
6093{
6094#if defined(PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS)
6095 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
6096 return 0;
6097 }
6098#endif
6099 (void) kdf_alg;
6100 return 1;
6101}
John Durkop07cc04a2020-11-16 22:08:34 -08006102#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01006103
Gilles Peskine449bd832023-01-11 14:50:10 +01006104psa_status_t psa_key_derivation_setup(psa_key_derivation_operation_t *operation,
6105 psa_algorithm_t alg)
Gilles Peskine969c5d62019-01-16 15:53:06 +01006106{
6107 psa_status_t status;
6108
Gilles Peskine449bd832023-01-11 14:50:10 +01006109 if (operation->alg != 0) {
6110 return PSA_ERROR_BAD_STATE;
Gilles Peskine969c5d62019-01-16 15:53:06 +01006111 }
Gilles Peskine969c5d62019-01-16 15:53:06 +01006112
Gilles Peskine449bd832023-01-11 14:50:10 +01006113 if (PSA_ALG_IS_RAW_KEY_AGREEMENT(alg)) {
6114 return PSA_ERROR_INVALID_ARGUMENT;
6115 } else if (PSA_ALG_IS_KEY_AGREEMENT(alg)) {
6116#if defined(AT_LEAST_ONE_BUILTIN_KDF)
6117 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF(alg);
6118 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE(alg);
6119 status = psa_key_agreement_try_support(ka_alg);
6120 if (status != PSA_SUCCESS) {
6121 return status;
6122 }
Gilles Peskinebb3814c2022-12-16 01:12:12 +01006123 if (!psa_key_derivation_allows_free_form_secret_input(kdf_alg)) {
6124 return PSA_ERROR_INVALID_ARGUMENT;
6125 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006126 status = psa_key_derivation_setup_kdf(operation, kdf_alg);
6127#else
6128 return PSA_ERROR_NOT_SUPPORTED;
6129#endif /* AT_LEAST_ONE_BUILTIN_KDF */
6130 } else if (PSA_ALG_IS_KEY_DERIVATION(alg)) {
6131#if defined(AT_LEAST_ONE_BUILTIN_KDF)
6132 status = psa_key_derivation_setup_kdf(operation, alg);
6133#else
6134 return PSA_ERROR_NOT_SUPPORTED;
6135#endif /* AT_LEAST_ONE_BUILTIN_KDF */
6136 } else {
6137 return PSA_ERROR_INVALID_ARGUMENT;
6138 }
6139
6140 if (status == PSA_SUCCESS) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006141 operation->alg = alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01006142 }
6143 return status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006144}
6145
Przemek Stekiel69c46792022-06-10 12:59:51 +02006146#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006147static psa_status_t psa_hkdf_input(psa_hkdf_key_derivation_t *hkdf,
6148 psa_algorithm_t kdf_alg,
6149 psa_key_derivation_step_t step,
6150 const uint8_t *data,
6151 size_t data_length)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006152{
Gilles Peskine449bd832023-01-11 14:50:10 +01006153 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006154 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006155 switch (step) {
Gilles Peskine03410b52019-05-16 16:05:19 +02006156 case PSA_KEY_DERIVATION_INPUT_SALT:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006157#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006158 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
6159 return PSA_ERROR_INVALID_ARGUMENT;
6160 }
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006161#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND */
Gilles Peskine449bd832023-01-11 14:50:10 +01006162 if (hkdf->state != HKDF_STATE_INIT) {
6163 return PSA_ERROR_BAD_STATE;
6164 } else {
6165 status = psa_key_derivation_start_hmac(&hkdf->hmac,
6166 hash_alg,
6167 data, data_length);
6168 if (status != PSA_SUCCESS) {
6169 return status;
6170 }
Steven Cooremand1ed1d92021-04-29 19:11:25 +02006171 hkdf->state = HKDF_STATE_STARTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01006172 return PSA_SUCCESS;
Steven Cooremand1ed1d92021-04-29 19:11:25 +02006173 }
Gilles Peskine03410b52019-05-16 16:05:19 +02006174 case PSA_KEY_DERIVATION_INPUT_SECRET:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006175#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006176 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
Przemek Stekiel2fb0dcd2022-05-19 10:34:37 +02006177 /* We shouldn't be in different state as HKDF_EXPAND only allows
6178 * two inputs: SECRET (this case) and INFO which does not modify
6179 * the state. It could happen only if the hkdf
6180 * object was corrupted. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006181 if (hkdf->state != HKDF_STATE_INIT) {
6182 return PSA_ERROR_BAD_STATE;
6183 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006184
Przemek Stekiel2fb0dcd2022-05-19 10:34:37 +02006185 /* Allow only input that fits expected prk size */
Gilles Peskine449bd832023-01-11 14:50:10 +01006186 if (data_length != PSA_HASH_LENGTH(hash_alg)) {
6187 return PSA_ERROR_INVALID_ARGUMENT;
6188 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006189
Gilles Peskine449bd832023-01-11 14:50:10 +01006190 memcpy(hkdf->prk, data, data_length);
6191 } else
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006192#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND */
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006193 {
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006194 /* HKDF: If no salt was provided, use an empty salt.
6195 * HKDF-EXTRACT: salt is mandatory. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006196 if (hkdf->state == HKDF_STATE_INIT) {
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006197#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006198 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6199 return PSA_ERROR_BAD_STATE;
6200 }
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006201#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01006202 status = psa_key_derivation_start_hmac(&hkdf->hmac,
6203 hash_alg,
6204 NULL, 0);
6205 if (status != PSA_SUCCESS) {
6206 return status;
6207 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006208 hkdf->state = HKDF_STATE_STARTED;
6209 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006210 if (hkdf->state != HKDF_STATE_STARTED) {
6211 return PSA_ERROR_BAD_STATE;
6212 }
6213 status = psa_mac_update(&hkdf->hmac,
6214 data, data_length);
6215 if (status != PSA_SUCCESS) {
6216 return status;
6217 }
6218 status = psa_mac_sign_finish(&hkdf->hmac,
6219 hkdf->prk,
6220 sizeof(hkdf->prk),
6221 &data_length);
6222 if (status != PSA_SUCCESS) {
6223 return status;
6224 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006225 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006226
Gilles Peskine2b522db2019-04-12 15:11:49 +02006227 hkdf->state = HKDF_STATE_KEYED;
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006228 hkdf->block_number = 0;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006229#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006230 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006231 /* The only block of output is the PRK. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006232 memcpy(hkdf->output_block, hkdf->prk, PSA_HASH_LENGTH(hash_alg));
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006233 hkdf->offset_in_block = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01006234 } else
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006235#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006236 {
6237 /* Block 0 is empty, and the next block will be
6238 * generated by psa_key_derivation_hkdf_read(). */
Gilles Peskine449bd832023-01-11 14:50:10 +01006239 hkdf->offset_in_block = PSA_HASH_LENGTH(hash_alg);
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006240 }
6241
Gilles Peskine449bd832023-01-11 14:50:10 +01006242 return PSA_SUCCESS;
Gilles Peskine03410b52019-05-16 16:05:19 +02006243 case PSA_KEY_DERIVATION_INPUT_INFO:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006244#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006245 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6246 return PSA_ERROR_INVALID_ARGUMENT;
6247 }
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006248#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Przemek Stekielcde3f782022-06-03 16:12:27 +02006249#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006250 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg) &&
6251 hkdf->state == HKDF_STATE_INIT) {
6252 return PSA_ERROR_BAD_STATE;
6253 }
Przemek Stekielcde3f782022-06-03 16:12:27 +02006254#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01006255 if (hkdf->state == HKDF_STATE_OUTPUT) {
6256 return PSA_ERROR_BAD_STATE;
6257 }
6258 if (hkdf->info_set) {
6259 return PSA_ERROR_BAD_STATE;
6260 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006261 hkdf->info_length = data_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01006262 if (data_length != 0) {
6263 hkdf->info = mbedtls_calloc(1, data_length);
6264 if (hkdf->info == NULL) {
6265 return PSA_ERROR_INSUFFICIENT_MEMORY;
6266 }
6267 memcpy(hkdf->info, data, data_length);
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006268 }
6269 hkdf->info_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01006270 return PSA_SUCCESS;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006271 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006272 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006273 }
6274}
Przemek Stekiel69c46792022-06-10 12:59:51 +02006275#endif /* BUILTIN_ALG_ANY_HKDF */
Janos Follathb03233e2019-06-11 15:30:30 +01006276
John Durkop07cc04a2020-11-16 22:08:34 -08006277#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
6278 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006279static psa_status_t psa_tls12_prf_set_seed(psa_tls12_prf_key_derivation_t *prf,
6280 const uint8_t *data,
6281 size_t data_length)
Janos Follathf08e2652019-06-13 09:05:41 +01006282{
Gilles Peskine449bd832023-01-11 14:50:10 +01006283 if (prf->state != PSA_TLS12_PRF_STATE_INIT) {
6284 return PSA_ERROR_BAD_STATE;
6285 }
Janos Follathf08e2652019-06-13 09:05:41 +01006286
Gilles Peskine449bd832023-01-11 14:50:10 +01006287 if (data_length != 0) {
6288 prf->seed = mbedtls_calloc(1, data_length);
6289 if (prf->seed == NULL) {
6290 return PSA_ERROR_INSUFFICIENT_MEMORY;
6291 }
Janos Follathf08e2652019-06-13 09:05:41 +01006292
Gilles Peskine449bd832023-01-11 14:50:10 +01006293 memcpy(prf->seed, data, data_length);
Janos Follathd6dce9f2019-07-04 09:11:38 +01006294 prf->seed_length = data_length;
6295 }
Janos Follathf08e2652019-06-13 09:05:41 +01006296
Gilles Peskine43f958b2020-12-13 14:55:14 +01006297 prf->state = PSA_TLS12_PRF_STATE_SEED_SET;
Janos Follathf08e2652019-06-13 09:05:41 +01006298
Gilles Peskine449bd832023-01-11 14:50:10 +01006299 return PSA_SUCCESS;
Janos Follathf08e2652019-06-13 09:05:41 +01006300}
6301
Gilles Peskine449bd832023-01-11 14:50:10 +01006302static psa_status_t psa_tls12_prf_set_key(psa_tls12_prf_key_derivation_t *prf,
6303 const uint8_t *data,
6304 size_t data_length)
Janos Follath81550542019-06-13 14:26:34 +01006305{
Gilles Peskine449bd832023-01-11 14:50:10 +01006306 if (prf->state != PSA_TLS12_PRF_STATE_SEED_SET &&
6307 prf->state != PSA_TLS12_PRF_STATE_OTHER_KEY_SET) {
6308 return PSA_ERROR_BAD_STATE;
6309 }
Janos Follath81550542019-06-13 14:26:34 +01006310
Gilles Peskine449bd832023-01-11 14:50:10 +01006311 if (data_length != 0) {
6312 prf->secret = mbedtls_calloc(1, data_length);
6313 if (prf->secret == NULL) {
6314 return PSA_ERROR_INSUFFICIENT_MEMORY;
6315 }
Steven Cooremana6df6042021-04-29 19:32:25 +02006316
Gilles Peskine449bd832023-01-11 14:50:10 +01006317 memcpy(prf->secret, data, data_length);
Steven Cooremana6df6042021-04-29 19:32:25 +02006318 prf->secret_length = data_length;
6319 }
Janos Follath81550542019-06-13 14:26:34 +01006320
Gilles Peskine43f958b2020-12-13 14:55:14 +01006321 prf->state = PSA_TLS12_PRF_STATE_KEY_SET;
Janos Follath81550542019-06-13 14:26:34 +01006322
Gilles Peskine449bd832023-01-11 14:50:10 +01006323 return PSA_SUCCESS;
Janos Follath81550542019-06-13 14:26:34 +01006324}
6325
Gilles Peskine449bd832023-01-11 14:50:10 +01006326static psa_status_t psa_tls12_prf_set_label(psa_tls12_prf_key_derivation_t *prf,
6327 const uint8_t *data,
6328 size_t data_length)
Janos Follath63028dd2019-06-13 09:15:47 +01006329{
Gilles Peskine449bd832023-01-11 14:50:10 +01006330 if (prf->state != PSA_TLS12_PRF_STATE_KEY_SET) {
6331 return PSA_ERROR_BAD_STATE;
6332 }
Janos Follath63028dd2019-06-13 09:15:47 +01006333
Gilles Peskine449bd832023-01-11 14:50:10 +01006334 if (data_length != 0) {
6335 prf->label = mbedtls_calloc(1, data_length);
6336 if (prf->label == NULL) {
6337 return PSA_ERROR_INSUFFICIENT_MEMORY;
6338 }
Janos Follath63028dd2019-06-13 09:15:47 +01006339
Gilles Peskine449bd832023-01-11 14:50:10 +01006340 memcpy(prf->label, data, data_length);
Janos Follathd6dce9f2019-07-04 09:11:38 +01006341 prf->label_length = data_length;
6342 }
Janos Follath63028dd2019-06-13 09:15:47 +01006343
Gilles Peskine43f958b2020-12-13 14:55:14 +01006344 prf->state = PSA_TLS12_PRF_STATE_LABEL_SET;
Janos Follath63028dd2019-06-13 09:15:47 +01006345
Gilles Peskine449bd832023-01-11 14:50:10 +01006346 return PSA_SUCCESS;
Janos Follath63028dd2019-06-13 09:15:47 +01006347}
6348
Gilles Peskine449bd832023-01-11 14:50:10 +01006349static psa_status_t psa_tls12_prf_input(psa_tls12_prf_key_derivation_t *prf,
6350 psa_key_derivation_step_t step,
6351 const uint8_t *data,
6352 size_t data_length)
Janos Follathb03233e2019-06-11 15:30:30 +01006353{
Gilles Peskine449bd832023-01-11 14:50:10 +01006354 switch (step) {
Janos Follathf08e2652019-06-13 09:05:41 +01006355 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskine449bd832023-01-11 14:50:10 +01006356 return psa_tls12_prf_set_seed(prf, data, data_length);
Janos Follath81550542019-06-13 14:26:34 +01006357 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006358 return psa_tls12_prf_set_key(prf, data, data_length);
Janos Follath63028dd2019-06-13 09:15:47 +01006359 case PSA_KEY_DERIVATION_INPUT_LABEL:
Gilles Peskine449bd832023-01-11 14:50:10 +01006360 return psa_tls12_prf_set_label(prf, data, data_length);
Janos Follathb03233e2019-06-11 15:30:30 +01006361 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006362 return PSA_ERROR_INVALID_ARGUMENT;
Janos Follathb03233e2019-06-11 15:30:30 +01006363 }
6364}
John Durkop07cc04a2020-11-16 22:08:34 -08006365#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
6366 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
6367
6368#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
6369static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
6370 psa_tls12_prf_key_derivation_t *prf,
John Durkop07cc04a2020-11-16 22:08:34 -08006371 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006372 size_t data_length)
John Durkop07cc04a2020-11-16 22:08:34 -08006373{
6374 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006375 const size_t pms_len = (prf->state == PSA_TLS12_PRF_STATE_OTHER_KEY_SET ?
6376 4 + data_length + prf->other_secret_length :
6377 4 + 2 * data_length);
John Durkop07cc04a2020-11-16 22:08:34 -08006378
Gilles Peskine449bd832023-01-11 14:50:10 +01006379 if (data_length > PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE) {
6380 return PSA_ERROR_INVALID_ARGUMENT;
6381 }
John Durkop07cc04a2020-11-16 22:08:34 -08006382
Gilles Peskine449bd832023-01-11 14:50:10 +01006383 uint8_t *pms = mbedtls_calloc(1, pms_len);
6384 if (pms == NULL) {
6385 return PSA_ERROR_INSUFFICIENT_MEMORY;
6386 }
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02006387 uint8_t *cur = pms;
6388
6389 /* pure-PSK:
6390 * Quoting RFC 4279, Section 2:
John Durkop07cc04a2020-11-16 22:08:34 -08006391 *
6392 * The premaster secret is formed as follows: if the PSK is N octets
6393 * long, concatenate a uint16 with the value N, N zero octets, a second
6394 * uint16 with the value N, and the PSK itself.
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02006395 *
6396 * mixed-PSK:
6397 * In a DHE-PSK, RSA-PSK, ECDHE-PSK the premaster secret is formed as
6398 * follows: concatenate a uint16 with the length of the other secret,
6399 * the other secret itself, uint16 with the length of PSK, and the
6400 * PSK itself.
6401 * For details please check:
6402 * - RFC 4279, Section 4 for the definition of RSA-PSK,
6403 * - RFC 4279, Section 3 for the definition of DHE-PSK,
6404 * - RFC 5489 for the definition of ECDHE-PSK.
John Durkop07cc04a2020-11-16 22:08:34 -08006405 */
6406
Gilles Peskine449bd832023-01-11 14:50:10 +01006407 if (prf->state == PSA_TLS12_PRF_STATE_OTHER_KEY_SET) {
6408 *cur++ = MBEDTLS_BYTE_1(prf->other_secret_length);
6409 *cur++ = MBEDTLS_BYTE_0(prf->other_secret_length);
6410 if (prf->other_secret_length != 0) {
6411 memcpy(cur, prf->other_secret, prf->other_secret_length);
6412 mbedtls_platform_zeroize(prf->other_secret, prf->other_secret_length);
Przemek Stekiel2503f7e2022-04-12 12:08:01 +02006413 cur += prf->other_secret_length;
6414 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006415 } else {
6416 *cur++ = MBEDTLS_BYTE_1(data_length);
6417 *cur++ = MBEDTLS_BYTE_0(data_length);
6418 memset(cur, 0, data_length);
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02006419 cur += data_length;
6420 }
6421
Gilles Peskine449bd832023-01-11 14:50:10 +01006422 *cur++ = MBEDTLS_BYTE_1(data_length);
6423 *cur++ = MBEDTLS_BYTE_0(data_length);
6424 memcpy(cur, data, data_length);
John Durkop07cc04a2020-11-16 22:08:34 -08006425 cur += data_length;
6426
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00006427 status = psa_tls12_prf_set_key(prf, pms, (size_t) (cur - pms));
John Durkop07cc04a2020-11-16 22:08:34 -08006428
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01006429 mbedtls_zeroize_and_free(pms, pms_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01006430 return status;
John Durkop07cc04a2020-11-16 22:08:34 -08006431}
Janos Follath6660f0e2019-06-17 08:44:03 +01006432
Przemek Stekiele47201b2022-04-19 13:53:28 +02006433static psa_status_t psa_tls12_prf_psk_to_ms_set_other_key(
6434 psa_tls12_prf_key_derivation_t *prf,
6435 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006436 size_t data_length)
Przemek Stekiele47201b2022-04-19 13:53:28 +02006437{
Gilles Peskine449bd832023-01-11 14:50:10 +01006438 if (prf->state != PSA_TLS12_PRF_STATE_SEED_SET) {
6439 return PSA_ERROR_BAD_STATE;
Przemek Stekiele47201b2022-04-19 13:53:28 +02006440 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006441
6442 if (data_length != 0) {
6443 prf->other_secret = mbedtls_calloc(1, data_length);
6444 if (prf->other_secret == NULL) {
6445 return PSA_ERROR_INSUFFICIENT_MEMORY;
6446 }
6447
6448 memcpy(prf->other_secret, data, data_length);
6449 prf->other_secret_length = data_length;
6450 } else {
Przemek Stekiele47201b2022-04-19 13:53:28 +02006451 prf->other_secret_length = 0;
6452 }
6453
6454 prf->state = PSA_TLS12_PRF_STATE_OTHER_KEY_SET;
6455
Gilles Peskine449bd832023-01-11 14:50:10 +01006456 return PSA_SUCCESS;
Przemek Stekiele47201b2022-04-19 13:53:28 +02006457}
6458
Janos Follath6660f0e2019-06-17 08:44:03 +01006459static psa_status_t psa_tls12_prf_psk_to_ms_input(
6460 psa_tls12_prf_key_derivation_t *prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01006461 psa_key_derivation_step_t step,
6462 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006463 size_t data_length)
Janos Follath6660f0e2019-06-17 08:44:03 +01006464{
Gilles Peskine449bd832023-01-11 14:50:10 +01006465 switch (step) {
Przemek Stekiele47201b2022-04-19 13:53:28 +02006466 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006467 return psa_tls12_prf_psk_to_ms_set_key(prf,
6468 data, data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02006469 break;
6470 case PSA_KEY_DERIVATION_INPUT_OTHER_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006471 return psa_tls12_prf_psk_to_ms_set_other_key(prf,
6472 data,
6473 data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02006474 break;
6475 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006476 return psa_tls12_prf_input(prf, step, data, data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02006477 break;
Janos Follath6660f0e2019-06-17 08:44:03 +01006478
Przemek Stekiele47201b2022-04-19 13:53:28 +02006479 }
Janos Follath6660f0e2019-06-17 08:44:03 +01006480}
John Durkop07cc04a2020-11-16 22:08:34 -08006481#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006482
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006483#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
6484static psa_status_t psa_tls12_ecjpake_to_pms_input(
6485 psa_tls12_ecjpake_to_pms_t *ecjpake,
Andrzej Kurek702776f2022-09-16 06:22:44 -04006486 psa_key_derivation_step_t step,
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006487 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006488 size_t data_length)
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006489{
Gilles Peskine449bd832023-01-11 14:50:10 +01006490 if (data_length != PSA_TLS12_ECJPAKE_TO_PMS_INPUT_SIZE ||
6491 step != PSA_KEY_DERIVATION_INPUT_SECRET) {
6492 return PSA_ERROR_INVALID_ARGUMENT;
Andrzej Kurek5603efd2022-09-26 10:49:16 -04006493 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006494
6495 /* Check if the passed point is in an uncompressed form */
Gilles Peskine449bd832023-01-11 14:50:10 +01006496 if (data[0] != 0x04) {
6497 return PSA_ERROR_INVALID_ARGUMENT;
6498 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006499
6500 /* Only K.X has to be extracted - bytes 1 to 32 inclusive. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006501 memcpy(ecjpake->data, data + 1, PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE);
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006502
Gilles Peskine449bd832023-01-11 14:50:10 +01006503 return PSA_SUCCESS;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006504}
6505#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306506
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306507#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306508static psa_status_t psa_pbkdf2_set_input_cost(
6509 psa_pbkdf2_key_derivation_t *pbkdf2,
6510 psa_key_derivation_step_t step,
6511 uint64_t data)
6512{
6513 if (step != PSA_KEY_DERIVATION_INPUT_COST) {
6514 return PSA_ERROR_INVALID_ARGUMENT;
6515 }
6516
6517 if (pbkdf2->state != PSA_PBKDF2_STATE_INIT) {
6518 return PSA_ERROR_BAD_STATE;
6519 }
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05306520
Kusumit Ghoderaoe66a8ad2023-05-24 12:30:43 +05306521 if (data > PSA_VENDOR_PBKDF2_MAX_ITERATIONS) {
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05306522 return PSA_ERROR_NOT_SUPPORTED;
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306523 }
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05306524
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306525 if (data == 0) {
6526 return PSA_ERROR_INVALID_ARGUMENT;
6527 }
Kusumit Ghoderaoe66a8ad2023-05-24 12:30:43 +05306528
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306529 pbkdf2->input_cost = data;
6530 pbkdf2->state = PSA_PBKDF2_STATE_INPUT_COST_SET;
6531
6532 return PSA_SUCCESS;
6533}
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306534
6535static psa_status_t psa_pbkdf2_set_salt(psa_pbkdf2_key_derivation_t *pbkdf2,
6536 const uint8_t *data,
6537 size_t data_length)
6538{
Gilles Peskineead17662023-08-20 22:02:51 +02006539 if (pbkdf2->state == PSA_PBKDF2_STATE_INPUT_COST_SET) {
6540 pbkdf2->state = PSA_PBKDF2_STATE_SALT_SET;
6541 } else if (pbkdf2->state == PSA_PBKDF2_STATE_SALT_SET) {
6542 /* Appending to existing salt. No state change. */
6543 } else {
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306544 return PSA_ERROR_BAD_STATE;
6545 }
6546
Gilles Peskineca57d782023-07-20 19:08:06 +02006547 if (data_length == 0) {
Gilles Peskineead17662023-08-20 22:02:51 +02006548 /* Appending an empty string, nothing to do. */
6549 } else {
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306550 uint8_t *next_salt;
Kusumit Ghoderaob538bb72023-05-24 12:32:14 +05306551
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306552 next_salt = mbedtls_calloc(1, data_length + pbkdf2->salt_length);
6553 if (next_salt == NULL) {
Kusumit Ghoderaod0422f32023-05-08 15:56:19 +05306554 return PSA_ERROR_INSUFFICIENT_MEMORY;
6555 }
6556
Gilles Peskineead17662023-08-20 22:02:51 +02006557 if (pbkdf2->salt_length != 0) {
6558 memcpy(next_salt, pbkdf2->salt, pbkdf2->salt_length);
6559 }
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306560 memcpy(next_salt + pbkdf2->salt_length, data, data_length);
Kusumit Ghoderaod0422f32023-05-08 15:56:19 +05306561 pbkdf2->salt_length += data_length;
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306562 mbedtls_free(pbkdf2->salt);
6563 pbkdf2->salt = next_salt;
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306564 }
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306565 return PSA_SUCCESS;
6566}
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306567
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05306568#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306569static psa_status_t psa_pbkdf2_hmac_set_password(psa_algorithm_t hash_alg,
Kusumit Ghoderaoaac9a582023-05-24 14:19:17 +05306570 const uint8_t *input,
6571 size_t input_len,
6572 uint8_t *output,
Kusumit Ghoderao91f99f52023-05-24 22:21:48 +05306573 size_t *output_len)
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306574{
6575 psa_status_t status = PSA_SUCCESS;
6576 if (input_len > PSA_HASH_BLOCK_LENGTH(hash_alg)) {
6577 status = psa_hash_compute(hash_alg, input, input_len, output,
Kusumit Ghoderao91f99f52023-05-24 22:21:48 +05306578 PSA_HMAC_MAX_HASH_BLOCK_SIZE, output_len);
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306579 } else {
6580 memcpy(output, input, input_len);
Kusumit Ghoderao91f99f52023-05-24 22:21:48 +05306581 *output_len = PSA_HASH_BLOCK_LENGTH(hash_alg);
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306582 }
6583 return status;
6584}
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05306585#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC */
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306586
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05306587#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128)
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306588static psa_status_t psa_pbkdf2_cmac_set_password(const uint8_t *input,
6589 size_t input_len,
6590 uint8_t *output,
6591 size_t *output_len)
6592{
6593 psa_status_t status = PSA_SUCCESS;
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306594 if (input_len != PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC)) {
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306595 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Kusumit Ghoderao3fde8fe2023-06-27 10:41:43 +05306596 uint8_t zeros[16] = { 0 };
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306597 psa_set_key_type(&attributes, PSA_KEY_TYPE_AES);
6598 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(sizeof(zeros)));
6599 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306600 /* Passing PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC) as
Kusumit Ghoderao5f3345a2023-07-27 21:21:38 +05306601 * mac_size as the driver function sets mac_output_length = mac_size
6602 * on success. See https://github.com/Mbed-TLS/mbedtls/issues/7801 */
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306603 status = psa_driver_wrapper_mac_compute(&attributes,
6604 zeros, sizeof(zeros),
6605 PSA_ALG_CMAC, input, input_len,
6606 output,
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306607 PSA_MAC_LENGTH(PSA_KEY_TYPE_AES,
6608 128U,
6609 PSA_ALG_CMAC),
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306610 output_len);
6611 } else {
6612 memcpy(output, input, input_len);
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306613 *output_len = PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC);
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306614 }
6615 return status;
6616}
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05306617#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128 */
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306618
6619static psa_status_t psa_pbkdf2_set_password(psa_pbkdf2_key_derivation_t *pbkdf2,
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306620 psa_algorithm_t kdf_alg,
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306621 const uint8_t *data,
6622 size_t data_length)
6623{
Kusumit Ghoderaoaac9a582023-05-24 14:19:17 +05306624 psa_status_t status = PSA_SUCCESS;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306625 if (pbkdf2->state != PSA_PBKDF2_STATE_SALT_SET) {
6626 return PSA_ERROR_BAD_STATE;
6627 }
6628
Kusumit Ghoderaof3e696d2023-07-28 13:30:50 +05306629#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306630 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
6631 psa_algorithm_t hash_alg = PSA_ALG_PBKDF2_HMAC_GET_HASH(kdf_alg);
6632 status = psa_pbkdf2_hmac_set_password(hash_alg, data, data_length,
6633 pbkdf2->password,
6634 &pbkdf2->password_length);
Kusumit Ghoderaof3e696d2023-07-28 13:30:50 +05306635 } else
6636#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC */
6637#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128)
6638 if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306639 status = psa_pbkdf2_cmac_set_password(data, data_length,
6640 pbkdf2->password,
6641 &pbkdf2->password_length);
Kusumit Ghoderaof3e696d2023-07-28 13:30:50 +05306642 } else
6643#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128 */
6644 {
6645 return PSA_ERROR_INVALID_ARGUMENT;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306646 }
6647
6648 pbkdf2->state = PSA_PBKDF2_STATE_PASSWORD_SET;
6649
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306650 return status;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306651}
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05306652
6653static psa_status_t psa_pbkdf2_input(psa_pbkdf2_key_derivation_t *pbkdf2,
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306654 psa_algorithm_t kdf_alg,
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05306655 psa_key_derivation_step_t step,
6656 const uint8_t *data,
6657 size_t data_length)
6658{
6659 switch (step) {
6660 case PSA_KEY_DERIVATION_INPUT_SALT:
6661 return psa_pbkdf2_set_salt(pbkdf2, data, data_length);
6662 case PSA_KEY_DERIVATION_INPUT_PASSWORD:
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306663 return psa_pbkdf2_set_password(pbkdf2, kdf_alg, data, data_length);
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05306664 default:
6665 return PSA_ERROR_INVALID_ARGUMENT;
6666 }
6667}
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306668#endif /* PSA_HAVE_SOFT_PBKDF2 */
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306669
Gilles Peskineb8965192019-09-24 16:21:10 +02006670/** Check whether the given key type is acceptable for the given
6671 * input step of a key derivation.
6672 *
6673 * Secret inputs must have the type #PSA_KEY_TYPE_DERIVE.
6674 * Non-secret inputs must have the type #PSA_KEY_TYPE_RAW_DATA.
6675 * Both secret and non-secret inputs can alternatively have the type
6676 * #PSA_KEY_TYPE_NONE, which is never the type of a key object, meaning
6677 * that the input was passed as a buffer rather than via a key object.
6678 */
Gilles Peskine224b0d62019-09-23 18:13:17 +02006679static int psa_key_derivation_check_input_type(
6680 psa_key_derivation_step_t step,
Gilles Peskine449bd832023-01-11 14:50:10 +01006681 psa_key_type_t key_type)
Gilles Peskine224b0d62019-09-23 18:13:17 +02006682{
Gilles Peskine449bd832023-01-11 14:50:10 +01006683 switch (step) {
Gilles Peskine224b0d62019-09-23 18:13:17 +02006684 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006685 if (key_type == PSA_KEY_TYPE_DERIVE) {
6686 return PSA_SUCCESS;
6687 }
6688 if (key_type == PSA_KEY_TYPE_NONE) {
6689 return PSA_SUCCESS;
6690 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02006691 break;
Przemek Stekiela7695a22022-04-07 15:39:01 +02006692 case PSA_KEY_DERIVATION_INPUT_OTHER_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006693 if (key_type == PSA_KEY_TYPE_DERIVE) {
6694 return PSA_SUCCESS;
6695 }
6696 if (key_type == PSA_KEY_TYPE_NONE) {
6697 return PSA_SUCCESS;
6698 }
Przemek Stekiela7695a22022-04-07 15:39:01 +02006699 break;
Gilles Peskine224b0d62019-09-23 18:13:17 +02006700 case PSA_KEY_DERIVATION_INPUT_LABEL:
6701 case PSA_KEY_DERIVATION_INPUT_SALT:
6702 case PSA_KEY_DERIVATION_INPUT_INFO:
6703 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskine449bd832023-01-11 14:50:10 +01006704 if (key_type == PSA_KEY_TYPE_RAW_DATA) {
6705 return PSA_SUCCESS;
6706 }
6707 if (key_type == PSA_KEY_TYPE_NONE) {
6708 return PSA_SUCCESS;
6709 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02006710 break;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306711 case PSA_KEY_DERIVATION_INPUT_PASSWORD:
6712 if (key_type == PSA_KEY_TYPE_PASSWORD) {
6713 return PSA_SUCCESS;
6714 }
6715 if (key_type == PSA_KEY_TYPE_DERIVE) {
6716 return PSA_SUCCESS;
6717 }
6718 if (key_type == PSA_KEY_TYPE_NONE) {
6719 return PSA_SUCCESS;
6720 }
6721 break;
Gilles Peskine224b0d62019-09-23 18:13:17 +02006722 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006723 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine224b0d62019-09-23 18:13:17 +02006724}
6725
Janos Follathb80a94e2019-06-12 15:54:46 +01006726static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006727 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01006728 psa_key_derivation_step_t step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02006729 psa_key_type_t key_type,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01006730 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006731 size_t data_length)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006732{
Gilles Peskine46d7faf2019-09-23 19:22:55 +02006733 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006734 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
Gilles Peskine46d7faf2019-09-23 19:22:55 +02006735
Gilles Peskine449bd832023-01-11 14:50:10 +01006736 status = psa_key_derivation_check_input_type(step, key_type);
6737 if (status != PSA_SUCCESS) {
Gilles Peskine224b0d62019-09-23 18:13:17 +02006738 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006739 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02006740
Przemek Stekiel69c46792022-06-10 12:59:51 +02006741#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006742 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
6743 status = psa_hkdf_input(&operation->ctx.hkdf, kdf_alg,
6744 step, data, data_length);
6745 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02006746#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08006747#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006748 if (PSA_ALG_IS_TLS12_PRF(kdf_alg)) {
6749 status = psa_tls12_prf_input(&operation->ctx.tls12_prf,
6750 step, data, data_length);
6751 } else
John Durkop07cc04a2020-11-16 22:08:34 -08006752#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF */
6753#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006754 if (PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
6755 status = psa_tls12_prf_psk_to_ms_input(&operation->ctx.tls12_prf,
6756 step, data, data_length);
6757 } else
John Durkop07cc04a2020-11-16 22:08:34 -08006758#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006759#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006760 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006761 status = psa_tls12_ecjpake_to_pms_input(
Gilles Peskine449bd832023-01-11 14:50:10 +01006762 &operation->ctx.tls12_ecjpake_to_pms, step, data, data_length);
6763 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006764#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306765#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05306766 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306767 status = psa_pbkdf2_input(&operation->ctx.pbkdf2, kdf_alg,
6768 step, data, data_length);
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05306769 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306770#endif /* PSA_HAVE_SOFT_PBKDF2 */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006771 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006772 /* This can't happen unless the operation object was not initialized */
Steven Cooreman74afe472021-02-10 17:19:22 +01006773 (void) data;
6774 (void) data_length;
6775 (void) kdf_alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01006776 return PSA_ERROR_BAD_STATE;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006777 }
6778
Gilles Peskine224b0d62019-09-23 18:13:17 +02006779exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01006780 if (status != PSA_SUCCESS) {
6781 psa_key_derivation_abort(operation);
6782 }
6783 return status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006784}
6785
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05306786static psa_status_t psa_key_derivation_input_integer_internal(
6787 psa_key_derivation_operation_t *operation,
6788 psa_key_derivation_step_t step,
6789 uint64_t value)
6790{
6791 psa_status_t status;
6792 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
6793
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306794#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05306795 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306796 status = psa_pbkdf2_set_input_cost(
6797 &operation->ctx.pbkdf2, step, value);
6798 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306799#endif /* PSA_HAVE_SOFT_PBKDF2 */
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05306800 {
Kusumit Ghoderao3a18dee2023-04-07 16:16:27 +05306801 (void) step;
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05306802 (void) value;
6803 (void) kdf_alg;
Kusumit Ghoderaoa14ae5a2023-04-19 14:16:26 +05306804 status = PSA_ERROR_INVALID_ARGUMENT;
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05306805 }
6806
6807 if (status != PSA_SUCCESS) {
6808 psa_key_derivation_abort(operation);
6809 }
6810 return status;
6811}
6812
Janos Follath51f4a0f2019-06-14 11:35:55 +01006813psa_status_t psa_key_derivation_input_bytes(
6814 psa_key_derivation_operation_t *operation,
6815 psa_key_derivation_step_t step,
6816 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006817 size_t data_length)
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01006818{
Gilles Peskine449bd832023-01-11 14:50:10 +01006819 return psa_key_derivation_input_internal(operation, step,
6820 PSA_KEY_TYPE_NONE,
6821 data, data_length);
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01006822}
6823
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05306824psa_status_t psa_key_derivation_input_integer(
6825 psa_key_derivation_operation_t *operation,
6826 psa_key_derivation_step_t step,
6827 uint64_t value)
6828{
6829 return psa_key_derivation_input_integer_internal(operation, step, value);
6830}
6831
Janos Follath51f4a0f2019-06-14 11:35:55 +01006832psa_status_t psa_key_derivation_input_key(
6833 psa_key_derivation_operation_t *operation,
6834 psa_key_derivation_step_t step,
Gilles Peskine449bd832023-01-11 14:50:10 +01006835 mbedtls_svc_key_id_t key)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006836{
Ronald Cronf95a2b12020-10-22 15:24:49 +02006837 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01006838 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006839 psa_key_slot_t *slot;
Gilles Peskine178c9aa2019-09-24 18:21:06 +02006840
Ronald Cron5c522922020-11-14 16:35:34 +01006841 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01006842 key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg);
6843 if (status != PSA_SUCCESS) {
6844 psa_key_derivation_abort(operation);
6845 return status;
Gilles Peskine593773d2019-09-23 18:17:40 +02006846 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02006847
Kusumit Ghoderao3128c5d2023-05-03 12:27:57 +05306848 /* Passing a key object as a SECRET or PASSWORD input unlocks the
6849 * permission to output to a key object. */
6850 if (step == PSA_KEY_DERIVATION_INPUT_SECRET ||
6851 step == PSA_KEY_DERIVATION_INPUT_PASSWORD) {
Gilles Peskine178c9aa2019-09-24 18:21:06 +02006852 operation->can_output_key = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01006853 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02006854
Gilles Peskine449bd832023-01-11 14:50:10 +01006855 status = psa_key_derivation_input_internal(operation,
6856 step, slot->attr.type,
6857 slot->key.data,
6858 slot->key.bytes);
Ronald Cronf95a2b12020-10-22 15:24:49 +02006859
Ryan Everett5ac6fa72024-02-14 17:11:36 +00006860 unlock_status = psa_unregister_read_under_mutex(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02006861
Gilles Peskine449bd832023-01-11 14:50:10 +01006862 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006863}
Gilles Peskineea0fb492018-07-12 17:17:20 +02006864
6865
6866
6867/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02006868/* Key agreement */
6869/****************************************************************/
6870
Gilles Peskine449bd832023-01-11 14:50:10 +01006871psa_status_t psa_key_agreement_raw_builtin(const psa_key_attributes_t *attributes,
6872 const uint8_t *key_buffer,
6873 size_t key_buffer_size,
6874 psa_algorithm_t alg,
6875 const uint8_t *peer_key,
6876 size_t peer_key_length,
6877 uint8_t *shared_secret,
6878 size_t shared_secret_size,
6879 size_t *shared_secret_length)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02006880{
Gilles Peskine449bd832023-01-11 14:50:10 +01006881 switch (alg) {
John Durkop6ba40d12020-11-10 08:50:04 -08006882#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskine0216fe12019-04-11 21:23:21 +02006883 case PSA_ALG_ECDH:
Gilles Peskine449bd832023-01-11 14:50:10 +01006884 return mbedtls_psa_key_agreement_ecdh(attributes, key_buffer,
6885 key_buffer_size, alg,
6886 peer_key, peer_key_length,
6887 shared_secret,
6888 shared_secret_size,
6889 shared_secret_length);
Gilles Peskine01d718c2018-09-18 12:01:02 +02006890#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Przemek Stekielfb3dd542022-12-01 14:59:15 +01006891
6892#if defined(MBEDTLS_PSA_BUILTIN_ALG_FFDH)
6893 case PSA_ALG_FFDH:
Przemek Stekiel152bb462023-06-01 11:52:39 +02006894 return mbedtls_psa_ffdh_key_agreement(attributes,
Przemek Stekiel359f4622022-12-05 14:11:55 +01006895 peer_key,
6896 peer_key_length,
6897 key_buffer,
6898 key_buffer_size,
6899 shared_secret,
6900 shared_secret_size,
6901 shared_secret_length);
Przemek Stekielfb3dd542022-12-01 14:59:15 +01006902#endif /* MBEDTLS_PSA_BUILTIN_ALG_FFDH */
6903
Gilles Peskine01d718c2018-09-18 12:01:02 +02006904 default:
Aditya Deshpande17845b82022-10-13 17:21:01 +01006905 (void) attributes;
6906 (void) key_buffer;
6907 (void) key_buffer_size;
Gilles Peskine93f85002018-11-16 16:43:31 +01006908 (void) peer_key;
6909 (void) peer_key_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02006910 (void) shared_secret;
6911 (void) shared_secret_size;
6912 (void) shared_secret_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01006913 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine01d718c2018-09-18 12:01:02 +02006914 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02006915}
Gilles Peskine01d718c2018-09-18 12:01:02 +02006916
Aditya Deshpande17845b82022-10-13 17:21:01 +01006917/** Internal function for raw key agreement
6918 * Calls the driver wrapper which will hand off key agreement task
Aditya Deshpande40c05cc2022-10-14 16:41:40 +01006919 * to the driver's implementation if a driver is present.
6920 * Fallback specified in the driver wrapper is built-in raw key agreement
Aditya Deshpande17845b82022-10-13 17:21:01 +01006921 * (psa_key_agreement_raw_builtin).
6922 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006923static psa_status_t psa_key_agreement_raw_internal(psa_algorithm_t alg,
6924 psa_key_slot_t *private_key,
6925 const uint8_t *peer_key,
6926 size_t peer_key_length,
6927 uint8_t *shared_secret,
6928 size_t shared_secret_size,
6929 size_t *shared_secret_length)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006930{
Gilles Peskine449bd832023-01-11 14:50:10 +01006931 if (!PSA_ALG_IS_RAW_KEY_AGREEMENT(alg)) {
6932 return PSA_ERROR_NOT_SUPPORTED;
6933 }
Aditya Deshpande17845b82022-10-13 17:21:01 +01006934
Gilles Peskine7a5d9202024-02-28 01:18:23 +01006935 return psa_driver_wrapper_key_agreement(&private_key->attr,
Gilles Peskine449bd832023-01-11 14:50:10 +01006936 private_key->key.data,
6937 private_key->key.bytes, alg,
6938 peer_key, peer_key_length,
6939 shared_secret,
6940 shared_secret_size,
6941 shared_secret_length);
Gilles Peskine0216fe12019-04-11 21:23:21 +02006942}
6943
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02006944/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine01d718c2018-09-18 12:01:02 +02006945 * to potentially free embedded data structures and wipe confidential data.
6946 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006947static psa_status_t psa_key_agreement_internal(psa_key_derivation_operation_t *operation,
6948 psa_key_derivation_step_t step,
6949 psa_key_slot_t *private_key,
6950 const uint8_t *peer_key,
6951 size_t peer_key_length)
Gilles Peskine01d718c2018-09-18 12:01:02 +02006952{
6953 psa_status_t status;
Moritz Fischer967f8cd2024-03-02 00:55:06 +00006954 uint8_t shared_secret[PSA_RAW_KEY_AGREEMENT_OUTPUT_MAX_SIZE] = { 0 };
Gilles Peskine01d718c2018-09-18 12:01:02 +02006955 size_t shared_secret_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01006956 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE(operation->alg);
Gilles Peskine01d718c2018-09-18 12:01:02 +02006957
6958 /* Step 1: run the secret agreement algorithm to generate the shared
6959 * secret. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006960 status = psa_key_agreement_raw_internal(ka_alg,
6961 private_key,
6962 peer_key, peer_key_length,
6963 shared_secret,
6964 sizeof(shared_secret),
6965 &shared_secret_length);
6966 if (status != PSA_SUCCESS) {
Gilles Peskine12313cd2018-06-20 00:20:32 +02006967 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006968 }
Gilles Peskine12313cd2018-06-20 00:20:32 +02006969
Gilles Peskineb0b255c2018-07-06 17:01:38 +02006970 /* Step 2: set up the key derivation to generate key material from
Gilles Peskine224b0d62019-09-23 18:13:17 +02006971 * the shared secret. A shared secret is permitted wherever a key
6972 * of type DERIVE is permitted. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006973 status = psa_key_derivation_input_internal(operation, step,
6974 PSA_KEY_TYPE_DERIVE,
6975 shared_secret,
6976 shared_secret_length);
Gilles Peskine12313cd2018-06-20 00:20:32 +02006977exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01006978 mbedtls_platform_zeroize(shared_secret, shared_secret_length);
6979 return status;
Gilles Peskine12313cd2018-06-20 00:20:32 +02006980}
6981
Gilles Peskine449bd832023-01-11 14:50:10 +01006982psa_status_t psa_key_derivation_key_agreement(psa_key_derivation_operation_t *operation,
6983 psa_key_derivation_step_t step,
6984 mbedtls_svc_key_id_t private_key,
6985 const uint8_t *peer_key,
6986 size_t peer_key_length)
Gilles Peskine12313cd2018-06-20 00:20:32 +02006987{
Ronald Cronf95a2b12020-10-22 15:24:49 +02006988 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01006989 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01006990 psa_key_slot_t *slot;
Ronald Cronf95a2b12020-10-22 15:24:49 +02006991
Gilles Peskine449bd832023-01-11 14:50:10 +01006992 if (!PSA_ALG_IS_KEY_AGREEMENT(operation->alg)) {
6993 return PSA_ERROR_INVALID_ARGUMENT;
6994 }
Ronald Cron5c522922020-11-14 16:35:34 +01006995 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01006996 private_key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg);
6997 if (status != PSA_SUCCESS) {
6998 return status;
6999 }
7000 status = psa_key_agreement_internal(operation, step,
7001 slot,
7002 peer_key, peer_key_length);
7003 if (status != PSA_SUCCESS) {
7004 psa_key_derivation_abort(operation);
7005 } else {
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007006 /* If a private key has been added as SECRET, we allow the derived
7007 * key material to be used as a key in PSA Crypto. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007008 if (step == PSA_KEY_DERIVATION_INPUT_SECRET) {
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007009 operation->can_output_key = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01007010 }
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007011 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007012
Ryan Everett5ac6fa72024-02-14 17:11:36 +00007013 unlock_status = psa_unregister_read_under_mutex(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007014
Gilles Peskine449bd832023-01-11 14:50:10 +01007015 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskineaf3baab2018-06-27 22:55:52 +02007016}
7017
Gilles Peskine449bd832023-01-11 14:50:10 +01007018psa_status_t psa_raw_key_agreement(psa_algorithm_t alg,
7019 mbedtls_svc_key_id_t private_key,
7020 const uint8_t *peer_key,
7021 size_t peer_key_length,
7022 uint8_t *output,
7023 size_t output_size,
7024 size_t *output_length)
Gilles Peskine0216fe12019-04-11 21:23:21 +02007025{
Ronald Cronf95a2b12020-10-22 15:24:49 +02007026 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01007027 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +02007028 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007029 size_t expected_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02007030
Gilles Peskine449bd832023-01-11 14:50:10 +01007031 if (!PSA_ALG_IS_KEY_AGREEMENT(alg)) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007032 status = PSA_ERROR_INVALID_ARGUMENT;
7033 goto exit;
7034 }
Ronald Cron5c522922020-11-14 16:35:34 +01007035 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01007036 private_key, &slot, PSA_KEY_USAGE_DERIVE, alg);
7037 if (status != PSA_SUCCESS) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007038 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007039 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02007040
Gilles Peskine3e561302022-04-14 00:17:15 +02007041 /* PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() is in general an upper bound
7042 * for the output size. The PSA specification only guarantees that this
7043 * function works if output_size >= PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE(...),
7044 * but it might be nice to allow smaller buffers if the output fits.
7045 * At the time of writing this comment, with only ECDH implemented,
7046 * PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() is exact so the point is moot.
7047 * If FFDH is implemented, PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() can easily
7048 * be exact for it as well. */
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007049 expected_length =
Gilles Peskine449bd832023-01-11 14:50:10 +01007050 PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE(slot->attr.type, slot->attr.bits);
7051 if (output_size < expected_length) {
Gilles Peskine3e561302022-04-14 00:17:15 +02007052 status = PSA_ERROR_BUFFER_TOO_SMALL;
7053 goto exit;
7054 }
7055
Gilles Peskine449bd832023-01-11 14:50:10 +01007056 status = psa_key_agreement_raw_internal(alg, slot,
7057 peer_key, peer_key_length,
7058 output, output_size,
7059 output_length);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007060
7061exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007062 if (status != PSA_SUCCESS) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007063 /* If an error happens and is not handled properly, the output
7064 * may be used as a key to protect sensitive data. Arrange for such
7065 * a key to be random, which is likely to result in decryption or
7066 * verification errors. This is better than filling the buffer with
7067 * some constant data such as zeros, which would result in the data
7068 * being protected with a reproducible, easily knowable key.
7069 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007070 psa_generate_random(output, output_size);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007071 *output_length = output_size;
7072 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007073
Ryan Everetta103ec92024-01-31 13:59:57 +00007074 unlock_status = psa_unregister_read_under_mutex(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007075
Gilles Peskine449bd832023-01-11 14:50:10 +01007076 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine0216fe12019-04-11 21:23:21 +02007077}
Gilles Peskine86a440b2018-11-12 18:39:40 +01007078
7079
Gilles Peskine30524eb2020-11-13 17:02:26 +01007080
Gilles Peskine86a440b2018-11-12 18:39:40 +01007081/****************************************************************/
7082/* Random generation */
Gilles Peskine53d991e2018-07-12 01:14:59 +02007083/****************************************************************/
Gilles Peskine12313cd2018-06-20 00:20:32 +02007084
Gilles Peskine672a7712023-04-28 21:00:28 +02007085#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
7086#include "entropy_poll.h"
7087#endif
7088
Gilles Peskine30524eb2020-11-13 17:02:26 +01007089/** Initialize the PSA random generator.
7090 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007091static void mbedtls_psa_random_init(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01007092{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007093#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine449bd832023-01-11 14:50:10 +01007094 memset(rng, 0, sizeof(*rng));
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007095#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
7096
Gilles Peskine30524eb2020-11-13 17:02:26 +01007097 /* Set default configuration if
7098 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007099 if (rng->entropy_init == NULL) {
Gilles Peskine30524eb2020-11-13 17:02:26 +01007100 rng->entropy_init = mbedtls_entropy_init;
Gilles Peskine449bd832023-01-11 14:50:10 +01007101 }
7102 if (rng->entropy_free == NULL) {
Gilles Peskine30524eb2020-11-13 17:02:26 +01007103 rng->entropy_free = mbedtls_entropy_free;
Gilles Peskine449bd832023-01-11 14:50:10 +01007104 }
Gilles Peskine30524eb2020-11-13 17:02:26 +01007105
Gilles Peskine449bd832023-01-11 14:50:10 +01007106 rng->entropy_init(&rng->entropy);
Gilles Peskine30524eb2020-11-13 17:02:26 +01007107#if defined(MBEDTLS_PSA_INJECT_ENTROPY) && \
7108 defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
7109 /* The PSA entropy injection feature depends on using NV seed as an entropy
7110 * source. Add NV seed as an entropy source for PSA entropy injection. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007111 mbedtls_entropy_add_source(&rng->entropy,
7112 mbedtls_nv_seed_poll, NULL,
7113 MBEDTLS_ENTROPY_BLOCK_SIZE,
7114 MBEDTLS_ENTROPY_SOURCE_STRONG);
Gilles Peskine30524eb2020-11-13 17:02:26 +01007115#endif
7116
Gilles Peskine449bd832023-01-11 14:50:10 +01007117 mbedtls_psa_drbg_init(MBEDTLS_PSA_RANDOM_STATE);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007118#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007119}
7120
7121/** Deinitialize the PSA random generator.
7122 */
Valerio Setti83e0de82023-11-24 12:13:05 +01007123static void mbedtls_psa_random_free(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01007124{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007125#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Valerio Setti83e0de82023-11-24 12:13:05 +01007126 memset(rng, 0, sizeof(*rng));
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007127#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Valerio Setti83e0de82023-11-24 12:13:05 +01007128 mbedtls_psa_drbg_free(MBEDTLS_PSA_RANDOM_STATE);
7129 rng->entropy_free(&rng->entropy);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007130#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007131}
7132
7133/** Seed the PSA random generator.
7134 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007135static psa_status_t mbedtls_psa_random_seed(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01007136{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007137#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
7138 /* Do nothing: the external RNG seeds itself. */
7139 (void) rng;
Gilles Peskine449bd832023-01-11 14:50:10 +01007140 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007141#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007142 const unsigned char drbg_seed[] = "PSA";
Gilles Peskine449bd832023-01-11 14:50:10 +01007143 int ret = mbedtls_psa_drbg_seed(&rng->entropy,
7144 drbg_seed, sizeof(drbg_seed) - 1);
7145 return mbedtls_to_psa_error(ret);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007146#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007147}
7148
Gilles Peskine449bd832023-01-11 14:50:10 +01007149psa_status_t psa_generate_random(uint8_t *output,
7150 size_t output_size)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007151{
Gilles Peskinee59236f2018-01-27 23:32:46 +01007152 GUARD_MODULE_INITIALIZED;
7153
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007154#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
7155
7156 size_t output_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007157 psa_status_t status = mbedtls_psa_external_get_random(&global_data.rng,
7158 output, output_size,
7159 &output_length);
7160 if (status != PSA_SUCCESS) {
7161 return status;
7162 }
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007163 /* Breaking up a request into smaller chunks is currently not supported
Tom Cosgrove1797b052022-12-04 17:19:59 +00007164 * for the external RNG interface. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007165 if (output_length != output_size) {
7166 return PSA_ERROR_INSUFFICIENT_ENTROPY;
7167 }
7168 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007169
7170#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
7171
Gilles Peskine449bd832023-01-11 14:50:10 +01007172 while (output_size > 0) {
Gilles Peskine71ddab92021-01-04 21:01:07 +01007173 size_t request_size =
Gilles Peskine449bd832023-01-11 14:50:10 +01007174 (output_size > MBEDTLS_PSA_RANDOM_MAX_REQUEST ?
7175 MBEDTLS_PSA_RANDOM_MAX_REQUEST :
7176 output_size);
7177 int ret = mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE,
7178 output, request_size);
7179 if (ret != 0) {
7180 return mbedtls_to_psa_error(ret);
7181 }
Gilles Peskine71ddab92021-01-04 21:01:07 +01007182 output_size -= request_size;
7183 output += request_size;
Gilles Peskinef181eca2019-08-07 13:49:00 +02007184 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007185 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007186#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskinee59236f2018-01-27 23:32:46 +01007187}
7188
Gilles Peskine8814fc42020-12-14 15:33:44 +01007189/* Wrapper function allowing the classic API to use the PSA RNG.
Gilles Peskine9c3e0602021-01-05 16:03:55 +01007190 *
7191 * `mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE, ...)` calls
7192 * `psa_generate_random(...)`. The state parameter is ignored since the
7193 * PSA API doesn't support passing an explicit state.
7194 *
7195 * In the non-external case, psa_generate_random() calls an
7196 * `mbedtls_xxx_drbg_random` function which has exactly the same signature
7197 * and semantics as mbedtls_psa_get_random(). As an optimization,
7198 * instead of doing this back-and-forth between the PSA API and the
7199 * classic API, psa_crypto_random_impl.h defines `mbedtls_psa_get_random`
7200 * as a constant function pointer to `mbedtls_xxx_drbg_random`.
Gilles Peskine8814fc42020-12-14 15:33:44 +01007201 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007202#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
7203int mbedtls_psa_get_random(void *p_rng,
7204 unsigned char *output,
7205 size_t output_size)
Gilles Peskine8814fc42020-12-14 15:33:44 +01007206{
Gilles Peskine9c3e0602021-01-05 16:03:55 +01007207 /* This function takes a pointer to the RNG state because that's what
7208 * classic mbedtls functions using an RNG expect. The PSA RNG manages
7209 * its own state internally and doesn't let the caller access that state.
7210 * So we just ignore the state parameter, and in practice we'll pass
7211 * NULL. */
Gilles Peskine8814fc42020-12-14 15:33:44 +01007212 (void) p_rng;
Gilles Peskine449bd832023-01-11 14:50:10 +01007213 psa_status_t status = psa_generate_random(output, output_size);
7214 if (status == PSA_SUCCESS) {
7215 return 0;
7216 } else {
7217 return MBEDTLS_ERR_ENTROPY_SOURCE_FAILED;
7218 }
Gilles Peskine8814fc42020-12-14 15:33:44 +01007219}
7220#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
7221
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01007222#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
Gilles Peskine449bd832023-01-11 14:50:10 +01007223psa_status_t mbedtls_psa_inject_entropy(const uint8_t *seed,
7224 size_t seed_size)
Netanel Gonen2bcd3122018-11-19 11:53:02 +02007225{
Gilles Peskine449bd832023-01-11 14:50:10 +01007226 if (global_data.initialized) {
7227 return PSA_ERROR_NOT_PERMITTED;
7228 }
Netanel Gonen21f37cb2018-11-19 11:53:55 +02007229
Gilles Peskine449bd832023-01-11 14:50:10 +01007230 if (((seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM) ||
7231 (seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE)) ||
7232 (seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE)) {
7233 return PSA_ERROR_INVALID_ARGUMENT;
7234 }
Netanel Gonen21f37cb2018-11-19 11:53:55 +02007235
Gilles Peskine449bd832023-01-11 14:50:10 +01007236 return mbedtls_psa_storage_inject_entropy(seed, seed_size);
Netanel Gonen2bcd3122018-11-19 11:53:02 +02007237}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01007238#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02007239
Ronald Cron3772afe2021-02-08 16:10:05 +01007240/** Validate the key type and size for key generation
Ronald Cron01b2aba2020-10-05 09:42:02 +02007241 *
Ronald Cron3772afe2021-02-08 16:10:05 +01007242 * \param type The key type
7243 * \param bits The number of bits of the key
Ronald Cron01b2aba2020-10-05 09:42:02 +02007244 *
7245 * \retval #PSA_SUCCESS
Ronald Cron3772afe2021-02-08 16:10:05 +01007246 * The key type and size are valid.
Ronald Cron01b2aba2020-10-05 09:42:02 +02007247 * \retval #PSA_ERROR_INVALID_ARGUMENT
7248 * The size in bits of the key is not valid.
7249 * \retval #PSA_ERROR_NOT_SUPPORTED
7250 * The type and/or the size in bits of the key or the combination of
7251 * the two is not supported.
7252 */
Ronald Cron3772afe2021-02-08 16:10:05 +01007253static psa_status_t psa_validate_key_type_and_size_for_key_generation(
Gilles Peskine449bd832023-01-11 14:50:10 +01007254 psa_key_type_t type, size_t bits)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007255{
Ronald Cronf3bb7612020-10-02 20:11:59 +02007256 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007257
Gilles Peskine449bd832023-01-11 14:50:10 +01007258 if (key_type_is_raw_bytes(type)) {
7259 status = psa_validate_unstructured_key_bit_size(type, bits);
7260 if (status != PSA_SUCCESS) {
7261 return status;
7262 }
7263 } else
Valerio Settif6d4dfb2023-07-10 10:55:12 +02007264#if defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007265 if (PSA_KEY_TYPE_IS_RSA(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
7266 if (bits > PSA_VENDOR_RSA_MAX_KEY_BITS) {
7267 return PSA_ERROR_NOT_SUPPORTED;
7268 }
Waleed Elmelegyd7bdbbe2023-07-20 16:26:58 +00007269 if (bits < PSA_VENDOR_RSA_GENERATE_MIN_KEY_BITS) {
Waleed Elmelegyab570712023-07-05 16:40:58 +00007270 return PSA_ERROR_NOT_SUPPORTED;
7271 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +02007272
Ronald Cron01b2aba2020-10-05 09:42:02 +02007273 /* Accept only byte-aligned keys, for the same reasons as
7274 * in psa_import_rsa_key(). */
Gilles Peskine449bd832023-01-11 14:50:10 +01007275 if (bits % 8 != 0) {
7276 return PSA_ERROR_NOT_SUPPORTED;
7277 }
7278 } else
Valerio Settif6d4dfb2023-07-10 10:55:12 +02007279#endif /* defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02007280
Valerio Setti6a9d0ee2023-06-21 10:07:21 +02007281#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007282 if (PSA_KEY_TYPE_IS_ECC(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
Ronald Crond81ab562021-02-16 09:01:16 +01007283 /* To avoid empty block, return successfully here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007284 return PSA_SUCCESS;
7285 } else
Valerio Setti6a9d0ee2023-06-21 10:07:21 +02007286#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_GENERATE) */
Przemek Stekielfedd1342022-12-01 15:00:02 +01007287
Valerio Settia55f0422023-07-10 15:34:41 +02007288#if defined(PSA_WANT_KEY_TYPE_DH_KEY_PAIR_GENERATE)
Przemek Stekielfedd1342022-12-01 15:00:02 +01007289 if (PSA_KEY_TYPE_IS_DH(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
Przemek Stekield1cf1ba2023-04-27 12:04:21 +02007290 if (psa_is_dh_key_size_valid(bits) == 0) {
Przemek Stekielfedd1342022-12-01 15:00:02 +01007291 return PSA_ERROR_NOT_SUPPORTED;
7292 }
7293 } else
Valerio Settia55f0422023-07-10 15:34:41 +02007294#endif /* defined(PSA_WANT_KEY_TYPE_DH_KEY_PAIR_GENERATE) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02007295 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007296 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007297 }
7298
Gilles Peskine449bd832023-01-11 14:50:10 +01007299 return PSA_SUCCESS;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007300}
7301
Ronald Cron55ed0592020-10-05 10:30:40 +02007302psa_status_t psa_generate_key_internal(
Ronald Cron2a38a6b2020-10-02 20:02:04 +02007303 const psa_key_attributes_t *attributes,
Gilles Peskine092ce512024-02-20 12:31:24 +01007304 const psa_key_production_parameters_t *params, size_t params_data_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01007305 uint8_t *key_buffer, size_t key_buffer_size, size_t *key_buffer_length)
Ronald Cron01b2aba2020-10-05 09:42:02 +02007306{
7307 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f107ae2024-02-28 01:26:46 +01007308 psa_key_type_t type = attributes->type;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007309
Gilles Peskine7a18f962024-02-12 16:48:11 +01007310 /* Only used for RSA */
Gilles Peskine092ce512024-02-20 12:31:24 +01007311 (void) params;
7312 (void) params_data_length;
Gilles Peskine7a18f962024-02-12 16:48:11 +01007313
Gilles Peskine449bd832023-01-11 14:50:10 +01007314 if (key_type_is_raw_bytes(type)) {
7315 status = psa_generate_random(key_buffer, key_buffer_size);
7316 if (status != PSA_SUCCESS) {
7317 return status;
7318 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +02007319
David Brown12ca5032021-02-11 11:02:00 -07007320#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01007321 if (type == PSA_KEY_TYPE_DES) {
7322 psa_des_set_key_parity(key_buffer, key_buffer_size);
7323 }
David Brown8107e312021-02-12 08:08:46 -07007324#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine449bd832023-01-11 14:50:10 +01007325 } else
Gilles Peskinee59236f2018-01-27 23:32:46 +01007326
Valerio Setti76df8c12023-07-11 14:11:28 +02007327#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007328 if (type == PSA_KEY_TYPE_RSA_KEY_PAIR) {
Gilles Peskinee22f6a92024-02-26 15:45:33 +01007329 return mbedtls_psa_rsa_generate_key(attributes,
Gilles Peskine4c32b692024-02-16 00:11:09 +01007330 params, params_data_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01007331 key_buffer,
7332 key_buffer_size,
7333 key_buffer_length);
7334 } else
Valerio Setti76df8c12023-07-11 14:11:28 +02007335#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_GENERATE) */
Gilles Peskinee59236f2018-01-27 23:32:46 +01007336
Valerio Settibfeaf5b2023-06-20 13:27:46 +02007337#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007338 if (PSA_KEY_TYPE_IS_ECC(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
7339 return mbedtls_psa_ecp_generate_key(attributes,
7340 key_buffer,
7341 key_buffer_size,
7342 key_buffer_length);
7343 } else
Valerio Settibfeaf5b2023-06-20 13:27:46 +02007344#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_GENERATE) */
Przemek Stekielfedd1342022-12-01 15:00:02 +01007345
Valerio Settia55f0422023-07-10 15:34:41 +02007346#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_GENERATE)
Przemek Stekielfedd1342022-12-01 15:00:02 +01007347 if (PSA_KEY_TYPE_IS_DH(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
7348 return mbedtls_psa_ffdh_generate_key(attributes,
7349 key_buffer,
7350 key_buffer_size,
7351 key_buffer_length);
7352 } else
Valerio Settia55f0422023-07-10 15:34:41 +02007353#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_GENERATE) */
Steven Cooreman29149862020-08-05 15:43:42 +02007354 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007355 (void) key_buffer_length;
7356 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman29149862020-08-05 15:43:42 +02007357 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01007358
Gilles Peskine449bd832023-01-11 14:50:10 +01007359 return PSA_SUCCESS;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02007360}
Darryl Green0c6575a2018-11-07 16:05:30 +00007361
Gilles Peskinef0765fa2024-02-12 16:46:16 +01007362psa_status_t psa_generate_key_ext(const psa_key_attributes_t *attributes,
Gilles Peskine092ce512024-02-20 12:31:24 +01007363 const psa_key_production_parameters_t *params,
7364 size_t params_data_length,
Gilles Peskinef0765fa2024-02-12 16:46:16 +01007365 mbedtls_svc_key_id_t *key)
Gilles Peskineff5f0e72019-04-18 12:53:30 +02007366{
7367 psa_status_t status;
7368 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02007369 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cron2b56bc82020-10-05 10:02:26 +02007370 size_t key_buffer_size;
Gilles Peskine11792082019-08-06 18:36:36 +02007371
Ronald Cron81709fc2020-11-14 12:10:32 +01007372 *key = MBEDTLS_SVC_KEY_ID_INIT;
7373
Gilles Peskine0f84d622019-09-12 19:03:13 +02007374 /* Reject any attempt to create a zero-length key so that we don't
7375 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007376 if (psa_get_key_bits(attributes) == 0) {
7377 return PSA_ERROR_INVALID_ARGUMENT;
7378 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02007379
Przemyslaw Stekielc0fe8202021-10-07 11:08:56 +02007380 /* Reject any attempt to create a public key. */
Gilles Peskine2f107ae2024-02-28 01:26:46 +01007381 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(attributes->type)) {
Gilles Peskine449bd832023-01-11 14:50:10 +01007382 return PSA_ERROR_INVALID_ARGUMENT;
7383 }
Przemyslaw Stekielc0fe8202021-10-07 11:08:56 +02007384
Gilles Peskine7a18f962024-02-12 16:48:11 +01007385#if defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE)
Gilles Peskine2f107ae2024-02-28 01:26:46 +01007386 if (attributes->type == PSA_KEY_TYPE_RSA_KEY_PAIR) {
Gilles Peskine092ce512024-02-20 12:31:24 +01007387 if (params->flags != 0) {
Gilles Peskine7a18f962024-02-12 16:48:11 +01007388 return PSA_ERROR_INVALID_ARGUMENT;
7389 }
7390 } else
7391#endif
Gilles Peskine092ce512024-02-20 12:31:24 +01007392 if (!psa_key_production_parameters_are_default(params, params_data_length)) {
Gilles Peskinef0765fa2024-02-12 16:46:16 +01007393 return PSA_ERROR_INVALID_ARGUMENT;
7394 }
7395
Gilles Peskine449bd832023-01-11 14:50:10 +01007396 status = psa_start_key_creation(PSA_KEY_CREATION_GENERATE, attributes,
7397 &slot, &driver);
7398 if (status != PSA_SUCCESS) {
Gilles Peskine11792082019-08-06 18:36:36 +02007399 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007400 }
Gilles Peskine11792082019-08-06 18:36:36 +02007401
Ronald Cron977c2472020-10-13 08:32:21 +02007402 /* In the case of a transparent key or an opaque key stored in local
Archana449608b2021-09-08 15:36:05 +05307403 * storage ( thus not in the case of generating a key in a secure element
7404 * with storage ( MBEDTLS_PSA_CRYPTO_SE_C ) ),we have to allocate a
7405 * buffer to hold the generated key material. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007406 if (slot->key.data == NULL) {
Gilles Peskine2f107ae2024-02-28 01:26:46 +01007407 if (PSA_KEY_LIFETIME_GET_LOCATION(attributes->lifetime) ==
Gilles Peskine449bd832023-01-11 14:50:10 +01007408 PSA_KEY_LOCATION_LOCAL_STORAGE) {
Ronald Cron3772afe2021-02-08 16:10:05 +01007409 status = psa_validate_key_type_and_size_for_key_generation(
Gilles Peskine2f107ae2024-02-28 01:26:46 +01007410 attributes->type, attributes->bits);
Gilles Peskine449bd832023-01-11 14:50:10 +01007411 if (status != PSA_SUCCESS) {
Ronald Cron3772afe2021-02-08 16:10:05 +01007412 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007413 }
Ronald Cron3772afe2021-02-08 16:10:05 +01007414
7415 key_buffer_size = PSA_EXPORT_KEY_OUTPUT_SIZE(
Gilles Peskine2f107ae2024-02-28 01:26:46 +01007416 attributes->type,
7417 attributes->bits);
Gilles Peskine449bd832023-01-11 14:50:10 +01007418 } else {
Ronald Cron977c2472020-10-13 08:32:21 +02007419 status = psa_driver_wrapper_get_key_buffer_size(
Gilles Peskine449bd832023-01-11 14:50:10 +01007420 attributes, &key_buffer_size);
7421 if (status != PSA_SUCCESS) {
Ronald Cron3772afe2021-02-08 16:10:05 +01007422 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007423 }
Ronald Cron977c2472020-10-13 08:32:21 +02007424 }
Ronald Cron977c2472020-10-13 08:32:21 +02007425
Gilles Peskine449bd832023-01-11 14:50:10 +01007426 status = psa_allocate_buffer_to_slot(slot, key_buffer_size);
7427 if (status != PSA_SUCCESS) {
Ronald Cron977c2472020-10-13 08:32:21 +02007428 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007429 }
Ronald Cron977c2472020-10-13 08:32:21 +02007430 }
7431
Gilles Peskine449bd832023-01-11 14:50:10 +01007432 status = psa_driver_wrapper_generate_key(attributes,
Gilles Peskine092ce512024-02-20 12:31:24 +01007433 params, params_data_length,
Gilles Peskine7a18f962024-02-12 16:48:11 +01007434 slot->key.data, slot->key.bytes,
7435 &slot->key.bytes);
Gilles Peskine449bd832023-01-11 14:50:10 +01007436 if (status != PSA_SUCCESS) {
7437 psa_remove_key_data_from_memory(slot);
7438 }
Ronald Cron2b56bc82020-10-05 10:02:26 +02007439
Gilles Peskine11792082019-08-06 18:36:36 +02007440exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007441 if (status == PSA_SUCCESS) {
7442 status = psa_finish_key_creation(slot, driver, key);
7443 }
7444 if (status != PSA_SUCCESS) {
7445 psa_fail_key_creation(slot, driver);
7446 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007447
Gilles Peskine449bd832023-01-11 14:50:10 +01007448 return status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007449}
7450
Gilles Peskinef0765fa2024-02-12 16:46:16 +01007451psa_status_t psa_generate_key(const psa_key_attributes_t *attributes,
7452 mbedtls_svc_key_id_t *key)
7453{
7454 return psa_generate_key_ext(attributes,
Gilles Peskine092ce512024-02-20 12:31:24 +01007455 &default_production_parameters, 0,
Gilles Peskinef0765fa2024-02-12 16:46:16 +01007456 key);
7457}
7458
Gilles Peskinee59236f2018-01-27 23:32:46 +01007459/****************************************************************/
7460/* Module setup */
7461/****************************************************************/
7462
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007463#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine5e769522018-11-20 21:59:56 +01007464psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
Gilles Peskine449bd832023-01-11 14:50:10 +01007465 void (* entropy_init)(mbedtls_entropy_context *ctx),
7466 void (* entropy_free)(mbedtls_entropy_context *ctx))
Gilles Peskine5e769522018-11-20 21:59:56 +01007467{
Gilles Peskine449bd832023-01-11 14:50:10 +01007468 if (global_data.rng_state != RNG_NOT_INITIALIZED) {
7469 return PSA_ERROR_BAD_STATE;
7470 }
Gilles Peskine30524eb2020-11-13 17:02:26 +01007471 global_data.rng.entropy_init = entropy_init;
7472 global_data.rng.entropy_free = entropy_free;
Gilles Peskine449bd832023-01-11 14:50:10 +01007473 return PSA_SUCCESS;
Gilles Peskine5e769522018-11-20 21:59:56 +01007474}
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007475#endif /* !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) */
Gilles Peskine5e769522018-11-20 21:59:56 +01007476
Gilles Peskine449bd832023-01-11 14:50:10 +01007477void mbedtls_psa_crypto_free(void)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007478{
Gilles Peskine449bd832023-01-11 14:50:10 +01007479 psa_wipe_all_key_slots();
Valerio Setti83e0de82023-11-24 12:13:05 +01007480 if (global_data.rng_state != RNG_NOT_INITIALIZED) {
7481 mbedtls_psa_random_free(&global_data.rng);
7482 }
Gilles Peskinec6b69072018-11-20 21:42:52 +01007483 /* Wipe all remaining data, including configuration.
7484 * In particular, this sets all state indicator to the value
7485 * indicating "uninitialized". */
Gilles Peskine449bd832023-01-11 14:50:10 +01007486 mbedtls_platform_zeroize(&global_data, sizeof(global_data));
Ronald Cron9ba76912021-04-10 16:57:30 +02007487
7488 /* Terminate drivers */
Gilles Peskine449bd832023-01-11 14:50:10 +01007489 psa_driver_wrapper_free();
Gilles Peskinee59236f2018-01-27 23:32:46 +01007490}
7491
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007492#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
7493/** Recover a transaction that was interrupted by a power failure.
7494 *
7495 * This function is called during initialization, before psa_crypto_init()
7496 * returns. If this function returns a failure status, the initialization
7497 * fails.
7498 */
7499static psa_status_t psa_crypto_recover_transaction(
Gilles Peskine449bd832023-01-11 14:50:10 +01007500 const psa_crypto_transaction_t *transaction)
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007501{
Gilles Peskine449bd832023-01-11 14:50:10 +01007502 switch (transaction->unknown.type) {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007503 case PSA_CRYPTO_TRANSACTION_CREATE_KEY:
7504 case PSA_CRYPTO_TRANSACTION_DESTROY_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01007505 /* TODO - fall through to the failure case until this
7506 * is implemented.
7507 * https://github.com/ARMmbed/mbed-crypto/issues/218
7508 */
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007509 default:
7510 /* We found an unsupported transaction in the storage.
7511 * We don't know what state the storage is in. Give up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007512 return PSA_ERROR_DATA_INVALID;
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007513 }
7514}
7515#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
7516
Gilles Peskine449bd832023-01-11 14:50:10 +01007517psa_status_t psa_crypto_init(void)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007518{
Gilles Peskine66fb1262018-12-10 16:29:04 +01007519 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007520
Gilles Peskinec6b69072018-11-20 21:42:52 +01007521 /* Double initialization is explicitly allowed. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007522 if (global_data.initialized != 0) {
7523 return PSA_SUCCESS;
7524 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01007525
Manuel Pégourié-Gonnard7abdf7e2023-03-09 11:17:43 +01007526 /* Init drivers */
7527 status = psa_driver_wrapper_init();
7528 if (status != PSA_SUCCESS) {
7529 goto exit;
7530 }
7531 global_data.drivers_initialized = 1;
7532
Valerio Setti402cfba2023-11-13 10:24:32 +01007533 status = psa_initialize_key_slots();
7534 if (status != PSA_SUCCESS) {
7535 goto exit;
7536 }
7537
Gilles Peskine30524eb2020-11-13 17:02:26 +01007538 /* Initialize and seed the random generator. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007539 mbedtls_psa_random_init(&global_data.rng);
Gilles Peskinec6b69072018-11-20 21:42:52 +01007540 global_data.rng_state = RNG_INITIALIZED;
Gilles Peskine449bd832023-01-11 14:50:10 +01007541 status = mbedtls_psa_random_seed(&global_data.rng);
7542 if (status != PSA_SUCCESS) {
Gilles Peskinee59236f2018-01-27 23:32:46 +01007543 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007544 }
Gilles Peskinec6b69072018-11-20 21:42:52 +01007545 global_data.rng_state = RNG_SEEDED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007546
Gilles Peskine4b734222019-07-24 15:56:31 +02007547#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007548 status = psa_crypto_load_transaction();
7549 if (status == PSA_SUCCESS) {
7550 status = psa_crypto_recover_transaction(&psa_crypto_transaction);
7551 if (status != PSA_SUCCESS) {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007552 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007553 }
7554 status = psa_crypto_stop_transaction();
7555 } else if (status == PSA_ERROR_DOES_NOT_EXIST) {
Gilles Peskinefc762652019-07-22 19:30:34 +02007556 /* There's no transaction to complete. It's all good. */
7557 status = PSA_SUCCESS;
7558 }
Gilles Peskine4b734222019-07-24 15:56:31 +02007559#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
Gilles Peskinefc762652019-07-22 19:30:34 +02007560
Gilles Peskinec6b69072018-11-20 21:42:52 +01007561 /* All done. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01007562 global_data.initialized = 1;
7563
7564exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007565 if (status != PSA_SUCCESS) {
7566 mbedtls_psa_crypto_free();
7567 }
7568 return status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007569}
7570
Yanray Wangffc3c482023-07-11 12:01:04 +08007571#if defined(PSA_WANT_ALG_SOME_PAKE)
Przemek Stekielca8d2b22023-01-17 16:21:33 +01007572psa_status_t psa_crypto_driver_pake_get_password_len(
7573 const psa_crypto_driver_pake_inputs_t *inputs,
7574 size_t *password_len)
7575{
7576 if (inputs->password_len == 0) {
7577 return PSA_ERROR_BAD_STATE;
7578 }
7579
7580 *password_len = inputs->password_len;
7581
7582 return PSA_SUCCESS;
7583}
7584
7585psa_status_t psa_crypto_driver_pake_get_password(
7586 const psa_crypto_driver_pake_inputs_t *inputs,
7587 uint8_t *buffer, size_t buffer_size, size_t *buffer_length)
7588{
7589 if (inputs->password_len == 0) {
7590 return PSA_ERROR_BAD_STATE;
7591 }
7592
7593 if (buffer_size < inputs->password_len) {
7594 return PSA_ERROR_BUFFER_TOO_SMALL;
7595 }
7596
7597 memcpy(buffer, inputs->password, inputs->password_len);
7598 *buffer_length = inputs->password_len;
7599
7600 return PSA_SUCCESS;
7601}
7602
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007603psa_status_t psa_crypto_driver_pake_get_user_len(
7604 const psa_crypto_driver_pake_inputs_t *inputs,
7605 size_t *user_len)
7606{
7607 if (inputs->user_len == 0) {
7608 return PSA_ERROR_BAD_STATE;
7609 }
7610
7611 *user_len = inputs->user_len;
7612
7613 return PSA_SUCCESS;
7614}
7615
7616psa_status_t psa_crypto_driver_pake_get_user(
7617 const psa_crypto_driver_pake_inputs_t *inputs,
Przemek Stekielc0e62502023-03-14 11:49:36 +01007618 uint8_t *user_id, size_t user_id_size, size_t *user_id_len)
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007619{
7620 if (inputs->user_len == 0) {
7621 return PSA_ERROR_BAD_STATE;
7622 }
7623
Przemek Stekielc0e62502023-03-14 11:49:36 +01007624 if (user_id_size < inputs->user_len) {
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007625 return PSA_ERROR_BUFFER_TOO_SMALL;
7626 }
7627
Przemek Stekielc0e62502023-03-14 11:49:36 +01007628 memcpy(user_id, inputs->user, inputs->user_len);
7629 *user_id_len = inputs->user_len;
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007630
7631 return PSA_SUCCESS;
7632}
7633
7634psa_status_t psa_crypto_driver_pake_get_peer_len(
7635 const psa_crypto_driver_pake_inputs_t *inputs,
7636 size_t *peer_len)
7637{
7638 if (inputs->peer_len == 0) {
7639 return PSA_ERROR_BAD_STATE;
7640 }
7641
7642 *peer_len = inputs->peer_len;
7643
7644 return PSA_SUCCESS;
7645}
7646
7647psa_status_t psa_crypto_driver_pake_get_peer(
7648 const psa_crypto_driver_pake_inputs_t *inputs,
Przemek Stekielc0e62502023-03-14 11:49:36 +01007649 uint8_t *peer_id, size_t peer_id_size, size_t *peer_id_length)
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007650{
7651 if (inputs->peer_len == 0) {
7652 return PSA_ERROR_BAD_STATE;
7653 }
7654
Przemek Stekielc0e62502023-03-14 11:49:36 +01007655 if (peer_id_size < inputs->peer_len) {
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007656 return PSA_ERROR_BUFFER_TOO_SMALL;
7657 }
7658
Przemek Stekielc0e62502023-03-14 11:49:36 +01007659 memcpy(peer_id, inputs->peer, inputs->peer_len);
7660 *peer_id_length = inputs->peer_len;
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007661
7662 return PSA_SUCCESS;
7663}
7664
Przemek Stekielca8d2b22023-01-17 16:21:33 +01007665psa_status_t psa_crypto_driver_pake_get_cipher_suite(
7666 const psa_crypto_driver_pake_inputs_t *inputs,
7667 psa_pake_cipher_suite_t *cipher_suite)
7668{
7669 if (inputs->cipher_suite.algorithm == PSA_ALG_NONE) {
7670 return PSA_ERROR_BAD_STATE;
7671 }
7672
7673 *cipher_suite = inputs->cipher_suite;
7674
7675 return PSA_SUCCESS;
7676}
7677
Neil Armstronga7d08c32022-06-01 18:21:20 +02007678psa_status_t psa_pake_setup(
7679 psa_pake_operation_t *operation,
7680 const psa_pake_cipher_suite_t *cipher_suite)
7681{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007682 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007683
Przemek Stekiel1c3cfb42023-01-26 10:35:02 +01007684 if (operation->stage != PSA_PAKE_OPERATION_STAGE_SETUP) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007685 status = PSA_ERROR_BAD_STATE;
7686 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007687 }
7688
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01007689 if (PSA_ALG_IS_PAKE(cipher_suite->algorithm) == 0 ||
Przemek Stekiel51eac532022-12-07 11:04:51 +01007690 PSA_ALG_IS_HASH(cipher_suite->hash) == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007691 status = PSA_ERROR_INVALID_ARGUMENT;
7692 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007693 }
7694
Przemek Stekiel51eac532022-12-07 11:04:51 +01007695 memset(&operation->data.inputs, 0, sizeof(operation->data.inputs));
7696
Przemek Stekiele12ed362022-12-21 12:54:46 +01007697 operation->alg = cipher_suite->algorithm;
Przemek Stekiel656b2592023-03-22 13:15:33 +01007698 operation->primitive = PSA_PAKE_PRIMITIVE(cipher_suite->type,
7699 cipher_suite->family, cipher_suite->bits);
Przemek Stekiel51eac532022-12-07 11:04:51 +01007700 operation->data.inputs.cipher_suite = *cipher_suite;
7701
Przemek Stekiel4aa99402023-02-27 13:00:57 +01007702#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01007703 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01007704 psa_jpake_computation_stage_t *computation_stage =
Przemek Stekieldde6a912023-01-26 08:46:37 +01007705 &operation->computation_stage.jpake;
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01007706
David Horstmann16f01512023-06-14 17:21:07 +01007707 memset(computation_stage, 0, sizeof(*computation_stage));
David Horstmanne7f21e62023-05-12 18:17:21 +01007708 computation_stage->step = PSA_PAKE_STEP_KEY_SHARE;
Przemek Stekiel80a88492023-02-20 13:32:22 +01007709 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007710#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01007711 {
7712 status = PSA_ERROR_NOT_SUPPORTED;
7713 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01007714 }
7715
Przemek Stekiel1c3cfb42023-01-26 10:35:02 +01007716 operation->stage = PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS;
7717
Przemek Stekiel51eac532022-12-07 11:04:51 +01007718 return PSA_SUCCESS;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007719exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007720 psa_pake_abort(operation);
7721 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02007722}
7723
7724psa_status_t psa_pake_set_password_key(
7725 psa_pake_operation_t *operation,
7726 mbedtls_svc_key_id_t password)
7727{
Neil Armstrong5ae60962022-09-15 11:29:46 +02007728 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel6c764412022-11-22 14:05:12 +01007729 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
7730 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007731 psa_key_type_t type;
Neil Armstrong5ae60962022-09-15 11:29:46 +02007732
Przemek Stekiel51eac532022-12-07 11:04:51 +01007733 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007734 status = PSA_ERROR_BAD_STATE;
7735 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007736 }
7737
Przemek Stekiel6c764412022-11-22 14:05:12 +01007738 status = psa_get_and_lock_key_slot_with_policy(password, &slot,
7739 PSA_KEY_USAGE_DERIVE,
Przemek Stekield5d28a22023-01-26 10:46:05 +01007740 operation->alg);
Neil Armstrong5ae60962022-09-15 11:29:46 +02007741 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007742 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02007743 }
7744
Gilles Peskine7a5d9202024-02-28 01:18:23 +01007745 type = psa_get_key_type(&slot->attr);
Neil Armstrong5ae60962022-09-15 11:29:46 +02007746
Przemek Stekiel51eac532022-12-07 11:04:51 +01007747 if (type != PSA_KEY_TYPE_PASSWORD &&
7748 type != PSA_KEY_TYPE_PASSWORD_HASH) {
7749 status = PSA_ERROR_INVALID_ARGUMENT;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007750 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007751 }
7752
Przemek Stekiel51eac532022-12-07 11:04:51 +01007753 operation->data.inputs.password = mbedtls_calloc(1, slot->key.bytes);
7754 if (operation->data.inputs.password == NULL) {
Przemek Stekiele12ed362022-12-21 12:54:46 +01007755 status = PSA_ERROR_INSUFFICIENT_MEMORY;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007756 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007757 }
7758
7759 memcpy(operation->data.inputs.password, slot->key.data, slot->key.bytes);
7760 operation->data.inputs.password_len = slot->key.bytes;
Gilles Peskine7fad3ef2024-02-28 01:08:27 +01007761 operation->data.inputs.attributes = slot->attr;
7762
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007763exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007764 if (status != PSA_SUCCESS) {
7765 psa_pake_abort(operation);
7766 }
Ryan Everettbbedfce2024-02-14 18:22:09 +00007767 unlock_status = psa_unregister_read_under_mutex(slot);
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007768 return (status == PSA_SUCCESS) ? unlock_status : status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02007769}
7770
7771psa_status_t psa_pake_set_user(
7772 psa_pake_operation_t *operation,
7773 const uint8_t *user_id,
7774 size_t user_id_len)
7775{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007776 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007777
7778 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007779 status = PSA_ERROR_BAD_STATE;
7780 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02007781 }
7782
Przemek Stekiel51eac532022-12-07 11:04:51 +01007783 if (user_id_len == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007784 status = PSA_ERROR_INVALID_ARGUMENT;
7785 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02007786 }
7787
Przemek Stekielf309d6b2023-03-10 09:54:45 +01007788 if (operation->data.inputs.user_len != 0) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007789 status = PSA_ERROR_BAD_STATE;
7790 goto exit;
7791 }
7792
Przemek Stekielf309d6b2023-03-10 09:54:45 +01007793 operation->data.inputs.user = mbedtls_calloc(1, user_id_len);
7794 if (operation->data.inputs.user == NULL) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007795 status = PSA_ERROR_INSUFFICIENT_MEMORY;
7796 goto exit;
7797 }
7798
Przemek Stekielf309d6b2023-03-10 09:54:45 +01007799 memcpy(operation->data.inputs.user, user_id, user_id_len);
7800 operation->data.inputs.user_len = user_id_len;
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007801
7802 return PSA_SUCCESS;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007803exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007804 psa_pake_abort(operation);
7805 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02007806}
7807
7808psa_status_t psa_pake_set_peer(
7809 psa_pake_operation_t *operation,
7810 const uint8_t *peer_id,
7811 size_t peer_id_len)
7812{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007813 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007814
7815 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007816 status = PSA_ERROR_BAD_STATE;
7817 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02007818 }
7819
Przemek Stekiel51eac532022-12-07 11:04:51 +01007820 if (peer_id_len == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007821 status = PSA_ERROR_INVALID_ARGUMENT;
7822 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02007823 }
7824
Przemek Stekielf309d6b2023-03-10 09:54:45 +01007825 if (operation->data.inputs.peer_len != 0) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007826 status = PSA_ERROR_BAD_STATE;
7827 goto exit;
7828 }
7829
Przemek Stekielf309d6b2023-03-10 09:54:45 +01007830 operation->data.inputs.peer = mbedtls_calloc(1, peer_id_len);
7831 if (operation->data.inputs.peer == NULL) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007832 status = PSA_ERROR_INSUFFICIENT_MEMORY;
7833 goto exit;
7834 }
7835
Przemek Stekielf309d6b2023-03-10 09:54:45 +01007836 memcpy(operation->data.inputs.peer, peer_id, peer_id_len);
7837 operation->data.inputs.peer_len = peer_id_len;
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007838
7839 return PSA_SUCCESS;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007840exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007841 psa_pake_abort(operation);
7842 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02007843}
7844
7845psa_status_t psa_pake_set_role(
7846 psa_pake_operation_t *operation,
7847 psa_pake_role_t role)
7848{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007849 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007850
Przemek Stekiel51eac532022-12-07 11:04:51 +01007851 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007852 status = PSA_ERROR_BAD_STATE;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007853 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007854 }
7855
Przemek Stekiel09104b82023-03-06 14:11:51 +01007856 switch (operation->alg) {
7857#if defined(PSA_WANT_ALG_JPAKE)
7858 case PSA_ALG_JPAKE:
7859 if (role == PSA_PAKE_ROLE_NONE) {
7860 return PSA_SUCCESS;
7861 }
7862 status = PSA_ERROR_INVALID_ARGUMENT;
7863 break;
7864#endif
7865 default:
7866 (void) role;
7867 status = PSA_ERROR_NOT_SUPPORTED;
7868 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02007869 }
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007870exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007871 psa_pake_abort(operation);
7872 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02007873}
7874
David Horstmanne7f21e62023-05-12 18:17:21 +01007875/* Auxiliary function to convert core computation stage to single driver step. */
Przemek Stekiel4aa99402023-02-27 13:00:57 +01007876#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiel251e86a2023-02-17 14:30:50 +01007877static psa_crypto_driver_pake_step_t convert_jpake_computation_stage_to_driver_step(
Przemek Stekieldde6a912023-01-26 08:46:37 +01007878 psa_jpake_computation_stage_t *stage)
Przemek Stekielb09c4872023-01-17 12:05:38 +01007879{
David Horstmann74a3d8c2023-06-14 18:28:19 +01007880 psa_crypto_driver_pake_step_t key_share_step;
David Horstmann5da95602023-06-08 15:37:12 +01007881 if (stage->round == PSA_JPAKE_FIRST) {
David Horstmanne7f21e62023-05-12 18:17:21 +01007882 int is_x1;
David Horstmann74a3d8c2023-06-14 18:28:19 +01007883
David Horstmann024e5c52023-06-14 15:48:21 +01007884 if (stage->io_mode == PSA_JPAKE_OUTPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01007885 is_x1 = (stage->outputs < 1);
7886 } else {
7887 is_x1 = (stage->inputs < 1);
7888 }
7889
David Horstmann74a3d8c2023-06-14 18:28:19 +01007890 key_share_step = is_x1 ?
7891 PSA_JPAKE_X1_STEP_KEY_SHARE :
7892 PSA_JPAKE_X2_STEP_KEY_SHARE;
David Horstmann5da95602023-06-08 15:37:12 +01007893 } else if (stage->round == PSA_JPAKE_SECOND) {
David Horstmann74a3d8c2023-06-14 18:28:19 +01007894 key_share_step = (stage->io_mode == PSA_JPAKE_OUTPUT) ?
7895 PSA_JPAKE_X2S_STEP_KEY_SHARE :
7896 PSA_JPAKE_X4S_STEP_KEY_SHARE;
7897 } else {
7898 return PSA_JPAKE_STEP_INVALID;
Przemek Stekielb09c4872023-01-17 12:05:38 +01007899 }
Agathiyan Bragadeesh387bfa52023-07-17 17:01:33 +01007900 return (psa_crypto_driver_pake_step_t) (key_share_step + stage->step - PSA_PAKE_STEP_KEY_SHARE);
Przemek Stekielb09c4872023-01-17 12:05:38 +01007901}
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007902#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekielb09c4872023-01-17 12:05:38 +01007903
Przemek Stekiel2797d372022-12-22 11:19:22 +01007904static psa_status_t psa_pake_complete_inputs(
7905 psa_pake_operation_t *operation)
7906{
Przemek Stekiel2797d372022-12-22 11:19:22 +01007907 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel18620a32023-01-17 16:34:52 +01007908 /* Create copy of the inputs on stack as inputs share memory
7909 with the driver context which will be setup by the driver. */
7910 psa_crypto_driver_pake_inputs_t inputs = operation->data.inputs;
Przemek Stekiel2797d372022-12-22 11:19:22 +01007911
Przemek Stekielfde11282023-03-13 16:06:09 +01007912 if (inputs.password_len == 0) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01007913 return PSA_ERROR_BAD_STATE;
7914 }
7915
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007916 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekielfde11282023-03-13 16:06:09 +01007917 if (inputs.user_len == 0 || inputs.peer_len == 0) {
7918 return PSA_ERROR_BAD_STATE;
7919 }
Przemek Stekieldff21d32023-02-14 20:09:10 +01007920 }
7921
Przemek Stekiel18620a32023-01-17 16:34:52 +01007922 /* Clear driver context */
7923 mbedtls_platform_zeroize(&operation->data, sizeof(operation->data));
7924
7925 status = psa_driver_wrapper_pake_setup(operation, &inputs);
Przemek Stekiel2797d372022-12-22 11:19:22 +01007926
7927 /* Driver is responsible for creating its own copy of the password. */
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01007928 mbedtls_zeroize_and_free(inputs.password, inputs.password_len);
Przemek Stekiel2797d372022-12-22 11:19:22 +01007929
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007930 /* User and peer are translated to role. */
7931 mbedtls_free(inputs.user);
7932 mbedtls_free(inputs.peer);
7933
Przemek Stekiel2797d372022-12-22 11:19:22 +01007934 if (status == PSA_SUCCESS) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01007935#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiel2797d372022-12-22 11:19:22 +01007936 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekield93de322023-02-24 08:39:04 +01007937 operation->stage = PSA_PAKE_OPERATION_STAGE_COMPUTATION;
Przemek Stekiel80a88492023-02-20 13:32:22 +01007938 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007939#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01007940 {
7941 status = PSA_ERROR_NOT_SUPPORTED;
Przemek Stekiel2797d372022-12-22 11:19:22 +01007942 }
Przemek Stekiel2797d372022-12-22 11:19:22 +01007943 }
Przemek Stekiel2797d372022-12-22 11:19:22 +01007944 return status;
7945}
7946
Przemek Stekiel4aa99402023-02-27 13:00:57 +01007947#if defined(PSA_WANT_ALG_JPAKE)
David Horstmanne7f21e62023-05-12 18:17:21 +01007948static psa_status_t psa_jpake_prologue(
Przemek Stekiele12ed362022-12-21 12:54:46 +01007949 psa_pake_operation_t *operation,
David Horstmanne7f21e62023-05-12 18:17:21 +01007950 psa_pake_step_t step,
David Horstmann00ad6bf2023-06-14 15:44:24 +01007951 psa_jpake_io_mode_t io_mode)
Przemek Stekiele12ed362022-12-21 12:54:46 +01007952{
Przemek Stekiele12ed362022-12-21 12:54:46 +01007953 if (step != PSA_PAKE_STEP_KEY_SHARE &&
7954 step != PSA_PAKE_STEP_ZK_PUBLIC &&
7955 step != PSA_PAKE_STEP_ZK_PROOF) {
7956 return PSA_ERROR_INVALID_ARGUMENT;
7957 }
7958
Przemek Stekiel5eff1032023-02-21 19:10:36 +01007959 psa_jpake_computation_stage_t *computation_stage =
7960 &operation->computation_stage.jpake;
Przemek Stekiele12ed362022-12-21 12:54:46 +01007961
David Horstmann5da95602023-06-08 15:37:12 +01007962 if (computation_stage->round != PSA_JPAKE_FIRST &&
7963 computation_stage->round != PSA_JPAKE_SECOND) {
Przemek Stekiel5eff1032023-02-21 19:10:36 +01007964 return PSA_ERROR_BAD_STATE;
7965 }
7966
David Horstmanne7f21e62023-05-12 18:17:21 +01007967 /* Check that the step we are given is the one we were expecting */
7968 if (step != computation_stage->step) {
Przemek Stekiel5eff1032023-02-21 19:10:36 +01007969 return PSA_ERROR_BAD_STATE;
7970 }
7971
David Horstmanne7f21e62023-05-12 18:17:21 +01007972 if (step == PSA_PAKE_STEP_KEY_SHARE &&
7973 computation_stage->inputs == 0 &&
7974 computation_stage->outputs == 0) {
7975 /* Start of the round, so function decides whether we are inputting
7976 * or outputting */
David Horstmann024e5c52023-06-14 15:48:21 +01007977 computation_stage->io_mode = io_mode;
7978 } else if (computation_stage->io_mode != io_mode) {
David Horstmanne7f21e62023-05-12 18:17:21 +01007979 /* Middle of the round so the mode we are in must match the function
7980 * called by the user */
7981 return PSA_ERROR_BAD_STATE;
Przemek Stekiele12ed362022-12-21 12:54:46 +01007982 }
7983
7984 return PSA_SUCCESS;
7985}
7986
David Horstmanne7f21e62023-05-12 18:17:21 +01007987static psa_status_t psa_jpake_epilogue(
7988 psa_pake_operation_t *operation,
David Horstmann00ad6bf2023-06-14 15:44:24 +01007989 psa_jpake_io_mode_t io_mode)
Przemek Stekiele12ed362022-12-21 12:54:46 +01007990{
David Horstmanne7f21e62023-05-12 18:17:21 +01007991 psa_jpake_computation_stage_t *stage =
Przemek Stekiel5eff1032023-02-21 19:10:36 +01007992 &operation->computation_stage.jpake;
Przemek Stekiele12ed362022-12-21 12:54:46 +01007993
David Horstmanne7f21e62023-05-12 18:17:21 +01007994 if (stage->step == PSA_PAKE_STEP_ZK_PROOF) {
7995 /* End of an input/output */
David Horstmann00ad6bf2023-06-14 15:44:24 +01007996 if (io_mode == PSA_JPAKE_INPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01007997 stage->inputs++;
David Horstmann246ec5a2023-06-27 10:33:06 +01007998 if (stage->inputs == PSA_JPAKE_EXPECTED_INPUTS(stage->round)) {
David Horstmann024e5c52023-06-14 15:48:21 +01007999 stage->io_mode = PSA_JPAKE_OUTPUT;
David Horstmanne7f21e62023-05-12 18:17:21 +01008000 }
8001 }
David Horstmann00ad6bf2023-06-14 15:44:24 +01008002 if (io_mode == PSA_JPAKE_OUTPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008003 stage->outputs++;
David Horstmann246ec5a2023-06-27 10:33:06 +01008004 if (stage->outputs == PSA_JPAKE_EXPECTED_OUTPUTS(stage->round)) {
David Horstmann024e5c52023-06-14 15:48:21 +01008005 stage->io_mode = PSA_JPAKE_INPUT;
David Horstmanne7f21e62023-05-12 18:17:21 +01008006 }
8007 }
David Horstmann246ec5a2023-06-27 10:33:06 +01008008 if (stage->inputs == PSA_JPAKE_EXPECTED_INPUTS(stage->round) &&
8009 stage->outputs == PSA_JPAKE_EXPECTED_OUTPUTS(stage->round)) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008010 /* End of a round, move to the next round */
8011 stage->inputs = 0;
8012 stage->outputs = 0;
8013 stage->round++;
8014 }
8015 stage->step = PSA_PAKE_STEP_KEY_SHARE;
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008016 } else {
David Horstmanne7f21e62023-05-12 18:17:21 +01008017 stage->step++;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008018 }
Przemek Stekiele12ed362022-12-21 12:54:46 +01008019 return PSA_SUCCESS;
8020}
David Horstmanne7f21e62023-05-12 18:17:21 +01008021
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008022#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008023
Neil Armstronga7d08c32022-06-01 18:21:20 +02008024psa_status_t psa_pake_output(
8025 psa_pake_operation_t *operation,
8026 psa_pake_step_t step,
8027 uint8_t *output,
8028 size_t output_size,
8029 size_t *output_length)
8030{
Przemek Stekiel51eac532022-12-07 11:04:51 +01008031 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008032 psa_crypto_driver_pake_step_t driver_step = PSA_JPAKE_STEP_INVALID;
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008033 *output_length = 0;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008034
8035 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01008036 status = psa_pake_complete_inputs(operation);
8037 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008038 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008039 }
8040 }
8041
8042 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008043 status = PSA_ERROR_BAD_STATE;
8044 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008045 }
8046
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008047 if (output_size == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008048 status = PSA_ERROR_INVALID_ARGUMENT;
8049 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008050 }
8051
Przemek Stekiele12ed362022-12-21 12:54:46 +01008052 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008053#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008054 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008055 status = psa_jpake_prologue(operation, step, PSA_JPAKE_OUTPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008056 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008057 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008058 }
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008059 driver_step = convert_jpake_computation_stage_to_driver_step(
8060 &operation->computation_stage.jpake);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008061 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008062#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008063 default:
Przemek Stekiel80a88492023-02-20 13:32:22 +01008064 (void) step;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008065 status = PSA_ERROR_NOT_SUPPORTED;
8066 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008067 }
8068
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008069 status = psa_driver_wrapper_pake_output(operation, driver_step,
8070 output, output_size, output_length);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008071
8072 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008073 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008074 }
8075
8076 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008077#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008078 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008079 status = psa_jpake_epilogue(operation, PSA_JPAKE_OUTPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008080 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008081 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008082 }
8083 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008084#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008085 default:
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008086 status = PSA_ERROR_NOT_SUPPORTED;
8087 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008088 }
8089
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008090 return PSA_SUCCESS;
8091exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008092 psa_pake_abort(operation);
8093 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008094}
8095
8096psa_status_t psa_pake_input(
8097 psa_pake_operation_t *operation,
8098 psa_pake_step_t step,
8099 const uint8_t *input,
8100 size_t input_length)
8101{
Przemek Stekiel51eac532022-12-07 11:04:51 +01008102 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008103 psa_crypto_driver_pake_step_t driver_step = PSA_JPAKE_STEP_INVALID;
Przemek Stekiel256c75d2023-03-23 14:09:34 +01008104 const size_t max_input_length = (size_t) PSA_PAKE_INPUT_SIZE(operation->alg,
8105 operation->primitive,
8106 step);
Przemek Stekiel51eac532022-12-07 11:04:51 +01008107
8108 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01008109 status = psa_pake_complete_inputs(operation);
8110 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008111 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008112 }
8113 }
8114
8115 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008116 status = PSA_ERROR_BAD_STATE;
8117 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008118 }
8119
Przemek Stekiel256c75d2023-03-23 14:09:34 +01008120 if (input_length == 0 || input_length > max_input_length) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008121 status = PSA_ERROR_INVALID_ARGUMENT;
8122 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008123 }
8124
Przemek Stekiele12ed362022-12-21 12:54:46 +01008125 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008126#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008127 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008128 status = psa_jpake_prologue(operation, step, PSA_JPAKE_INPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008129 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008130 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008131 }
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008132 driver_step = convert_jpake_computation_stage_to_driver_step(
8133 &operation->computation_stage.jpake);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008134 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008135#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008136 default:
Przemek Stekiel80a88492023-02-20 13:32:22 +01008137 (void) step;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008138 status = PSA_ERROR_NOT_SUPPORTED;
8139 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008140 }
8141
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008142 status = psa_driver_wrapper_pake_input(operation, driver_step,
8143 input, input_length);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008144
8145 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008146 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008147 }
8148
8149 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008150#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008151 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008152 status = psa_jpake_epilogue(operation, PSA_JPAKE_INPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008153 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008154 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008155 }
8156 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008157#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008158 default:
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008159 status = PSA_ERROR_NOT_SUPPORTED;
8160 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008161 }
8162
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008163 return PSA_SUCCESS;
8164exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008165 psa_pake_abort(operation);
8166 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008167}
8168
8169psa_status_t psa_pake_get_implicit_key(
8170 psa_pake_operation_t *operation,
8171 psa_key_derivation_operation_t *output)
8172{
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008173 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008174 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel251e86a2023-02-17 14:30:50 +01008175 uint8_t shared_key[MBEDTLS_PSA_JPAKE_BUFFER_SIZE];
Przemek Stekiel0c781802022-11-29 14:53:13 +01008176 size_t shared_key_len = 0;
8177
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008178 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008179 status = PSA_ERROR_BAD_STATE;
8180 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008181 }
8182
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008183#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008184 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008185 psa_jpake_computation_stage_t *computation_stage =
Przemek Stekiel083745e2023-02-23 17:28:23 +01008186 &operation->computation_stage.jpake;
David Horstmann5da95602023-06-08 15:37:12 +01008187 if (computation_stage->round != PSA_JPAKE_FINISHED) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008188 status = PSA_ERROR_BAD_STATE;
8189 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008190 }
Przemek Stekiel80a88492023-02-20 13:32:22 +01008191 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008192#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01008193 {
8194 status = PSA_ERROR_NOT_SUPPORTED;
8195 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008196 }
8197
Przemek Stekiel0c781802022-11-29 14:53:13 +01008198 status = psa_driver_wrapper_pake_get_implicit_key(operation,
8199 shared_key,
Przemek Stekiel6b648622023-02-19 22:55:33 +01008200 sizeof(shared_key),
Przemek Stekiel0c781802022-11-29 14:53:13 +01008201 &shared_key_len);
8202
8203 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008204 goto exit;
Przemek Stekiel0c781802022-11-29 14:53:13 +01008205 }
8206
8207 status = psa_key_derivation_input_bytes(output,
8208 PSA_KEY_DERIVATION_INPUT_SECRET,
8209 shared_key,
8210 shared_key_len);
8211
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008212 mbedtls_platform_zeroize(shared_key, sizeof(shared_key));
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008213exit:
8214 abort_status = psa_pake_abort(operation);
8215 return status == PSA_SUCCESS ? abort_status : status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008216}
8217
8218psa_status_t psa_pake_abort(
8219 psa_pake_operation_t *operation)
8220{
Przemek Stekield69dca92023-01-31 19:59:20 +01008221 psa_status_t status = PSA_SUCCESS;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008222
Przemek Stekield69dca92023-01-31 19:59:20 +01008223 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008224 status = psa_driver_wrapper_pake_abort(operation);
Neil Armstrong5ae60962022-09-15 11:29:46 +02008225 }
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008226
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008227 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
8228 if (operation->data.inputs.password != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01008229 mbedtls_zeroize_and_free(operation->data.inputs.password,
Przemek Stekielaa183422023-03-06 14:21:44 +01008230 operation->data.inputs.password_len);
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008231 }
8232 if (operation->data.inputs.user != NULL) {
8233 mbedtls_free(operation->data.inputs.user);
8234 }
8235 if (operation->data.inputs.peer != NULL) {
8236 mbedtls_free(operation->data.inputs.peer);
8237 }
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008238 }
Przemek Stekield69dca92023-01-31 19:59:20 +01008239 memset(operation, 0, sizeof(psa_pake_operation_t));
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008240
Przemek Stekield69dca92023-01-31 19:59:20 +01008241 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008242}
Tom Cosgrove6d62fac2023-05-10 14:40:05 +01008243#endif /* PSA_WANT_ALG_SOME_PAKE */
Neil Armstronga7d08c32022-06-01 18:21:20 +02008244
Gilles Peskinee59236f2018-01-27 23:32:46 +01008245#endif /* MBEDTLS_PSA_CRYPTO_C */