blob: 917375778073889d0cf2f0c6bec84d0d6cabd4bd [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"
Manuel Pégourié-Gonnard02b10d82023-03-28 12:33:20 +020073#include "md_psa.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010074
Przemek Stekiel75fe3fb2022-06-09 14:44:55 +020075#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF) || \
76 defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT) || \
77 defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Przemek Stekiel69c46792022-06-10 12:59:51 +020078#define BUILTIN_ALG_ANY_HKDF 1
Przemek Stekiel75fe3fb2022-06-09 14:44:55 +020079#endif
80
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010081/****************************************************************/
82/* Global data, support functions and library management */
83/****************************************************************/
84
Gilles Peskine449bd832023-01-11 14:50:10 +010085static int key_type_is_raw_bytes(psa_key_type_t type)
Gilles Peskine48c0ea12018-06-21 14:15:31 +020086{
Gilles Peskine449bd832023-01-11 14:50:10 +010087 return PSA_KEY_TYPE_IS_UNSTRUCTURED(type);
Gilles Peskine48c0ea12018-06-21 14:15:31 +020088}
89
Gilles Peskine5a3c50e2018-12-04 12:27:09 +010090/* Values for psa_global_data_t::rng_state */
91#define RNG_NOT_INITIALIZED 0
92#define RNG_INITIALIZED 1
93#define RNG_SEEDED 2
Gilles Peskinec6b69072018-11-20 21:42:52 +010094
Gilles Peskine449bd832023-01-11 14:50:10 +010095typedef struct {
Dave Rodgman864f5942023-08-16 18:04:44 +010096 uint8_t initialized;
97 uint8_t rng_state;
98 uint8_t drivers_initialized;
Gilles Peskine2d8a1822021-11-08 22:20:03 +010099 mbedtls_psa_random_context_t rng;
Gilles Peskinee59236f2018-01-27 23:32:46 +0100100} psa_global_data_t;
101
102static psa_global_data_t global_data;
103
Gilles Peskine5894e8e2020-12-14 14:54:06 +0100104#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
105mbedtls_psa_drbg_context_t *const mbedtls_psa_random_state =
106 &global_data.rng.drbg;
107#endif
108
itayzafrir0adf0fc2018-09-06 16:24:41 +0300109#define GUARD_MODULE_INITIALIZED \
Gilles Peskine449bd832023-01-11 14:50:10 +0100110 if (global_data.initialized == 0) \
111 return PSA_ERROR_BAD_STATE;
itayzafrir0adf0fc2018-09-06 16:24:41 +0300112
Manuel Pégourié-Gonnard7abdf7e2023-03-09 11:17:43 +0100113int psa_can_do_hash(psa_algorithm_t hash_alg)
114{
115 (void) hash_alg;
116 return global_data.drivers_initialized;
117}
Valerio Settic6f004f2023-12-12 11:27:36 +0100118
Valerio Setti1fff4f22023-12-28 14:19:34 +0100119int psa_can_do_cipher(psa_key_type_t key_type, psa_algorithm_t cipher_alg)
Valerio Settic6f004f2023-12-12 11:27:36 +0100120{
Valerio Setti1fff4f22023-12-28 14:19:34 +0100121 (void) key_type;
Valerio Settic6f004f2023-12-12 11:27:36 +0100122 (void) cipher_alg;
123 return global_data.drivers_initialized;
124}
125
126
Valerio Settia55f0422023-07-10 15:34:41 +0200127#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_IMPORT) || \
Przemek Stekiel53410502023-04-28 13:18:43 +0200128 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY) || \
Valerio Settia55f0422023-07-10 15:34:41 +0200129 defined(PSA_WANT_KEY_TYPE_DH_KEY_PAIR_GENERATE)
Przemek Stekiel134cc2e2023-05-05 10:13:37 +0200130static int psa_is_dh_key_size_valid(size_t bits)
131{
Valerio Setti504a1022024-01-17 15:19:30 +0100132 switch (bits) {
133#if defined(PSA_WANT_DH_RFC7919_2048)
134 case 2048:
135 return 1;
136#endif /* PSA_WANT_DH_RFC7919_2048 */
137#if defined(PSA_WANT_DH_RFC7919_3072)
138 case 3072:
139 return 1;
140#endif /* PSA_WANT_DH_RFC7919_3072 */
141#if defined(PSA_WANT_DH_RFC7919_4096)
142 case 4096:
143 return 1;
144#endif /* PSA_WANT_DH_RFC7919_4096 */
145#if defined(PSA_WANT_DH_RFC7919_6144)
146 case 6144:
147 return 1;
148#endif /* PSA_WANT_DH_RFC7919_6144 */
149#if defined(PSA_WANT_DH_RFC7919_8192)
150 case 8192:
151 return 1;
152#endif /* PSA_WANT_DH_RFC7919_8192 */
153 default:
154 return 0;
Przemek Stekield1cf1ba2023-04-27 12:04:21 +0200155 }
Przemek Stekield1cf1ba2023-04-27 12:04:21 +0200156}
Valerio Settia55f0422023-07-10 15:34:41 +0200157#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_IMPORT ||
Przemek Stekiel53410502023-04-28 13:18:43 +0200158 MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY ||
Valerio Settia55f0422023-07-10 15:34:41 +0200159 PSA_WANT_KEY_TYPE_DH_KEY_PAIR_GENERATE */
Manuel Pégourié-Gonnard7abdf7e2023-03-09 11:17:43 +0100160
Gilles Peskine449bd832023-01-11 14:50:10 +0100161psa_status_t mbedtls_to_psa_error(int ret)
Gilles Peskinee59236f2018-01-27 23:32:46 +0100162{
Gilles Peskinedbf68962021-01-06 20:04:23 +0100163 /* Mbed TLS error codes can combine a high-level error code and a
164 * low-level error code. The low-level error usually reflects the
165 * root cause better, so dispatch on that preferably. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100166 int low_level_ret = -(-ret & 0x007f);
167 switch (low_level_ret != 0 ? low_level_ret : ret) {
Gilles Peskinee59236f2018-01-27 23:32:46 +0100168 case 0:
Gilles Peskine449bd832023-01-11 14:50:10 +0100169 return PSA_SUCCESS;
Gilles Peskinea5905292018-02-07 20:59:33 +0100170
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100171#if defined(MBEDTLS_AES_C)
Gilles Peskinea5905292018-02-07 20:59:33 +0100172 case MBEDTLS_ERR_AES_INVALID_KEY_LENGTH:
173 case MBEDTLS_ERR_AES_INVALID_INPUT_LENGTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100174 return PSA_ERROR_NOT_SUPPORTED;
Dave Rodgman09a9e582023-08-31 11:05:22 +0100175 case MBEDTLS_ERR_AES_BAD_INPUT_DATA:
176 return PSA_ERROR_INVALID_ARGUMENT;
Dave Rodgman509b5672023-08-16 19:26:23 +0100177#endif
178
179#if defined(MBEDTLS_ASN1_PARSE_C) || defined(MBEDTLS_ASN1_WRITE_C)
Gilles Peskine9a944802018-06-21 09:35:35 +0200180 case MBEDTLS_ERR_ASN1_OUT_OF_DATA:
181 case MBEDTLS_ERR_ASN1_UNEXPECTED_TAG:
182 case MBEDTLS_ERR_ASN1_INVALID_LENGTH:
183 case MBEDTLS_ERR_ASN1_LENGTH_MISMATCH:
184 case MBEDTLS_ERR_ASN1_INVALID_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100185 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine9a944802018-06-21 09:35:35 +0200186 case MBEDTLS_ERR_ASN1_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100187 return PSA_ERROR_INSUFFICIENT_MEMORY;
Gilles Peskine9a944802018-06-21 09:35:35 +0200188 case MBEDTLS_ERR_ASN1_BUF_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +0100189 return PSA_ERROR_BUFFER_TOO_SMALL;
Dave Rodgman509b5672023-08-16 19:26:23 +0100190#endif
Gilles Peskine9a944802018-06-21 09:35:35 +0200191
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100192#if defined(MBEDTLS_CAMELLIA_C)
Jaeden Amero892cd6d2019-02-11 12:21:12 +0000193 case MBEDTLS_ERR_CAMELLIA_BAD_INPUT_DATA:
Gilles Peskinea5905292018-02-07 20:59:33 +0100194 case MBEDTLS_ERR_CAMELLIA_INVALID_INPUT_LENGTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100195 return PSA_ERROR_NOT_SUPPORTED;
Dave Rodgman509b5672023-08-16 19:26:23 +0100196#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100197
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100198#if defined(MBEDTLS_CCM_C)
Gilles Peskinea5905292018-02-07 20:59:33 +0100199 case MBEDTLS_ERR_CCM_BAD_INPUT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100200 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100201 case MBEDTLS_ERR_CCM_AUTH_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100202 return PSA_ERROR_INVALID_SIGNATURE;
Dave Rodgman509b5672023-08-16 19:26:23 +0100203#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100204
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100205#if defined(MBEDTLS_CHACHA20_C)
Gilles Peskine26869f22019-05-06 15:25:00 +0200206 case MBEDTLS_ERR_CHACHA20_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100207 return PSA_ERROR_INVALID_ARGUMENT;
Dave Rodgman509b5672023-08-16 19:26:23 +0100208#endif
Gilles Peskine26869f22019-05-06 15:25:00 +0200209
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100210#if defined(MBEDTLS_CHACHAPOLY_C)
Gilles Peskine26869f22019-05-06 15:25:00 +0200211 case MBEDTLS_ERR_CHACHAPOLY_BAD_STATE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100212 return PSA_ERROR_BAD_STATE;
Gilles Peskine26869f22019-05-06 15:25:00 +0200213 case MBEDTLS_ERR_CHACHAPOLY_AUTH_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100214 return PSA_ERROR_INVALID_SIGNATURE;
Dave Rodgman509b5672023-08-16 19:26:23 +0100215#endif
Gilles Peskine26869f22019-05-06 15:25:00 +0200216
Dave Rodgman509b5672023-08-16 19:26:23 +0100217#if defined(MBEDTLS_CIPHER_C)
Gilles Peskinea5905292018-02-07 20:59:33 +0100218 case MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100219 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea5905292018-02-07 20:59:33 +0100220 case MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100221 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100222 case MBEDTLS_ERR_CIPHER_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100223 return PSA_ERROR_INSUFFICIENT_MEMORY;
Gilles Peskinea5905292018-02-07 20:59:33 +0100224 case MBEDTLS_ERR_CIPHER_INVALID_PADDING:
Gilles Peskine449bd832023-01-11 14:50:10 +0100225 return PSA_ERROR_INVALID_PADDING;
Gilles Peskinea5905292018-02-07 20:59:33 +0100226 case MBEDTLS_ERR_CIPHER_FULL_BLOCK_EXPECTED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100227 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100228 case MBEDTLS_ERR_CIPHER_AUTH_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100229 return PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskinea5905292018-02-07 20:59:33 +0100230 case MBEDTLS_ERR_CIPHER_INVALID_CONTEXT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100231 return PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman509b5672023-08-16 19:26:23 +0100232#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100233
Gilles Peskine449bd832023-01-11 14:50:10 +0100234#if !(defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) || \
235 defined(MBEDTLS_PSA_HMAC_DRBG_MD_TYPE))
Gilles Peskinebee96c82020-11-23 21:00:09 +0100236 /* Only check CTR_DRBG error codes if underlying mbedtls_xxx
237 * functions are passed a CTR_DRBG instance. */
Gilles Peskinea5905292018-02-07 20:59:33 +0100238 case MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100239 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskinea5905292018-02-07 20:59:33 +0100240 case MBEDTLS_ERR_CTR_DRBG_REQUEST_TOO_BIG:
241 case MBEDTLS_ERR_CTR_DRBG_INPUT_TOO_BIG:
Gilles Peskine449bd832023-01-11 14:50:10 +0100242 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea5905292018-02-07 20:59:33 +0100243 case MBEDTLS_ERR_CTR_DRBG_FILE_IO_ERROR:
Gilles Peskine449bd832023-01-11 14:50:10 +0100244 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskine82e57d12020-11-13 21:31:17 +0100245#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100246
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100247#if defined(MBEDTLS_DES_C)
Gilles Peskinea5905292018-02-07 20:59:33 +0100248 case MBEDTLS_ERR_DES_INVALID_INPUT_LENGTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100249 return PSA_ERROR_NOT_SUPPORTED;
Dave Rodgman509b5672023-08-16 19:26:23 +0100250#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100251
Gilles Peskinee59236f2018-01-27 23:32:46 +0100252 case MBEDTLS_ERR_ENTROPY_NO_SOURCES_DEFINED:
253 case MBEDTLS_ERR_ENTROPY_NO_STRONG_SOURCE:
254 case MBEDTLS_ERR_ENTROPY_SOURCE_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100255 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskinea5905292018-02-07 20:59:33 +0100256
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100257#if defined(MBEDTLS_GCM_C)
Gilles Peskinea5905292018-02-07 20:59:33 +0100258 case MBEDTLS_ERR_GCM_AUTH_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100259 return PSA_ERROR_INVALID_SIGNATURE;
Mateusz Starzykf28261f2021-09-30 16:39:07 +0200260 case MBEDTLS_ERR_GCM_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +0100261 return PSA_ERROR_BUFFER_TOO_SMALL;
Gilles Peskinea5905292018-02-07 20:59:33 +0100262 case MBEDTLS_ERR_GCM_BAD_INPUT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100263 return PSA_ERROR_INVALID_ARGUMENT;
Dave Rodgman509b5672023-08-16 19:26:23 +0100264#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100265
Gilles Peskine82e57d12020-11-13 21:31:17 +0100266#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) && \
Gilles Peskine449bd832023-01-11 14:50:10 +0100267 defined(MBEDTLS_PSA_HMAC_DRBG_MD_TYPE)
Gilles Peskinebee96c82020-11-23 21:00:09 +0100268 /* Only check HMAC_DRBG error codes if underlying mbedtls_xxx
269 * functions are passed a HMAC_DRBG instance. */
Gilles Peskine82e57d12020-11-13 21:31:17 +0100270 case MBEDTLS_ERR_HMAC_DRBG_ENTROPY_SOURCE_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100271 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskine82e57d12020-11-13 21:31:17 +0100272 case MBEDTLS_ERR_HMAC_DRBG_REQUEST_TOO_BIG:
273 case MBEDTLS_ERR_HMAC_DRBG_INPUT_TOO_BIG:
Gilles Peskine449bd832023-01-11 14:50:10 +0100274 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine82e57d12020-11-13 21:31:17 +0100275 case MBEDTLS_ERR_HMAC_DRBG_FILE_IO_ERROR:
Gilles Peskine449bd832023-01-11 14:50:10 +0100276 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskine82e57d12020-11-13 21:31:17 +0100277#endif
278
Dave Rodgmandea266f2023-08-31 11:52:43 +0100279#if defined(MBEDTLS_MD_LIGHT)
Gilles Peskinea5905292018-02-07 20:59:33 +0100280 case MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100281 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea5905292018-02-07 20:59:33 +0100282 case MBEDTLS_ERR_MD_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100283 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100284 case MBEDTLS_ERR_MD_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100285 return PSA_ERROR_INSUFFICIENT_MEMORY;
Dave Rodgman509b5672023-08-16 19:26:23 +0100286#if defined(MBEDTLS_FS_IO)
Gilles Peskinea5905292018-02-07 20:59:33 +0100287 case MBEDTLS_ERR_MD_FILE_IO_ERROR:
Gilles Peskine449bd832023-01-11 14:50:10 +0100288 return PSA_ERROR_STORAGE_FAILURE;
Dave Rodgman509b5672023-08-16 19:26:23 +0100289#endif
290#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100291
Dave Rodgman509b5672023-08-16 19:26:23 +0100292#if defined(MBEDTLS_BIGNUM_C)
293#if defined(MBEDTLS_FS_IO)
Gilles Peskinef76aa772018-10-29 19:24:33 +0100294 case MBEDTLS_ERR_MPI_FILE_IO_ERROR:
Gilles Peskine449bd832023-01-11 14:50:10 +0100295 return PSA_ERROR_STORAGE_FAILURE;
Dave Rodgman509b5672023-08-16 19:26:23 +0100296#endif
Gilles Peskinef76aa772018-10-29 19:24:33 +0100297 case MBEDTLS_ERR_MPI_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100298 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100299 case MBEDTLS_ERR_MPI_INVALID_CHARACTER:
Gilles Peskine449bd832023-01-11 14:50:10 +0100300 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100301 case MBEDTLS_ERR_MPI_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +0100302 return PSA_ERROR_BUFFER_TOO_SMALL;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100303 case MBEDTLS_ERR_MPI_NEGATIVE_VALUE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100304 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100305 case MBEDTLS_ERR_MPI_DIVISION_BY_ZERO:
Gilles Peskine449bd832023-01-11 14:50:10 +0100306 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100307 case MBEDTLS_ERR_MPI_NOT_ACCEPTABLE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100308 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100309 case MBEDTLS_ERR_MPI_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100310 return PSA_ERROR_INSUFFICIENT_MEMORY;
Dave Rodgman509b5672023-08-16 19:26:23 +0100311#endif
Gilles Peskinef76aa772018-10-29 19:24:33 +0100312
Dave Rodgman509b5672023-08-16 19:26:23 +0100313#if defined(MBEDTLS_PK_C)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100314 case MBEDTLS_ERR_PK_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100315 return PSA_ERROR_INSUFFICIENT_MEMORY;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100316 case MBEDTLS_ERR_PK_TYPE_MISMATCH:
317 case MBEDTLS_ERR_PK_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100318 return PSA_ERROR_INVALID_ARGUMENT;
Dave Rodgman509b5672023-08-16 19:26:23 +0100319#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) || defined(MBEDTLS_FS_IO) || \
320 defined(MBEDTLS_PSA_ITS_FILE_C)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100321 case MBEDTLS_ERR_PK_FILE_IO_ERROR:
Gilles Peskine449bd832023-01-11 14:50:10 +0100322 return PSA_ERROR_STORAGE_FAILURE;
Dave Rodgman509b5672023-08-16 19:26:23 +0100323#endif
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100324 case MBEDTLS_ERR_PK_KEY_INVALID_VERSION:
325 case MBEDTLS_ERR_PK_KEY_INVALID_FORMAT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100326 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100327 case MBEDTLS_ERR_PK_UNKNOWN_PK_ALG:
Gilles Peskine449bd832023-01-11 14:50:10 +0100328 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100329 case MBEDTLS_ERR_PK_PASSWORD_REQUIRED:
330 case MBEDTLS_ERR_PK_PASSWORD_MISMATCH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100331 return PSA_ERROR_NOT_PERMITTED;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100332 case MBEDTLS_ERR_PK_INVALID_PUBKEY:
Gilles Peskine449bd832023-01-11 14:50:10 +0100333 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100334 case MBEDTLS_ERR_PK_INVALID_ALG:
335 case MBEDTLS_ERR_PK_UNKNOWN_NAMED_CURVE:
336 case MBEDTLS_ERR_PK_FEATURE_UNAVAILABLE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100337 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100338 case MBEDTLS_ERR_PK_SIG_LEN_MISMATCH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100339 return PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskinef9f1bdf2021-06-23 20:32:27 +0200340 case MBEDTLS_ERR_PK_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +0100341 return PSA_ERROR_BUFFER_TOO_SMALL;
Dave Rodgman509b5672023-08-16 19:26:23 +0100342#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100343
Gilles Peskineff2d2002019-05-06 15:26:23 +0200344 case MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100345 return PSA_ERROR_HARDWARE_FAILURE;
Gilles Peskineff2d2002019-05-06 15:26:23 +0200346 case MBEDTLS_ERR_PLATFORM_FEATURE_UNSUPPORTED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100347 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskineff2d2002019-05-06 15:26:23 +0200348
Dave Rodgman509b5672023-08-16 19:26:23 +0100349#if defined(MBEDTLS_RSA_C)
Gilles Peskinea5905292018-02-07 20:59:33 +0100350 case MBEDTLS_ERR_RSA_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100351 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100352 case MBEDTLS_ERR_RSA_INVALID_PADDING:
Gilles Peskine449bd832023-01-11 14:50:10 +0100353 return PSA_ERROR_INVALID_PADDING;
Gilles Peskinea5905292018-02-07 20:59:33 +0100354 case MBEDTLS_ERR_RSA_KEY_GEN_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100355 return PSA_ERROR_HARDWARE_FAILURE;
Gilles Peskinea5905292018-02-07 20:59:33 +0100356 case MBEDTLS_ERR_RSA_KEY_CHECK_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100357 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100358 case MBEDTLS_ERR_RSA_PUBLIC_FAILED:
359 case MBEDTLS_ERR_RSA_PRIVATE_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100360 return PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinea5905292018-02-07 20:59:33 +0100361 case MBEDTLS_ERR_RSA_VERIFY_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100362 return PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskinea5905292018-02-07 20:59:33 +0100363 case MBEDTLS_ERR_RSA_OUTPUT_TOO_LARGE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100364 return PSA_ERROR_BUFFER_TOO_SMALL;
Gilles Peskinea5905292018-02-07 20:59:33 +0100365 case MBEDTLS_ERR_RSA_RNG_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100366 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Dave Rodgman509b5672023-08-16 19:26:23 +0100367#endif
Manuel Pégourié-Gonnard93c08472021-04-15 12:23:55 +0200368
Dave Rodgman1dab4452023-09-01 09:59:51 +0100369#if defined(MBEDTLS_ECP_LIGHT)
itayzafrir5c753392018-05-08 11:18:38 +0300370 case MBEDTLS_ERR_ECP_BAD_INPUT_DATA:
itayzafrir7b30f8b2018-05-09 16:07:36 +0300371 case MBEDTLS_ERR_ECP_INVALID_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +0100372 return PSA_ERROR_INVALID_ARGUMENT;
itayzafrir7b30f8b2018-05-09 16:07:36 +0300373 case MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +0100374 return PSA_ERROR_BUFFER_TOO_SMALL;
itayzafrir7b30f8b2018-05-09 16:07:36 +0300375 case MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100376 return PSA_ERROR_NOT_SUPPORTED;
itayzafrir7b30f8b2018-05-09 16:07:36 +0300377 case MBEDTLS_ERR_ECP_SIG_LEN_MISMATCH:
378 case MBEDTLS_ERR_ECP_VERIFY_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100379 return PSA_ERROR_INVALID_SIGNATURE;
itayzafrir7b30f8b2018-05-09 16:07:36 +0300380 case MBEDTLS_ERR_ECP_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100381 return PSA_ERROR_INSUFFICIENT_MEMORY;
Gilles Peskine40d81602020-11-25 00:09:47 +0100382 case MBEDTLS_ERR_ECP_RANDOM_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100383 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskine40d81602020-11-25 00:09:47 +0100384
Dave Rodgman509b5672023-08-16 19:26:23 +0100385#if defined(MBEDTLS_ECP_RESTARTABLE)
Paul Elliott588f8ed2022-12-02 18:10:26 +0000386 case MBEDTLS_ERR_ECP_IN_PROGRESS:
387 return PSA_OPERATION_INCOMPLETE;
Dave Rodgman509b5672023-08-16 19:26:23 +0100388#endif
389#endif
Paul Elliott588f8ed2022-12-02 18:10:26 +0000390
Janos Follatha13b9052019-11-22 12:48:59 +0000391 case MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100392 return PSA_ERROR_CORRUPTION_DETECTED;
itayzafrir5c753392018-05-08 11:18:38 +0300393
Gilles Peskinee59236f2018-01-27 23:32:46 +0100394 default:
Gilles Peskine449bd832023-01-11 14:50:10 +0100395 return PSA_ERROR_GENERIC_ERROR;
Gilles Peskinee59236f2018-01-27 23:32:46 +0100396 }
397}
398
Paul Elliottdc42ca82023-02-24 18:11:59 +0000399/**
400 * \brief For output buffers which contain "tags"
401 * (outputs that may be checked for validity like
402 * hashes, MACs and signatures), fill the unused
403 * part of the output buffer (the whole buffer on
404 * error, the trailing part on success) with
405 * something that isn't a valid tag (barring an
406 * attack on the tag and deliberately-crafted
407 * input), in case the caller doesn't check the
408 * return status properly.
409 *
410 * \param output_buffer Pointer to buffer to wipe. May not be NULL
411 * unless \p output_buffer_size is zero.
412 * \param status Status of function called to generate
413 * output_buffer originally
414 * \param output_buffer_size Size of output buffer. If zero, \p output_buffer
415 * could be NULL.
416 * \param output_buffer_length Length of data written to output_buffer, must be
417 * less than \p output_buffer_size
418 */
419static void psa_wipe_tag_output_buffer(uint8_t *output_buffer, psa_status_t status,
Paul Elliott7118d172023-02-26 16:57:05 +0000420 size_t output_buffer_size, size_t output_buffer_length)
421{
Paul Elliottdc42ca82023-02-24 18:11:59 +0000422 size_t offset = 0;
423
424 if (output_buffer_size == 0) {
425 /* If output_buffer_size is 0 then we have nothing to do. We must not
426 call memset because output_buffer may be NULL in this case */
427 return;
428 }
429
430 if (status == PSA_SUCCESS) {
431 offset = output_buffer_length;
432 }
433
434 memset(output_buffer + offset, '!', output_buffer_size - offset);
435}
436
Gilles Peskineb0b255c2018-07-06 17:01:38 +0200437
Gilles Peskine449bd832023-01-11 14:50:10 +0100438psa_status_t psa_validate_unstructured_key_bit_size(psa_key_type_t type,
439 size_t bits)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200440{
441 /* Check that the bit size is acceptable for the key type */
Gilles Peskine449bd832023-01-11 14:50:10 +0100442 switch (type) {
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200443 case PSA_KEY_TYPE_RAW_DATA:
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200444 case PSA_KEY_TYPE_HMAC:
Gilles Peskineea0fb492018-07-12 17:17:20 +0200445 case PSA_KEY_TYPE_DERIVE:
Neil Armstrong4b5710f2022-05-25 11:30:27 +0200446 case PSA_KEY_TYPE_PASSWORD:
447 case PSA_KEY_TYPE_PASSWORD_HASH:
Gilles Peskineea0fb492018-07-12 17:17:20 +0200448 break;
Ronald Cron1f0db802021-03-12 09:59:30 +0100449#if defined(PSA_WANT_KEY_TYPE_AES)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200450 case PSA_KEY_TYPE_AES:
Gilles Peskine449bd832023-01-11 14:50:10 +0100451 if (bits != 128 && bits != 192 && bits != 256) {
452 return PSA_ERROR_INVALID_ARGUMENT;
453 }
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200454 break;
455#endif
Gilles Peskine6c12a1e2021-09-21 11:59:39 +0200456#if defined(PSA_WANT_KEY_TYPE_ARIA)
457 case PSA_KEY_TYPE_ARIA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100458 if (bits != 128 && bits != 192 && bits != 256) {
459 return PSA_ERROR_INVALID_ARGUMENT;
460 }
Gilles Peskine6c12a1e2021-09-21 11:59:39 +0200461 break;
462#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100463#if defined(PSA_WANT_KEY_TYPE_CAMELLIA)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200464 case PSA_KEY_TYPE_CAMELLIA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100465 if (bits != 128 && bits != 192 && bits != 256) {
466 return PSA_ERROR_INVALID_ARGUMENT;
467 }
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200468 break;
469#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100470#if defined(PSA_WANT_KEY_TYPE_DES)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200471 case PSA_KEY_TYPE_DES:
Gilles Peskine449bd832023-01-11 14:50:10 +0100472 if (bits != 64 && bits != 128 && bits != 192) {
473 return PSA_ERROR_INVALID_ARGUMENT;
474 }
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200475 break;
476#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100477#if defined(PSA_WANT_KEY_TYPE_CHACHA20)
Gilles Peskine26869f22019-05-06 15:25:00 +0200478 case PSA_KEY_TYPE_CHACHA20:
Gilles Peskine449bd832023-01-11 14:50:10 +0100479 if (bits != 256) {
480 return PSA_ERROR_INVALID_ARGUMENT;
481 }
Gilles Peskine26869f22019-05-06 15:25:00 +0200482 break;
483#endif
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200484 default:
Gilles Peskine449bd832023-01-11 14:50:10 +0100485 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200486 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100487 if (bits % 8 != 0) {
488 return PSA_ERROR_INVALID_ARGUMENT;
489 }
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200490
Gilles Peskine449bd832023-01-11 14:50:10 +0100491 return PSA_SUCCESS;
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200492}
493
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100494/** Check whether a given key type is valid for use with a given MAC algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100495 *
Steven Cooremancd640932021-03-08 12:00:27 +0100496 * Upon successful return of this function, the behavior of #PSA_MAC_LENGTH
497 * when called with the validated \p algorithm and \p key_type is well-defined.
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100498 *
499 * \param[in] algorithm The specific MAC algorithm (can be wildcard).
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100500 * \param[in] key_type The key type of the key to be used with the
501 * \p algorithm.
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100502 *
503 * \retval #PSA_SUCCESS
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100504 * The \p key_type is valid for use with the \p algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100505 * \retval #PSA_ERROR_INVALID_ARGUMENT
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100506 * The \p key_type is not valid for use with the \p algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100507 */
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100508MBEDTLS_STATIC_TESTABLE psa_status_t psa_mac_key_can_do(
Steven Cooreman58c94d32021-03-02 21:31:17 +0100509 psa_algorithm_t algorithm,
Gilles Peskine449bd832023-01-11 14:50:10 +0100510 psa_key_type_t key_type)
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100511{
Gilles Peskine449bd832023-01-11 14:50:10 +0100512 if (PSA_ALG_IS_HMAC(algorithm)) {
513 if (key_type == PSA_KEY_TYPE_HMAC) {
514 return PSA_SUCCESS;
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100515 }
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100516 }
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100517
Gilles Peskine449bd832023-01-11 14:50:10 +0100518 if (PSA_ALG_IS_BLOCK_CIPHER_MAC(algorithm)) {
519 /* Check that we're calling PSA_BLOCK_CIPHER_BLOCK_LENGTH with a cipher
520 * key. */
521 if ((key_type & PSA_KEY_TYPE_CATEGORY_MASK) ==
522 PSA_KEY_TYPE_CATEGORY_SYMMETRIC) {
523 /* PSA_BLOCK_CIPHER_BLOCK_LENGTH returns 1 for stream ciphers and
524 * the block length (larger than 1) for block ciphers. */
525 if (PSA_BLOCK_CIPHER_BLOCK_LENGTH(key_type) > 1) {
526 return PSA_SUCCESS;
527 }
528 }
529 }
530
531 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100532}
533
Gilles Peskine449bd832023-01-11 14:50:10 +0100534psa_status_t psa_allocate_buffer_to_slot(psa_key_slot_t *slot,
535 size_t buffer_length)
Steven Cooreman75b74362020-07-28 14:30:13 +0200536{
Gilles Peskine449bd832023-01-11 14:50:10 +0100537 if (slot->key.data != NULL) {
538 return PSA_ERROR_ALREADY_EXISTS;
539 }
Steven Cooreman75b74362020-07-28 14:30:13 +0200540
Gilles Peskine449bd832023-01-11 14:50:10 +0100541 slot->key.data = mbedtls_calloc(1, buffer_length);
542 if (slot->key.data == NULL) {
543 return PSA_ERROR_INSUFFICIENT_MEMORY;
544 }
Steven Cooreman75b74362020-07-28 14:30:13 +0200545
Ronald Cronea0f8a62020-11-25 17:52:23 +0100546 slot->key.bytes = buffer_length;
Gilles Peskine449bd832023-01-11 14:50:10 +0100547 return PSA_SUCCESS;
Steven Cooreman75b74362020-07-28 14:30:13 +0200548}
549
Gilles Peskine449bd832023-01-11 14:50:10 +0100550psa_status_t psa_copy_key_material_into_slot(psa_key_slot_t *slot,
551 const uint8_t *data,
552 size_t data_length)
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200553{
Gilles Peskine449bd832023-01-11 14:50:10 +0100554 psa_status_t status = psa_allocate_buffer_to_slot(slot,
555 data_length);
556 if (status != PSA_SUCCESS) {
557 return status;
558 }
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200559
Gilles Peskine449bd832023-01-11 14:50:10 +0100560 memcpy(slot->key.data, data, data_length);
561 return PSA_SUCCESS;
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200562}
563
Ronald Crona0fe59f2020-11-29 11:14:53 +0100564psa_status_t psa_import_key_into_slot(
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100565 const psa_key_attributes_t *attributes,
566 const uint8_t *data, size_t data_length,
567 uint8_t *key_buffer, size_t key_buffer_size,
Gilles Peskine449bd832023-01-11 14:50:10 +0100568 size_t *key_buffer_length, size_t *bits)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100569{
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100570 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
571 psa_key_type_t type = attributes->core.type;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100572
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200573 /* zero-length keys are never supported. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100574 if (data_length == 0) {
575 return PSA_ERROR_NOT_SUPPORTED;
576 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200577
Gilles Peskine449bd832023-01-11 14:50:10 +0100578 if (key_type_is_raw_bytes(type)) {
579 *bits = PSA_BYTES_TO_BITS(data_length);
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200580
Gilles Peskine449bd832023-01-11 14:50:10 +0100581 status = psa_validate_unstructured_key_bit_size(attributes->core.type,
582 *bits);
583 if (status != PSA_SUCCESS) {
584 return status;
585 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200586
Ronald Crondd04d422020-11-28 15:14:42 +0100587 /* Copy the key material. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100588 memcpy(key_buffer, data, data_length);
Ronald Crondd04d422020-11-28 15:14:42 +0100589 *key_buffer_length = data_length;
Gilles Peskine449bd832023-01-11 14:50:10 +0100590 (void) key_buffer_size;
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200591
Gilles Peskine449bd832023-01-11 14:50:10 +0100592 return PSA_SUCCESS;
593 } else if (PSA_KEY_TYPE_IS_ASYMMETRIC(type)) {
Valerio Settia55f0422023-07-10 15:34:41 +0200594#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_IMPORT) || \
Przemek Stekiel6d85afa2023-04-28 11:42:17 +0200595 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY)
Przemek Stekiel472b3f32022-12-01 14:38:49 +0100596 if (PSA_KEY_TYPE_IS_DH(type)) {
Przemek Stekield1cf1ba2023-04-27 12:04:21 +0200597 if (psa_is_dh_key_size_valid(PSA_BYTES_TO_BITS(data_length)) == 0) {
Valerio Setti504a1022024-01-17 15:19:30 +0100598 return PSA_ERROR_NOT_SUPPORTED;
Przemek Stekiel472b3f32022-12-01 14:38:49 +0100599 }
Przemek Stekiel33c91eb2023-05-30 15:16:35 +0200600 return mbedtls_psa_ffdh_import_key(attributes,
601 data, data_length,
602 key_buffer, key_buffer_size,
603 key_buffer_length,
604 bits);
Przemek Stekiel472b3f32022-12-01 14:38:49 +0100605 }
Valerio Settia55f0422023-07-10 15:34:41 +0200606#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_IMPORT) ||
Przemek Stekiel6d85afa2023-04-28 11:42:17 +0200607 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY) */
Valerio Setti27c501a2023-06-27 16:58:52 +0200608#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_IMPORT) || \
Gilles Peskine449bd832023-01-11 14:50:10 +0100609 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
610 if (PSA_KEY_TYPE_IS_ECC(type)) {
611 return mbedtls_psa_ecp_import_key(attributes,
612 data, data_length,
613 key_buffer, key_buffer_size,
614 key_buffer_length,
615 bits);
Steven Cooreman40120f62020-10-29 11:42:22 +0100616 }
Valerio Setti27c501a2023-06-27 16:58:52 +0200617#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_IMPORT) ||
John Durkop9814fa22020-11-04 12:28:15 -0800618 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
Valerio Settife478902023-07-25 12:27:19 +0200619#if (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) && \
620 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) || \
Gilles Peskine449bd832023-01-11 14:50:10 +0100621 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
622 if (PSA_KEY_TYPE_IS_RSA(type)) {
623 return mbedtls_psa_rsa_import_key(attributes,
624 data, data_length,
625 key_buffer, key_buffer_size,
626 key_buffer_length,
627 bits);
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200628 }
Valerio Settife478902023-07-25 12:27:19 +0200629#endif /* (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) &&
630 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) ||
John Durkop9814fa22020-11-04 12:28:15 -0800631 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100632 }
Steven Cooreman40120f62020-10-29 11:42:22 +0100633
Gilles Peskine449bd832023-01-11 14:50:10 +0100634 return PSA_ERROR_NOT_SUPPORTED;
Darryl Green06fd18d2018-07-16 11:21:11 +0100635}
636
Gilles Peskinef603c712019-01-19 13:40:11 +0100637/** Calculate the intersection of two algorithm usage policies.
638 *
639 * Return 0 (which allows no operation) on incompatibility.
640 */
641static psa_algorithm_t psa_key_policy_algorithm_intersection(
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100642 psa_key_type_t key_type,
Gilles Peskinef603c712019-01-19 13:40:11 +0100643 psa_algorithm_t alg1,
Gilles Peskine449bd832023-01-11 14:50:10 +0100644 psa_algorithm_t alg2)
Gilles Peskinef603c712019-01-19 13:40:11 +0100645{
Gilles Peskine549ea862019-05-22 11:45:59 +0200646 /* Common case: both sides actually specify the same policy. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100647 if (alg1 == alg2) {
648 return alg1;
649 }
Steven Cooreman03488022021-02-18 12:07:20 +0100650 /* If the policies are from the same hash-and-sign family, check
651 * if one is a wildcard. If so the other has the specific algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100652 if (PSA_ALG_IS_SIGN_HASH(alg1) &&
653 PSA_ALG_IS_SIGN_HASH(alg2) &&
654 (alg1 & ~PSA_ALG_HASH_MASK) == (alg2 & ~PSA_ALG_HASH_MASK)) {
655 if (PSA_ALG_SIGN_GET_HASH(alg1) == PSA_ALG_ANY_HASH) {
656 return alg2;
657 }
658 if (PSA_ALG_SIGN_GET_HASH(alg2) == PSA_ALG_ANY_HASH) {
659 return alg1;
660 }
Steven Cooreman03488022021-02-18 12:07:20 +0100661 }
662 /* If the policies are from the same AEAD family, check whether
Steven Cooreman7de9e2d2021-02-22 17:05:56 +0100663 * one of them is a minimum-tag-length wildcard. Calculate the most
Steven Cooreman03488022021-02-18 12:07:20 +0100664 * restrictive tag length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100665 if (PSA_ALG_IS_AEAD(alg1) && PSA_ALG_IS_AEAD(alg2) &&
666 (PSA_ALG_AEAD_WITH_SHORTENED_TAG(alg1, 0) ==
667 PSA_ALG_AEAD_WITH_SHORTENED_TAG(alg2, 0))) {
668 size_t alg1_len = PSA_ALG_AEAD_GET_TAG_LENGTH(alg1);
669 size_t alg2_len = PSA_ALG_AEAD_GET_TAG_LENGTH(alg2);
Steven Cooremancd640932021-03-08 12:00:27 +0100670 size_t restricted_len = alg1_len > alg2_len ? alg1_len : alg2_len;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100671
Steven Cooreman7de9e2d2021-02-22 17:05:56 +0100672 /* If both are wildcards, return most restrictive wildcard */
Gilles Peskine449bd832023-01-11 14:50:10 +0100673 if (((alg1 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0) &&
674 ((alg2 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0)) {
675 return PSA_ALG_AEAD_WITH_AT_LEAST_THIS_LENGTH_TAG(
676 alg1, restricted_len);
Steven Cooreman03488022021-02-18 12:07:20 +0100677 }
678 /* If only one is a wildcard, return specific algorithm if compatible. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100679 if (((alg1 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0) &&
680 (alg1_len <= alg2_len)) {
681 return alg2;
Steven Cooreman03488022021-02-18 12:07:20 +0100682 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100683 if (((alg2 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0) &&
684 (alg2_len <= alg1_len)) {
685 return alg1;
Steven Cooreman03488022021-02-18 12:07:20 +0100686 }
687 }
688 /* If the policies are from the same MAC family, check whether one
689 * of them is a minimum-MAC-length policy. Calculate the most
690 * restrictive tag length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100691 if (PSA_ALG_IS_MAC(alg1) && PSA_ALG_IS_MAC(alg2) &&
692 (PSA_ALG_FULL_LENGTH_MAC(alg1) ==
693 PSA_ALG_FULL_LENGTH_MAC(alg2))) {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100694 /* Validate the combination of key type and algorithm. Since the base
695 * algorithm of alg1 and alg2 are the same, we only need this once. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100696 if (PSA_SUCCESS != psa_mac_key_can_do(alg1, key_type)) {
697 return 0;
698 }
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100699
Steven Cooreman31a876d2021-03-03 20:47:40 +0100700 /* Get the (exact or at-least) output lengths for both sides of the
701 * requested intersection. None of the currently supported algorithms
702 * have an output length dependent on the actual key size, so setting it
703 * to a bogus value of 0 is currently OK.
704 *
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100705 * Note that for at-least-this-length wildcard algorithms, the output
706 * length is set to the shortest allowed length, which allows us to
707 * calculate the most restrictive tag length for the intersection. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100708 size_t alg1_len = PSA_MAC_LENGTH(key_type, 0, alg1);
709 size_t alg2_len = PSA_MAC_LENGTH(key_type, 0, alg2);
Steven Cooremancd640932021-03-08 12:00:27 +0100710 size_t restricted_len = alg1_len > alg2_len ? alg1_len : alg2_len;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100711
Steven Cooremana1d83222021-02-25 10:20:29 +0100712 /* If both are wildcards, return most restrictive wildcard */
Gilles Peskine449bd832023-01-11 14:50:10 +0100713 if (((alg1 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0) &&
714 ((alg2 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0)) {
715 return PSA_ALG_AT_LEAST_THIS_LENGTH_MAC(alg1, restricted_len);
Steven Cooreman03488022021-02-18 12:07:20 +0100716 }
Steven Cooreman31a876d2021-03-03 20:47:40 +0100717
718 /* If only one is an at-least-this-length policy, the intersection would
719 * be the other (fixed-length) policy as long as said fixed length is
720 * equal to or larger than the shortest allowed length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100721 if ((alg1 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0) {
722 return (alg1_len <= alg2_len) ? alg2 : 0;
Steven Cooreman03488022021-02-18 12:07:20 +0100723 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100724 if ((alg2 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0) {
725 return (alg2_len <= alg1_len) ? alg1 : 0;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100726 }
Steven Cooreman31a876d2021-03-03 20:47:40 +0100727
Steven Cooremancd640932021-03-08 12:00:27 +0100728 /* If none of them are wildcards, check whether they define the same tag
729 * length. This is still possible here when one is default-length and
730 * the other specific-length. Ensure to always return the
731 * specific-length version for the intersection. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100732 if (alg1_len == alg2_len) {
733 return PSA_ALG_TRUNCATED_MAC(alg1, alg1_len);
734 }
Gilles Peskinef603c712019-01-19 13:40:11 +0100735 }
736 /* If the policies are incompatible, allow nothing. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100737 return 0;
Gilles Peskinef603c712019-01-19 13:40:11 +0100738}
739
Gilles Peskine449bd832023-01-11 14:50:10 +0100740static int psa_key_algorithm_permits(psa_key_type_t key_type,
741 psa_algorithm_t policy_alg,
742 psa_algorithm_t requested_alg)
Gilles Peskined6f371b2019-05-10 19:33:38 +0200743{
Gilles Peskine549ea862019-05-22 11:45:59 +0200744 /* Common case: the policy only allows requested_alg. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100745 if (requested_alg == policy_alg) {
746 return 1;
747 }
Steven Cooreman03488022021-02-18 12:07:20 +0100748 /* If policy_alg is a hash-and-sign with a wildcard for the hash,
749 * and requested_alg is the same hash-and-sign family with any hash,
750 * then requested_alg is compliant with policy_alg. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100751 if (PSA_ALG_IS_SIGN_HASH(requested_alg) &&
752 PSA_ALG_SIGN_GET_HASH(policy_alg) == PSA_ALG_ANY_HASH) {
753 return (policy_alg & ~PSA_ALG_HASH_MASK) ==
754 (requested_alg & ~PSA_ALG_HASH_MASK);
Steven Cooreman03488022021-02-18 12:07:20 +0100755 }
756 /* If policy_alg is a wildcard AEAD algorithm of the same base as
757 * the requested algorithm, check the requested tag length to be
758 * equal-length or longer than the wildcard-specified length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100759 if (PSA_ALG_IS_AEAD(policy_alg) &&
760 PSA_ALG_IS_AEAD(requested_alg) &&
761 (PSA_ALG_AEAD_WITH_SHORTENED_TAG(policy_alg, 0) ==
762 PSA_ALG_AEAD_WITH_SHORTENED_TAG(requested_alg, 0)) &&
763 ((policy_alg & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0)) {
764 return PSA_ALG_AEAD_GET_TAG_LENGTH(policy_alg) <=
765 PSA_ALG_AEAD_GET_TAG_LENGTH(requested_alg);
Steven Cooreman03488022021-02-18 12:07:20 +0100766 }
Steven Cooremancd640932021-03-08 12:00:27 +0100767 /* If policy_alg is a MAC algorithm of the same base as the requested
768 * algorithm, check whether their MAC lengths are compatible. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100769 if (PSA_ALG_IS_MAC(policy_alg) &&
770 PSA_ALG_IS_MAC(requested_alg) &&
771 (PSA_ALG_FULL_LENGTH_MAC(policy_alg) ==
772 PSA_ALG_FULL_LENGTH_MAC(requested_alg))) {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100773 /* Validate the combination of key type and algorithm. Since the policy
774 * and requested algorithms are the same, we only need this once. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100775 if (PSA_SUCCESS != psa_mac_key_can_do(policy_alg, key_type)) {
776 return 0;
777 }
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100778
Steven Cooreman31a876d2021-03-03 20:47:40 +0100779 /* Get both the requested output length for the algorithm which is to be
780 * verified, and the default output length for the base algorithm.
781 * Note that none of the currently supported algorithms have an output
782 * length dependent on actual key size, so setting it to a bogus value
783 * of 0 is currently OK. */
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100784 size_t requested_output_length = PSA_MAC_LENGTH(
Gilles Peskine449bd832023-01-11 14:50:10 +0100785 key_type, 0, requested_alg);
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100786 size_t default_output_length = PSA_MAC_LENGTH(
Gilles Peskine449bd832023-01-11 14:50:10 +0100787 key_type, 0,
788 PSA_ALG_FULL_LENGTH_MAC(requested_alg));
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100789
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100790 /* If the policy is default-length, only allow an algorithm with
791 * a declared exact-length matching the default. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100792 if (PSA_MAC_TRUNCATED_LENGTH(policy_alg) == 0) {
793 return requested_output_length == default_output_length;
794 }
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100795
796 /* If the requested algorithm is default-length, allow it if the policy
Steven Cooremancd640932021-03-08 12:00:27 +0100797 * length exactly matches the default length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100798 if (PSA_MAC_TRUNCATED_LENGTH(requested_alg) == 0 &&
799 PSA_MAC_TRUNCATED_LENGTH(policy_alg) == default_output_length) {
800 return 1;
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100801 }
802
Steven Cooremancd640932021-03-08 12:00:27 +0100803 /* If policy_alg is an at-least-this-length wildcard MAC algorithm,
804 * check for the requested MAC length to be equal to or longer than the
805 * minimum allowed length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100806 if ((policy_alg & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0) {
807 return PSA_MAC_TRUNCATED_LENGTH(policy_alg) <=
808 requested_output_length;
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100809 }
Gilles Peskined6f371b2019-05-10 19:33:38 +0200810 }
Steven Cooremance48e852020-10-05 16:02:45 +0200811 /* If policy_alg is a generic key agreement operation, then using it for
Steven Cooremanfa5e6312020-10-15 17:07:12 +0200812 * a key derivation with that key agreement should also be allowed. This
813 * behaviour is expected to be defined in a future specification version. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100814 if (PSA_ALG_IS_RAW_KEY_AGREEMENT(policy_alg) &&
815 PSA_ALG_IS_KEY_AGREEMENT(requested_alg)) {
816 return PSA_ALG_KEY_AGREEMENT_GET_BASE(requested_alg) ==
817 policy_alg;
Steven Cooremance48e852020-10-05 16:02:45 +0200818 }
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100819 /* If it isn't explicitly permitted, it's forbidden. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100820 return 0;
Gilles Peskined6f371b2019-05-10 19:33:38 +0200821}
822
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100823/** Test whether a policy permits an algorithm.
824 *
825 * The caller must test usage flags separately.
Steven Cooreman7e39f052021-02-23 14:18:32 +0100826 *
Steven Cooreman5a172672021-03-02 21:27:42 +0100827 * \note This function requires providing the key type for which the policy is
828 * being validated, since some algorithm policy definitions (e.g. MAC)
829 * have different properties depending on what kind of cipher it is
830 * combined with.
831 *
Steven Cooreman7e39f052021-02-23 14:18:32 +0100832 * \retval PSA_SUCCESS When \p alg is a specific algorithm
833 * allowed by the \p policy.
834 * \retval PSA_ERROR_INVALID_ARGUMENT When \p alg is not a specific algorithm
835 * \retval PSA_ERROR_NOT_PERMITTED When \p alg is a specific algorithm, but
836 * the \p policy does not allow it.
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100837 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100838static psa_status_t psa_key_policy_permits(const psa_key_policy_t *policy,
839 psa_key_type_t key_type,
840 psa_algorithm_t alg)
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100841{
Steven Cooremand788fab2021-02-25 11:29:17 +0100842 /* '0' is not a valid algorithm */
Gilles Peskine449bd832023-01-11 14:50:10 +0100843 if (alg == 0) {
844 return PSA_ERROR_INVALID_ARGUMENT;
845 }
Steven Cooremand788fab2021-02-25 11:29:17 +0100846
Steven Cooreman7e39f052021-02-23 14:18:32 +0100847 /* A requested algorithm cannot be a wildcard. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100848 if (PSA_ALG_IS_WILDCARD(alg)) {
849 return PSA_ERROR_INVALID_ARGUMENT;
850 }
Steven Cooreman7e39f052021-02-23 14:18:32 +0100851
Gilles Peskine449bd832023-01-11 14:50:10 +0100852 if (psa_key_algorithm_permits(key_type, policy->alg, alg) ||
853 psa_key_algorithm_permits(key_type, policy->alg2, alg)) {
854 return PSA_SUCCESS;
855 } else {
856 return PSA_ERROR_NOT_PERMITTED;
857 }
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100858}
859
Gilles Peskinef603c712019-01-19 13:40:11 +0100860/** Restrict a key policy based on a constraint.
861 *
Steven Cooreman5a172672021-03-02 21:27:42 +0100862 * \note This function requires providing the key type for which the policy is
863 * being restricted, since some algorithm policy definitions (e.g. MAC)
864 * have different properties depending on what kind of cipher it is
865 * combined with.
866 *
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100867 * \param[in] key_type The key type for which to restrict the policy
Gilles Peskinef603c712019-01-19 13:40:11 +0100868 * \param[in,out] policy The policy to restrict.
869 * \param[in] constraint The policy constraint to apply.
870 *
871 * \retval #PSA_SUCCESS
872 * \c *policy contains the intersection of the original value of
873 * \c *policy and \c *constraint.
874 * \retval #PSA_ERROR_INVALID_ARGUMENT
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100875 * \c key_type, \c *policy and \c *constraint are incompatible.
Gilles Peskinef603c712019-01-19 13:40:11 +0100876 * \c *policy is unchanged.
877 */
878static psa_status_t psa_restrict_key_policy(
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100879 psa_key_type_t key_type,
Gilles Peskinef603c712019-01-19 13:40:11 +0100880 psa_key_policy_t *policy,
Gilles Peskine449bd832023-01-11 14:50:10 +0100881 const psa_key_policy_t *constraint)
Gilles Peskinef603c712019-01-19 13:40:11 +0100882{
883 psa_algorithm_t intersection_alg =
Gilles Peskine449bd832023-01-11 14:50:10 +0100884 psa_key_policy_algorithm_intersection(key_type, policy->alg,
885 constraint->alg);
Gilles Peskined6f371b2019-05-10 19:33:38 +0200886 psa_algorithm_t intersection_alg2 =
Gilles Peskine449bd832023-01-11 14:50:10 +0100887 psa_key_policy_algorithm_intersection(key_type, policy->alg2,
888 constraint->alg2);
889 if (intersection_alg == 0 && policy->alg != 0 && constraint->alg != 0) {
890 return PSA_ERROR_INVALID_ARGUMENT;
891 }
892 if (intersection_alg2 == 0 && policy->alg2 != 0 && constraint->alg2 != 0) {
893 return PSA_ERROR_INVALID_ARGUMENT;
894 }
Gilles Peskinef603c712019-01-19 13:40:11 +0100895 policy->usage &= constraint->usage;
896 policy->alg = intersection_alg;
Gilles Peskined6f371b2019-05-10 19:33:38 +0200897 policy->alg2 = intersection_alg2;
Gilles Peskine449bd832023-01-11 14:50:10 +0100898 return PSA_SUCCESS;
Gilles Peskinef603c712019-01-19 13:40:11 +0100899}
900
Przemek Stekiel061f6942022-11-30 10:51:35 +0100901/** Get the description of a key given its identifier and policy constraints
902 * and lock it.
903 *
904 * The key must have allow all the usage flags set in \p usage. If \p alg is
905 * nonzero, the key must allow operations with this algorithm. If \p alg is
906 * zero, the algorithm is not checked.
907 *
908 * In case of a persistent key, the function loads the description of the key
909 * into a key slot if not already done.
910 *
911 * On success, the returned key slot is locked. It is the responsibility of
912 * the caller to unlock the key slot when it does not access it anymore.
913 */
914static psa_status_t psa_get_and_lock_key_slot_with_policy(
Ronald Cron5c522922020-11-14 16:35:34 +0100915 mbedtls_svc_key_id_t key,
916 psa_key_slot_t **p_slot,
917 psa_key_usage_t usage,
Gilles Peskine449bd832023-01-11 14:50:10 +0100918 psa_algorithm_t alg)
Darryl Green06fd18d2018-07-16 11:21:11 +0100919{
Ronald Cronf95a2b12020-10-22 15:24:49 +0200920 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel9a5b8122022-12-22 13:34:47 +0100921 psa_key_slot_t *slot = NULL;
Darryl Green06fd18d2018-07-16 11:21:11 +0100922
Gilles Peskine449bd832023-01-11 14:50:10 +0100923 status = psa_get_and_lock_key_slot(key, p_slot);
924 if (status != PSA_SUCCESS) {
925 return status;
926 }
Ronald Cronf95a2b12020-10-22 15:24:49 +0200927 slot = *p_slot;
Darryl Green06fd18d2018-07-16 11:21:11 +0100928
929 /* Enforce that usage policy for the key slot contains all the flags
930 * required by the usage parameter. There is one exception: public
931 * keys can always be exported, so we treat public key objects as
932 * if they had the export flag. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100933 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(slot->attr.type)) {
Darryl Green06fd18d2018-07-16 11:21:11 +0100934 usage &= ~PSA_KEY_USAGE_EXPORT;
Gilles Peskine449bd832023-01-11 14:50:10 +0100935 }
Ronald Cronf95a2b12020-10-22 15:24:49 +0200936
Gilles Peskine449bd832023-01-11 14:50:10 +0100937 if ((slot->attr.policy.usage & usage) != usage) {
Steven Cooreman328f11c2021-03-02 11:44:51 +0100938 status = PSA_ERROR_NOT_PERMITTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +0200939 goto error;
Steven Cooreman328f11c2021-03-02 11:44:51 +0100940 }
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100941
Shaun Case8b0ecbc2021-12-20 21:14:10 -0800942 /* Enforce that the usage policy permits the requested algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100943 if (alg != 0) {
944 status = psa_key_policy_permits(&slot->attr.policy,
945 slot->attr.type,
946 alg);
947 if (status != PSA_SUCCESS) {
Steven Cooreman7e39f052021-02-23 14:18:32 +0100948 goto error;
Gilles Peskine449bd832023-01-11 14:50:10 +0100949 }
Steven Cooreman7e39f052021-02-23 14:18:32 +0100950 }
Darryl Green06fd18d2018-07-16 11:21:11 +0100951
Gilles Peskine449bd832023-01-11 14:50:10 +0100952 return PSA_SUCCESS;
Ronald Cronf95a2b12020-10-22 15:24:49 +0200953
954error:
955 *p_slot = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +0100956 psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +0200957
Gilles Peskine449bd832023-01-11 14:50:10 +0100958 return status;
Darryl Green06fd18d2018-07-16 11:21:11 +0100959}
Darryl Green940d72c2018-07-13 13:18:51 +0100960
Ronald Cron5c522922020-11-14 16:35:34 +0100961/** Get a key slot containing a transparent key and lock it.
Gilles Peskine28f8f302019-07-24 13:30:31 +0200962 *
963 * A transparent key is a key for which the key material is directly
Ronald Cronddae0f52021-08-24 15:39:44 +0200964 * available, as opposed to a key in a secure element and/or to be used
965 * by a secure element.
Gilles Peskine28f8f302019-07-24 13:30:31 +0200966 *
Ronald Cronddae0f52021-08-24 15:39:44 +0200967 * This is a temporary function that may be used instead of
968 * psa_get_and_lock_key_slot_with_policy() when there is no opaque key support
969 * for a cryptographic operation.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200970 *
Ronald Cron5c522922020-11-14 16:35:34 +0100971 * On success, the returned key slot is locked. It is the responsibility of the
972 * caller to unlock the key slot when it does not access it anymore.
Gilles Peskine28f8f302019-07-24 13:30:31 +0200973 */
Ronald Cron5c522922020-11-14 16:35:34 +0100974static psa_status_t psa_get_and_lock_transparent_key_slot_with_policy(
975 mbedtls_svc_key_id_t key,
976 psa_key_slot_t **p_slot,
977 psa_key_usage_t usage,
Gilles Peskine449bd832023-01-11 14:50:10 +0100978 psa_algorithm_t alg)
Gilles Peskine28f8f302019-07-24 13:30:31 +0200979{
Gilles Peskine449bd832023-01-11 14:50:10 +0100980 psa_status_t status = psa_get_and_lock_key_slot_with_policy(key, p_slot,
981 usage, alg);
982 if (status != PSA_SUCCESS) {
983 return status;
Gilles Peskine28f8f302019-07-24 13:30:31 +0200984 }
Ronald Cronf95a2b12020-10-22 15:24:49 +0200985
Gilles Peskine449bd832023-01-11 14:50:10 +0100986 if (psa_key_lifetime_is_external((*p_slot)->attr.lifetime)) {
987 psa_unlock_key_slot(*p_slot);
988 *p_slot = NULL;
989 return PSA_ERROR_NOT_SUPPORTED;
990 }
991
992 return PSA_SUCCESS;
Gilles Peskine28f8f302019-07-24 13:30:31 +0200993}
Gilles Peskine28f8f302019-07-24 13:30:31 +0200994
Gilles Peskine449bd832023-01-11 14:50:10 +0100995psa_status_t psa_remove_key_data_from_memory(psa_key_slot_t *slot)
Darryl Green40225ba2018-11-15 14:48:15 +0000996{
Gilles Peskine449bd832023-01-11 14:50:10 +0100997 if (slot->key.data != NULL) {
Tom Cosgrove52f7e182023-08-01 09:08:48 +0100998 mbedtls_zeroize_and_free(slot->key.data, slot->key.bytes);
Gilles Peskine449bd832023-01-11 14:50:10 +0100999 }
Ronald Cronea0f8a62020-11-25 17:52:23 +01001000
Ronald Cronea0f8a62020-11-25 17:52:23 +01001001 slot->key.data = NULL;
1002 slot->key.bytes = 0;
Darryl Green40225ba2018-11-15 14:48:15 +00001003
Gilles Peskine449bd832023-01-11 14:50:10 +01001004 return PSA_SUCCESS;
Darryl Green40225ba2018-11-15 14:48:15 +00001005}
1006
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001007/** Completely wipe a slot in memory, including its policy.
1008 * Persistent storage is not affected. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001009psa_status_t psa_wipe_key_slot(psa_key_slot_t *slot)
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001010{
Gilles Peskine449bd832023-01-11 14:50:10 +01001011 psa_status_t status = psa_remove_key_data_from_memory(slot);
Ronald Cronddd3d052020-10-30 14:07:07 +01001012
Gilles Peskine449bd832023-01-11 14:50:10 +01001013 /*
1014 * As the return error code may not be handled in case of multiple errors,
1015 * do our best to report an unexpected lock counter. Assert with
1016 * MBEDTLS_TEST_HOOK_TEST_ASSERT that the lock counter is equal to one:
1017 * if the MBEDTLS_TEST_HOOKS configuration option is enabled and the
1018 * function is called as part of the execution of a test suite, the
1019 * execution of the test suite is stopped in error if the assertion fails.
1020 */
1021 if (slot->lock_count != 1) {
1022 MBEDTLS_TEST_HOOK_TEST_ASSERT(slot->lock_count == 1);
Ronald Cronddd3d052020-10-30 14:07:07 +01001023 status = PSA_ERROR_CORRUPTION_DETECTED;
1024 }
1025
Gilles Peskine3f7cd622019-08-13 15:01:08 +02001026 /* Multipart operations may still be using the key. This is safe
1027 * because all multipart operation objects are independent from
1028 * the key slot: if they need to access the key after the setup
1029 * phase, they have a copy of the key. Note that this means that
1030 * key material can linger until all operations are completed. */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001031 /* At this point, key material and other type-specific content has
1032 * been wiped. Clear remaining metadata. We can call memset and not
1033 * zeroize because the metadata is not particularly sensitive. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001034 memset(slot, 0, sizeof(*slot));
1035 return status;
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001036}
1037
Gilles Peskine449bd832023-01-11 14:50:10 +01001038psa_status_t psa_destroy_key(mbedtls_svc_key_id_t key)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001039{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001040 psa_key_slot_t *slot;
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001041 psa_status_t status; /* status of the last operation */
1042 psa_status_t overall_status = PSA_SUCCESS;
Gilles Peskine354f7672019-07-12 23:46:38 +02001043#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1044 psa_se_drv_table_entry_t *driver;
1045#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001046
Gilles Peskine449bd832023-01-11 14:50:10 +01001047 if (mbedtls_svc_key_id_is_null(key)) {
1048 return PSA_SUCCESS;
1049 }
Gilles Peskine1841cf42019-10-08 15:48:25 +02001050
Ronald Cronf2911112020-10-29 17:51:10 +01001051 /*
Ronald Cron19daca92020-11-10 18:08:03 +01001052 * Get the description of the key in a key slot. In case of a persistent
Ronald Cronf2911112020-10-29 17:51:10 +01001053 * key, this will load the key description from persistent memory if not
1054 * done yet. We cannot avoid this loading as without it we don't know if
1055 * the key is operated by an SE or not and this information is needed by
1056 * the current implementation.
1057 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001058 status = psa_get_and_lock_key_slot(key, &slot);
1059 if (status != PSA_SUCCESS) {
1060 return status;
1061 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001062
Ronald Cronf2911112020-10-29 17:51:10 +01001063 /*
1064 * If the key slot containing the key description is under access by the
1065 * library (apart from the present access), the key cannot be destroyed
1066 * yet. For the time being, just return in error. Eventually (to be
1067 * implemented), the key should be destroyed when all accesses have
1068 * stopped.
1069 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001070 if (slot->lock_count > 1) {
1071 psa_unlock_key_slot(slot);
1072 return PSA_ERROR_GENERIC_ERROR;
Ronald Cronf2911112020-10-29 17:51:10 +01001073 }
1074
Gilles Peskine449bd832023-01-11 14:50:10 +01001075 if (PSA_KEY_LIFETIME_IS_READ_ONLY(slot->attr.lifetime)) {
Gilles Peskine6687cd02021-04-21 22:32:05 +02001076 /* Refuse the destruction of a read-only key (which may or may not work
1077 * if we attempt it, depending on whether the key is merely read-only
1078 * by policy or actually physically read-only).
Gilles Peskinef9a046e2021-06-07 23:27:54 +02001079 * Just do the best we can, which is to wipe the copy in memory
1080 * (done in this function's cleanup code). */
1081 overall_status = PSA_ERROR_NOT_PERMITTED;
1082 goto exit;
Gilles Peskine6687cd02021-04-21 22:32:05 +02001083 }
1084
Gilles Peskine354f7672019-07-12 23:46:38 +02001085#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001086 driver = psa_get_se_driver_entry(slot->attr.lifetime);
1087 if (driver != NULL) {
Gilles Peskine60450a42019-07-25 11:32:45 +02001088 /* For a key in a secure element, we need to do three things:
1089 * remove the key file in internal storage, destroy the
1090 * key inside the secure element, and update the driver's
1091 * persistent data. Start a transaction that will encompass these
1092 * three actions. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001093 psa_crypto_prepare_transaction(PSA_CRYPTO_TRANSACTION_DESTROY_KEY);
Gilles Peskine8e338702019-07-30 20:06:31 +02001094 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Gilles Peskine449bd832023-01-11 14:50:10 +01001095 psa_crypto_transaction.key.slot = psa_key_slot_get_slot_number(slot);
Gilles Peskine8e338702019-07-30 20:06:31 +02001096 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskine449bd832023-01-11 14:50:10 +01001097 status = psa_crypto_save_transaction();
1098 if (status != PSA_SUCCESS) {
1099 (void) psa_crypto_stop_transaction();
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001100 /* We should still try to destroy the key in the secure
1101 * element and the key metadata in storage. This is especially
1102 * important if the error is that the storage is full.
1103 * But how to do it exactly without risking an inconsistent
1104 * state after a reset?
1105 * https://github.com/ARMmbed/mbed-crypto/issues/215
1106 */
1107 overall_status = status;
1108 goto exit;
Gilles Peskinefc762652019-07-22 19:30:34 +02001109 }
1110
Gilles Peskine449bd832023-01-11 14:50:10 +01001111 status = psa_destroy_se_key(driver,
1112 psa_key_slot_get_slot_number(slot));
1113 if (overall_status == PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001114 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001115 }
Gilles Peskinefc762652019-07-22 19:30:34 +02001116 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001117#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1118
Darryl Greend49a4992018-06-18 17:27:26 +01001119#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001120 if (!PSA_KEY_LIFETIME_IS_VOLATILE(slot->attr.lifetime)) {
1121 status = psa_destroy_persistent_key(slot->attr.id);
1122 if (overall_status == PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001123 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001124 }
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001125
Gilles Peskine9ce31c42019-08-13 15:14:20 +02001126 /* TODO: other slots may have a copy of the same key. We should
1127 * invalidate them.
1128 * https://github.com/ARMmbed/mbed-crypto/issues/214
1129 */
Darryl Greend49a4992018-06-18 17:27:26 +01001130 }
1131#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
Gilles Peskine354f7672019-07-12 23:46:38 +02001132
Gilles Peskinefc762652019-07-22 19:30:34 +02001133#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001134 if (driver != NULL) {
1135 status = psa_save_se_persistent_data(driver);
1136 if (overall_status == PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001137 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001138 }
1139 status = psa_crypto_stop_transaction();
1140 if (overall_status == PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001141 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001142 }
Gilles Peskinefc762652019-07-22 19:30:34 +02001143 }
1144#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1145
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001146exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01001147 status = psa_wipe_key_slot(slot);
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001148 /* Prioritize CORRUPTION_DETECTED from wiping over a storage error */
Gilles Peskine449bd832023-01-11 14:50:10 +01001149 if (status != PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001150 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001151 }
1152 return overall_status;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001153}
1154
Valerio Settib2bcedb2023-07-10 11:24:00 +02001155#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT) || \
John Durkop0e005192020-10-31 22:06:54 -07001156 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskineb699f072019-04-26 16:06:02 +02001157static psa_status_t psa_get_rsa_public_exponent(
1158 const mbedtls_rsa_context *rsa,
Gilles Peskine449bd832023-01-11 14:50:10 +01001159 psa_key_attributes_t *attributes)
Gilles Peskineb699f072019-04-26 16:06:02 +02001160{
1161 mbedtls_mpi mpi;
Janos Follath24eed8d2019-11-22 13:21:35 +00001162 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb699f072019-04-26 16:06:02 +02001163 uint8_t *buffer = NULL;
1164 size_t buflen;
Gilles Peskine449bd832023-01-11 14:50:10 +01001165 mbedtls_mpi_init(&mpi);
Gilles Peskineb699f072019-04-26 16:06:02 +02001166
Gilles Peskine449bd832023-01-11 14:50:10 +01001167 ret = mbedtls_rsa_export(rsa, NULL, NULL, NULL, NULL, &mpi);
1168 if (ret != 0) {
Gilles Peskineb699f072019-04-26 16:06:02 +02001169 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001170 }
1171 if (mbedtls_mpi_cmp_int(&mpi, 65537) == 0) {
Gilles Peskine772c8b12019-04-26 17:37:21 +02001172 /* It's the default value, which is reported as an empty string,
1173 * so there's nothing to do. */
1174 goto exit;
1175 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001176
Gilles Peskine449bd832023-01-11 14:50:10 +01001177 buflen = mbedtls_mpi_size(&mpi);
1178 buffer = mbedtls_calloc(1, buflen);
1179 if (buffer == NULL) {
Gilles Peskineb699f072019-04-26 16:06:02 +02001180 ret = MBEDTLS_ERR_MPI_ALLOC_FAILED;
1181 goto exit;
1182 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001183 ret = mbedtls_mpi_write_binary(&mpi, buffer, buflen);
1184 if (ret != 0) {
Gilles Peskineb699f072019-04-26 16:06:02 +02001185 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001186 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001187 attributes->domain_parameters = buffer;
1188 attributes->domain_parameters_size = buflen;
1189
1190exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01001191 mbedtls_mpi_free(&mpi);
1192 if (ret != 0) {
1193 mbedtls_free(buffer);
1194 }
1195 return mbedtls_to_psa_error(ret);
Gilles Peskineb699f072019-04-26 16:06:02 +02001196}
Valerio Settib2bcedb2023-07-10 11:24:00 +02001197#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT) ||
John Durkop9814fa22020-11-04 12:28:15 -08001198 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001199
Gilles Peskinebfd322f2019-07-23 11:58:03 +02001200/** Retrieve all the publicly-accessible attributes of a key.
1201 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001202psa_status_t psa_get_key_attributes(mbedtls_svc_key_id_t key,
1203 psa_key_attributes_t *attributes)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001204{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001205 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001206 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001207 psa_key_slot_t *slot;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001208
Gilles Peskine449bd832023-01-11 14:50:10 +01001209 psa_reset_key_attributes(attributes);
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001210
Gilles Peskine449bd832023-01-11 14:50:10 +01001211 status = psa_get_and_lock_key_slot_with_policy(key, &slot, 0, 0);
1212 if (status != PSA_SUCCESS) {
1213 return status;
1214 }
Gilles Peskineb870b182018-07-06 16:02:09 +02001215
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001216 attributes->core = slot->attr;
Gilles Peskine449bd832023-01-11 14:50:10 +01001217 attributes->core.flags &= (MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1218 MBEDTLS_PSA_KA_MASK_DUAL_USE);
Gilles Peskinec8000c02019-08-02 20:15:51 +02001219
1220#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001221 if (psa_get_se_driver_entry(slot->attr.lifetime) != NULL) {
1222 psa_set_key_slot_number(attributes,
1223 psa_key_slot_get_slot_number(slot));
1224 }
Gilles Peskinec8000c02019-08-02 20:15:51 +02001225#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineb699f072019-04-26 16:06:02 +02001226
Gilles Peskine449bd832023-01-11 14:50:10 +01001227 switch (slot->attr.type) {
Valerio Settib2bcedb2023-07-10 11:24:00 +02001228#if (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) && \
1229 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) || \
John Durkop0e005192020-10-31 22:06:54 -07001230 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02001231 case PSA_KEY_TYPE_RSA_KEY_PAIR:
Gilles Peskineb699f072019-04-26 16:06:02 +02001232 case PSA_KEY_TYPE_RSA_PUBLIC_KEY:
Pengyu Lvf75893b2023-12-08 17:21:39 +08001233 /* TODO: This is a temporary situation where domain parameters are deprecated,
1234 * but we need it for namely generating an RSA key with a non-default exponent.
1235 * This would be improved after https://github.com/Mbed-TLS/mbedtls/issues/6494.
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001236 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001237 if (!psa_key_lifetime_is_external(slot->attr.lifetime)) {
Steven Cooremana2371e52020-07-28 14:30:39 +02001238 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02001239
Ronald Cron90857082020-11-25 14:58:33 +01001240 status = mbedtls_psa_rsa_load_representation(
Gilles Peskine449bd832023-01-11 14:50:10 +01001241 slot->attr.type,
1242 slot->key.data,
1243 slot->key.bytes,
1244 &rsa);
1245 if (status != PSA_SUCCESS) {
Steven Cooremana01795d2020-07-24 22:48:15 +02001246 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01001247 }
Steven Cooremana01795d2020-07-24 22:48:15 +02001248
Gilles Peskine449bd832023-01-11 14:50:10 +01001249 status = psa_get_rsa_public_exponent(rsa,
1250 attributes);
1251 mbedtls_rsa_free(rsa);
1252 mbedtls_free(rsa);
Steven Cooremana01795d2020-07-24 22:48:15 +02001253 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001254 break;
Pengyu Lve9efbc22023-12-08 16:59:08 +08001255#else
1256 case PSA_KEY_TYPE_RSA_KEY_PAIR:
1257 case PSA_KEY_TYPE_RSA_PUBLIC_KEY:
1258 attributes->domain_parameters = NULL;
1259 attributes->domain_parameters_size = SIZE_MAX;
1260 break;
Valerio Settib2bcedb2023-07-10 11:24:00 +02001261#endif /* (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) && \
1262 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) ||
John Durkop9814fa22020-11-04 12:28:15 -08001263 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001264 default:
1265 /* Nothing else to do. */
1266 break;
1267 }
1268
Gilles Peskine449bd832023-01-11 14:50:10 +01001269 if (status != PSA_SUCCESS) {
1270 psa_reset_key_attributes(attributes);
1271 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001272
Gilles Peskine449bd832023-01-11 14:50:10 +01001273 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02001274
Gilles Peskine449bd832023-01-11 14:50:10 +01001275 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001276}
1277
Gilles Peskinec8000c02019-08-02 20:15:51 +02001278#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1279psa_status_t psa_get_key_slot_number(
1280 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01001281 psa_key_slot_number_t *slot_number)
Gilles Peskinec8000c02019-08-02 20:15:51 +02001282{
Gilles Peskine449bd832023-01-11 14:50:10 +01001283 if (attributes->core.flags & MBEDTLS_PSA_KA_FLAG_HAS_SLOT_NUMBER) {
Gilles Peskinec8000c02019-08-02 20:15:51 +02001284 *slot_number = attributes->slot_number;
Gilles Peskine449bd832023-01-11 14:50:10 +01001285 return PSA_SUCCESS;
1286 } else {
1287 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinec8000c02019-08-02 20:15:51 +02001288 }
Gilles Peskinec8000c02019-08-02 20:15:51 +02001289}
1290#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1291
Gilles Peskine449bd832023-01-11 14:50:10 +01001292static psa_status_t psa_export_key_buffer_internal(const uint8_t *key_buffer,
1293 size_t key_buffer_size,
1294 uint8_t *data,
1295 size_t data_size,
1296 size_t *data_length)
Steven Cooremana01795d2020-07-24 22:48:15 +02001297{
Gilles Peskine449bd832023-01-11 14:50:10 +01001298 if (key_buffer_size > data_size) {
1299 return PSA_ERROR_BUFFER_TOO_SMALL;
1300 }
1301 memcpy(data, key_buffer, key_buffer_size);
1302 memset(data + key_buffer_size, 0,
1303 data_size - key_buffer_size);
Ronald Crond18b5f82020-11-25 16:46:05 +01001304 *data_length = key_buffer_size;
Gilles Peskine449bd832023-01-11 14:50:10 +01001305 return PSA_SUCCESS;
Steven Cooremana01795d2020-07-24 22:48:15 +02001306}
1307
Ronald Cron7285cda2020-11-26 14:46:37 +01001308psa_status_t psa_export_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001309 const psa_key_attributes_t *attributes,
1310 const uint8_t *key_buffer, size_t key_buffer_size,
Gilles Peskine449bd832023-01-11 14:50:10 +01001311 uint8_t *data, size_t data_size, size_t *data_length)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001312{
Ronald Crond18b5f82020-11-25 16:46:05 +01001313 psa_key_type_t type = attributes->core.type;
1314
Gilles Peskine449bd832023-01-11 14:50:10 +01001315 if (key_type_is_raw_bytes(type) ||
1316 PSA_KEY_TYPE_IS_RSA(type) ||
Przemek Stekiel472b3f32022-12-01 14:38:49 +01001317 PSA_KEY_TYPE_IS_ECC(type) ||
1318 PSA_KEY_TYPE_IS_DH(type)) {
Gilles Peskine449bd832023-01-11 14:50:10 +01001319 return psa_export_key_buffer_internal(
1320 key_buffer, key_buffer_size,
1321 data, data_size, data_length);
1322 } else {
Ronald Cron9486f9d2020-11-26 13:36:23 +01001323 /* This shouldn't happen in the reference implementation, but
1324 it is valid for a special-purpose implementation to omit
1325 support for exporting certain key types. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001326 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron9486f9d2020-11-26 13:36:23 +01001327 }
1328}
1329
Gilles Peskine449bd832023-01-11 14:50:10 +01001330psa_status_t psa_export_key(mbedtls_svc_key_id_t key,
1331 uint8_t *data,
1332 size_t data_size,
1333 size_t *data_length)
Ronald Cron9486f9d2020-11-26 13:36:23 +01001334{
1335 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
1336 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
1337 psa_key_slot_t *slot;
1338
Ronald Crone907e552021-01-18 13:22:38 +01001339 /* Reject a zero-length output buffer now, since this can never be a
1340 * valid key representation. This way we know that data must be a valid
1341 * pointer and we can do things like memset(data, ..., data_size). */
Gilles Peskine449bd832023-01-11 14:50:10 +01001342 if (data_size == 0) {
1343 return PSA_ERROR_BUFFER_TOO_SMALL;
1344 }
Ronald Crone907e552021-01-18 13:22:38 +01001345
Ronald Cron9486f9d2020-11-26 13:36:23 +01001346 /* Set the key to empty now, so that even when there are errors, we always
1347 * set data_length to a value between 0 and data_size. On error, setting
1348 * the key to empty is a good choice because an empty key representation is
1349 * unlikely to be accepted anywhere. */
Jaeden Amerof24c7f82018-06-27 17:20:43 +01001350 *data_length = 0;
1351
Ronald Cron9486f9d2020-11-26 13:36:23 +01001352 /* Export requires the EXPORT flag. There is an exception for public keys,
1353 * which don't require any flag, but
1354 * psa_get_and_lock_key_slot_with_policy() takes care of this.
1355 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001356 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
1357 PSA_KEY_USAGE_EXPORT, 0);
1358 if (status != PSA_SUCCESS) {
1359 return status;
1360 }
mohammad160306e79202018-03-28 13:17:44 +03001361
Ronald Crond18b5f82020-11-25 16:46:05 +01001362 psa_key_attributes_t attributes = {
1363 .core = slot->attr
1364 };
Gilles Peskine449bd832023-01-11 14:50:10 +01001365 status = psa_driver_wrapper_export_key(&attributes,
1366 slot->key.data, slot->key.bytes,
1367 data, data_size, data_length);
Ronald Cron9486f9d2020-11-26 13:36:23 +01001368
Gilles Peskine449bd832023-01-11 14:50:10 +01001369 unlock_status = psa_unlock_key_slot(slot);
Ronald Cron9486f9d2020-11-26 13:36:23 +01001370
Gilles Peskine449bd832023-01-11 14:50:10 +01001371 return (status == PSA_SUCCESS) ? unlock_status : status;
Ronald Cron9486f9d2020-11-26 13:36:23 +01001372}
1373
Ronald Cron7285cda2020-11-26 14:46:37 +01001374psa_status_t psa_export_public_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001375 const psa_key_attributes_t *attributes,
1376 const uint8_t *key_buffer,
1377 size_t key_buffer_size,
1378 uint8_t *data,
1379 size_t data_size,
Gilles Peskine449bd832023-01-11 14:50:10 +01001380 size_t *data_length)
Ronald Cron9486f9d2020-11-26 13:36:23 +01001381{
Ronald Crond18b5f82020-11-25 16:46:05 +01001382 psa_key_type_t type = attributes->core.type;
Ronald Crond18b5f82020-11-25 16:46:05 +01001383
Przemek Stekiel6fd72b62023-04-27 10:20:56 +02001384 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(type) &&
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001385 (PSA_KEY_TYPE_IS_RSA(type) || PSA_KEY_TYPE_IS_ECC(type) ||
1386 PSA_KEY_TYPE_IS_DH(type))) {
Przemek Stekiel6fd72b62023-04-27 10:20:56 +02001387 /* Exporting public -> public */
1388 return psa_export_key_buffer_internal(
1389 key_buffer, key_buffer_size,
1390 data, data_size, data_length);
1391 } else if (PSA_KEY_TYPE_IS_RSA(type)) {
Valerio Settib2bcedb2023-07-10 11:24:00 +02001392#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT) || \
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001393 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
1394 return mbedtls_psa_rsa_export_public_key(attributes,
1395 key_buffer,
1396 key_buffer_size,
1397 data,
1398 data_size,
1399 data_length);
Darryl Green9e2d7a02018-07-24 16:33:30 +01001400#else
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001401 /* We don't know how to convert a private RSA key to public. */
1402 return PSA_ERROR_NOT_SUPPORTED;
Valerio Settib2bcedb2023-07-10 11:24:00 +02001403#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT) ||
John Durkop9814fa22020-11-04 12:28:15 -08001404 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Przemek Stekiel6fd72b62023-04-27 10:20:56 +02001405 } else if (PSA_KEY_TYPE_IS_ECC(type)) {
Valerio Setti27c501a2023-06-27 16:58:52 +02001406#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_EXPORT) || \
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001407 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
1408 return mbedtls_psa_ecp_export_public_key(attributes,
1409 key_buffer,
1410 key_buffer_size,
1411 data,
1412 data_size,
1413 data_length);
Steven Cooreman560c28a2020-07-24 23:20:24 +02001414#else
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001415 /* We don't know how to convert a private ECC key to public */
1416 return PSA_ERROR_NOT_SUPPORTED;
Valerio Setti27c501a2023-06-27 16:58:52 +02001417#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_EXPORT) ||
John Durkop9814fa22020-11-04 12:28:15 -08001418 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
Przemek Stekiel6fd72b62023-04-27 10:20:56 +02001419 } else if (PSA_KEY_TYPE_IS_DH(type)) {
Valerio Settia55f0422023-07-10 15:34:41 +02001420#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_EXPORT) || \
Przemek Stekiel6d85afa2023-04-28 11:42:17 +02001421 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY)
Przemek Stekiel152bb462023-06-01 11:52:39 +02001422 return mbedtls_psa_ffdh_export_public_key(attributes,
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001423 key_buffer,
1424 key_buffer_size,
1425 data, data_size,
1426 data_length);
Przemek Stekiel472b3f32022-12-01 14:38:49 +01001427#else
Przemek Stekiel472b3f32022-12-01 14:38:49 +01001428 return PSA_ERROR_NOT_SUPPORTED;
Valerio Settia55f0422023-07-10 15:34:41 +02001429#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_EXPORT) ||
Przemek Stekiel6d85afa2023-04-28 11:42:17 +02001430 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY) */
Gilles Peskine449bd832023-01-11 14:50:10 +01001431 } else {
Przemek Stekiel0b11ee02023-05-16 13:26:06 +02001432 (void) key_buffer;
1433 (void) key_buffer_size;
1434 (void) data;
1435 (void) data_size;
1436 (void) data_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01001437 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman560c28a2020-07-24 23:20:24 +02001438 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001439}
Ronald Crond18b5f82020-11-25 16:46:05 +01001440
Gilles Peskine449bd832023-01-11 14:50:10 +01001441psa_status_t psa_export_public_key(mbedtls_svc_key_id_t key,
1442 uint8_t *data,
1443 size_t data_size,
1444 size_t *data_length)
Moran Pekerdd4ea382018-04-03 15:30:03 +03001445{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001446 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001447 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001448 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01001449 psa_key_attributes_t attributes;
Darryl Greendd8fb772018-11-07 16:00:44 +00001450
Ronald Crone907e552021-01-18 13:22:38 +01001451 /* Reject a zero-length output buffer now, since this can never be a
1452 * valid key representation. This way we know that data must be a valid
1453 * pointer and we can do things like memset(data, ..., data_size). */
Gilles Peskine449bd832023-01-11 14:50:10 +01001454 if (data_size == 0) {
1455 return PSA_ERROR_BUFFER_TOO_SMALL;
1456 }
Ronald Crone907e552021-01-18 13:22:38 +01001457
Darryl Greendd8fb772018-11-07 16:00:44 +00001458 /* Set the key to empty now, so that even when there are errors, we always
1459 * set data_length to a value between 0 and data_size. On error, setting
1460 * the key to empty is a good choice because an empty key representation is
1461 * unlikely to be accepted anywhere. */
1462 *data_length = 0;
1463
1464 /* Exporting a public key doesn't require a usage flag. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001465 status = psa_get_and_lock_key_slot_with_policy(key, &slot, 0, 0);
1466 if (status != PSA_SUCCESS) {
1467 return status;
1468 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001469
Gilles Peskine449bd832023-01-11 14:50:10 +01001470 if (!PSA_KEY_TYPE_IS_ASYMMETRIC(slot->attr.type)) {
1471 status = PSA_ERROR_INVALID_ARGUMENT;
1472 goto exit;
Ronald Cron9486f9d2020-11-26 13:36:23 +01001473 }
1474
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01001475 attributes = (psa_key_attributes_t) {
Ronald Crond18b5f82020-11-25 16:46:05 +01001476 .core = slot->attr
1477 };
Ronald Cron67227982020-11-26 15:16:05 +01001478 status = psa_driver_wrapper_export_public_key(
Ronald Crond18b5f82020-11-25 16:46:05 +01001479 &attributes, slot->key.data, slot->key.bytes,
Gilles Peskine449bd832023-01-11 14:50:10 +01001480 data, data_size, data_length);
Ronald Cron9486f9d2020-11-26 13:36:23 +01001481
1482exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01001483 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02001484
Gilles Peskine449bd832023-01-11 14:50:10 +01001485 return (status == PSA_SUCCESS) ? unlock_status : status;
Moran Pekerdd4ea382018-04-03 15:30:03 +03001486}
1487
Tom Cosgrove6ef9bb32023-03-08 14:19:51 +00001488MBEDTLS_STATIC_ASSERT(
1489 (MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE) == 0,
1490 "One or more key attribute flag is listed as both external-only and dual-use")
1491MBEDTLS_STATIC_ASSERT(
1492 (PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE) == 0,
1493 "One or more key attribute flag is listed as both internal-only and dual-use")
1494MBEDTLS_STATIC_ASSERT(
1495 (PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY) == 0,
1496 "One or more key attribute flag is listed as both internal-only and external-only")
Gilles Peskine91e8c332019-08-02 19:19:39 +02001497
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001498/** Validate that a key policy is internally well-formed.
1499 *
1500 * This function only rejects invalid policies. It does not validate the
1501 * consistency of the policy with respect to other attributes of the key
1502 * such as the key type.
1503 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001504static psa_status_t psa_validate_key_policy(const psa_key_policy_t *policy)
Gilles Peskine4747d192019-04-17 15:05:45 +02001505{
Gilles Peskine449bd832023-01-11 14:50:10 +01001506 if ((policy->usage & ~(PSA_KEY_USAGE_EXPORT |
1507 PSA_KEY_USAGE_COPY |
1508 PSA_KEY_USAGE_ENCRYPT |
1509 PSA_KEY_USAGE_DECRYPT |
1510 PSA_KEY_USAGE_SIGN_MESSAGE |
1511 PSA_KEY_USAGE_VERIFY_MESSAGE |
1512 PSA_KEY_USAGE_SIGN_HASH |
1513 PSA_KEY_USAGE_VERIFY_HASH |
1514 PSA_KEY_USAGE_VERIFY_DERIVATION |
1515 PSA_KEY_USAGE_DERIVE)) != 0) {
1516 return PSA_ERROR_INVALID_ARGUMENT;
1517 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001518
Gilles Peskine449bd832023-01-11 14:50:10 +01001519 return PSA_SUCCESS;
Gilles Peskine4747d192019-04-17 15:05:45 +02001520}
1521
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001522/** Validate the internal consistency of key attributes.
1523 *
1524 * This function only rejects invalid attribute values. If does not
1525 * validate the consistency of the attributes with any key data that may
1526 * be involved in the creation of the key.
1527 *
1528 * Call this function early in the key creation process.
1529 *
1530 * \param[in] attributes Key attributes for the new key.
1531 * \param[out] p_drv On any return, the driver for the key, if any.
1532 * NULL for a transparent key.
1533 *
1534 */
1535static psa_status_t psa_validate_key_attributes(
1536 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01001537 psa_se_drv_table_entry_t **p_drv)
Darryl Green0c6575a2018-11-07 16:05:30 +00001538{
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001539 psa_status_t status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine449bd832023-01-11 14:50:10 +01001540 psa_key_lifetime_t lifetime = psa_get_key_lifetime(attributes);
1541 mbedtls_svc_key_id_t key = psa_get_key_id(attributes);
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001542
Gilles Peskine449bd832023-01-11 14:50:10 +01001543 status = psa_validate_key_location(lifetime, p_drv);
1544 if (status != PSA_SUCCESS) {
1545 return status;
Ronald Crond2ed4812020-07-17 16:11:30 +02001546 }
1547
Gilles Peskine449bd832023-01-11 14:50:10 +01001548 status = psa_validate_key_persistence(lifetime);
1549 if (status != PSA_SUCCESS) {
1550 return status;
1551 }
1552
1553 if (PSA_KEY_LIFETIME_IS_VOLATILE(lifetime)) {
1554 if (MBEDTLS_SVC_KEY_ID_GET_KEY_ID(key) != 0) {
1555 return PSA_ERROR_INVALID_ARGUMENT;
1556 }
1557 } else {
1558 if (!psa_is_valid_key_id(psa_get_key_id(attributes), 0)) {
1559 return PSA_ERROR_INVALID_ARGUMENT;
1560 }
1561 }
1562
1563 status = psa_validate_key_policy(&attributes->core.policy);
1564 if (status != PSA_SUCCESS) {
1565 return status;
1566 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001567
1568 /* Refuse to create overly large keys.
1569 * Note that this doesn't trigger on import if the attributes don't
1570 * explicitly specify a size (so psa_get_key_bits returns 0), so
1571 * psa_import_key() needs its own checks. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001572 if (psa_get_key_bits(attributes) > PSA_MAX_KEY_BITS) {
1573 return PSA_ERROR_NOT_SUPPORTED;
1574 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001575
Gilles Peskine91e8c332019-08-02 19:19:39 +02001576 /* Reject invalid flags. These should not be reachable through the API. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001577 if (attributes->core.flags & ~(MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1578 MBEDTLS_PSA_KA_MASK_DUAL_USE)) {
1579 return PSA_ERROR_INVALID_ARGUMENT;
1580 }
Gilles Peskine91e8c332019-08-02 19:19:39 +02001581
Gilles Peskine449bd832023-01-11 14:50:10 +01001582 return PSA_SUCCESS;
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001583}
1584
Gilles Peskine4747d192019-04-17 15:05:45 +02001585/** Prepare a key slot to receive key material.
1586 *
1587 * This function allocates a key slot and sets its metadata.
1588 *
1589 * If this function fails, call psa_fail_key_creation().
1590 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001591 * This function is intended to be used as follows:
1592 * -# Call psa_start_key_creation() to allocate a key slot, prepare
Ronald Croncf56a0a2020-08-04 09:51:30 +02001593 * it with the specified attributes, and in case of a volatile key assign it
1594 * a volatile key identifier.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001595 * -# Populate the slot with the key material.
1596 * -# Call psa_finish_key_creation() to finalize the creation of the slot.
1597 * In case of failure at any step, stop the sequence and call
1598 * psa_fail_key_creation().
1599 *
Ronald Cron5c522922020-11-14 16:35:34 +01001600 * On success, the key slot is locked. It is the responsibility of the caller
1601 * to unlock the key slot when it does not access it anymore.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001602 *
Gilles Peskinedf179142019-07-15 22:02:14 +02001603 * \param method An identification of the calling function.
Gilles Peskine011e4282019-06-26 18:34:38 +02001604 * \param[in] attributes Key attributes for the new key.
Gilles Peskine011e4282019-06-26 18:34:38 +02001605 * \param[out] p_slot On success, a pointer to the prepared slot.
1606 * \param[out] p_drv On any return, the driver for the key, if any.
1607 * NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001608 *
1609 * \retval #PSA_SUCCESS
1610 * The key slot is ready to receive key material.
1611 * \return If this function fails, the key slot is an invalid state.
1612 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001613 */
1614static psa_status_t psa_start_key_creation(
Gilles Peskinedf179142019-07-15 22:02:14 +02001615 psa_key_creation_method_t method,
Gilles Peskine4747d192019-04-17 15:05:45 +02001616 const psa_key_attributes_t *attributes,
Gilles Peskine011e4282019-06-26 18:34:38 +02001617 psa_key_slot_t **p_slot,
Gilles Peskine449bd832023-01-11 14:50:10 +01001618 psa_se_drv_table_entry_t **p_drv)
Gilles Peskine4747d192019-04-17 15:05:45 +02001619{
1620 psa_status_t status;
Ronald Cron2a993152020-07-17 14:13:26 +02001621 psa_key_id_t volatile_key_id;
Gilles Peskine4747d192019-04-17 15:05:45 +02001622 psa_key_slot_t *slot;
1623
Gilles Peskinedf179142019-07-15 22:02:14 +02001624 (void) method;
Gilles Peskine011e4282019-06-26 18:34:38 +02001625 *p_drv = NULL;
1626
Gilles Peskine449bd832023-01-11 14:50:10 +01001627 status = psa_validate_key_attributes(attributes, p_drv);
1628 if (status != PSA_SUCCESS) {
1629 return status;
1630 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001631
Gilles Peskine449bd832023-01-11 14:50:10 +01001632 status = psa_get_empty_key_slot(&volatile_key_id, p_slot);
1633 if (status != PSA_SUCCESS) {
1634 return status;
1635 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001636 slot = *p_slot;
1637
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001638 /* We're storing the declared bit-size of the key. It's up to each
1639 * creation mechanism to verify that this information is correct.
1640 * It's automatically correct for mechanisms that use the bit-size as
Gilles Peskineb46bef22019-07-30 21:32:04 +02001641 * an input (generate, device) but not for those where the bit-size
Ronald Cronc4d1b512020-07-31 11:26:37 +02001642 * is optional (import, copy). In case of a volatile key, assign it the
1643 * volatile key identifier associated to the slot returned to contain its
1644 * definition. */
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001645
1646 slot->attr = attributes->core;
Gilles Peskine449bd832023-01-11 14:50:10 +01001647 if (PSA_KEY_LIFETIME_IS_VOLATILE(slot->attr.lifetime)) {
Ronald Cronc4d1b512020-07-31 11:26:37 +02001648#if !defined(MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER)
1649 slot->attr.id = volatile_key_id;
1650#else
1651 slot->attr.id.key_id = volatile_key_id;
1652#endif
1653 }
Gilles Peskinec744d992019-07-30 17:26:54 +02001654
Gilles Peskine91e8c332019-08-02 19:19:39 +02001655 /* Erase external-only flags from the internal copy. To access
Gilles Peskine013f5472019-08-07 15:42:14 +02001656 * external-only flags, query `attributes`. Thanks to the check
1657 * in psa_validate_key_attributes(), this leaves the dual-use
Gilles Peskineedbed562019-08-07 18:19:59 +02001658 * flags and any internal flag that psa_get_empty_key_slot()
Gilles Peskine013f5472019-08-07 15:42:14 +02001659 * may have set. */
1660 slot->attr.flags &= ~MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY;
Gilles Peskine91e8c332019-08-02 19:19:39 +02001661
Gilles Peskinecbaff462019-07-12 23:46:04 +02001662#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001663 /* For a key in a secure element, we need to do three things
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001664 * when creating or registering a persistent key:
Gilles Peskine60450a42019-07-25 11:32:45 +02001665 * create the key file in internal storage, create the
1666 * key inside the secure element, and update the driver's
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001667 * persistent data. This is done by starting a transaction that will
1668 * encompass these three actions.
1669 * For registering a volatile key, we just need to find an appropriate
1670 * slot number inside the SE. Since the key is designated volatile, creating
1671 * a transaction is not required. */
Gilles Peskine60450a42019-07-25 11:32:45 +02001672 /* The first thing to do is to find a slot number for the new key.
1673 * We save the slot number in persistent storage as part of the
1674 * transaction data. It will be needed to recover if the power
1675 * fails during the key creation process, to clean up on the secure
1676 * element side after restarting. Obtaining a slot number from the
1677 * secure element driver updates its persistent state, but we do not yet
1678 * save the driver's persistent state, so that if the power fails,
Gilles Peskinefc762652019-07-22 19:30:34 +02001679 * we can roll back to a state where the key doesn't exist. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001680 if (*p_drv != NULL) {
Ronald Cronea0f8a62020-11-25 17:52:23 +01001681 psa_key_slot_number_t slot_number;
Gilles Peskine449bd832023-01-11 14:50:10 +01001682 status = psa_find_se_slot_for_key(attributes, method, *p_drv,
1683 &slot_number);
1684 if (status != PSA_SUCCESS) {
1685 return status;
1686 }
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001687
Gilles Peskine449bd832023-01-11 14:50:10 +01001688 if (!PSA_KEY_LIFETIME_IS_VOLATILE(attributes->core.lifetime)) {
1689 psa_crypto_prepare_transaction(PSA_CRYPTO_TRANSACTION_CREATE_KEY);
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001690 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001691 psa_crypto_transaction.key.slot = slot_number;
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001692 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskine449bd832023-01-11 14:50:10 +01001693 status = psa_crypto_save_transaction();
1694 if (status != PSA_SUCCESS) {
1695 (void) psa_crypto_stop_transaction();
1696 return status;
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001697 }
Gilles Peskine66be51c2019-07-25 18:02:52 +02001698 }
Ronald Cronea0f8a62020-11-25 17:52:23 +01001699
1700 status = psa_copy_key_material_into_slot(
Gilles Peskine449bd832023-01-11 14:50:10 +01001701 slot, (uint8_t *) (&slot_number), sizeof(slot_number));
Darryl Green0c6575a2018-11-07 16:05:30 +00001702 }
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001703
Gilles Peskine449bd832023-01-11 14:50:10 +01001704 if (*p_drv == NULL && method == PSA_KEY_CREATION_REGISTER) {
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001705 /* Key registration only makes sense with a secure element. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001706 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001707 }
Gilles Peskinecbaff462019-07-12 23:46:04 +02001708#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1709
Ryan Everett975d4112023-11-16 13:37:51 +00001710 slot->status = PSA_SLOT_OCCUPIED;
1711
Gilles Peskine449bd832023-01-11 14:50:10 +01001712 return PSA_SUCCESS;
Darryl Green0c6575a2018-11-07 16:05:30 +00001713}
Gilles Peskine4747d192019-04-17 15:05:45 +02001714
1715/** Finalize the creation of a key once its key material has been set.
1716 *
1717 * This entails writing the key to persistent storage.
1718 *
1719 * If this function fails, call psa_fail_key_creation().
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001720 * See the documentation of psa_start_key_creation() for the intended use
1721 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001722 *
Ronald Cron5c522922020-11-14 16:35:34 +01001723 * If the finalization succeeds, the function unlocks the key slot (it was
1724 * locked by psa_start_key_creation()) and the key slot cannot be accessed
1725 * anymore as part of the key creation process.
Ronald Cron50972942020-11-14 11:28:25 +01001726 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001727 * \param[in,out] slot Pointer to the slot with key material.
1728 * \param[in] driver The secure element driver for the key,
1729 * or NULL for a transparent key.
Ronald Cron81709fc2020-11-14 12:10:32 +01001730 * \param[out] key On success, identifier of the key. Note that the
1731 * key identifier is also stored in the key slot.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001732 *
1733 * \retval #PSA_SUCCESS
Ronald Croncf56a0a2020-08-04 09:51:30 +02001734 * The key was successfully created.
Gilles Peskineed733552023-02-14 19:21:09 +01001735 * \retval #PSA_ERROR_INSUFFICIENT_MEMORY \emptydescription
1736 * \retval #PSA_ERROR_INSUFFICIENT_STORAGE \emptydescription
1737 * \retval #PSA_ERROR_ALREADY_EXISTS \emptydescription
1738 * \retval #PSA_ERROR_DATA_INVALID \emptydescription
1739 * \retval #PSA_ERROR_DATA_CORRUPT \emptydescription
1740 * \retval #PSA_ERROR_STORAGE_FAILURE \emptydescription
gabor-mezei-arm452b0a32020-11-09 17:42:55 +01001741 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001742 * \return If this function fails, the key slot is an invalid state.
1743 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001744 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001745static psa_status_t psa_finish_key_creation(
1746 psa_key_slot_t *slot,
Ronald Cron81709fc2020-11-14 12:10:32 +01001747 psa_se_drv_table_entry_t *driver,
1748 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02001749{
1750 psa_status_t status = PSA_SUCCESS;
Gilles Peskine30afafd2019-04-25 13:47:40 +02001751 (void) slot;
Gilles Peskine011e4282019-06-26 18:34:38 +02001752 (void) driver;
Gilles Peskine4747d192019-04-17 15:05:45 +02001753
1754#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001755 if (!PSA_KEY_LIFETIME_IS_VOLATILE(slot->attr.lifetime)) {
Gilles Peskine1df83d42019-07-23 16:13:14 +02001756#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001757 if (driver != NULL) {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001758 psa_se_key_data_storage_t data;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001759 psa_key_slot_number_t slot_number =
Gilles Peskine449bd832023-01-11 14:50:10 +01001760 psa_key_slot_get_slot_number(slot);
Ronald Cronea0f8a62020-11-25 17:52:23 +01001761
Tom Cosgrove6ef9bb32023-03-08 14:19:51 +00001762 MBEDTLS_STATIC_ASSERT(sizeof(slot_number) ==
1763 sizeof(data.slot_number),
1764 "Slot number size does not match psa_se_key_data_storage_t");
1765
Gilles Peskine449bd832023-01-11 14:50:10 +01001766 memcpy(&data.slot_number, &slot_number, sizeof(slot_number));
1767 status = psa_save_persistent_key(&slot->attr,
1768 (uint8_t *) &data,
1769 sizeof(data));
1770 } else
Gilles Peskine1df83d42019-07-23 16:13:14 +02001771#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1772 {
Steven Cooreman40120f62020-10-29 11:42:22 +01001773 /* Key material is saved in export representation in the slot, so
1774 * just pass the slot buffer for storage. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001775 status = psa_save_persistent_key(&slot->attr,
1776 slot->key.data,
1777 slot->key.bytes);
Gilles Peskine1df83d42019-07-23 16:13:14 +02001778 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001779 }
Darryl Green0c6575a2018-11-07 16:05:30 +00001780#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
1781
Gilles Peskinecbaff462019-07-12 23:46:04 +02001782#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001783 /* Finish the transaction for a key creation. This does not
1784 * happen when registering an existing key. Detect this case
1785 * by checking whether a transaction is in progress (actual
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001786 * creation of a persistent key in a secure element requires a transaction,
1787 * but registration or volatile key creation doesn't use one). */
Gilles Peskine449bd832023-01-11 14:50:10 +01001788 if (driver != NULL &&
1789 psa_crypto_transaction.unknown.type == PSA_CRYPTO_TRANSACTION_CREATE_KEY) {
1790 status = psa_save_se_persistent_data(driver);
1791 if (status != PSA_SUCCESS) {
1792 psa_destroy_persistent_key(slot->attr.id);
1793 return status;
Gilles Peskinecbaff462019-07-12 23:46:04 +02001794 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001795 status = psa_crypto_stop_transaction();
Gilles Peskinecbaff462019-07-12 23:46:04 +02001796 }
1797#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1798
Gilles Peskine449bd832023-01-11 14:50:10 +01001799 if (status == PSA_SUCCESS) {
Ronald Cron81709fc2020-11-14 12:10:32 +01001800 *key = slot->attr.id;
Gilles Peskine449bd832023-01-11 14:50:10 +01001801 status = psa_unlock_key_slot(slot);
1802 if (status != PSA_SUCCESS) {
Ronald Cron81709fc2020-11-14 12:10:32 +01001803 *key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01001804 }
Ronald Cron81709fc2020-11-14 12:10:32 +01001805 }
Ronald Cron50972942020-11-14 11:28:25 +01001806
Gilles Peskine449bd832023-01-11 14:50:10 +01001807 return status;
Gilles Peskine4747d192019-04-17 15:05:45 +02001808}
1809
1810/** Abort the creation of a key.
1811 *
1812 * You may call this function after calling psa_start_key_creation(),
1813 * or after psa_finish_key_creation() fails. In other circumstances, this
1814 * function may not clean up persistent storage.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001815 * See the documentation of psa_start_key_creation() for the intended use
1816 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001817 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001818 * \param[in,out] slot Pointer to the slot with key material.
1819 * \param[in] driver The secure element driver for the key,
1820 * or NULL for a transparent key.
Gilles Peskine4747d192019-04-17 15:05:45 +02001821 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001822static void psa_fail_key_creation(psa_key_slot_t *slot,
1823 psa_se_drv_table_entry_t *driver)
Gilles Peskine4747d192019-04-17 15:05:45 +02001824{
Gilles Peskine011e4282019-06-26 18:34:38 +02001825 (void) driver;
1826
Gilles Peskine449bd832023-01-11 14:50:10 +01001827 if (slot == NULL) {
Gilles Peskine4747d192019-04-17 15:05:45 +02001828 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01001829 }
Gilles Peskine011e4282019-06-26 18:34:38 +02001830
1831#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001832 /* TODO: If the key has already been created in the secure
Gilles Peskine011e4282019-06-26 18:34:38 +02001833 * element, and the failure happened later (when saving metadata
1834 * to internal storage), we need to destroy the key in the secure
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001835 * element.
1836 * https://github.com/ARMmbed/mbed-crypto/issues/217
1837 */
Gilles Peskinefc762652019-07-22 19:30:34 +02001838
Gilles Peskined7729582019-08-05 15:55:54 +02001839 /* Abort the ongoing transaction if any (there may not be one if
1840 * the creation process failed before starting one, or if the
1841 * key creation is a registration of a key in a secure element).
1842 * Earlier functions must already have done what it takes to undo any
1843 * partial creation. All that's left is to update the transaction data
1844 * itself. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001845 (void) psa_crypto_stop_transaction();
Gilles Peskine011e4282019-06-26 18:34:38 +02001846#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1847
Gilles Peskine449bd832023-01-11 14:50:10 +01001848 psa_wipe_key_slot(slot);
Gilles Peskine4747d192019-04-17 15:05:45 +02001849}
1850
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001851/** Validate optional attributes during key creation.
1852 *
1853 * Some key attributes are optional during key creation. If they are
1854 * specified in the attributes structure, check that they are consistent
1855 * with the data in the slot.
1856 *
1857 * This function should be called near the end of key creation, after
1858 * the slot in memory is fully populated but before saving persistent data.
1859 */
1860static psa_status_t psa_validate_optional_attributes(
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001861 const psa_key_slot_t *slot,
Gilles Peskine449bd832023-01-11 14:50:10 +01001862 const psa_key_attributes_t *attributes)
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001863{
Gilles Peskine449bd832023-01-11 14:50:10 +01001864 if (attributes->core.type != 0) {
1865 if (attributes->core.type != slot->attr.type) {
1866 return PSA_ERROR_INVALID_ARGUMENT;
1867 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001868 }
1869
Gilles Peskine449bd832023-01-11 14:50:10 +01001870 if (attributes->domain_parameters_size != 0) {
Valerio Settib2bcedb2023-07-10 11:24:00 +02001871#if (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) && \
1872 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01001873 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
1874 if (PSA_KEY_TYPE_IS_RSA(slot->attr.type)) {
Steven Cooremana2371e52020-07-28 14:30:39 +02001875 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman75b74362020-07-28 14:30:13 +02001876 mbedtls_mpi actual, required;
Steven Cooreman6d839f02020-07-30 11:36:45 +02001877 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooremana01795d2020-07-24 22:48:15 +02001878
Ronald Cron90857082020-11-25 14:58:33 +01001879 psa_status_t status = mbedtls_psa_rsa_load_representation(
Gilles Peskine449bd832023-01-11 14:50:10 +01001880 slot->attr.type,
1881 slot->key.data,
1882 slot->key.bytes,
1883 &rsa);
1884 if (status != PSA_SUCCESS) {
1885 return status;
1886 }
Steven Cooreman75b74362020-07-28 14:30:13 +02001887
Gilles Peskine449bd832023-01-11 14:50:10 +01001888 mbedtls_mpi_init(&actual);
1889 mbedtls_mpi_init(&required);
1890 ret = mbedtls_rsa_export(rsa,
1891 NULL, NULL, NULL, NULL, &actual);
1892 mbedtls_rsa_free(rsa);
1893 mbedtls_free(rsa);
1894 if (ret != 0) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001895 goto rsa_exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001896 }
1897 ret = mbedtls_mpi_read_binary(&required,
1898 attributes->domain_parameters,
1899 attributes->domain_parameters_size);
1900 if (ret != 0) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001901 goto rsa_exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001902 }
1903 if (mbedtls_mpi_cmp_mpi(&actual, &required) != 0) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001904 ret = MBEDTLS_ERR_RSA_BAD_INPUT_DATA;
Gilles Peskine449bd832023-01-11 14:50:10 +01001905 }
1906rsa_exit:
1907 mbedtls_mpi_free(&actual);
1908 mbedtls_mpi_free(&required);
1909 if (ret != 0) {
1910 return mbedtls_to_psa_error(ret);
1911 }
1912 } else
Valerio Settib2bcedb2023-07-10 11:24:00 +02001913#endif /* (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) &&
1914 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) ||
John Durkop9814fa22020-11-04 12:28:15 -08001915 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001916 {
Gilles Peskine449bd832023-01-11 14:50:10 +01001917 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001918 }
1919 }
1920
Gilles Peskine449bd832023-01-11 14:50:10 +01001921 if (attributes->core.bits != 0) {
1922 if (attributes->core.bits != slot->attr.bits) {
1923 return PSA_ERROR_INVALID_ARGUMENT;
1924 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001925 }
1926
Gilles Peskine449bd832023-01-11 14:50:10 +01001927 return PSA_SUCCESS;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001928}
1929
Gilles Peskine449bd832023-01-11 14:50:10 +01001930psa_status_t psa_import_key(const psa_key_attributes_t *attributes,
1931 const uint8_t *data,
1932 size_t data_length,
1933 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02001934{
1935 psa_status_t status;
1936 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001937 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001938 size_t bits;
Archanad8a83dc2021-06-14 10:04:16 +05301939 size_t storage_size = data_length;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001940
Ronald Cron81709fc2020-11-14 12:10:32 +01001941 *key = MBEDTLS_SVC_KEY_ID_INIT;
1942
Gilles Peskine0f84d622019-09-12 19:03:13 +02001943 /* Reject zero-length symmetric keys (including raw data key objects).
1944 * This also rejects any key which might be encoded as an empty string,
1945 * which is never valid. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001946 if (data_length == 0) {
1947 return PSA_ERROR_INVALID_ARGUMENT;
1948 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02001949
Archana449608b2021-09-08 15:36:05 +05301950 /* Ensure that the bytes-to-bits conversion cannot overflow. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001951 if (data_length > SIZE_MAX / 8) {
1952 return PSA_ERROR_NOT_SUPPORTED;
1953 }
Archana6ed4bda2021-08-04 10:47:15 +05301954
Gilles Peskine449bd832023-01-11 14:50:10 +01001955 status = psa_start_key_creation(PSA_KEY_CREATION_IMPORT, attributes,
1956 &slot, &driver);
1957 if (status != PSA_SUCCESS) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001958 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001959 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001960
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001961 /* In the case of a transparent key or an opaque key stored in local
Archana449608b2021-09-08 15:36:05 +05301962 * storage ( thus not in the case of importing a key in a secure element
1963 * with storage ( MBEDTLS_PSA_CRYPTO_SE_C ) ),we have to allocate a
1964 * buffer to hold the imported key material. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001965 if (slot->key.data == NULL) {
1966 if (psa_key_lifetime_is_external(attributes->core.lifetime)) {
Archana449608b2021-09-08 15:36:05 +05301967 status = psa_driver_wrapper_get_key_buffer_size_from_key_data(
Gilles Peskine449bd832023-01-11 14:50:10 +01001968 attributes, data, data_length, &storage_size);
1969 if (status != PSA_SUCCESS) {
Archanad8a83dc2021-06-14 10:04:16 +05301970 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001971 }
Archanad8a83dc2021-06-14 10:04:16 +05301972 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001973 status = psa_allocate_buffer_to_slot(slot, storage_size);
1974 if (status != PSA_SUCCESS) {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001975 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001976 }
Gilles Peskine5d309672019-07-12 23:47:28 +02001977 }
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001978
1979 bits = slot->attr.bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01001980 status = psa_driver_wrapper_import_key(attributes,
1981 data, data_length,
1982 slot->key.data,
1983 slot->key.bytes,
1984 &slot->key.bytes, &bits);
1985 if (status != PSA_SUCCESS) {
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001986 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001987 }
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001988
Gilles Peskine449bd832023-01-11 14:50:10 +01001989 if (slot->attr.bits == 0) {
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001990 slot->attr.bits = (psa_key_bits_t) bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01001991 } else if (bits != slot->attr.bits) {
Steven Cooremanac3434f2021-01-15 17:36:02 +01001992 status = PSA_ERROR_INVALID_ARGUMENT;
1993 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02001994 }
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01001995
Archana6ed4bda2021-08-04 10:47:15 +05301996 /* Enforce a size limit, and in particular ensure that the bit
1997 * size fits in its representation type.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01001998 if (bits > PSA_MAX_KEY_BITS) {
Archana6ed4bda2021-08-04 10:47:15 +05301999 status = PSA_ERROR_NOT_SUPPORTED;
2000 goto exit;
2001 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002002 status = psa_validate_optional_attributes(slot, attributes);
2003 if (status != PSA_SUCCESS) {
Gilles Peskine18017402019-07-24 20:25:59 +02002004 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002005 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002006
Gilles Peskine449bd832023-01-11 14:50:10 +01002007 status = psa_finish_key_creation(slot, driver, key);
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002008exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002009 if (status != PSA_SUCCESS) {
2010 psa_fail_key_creation(slot, driver);
2011 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002012
Gilles Peskine449bd832023-01-11 14:50:10 +01002013 return status;
Gilles Peskine4747d192019-04-17 15:05:45 +02002014}
2015
Gilles Peskined7729582019-08-05 15:55:54 +02002016#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2017psa_status_t mbedtls_psa_register_se_key(
Gilles Peskine449bd832023-01-11 14:50:10 +01002018 const psa_key_attributes_t *attributes)
Gilles Peskined7729582019-08-05 15:55:54 +02002019{
2020 psa_status_t status;
2021 psa_key_slot_t *slot = NULL;
2022 psa_se_drv_table_entry_t *driver = NULL;
Ronald Croncf56a0a2020-08-04 09:51:30 +02002023 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskined7729582019-08-05 15:55:54 +02002024
2025 /* Leaving attributes unspecified is not currently supported.
2026 * It could make sense to query the key type and size from the
2027 * secure element, but not all secure elements support this
2028 * and the driver HAL doesn't currently support it. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002029 if (psa_get_key_type(attributes) == PSA_KEY_TYPE_NONE) {
2030 return PSA_ERROR_NOT_SUPPORTED;
2031 }
2032 if (psa_get_key_bits(attributes) == 0) {
2033 return PSA_ERROR_NOT_SUPPORTED;
2034 }
Gilles Peskined7729582019-08-05 15:55:54 +02002035
Gilles Peskine449bd832023-01-11 14:50:10 +01002036 status = psa_start_key_creation(PSA_KEY_CREATION_REGISTER, attributes,
2037 &slot, &driver);
2038 if (status != PSA_SUCCESS) {
Gilles Peskined7729582019-08-05 15:55:54 +02002039 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002040 }
Gilles Peskined7729582019-08-05 15:55:54 +02002041
Gilles Peskine449bd832023-01-11 14:50:10 +01002042 status = psa_finish_key_creation(slot, driver, &key);
Gilles Peskined7729582019-08-05 15:55:54 +02002043
2044exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002045 if (status != PSA_SUCCESS) {
2046 psa_fail_key_creation(slot, driver);
2047 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002048
Gilles Peskined7729582019-08-05 15:55:54 +02002049 /* Registration doesn't keep the key in RAM. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002050 psa_close_key(key);
2051 return status;
Gilles Peskined7729582019-08-05 15:55:54 +02002052}
2053#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2054
Gilles Peskine449bd832023-01-11 14:50:10 +01002055psa_status_t psa_copy_key(mbedtls_svc_key_id_t source_key,
2056 const psa_key_attributes_t *specified_attributes,
2057 mbedtls_svc_key_id_t *target_key)
Gilles Peskinef603c712019-01-19 13:40:11 +01002058{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002059 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01002060 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinef603c712019-01-19 13:40:11 +01002061 psa_key_slot_t *source_slot = NULL;
2062 psa_key_slot_t *target_slot = NULL;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002063 psa_key_attributes_t actual_attributes = *specified_attributes;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002064 psa_se_drv_table_entry_t *driver = NULL;
Archana8a180362021-07-05 02:18:48 +05302065 size_t storage_size = 0;
Gilles Peskinef603c712019-01-19 13:40:11 +01002066
Ronald Cron81709fc2020-11-14 12:10:32 +01002067 *target_key = MBEDTLS_SVC_KEY_ID_INIT;
2068
Archana8a180362021-07-05 02:18:48 +05302069 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002070 source_key, &source_slot, PSA_KEY_USAGE_COPY, 0);
2071 if (status != PSA_SUCCESS) {
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002072 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002073 }
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002074
Gilles Peskine449bd832023-01-11 14:50:10 +01002075 status = psa_validate_optional_attributes(source_slot,
2076 specified_attributes);
2077 if (status != PSA_SUCCESS) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002078 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002079 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002080
Archana9d17bf42021-09-10 06:22:44 +05302081 /* The target key type and number of bits have been validated by
2082 * psa_validate_optional_attributes() to be either equal to zero or
2083 * equal to the ones of the source key. So it is safe to inherit
2084 * them from the source key now."
Archana374fe5b2021-09-08 15:50:28 +05302085 * */
Archana9d17bf42021-09-10 06:22:44 +05302086 actual_attributes.core.bits = source_slot->attr.bits;
2087 actual_attributes.core.type = source_slot->attr.type;
Archana374fe5b2021-09-08 15:50:28 +05302088
2089
Gilles Peskine449bd832023-01-11 14:50:10 +01002090 status = psa_restrict_key_policy(source_slot->attr.type,
2091 &actual_attributes.core.policy,
2092 &source_slot->attr.policy);
2093 if (status != PSA_SUCCESS) {
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002094 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002095 }
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002096
Gilles Peskine449bd832023-01-11 14:50:10 +01002097 status = psa_start_key_creation(PSA_KEY_CREATION_COPY, &actual_attributes,
2098 &target_slot, &driver);
2099 if (status != PSA_SUCCESS) {
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002100 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002101 }
2102 if (PSA_KEY_LIFETIME_GET_LOCATION(target_slot->attr.lifetime) !=
2103 PSA_KEY_LIFETIME_GET_LOCATION(source_slot->attr.lifetime)) {
Archana8a180362021-07-05 02:18:48 +05302104 /*
Archana9d17bf42021-09-10 06:22:44 +05302105 * If the source and target keys are stored in different locations,
Archana8a180362021-07-05 02:18:48 +05302106 * the source key would need to be exported as plaintext and re-imported
2107 * in the other location. This has security implications which have not
Archana449608b2021-09-08 15:36:05 +05302108 * been fully mapped. For now, this can be achieved through
Archana8a180362021-07-05 02:18:48 +05302109 * appropriate API invocations from the application, if needed.
2110 * */
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002111 status = PSA_ERROR_NOT_SUPPORTED;
2112 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002113 }
Archana8a180362021-07-05 02:18:48 +05302114 /*
2115 * When the source and target keys are within the same location,
Archana449608b2021-09-08 15:36:05 +05302116 * - For transparent keys it is a blind copy without any driver invocation,
Archana8a180362021-07-05 02:18:48 +05302117 * - For opaque keys this translates to an invocation of the drivers'
2118 * copy_key entry point through the dispatch layer.
2119 * */
Gilles Peskine449bd832023-01-11 14:50:10 +01002120 if (psa_key_lifetime_is_external(actual_attributes.core.lifetime)) {
2121 status = psa_driver_wrapper_get_key_buffer_size(&actual_attributes,
2122 &storage_size);
2123 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302124 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002125 }
Archana374fe5b2021-09-08 15:50:28 +05302126
Gilles Peskine449bd832023-01-11 14:50:10 +01002127 status = psa_allocate_buffer_to_slot(target_slot, storage_size);
2128 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302129 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002130 }
Archana374fe5b2021-09-08 15:50:28 +05302131
Gilles Peskine449bd832023-01-11 14:50:10 +01002132 status = psa_driver_wrapper_copy_key(&actual_attributes,
2133 source_slot->key.data,
2134 source_slot->key.bytes,
2135 target_slot->key.data,
2136 target_slot->key.bytes,
2137 &target_slot->key.bytes);
2138 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302139 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002140 }
2141 } else {
2142 status = psa_copy_key_material_into_slot(target_slot,
Archana9d17bf42021-09-10 06:22:44 +05302143 source_slot->key.data,
Gilles Peskine449bd832023-01-11 14:50:10 +01002144 source_slot->key.bytes);
2145 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302146 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002147 }
Archana8a180362021-07-05 02:18:48 +05302148 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002149 status = psa_finish_key_creation(target_slot, driver, target_key);
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002150exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002151 if (status != PSA_SUCCESS) {
2152 psa_fail_key_creation(target_slot, driver);
2153 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002154
Gilles Peskine449bd832023-01-11 14:50:10 +01002155 unlock_status = psa_unlock_key_slot(source_slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02002156
Gilles Peskine449bd832023-01-11 14:50:10 +01002157 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskinef603c712019-01-19 13:40:11 +01002158}
2159
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02002160
2161
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01002162/****************************************************************/
Gilles Peskine20035e32018-02-03 22:44:14 +01002163/* Message digests */
2164/****************************************************************/
2165
Gilles Peskine449bd832023-01-11 14:50:10 +01002166psa_status_t psa_hash_abort(psa_hash_operation_t *operation)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002167{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002168 /* Aborting a non-active operation is allowed */
Gilles Peskine449bd832023-01-11 14:50:10 +01002169 if (operation->id == 0) {
2170 return PSA_SUCCESS;
2171 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002172
Gilles Peskine449bd832023-01-11 14:50:10 +01002173 psa_status_t status = psa_driver_wrapper_hash_abort(operation);
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002174 operation->id = 0;
2175
Gilles Peskine449bd832023-01-11 14:50:10 +01002176 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002177}
2178
Gilles Peskine449bd832023-01-11 14:50:10 +01002179psa_status_t psa_hash_setup(psa_hash_operation_t *operation,
2180 psa_algorithm_t alg)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002181{
Dave Rodgman685b6a72021-06-24 11:49:14 +01002182 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002183
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002184 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002185 if (operation->id != 0) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002186 status = PSA_ERROR_BAD_STATE;
2187 goto exit;
2188 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002189
Gilles Peskine449bd832023-01-11 14:50:10 +01002190 if (!PSA_ALG_IS_HASH(alg)) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002191 status = PSA_ERROR_INVALID_ARGUMENT;
2192 goto exit;
2193 }
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002194
Steven Cooremanb6bf4bb2021-03-15 19:00:14 +01002195 /* Ensure all of the context is zeroized, since PSA_HASH_OPERATION_INIT only
2196 * directly zeroes the int-sized dummy member of the context union. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002197 memset(&operation->ctx, 0, sizeof(operation->ctx));
Steven Cooreman893232f2021-03-15 12:23:37 +01002198
Gilles Peskine449bd832023-01-11 14:50:10 +01002199 status = psa_driver_wrapper_hash_setup(operation, alg);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002200
2201exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002202 if (status != PSA_SUCCESS) {
2203 psa_hash_abort(operation);
2204 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002205
2206 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002207}
2208
Gilles Peskine449bd832023-01-11 14:50:10 +01002209psa_status_t psa_hash_update(psa_hash_operation_t *operation,
2210 const uint8_t *input,
2211 size_t input_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002212{
Dave Rodgman685b6a72021-06-24 11:49:14 +01002213 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2214
Gilles Peskine449bd832023-01-11 14:50:10 +01002215 if (operation->id == 0) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002216 status = PSA_ERROR_BAD_STATE;
2217 goto exit;
2218 }
Gilles Peskine94e44542018-07-12 16:58:43 +02002219
Steven Cooremanc8288352021-03-04 14:02:19 +01002220 /* Don't require hash implementations to behave correctly on a
2221 * zero-length input, which may have an invalid pointer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002222 if (input_length == 0) {
2223 return PSA_SUCCESS;
2224 }
Steven Cooremanc8288352021-03-04 14:02:19 +01002225
Gilles Peskine449bd832023-01-11 14:50:10 +01002226 status = psa_driver_wrapper_hash_update(operation, input, input_length);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002227
2228exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002229 if (status != PSA_SUCCESS) {
2230 psa_hash_abort(operation);
2231 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002232
Gilles Peskine449bd832023-01-11 14:50:10 +01002233 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002234}
2235
Gilles Peskine449bd832023-01-11 14:50:10 +01002236psa_status_t psa_hash_finish(psa_hash_operation_t *operation,
2237 uint8_t *hash,
2238 size_t hash_size,
2239 size_t *hash_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002240{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002241 *hash_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002242 if (operation->id == 0) {
2243 return PSA_ERROR_BAD_STATE;
2244 }
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002245
Steven Cooreman1e582352021-02-18 17:24:37 +01002246 psa_status_t status = psa_driver_wrapper_hash_finish(
Gilles Peskine449bd832023-01-11 14:50:10 +01002247 operation, hash, hash_size, hash_length);
2248 psa_hash_abort(operation);
2249 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002250}
2251
Gilles Peskine449bd832023-01-11 14:50:10 +01002252psa_status_t psa_hash_verify(psa_hash_operation_t *operation,
2253 const uint8_t *hash,
2254 size_t hash_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002255{
Ronald Cron69a63422021-10-18 09:47:58 +02002256 uint8_t actual_hash[PSA_HASH_MAX_SIZE];
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002257 size_t actual_hash_length;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002258 psa_status_t status = psa_hash_finish(
Gilles Peskine449bd832023-01-11 14:50:10 +01002259 operation,
2260 actual_hash, sizeof(actual_hash),
2261 &actual_hash_length);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002262
Gilles Peskine449bd832023-01-11 14:50:10 +01002263 if (status != PSA_SUCCESS) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002264 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002265 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002266
Gilles Peskine449bd832023-01-11 14:50:10 +01002267 if (actual_hash_length != hash_length) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002268 status = PSA_ERROR_INVALID_SIGNATURE;
2269 goto exit;
2270 }
2271
Dave Rodgman78701152023-08-29 14:20:18 +01002272 if (mbedtls_ct_memcmp(hash, actual_hash, actual_hash_length) != 0) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002273 status = PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01002274 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002275
2276exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002277 mbedtls_platform_zeroize(actual_hash, sizeof(actual_hash));
2278 if (status != PSA_SUCCESS) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002279 psa_hash_abort(operation);
Gilles Peskine449bd832023-01-11 14:50:10 +01002280 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002281
Gilles Peskine449bd832023-01-11 14:50:10 +01002282 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002283}
2284
Gilles Peskine449bd832023-01-11 14:50:10 +01002285psa_status_t psa_hash_compute(psa_algorithm_t alg,
2286 const uint8_t *input, size_t input_length,
2287 uint8_t *hash, size_t hash_size,
2288 size_t *hash_length)
Gilles Peskine0a749c82019-11-28 19:33:58 +01002289{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002290 *hash_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002291 if (!PSA_ALG_IS_HASH(alg)) {
2292 return PSA_ERROR_INVALID_ARGUMENT;
2293 }
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002294
Gilles Peskine449bd832023-01-11 14:50:10 +01002295 return psa_driver_wrapper_hash_compute(alg, input, input_length,
2296 hash, hash_size, hash_length);
Gilles Peskine0a749c82019-11-28 19:33:58 +01002297}
2298
Gilles Peskine449bd832023-01-11 14:50:10 +01002299psa_status_t psa_hash_compare(psa_algorithm_t alg,
2300 const uint8_t *input, size_t input_length,
2301 const uint8_t *hash, size_t hash_length)
Gilles Peskine0a749c82019-11-28 19:33:58 +01002302{
Ronald Cron69a63422021-10-18 09:47:58 +02002303 uint8_t actual_hash[PSA_HASH_MAX_SIZE];
Steven Cooreman84d670d2021-02-18 16:22:53 +01002304 size_t actual_hash_length;
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002305
Gilles Peskine449bd832023-01-11 14:50:10 +01002306 if (!PSA_ALG_IS_HASH(alg)) {
2307 return PSA_ERROR_INVALID_ARGUMENT;
2308 }
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002309
Steven Cooreman1e582352021-02-18 17:24:37 +01002310 psa_status_t status = psa_driver_wrapper_hash_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01002311 alg, input, input_length,
2312 actual_hash, sizeof(actual_hash),
2313 &actual_hash_length);
2314 if (status != PSA_SUCCESS) {
Gilles Peskine60aebec2021-12-13 12:33:18 +01002315 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002316 }
2317 if (actual_hash_length != hash_length) {
Gilles Peskine60aebec2021-12-13 12:33:18 +01002318 status = PSA_ERROR_INVALID_SIGNATURE;
2319 goto exit;
2320 }
Dave Rodgman78701152023-08-29 14:20:18 +01002321 if (mbedtls_ct_memcmp(hash, actual_hash, actual_hash_length) != 0) {
Gilles Peskine60aebec2021-12-13 12:33:18 +01002322 status = PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01002323 }
Gilles Peskine60aebec2021-12-13 12:33:18 +01002324
2325exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002326 mbedtls_platform_zeroize(actual_hash, sizeof(actual_hash));
2327 return status;
Gilles Peskine0a749c82019-11-28 19:33:58 +01002328}
2329
Gilles Peskine449bd832023-01-11 14:50:10 +01002330psa_status_t psa_hash_clone(const psa_hash_operation_t *source_operation,
2331 psa_hash_operation_t *target_operation)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002332{
Gilles Peskine449bd832023-01-11 14:50:10 +01002333 if (source_operation->id == 0 ||
2334 target_operation->id != 0) {
2335 return PSA_ERROR_BAD_STATE;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002336 }
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002337
Gilles Peskine449bd832023-01-11 14:50:10 +01002338 psa_status_t status = psa_driver_wrapper_hash_clone(source_operation,
2339 target_operation);
2340 if (status != PSA_SUCCESS) {
2341 psa_hash_abort(target_operation);
2342 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002343
Gilles Peskine449bd832023-01-11 14:50:10 +01002344 return status;
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002345}
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002346
2347
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002348/****************************************************************/
Gilles Peskine8c9def32018-02-08 10:02:12 +01002349/* MAC */
2350/****************************************************************/
2351
Gilles Peskine449bd832023-01-11 14:50:10 +01002352psa_status_t psa_mac_abort(psa_mac_operation_t *operation)
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002353{
Steven Cooremane6804192021-03-19 18:28:56 +01002354 /* Aborting a non-active operation is allowed */
Gilles Peskine449bd832023-01-11 14:50:10 +01002355 if (operation->id == 0) {
2356 return PSA_SUCCESS;
2357 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002358
Gilles Peskine449bd832023-01-11 14:50:10 +01002359 psa_status_t status = psa_driver_wrapper_mac_abort(operation);
Steven Cooreman72f736a2021-05-07 14:14:37 +02002360 operation->mac_size = 0;
2361 operation->is_sign = 0;
Steven Cooremane6804192021-03-19 18:28:56 +01002362 operation->id = 0;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002363
Gilles Peskine449bd832023-01-11 14:50:10 +01002364 return status;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002365}
2366
Ronald Cron2dff3b22021-06-17 16:33:22 +02002367static psa_status_t psa_mac_finalize_alg_and_key_validation(
2368 psa_algorithm_t alg,
Ronald Cron79bdd822021-06-17 16:46:44 +02002369 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01002370 uint8_t *mac_size)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002371{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002372 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002373 psa_key_type_t key_type = psa_get_key_type(attributes);
2374 size_t key_bits = psa_get_key_bits(attributes);
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002375
Gilles Peskine449bd832023-01-11 14:50:10 +01002376 if (!PSA_ALG_IS_MAC(alg)) {
2377 return PSA_ERROR_INVALID_ARGUMENT;
2378 }
Steven Cooremane6804192021-03-19 18:28:56 +01002379
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002380 /* Validate the combination of key type and algorithm */
Gilles Peskine449bd832023-01-11 14:50:10 +01002381 status = psa_mac_key_can_do(alg, key_type);
2382 if (status != PSA_SUCCESS) {
2383 return status;
2384 }
Steven Cooreman15472f82021-03-02 16:16:22 +01002385
Steven Cooremand1a68f12021-05-10 11:13:41 +02002386 /* Get the output length for the algorithm and key combination */
Gilles Peskine449bd832023-01-11 14:50:10 +01002387 *mac_size = PSA_MAC_LENGTH(key_type, key_bits, alg);
Steven Cooreman15472f82021-03-02 16:16:22 +01002388
Gilles Peskine449bd832023-01-11 14:50:10 +01002389 if (*mac_size < 4) {
Steven Cooreman15472f82021-03-02 16:16:22 +01002390 /* A very short MAC is too short for security since it can be
2391 * brute-forced. Ancient protocols with 32-bit MACs do exist,
2392 * so we make this our minimum, even though 32 bits is still
2393 * too small for security. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002394 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman15472f82021-03-02 16:16:22 +01002395 }
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02002396
Gilles Peskine449bd832023-01-11 14:50:10 +01002397 if (*mac_size > PSA_MAC_LENGTH(key_type, key_bits,
2398 PSA_ALG_FULL_LENGTH_MAC(alg))) {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002399 /* It's impossible to "truncate" to a larger length than the full length
2400 * of the algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002401 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002402 }
2403
Gilles Peskine449bd832023-01-11 14:50:10 +01002404 if (*mac_size > PSA_MAC_MAX_SIZE) {
Gilles Peskinea9b6c802022-03-16 13:54:49 +01002405 /* PSA_MAC_LENGTH returns the correct length even for a MAC algorithm
2406 * that is disabled in the compile-time configuration. The result can
2407 * therefore be larger than PSA_MAC_MAX_SIZE, which does take the
2408 * configuration into account. In this case, force a return of
2409 * PSA_ERROR_NOT_SUPPORTED here. Otherwise psa_mac_verify(), or
2410 * psa_mac_compute(mac_size=PSA_MAC_MAX_SIZE), would return
2411 * PSA_ERROR_BUFFER_TOO_SMALL for an unsupported algorithm whose MAC size
2412 * is larger than PSA_MAC_MAX_SIZE, which is misleading and which breaks
2413 * systematically generated tests. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002414 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea9b6c802022-03-16 13:54:49 +01002415 }
2416
Gilles Peskine449bd832023-01-11 14:50:10 +01002417 return PSA_SUCCESS;
Ronald Cron2dff3b22021-06-17 16:33:22 +02002418}
2419
Gilles Peskine449bd832023-01-11 14:50:10 +01002420static psa_status_t psa_mac_setup(psa_mac_operation_t *operation,
2421 mbedtls_svc_key_id_t key,
2422 psa_algorithm_t alg,
2423 int is_sign)
Gilles Peskinee59236f2018-01-27 23:32:46 +01002424{
2425 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2426 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman54648242021-06-24 11:49:45 +01002427 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002428 psa_key_attributes_t attributes;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002429
2430 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002431 if (operation->id != 0) {
Dave Rodgman54648242021-06-24 11:49:45 +01002432 status = PSA_ERROR_BAD_STATE;
2433 goto exit;
2434 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002435
2436 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002437 key,
2438 &slot,
2439 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
2440 alg);
2441 if (status != PSA_SUCCESS) {
Dave Rodgman54648242021-06-24 11:49:45 +01002442 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002443 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002444
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002445 attributes = (psa_key_attributes_t) {
Gilles Peskine8c9def32018-02-08 10:02:12 +01002446 .core = slot->attr
2447 };
2448
Gilles Peskine449bd832023-01-11 14:50:10 +01002449 status = psa_mac_finalize_alg_and_key_validation(alg, &attributes,
2450 &operation->mac_size);
2451 if (status != PSA_SUCCESS) {
Gilles Peskine8c9def32018-02-08 10:02:12 +01002452 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002453 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002454
2455 operation->is_sign = is_sign;
Steven Cooremane6804192021-03-19 18:28:56 +01002456 /* Dispatch the MAC setup call with validated input */
Gilles Peskine449bd832023-01-11 14:50:10 +01002457 if (is_sign) {
2458 status = psa_driver_wrapper_mac_sign_setup(operation,
2459 &attributes,
2460 slot->key.data,
2461 slot->key.bytes,
2462 alg);
2463 } else {
2464 status = psa_driver_wrapper_mac_verify_setup(operation,
2465 &attributes,
2466 slot->key.data,
2467 slot->key.bytes,
2468 alg);
Gilles Peskine8c9def32018-02-08 10:02:12 +01002469 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002470
Gilles Peskinefbfac682018-07-08 20:51:54 +02002471exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002472 if (status != PSA_SUCCESS) {
2473 psa_mac_abort(operation);
2474 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002475
Gilles Peskine449bd832023-01-11 14:50:10 +01002476 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02002477
Gilles Peskine449bd832023-01-11 14:50:10 +01002478 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002479}
2480
Gilles Peskine449bd832023-01-11 14:50:10 +01002481psa_status_t psa_mac_sign_setup(psa_mac_operation_t *operation,
2482 mbedtls_svc_key_id_t key,
2483 psa_algorithm_t alg)
Gilles Peskine89167cb2018-07-08 20:12:23 +02002484{
Gilles Peskine449bd832023-01-11 14:50:10 +01002485 return psa_mac_setup(operation, key, alg, 1);
Gilles Peskine89167cb2018-07-08 20:12:23 +02002486}
2487
Gilles Peskine449bd832023-01-11 14:50:10 +01002488psa_status_t psa_mac_verify_setup(psa_mac_operation_t *operation,
2489 mbedtls_svc_key_id_t key,
2490 psa_algorithm_t alg)
Gilles Peskine89167cb2018-07-08 20:12:23 +02002491{
Gilles Peskine449bd832023-01-11 14:50:10 +01002492 return psa_mac_setup(operation, key, alg, 0);
Gilles Peskine89167cb2018-07-08 20:12:23 +02002493}
2494
Gilles Peskine449bd832023-01-11 14:50:10 +01002495psa_status_t psa_mac_update(psa_mac_operation_t *operation,
2496 const uint8_t *input,
2497 size_t input_length)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002498{
Gilles Peskine449bd832023-01-11 14:50:10 +01002499 if (operation->id == 0) {
2500 return PSA_ERROR_BAD_STATE;
2501 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002502
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002503 /* Don't require hash implementations to behave correctly on a
2504 * zero-length input, which may have an invalid pointer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002505 if (input_length == 0) {
2506 return PSA_SUCCESS;
2507 }
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03002508
Gilles Peskine449bd832023-01-11 14:50:10 +01002509 psa_status_t status = psa_driver_wrapper_mac_update(operation,
2510 input, input_length);
2511 if (status != PSA_SUCCESS) {
2512 psa_mac_abort(operation);
2513 }
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002514
Gilles Peskine449bd832023-01-11 14:50:10 +01002515 return status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002516}
2517
Gilles Peskine449bd832023-01-11 14:50:10 +01002518psa_status_t psa_mac_sign_finish(psa_mac_operation_t *operation,
2519 uint8_t *mac,
2520 size_t mac_size,
2521 size_t *mac_length)
mohammad16036df908f2018-04-02 08:34:15 -07002522{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002523 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2524 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002525
Gilles Peskine449bd832023-01-11 14:50:10 +01002526 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002527 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002528 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002529 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002530
Gilles Peskine449bd832023-01-11 14:50:10 +01002531 if (!operation->is_sign) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002532 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002533 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002534 }
Steven Cooreman72f736a2021-05-07 14:14:37 +02002535
Steven Cooreman8af5c5c2021-05-11 11:09:13 +02002536 /* Sanity check. This will guarantee that mac_size != 0 (and so mac != NULL)
2537 * once all the error checks are done. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002538 if (operation->mac_size == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002539 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002540 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002541 }
Steven Cooreman8af5c5c2021-05-11 11:09:13 +02002542
Gilles Peskine449bd832023-01-11 14:50:10 +01002543 if (mac_size < operation->mac_size) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002544 status = PSA_ERROR_BUFFER_TOO_SMALL;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002545 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002546 }
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002547
Gilles Peskine449bd832023-01-11 14:50:10 +01002548 status = psa_driver_wrapper_mac_sign_finish(operation,
2549 mac, operation->mac_size,
2550 mac_length);
Steven Cooreman72f736a2021-05-07 14:14:37 +02002551
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002552exit:
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002553 /* In case of success, set the potential excess room in the output buffer
2554 * to an invalid value, to avoid potentially leaking a longer MAC.
2555 * In case of error, set the output length and content to a safe default,
2556 * such that in case the caller misses an error check, the output would be
2557 * an unachievable MAC.
2558 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002559 if (status != PSA_SUCCESS) {
Steven Cooreman72f736a2021-05-07 14:14:37 +02002560 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002561 operation->mac_size = 0;
Steven Cooreman72f736a2021-05-07 14:14:37 +02002562 }
mohammad16036df908f2018-04-02 08:34:15 -07002563
Paul Elliottdc42ca82023-02-24 18:11:59 +00002564 psa_wipe_tag_output_buffer(mac, status, mac_size, *mac_length);
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002565
Gilles Peskine449bd832023-01-11 14:50:10 +01002566 abort_status = psa_mac_abort(operation);
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002567
Gilles Peskine449bd832023-01-11 14:50:10 +01002568 return status == PSA_SUCCESS ? abort_status : status;
mohammad16036df908f2018-04-02 08:34:15 -07002569}
2570
Gilles Peskine449bd832023-01-11 14:50:10 +01002571psa_status_t psa_mac_verify_finish(psa_mac_operation_t *operation,
2572 const uint8_t *mac,
2573 size_t mac_length)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002574{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002575 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2576 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002577
Gilles Peskine449bd832023-01-11 14:50:10 +01002578 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002579 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002580 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002581 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002582
Gilles Peskine449bd832023-01-11 14:50:10 +01002583 if (operation->is_sign) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002584 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002585 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002586 }
Steven Cooreman72f736a2021-05-07 14:14:37 +02002587
Gilles Peskine449bd832023-01-11 14:50:10 +01002588 if (operation->mac_size != mac_length) {
Steven Cooreman72f736a2021-05-07 14:14:37 +02002589 status = PSA_ERROR_INVALID_SIGNATURE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002590 goto exit;
Steven Cooreman72f736a2021-05-07 14:14:37 +02002591 }
2592
Gilles Peskine449bd832023-01-11 14:50:10 +01002593 status = psa_driver_wrapper_mac_verify_finish(operation,
2594 mac, mac_length);
Steven Cooreman72f736a2021-05-07 14:14:37 +02002595
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002596exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002597 abort_status = psa_mac_abort(operation);
mohammad16036df908f2018-04-02 08:34:15 -07002598
Gilles Peskine449bd832023-01-11 14:50:10 +01002599 return status == PSA_SUCCESS ? abort_status : status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002600}
2601
Gilles Peskine449bd832023-01-11 14:50:10 +01002602static psa_status_t psa_mac_compute_internal(mbedtls_svc_key_id_t key,
2603 psa_algorithm_t alg,
2604 const uint8_t *input,
2605 size_t input_length,
2606 uint8_t *mac,
2607 size_t mac_size,
2608 size_t *mac_length,
2609 int is_sign)
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002610{
2611 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron51131b52021-06-17 17:17:20 +02002612 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2613 psa_key_slot_t *slot;
2614 uint8_t operation_mac_size = 0;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002615 psa_key_attributes_t attributes;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002616
Ronald Cron51131b52021-06-17 17:17:20 +02002617 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002618 key,
2619 &slot,
2620 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
2621 alg);
2622 if (status != PSA_SUCCESS) {
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002623 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002624 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002625
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002626 attributes = (psa_key_attributes_t) {
Ronald Cron51131b52021-06-17 17:17:20 +02002627 .core = slot->attr
2628 };
2629
Gilles Peskine449bd832023-01-11 14:50:10 +01002630 status = psa_mac_finalize_alg_and_key_validation(alg, &attributes,
2631 &operation_mac_size);
2632 if (status != PSA_SUCCESS) {
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002633 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002634 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002635
Gilles Peskine449bd832023-01-11 14:50:10 +01002636 if (mac_size < operation_mac_size) {
Ronald Cron51131b52021-06-17 17:17:20 +02002637 status = PSA_ERROR_BUFFER_TOO_SMALL;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002638 goto exit;
Ronald Cron51131b52021-06-17 17:17:20 +02002639 }
2640
2641 status = psa_driver_wrapper_mac_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01002642 &attributes,
2643 slot->key.data, slot->key.bytes,
2644 alg,
2645 input, input_length,
2646 mac, operation_mac_size, mac_length);
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002647
2648exit:
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002649 /* In case of success, set the potential excess room in the output buffer
2650 * to an invalid value, to avoid potentially leaking a longer MAC.
2651 * In case of error, set the output length and content to a safe default,
2652 * such that in case the caller misses an error check, the output would be
2653 * an unachievable MAC.
2654 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002655 if (status != PSA_SUCCESS) {
Ronald Cron51131b52021-06-17 17:17:20 +02002656 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002657 operation_mac_size = 0;
Ronald Cron51131b52021-06-17 17:17:20 +02002658 }
Paul Elliottdc42ca82023-02-24 18:11:59 +00002659
2660 psa_wipe_tag_output_buffer(mac, status, mac_size, *mac_length);
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002661
Gilles Peskine449bd832023-01-11 14:50:10 +01002662 unlock_status = psa_unlock_key_slot(slot);
Ronald Cron51131b52021-06-17 17:17:20 +02002663
Gilles Peskine449bd832023-01-11 14:50:10 +01002664 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002665}
2666
Gilles Peskine449bd832023-01-11 14:50:10 +01002667psa_status_t psa_mac_compute(mbedtls_svc_key_id_t key,
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002668 psa_algorithm_t alg,
2669 const uint8_t *input,
2670 size_t input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002671 uint8_t *mac,
2672 size_t mac_size,
2673 size_t *mac_length)
2674{
2675 return psa_mac_compute_internal(key, alg,
2676 input, input_length,
2677 mac, mac_size, mac_length, 1);
2678}
2679
2680psa_status_t psa_mac_verify(mbedtls_svc_key_id_t key,
2681 psa_algorithm_t alg,
2682 const uint8_t *input,
2683 size_t input_length,
2684 const uint8_t *mac,
2685 size_t mac_length)
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002686{
2687 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Crona587cbc2021-06-18 14:51:29 +02002688 uint8_t actual_mac[PSA_MAC_MAX_SIZE];
2689 size_t actual_mac_length;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002690
Gilles Peskine449bd832023-01-11 14:50:10 +01002691 status = psa_mac_compute_internal(key, alg,
2692 input, input_length,
2693 actual_mac, sizeof(actual_mac),
2694 &actual_mac_length, 0);
2695 if (status != PSA_SUCCESS) {
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002696 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002697 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002698
Gilles Peskine449bd832023-01-11 14:50:10 +01002699 if (mac_length != actual_mac_length) {
Ronald Crona587cbc2021-06-18 14:51:29 +02002700 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002701 goto exit;
Ronald Crona587cbc2021-06-18 14:51:29 +02002702 }
Dave Rodgman78701152023-08-29 14:20:18 +01002703 if (mbedtls_ct_memcmp(mac, actual_mac, actual_mac_length) != 0) {
Ronald Crona587cbc2021-06-18 14:51:29 +02002704 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002705 goto exit;
Ronald Crona587cbc2021-06-18 14:51:29 +02002706 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002707
2708exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002709 mbedtls_platform_zeroize(actual_mac, sizeof(actual_mac));
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002710
Gilles Peskine449bd832023-01-11 14:50:10 +01002711 return status;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002712}
Gilles Peskinee59236f2018-01-27 23:32:46 +01002713
Gilles Peskinee59236f2018-01-27 23:32:46 +01002714/****************************************************************/
2715/* Asymmetric cryptography */
2716/****************************************************************/
2717
Gilles Peskine449bd832023-01-11 14:50:10 +01002718static psa_status_t psa_sign_verify_check_alg(int input_is_message,
2719 psa_algorithm_t alg)
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002720{
Gilles Peskine449bd832023-01-11 14:50:10 +01002721 if (input_is_message) {
2722 if (!PSA_ALG_IS_SIGN_MESSAGE(alg)) {
2723 return PSA_ERROR_INVALID_ARGUMENT;
2724 }
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002725
Gilles Peskine449bd832023-01-11 14:50:10 +01002726 if (PSA_ALG_IS_SIGN_HASH(alg)) {
2727 if (!PSA_ALG_IS_HASH(PSA_ALG_SIGN_GET_HASH(alg))) {
2728 return PSA_ERROR_INVALID_ARGUMENT;
2729 }
2730 }
2731 } else {
2732 if (!PSA_ALG_IS_SIGN_HASH(alg)) {
2733 return PSA_ERROR_INVALID_ARGUMENT;
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002734 }
2735 }
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002736
Gilles Peskine449bd832023-01-11 14:50:10 +01002737 return PSA_SUCCESS;
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002738}
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002739
Gilles Peskine449bd832023-01-11 14:50:10 +01002740static psa_status_t psa_sign_internal(mbedtls_svc_key_id_t key,
2741 int input_is_message,
2742 psa_algorithm_t alg,
2743 const uint8_t *input,
2744 size_t input_length,
2745 uint8_t *signature,
2746 size_t signature_size,
2747 size_t *signature_length)
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002748{
2749 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2750 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2751 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002752 psa_key_attributes_t attributes;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002753
2754 *signature_length = 0;
2755
Gilles Peskine449bd832023-01-11 14:50:10 +01002756 status = psa_sign_verify_check_alg(input_is_message, alg);
2757 if (status != PSA_SUCCESS) {
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002758 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002759 }
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002760
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002761 /* Immediately reject a zero-length signature buffer. This guarantees
gabor-mezei-arm12b4f342021-05-05 13:54:55 +02002762 * that signature must be a valid pointer. (On the other hand, the input
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002763 * buffer can in principle be empty since it doesn't actually have
2764 * to be a hash.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01002765 if (signature_size == 0) {
2766 return PSA_ERROR_BUFFER_TOO_SMALL;
2767 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002768
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002769 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002770 key, &slot,
2771 input_is_message ? PSA_KEY_USAGE_SIGN_MESSAGE :
2772 PSA_KEY_USAGE_SIGN_HASH,
2773 alg);
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002774
Gilles Peskine449bd832023-01-11 14:50:10 +01002775 if (status != PSA_SUCCESS) {
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002776 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002777 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002778
Gilles Peskine449bd832023-01-11 14:50:10 +01002779 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002780 status = PSA_ERROR_INVALID_ARGUMENT;
2781 goto exit;
2782 }
2783
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002784 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01002785 .core = slot->attr
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002786 };
2787
Gilles Peskine449bd832023-01-11 14:50:10 +01002788 if (input_is_message) {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002789 status = psa_driver_wrapper_sign_message(
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002790 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002791 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002792 signature, signature_size, signature_length);
2793 } else {
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002794
2795 status = psa_driver_wrapper_sign_hash(
2796 &attributes, slot->key.data, slot->key.bytes,
2797 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002798 signature, signature_size, signature_length);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002799 }
2800
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002801
2802exit:
Paul Elliott59200a22023-02-21 15:07:40 +00002803 psa_wipe_tag_output_buffer(signature, status, signature_size,
2804 *signature_length);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002805
Gilles Peskine449bd832023-01-11 14:50:10 +01002806 unlock_status = psa_unlock_key_slot(slot);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002807
Gilles Peskine449bd832023-01-11 14:50:10 +01002808 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002809}
2810
Gilles Peskine449bd832023-01-11 14:50:10 +01002811static psa_status_t psa_verify_internal(mbedtls_svc_key_id_t key,
2812 int input_is_message,
2813 psa_algorithm_t alg,
2814 const uint8_t *input,
2815 size_t input_length,
2816 const uint8_t *signature,
2817 size_t signature_length)
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002818{
2819 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2820 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2821 psa_key_slot_t *slot;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002822
Gilles Peskine449bd832023-01-11 14:50:10 +01002823 status = psa_sign_verify_check_alg(input_is_message, alg);
2824 if (status != PSA_SUCCESS) {
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002825 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002826 }
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002827
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002828 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002829 key, &slot,
2830 input_is_message ? PSA_KEY_USAGE_VERIFY_MESSAGE :
2831 PSA_KEY_USAGE_VERIFY_HASH,
2832 alg);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002833
Gilles Peskine449bd832023-01-11 14:50:10 +01002834 if (status != PSA_SUCCESS) {
2835 return status;
2836 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002837
2838 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01002839 .core = slot->attr
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002840 };
2841
Gilles Peskine449bd832023-01-11 14:50:10 +01002842 if (input_is_message) {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002843 status = psa_driver_wrapper_verify_message(
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002844 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002845 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002846 signature, signature_length);
2847 } else {
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002848 status = psa_driver_wrapper_verify_hash(
2849 &attributes, slot->key.data, slot->key.bytes,
2850 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002851 signature, signature_length);
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002852 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002853
Gilles Peskine449bd832023-01-11 14:50:10 +01002854 unlock_status = psa_unlock_key_slot(slot);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002855
Gilles Peskine449bd832023-01-11 14:50:10 +01002856 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002857
2858}
2859
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002860psa_status_t psa_sign_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002861 const psa_key_attributes_t *attributes,
2862 const uint8_t *key_buffer,
2863 size_t key_buffer_size,
2864 psa_algorithm_t alg,
2865 const uint8_t *input,
2866 size_t input_length,
2867 uint8_t *signature,
2868 size_t signature_size,
Gilles Peskine449bd832023-01-11 14:50:10 +01002869 size_t *signature_length)
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002870{
2871 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002872
Gilles Peskine449bd832023-01-11 14:50:10 +01002873 if (PSA_ALG_IS_SIGN_HASH(alg)) {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002874 size_t hash_length;
2875 uint8_t hash[PSA_HASH_MAX_SIZE];
2876
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002877 status = psa_driver_wrapper_hash_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01002878 PSA_ALG_SIGN_GET_HASH(alg),
2879 input, input_length,
2880 hash, sizeof(hash), &hash_length);
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002881
Gilles Peskine449bd832023-01-11 14:50:10 +01002882 if (status != PSA_SUCCESS) {
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002883 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002884 }
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002885
2886 return psa_driver_wrapper_sign_hash(
Gilles Peskine449bd832023-01-11 14:50:10 +01002887 attributes, key_buffer, key_buffer_size,
2888 alg, hash, hash_length,
2889 signature, signature_size, signature_length);
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002890 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002891
Gilles Peskine449bd832023-01-11 14:50:10 +01002892 return PSA_ERROR_NOT_SUPPORTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002893}
2894
Gilles Peskine449bd832023-01-11 14:50:10 +01002895psa_status_t psa_sign_message(mbedtls_svc_key_id_t key,
2896 psa_algorithm_t alg,
2897 const uint8_t *input,
2898 size_t input_length,
2899 uint8_t *signature,
2900 size_t signature_size,
2901 size_t *signature_length)
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002902{
2903 return psa_sign_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002904 key, 1, alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002905 signature, signature_size, signature_length);
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002906}
2907
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002908psa_status_t psa_verify_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002909 const psa_key_attributes_t *attributes,
2910 const uint8_t *key_buffer,
2911 size_t key_buffer_size,
2912 psa_algorithm_t alg,
2913 const uint8_t *input,
2914 size_t input_length,
2915 const uint8_t *signature,
Gilles Peskine449bd832023-01-11 14:50:10 +01002916 size_t signature_length)
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002917{
2918 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002919
Gilles Peskine449bd832023-01-11 14:50:10 +01002920 if (PSA_ALG_IS_SIGN_HASH(alg)) {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002921 size_t hash_length;
2922 uint8_t hash[PSA_HASH_MAX_SIZE];
2923
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002924 status = psa_driver_wrapper_hash_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01002925 PSA_ALG_SIGN_GET_HASH(alg),
2926 input, input_length,
2927 hash, sizeof(hash), &hash_length);
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002928
Gilles Peskine449bd832023-01-11 14:50:10 +01002929 if (status != PSA_SUCCESS) {
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002930 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002931 }
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002932
2933 return psa_driver_wrapper_verify_hash(
Gilles Peskine449bd832023-01-11 14:50:10 +01002934 attributes, key_buffer, key_buffer_size,
2935 alg, hash, hash_length,
2936 signature, signature_length);
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002937 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002938
Gilles Peskine449bd832023-01-11 14:50:10 +01002939 return PSA_ERROR_NOT_SUPPORTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002940}
2941
Gilles Peskine449bd832023-01-11 14:50:10 +01002942psa_status_t psa_verify_message(mbedtls_svc_key_id_t key,
2943 psa_algorithm_t alg,
2944 const uint8_t *input,
2945 size_t input_length,
2946 const uint8_t *signature,
2947 size_t signature_length)
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002948{
2949 return psa_verify_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002950 key, 1, alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002951 signature, signature_length);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002952}
2953
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002954psa_status_t psa_sign_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01002955 const psa_key_attributes_t *attributes,
2956 const uint8_t *key_buffer, size_t key_buffer_size,
2957 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002958 uint8_t *signature, size_t signature_size, size_t *signature_length)
Gilles Peskinee59236f2018-01-27 23:32:46 +01002959{
Gilles Peskine449bd832023-01-11 14:50:10 +01002960 if (attributes->core.type == PSA_KEY_TYPE_RSA_KEY_PAIR) {
2961 if (PSA_ALG_IS_RSA_PKCS1V15_SIGN(alg) ||
2962 PSA_ALG_IS_RSA_PSS(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01002963#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01002964 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
2965 return mbedtls_psa_rsa_sign_hash(
2966 attributes,
2967 key_buffer, key_buffer_size,
2968 alg, hash, hash_length,
2969 signature, signature_size, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01002970#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
2971 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine449bd832023-01-11 14:50:10 +01002972 } else {
2973 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanacda8342020-07-24 23:09:52 +02002974 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002975 } else if (PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
2976 if (PSA_ALG_IS_ECDSA(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01002977#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01002978 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
2979 return mbedtls_psa_ecdsa_sign_hash(
2980 attributes,
2981 key_buffer, key_buffer_size,
2982 alg, hash, hash_length,
2983 signature, signature_size, signature_length);
Gilles Peskinee59236f2018-01-27 23:32:46 +01002984#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
2985 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskine449bd832023-01-11 14:50:10 +01002986 } else {
2987 return PSA_ERROR_INVALID_ARGUMENT;
Ronald Cron4501c982021-03-19 20:09:32 +01002988 }
Ronald Cron8a494f32021-02-17 09:49:51 +01002989 }
Ronald Cron4501c982021-03-19 20:09:32 +01002990
Gilles Peskine449bd832023-01-11 14:50:10 +01002991 (void) key_buffer;
2992 (void) key_buffer_size;
2993 (void) hash;
2994 (void) hash_length;
2995 (void) signature;
2996 (void) signature_size;
2997 (void) signature_length;
Ronald Cron4501c982021-03-19 20:09:32 +01002998
Gilles Peskine449bd832023-01-11 14:50:10 +01002999 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron18659932020-12-08 16:32:23 +01003000}
Gilles Peskinee59236f2018-01-27 23:32:46 +01003001
Gilles Peskine449bd832023-01-11 14:50:10 +01003002psa_status_t psa_sign_hash(mbedtls_svc_key_id_t key,
3003 psa_algorithm_t alg,
3004 const uint8_t *hash,
3005 size_t hash_length,
3006 uint8_t *signature,
3007 size_t signature_size,
3008 size_t *signature_length)
Gilles Peskinee59236f2018-01-27 23:32:46 +01003009{
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003010 return psa_sign_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02003011 key, 0, alg, hash, hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003012 signature, signature_size, signature_length);
itayzafrir5c753392018-05-08 11:18:38 +03003013}
3014
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02003015psa_status_t psa_verify_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01003016 const psa_key_attributes_t *attributes,
3017 const uint8_t *key_buffer, size_t key_buffer_size,
3018 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003019 const uint8_t *signature, size_t signature_length)
itayzafrir5c753392018-05-08 11:18:38 +03003020{
Gilles Peskine449bd832023-01-11 14:50:10 +01003021 if (PSA_KEY_TYPE_IS_RSA(attributes->core.type)) {
3022 if (PSA_ALG_IS_RSA_PKCS1V15_SIGN(alg) ||
3023 PSA_ALG_IS_RSA_PSS(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003024#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003025 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
3026 return mbedtls_psa_rsa_verify_hash(
3027 attributes,
3028 key_buffer, key_buffer_size,
3029 alg, hash, hash_length,
3030 signature, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01003031#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
3032 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003033 } else {
3034 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanacda8342020-07-24 23:09:52 +02003035 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003036 } else if (PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3037 if (PSA_ALG_IS_ECDSA(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003038#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003039 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3040 return mbedtls_psa_ecdsa_verify_hash(
3041 attributes,
3042 key_buffer, key_buffer_size,
3043 alg, hash, hash_length,
3044 signature, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01003045#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3046 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003047 } else {
3048 return PSA_ERROR_INVALID_ARGUMENT;
Ronald Cron4501c982021-03-19 20:09:32 +01003049 }
Ronald Cron8a494f32021-02-17 09:49:51 +01003050 }
Ronald Cron4501c982021-03-19 20:09:32 +01003051
Gilles Peskine449bd832023-01-11 14:50:10 +01003052 (void) key_buffer;
3053 (void) key_buffer_size;
3054 (void) hash;
3055 (void) hash_length;
3056 (void) signature;
3057 (void) signature_length;
Ronald Cron4501c982021-03-19 20:09:32 +01003058
Gilles Peskine449bd832023-01-11 14:50:10 +01003059 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron18659932020-12-08 16:32:23 +01003060}
3061
Gilles Peskine449bd832023-01-11 14:50:10 +01003062psa_status_t psa_verify_hash(mbedtls_svc_key_id_t key,
3063 psa_algorithm_t alg,
3064 const uint8_t *hash,
3065 size_t hash_length,
3066 const uint8_t *signature,
3067 size_t signature_length)
itayzafrir5c753392018-05-08 11:18:38 +03003068{
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003069 return psa_verify_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02003070 key, 0, alg, hash, hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003071 signature, signature_length);
Gilles Peskinee59236f2018-01-27 23:32:46 +01003072}
3073
Gilles Peskine449bd832023-01-11 14:50:10 +01003074psa_status_t psa_asymmetric_encrypt(mbedtls_svc_key_id_t key,
3075 psa_algorithm_t alg,
3076 const uint8_t *input,
3077 size_t input_length,
3078 const uint8_t *salt,
3079 size_t salt_length,
3080 uint8_t *output,
3081 size_t output_size,
3082 size_t *output_length)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003083{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003084 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003085 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003086 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003087 psa_key_attributes_t attributes;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003088
Darryl Green5cc689a2018-07-24 15:34:10 +01003089 (void) input;
3090 (void) input_length;
3091 (void) salt;
3092 (void) output;
3093 (void) output_size;
3094
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003095 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003096
Gilles Peskine449bd832023-01-11 14:50:10 +01003097 if (!PSA_ALG_IS_RSA_OAEP(alg) && salt_length != 0) {
3098 return PSA_ERROR_INVALID_ARGUMENT;
3099 }
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003100
Ronald Cron5c522922020-11-14 16:35:34 +01003101 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01003102 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg);
3103 if (status != PSA_SUCCESS) {
3104 return status;
3105 }
3106 if (!(PSA_KEY_TYPE_IS_PUBLIC_KEY(slot->attr.type) ||
3107 PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type))) {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003108 status = PSA_ERROR_INVALID_ARGUMENT;
3109 goto exit;
3110 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003111
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003112 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01003113 .core = slot->attr
Przemyslaw Stekiel19e61422021-12-09 11:09:11 +01003114 };
Steven Cooremana2371e52020-07-28 14:30:39 +02003115
Przemyslaw Stekiel19e61422021-12-09 11:09:11 +01003116 status = psa_driver_wrapper_asymmetric_encrypt(
3117 &attributes, slot->key.data, slot->key.bytes,
3118 alg, input, input_length, salt, salt_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003119 output, output_size, output_length);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003120exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01003121 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003122
Gilles Peskine449bd832023-01-11 14:50:10 +01003123 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003124}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003125
Gilles Peskine449bd832023-01-11 14:50:10 +01003126psa_status_t psa_asymmetric_decrypt(mbedtls_svc_key_id_t key,
3127 psa_algorithm_t alg,
3128 const uint8_t *input,
3129 size_t input_length,
3130 const uint8_t *salt,
3131 size_t salt_length,
3132 uint8_t *output,
3133 size_t output_size,
3134 size_t *output_length)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003135{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003136 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003137 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003138 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003139 psa_key_attributes_t attributes;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003140
Darryl Green5cc689a2018-07-24 15:34:10 +01003141 (void) input;
3142 (void) input_length;
3143 (void) salt;
3144 (void) output;
3145 (void) output_size;
3146
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003147 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003148
Gilles Peskine449bd832023-01-11 14:50:10 +01003149 if (!PSA_ALG_IS_RSA_OAEP(alg) && salt_length != 0) {
3150 return PSA_ERROR_INVALID_ARGUMENT;
3151 }
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003152
Ronald Cron5c522922020-11-14 16:35:34 +01003153 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01003154 key, &slot, PSA_KEY_USAGE_DECRYPT, alg);
3155 if (status != PSA_SUCCESS) {
3156 return status;
3157 }
3158 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003159 status = PSA_ERROR_INVALID_ARGUMENT;
3160 goto exit;
3161 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003162
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003163 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01003164 .core = slot->attr
Przemyslaw Stekiel8d45c002021-12-13 08:58:19 +01003165 };
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003166
Przemyslaw Stekiel8d45c002021-12-13 08:58:19 +01003167 status = psa_driver_wrapper_asymmetric_decrypt(
3168 &attributes, slot->key.data, slot->key.bytes,
3169 alg, input, input_length, salt, salt_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003170 output, output_size, output_length);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003171
3172exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01003173 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003174
Gilles Peskine449bd832023-01-11 14:50:10 +01003175 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003176}
Gilles Peskinee59236f2018-01-27 23:32:46 +01003177
Paul Elliott9fe12f62022-11-30 19:16:02 +00003178/****************************************************************/
3179/* Asymmetric interruptible cryptography */
3180/****************************************************************/
3181
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003182static uint32_t psa_interruptible_max_ops = PSA_INTERRUPTIBLE_MAX_OPS_UNLIMITED;
3183
Paul Elliott9fe12f62022-11-30 19:16:02 +00003184void psa_interruptible_set_max_ops(uint32_t max_ops)
3185{
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003186 psa_interruptible_max_ops = max_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003187}
3188
3189uint32_t psa_interruptible_get_max_ops(void)
3190{
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003191 return psa_interruptible_max_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003192}
3193
Paul Elliott9fe12f62022-11-30 19:16:02 +00003194uint32_t psa_sign_hash_get_num_ops(
3195 const psa_sign_hash_interruptible_operation_t *operation)
3196{
Paul Elliott296ede92022-12-15 17:00:30 +00003197 return operation->num_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003198}
3199
3200uint32_t psa_verify_hash_get_num_ops(
3201 const psa_verify_hash_interruptible_operation_t *operation)
3202{
Paul Elliott296ede92022-12-15 17:00:30 +00003203 return operation->num_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003204}
3205
Paul Elliott59ad9452022-12-18 15:09:02 +00003206static psa_status_t psa_sign_hash_abort_internal(
3207 psa_sign_hash_interruptible_operation_t *operation)
3208{
3209 if (operation->id == 0) {
3210 /* The object has (apparently) been initialized but it is not (yet)
3211 * in use. It's ok to call abort on such an object, and there's
3212 * nothing to do. */
3213 return PSA_SUCCESS;
3214 }
3215
3216 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3217
3218 status = psa_driver_wrapper_sign_hash_abort(operation);
3219
3220 operation->id = 0;
3221
Paul Elliotte6145dc2023-02-07 12:51:21 +00003222 /* Do not clear either the error_occurred or num_ops elements here as they
3223 * only want to be cleared by the application calling abort, not by abort
3224 * being called at completion of an operation. */
3225
Paul Elliott59ad9452022-12-18 15:09:02 +00003226 return status;
3227}
3228
Paul Elliott9fe12f62022-11-30 19:16:02 +00003229psa_status_t psa_sign_hash_start(
3230 psa_sign_hash_interruptible_operation_t *operation,
3231 mbedtls_svc_key_id_t key, psa_algorithm_t alg,
3232 const uint8_t *hash, size_t hash_length)
3233{
3234 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3235 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3236 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003237 psa_key_attributes_t attributes;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003238
Paul Elliottc9774412023-02-06 15:14:07 +00003239 /* Check that start has not been previously called, or operation has not
3240 * previously errored. */
3241 if (operation->id != 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003242 return PSA_ERROR_BAD_STATE;
3243 }
3244
Paul Elliott9fe12f62022-11-30 19:16:02 +00003245 status = psa_sign_verify_check_alg(0, alg);
3246 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003247 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003248 return status;
3249 }
3250
3251 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
3252 PSA_KEY_USAGE_SIGN_HASH,
3253 alg);
3254
3255 if (status != PSA_SUCCESS) {
3256 goto exit;
3257 }
3258
3259 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
3260 status = PSA_ERROR_INVALID_ARGUMENT;
3261 goto exit;
3262 }
3263
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003264 attributes = (psa_key_attributes_t) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003265 .core = slot->attr
3266 };
3267
Paul Elliott296ede92022-12-15 17:00:30 +00003268 /* Ensure ops count gets reset, in case of operation re-use. */
3269 operation->num_ops = 0;
3270
Paul Elliott9fe12f62022-11-30 19:16:02 +00003271 status = psa_driver_wrapper_sign_hash_start(operation, &attributes,
3272 slot->key.data,
3273 slot->key.bytes, alg,
3274 hash, hash_length);
3275exit:
3276
3277 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003278 operation->error_occurred = 1;
Paul Elliott59ad9452022-12-18 15:09:02 +00003279 psa_sign_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003280 }
3281
3282 unlock_status = psa_unlock_key_slot(slot);
3283
Paul Elliottc9774412023-02-06 15:14:07 +00003284 if (unlock_status != PSA_SUCCESS) {
3285 operation->error_occurred = 1;
3286 }
Paul Elliott9fe12f62022-11-30 19:16:02 +00003287
Paul Elliottc9774412023-02-06 15:14:07 +00003288 return (status == PSA_SUCCESS) ? unlock_status : status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003289}
3290
3291
3292psa_status_t psa_sign_hash_complete(
3293 psa_sign_hash_interruptible_operation_t *operation,
3294 uint8_t *signature, size_t signature_size,
3295 size_t *signature_length)
3296{
3297 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3298
3299 *signature_length = 0;
3300
Paul Elliottc9774412023-02-06 15:14:07 +00003301 /* Check that start has been called first, and that operation has not
3302 * previously errored. */
3303 if (operation->id == 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003304 status = PSA_ERROR_BAD_STATE;
3305 goto exit;
3306 }
3307
Paul Elliott096abc42023-02-03 18:33:23 +00003308 /* Immediately reject a zero-length signature buffer. This guarantees that
3309 * signature must be a valid pointer. */
Paul Elliott9fe12f62022-11-30 19:16:02 +00003310 if (signature_size == 0) {
3311 status = PSA_ERROR_BUFFER_TOO_SMALL;
3312 goto exit;
3313 }
3314
3315 status = psa_driver_wrapper_sign_hash_complete(operation, signature,
3316 signature_size,
3317 signature_length);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003318
Paul Elliott296ede92022-12-15 17:00:30 +00003319 /* Update ops count with work done. */
Paul Elliottde1114c2023-02-07 12:43:11 +00003320 operation->num_ops = psa_driver_wrapper_sign_hash_get_num_ops(operation);
Paul Elliott296ede92022-12-15 17:00:30 +00003321
Paul Elliottebe225c2023-02-10 14:32:53 +00003322exit:
3323
Paul Elliott59200a22023-02-21 15:07:40 +00003324 psa_wipe_tag_output_buffer(signature, status, signature_size,
3325 *signature_length);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003326
Paul Elliott53bb3122023-02-10 14:22:22 +00003327 if (status != PSA_OPERATION_INCOMPLETE) {
Paul Elliottc9774412023-02-06 15:14:07 +00003328 if (status != PSA_SUCCESS) {
3329 operation->error_occurred = 1;
3330 }
3331
Paul Elliott59ad9452022-12-18 15:09:02 +00003332 psa_sign_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003333 }
3334
3335 return status;
3336}
3337
3338psa_status_t psa_sign_hash_abort(
3339 psa_sign_hash_interruptible_operation_t *operation)
3340{
Paul Elliott59ad9452022-12-18 15:09:02 +00003341 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3342
3343 status = psa_sign_hash_abort_internal(operation);
3344
3345 /* We clear the number of ops done here, so that it is not cleared when
3346 * the operation fails or succeeds, only on manual abort. */
3347 operation->num_ops = 0;
3348
Paul Elliottc9774412023-02-06 15:14:07 +00003349 /* Likewise, failure state. */
3350 operation->error_occurred = 0;
3351
Paul Elliott59ad9452022-12-18 15:09:02 +00003352 return status;
3353}
3354
3355static psa_status_t psa_verify_hash_abort_internal(
3356 psa_verify_hash_interruptible_operation_t *operation)
3357{
Paul Elliott9fe12f62022-11-30 19:16:02 +00003358 if (operation->id == 0) {
3359 /* The object has (apparently) been initialized but it is not (yet)
3360 * in use. It's ok to call abort on such an object, and there's
3361 * nothing to do. */
3362 return PSA_SUCCESS;
3363 }
3364
Paul Elliott59ad9452022-12-18 15:09:02 +00003365 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3366
3367 status = psa_driver_wrapper_verify_hash_abort(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003368
3369 operation->id = 0;
3370
Paul Elliotte6145dc2023-02-07 12:51:21 +00003371 /* Do not clear either the error_occurred or num_ops elements here as they
3372 * only want to be cleared by the application calling abort, not by abort
3373 * being called at completion of an operation. */
3374
Paul Elliott59ad9452022-12-18 15:09:02 +00003375 return status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003376}
3377
3378psa_status_t psa_verify_hash_start(
3379 psa_verify_hash_interruptible_operation_t *operation,
3380 mbedtls_svc_key_id_t key, psa_algorithm_t alg,
3381 const uint8_t *hash, size_t hash_length,
3382 const uint8_t *signature, size_t signature_length)
3383{
3384 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3385 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3386 psa_key_slot_t *slot;
3387
Paul Elliottc9774412023-02-06 15:14:07 +00003388 /* Check that start has not been previously called, or operation has not
3389 * previously errored. */
3390 if (operation->id != 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003391 return PSA_ERROR_BAD_STATE;
3392 }
3393
3394 status = psa_sign_verify_check_alg(0, alg);
3395 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003396 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003397 return status;
3398 }
3399
3400 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
3401 PSA_KEY_USAGE_VERIFY_HASH,
3402 alg);
3403
3404 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003405 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003406 return status;
3407 }
3408
3409 psa_key_attributes_t attributes = {
3410 .core = slot->attr
3411 };
3412
Paul Elliott296ede92022-12-15 17:00:30 +00003413 /* Ensure ops count gets reset, in case of operation re-use. */
3414 operation->num_ops = 0;
3415
Paul Elliott9fe12f62022-11-30 19:16:02 +00003416 status = psa_driver_wrapper_verify_hash_start(operation, &attributes,
3417 slot->key.data,
3418 slot->key.bytes,
3419 alg, hash, hash_length,
3420 signature, signature_length);
3421
3422 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003423 operation->error_occurred = 1;
Paul Elliott59ad9452022-12-18 15:09:02 +00003424 psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003425 }
3426
3427 unlock_status = psa_unlock_key_slot(slot);
3428
Paul Elliottc9774412023-02-06 15:14:07 +00003429 if (unlock_status != PSA_SUCCESS) {
3430 operation->error_occurred = 1;
3431 }
Paul Elliott9fe12f62022-11-30 19:16:02 +00003432
Paul Elliottc9774412023-02-06 15:14:07 +00003433 return (status == PSA_SUCCESS) ? unlock_status : status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003434}
3435
3436psa_status_t psa_verify_hash_complete(
3437 psa_verify_hash_interruptible_operation_t *operation)
3438{
3439 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3440
Paul Elliottc9774412023-02-06 15:14:07 +00003441 /* Check that start has been called first, and that operation has not
3442 * previously errored. */
3443 if (operation->id == 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003444 status = PSA_ERROR_BAD_STATE;
3445 goto exit;
3446 }
3447
3448 status = psa_driver_wrapper_verify_hash_complete(operation);
3449
Paul Elliott296ede92022-12-15 17:00:30 +00003450 /* Update ops count with work done. */
Paul Elliottde1114c2023-02-07 12:43:11 +00003451 operation->num_ops = psa_driver_wrapper_verify_hash_get_num_ops(
Paul Elliott296ede92022-12-15 17:00:30 +00003452 operation);
3453
Paul Elliottebe225c2023-02-10 14:32:53 +00003454exit:
3455
Paul Elliott9fe12f62022-11-30 19:16:02 +00003456 if (status != PSA_OPERATION_INCOMPLETE) {
Paul Elliottc9774412023-02-06 15:14:07 +00003457 if (status != PSA_SUCCESS) {
3458 operation->error_occurred = 1;
3459 }
3460
Paul Elliott59ad9452022-12-18 15:09:02 +00003461 psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003462 }
3463
3464 return status;
3465}
3466
3467psa_status_t psa_verify_hash_abort(
3468 psa_verify_hash_interruptible_operation_t *operation)
3469{
Paul Elliott59ad9452022-12-18 15:09:02 +00003470 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003471
Paul Elliott59ad9452022-12-18 15:09:02 +00003472 status = psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003473
Paul Elliott59ad9452022-12-18 15:09:02 +00003474 /* We clear the number of ops done here, so that it is not cleared when
3475 * the operation fails or succeeds, only on manual abort. */
3476 operation->num_ops = 0;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003477
Paul Elliottc9774412023-02-06 15:14:07 +00003478 /* Likewise, failure state. */
3479 operation->error_occurred = 0;
3480
Paul Elliott59ad9452022-12-18 15:09:02 +00003481 return status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003482}
3483
Paul Elliott588f8ed2022-12-02 18:10:26 +00003484/****************************************************************/
3485/* Asymmetric interruptible cryptography internal */
3486/* implementations */
3487/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003488
Paul Elliott588f8ed2022-12-02 18:10:26 +00003489void mbedtls_psa_interruptible_set_max_ops(uint32_t max_ops)
3490{
Paul Elliott7cc4e812023-01-10 17:14:11 +00003491
Paul Elliott588f8ed2022-12-02 18:10:26 +00003492#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3493 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3494 defined(MBEDTLS_ECP_RESTARTABLE)
3495
3496 /* Internal implementation uses zero to indicate infinite number max ops,
3497 * therefore avoid this value, and set to minimum possible. */
3498 if (max_ops == 0) {
3499 max_ops = 1;
3500 }
3501
Paul Elliott588f8ed2022-12-02 18:10:26 +00003502 mbedtls_ecp_set_max_ops(max_ops);
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003503#else
3504 (void) max_ops;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003505#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3506 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3507 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3508}
3509
Paul Elliott588f8ed2022-12-02 18:10:26 +00003510uint32_t mbedtls_psa_sign_hash_get_num_ops(
Paul Elliottf8e5b562023-02-19 18:43:45 +00003511 const mbedtls_psa_sign_hash_interruptible_operation_t *operation)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003512{
3513#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3514 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3515 defined(MBEDTLS_ECP_RESTARTABLE)
3516
Paul Elliott93d9ca82023-02-15 18:14:21 +00003517 return operation->num_ops;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003518#else
3519 (void) operation;
3520 return 0;
3521#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3522 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3523 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3524}
3525
3526uint32_t mbedtls_psa_verify_hash_get_num_ops(
Paul Elliottf8e5b562023-02-19 18:43:45 +00003527 const mbedtls_psa_verify_hash_interruptible_operation_t *operation)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003528{
3529 #if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3530 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3531 defined(MBEDTLS_ECP_RESTARTABLE)
3532
Paul Elliott93d9ca82023-02-15 18:14:21 +00003533 return operation->num_ops;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003534#else
3535 (void) operation;
3536 return 0;
3537#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3538 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3539 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3540}
3541
3542psa_status_t mbedtls_psa_sign_hash_start(
3543 mbedtls_psa_sign_hash_interruptible_operation_t *operation,
3544 const psa_key_attributes_t *attributes, const uint8_t *key_buffer,
3545 size_t key_buffer_size, psa_algorithm_t alg,
3546 const uint8_t *hash, size_t hash_length)
3547{
3548 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott0290a762023-02-09 14:30:24 +00003549 size_t required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003550
Paul Elliott068fe072023-01-16 13:59:15 +00003551 if (!PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3552 return PSA_ERROR_NOT_SUPPORTED;
3553 }
3554
3555 if (!PSA_ALG_IS_ECDSA(alg)) {
Paul Elliott813f9cd2023-02-05 15:28:46 +00003556 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott068fe072023-01-16 13:59:15 +00003557 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003558
3559#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Paul Elliott068fe072023-01-16 13:59:15 +00003560 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3561 defined(MBEDTLS_ECP_RESTARTABLE)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003562
Paul Elliotta1c94092023-02-15 16:38:04 +00003563 mbedtls_ecdsa_restart_init(&operation->restart_ctx);
3564
Paul Elliott93d9ca82023-02-15 18:14:21 +00003565 /* Ensure num_ops is zero'ed in case of context re-use. */
3566 operation->num_ops = 0;
3567
Paul Elliott068fe072023-01-16 13:59:15 +00003568 status = mbedtls_psa_ecp_load_representation(attributes->core.type,
3569 attributes->core.bits,
3570 key_buffer,
3571 key_buffer_size,
3572 &operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003573
Paul Elliott068fe072023-01-16 13:59:15 +00003574 if (status != PSA_SUCCESS) {
3575 return status;
3576 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003577
Paul Elliott1bc59df2023-02-05 13:41:57 +00003578 operation->coordinate_bytes = PSA_BITS_TO_BYTES(
Paul Elliottc569fc22023-02-10 13:02:54 +00003579 operation->ctx->grp.nbits);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003580
Paul Elliott068fe072023-01-16 13:59:15 +00003581 psa_algorithm_t hash_alg = PSA_ALG_SIGN_GET_HASH(alg);
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02003582 operation->md_alg = mbedtls_md_type_from_psa_alg(hash_alg);
Paul Elliott068fe072023-01-16 13:59:15 +00003583 operation->alg = alg;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003584
Paul Elliott0290a762023-02-09 14:30:24 +00003585 /* We only need to store the same length of hash as the private key size
3586 * here, it would be truncated by the internal implementation anyway. */
3587 required_hash_length = (hash_length < operation->coordinate_bytes ?
3588 hash_length : operation->coordinate_bytes);
3589
Paul Elliottba70ad42023-02-15 18:23:53 +00003590 if (required_hash_length > sizeof(operation->hash)) {
3591 /* Shouldn't happen, but better safe than sorry. */
3592 return PSA_ERROR_CORRUPTION_DETECTED;
3593 }
3594
Paul Elliott0290a762023-02-09 14:30:24 +00003595 memcpy(operation->hash, hash, required_hash_length);
3596 operation->hash_length = required_hash_length;
Paul Elliott068fe072023-01-16 13:59:15 +00003597
3598 return PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003599
3600#else
Paul Elliott068fe072023-01-16 13:59:15 +00003601 (void) operation;
3602 (void) key_buffer;
3603 (void) key_buffer_size;
3604 (void) alg;
3605 (void) hash;
3606 (void) hash_length;
3607 (void) status;
Paul Elliott0290a762023-02-09 14:30:24 +00003608 (void) required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003609
Paul Elliott068fe072023-01-16 13:59:15 +00003610 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003611#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3612 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3613 * defined( MBEDTLS_ECP_RESTARTABLE ) */
Paul Elliott588f8ed2022-12-02 18:10:26 +00003614}
3615
3616psa_status_t mbedtls_psa_sign_hash_complete(
3617 mbedtls_psa_sign_hash_interruptible_operation_t *operation,
3618 uint8_t *signature, size_t signature_size,
3619 size_t *signature_length)
3620{
Paul Elliott588f8ed2022-12-02 18:10:26 +00003621#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3622 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3623 defined(MBEDTLS_ECP_RESTARTABLE)
3624
Paul Elliotta1c94092023-02-15 16:38:04 +00003625 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott1243f932023-02-07 11:21:10 +00003626 mbedtls_mpi r;
3627 mbedtls_mpi s;
3628
Paul Elliott46845252023-02-03 14:59:11 +00003629 mbedtls_mpi_init(&r);
3630 mbedtls_mpi_init(&s);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003631
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003632 /* Ensure max_ops is set to the current value (or default). */
3633 mbedtls_psa_interruptible_set_max_ops(psa_interruptible_get_max_ops());
3634
Paul Elliotta1c94092023-02-15 16:38:04 +00003635 if (signature_size < 2 * operation->coordinate_bytes) {
3636 status = PSA_ERROR_BUFFER_TOO_SMALL;
3637 goto exit;
3638 }
3639
Paul Elliott588f8ed2022-12-02 18:10:26 +00003640 if (PSA_ALG_ECDSA_IS_DETERMINISTIC(operation->alg)) {
Paul Elliott46845252023-02-03 14:59:11 +00003641
Paul Elliott588f8ed2022-12-02 18:10:26 +00003642#if defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3643 status = mbedtls_to_psa_error(
3644 mbedtls_ecdsa_sign_det_restartable(&operation->ctx->grp,
Paul Elliott46845252023-02-03 14:59:11 +00003645 &r,
3646 &s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003647 &operation->ctx->d,
3648 operation->hash,
3649 operation->hash_length,
3650 operation->md_alg,
3651 mbedtls_psa_get_random,
3652 MBEDTLS_PSA_RANDOM_STATE,
3653 &operation->restart_ctx));
3654#else /* defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Paul Elliott724bd252023-02-08 12:35:08 +00003655 status = PSA_ERROR_NOT_SUPPORTED;
3656 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003657#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
3658 } else {
Paul Elliott588f8ed2022-12-02 18:10:26 +00003659 status = mbedtls_to_psa_error(
3660 mbedtls_ecdsa_sign_restartable(&operation->ctx->grp,
Paul Elliott46845252023-02-03 14:59:11 +00003661 &r,
3662 &s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003663 &operation->ctx->d,
3664 operation->hash,
3665 operation->hash_length,
3666 mbedtls_psa_get_random,
3667 MBEDTLS_PSA_RANDOM_STATE,
3668 mbedtls_psa_get_random,
3669 MBEDTLS_PSA_RANDOM_STATE,
3670 &operation->restart_ctx));
3671 }
3672
Paul Elliottf8e5b562023-02-19 18:43:45 +00003673 /* Hide the fact that the restart context only holds a delta of number of
3674 * ops done during the last operation, not an absolute value. */
3675 operation->num_ops += operation->restart_ctx.ecp.ops_done;
3676
Paul Elliott724bd252023-02-08 12:35:08 +00003677 if (status == PSA_SUCCESS) {
Paul Elliott588f8ed2022-12-02 18:10:26 +00003678 status = mbedtls_to_psa_error(
Paul Elliott46845252023-02-03 14:59:11 +00003679 mbedtls_mpi_write_binary(&r,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003680 signature,
Paul Elliott1bc59df2023-02-05 13:41:57 +00003681 operation->coordinate_bytes)
3682 );
Paul Elliott588f8ed2022-12-02 18:10:26 +00003683
3684 if (status != PSA_SUCCESS) {
Paul Elliott724bd252023-02-08 12:35:08 +00003685 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003686 }
3687
3688 status = mbedtls_to_psa_error(
Paul Elliott46845252023-02-03 14:59:11 +00003689 mbedtls_mpi_write_binary(&s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003690 signature +
Paul Elliott1bc59df2023-02-05 13:41:57 +00003691 operation->coordinate_bytes,
3692 operation->coordinate_bytes)
3693 );
Paul Elliott588f8ed2022-12-02 18:10:26 +00003694
3695 if (status != PSA_SUCCESS) {
Paul Elliott724bd252023-02-08 12:35:08 +00003696 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003697 }
3698
Paul Elliott1bc59df2023-02-05 13:41:57 +00003699 *signature_length = operation->coordinate_bytes * 2;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003700
Paul Elliott724bd252023-02-08 12:35:08 +00003701 status = PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003702 }
Paul Elliott724bd252023-02-08 12:35:08 +00003703
3704exit:
3705
3706 mbedtls_mpi_free(&r);
3707 mbedtls_mpi_free(&s);
3708 return status;
3709
Paul Elliott588f8ed2022-12-02 18:10:26 +00003710 #else
3711
3712 (void) operation;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003713 (void) signature;
3714 (void) signature_size;
3715 (void) signature_length;
3716
3717 return PSA_ERROR_NOT_SUPPORTED;
3718
3719#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3720 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3721 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3722}
3723
3724psa_status_t mbedtls_psa_sign_hash_abort(
3725 mbedtls_psa_sign_hash_interruptible_operation_t *operation)
3726{
3727
3728#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3729 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3730 defined(MBEDTLS_ECP_RESTARTABLE)
3731
3732 if (operation->ctx) {
3733 mbedtls_ecdsa_free(operation->ctx);
3734 mbedtls_free(operation->ctx);
Paul Elliottf9c91a72023-02-05 18:06:38 +00003735 operation->ctx = NULL;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003736 }
3737
3738 mbedtls_ecdsa_restart_free(&operation->restart_ctx);
3739
Paul Elliott93d9ca82023-02-15 18:14:21 +00003740 operation->num_ops = 0;
3741
Paul Elliott588f8ed2022-12-02 18:10:26 +00003742 return PSA_SUCCESS;
3743
3744#else
3745
3746 (void) operation;
3747
3748 return PSA_ERROR_NOT_SUPPORTED;
3749
3750#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3751 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3752 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3753}
3754
3755psa_status_t mbedtls_psa_verify_hash_start(
3756 mbedtls_psa_verify_hash_interruptible_operation_t *operation,
3757 const psa_key_attributes_t *attributes,
3758 const uint8_t *key_buffer, size_t key_buffer_size,
3759 psa_algorithm_t alg,
3760 const uint8_t *hash, size_t hash_length,
3761 const uint8_t *signature, size_t signature_length)
3762{
3763 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott1bc59df2023-02-05 13:41:57 +00003764 size_t coordinate_bytes = 0;
Paul Elliott0290a762023-02-09 14:30:24 +00003765 size_t required_hash_length = 0;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003766
Paul Elliott068fe072023-01-16 13:59:15 +00003767 if (!PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3768 return PSA_ERROR_NOT_SUPPORTED;
3769 }
3770
3771 if (!PSA_ALG_IS_ECDSA(alg)) {
Paul Elliott813f9cd2023-02-05 15:28:46 +00003772 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott068fe072023-01-16 13:59:15 +00003773 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003774
3775#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Paul Elliott068fe072023-01-16 13:59:15 +00003776 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3777 defined(MBEDTLS_ECP_RESTARTABLE)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003778
Paul Elliotta1c94092023-02-15 16:38:04 +00003779 mbedtls_ecdsa_restart_init(&operation->restart_ctx);
3780 mbedtls_mpi_init(&operation->r);
3781 mbedtls_mpi_init(&operation->s);
3782
Paul Elliott93d9ca82023-02-15 18:14:21 +00003783 /* Ensure num_ops is zero'ed in case of context re-use. */
3784 operation->num_ops = 0;
3785
Paul Elliott068fe072023-01-16 13:59:15 +00003786 status = mbedtls_psa_ecp_load_representation(attributes->core.type,
3787 attributes->core.bits,
3788 key_buffer,
3789 key_buffer_size,
3790 &operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003791
Paul Elliott068fe072023-01-16 13:59:15 +00003792 if (status != PSA_SUCCESS) {
3793 return status;
3794 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003795
Paul Elliottc569fc22023-02-10 13:02:54 +00003796 coordinate_bytes = PSA_BITS_TO_BYTES(operation->ctx->grp.nbits);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003797
Paul Elliott1bc59df2023-02-05 13:41:57 +00003798 if (signature_length != 2 * coordinate_bytes) {
Paul Elliott068fe072023-01-16 13:59:15 +00003799 return PSA_ERROR_INVALID_SIGNATURE;
3800 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003801
Paul Elliott068fe072023-01-16 13:59:15 +00003802 status = mbedtls_to_psa_error(
3803 mbedtls_mpi_read_binary(&operation->r,
3804 signature,
Paul Elliott1bc59df2023-02-05 13:41:57 +00003805 coordinate_bytes));
Paul Elliott588f8ed2022-12-02 18:10:26 +00003806
Paul Elliott068fe072023-01-16 13:59:15 +00003807 if (status != PSA_SUCCESS) {
3808 return status;
3809 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003810
Paul Elliott068fe072023-01-16 13:59:15 +00003811 status = mbedtls_to_psa_error(
3812 mbedtls_mpi_read_binary(&operation->s,
3813 signature +
Paul Elliott1bc59df2023-02-05 13:41:57 +00003814 coordinate_bytes,
3815 coordinate_bytes));
Paul Elliott588f8ed2022-12-02 18:10:26 +00003816
Paul Elliott068fe072023-01-16 13:59:15 +00003817 if (status != PSA_SUCCESS) {
3818 return status;
3819 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003820
Paul Elliott2c9843f2023-02-15 17:32:42 +00003821 status = mbedtls_psa_ecp_load_public_part(operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003822
Paul Elliott2c9843f2023-02-15 17:32:42 +00003823 if (status != PSA_SUCCESS) {
3824 return status;
Paul Elliott068fe072023-01-16 13:59:15 +00003825 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003826
Paul Elliott0290a762023-02-09 14:30:24 +00003827 /* We only need to store the same length of hash as the private key size
3828 * here, it would be truncated by the internal implementation anyway. */
3829 required_hash_length = (hash_length < coordinate_bytes ? hash_length :
3830 coordinate_bytes);
3831
Paul Elliottba70ad42023-02-15 18:23:53 +00003832 if (required_hash_length > sizeof(operation->hash)) {
3833 /* Shouldn't happen, but better safe than sorry. */
3834 return PSA_ERROR_CORRUPTION_DETECTED;
3835 }
3836
Paul Elliott0290a762023-02-09 14:30:24 +00003837 memcpy(operation->hash, hash, required_hash_length);
3838 operation->hash_length = required_hash_length;
Paul Elliott068fe072023-01-16 13:59:15 +00003839
3840 return PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003841#else
Paul Elliott068fe072023-01-16 13:59:15 +00003842 (void) operation;
3843 (void) key_buffer;
3844 (void) key_buffer_size;
3845 (void) alg;
3846 (void) hash;
3847 (void) hash_length;
3848 (void) signature;
3849 (void) signature_length;
3850 (void) status;
Paul Elliott1243f932023-02-07 11:21:10 +00003851 (void) coordinate_bytes;
Paul Elliott0290a762023-02-09 14:30:24 +00003852 (void) required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003853
Paul Elliott068fe072023-01-16 13:59:15 +00003854 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003855#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3856 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3857 * defined( MBEDTLS_ECP_RESTARTABLE ) */
Paul Elliott588f8ed2022-12-02 18:10:26 +00003858}
3859
3860psa_status_t mbedtls_psa_verify_hash_complete(
3861 mbedtls_psa_verify_hash_interruptible_operation_t *operation)
3862{
3863
3864#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3865 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3866 defined(MBEDTLS_ECP_RESTARTABLE)
3867
Paul Elliottf8e5b562023-02-19 18:43:45 +00003868 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3869
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003870 /* Ensure max_ops is set to the current value (or default). */
3871 mbedtls_psa_interruptible_set_max_ops(psa_interruptible_get_max_ops());
3872
Paul Elliottf8e5b562023-02-19 18:43:45 +00003873 status = mbedtls_to_psa_error(
Paul Elliott588f8ed2022-12-02 18:10:26 +00003874 mbedtls_ecdsa_verify_restartable(&operation->ctx->grp,
3875 operation->hash,
3876 operation->hash_length,
3877 &operation->ctx->Q,
3878 &operation->r,
3879 &operation->s,
3880 &operation->restart_ctx));
3881
Paul Elliottf8e5b562023-02-19 18:43:45 +00003882 /* Hide the fact that the restart context only holds a delta of number of
3883 * ops done during the last operation, not an absolute value. */
3884 operation->num_ops += operation->restart_ctx.ecp.ops_done;
3885
3886 return status;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003887#else
3888 (void) operation;
3889
3890 return PSA_ERROR_NOT_SUPPORTED;
3891
3892#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3893 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3894 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3895}
3896
3897psa_status_t mbedtls_psa_verify_hash_abort(
3898 mbedtls_psa_verify_hash_interruptible_operation_t *operation)
3899{
3900
3901#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3902 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3903 defined(MBEDTLS_ECP_RESTARTABLE)
3904
3905 if (operation->ctx) {
3906 mbedtls_ecdsa_free(operation->ctx);
3907 mbedtls_free(operation->ctx);
Paul Elliottf9c91a72023-02-05 18:06:38 +00003908 operation->ctx = NULL;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003909 }
3910
3911 mbedtls_ecdsa_restart_free(&operation->restart_ctx);
3912
Paul Elliott93d9ca82023-02-15 18:14:21 +00003913 operation->num_ops = 0;
3914
Paul Elliott588f8ed2022-12-02 18:10:26 +00003915 mbedtls_mpi_free(&operation->r);
3916 mbedtls_mpi_free(&operation->s);
3917
3918 return PSA_SUCCESS;
3919
3920#else
3921 (void) operation;
3922
3923 return PSA_ERROR_NOT_SUPPORTED;
3924
3925#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3926 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3927 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3928}
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003929
mohammad1603503973b2018-03-12 15:59:30 +02003930/****************************************************************/
3931/* Symmetric cryptography */
3932/****************************************************************/
3933
Gilles Peskine449bd832023-01-11 14:50:10 +01003934static psa_status_t psa_cipher_setup(psa_cipher_operation_t *operation,
3935 mbedtls_svc_key_id_t key,
3936 psa_algorithm_t alg,
3937 mbedtls_operation_t cipher_operation)
Ronald Cronab99ac22020-10-01 16:38:28 +02003938{
3939 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3940 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman54648242021-06-24 11:49:45 +01003941 psa_key_slot_t *slot = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01003942 psa_key_usage_t usage = (cipher_operation == MBEDTLS_ENCRYPT ?
3943 PSA_KEY_USAGE_ENCRYPT :
3944 PSA_KEY_USAGE_DECRYPT);
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003945 psa_key_attributes_t attributes;
Ronald Cronab99ac22020-10-01 16:38:28 +02003946
3947 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003948 if (operation->id != 0) {
Dave Rodgman54648242021-06-24 11:49:45 +01003949 status = PSA_ERROR_BAD_STATE;
3950 goto exit;
3951 }
Ronald Cronab99ac22020-10-01 16:38:28 +02003952
Gilles Peskine449bd832023-01-11 14:50:10 +01003953 if (!PSA_ALG_IS_CIPHER(alg)) {
Dave Rodgman54648242021-06-24 11:49:45 +01003954 status = PSA_ERROR_INVALID_ARGUMENT;
3955 goto exit;
3956 }
Ronald Cronab99ac22020-10-01 16:38:28 +02003957
Gilles Peskine449bd832023-01-11 14:50:10 +01003958 status = psa_get_and_lock_key_slot_with_policy(key, &slot, usage, alg);
3959 if (status != PSA_SUCCESS) {
Ronald Cronab99ac22020-10-01 16:38:28 +02003960 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01003961 }
Ronald Cronab99ac22020-10-01 16:38:28 +02003962
Ronald Cron49fafa92021-03-10 08:34:23 +01003963 /* Initialize the operation struct members, except for id. The id member
Ronald Cronab99ac22020-10-01 16:38:28 +02003964 * is used to indicate to psa_cipher_abort that there are resources to free,
Ronald Cron49fafa92021-03-10 08:34:23 +01003965 * so we only set it (in the driver wrapper) after resources have been
3966 * allocated/initialized. */
Ronald Cronab99ac22020-10-01 16:38:28 +02003967 operation->iv_set = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01003968 if (alg == PSA_ALG_ECB_NO_PADDING) {
Ronald Cronab99ac22020-10-01 16:38:28 +02003969 operation->iv_required = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01003970 } else {
Ronald Cronab99ac22020-10-01 16:38:28 +02003971 operation->iv_required = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003972 }
3973 operation->default_iv_length = PSA_CIPHER_IV_LENGTH(slot->attr.type, alg);
Ronald Cronab99ac22020-10-01 16:38:28 +02003974
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003975 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01003976 .core = slot->attr
Ronald Crona4af55f2020-12-14 14:36:06 +01003977 };
3978
Ronald Cronab99ac22020-10-01 16:38:28 +02003979 /* Try doing the operation through a driver before using software fallback. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003980 if (cipher_operation == MBEDTLS_ENCRYPT) {
3981 status = psa_driver_wrapper_cipher_encrypt_setup(operation,
3982 &attributes,
3983 slot->key.data,
3984 slot->key.bytes,
3985 alg);
3986 } else {
3987 status = psa_driver_wrapper_cipher_decrypt_setup(operation,
3988 &attributes,
3989 slot->key.data,
3990 slot->key.bytes,
3991 alg);
3992 }
Ronald Cronab99ac22020-10-01 16:38:28 +02003993
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003994exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01003995 if (status != PSA_SUCCESS) {
3996 psa_cipher_abort(operation);
3997 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003998
Gilles Peskine449bd832023-01-11 14:50:10 +01003999 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02004000
Gilles Peskine449bd832023-01-11 14:50:10 +01004001 return (status == PSA_SUCCESS) ? unlock_status : status;
mohammad1603503973b2018-03-12 15:59:30 +02004002}
4003
Gilles Peskine449bd832023-01-11 14:50:10 +01004004psa_status_t psa_cipher_encrypt_setup(psa_cipher_operation_t *operation,
4005 mbedtls_svc_key_id_t key,
4006 psa_algorithm_t alg)
mohammad16038481e742018-03-18 13:57:31 +02004007{
Gilles Peskine449bd832023-01-11 14:50:10 +01004008 return psa_cipher_setup(operation, key, alg, MBEDTLS_ENCRYPT);
mohammad16038481e742018-03-18 13:57:31 +02004009}
4010
Gilles Peskine449bd832023-01-11 14:50:10 +01004011psa_status_t psa_cipher_decrypt_setup(psa_cipher_operation_t *operation,
4012 mbedtls_svc_key_id_t key,
4013 psa_algorithm_t alg)
mohammad16038481e742018-03-18 13:57:31 +02004014{
Gilles Peskine449bd832023-01-11 14:50:10 +01004015 return psa_cipher_setup(operation, key, alg, MBEDTLS_DECRYPT);
mohammad16038481e742018-03-18 13:57:31 +02004016}
4017
Gilles Peskine449bd832023-01-11 14:50:10 +01004018psa_status_t psa_cipher_generate_iv(psa_cipher_operation_t *operation,
4019 uint8_t *iv,
4020 size_t iv_size,
4021 size_t *iv_length)
mohammad1603503973b2018-03-12 15:59:30 +02004022{
Ronald Cron6d051732020-10-01 14:10:20 +02004023 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2fb90522021-07-05 12:31:44 +02004024 uint8_t local_iv[PSA_CIPHER_IV_MAX_SIZE];
Sergeybef1f632023-03-06 15:25:06 -07004025 size_t default_iv_length = 0;
Ronald Cron5618a392021-03-26 09:52:26 +01004026
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;
Ronald Cronc45b4af2020-09-29 16:18:05 +02004030 }
4031
Gilles Peskine449bd832023-01-11 14:50:10 +01004032 if (operation->iv_set || !operation->iv_required) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004033 status = PSA_ERROR_BAD_STATE;
4034 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004035 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004036
Ronald Cron2fb90522021-07-05 12:31:44 +02004037 default_iv_length = operation->default_iv_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01004038 if (iv_size < default_iv_length) {
Ronald Cron5618a392021-03-26 09:52:26 +01004039 status = PSA_ERROR_BUFFER_TOO_SMALL;
4040 goto exit;
4041 }
Gilles Peskinee553c652018-06-04 16:22:46 +02004042
Gilles Peskine449bd832023-01-11 14:50:10 +01004043 if (default_iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Ronald Cron2fb90522021-07-05 12:31:44 +02004044 status = PSA_ERROR_GENERIC_ERROR;
4045 goto exit;
4046 }
4047
Gilles Peskine449bd832023-01-11 14:50:10 +01004048 status = psa_generate_random(local_iv, default_iv_length);
4049 if (status != PSA_SUCCESS) {
Ronald Cron5618a392021-03-26 09:52:26 +01004050 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004051 }
Ronald Cron5618a392021-03-26 09:52:26 +01004052
Gilles Peskine449bd832023-01-11 14:50:10 +01004053 status = psa_driver_wrapper_cipher_set_iv(operation,
4054 local_iv, default_iv_length);
Ronald Cron5618a392021-03-26 09:52:26 +01004055
4056exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004057 if (status == PSA_SUCCESS) {
4058 memcpy(iv, local_iv, default_iv_length);
Ronald Cron2fb90522021-07-05 12:31:44 +02004059 *iv_length = default_iv_length;
Steven Cooreman7df02922020-09-09 15:28:49 +02004060 operation->iv_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004061 } else {
Ronald Cron2fb90522021-07-05 12:31:44 +02004062 *iv_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004063 psa_cipher_abort(operation);
Ronald Cron2fb90522021-07-05 12:31:44 +02004064 }
Ronald Cron6d051732020-10-01 14:10:20 +02004065
Gilles Peskine449bd832023-01-11 14:50:10 +01004066 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004067}
4068
Gilles Peskine449bd832023-01-11 14:50:10 +01004069psa_status_t psa_cipher_set_iv(psa_cipher_operation_t *operation,
4070 const uint8_t *iv,
4071 size_t iv_length)
mohammad1603503973b2018-03-12 15:59:30 +02004072{
Ronald Cron6d051732020-10-01 14:10:20 +02004073 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronc45b4af2020-09-29 16:18:05 +02004074
Gilles Peskine449bd832023-01-11 14:50:10 +01004075 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004076 status = PSA_ERROR_BAD_STATE;
4077 goto exit;
4078 }
Ronald Cronc45b4af2020-09-29 16:18:05 +02004079
Gilles Peskine449bd832023-01-11 14:50:10 +01004080 if (operation->iv_set || !operation->iv_required) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004081 status = PSA_ERROR_BAD_STATE;
4082 goto exit;
4083 }
Ronald Crona0d68172021-03-26 10:15:08 +01004084
Gilles Peskine449bd832023-01-11 14:50:10 +01004085 if (iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004086 status = PSA_ERROR_INVALID_ARGUMENT;
4087 goto exit;
4088 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004089
Gilles Peskine449bd832023-01-11 14:50:10 +01004090 status = psa_driver_wrapper_cipher_set_iv(operation,
4091 iv,
4092 iv_length);
Steven Cooremand3feccd2020-09-01 15:56:14 +02004093
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004094exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004095 if (status == PSA_SUCCESS) {
itayzafrir534bd7c2018-08-02 13:56:32 +03004096 operation->iv_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004097 } else {
4098 psa_cipher_abort(operation);
4099 }
4100 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004101}
4102
Gilles Peskine449bd832023-01-11 14:50:10 +01004103psa_status_t psa_cipher_update(psa_cipher_operation_t *operation,
4104 const uint8_t *input,
4105 size_t input_length,
4106 uint8_t *output,
4107 size_t output_size,
4108 size_t *output_length)
mohammad1603503973b2018-03-12 15:59:30 +02004109{
Steven Cooremanffecb7b2020-08-25 15:13:13 +02004110 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron6d051732020-10-01 14:10:20 +02004111
Gilles Peskine449bd832023-01-11 14:50:10 +01004112 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004113 status = PSA_ERROR_BAD_STATE;
4114 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004115 }
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004116
Gilles Peskine449bd832023-01-11 14:50:10 +01004117 if (operation->iv_required && !operation->iv_set) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004118 status = PSA_ERROR_BAD_STATE;
4119 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004120 }
Jaeden Ameroab439972019-02-15 14:12:05 +00004121
Gilles Peskine449bd832023-01-11 14:50:10 +01004122 status = psa_driver_wrapper_cipher_update(operation,
4123 input,
4124 input_length,
4125 output,
4126 output_size,
4127 output_length);
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004128
4129exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004130 if (status != PSA_SUCCESS) {
4131 psa_cipher_abort(operation);
4132 }
Ronald Cron6d051732020-10-01 14:10:20 +02004133
Gilles Peskine449bd832023-01-11 14:50:10 +01004134 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004135}
4136
Gilles Peskine449bd832023-01-11 14:50:10 +01004137psa_status_t psa_cipher_finish(psa_cipher_operation_t *operation,
4138 uint8_t *output,
4139 size_t output_size,
4140 size_t *output_length)
mohammad1603503973b2018-03-12 15:59:30 +02004141{
David Saadab4ecc272019-02-14 13:48:10 +02004142 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Ronald Cron6d051732020-10-01 14:10:20 +02004143
Gilles Peskine449bd832023-01-11 14:50:10 +01004144 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004145 status = PSA_ERROR_BAD_STATE;
4146 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004147 }
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004148
Gilles Peskine449bd832023-01-11 14:50:10 +01004149 if (operation->iv_required && !operation->iv_set) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004150 status = PSA_ERROR_BAD_STATE;
4151 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004152 }
Moran Pekerbed71a22018-04-22 20:19:20 +03004153
Gilles Peskine449bd832023-01-11 14:50:10 +01004154 status = psa_driver_wrapper_cipher_finish(operation,
4155 output,
4156 output_size,
4157 output_length);
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004158
4159exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004160 if (status == PSA_SUCCESS) {
4161 return psa_cipher_abort(operation);
4162 } else {
Steven Cooremanef8575e2020-09-11 11:44:50 +02004163 *output_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004164 (void) psa_cipher_abort(operation);
Janos Follath315b51c2018-07-09 16:04:51 +01004165
Gilles Peskine449bd832023-01-11 14:50:10 +01004166 return status;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004167 }
mohammad1603503973b2018-03-12 15:59:30 +02004168}
4169
Gilles Peskine449bd832023-01-11 14:50:10 +01004170psa_status_t psa_cipher_abort(psa_cipher_operation_t *operation)
Gilles Peskinee553c652018-06-04 16:22:46 +02004171{
Gilles Peskine449bd832023-01-11 14:50:10 +01004172 if (operation->id == 0) {
Steven Cooremana07b9972020-09-10 14:54:14 +02004173 /* The object has (apparently) been initialized but it is not (yet)
Gilles Peskine81736312018-06-26 15:04:31 +02004174 * in use. It's ok to call abort on such an object, and there's
4175 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004176 return PSA_SUCCESS;
Gilles Peskine81736312018-06-26 15:04:31 +02004177 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004178
Gilles Peskine449bd832023-01-11 14:50:10 +01004179 psa_driver_wrapper_cipher_abort(operation);
Gilles Peskinee553c652018-06-04 16:22:46 +02004180
Ronald Cron49fafa92021-03-10 08:34:23 +01004181 operation->id = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004182 operation->iv_set = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004183 operation->iv_required = 0;
Moran Peker41deec42018-04-04 15:43:05 +03004184
Gilles Peskine449bd832023-01-11 14:50:10 +01004185 return PSA_SUCCESS;
mohammad1603503973b2018-03-12 15:59:30 +02004186}
4187
Gilles Peskine449bd832023-01-11 14:50:10 +01004188psa_status_t psa_cipher_encrypt(mbedtls_svc_key_id_t key,
4189 psa_algorithm_t alg,
4190 const uint8_t *input,
4191 size_t input_length,
4192 uint8_t *output,
4193 size_t output_size,
4194 size_t *output_length)
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004195{
4196 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004197 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron23919522021-07-08 19:00:07 +02004198 psa_key_slot_t *slot = NULL;
Ronald Cronc6e6f502021-07-09 18:44:58 +02004199 uint8_t local_iv[PSA_CIPHER_IV_MAX_SIZE];
4200 size_t default_iv_length = 0;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004201 psa_key_attributes_t attributes;
gabor-mezei-arm6f4e5bb2021-06-25 15:21:11 +02004202
Gilles Peskine449bd832023-01-11 14:50:10 +01004203 if (!PSA_ALG_IS_CIPHER(alg)) {
Ronald Cron23919522021-07-08 19:00:07 +02004204 status = PSA_ERROR_INVALID_ARGUMENT;
4205 goto exit;
4206 }
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004207
Gilles Peskine449bd832023-01-11 14:50:10 +01004208 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
4209 PSA_KEY_USAGE_ENCRYPT,
4210 alg);
4211 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004212 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004213 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004214
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004215 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004216 .core = slot->attr
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004217 };
4218
Gilles Peskine449bd832023-01-11 14:50:10 +01004219 default_iv_length = PSA_CIPHER_IV_LENGTH(slot->attr.type, alg);
4220 if (default_iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Ronald Cronc6e6f502021-07-09 18:44:58 +02004221 status = PSA_ERROR_GENERIC_ERROR;
4222 goto exit;
4223 }
4224
Gilles Peskine449bd832023-01-11 14:50:10 +01004225 if (default_iv_length > 0) {
4226 if (output_size < default_iv_length) {
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004227 status = PSA_ERROR_BUFFER_TOO_SMALL;
4228 goto exit;
4229 }
4230
Gilles Peskine449bd832023-01-11 14:50:10 +01004231 status = psa_generate_random(local_iv, default_iv_length);
4232 if (status != PSA_SUCCESS) {
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004233 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004234 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004235 }
4236
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004237 status = psa_driver_wrapper_cipher_encrypt(
4238 &attributes, slot->key.data, slot->key.bytes,
Ronald Cronc6e6f502021-07-09 18:44:58 +02004239 alg, local_iv, default_iv_length, input, input_length,
Ronald Cronafbc7ed2023-01-24 16:02:04 +01004240 psa_crypto_buffer_offset(output, default_iv_length),
Gilles Peskine449bd832023-01-11 14:50:10 +01004241 output_size - default_iv_length, output_length);
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004242
4243exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004244 unlock_status = psa_unlock_key_slot(slot);
4245 if (status == PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004246 status = unlock_status;
Ronald Cronc6e6f502021-07-09 18:44:58 +02004247 }
Ronald Cron23919522021-07-08 19:00:07 +02004248
Gilles Peskine449bd832023-01-11 14:50:10 +01004249 if (status == PSA_SUCCESS) {
4250 if (default_iv_length > 0) {
4251 memcpy(output, local_iv, default_iv_length);
4252 }
4253 *output_length += default_iv_length;
4254 } else {
4255 *output_length = 0;
4256 }
4257
4258 return status;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004259}
4260
Gilles Peskine449bd832023-01-11 14:50:10 +01004261psa_status_t psa_cipher_decrypt(mbedtls_svc_key_id_t key,
4262 psa_algorithm_t alg,
4263 const uint8_t *input,
4264 size_t input_length,
4265 uint8_t *output,
4266 size_t output_size,
4267 size_t *output_length)
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004268{
4269 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004270 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron23919522021-07-08 19:00:07 +02004271 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004272 psa_key_attributes_t attributes;
gabor-mezei-arm6f4e5bb2021-06-25 15:21:11 +02004273
Gilles Peskine449bd832023-01-11 14:50:10 +01004274 if (!PSA_ALG_IS_CIPHER(alg)) {
Ronald Cron23919522021-07-08 19:00:07 +02004275 status = PSA_ERROR_INVALID_ARGUMENT;
4276 goto exit;
4277 }
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004278
Gilles Peskine449bd832023-01-11 14:50:10 +01004279 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
4280 PSA_KEY_USAGE_DECRYPT,
4281 alg);
4282 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004283 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004284 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004285
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004286 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004287 .core = slot->attr
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004288 };
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004289
Gilles Peskine449bd832023-01-11 14:50:10 +01004290 if (alg == PSA_ALG_CCM_STAR_NO_TAG &&
4291 input_length < PSA_BLOCK_CIPHER_BLOCK_LENGTH(slot->attr.type)) {
Mateusz Starzyk594215b2021-10-14 12:23:06 +02004292 status = PSA_ERROR_INVALID_ARGUMENT;
4293 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004294 } else if (input_length < PSA_CIPHER_IV_LENGTH(slot->attr.type, alg)) {
gabor-mezei-arm258ae072021-06-25 15:25:38 +02004295 status = PSA_ERROR_INVALID_ARGUMENT;
4296 goto exit;
4297 }
4298
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004299 status = psa_driver_wrapper_cipher_decrypt(
4300 &attributes, slot->key.data, slot->key.bytes,
4301 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004302 output, output_size, output_length);
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004303
gabor-mezei-arm258ae072021-06-25 15:25:38 +02004304exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004305 unlock_status = psa_unlock_key_slot(slot);
4306 if (status == PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004307 status = unlock_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01004308 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004309
Gilles Peskine449bd832023-01-11 14:50:10 +01004310 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004311 *output_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004312 }
Ronald Cron23919522021-07-08 19:00:07 +02004313
Gilles Peskine449bd832023-01-11 14:50:10 +01004314 return status;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004315}
4316
4317
mohammad16035955c982018-04-26 00:53:03 +03004318/****************************************************************/
4319/* AEAD */
4320/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004321
Paul Elliottbaff51c2021-09-28 17:44:45 +01004322/* Helper function to get the base algorithm from its variants. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004323static psa_algorithm_t psa_aead_get_base_algorithm(psa_algorithm_t alg)
Paul Elliottbaff51c2021-09-28 17:44:45 +01004324{
Gilles Peskine449bd832023-01-11 14:50:10 +01004325 return PSA_ALG_AEAD_WITH_DEFAULT_LENGTH_TAG(alg);
Paul Elliottbaff51c2021-09-28 17:44:45 +01004326}
4327
4328/* Helper function to perform common nonce length checks. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004329static psa_status_t psa_aead_check_nonce_length(psa_algorithm_t alg,
4330 size_t nonce_length)
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004331{
Gilles Peskine449bd832023-01-11 14:50:10 +01004332 psa_algorithm_t base_alg = psa_aead_get_base_algorithm(alg);
Paul Elliottbaff51c2021-09-28 17:44:45 +01004333
Gilles Peskine449bd832023-01-11 14:50:10 +01004334 switch (base_alg) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004335#if defined(PSA_WANT_ALG_GCM)
4336 case PSA_ALG_GCM:
4337 /* Not checking max nonce size here as GCM spec allows almost
Gilles Peskine449bd832023-01-11 14:50:10 +01004338 * arbitrarily large nonces. Please note that we do not generally
4339 * recommend the usage of nonces of greater length than
4340 * PSA_AEAD_NONCE_MAX_SIZE, as large nonces are hashed to a shorter
4341 * size, which can then lead to collisions if you encrypt a very
4342 * large number of messages.*/
4343 if (nonce_length != 0) {
4344 return PSA_SUCCESS;
4345 }
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004346 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004347#endif /* PSA_WANT_ALG_GCM */
4348#if defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004349 case PSA_ALG_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01004350 if (nonce_length >= 7 && nonce_length <= 13) {
4351 return PSA_SUCCESS;
4352 }
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004353 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004354#endif /* PSA_WANT_ALG_CCM */
4355#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004356 case PSA_ALG_CHACHA20_POLY1305:
Gilles Peskine449bd832023-01-11 14:50:10 +01004357 if (nonce_length == 12) {
4358 return PSA_SUCCESS;
4359 } else if (nonce_length == 8) {
4360 return PSA_ERROR_NOT_SUPPORTED;
4361 }
Bence Szépkúti6d48e202021-11-15 20:04:15 +01004362 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004363#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004364 default:
Przemek Stekiel4c499272022-09-27 13:55:37 +02004365 (void) nonce_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01004366 return PSA_ERROR_NOT_SUPPORTED;
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004367 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004368
Gilles Peskine449bd832023-01-11 14:50:10 +01004369 return PSA_ERROR_INVALID_ARGUMENT;
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004370}
4371
Gilles Peskine449bd832023-01-11 14:50:10 +01004372static psa_status_t psa_aead_check_algorithm(psa_algorithm_t alg)
Bence Szépkútiaa3a6e42022-01-13 16:26:03 +01004373{
Gilles Peskine449bd832023-01-11 14:50:10 +01004374 if (!PSA_ALG_IS_AEAD(alg) || PSA_ALG_IS_WILDCARD(alg)) {
4375 return PSA_ERROR_INVALID_ARGUMENT;
4376 }
Bence Szépkúti08f34652021-12-08 21:07:13 +01004377
Gilles Peskine449bd832023-01-11 14:50:10 +01004378 return PSA_SUCCESS;
Bence Szépkúti08f34652021-12-08 21:07:13 +01004379}
4380
Gilles Peskine449bd832023-01-11 14:50:10 +01004381psa_status_t psa_aead_encrypt(mbedtls_svc_key_id_t key,
4382 psa_algorithm_t alg,
4383 const uint8_t *nonce,
4384 size_t nonce_length,
4385 const uint8_t *additional_data,
4386 size_t additional_data_length,
4387 const uint8_t *plaintext,
4388 size_t plaintext_length,
4389 uint8_t *ciphertext,
4390 size_t ciphertext_size,
4391 size_t *ciphertext_length)
mohammad16035955c982018-04-26 00:53:03 +03004392{
Ronald Cron215633c2021-03-16 17:15:37 +01004393 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4394 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02004395
mohammad1603f08a5502018-06-03 15:05:47 +03004396 *ciphertext_length = 0;
mohammad1603e58e6842018-05-09 04:58:32 -07004397
Gilles Peskine449bd832023-01-11 14:50:10 +01004398 status = psa_aead_check_algorithm(alg);
4399 if (status != PSA_SUCCESS) {
4400 return status;
4401 }
Steven Cooremanea7ab132021-03-17 16:28:00 +01004402
Ronald Cron9a986162021-03-26 12:40:07 +01004403 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01004404 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg);
4405 if (status != PSA_SUCCESS) {
4406 return status;
4407 }
mohammad16035955c982018-04-26 00:53:03 +03004408
Ronald Cron215633c2021-03-16 17:15:37 +01004409 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01004410 .core = slot->attr
Ronald Cron215633c2021-03-16 17:15:37 +01004411 };
mohammad16035955c982018-04-26 00:53:03 +03004412
Gilles Peskine449bd832023-01-11 14:50:10 +01004413 status = psa_aead_check_nonce_length(alg, nonce_length);
4414 if (status != PSA_SUCCESS) {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004415 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004416 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004417
Ronald Cronde822812021-03-17 16:08:20 +01004418 status = psa_driver_wrapper_aead_encrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01004419 &attributes, slot->key.data, slot->key.bytes,
4420 alg,
4421 nonce, nonce_length,
4422 additional_data, additional_data_length,
4423 plaintext, plaintext_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004424 ciphertext, ciphertext_size, ciphertext_length);
Gilles Peskine2d277862018-06-18 15:41:12 +02004425
Gilles Peskine449bd832023-01-11 14:50:10 +01004426 if (status != PSA_SUCCESS && ciphertext_size != 0) {
4427 memset(ciphertext, 0, ciphertext_size);
4428 }
Gilles Peskine2d277862018-06-18 15:41:12 +02004429
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004430exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004431 psa_unlock_key_slot(slot);
mohammad16035955c982018-04-26 00:53:03 +03004432
Gilles Peskine449bd832023-01-11 14:50:10 +01004433 return status;
Gilles Peskineee652a32018-06-01 19:23:52 +02004434}
4435
Gilles Peskine449bd832023-01-11 14:50:10 +01004436psa_status_t psa_aead_decrypt(mbedtls_svc_key_id_t key,
4437 psa_algorithm_t alg,
4438 const uint8_t *nonce,
4439 size_t nonce_length,
4440 const uint8_t *additional_data,
4441 size_t additional_data_length,
4442 const uint8_t *ciphertext,
4443 size_t ciphertext_length,
4444 uint8_t *plaintext,
4445 size_t plaintext_size,
4446 size_t *plaintext_length)
mohammad16035955c982018-04-26 00:53:03 +03004447{
Ronald Cron215633c2021-03-16 17:15:37 +01004448 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4449 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02004450
Gilles Peskineee652a32018-06-01 19:23:52 +02004451 *plaintext_length = 0;
mohammad16039e5a5152018-04-26 12:07:35 +03004452
Gilles Peskine449bd832023-01-11 14:50:10 +01004453 status = psa_aead_check_algorithm(alg);
4454 if (status != PSA_SUCCESS) {
4455 return status;
4456 }
Steven Cooremanea7ab132021-03-17 16:28:00 +01004457
Ronald Cron9a986162021-03-26 12:40:07 +01004458 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01004459 key, &slot, PSA_KEY_USAGE_DECRYPT, alg);
4460 if (status != PSA_SUCCESS) {
4461 return status;
4462 }
mohammad16035955c982018-04-26 00:53:03 +03004463
Ronald Cron215633c2021-03-16 17:15:37 +01004464 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01004465 .core = slot->attr
Ronald Cron215633c2021-03-16 17:15:37 +01004466 };
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004467
Gilles Peskine449bd832023-01-11 14:50:10 +01004468 status = psa_aead_check_nonce_length(alg, nonce_length);
4469 if (status != PSA_SUCCESS) {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004470 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004471 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004472
Ronald Cronde822812021-03-17 16:08:20 +01004473 status = psa_driver_wrapper_aead_decrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01004474 &attributes, slot->key.data, slot->key.bytes,
4475 alg,
4476 nonce, nonce_length,
4477 additional_data, additional_data_length,
4478 ciphertext, ciphertext_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004479 plaintext, plaintext_size, plaintext_length);
Gilles Peskinea40d7742018-06-01 16:28:30 +02004480
Gilles Peskine449bd832023-01-11 14:50:10 +01004481 if (status != PSA_SUCCESS && plaintext_size != 0) {
4482 memset(plaintext, 0, plaintext_size);
4483 }
mohammad160360a64d02018-06-03 17:20:42 +03004484
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004485exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004486 psa_unlock_key_slot(slot);
Ronald Cron215633c2021-03-16 17:15:37 +01004487
Gilles Peskine449bd832023-01-11 14:50:10 +01004488 return status;
mohammad16035955c982018-04-26 00:53:03 +03004489}
4490
Gilles Peskine449bd832023-01-11 14:50:10 +01004491static psa_status_t psa_validate_tag_length(psa_algorithm_t alg)
4492{
4493 const uint8_t tag_len = PSA_ALG_AEAD_GET_TAG_LENGTH(alg);
Andrzej Kurekf8816012021-12-19 17:00:12 +01004494
Gilles Peskine449bd832023-01-11 14:50:10 +01004495 switch (PSA_ALG_AEAD_WITH_SHORTENED_TAG(alg, 0)) {
Przemek Stekiel86679c72022-10-06 17:06:56 +02004496#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004497 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004498 /* CCM allows the following tag lengths: 4, 6, 8, 10, 12, 14, 16.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004499 if (tag_len < 4 || tag_len > 16 || tag_len % 2) {
4500 return PSA_ERROR_INVALID_ARGUMENT;
4501 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01004502 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02004503#endif /* PSA_WANT_ALG_CCM */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004504
Przemek Stekiel86679c72022-10-06 17:06:56 +02004505#if defined(PSA_WANT_ALG_GCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004506 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_GCM, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004507 /* GCM allows the following tag lengths: 4, 8, 12, 13, 14, 15, 16. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004508 if (tag_len != 4 && tag_len != 8 && (tag_len < 12 || tag_len > 16)) {
4509 return PSA_ERROR_INVALID_ARGUMENT;
4510 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01004511 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02004512#endif /* PSA_WANT_ALG_GCM */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004513
Przemek Stekiel86679c72022-10-06 17:06:56 +02004514#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Gilles Peskine449bd832023-01-11 14:50:10 +01004515 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CHACHA20_POLY1305, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004516 /* We only support the default tag length. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004517 if (tag_len != 16) {
4518 return PSA_ERROR_INVALID_ARGUMENT;
4519 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01004520 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02004521#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004522
4523 default:
4524 (void) tag_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004525 return PSA_ERROR_NOT_SUPPORTED;
Andrzej Kurekf8816012021-12-19 17:00:12 +01004526 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004527 return PSA_SUCCESS;
Andrzej Kurekf8816012021-12-19 17:00:12 +01004528}
4529
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004530/* Set the key for a multipart authenticated operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004531static psa_status_t psa_aead_setup(psa_aead_operation_t *operation,
4532 int is_encrypt,
4533 mbedtls_svc_key_id_t key,
4534 psa_algorithm_t alg)
Paul Elliottc2b71442021-06-24 18:17:52 +01004535{
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004536 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4537 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
4538 psa_key_slot_t *slot = NULL;
4539 psa_key_usage_t key_usage = 0;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004540 psa_key_attributes_t attributes;
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004541
Gilles Peskine449bd832023-01-11 14:50:10 +01004542 status = psa_aead_check_algorithm(alg);
4543 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004544 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004545 }
Paul Elliottc2b71442021-06-24 18:17:52 +01004546
Gilles Peskine449bd832023-01-11 14:50:10 +01004547 if (operation->id != 0) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004548 status = PSA_ERROR_BAD_STATE;
4549 goto exit;
Paul Elliottc2b71442021-06-24 18:17:52 +01004550 }
4551
Gilles Peskine449bd832023-01-11 14:50:10 +01004552 if (operation->nonce_set || operation->lengths_set ||
4553 operation->ad_started || operation->body_started) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004554 status = PSA_ERROR_BAD_STATE;
4555 goto exit;
Paul Elliottc2b71442021-06-24 18:17:52 +01004556 }
4557
Gilles Peskine449bd832023-01-11 14:50:10 +01004558 if (is_encrypt) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004559 key_usage = PSA_KEY_USAGE_ENCRYPT;
Gilles Peskine449bd832023-01-11 14:50:10 +01004560 } else {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004561 key_usage = PSA_KEY_USAGE_DECRYPT;
Gilles Peskine449bd832023-01-11 14:50:10 +01004562 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004563
Gilles Peskine449bd832023-01-11 14:50:10 +01004564 status = psa_get_and_lock_key_slot_with_policy(key, &slot, key_usage,
4565 alg);
4566 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004567 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004568 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004569
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004570 attributes = (psa_key_attributes_t) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004571 .core = slot->attr
4572 };
4573
Gilles Peskine449bd832023-01-11 14:50:10 +01004574 if ((status = psa_validate_tag_length(alg)) != PSA_SUCCESS) {
Przemek Stekiel6ab50762022-10-08 17:54:30 +02004575 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004576 }
Przemek Stekiel6ab50762022-10-08 17:54:30 +02004577
Gilles Peskine449bd832023-01-11 14:50:10 +01004578 if (is_encrypt) {
4579 status = psa_driver_wrapper_aead_encrypt_setup(operation,
4580 &attributes,
4581 slot->key.data,
4582 slot->key.bytes,
4583 alg);
4584 } else {
4585 status = psa_driver_wrapper_aead_decrypt_setup(operation,
4586 &attributes,
4587 slot->key.data,
4588 slot->key.bytes,
4589 alg);
4590 }
4591 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004592 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004593 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004594
Gilles Peskine449bd832023-01-11 14:50:10 +01004595 operation->key_type = psa_get_key_type(&attributes);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004596
4597exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004598 unlock_status = psa_unlock_key_slot(slot);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004599
Gilles Peskine449bd832023-01-11 14:50:10 +01004600 if (status == PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004601 status = unlock_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01004602 operation->alg = psa_aead_get_base_algorithm(alg);
Paul Elliottd9343f22021-08-23 18:59:49 +01004603 operation->is_encrypt = is_encrypt;
Gilles Peskine449bd832023-01-11 14:50:10 +01004604 } else {
4605 psa_aead_abort(operation);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004606 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004607
Gilles Peskine449bd832023-01-11 14:50:10 +01004608 return status;
Paul Elliottc2b71442021-06-24 18:17:52 +01004609}
4610
Paul Elliott302ff6b2021-04-20 18:10:30 +01004611/* Set the key for a multipart authenticated encryption operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004612psa_status_t psa_aead_encrypt_setup(psa_aead_operation_t *operation,
4613 mbedtls_svc_key_id_t key,
4614 psa_algorithm_t alg)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004615{
Gilles Peskine449bd832023-01-11 14:50:10 +01004616 return psa_aead_setup(operation, 1, key, alg);
Paul Elliott302ff6b2021-04-20 18:10:30 +01004617}
4618
4619/* Set the key for a multipart authenticated decryption operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004620psa_status_t psa_aead_decrypt_setup(psa_aead_operation_t *operation,
4621 mbedtls_svc_key_id_t key,
4622 psa_algorithm_t alg)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004623{
Gilles Peskine449bd832023-01-11 14:50:10 +01004624 return psa_aead_setup(operation, 0, key, alg);
Paul Elliott302ff6b2021-04-20 18:10:30 +01004625}
4626
4627/* Generate a random nonce / IV for multipart AEAD operation */
Gilles Peskine449bd832023-01-11 14:50:10 +01004628psa_status_t psa_aead_generate_nonce(psa_aead_operation_t *operation,
4629 uint8_t *nonce,
4630 size_t nonce_size,
4631 size_t *nonce_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004632{
4633 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Croncae59092021-11-26 18:53:58 +01004634 uint8_t local_nonce[PSA_AEAD_NONCE_MAX_SIZE];
Sergeybef1f632023-03-06 15:25:06 -07004635 size_t required_nonce_size = 0;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004636
Paul Elliott8eb9daf2021-06-04 16:42:21 +01004637 *nonce_length = 0;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004638
Gilles Peskine449bd832023-01-11 14:50:10 +01004639 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004640 status = PSA_ERROR_BAD_STATE;
4641 goto exit;
4642 }
4643
Gilles Peskine449bd832023-01-11 14:50:10 +01004644 if (operation->nonce_set || !operation->is_encrypt) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004645 status = PSA_ERROR_BAD_STATE;
4646 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004647 }
4648
Paul Elliotte193ea82021-10-01 13:00:16 +01004649 /* For CCM, this size may not be correct according to the PSA
4650 * specification. The PSA Crypto 1.0.1 specification states:
4651 *
4652 * CCM encodes the plaintext length pLen in L octets, with L the smallest
4653 * integer >= 2 where pLen < 2^(8L). The nonce length is then 15 - L bytes.
4654 *
4655 * However this restriction that L has to be the smallest integer is not
4656 * applied in practice, and it is not implementable here since the
4657 * plaintext length may or may not be known at this time. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004658 required_nonce_size = PSA_AEAD_NONCE_LENGTH(operation->key_type,
4659 operation->alg);
4660 if (nonce_size < required_nonce_size) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004661 status = PSA_ERROR_BUFFER_TOO_SMALL;
4662 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004663 }
4664
Gilles Peskine449bd832023-01-11 14:50:10 +01004665 status = psa_generate_random(local_nonce, required_nonce_size);
4666 if (status != PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004667 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004668 }
Paul Elliott302ff6b2021-04-20 18:10:30 +01004669
Gilles Peskine449bd832023-01-11 14:50:10 +01004670 status = psa_aead_set_nonce(operation, local_nonce, required_nonce_size);
Paul Elliott302ff6b2021-04-20 18:10:30 +01004671
Paul Elliott39dc6b82021-05-11 19:16:09 +01004672exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004673 if (status == PSA_SUCCESS) {
4674 memcpy(nonce, local_nonce, required_nonce_size);
Paul Elliott39dc6b82021-05-11 19:16:09 +01004675 *nonce_length = required_nonce_size;
Gilles Peskine449bd832023-01-11 14:50:10 +01004676 } else {
4677 psa_aead_abort(operation);
Ronald Croncae59092021-11-26 18:53:58 +01004678 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01004679
Gilles Peskine449bd832023-01-11 14:50:10 +01004680 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004681}
4682
4683/* Set the nonce for a multipart authenticated encryption or decryption
4684 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004685psa_status_t psa_aead_set_nonce(psa_aead_operation_t *operation,
4686 const uint8_t *nonce,
4687 size_t nonce_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004688{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004689 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4690
Gilles Peskine449bd832023-01-11 14:50:10 +01004691 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004692 status = PSA_ERROR_BAD_STATE;
4693 goto exit;
4694 }
4695
Gilles Peskine449bd832023-01-11 14:50:10 +01004696 if (operation->nonce_set) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004697 status = PSA_ERROR_BAD_STATE;
4698 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004699 }
4700
Gilles Peskine449bd832023-01-11 14:50:10 +01004701 status = psa_aead_check_nonce_length(operation->alg, nonce_length);
4702 if (status != PSA_SUCCESS) {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004703 status = PSA_ERROR_INVALID_ARGUMENT;
4704 goto exit;
Paul Elliott4ed1ed12021-09-27 18:09:28 +01004705 }
Paul Elliott1a98aca2021-05-20 18:24:07 +01004706
Gilles Peskine449bd832023-01-11 14:50:10 +01004707 status = psa_driver_wrapper_aead_set_nonce(operation, nonce,
4708 nonce_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004709
Paul Elliott39dc6b82021-05-11 19:16:09 +01004710exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004711 if (status == PSA_SUCCESS) {
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004712 operation->nonce_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004713 } else {
4714 psa_aead_abort(operation);
4715 }
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004716
Gilles Peskine449bd832023-01-11 14:50:10 +01004717 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004718}
4719
4720/* Declare the lengths of the message and additional data for multipart AEAD. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004721psa_status_t psa_aead_set_lengths(psa_aead_operation_t *operation,
4722 size_t ad_length,
4723 size_t plaintext_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004724{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004725 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4726
Gilles Peskine449bd832023-01-11 14:50:10 +01004727 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004728 status = PSA_ERROR_BAD_STATE;
4729 goto exit;
4730 }
4731
Gilles Peskine449bd832023-01-11 14:50:10 +01004732 if (operation->lengths_set || operation->ad_started ||
4733 operation->body_started) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004734 status = PSA_ERROR_BAD_STATE;
4735 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004736 }
4737
Gilles Peskine449bd832023-01-11 14:50:10 +01004738 switch (operation->alg) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004739#if defined(PSA_WANT_ALG_GCM)
4740 case PSA_ALG_GCM:
4741 /* Lengths can only be too large for GCM if size_t is bigger than 32
Gilles Peskine449bd832023-01-11 14:50:10 +01004742 * bits. Without the guard this code will generate warnings on 32bit
4743 * builds. */
Paul Elliott325d3742021-09-27 17:56:28 +01004744#if SIZE_MAX > UINT32_MAX
Gilles Peskine449bd832023-01-11 14:50:10 +01004745 if (((uint64_t) ad_length) >> 61 != 0 ||
4746 ((uint64_t) plaintext_length) > 0xFFFFFFFE0ull) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004747 status = PSA_ERROR_INVALID_ARGUMENT;
4748 goto exit;
4749 }
Paul Elliott325d3742021-09-27 17:56:28 +01004750#endif
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004751 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004752#endif /* PSA_WANT_ALG_GCM */
4753#if defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004754 case PSA_ALG_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01004755 if (ad_length > 0xFF00) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004756 status = PSA_ERROR_INVALID_ARGUMENT;
4757 goto exit;
4758 }
4759 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004760#endif /* PSA_WANT_ALG_CCM */
4761#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004762 case PSA_ALG_CHACHA20_POLY1305:
4763 /* No length restrictions for ChaChaPoly. */
4764 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004765#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004766 default:
4767 break;
4768 }
Paul Elliott325d3742021-09-27 17:56:28 +01004769
Gilles Peskine449bd832023-01-11 14:50:10 +01004770 status = psa_driver_wrapper_aead_set_lengths(operation, ad_length,
4771 plaintext_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004772
Paul Elliott39dc6b82021-05-11 19:16:09 +01004773exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004774 if (status == PSA_SUCCESS) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01004775 operation->ad_remaining = ad_length;
4776 operation->body_remaining = plaintext_length;
Paul Elliott39dc6b82021-05-11 19:16:09 +01004777 operation->lengths_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004778 } else {
4779 psa_aead_abort(operation);
Paul Elliottee4ffe02021-05-20 17:25:06 +01004780 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01004781
Gilles Peskine449bd832023-01-11 14:50:10 +01004782 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004783}
Paul Elliott3d7d52c2021-09-01 10:33:14 +01004784
4785/* Pass additional data to an active multipart AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004786psa_status_t psa_aead_update_ad(psa_aead_operation_t *operation,
4787 const uint8_t *input,
4788 size_t input_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004789{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004790 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4791
Gilles Peskine449bd832023-01-11 14:50:10 +01004792 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004793 status = PSA_ERROR_BAD_STATE;
4794 goto exit;
4795 }
4796
Gilles Peskine449bd832023-01-11 14:50:10 +01004797 if (!operation->nonce_set || operation->body_started) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004798 status = PSA_ERROR_BAD_STATE;
4799 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004800 }
4801
Gilles Peskine449bd832023-01-11 14:50:10 +01004802 if (operation->lengths_set) {
4803 if (operation->ad_remaining < input_length) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01004804 status = PSA_ERROR_INVALID_ARGUMENT;
4805 goto exit;
4806 }
4807
4808 operation->ad_remaining -= input_length;
4809 }
Paul Elliotte193ea82021-10-01 13:00:16 +01004810#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004811 else if (operation->alg == PSA_ALG_CCM) {
Paul Elliotte193ea82021-10-01 13:00:16 +01004812 status = PSA_ERROR_BAD_STATE;
4813 goto exit;
4814 }
4815#endif /* PSA_WANT_ALG_CCM */
Paul Elliottee4ffe02021-05-20 17:25:06 +01004816
Gilles Peskine449bd832023-01-11 14:50:10 +01004817 status = psa_driver_wrapper_aead_update_ad(operation, input,
4818 input_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004819
Paul Elliott39dc6b82021-05-11 19:16:09 +01004820exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004821 if (status == PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004822 operation->ad_started = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004823 } else {
4824 psa_aead_abort(operation);
4825 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01004826
Gilles Peskine449bd832023-01-11 14:50:10 +01004827 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004828}
4829
4830/* Encrypt or decrypt a message fragment in an active multipart AEAD
4831 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004832psa_status_t psa_aead_update(psa_aead_operation_t *operation,
4833 const uint8_t *input,
4834 size_t input_length,
4835 uint8_t *output,
4836 size_t output_size,
4837 size_t *output_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004838{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004839 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004840
4841 *output_length = 0;
4842
Gilles Peskine449bd832023-01-11 14:50:10 +01004843 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004844 status = PSA_ERROR_BAD_STATE;
4845 goto exit;
4846 }
4847
Gilles Peskine449bd832023-01-11 14:50:10 +01004848 if (!operation->nonce_set) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004849 status = PSA_ERROR_BAD_STATE;
4850 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004851 }
4852
Gilles Peskine449bd832023-01-11 14:50:10 +01004853 if (operation->lengths_set) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01004854 /* Additional data length was supplied, but not all the additional
4855 data was supplied.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004856 if (operation->ad_remaining != 0) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01004857 status = PSA_ERROR_INVALID_ARGUMENT;
4858 goto exit;
4859 }
4860
4861 /* Too much data provided. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004862 if (operation->body_remaining < input_length) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01004863 status = PSA_ERROR_INVALID_ARGUMENT;
4864 goto exit;
4865 }
4866
4867 operation->body_remaining -= input_length;
4868 }
Paul Elliotte193ea82021-10-01 13:00:16 +01004869#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004870 else if (operation->alg == PSA_ALG_CCM) {
Paul Elliotte193ea82021-10-01 13:00:16 +01004871 status = PSA_ERROR_BAD_STATE;
4872 goto exit;
4873 }
4874#endif /* PSA_WANT_ALG_CCM */
Paul Elliottee4ffe02021-05-20 17:25:06 +01004875
Gilles Peskine449bd832023-01-11 14:50:10 +01004876 status = psa_driver_wrapper_aead_update(operation, input, input_length,
4877 output, output_size,
4878 output_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004879
Paul Elliott39dc6b82021-05-11 19:16:09 +01004880exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004881 if (status == PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004882 operation->body_started = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004883 } else {
4884 psa_aead_abort(operation);
4885 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01004886
Gilles Peskine449bd832023-01-11 14:50:10 +01004887 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004888}
4889
Gilles Peskine449bd832023-01-11 14:50:10 +01004890static psa_status_t psa_aead_final_checks(const psa_aead_operation_t *operation)
Paul Elliottad53dcc2021-06-23 08:50:14 +01004891{
Gilles Peskine449bd832023-01-11 14:50:10 +01004892 if (operation->id == 0 || !operation->nonce_set) {
4893 return PSA_ERROR_BAD_STATE;
4894 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01004895
Gilles Peskine449bd832023-01-11 14:50:10 +01004896 if (operation->lengths_set && (operation->ad_remaining != 0 ||
4897 operation->body_remaining != 0)) {
4898 return PSA_ERROR_INVALID_ARGUMENT;
4899 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01004900
Gilles Peskine449bd832023-01-11 14:50:10 +01004901 return PSA_SUCCESS;
Paul Elliottad53dcc2021-06-23 08:50:14 +01004902}
4903
Paul Elliott302ff6b2021-04-20 18:10:30 +01004904/* Finish encrypting a message in a multipart AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004905psa_status_t psa_aead_finish(psa_aead_operation_t *operation,
4906 uint8_t *ciphertext,
4907 size_t ciphertext_size,
4908 size_t *ciphertext_length,
4909 uint8_t *tag,
4910 size_t tag_size,
4911 size_t *tag_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004912{
Paul Elliott39dc6b82021-05-11 19:16:09 +01004913 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4914
Paul Elliott302ff6b2021-04-20 18:10:30 +01004915 *ciphertext_length = 0;
Paul Elliottf88a5652021-06-22 17:53:45 +01004916 *tag_length = tag_size;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004917
Gilles Peskine449bd832023-01-11 14:50:10 +01004918 status = psa_aead_final_checks(operation);
4919 if (status != PSA_SUCCESS) {
Paul Elliottad53dcc2021-06-23 08:50:14 +01004920 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004921 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01004922
Gilles Peskine449bd832023-01-11 14:50:10 +01004923 if (!operation->is_encrypt) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004924 status = PSA_ERROR_BAD_STATE;
4925 goto exit;
4926 }
4927
Gilles Peskine449bd832023-01-11 14:50:10 +01004928 status = psa_driver_wrapper_aead_finish(operation, ciphertext,
4929 ciphertext_size,
4930 ciphertext_length,
4931 tag, tag_size, tag_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004932
Paul Elliott39dc6b82021-05-11 19:16:09 +01004933exit:
Paul Elliottdc42ca82023-02-24 18:11:59 +00004934
4935
Paul Elliottf47b0952021-05-21 18:02:33 +01004936 /* In case the operation fails and the user fails to check for failure or
Paul Elliott4c916e82021-09-19 18:34:50 +01004937 * the zero tag size, make sure the tag is set to something implausible.
4938 * Even if the operation succeeds, make sure we clear the rest of the
4939 * buffer to prevent potential leakage of anything previously placed in
4940 * the same buffer.*/
Paul Elliottdc42ca82023-02-24 18:11:59 +00004941 psa_wipe_tag_output_buffer(tag, status, tag_size, *tag_length);
Paul Elliottf47b0952021-05-21 18:02:33 +01004942
Gilles Peskine449bd832023-01-11 14:50:10 +01004943 psa_aead_abort(operation);
Paul Elliott39dc6b82021-05-11 19:16:09 +01004944
Gilles Peskine449bd832023-01-11 14:50:10 +01004945 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004946}
4947
4948/* Finish authenticating and decrypting a message in a multipart AEAD
4949 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004950psa_status_t psa_aead_verify(psa_aead_operation_t *operation,
4951 uint8_t *plaintext,
4952 size_t plaintext_size,
4953 size_t *plaintext_length,
4954 const uint8_t *tag,
4955 size_t tag_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004956{
Paul Elliott39dc6b82021-05-11 19:16:09 +01004957 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4958
Paul Elliott302ff6b2021-04-20 18:10:30 +01004959 *plaintext_length = 0;
4960
Gilles Peskine449bd832023-01-11 14:50:10 +01004961 status = psa_aead_final_checks(operation);
4962 if (status != PSA_SUCCESS) {
Paul Elliottad53dcc2021-06-23 08:50:14 +01004963 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004964 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01004965
Gilles Peskine449bd832023-01-11 14:50:10 +01004966 if (operation->is_encrypt) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004967 status = PSA_ERROR_BAD_STATE;
4968 goto exit;
4969 }
4970
Gilles Peskine449bd832023-01-11 14:50:10 +01004971 status = psa_driver_wrapper_aead_verify(operation, plaintext,
4972 plaintext_size,
4973 plaintext_length,
4974 tag, tag_length);
Paul Elliott39dc6b82021-05-11 19:16:09 +01004975
4976exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004977 psa_aead_abort(operation);
Paul Elliott39dc6b82021-05-11 19:16:09 +01004978
Gilles Peskine449bd832023-01-11 14:50:10 +01004979 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004980}
4981
4982/* Abort an AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004983psa_status_t psa_aead_abort(psa_aead_operation_t *operation)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004984{
4985 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4986
Gilles Peskine449bd832023-01-11 14:50:10 +01004987 if (operation->id == 0) {
Paul Elliott302ff6b2021-04-20 18:10:30 +01004988 /* The object has (apparently) been initialized but it is not (yet)
4989 * in use. It's ok to call abort on such an object, and there's
4990 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004991 return PSA_SUCCESS;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004992 }
4993
Gilles Peskine449bd832023-01-11 14:50:10 +01004994 status = psa_driver_wrapper_aead_abort(operation);
Paul Elliott302ff6b2021-04-20 18:10:30 +01004995
Gilles Peskine449bd832023-01-11 14:50:10 +01004996 memset(operation, 0, sizeof(*operation));
Paul Elliott302ff6b2021-04-20 18:10:30 +01004997
Gilles Peskine449bd832023-01-11 14:50:10 +01004998 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004999}
5000
Gilles Peskinee59236f2018-01-27 23:32:46 +01005001/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02005002/* Generators */
5003/****************************************************************/
5004
Przemek Stekiel69c46792022-06-10 12:59:51 +02005005#if defined(BUILTIN_ALG_ANY_HKDF) || \
John Durkop07cc04a2020-11-16 22:08:34 -08005006 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005007 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) || \
Kusumit Ghoderaoaf0b5342023-05-03 11:58:46 +05305008 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS) || \
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305009 defined(PSA_HAVE_SOFT_PBKDF2)
John Durkop07cc04a2020-11-16 22:08:34 -08005010#define AT_LEAST_ONE_BUILTIN_KDF
Steven Cooreman094a77e2021-05-06 17:58:36 +02005011#endif /* At least one builtin KDF */
5012
Przemek Stekiel69c46792022-06-10 12:59:51 +02005013#if defined(BUILTIN_ALG_ANY_HKDF) || \
Steven Cooreman094a77e2021-05-06 17:58:36 +02005014 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5015 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
5016static psa_status_t psa_key_derivation_start_hmac(
5017 psa_mac_operation_t *operation,
5018 psa_algorithm_t hash_alg,
5019 const uint8_t *hmac_key,
Gilles Peskine449bd832023-01-11 14:50:10 +01005020 size_t hmac_key_length)
Steven Cooreman094a77e2021-05-06 17:58:36 +02005021{
5022 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5023 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01005024 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
5025 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(hmac_key_length));
5026 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_HASH);
Steven Cooreman094a77e2021-05-06 17:58:36 +02005027
Steven Cooreman72f736a2021-05-07 14:14:37 +02005028 operation->is_sign = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005029 operation->mac_size = PSA_HASH_LENGTH(hash_alg);
Steven Cooreman72f736a2021-05-07 14:14:37 +02005030
Gilles Peskine449bd832023-01-11 14:50:10 +01005031 status = psa_driver_wrapper_mac_sign_setup(operation,
5032 &attributes,
5033 hmac_key, hmac_key_length,
5034 PSA_ALG_HMAC(hash_alg));
Steven Cooreman094a77e2021-05-06 17:58:36 +02005035
Gilles Peskine449bd832023-01-11 14:50:10 +01005036 psa_reset_key_attributes(&attributes);
5037 return status;
Steven Cooreman094a77e2021-05-06 17:58:36 +02005038}
5039#endif /* KDF algorithms reliant on HMAC */
John Durkop07cc04a2020-11-16 22:08:34 -08005040
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005041#define HKDF_STATE_INIT 0 /* no input yet */
5042#define HKDF_STATE_STARTED 1 /* got salt */
5043#define HKDF_STATE_KEYED 2 /* got key */
5044#define HKDF_STATE_OUTPUT 3 /* output started */
5045
Gilles Peskinecbe66502019-05-16 16:59:18 +02005046static psa_algorithm_t psa_key_derivation_get_kdf_alg(
Gilles Peskine449bd832023-01-11 14:50:10 +01005047 const psa_key_derivation_operation_t *operation)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005048{
Gilles Peskine449bd832023-01-11 14:50:10 +01005049 if (PSA_ALG_IS_KEY_AGREEMENT(operation->alg)) {
5050 return PSA_ALG_KEY_AGREEMENT_GET_KDF(operation->alg);
5051 } else {
5052 return operation->alg;
5053 }
Gilles Peskine969c5d62019-01-16 15:53:06 +01005054}
5055
Gilles Peskine449bd832023-01-11 14:50:10 +01005056psa_status_t psa_key_derivation_abort(psa_key_derivation_operation_t *operation)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005057{
5058 psa_status_t status = PSA_SUCCESS;
Gilles Peskine449bd832023-01-11 14:50:10 +01005059 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
5060 if (kdf_alg == 0) {
Gilles Peskineeab56e42018-07-12 17:12:33 +02005061 /* The object has (apparently) been initialized but it is not
5062 * in use. It's ok to call abort on such an object, and there's
5063 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005064 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02005065#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01005066 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
5067 mbedtls_free(operation->ctx.hkdf.info);
5068 status = psa_mac_abort(&operation->ctx.hkdf.hmac);
5069 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02005070#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08005071#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5072 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005073 if (PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
5074 /* TLS-1.2 PSK-to-MS KDF uses the same core as TLS-1.2 PRF */
5075 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
5076 if (operation->ctx.tls12_prf.secret != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005077 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.secret,
Gilles Peskine449bd832023-01-11 14:50:10 +01005078 operation->ctx.tls12_prf.secret_length);
Steven Cooremana6df6042021-04-29 19:32:25 +02005079 }
5080
Gilles Peskine449bd832023-01-11 14:50:10 +01005081 if (operation->ctx.tls12_prf.seed != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005082 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.seed,
Gilles Peskine449bd832023-01-11 14:50:10 +01005083 operation->ctx.tls12_prf.seed_length);
Janos Follath6a1d2622019-06-11 10:37:28 +01005084 }
5085
Gilles Peskine449bd832023-01-11 14:50:10 +01005086 if (operation->ctx.tls12_prf.label != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005087 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.label,
Gilles Peskine449bd832023-01-11 14:50:10 +01005088 operation->ctx.tls12_prf.label_length);
Janos Follath6a1d2622019-06-11 10:37:28 +01005089 }
Przemek Stekiel6c764412022-11-22 14:05:12 +01005090#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005091 if (operation->ctx.tls12_prf.other_secret != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005092 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.other_secret,
Gilles Peskine449bd832023-01-11 14:50:10 +01005093 operation->ctx.tls12_prf.other_secret_length);
Przemek Stekiele3ee2212022-04-07 14:29:56 +02005094 }
Przemek Stekiel6c764412022-11-22 14:05:12 +01005095#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Steven Cooremana6df6042021-04-29 19:32:25 +02005096 status = PSA_SUCCESS;
Janos Follath6a1d2622019-06-11 10:37:28 +01005097
5098 /* We leave the fields Ai and output_block to be erased safely by the
5099 * mbedtls_platform_zeroize() in the end of this function. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005100 } else
John Durkop07cc04a2020-11-16 22:08:34 -08005101#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
5102 * defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005103#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005104 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
5105 mbedtls_platform_zeroize(operation->ctx.tls12_ecjpake_to_pms.data,
5106 sizeof(operation->ctx.tls12_ecjpake_to_pms.data));
5107 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005108#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS) */
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305109#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05305110 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305111 if (operation->ctx.pbkdf2.salt != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005112 mbedtls_zeroize_and_free(operation->ctx.pbkdf2.salt,
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305113 operation->ctx.pbkdf2.salt_length);
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305114 }
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305115
5116 status = PSA_SUCCESS;
5117 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305118#endif /* defined(PSA_HAVE_SOFT_PBKDF2) */
Gilles Peskineeab56e42018-07-12 17:12:33 +02005119 {
5120 status = PSA_ERROR_BAD_STATE;
5121 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005122 mbedtls_platform_zeroize(operation, sizeof(*operation));
5123 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005124}
5125
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005126psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskine449bd832023-01-11 14:50:10 +01005127 size_t *capacity)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005128{
Gilles Peskine449bd832023-01-11 14:50:10 +01005129 if (operation->alg == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005130 /* This is a blank key derivation operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005131 return PSA_ERROR_BAD_STATE;
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005132 }
5133
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005134 *capacity = operation->capacity;
Gilles Peskine449bd832023-01-11 14:50:10 +01005135 return PSA_SUCCESS;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005136}
5137
Gilles Peskine449bd832023-01-11 14:50:10 +01005138psa_status_t psa_key_derivation_set_capacity(psa_key_derivation_operation_t *operation,
5139 size_t capacity)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005140{
Gilles Peskine449bd832023-01-11 14:50:10 +01005141 if (operation->alg == 0) {
5142 return PSA_ERROR_BAD_STATE;
5143 }
5144 if (capacity > operation->capacity) {
5145 return PSA_ERROR_INVALID_ARGUMENT;
5146 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005147 operation->capacity = capacity;
Gilles Peskine449bd832023-01-11 14:50:10 +01005148 return PSA_SUCCESS;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005149}
5150
Przemek Stekiel69c46792022-06-10 12:59:51 +02005151#if defined(BUILTIN_ALG_ANY_HKDF)
Przemek Stekiel03d948c2022-05-19 11:45:20 +02005152/* Read some bytes from an HKDF-based operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005153static psa_status_t psa_key_derivation_hkdf_read(psa_hkdf_key_derivation_t *hkdf,
5154 psa_algorithm_t kdf_alg,
5155 uint8_t *output,
5156 size_t output_length)
Gilles Peskinebef7f142018-07-12 17:22:21 +02005157{
Gilles Peskine449bd832023-01-11 14:50:10 +01005158 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
5159 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Steven Cooremand1ed1d92021-04-29 19:11:25 +02005160 size_t hmac_output_length;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005161 psa_status_t status;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005162#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01005163 const uint8_t last_block = PSA_ALG_IS_HKDF_EXTRACT(kdf_alg) ? 0 : 0xff;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005164#else
5165 const uint8_t last_block = 0xff;
5166#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskinebef7f142018-07-12 17:22:21 +02005167
Gilles Peskine449bd832023-01-11 14:50:10 +01005168 if (hkdf->state < HKDF_STATE_KEYED ||
5169 (!hkdf->info_set
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005170#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01005171 && !PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005172#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01005173 )) {
5174 return PSA_ERROR_BAD_STATE;
5175 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005176 hkdf->state = HKDF_STATE_OUTPUT;
5177
Gilles Peskine449bd832023-01-11 14:50:10 +01005178 while (output_length != 0) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005179 /* Copy what remains of the current block */
5180 uint8_t n = hash_length - hkdf->offset_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005181 if (n > output_length) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005182 n = (uint8_t) output_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01005183 }
5184 memcpy(output, hkdf->output_block + hkdf->offset_in_block, n);
Gilles Peskinebef7f142018-07-12 17:22:21 +02005185 output += n;
5186 output_length -= n;
5187 hkdf->offset_in_block += n;
Gilles Peskine449bd832023-01-11 14:50:10 +01005188 if (output_length == 0) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005189 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01005190 }
Przemek Stekiel03d948c2022-05-19 11:45:20 +02005191 /* We can't be wanting more output after the last block, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005192 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005193 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02005194 * object was corrupted or if this function is called directly
5195 * inside the library. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005196 if (hkdf->block_number == last_block) {
5197 return PSA_ERROR_BAD_STATE;
5198 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02005199
5200 /* We need a new block */
5201 ++hkdf->block_number;
5202 hkdf->offset_in_block = 0;
Steven Cooremand1ed1d92021-04-29 19:11:25 +02005203
Gilles Peskine449bd832023-01-11 14:50:10 +01005204 status = psa_key_derivation_start_hmac(&hkdf->hmac,
5205 hash_alg,
5206 hkdf->prk,
5207 hash_length);
5208 if (status != PSA_SUCCESS) {
5209 return status;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005210 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005211
5212 if (hkdf->block_number != 1) {
5213 status = psa_mac_update(&hkdf->hmac,
5214 hkdf->output_block,
5215 hash_length);
5216 if (status != PSA_SUCCESS) {
5217 return status;
5218 }
5219 }
5220 status = psa_mac_update(&hkdf->hmac,
5221 hkdf->info,
5222 hkdf->info_length);
5223 if (status != PSA_SUCCESS) {
5224 return status;
5225 }
5226 status = psa_mac_update(&hkdf->hmac,
5227 &hkdf->block_number, 1);
5228 if (status != PSA_SUCCESS) {
5229 return status;
5230 }
5231 status = psa_mac_sign_finish(&hkdf->hmac,
5232 hkdf->output_block,
5233 sizeof(hkdf->output_block),
5234 &hmac_output_length);
5235 if (status != PSA_SUCCESS) {
5236 return status;
5237 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02005238 }
5239
Gilles Peskine449bd832023-01-11 14:50:10 +01005240 return PSA_SUCCESS;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005241}
Przemek Stekiel69c46792022-06-10 12:59:51 +02005242#endif /* BUILTIN_ALG_ANY_HKDF */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005243
John Durkop07cc04a2020-11-16 22:08:34 -08005244#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5245 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follath7742fee2019-06-17 12:58:10 +01005246static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
5247 psa_tls12_prf_key_derivation_t *tls12_prf,
Gilles Peskine449bd832023-01-11 14:50:10 +01005248 psa_algorithm_t alg)
Janos Follath7742fee2019-06-17 12:58:10 +01005249{
Gilles Peskine449bd832023-01-11 14:50:10 +01005250 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(alg);
5251 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Steven Cooremana6df6042021-04-29 19:32:25 +02005252 psa_mac_operation_t hmac = PSA_MAC_OPERATION_INIT;
5253 size_t hmac_output_length;
Janos Follathea29bfb2019-06-19 12:21:20 +01005254 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005255
Janos Follath7742fee2019-06-17 12:58:10 +01005256 /* We can't be wanting more output after block 0xff, otherwise
5257 * the capacity check in psa_key_derivation_output_bytes() would have
5258 * prevented this call. It could happen only if the operation
5259 * object was corrupted or if this function is called directly
5260 * inside the library. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005261 if (tls12_prf->block_number == 0xff) {
5262 return PSA_ERROR_CORRUPTION_DETECTED;
5263 }
Janos Follath7742fee2019-06-17 12:58:10 +01005264
5265 /* We need a new block */
5266 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01005267 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01005268
5269 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
5270 *
5271 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
5272 *
5273 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
5274 * HMAC_hash(secret, A(2) + seed) +
5275 * HMAC_hash(secret, A(3) + seed) + ...
5276 *
5277 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01005278 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01005279 *
Janos Follathea29bfb2019-06-19 12:21:20 +01005280 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01005281 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01005282 * is currently extracted as `output_block` and where i is
5283 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01005284 */
5285
Gilles Peskine449bd832023-01-11 14:50:10 +01005286 status = psa_key_derivation_start_hmac(&hmac,
5287 hash_alg,
5288 tls12_prf->secret,
5289 tls12_prf->secret_length);
5290 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005291 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005292 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005293
5294 /* Calculate A(i) where i = tls12_prf->block_number. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005295 if (tls12_prf->block_number == 1) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005296 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
5297 * the variable seed and in this instance means it in the context of the
5298 * P_hash function, where seed = label + seed.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01005299 status = psa_mac_update(&hmac,
5300 tls12_prf->label,
5301 tls12_prf->label_length);
5302 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005303 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005304 }
5305 status = psa_mac_update(&hmac,
5306 tls12_prf->seed,
5307 tls12_prf->seed_length);
5308 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005309 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005310 }
5311 } else {
Janos Follathea29bfb2019-06-19 12:21:20 +01005312 /* A(i) = HMAC_hash(secret, A(i-1)) */
Gilles Peskine449bd832023-01-11 14:50:10 +01005313 status = psa_mac_update(&hmac, tls12_prf->Ai, hash_length);
5314 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005315 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005316 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005317 }
5318
Gilles Peskine449bd832023-01-11 14:50:10 +01005319 status = psa_mac_sign_finish(&hmac,
5320 tls12_prf->Ai, hash_length,
5321 &hmac_output_length);
5322 if (hmac_output_length != hash_length) {
Steven Cooremana6df6042021-04-29 19:32:25 +02005323 status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01005324 }
5325 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005326 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005327 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005328
5329 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
Gilles Peskine449bd832023-01-11 14:50:10 +01005330 status = psa_key_derivation_start_hmac(&hmac,
5331 hash_alg,
5332 tls12_prf->secret,
5333 tls12_prf->secret_length);
5334 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005335 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005336 }
5337 status = psa_mac_update(&hmac, tls12_prf->Ai, hash_length);
5338 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005339 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005340 }
5341 status = psa_mac_update(&hmac, tls12_prf->label, tls12_prf->label_length);
5342 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005343 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005344 }
5345 status = psa_mac_update(&hmac, tls12_prf->seed, tls12_prf->seed_length);
5346 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005347 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005348 }
5349 status = psa_mac_sign_finish(&hmac,
5350 tls12_prf->output_block, hash_length,
5351 &hmac_output_length);
5352 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005353 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005354 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005355
Janos Follath7742fee2019-06-17 12:58:10 +01005356
5357cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01005358 cleanup_status = psa_mac_abort(&hmac);
5359 if (status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005360 status = cleanup_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01005361 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005362
Gilles Peskine449bd832023-01-11 14:50:10 +01005363 return status;
Janos Follath7742fee2019-06-17 12:58:10 +01005364}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005365
Janos Follath844eb0e2019-06-19 12:10:49 +01005366static psa_status_t psa_key_derivation_tls12_prf_read(
5367 psa_tls12_prf_key_derivation_t *tls12_prf,
5368 psa_algorithm_t alg,
5369 uint8_t *output,
Gilles Peskine449bd832023-01-11 14:50:10 +01005370 size_t output_length)
Janos Follath844eb0e2019-06-19 12:10:49 +01005371{
Gilles Peskine449bd832023-01-11 14:50:10 +01005372 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH(alg);
5373 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Janos Follath844eb0e2019-06-19 12:10:49 +01005374 psa_status_t status;
5375 uint8_t offset, length;
5376
Gilles Peskine449bd832023-01-11 14:50:10 +01005377 switch (tls12_prf->state) {
Gilles Peskineb1edaec2021-06-11 22:41:46 +02005378 case PSA_TLS12_PRF_STATE_LABEL_SET:
5379 tls12_prf->state = PSA_TLS12_PRF_STATE_OUTPUT;
5380 break;
5381 case PSA_TLS12_PRF_STATE_OUTPUT:
5382 break;
5383 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005384 return PSA_ERROR_BAD_STATE;
Gilles Peskineb1edaec2021-06-11 22:41:46 +02005385 }
5386
Gilles Peskine449bd832023-01-11 14:50:10 +01005387 while (output_length != 0) {
Janos Follath844eb0e2019-06-19 12:10:49 +01005388 /* Check if we have fully processed the current block. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005389 if (tls12_prf->left_in_block == 0) {
5390 status = psa_key_derivation_tls12_prf_generate_next_block(tls12_prf,
5391 alg);
5392 if (status != PSA_SUCCESS) {
5393 return status;
5394 }
Janos Follath844eb0e2019-06-19 12:10:49 +01005395
5396 continue;
5397 }
5398
Gilles Peskine449bd832023-01-11 14:50:10 +01005399 if (tls12_prf->left_in_block > output_length) {
Janos Follath844eb0e2019-06-19 12:10:49 +01005400 length = (uint8_t) output_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01005401 } else {
Janos Follath844eb0e2019-06-19 12:10:49 +01005402 length = tls12_prf->left_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005403 }
Janos Follath844eb0e2019-06-19 12:10:49 +01005404
5405 offset = hash_length - tls12_prf->left_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005406 memcpy(output, tls12_prf->output_block + offset, length);
Janos Follath844eb0e2019-06-19 12:10:49 +01005407 output += length;
5408 output_length -= length;
5409 tls12_prf->left_in_block -= length;
5410 }
5411
Gilles Peskine449bd832023-01-11 14:50:10 +01005412 return PSA_SUCCESS;
Janos Follath844eb0e2019-06-19 12:10:49 +01005413}
John Durkop07cc04a2020-11-16 22:08:34 -08005414#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
5415 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskinebef7f142018-07-12 17:22:21 +02005416
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005417#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
5418static psa_status_t psa_key_derivation_tls12_ecjpake_to_pms_read(
5419 psa_tls12_ecjpake_to_pms_t *ecjpake,
5420 uint8_t *output,
Gilles Peskine449bd832023-01-11 14:50:10 +01005421 size_t output_length)
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005422{
5423 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Andrzej Kurek5603efd2022-09-26 10:49:16 -04005424 size_t output_size = 0;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005425
Gilles Peskine449bd832023-01-11 14:50:10 +01005426 if (output_length != 32) {
5427 return PSA_ERROR_INVALID_ARGUMENT;
5428 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005429
Gilles Peskine449bd832023-01-11 14:50:10 +01005430 status = psa_hash_compute(PSA_ALG_SHA_256, ecjpake->data,
5431 PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE, output, output_length,
5432 &output_size);
5433 if (status != PSA_SUCCESS) {
5434 return status;
5435 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005436
Gilles Peskine449bd832023-01-11 14:50:10 +01005437 if (output_size != output_length) {
5438 return PSA_ERROR_GENERIC_ERROR;
5439 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005440
Gilles Peskine449bd832023-01-11 14:50:10 +01005441 return PSA_SUCCESS;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005442}
5443#endif
5444
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305445#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305446static psa_status_t psa_key_derivation_pbkdf2_generate_block(
5447 psa_pbkdf2_key_derivation_t *pbkdf2,
5448 psa_algorithm_t prf_alg,
5449 uint8_t prf_output_length,
5450 psa_key_attributes_t *attributes)
5451{
5452 psa_status_t status;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305453 psa_mac_operation_t mac_operation = PSA_MAC_OPERATION_INIT;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305454 size_t mac_output_length;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305455 uint8_t U_i[PSA_MAC_MAX_SIZE];
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305456 uint8_t *U_accumulator = pbkdf2->output_block;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305457 uint64_t i;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305458 uint8_t block_counter[4];
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305459
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305460 mac_operation.is_sign = 1;
5461 mac_operation.mac_size = prf_output_length;
5462 MBEDTLS_PUT_UINT32_BE(pbkdf2->block_number, block_counter, 0);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305463
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305464 status = psa_driver_wrapper_mac_sign_setup(&mac_operation,
5465 attributes,
5466 pbkdf2->password,
5467 pbkdf2->password_length,
5468 prf_alg);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305469 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305470 goto cleanup;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305471 }
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305472 status = psa_mac_update(&mac_operation, pbkdf2->salt, pbkdf2->salt_length);
5473 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305474 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305475 }
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305476 status = psa_mac_update(&mac_operation, block_counter, sizeof(block_counter));
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305477 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305478 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305479 }
5480 status = psa_mac_sign_finish(&mac_operation, U_i, sizeof(U_i),
5481 &mac_output_length);
5482 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305483 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305484 }
5485
5486 if (mac_output_length != prf_output_length) {
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305487 status = PSA_ERROR_CORRUPTION_DETECTED;
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305488 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305489 }
5490
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305491 memcpy(U_accumulator, U_i, prf_output_length);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305492
5493 for (i = 1; i < pbkdf2->input_cost; i++) {
Kusumit Ghoderao4536bb62023-06-22 15:42:59 +05305494 /* We are passing prf_output_length as mac_size because the driver
5495 * function directly sets mac_output_length as mac_size upon success.
Kusumit Ghoderao5f3345a2023-07-27 21:21:38 +05305496 * See https://github.com/Mbed-TLS/mbedtls/issues/7801 */
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305497 status = psa_driver_wrapper_mac_compute(attributes,
5498 pbkdf2->password,
5499 pbkdf2->password_length,
5500 prf_alg, U_i, prf_output_length,
Kusumit Ghoderao4536bb62023-06-22 15:42:59 +05305501 U_i, prf_output_length,
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305502 &mac_output_length);
5503 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305504 goto cleanup;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305505 }
5506
Kusumit Ghoderao109ee3d2023-06-08 16:36:45 +05305507 mbedtls_xor(U_accumulator, U_accumulator, U_i, prf_output_length);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305508 }
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305509
5510cleanup:
5511 /* Zeroise buffers to clear sensitive data from memory. */
5512 mbedtls_platform_zeroize(U_i, PSA_MAC_MAX_SIZE);
5513 return status;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305514}
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05305515
5516static psa_status_t psa_key_derivation_pbkdf2_read(
5517 psa_pbkdf2_key_derivation_t *pbkdf2,
5518 psa_algorithm_t kdf_alg,
5519 uint8_t *output,
5520 size_t output_length)
5521{
5522 psa_status_t status;
5523 psa_algorithm_t prf_alg;
5524 uint8_t prf_output_length;
5525 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
5526 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(pbkdf2->password_length));
5527 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
5528
5529 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
5530 prf_alg = PSA_ALG_HMAC(PSA_ALG_PBKDF2_HMAC_GET_HASH(kdf_alg));
5531 prf_output_length = PSA_HASH_LENGTH(prf_alg);
5532 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
Kusumit Ghoderaoa2520a52023-06-22 15:42:19 +05305533 } else if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
5534 prf_alg = PSA_ALG_CMAC;
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05305535 prf_output_length = PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC);
Kusumit Ghoderaoa2520a52023-06-22 15:42:19 +05305536 psa_set_key_type(&attributes, PSA_KEY_TYPE_AES);
Kusumit Ghoderaod9ec1af2023-06-08 20:19:51 +05305537 } else {
5538 return PSA_ERROR_INVALID_ARGUMENT;
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05305539 }
5540
5541 switch (pbkdf2->state) {
5542 case PSA_PBKDF2_STATE_PASSWORD_SET:
5543 /* Initially we need a new block so bytes_used is equal to block size*/
5544 pbkdf2->bytes_used = prf_output_length;
5545 pbkdf2->state = PSA_PBKDF2_STATE_OUTPUT;
5546 break;
5547 case PSA_PBKDF2_STATE_OUTPUT:
5548 break;
5549 default:
5550 return PSA_ERROR_BAD_STATE;
5551 }
5552
5553 while (output_length != 0) {
5554 uint8_t n = prf_output_length - pbkdf2->bytes_used;
5555 if (n > output_length) {
5556 n = (uint8_t) output_length;
5557 }
5558 memcpy(output, pbkdf2->output_block + pbkdf2->bytes_used, n);
5559 output += n;
5560 output_length -= n;
5561 pbkdf2->bytes_used += n;
5562
5563 if (output_length == 0) {
5564 break;
5565 }
5566
5567 /* We need a new block */
5568 pbkdf2->bytes_used = 0;
5569 pbkdf2->block_number++;
5570
5571 status = psa_key_derivation_pbkdf2_generate_block(pbkdf2, prf_alg,
5572 prf_output_length,
5573 &attributes);
5574 if (status != PSA_SUCCESS) {
5575 return status;
5576 }
5577 }
5578
5579 return PSA_SUCCESS;
5580}
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305581#endif /* PSA_HAVE_SOFT_PBKDF2 */
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305582
Janos Follath6c6c8fc2019-06-17 12:38:20 +01005583psa_status_t psa_key_derivation_output_bytes(
5584 psa_key_derivation_operation_t *operation,
5585 uint8_t *output,
Gilles Peskine449bd832023-01-11 14:50:10 +01005586 size_t output_length)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005587{
5588 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01005589 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
Gilles Peskineeab56e42018-07-12 17:12:33 +02005590
Gilles Peskine449bd832023-01-11 14:50:10 +01005591 if (operation->alg == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005592 /* This is a blank operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005593 return PSA_ERROR_BAD_STATE;
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005594 }
5595
Gilles Peskine449bd832023-01-11 14:50:10 +01005596 if (output_length > operation->capacity) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005597 operation->capacity = 0;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005598 /* Go through the error path to wipe all confidential data now
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005599 * that the operation object is useless. */
David Saadab4ecc272019-02-14 13:48:10 +02005600 status = PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005601 goto exit;
5602 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005603 if (output_length == 0 && operation->capacity == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005604 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005605 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02005606 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
5607 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005608 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02005609 * output_length > 0. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005610 return PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005611 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005612 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005613
Przemek Stekiel69c46792022-06-10 12:59:51 +02005614#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01005615 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
5616 status = psa_key_derivation_hkdf_read(&operation->ctx.hkdf, kdf_alg,
5617 output, output_length);
5618 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02005619#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08005620#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5621 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005622 if (PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
5623 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
5624 status = psa_key_derivation_tls12_prf_read(&operation->ctx.tls12_prf,
5625 kdf_alg, output,
5626 output_length);
5627 } else
John Durkop07cc04a2020-11-16 22:08:34 -08005628#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
5629 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005630#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005631 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005632 status = psa_key_derivation_tls12_ecjpake_to_pms_read(
Gilles Peskine449bd832023-01-11 14:50:10 +01005633 &operation->ctx.tls12_ecjpake_to_pms, output, output_length);
5634 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005635#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305636#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05305637 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05305638 status = psa_key_derivation_pbkdf2_read(&operation->ctx.pbkdf2, kdf_alg,
5639 output, output_length);
Kusumit Ghoderao056f0c52023-05-03 15:58:34 +05305640 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305641#endif /* PSA_HAVE_SOFT_PBKDF2 */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005642
Gilles Peskineeab56e42018-07-12 17:12:33 +02005643 {
Steven Cooreman74afe472021-02-10 17:19:22 +01005644 (void) kdf_alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01005645 return PSA_ERROR_BAD_STATE;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005646 }
5647
5648exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005649 if (status != PSA_SUCCESS) {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005650 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005651 * This allows us to differentiate between exhausted operations and
5652 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
5653 * operations. */
5654 psa_algorithm_t alg = operation->alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01005655 psa_key_derivation_abort(operation);
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005656 operation->alg = alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01005657 memset(output, '!', output_length);
Gilles Peskineeab56e42018-07-12 17:12:33 +02005658 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005659 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005660}
5661
David Brown7807bf72021-02-09 16:28:23 -07005662#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01005663static void psa_des_set_key_parity(uint8_t *data, size_t data_size)
Gilles Peskine08542d82018-07-19 17:05:42 +02005664{
Gilles Peskine449bd832023-01-11 14:50:10 +01005665 if (data_size >= 8) {
5666 mbedtls_des_key_set_parity(data);
5667 }
5668 if (data_size >= 16) {
5669 mbedtls_des_key_set_parity(data + 8);
5670 }
5671 if (data_size >= 24) {
5672 mbedtls_des_key_set_parity(data + 16);
5673 }
Gilles Peskine08542d82018-07-19 17:05:42 +02005674}
David Brown7807bf72021-02-09 16:28:23 -07005675#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine08542d82018-07-19 17:05:42 +02005676
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005677/*
Gilles Peskine449bd832023-01-11 14:50:10 +01005678 * ECC keys on a Weierstrass elliptic curve require the generation
5679 * of a private key which is an integer
5680 * in the range [1, N - 1], where N is the boundary of the private key domain:
5681 * N is the prime p for Diffie-Hellman, or the order of the
5682 * curve’s base point for ECC.
5683 *
5684 * Let m be the bit size of N, such that 2^m > N >= 2^(m-1).
5685 * This function generates the private key using the following process:
5686 *
5687 * 1. Draw a byte string of length ceiling(m/8) bytes.
5688 * 2. If m is not a multiple of 8, set the most significant
5689 * (8 * ceiling(m/8) - m) bits of the first byte in the string to zero.
5690 * 3. Convert the string to integer k by decoding it as a big-endian byte string.
5691 * 4. If k > N - 2, discard the result and return to step 1.
5692 * 5. Output k + 1 as the private key.
5693 *
5694 * This method allows compliance to NIST standards, specifically the methods titled
5695 * Key-Pair Generation by Testing Candidates in the following publications:
5696 * - NIST Special Publication 800-56A: Recommendation for Pair-Wise Key-Establishment
5697 * Schemes Using Discrete Logarithm Cryptography [SP800-56A] §5.6.1.1.4 for
5698 * Diffie-Hellman keys.
5699 *
5700 * - [SP800-56A] §5.6.1.2.2 or FIPS Publication 186-4: Digital Signature
5701 * Standard (DSS) [FIPS186-4] §B.4.2 for elliptic curve keys.
5702 *
5703 * Note: Function allocates memory for *data buffer, so given *data should be
5704 * always NULL.
5705 */
Valerio Setti86587ab2023-06-27 13:09:30 +02005706#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE)
5707#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE)
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01005708static psa_status_t psa_generate_derived_ecc_key_weierstrass_helper(
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005709 psa_key_slot_t *slot,
5710 size_t bits,
5711 psa_key_derivation_operation_t *operation,
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005712 uint8_t **data
5713 )
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005714{
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005715 unsigned key_out_of_range = 1;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005716 mbedtls_mpi k;
5717 mbedtls_mpi diff_N_2;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005718 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Przemek Stekiela81aed22022-03-01 15:13:30 +01005719 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01005720 size_t m;
5721 size_t m_bytes;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005722
Gilles Peskine449bd832023-01-11 14:50:10 +01005723 mbedtls_mpi_init(&k);
5724 mbedtls_mpi_init(&diff_N_2);
Przemyslaw Stekiel1dfd1222021-11-18 13:35:00 +01005725
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005726 psa_ecc_family_t curve = PSA_KEY_TYPE_ECC_GET_FAMILY(
Gilles Peskine449bd832023-01-11 14:50:10 +01005727 slot->attr.type);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005728 mbedtls_ecp_group_id grp_id =
Gilles Peskine449bd832023-01-11 14:50:10 +01005729 mbedtls_ecc_group_of_psa(curve, bits, 0);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005730
Gilles Peskine449bd832023-01-11 14:50:10 +01005731 if (grp_id == MBEDTLS_ECP_DP_NONE) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005732 ret = MBEDTLS_ERR_ASN1_INVALID_DATA;
Przemyslaw Stekiel871a3362021-12-02 08:46:39 +01005733 goto cleanup;
5734 }
5735
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005736 mbedtls_ecp_group ecp_group;
Gilles Peskine449bd832023-01-11 14:50:10 +01005737 mbedtls_ecp_group_init(&ecp_group);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005738
Gilles Peskine449bd832023-01-11 14:50:10 +01005739 MBEDTLS_MPI_CHK(mbedtls_ecp_group_load(&ecp_group, grp_id));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005740
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005741 /* N is the boundary of the private key domain (ecp_group.N). */
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005742 /* Let m be the bit size of N. */
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01005743 m = ecp_group.nbits;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005744
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01005745 m_bytes = PSA_BITS_TO_BYTES(m);
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005746
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005747 /* Calculate N - 2 - it will be needed later. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005748 MBEDTLS_MPI_CHK(mbedtls_mpi_sub_int(&diff_N_2, &ecp_group.N, 2));
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005749
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005750 /* Note: This function is always called with *data == NULL and it
5751 * allocates memory for the data buffer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005752 *data = mbedtls_calloc(1, m_bytes);
5753 if (*data == NULL) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005754 ret = MBEDTLS_ERR_ASN1_ALLOC_FAILED;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005755 goto cleanup;
5756 }
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005757
Gilles Peskine449bd832023-01-11 14:50:10 +01005758 while (key_out_of_range) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005759 /* 1. Draw a byte string of length ceiling(m/8) bytes. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005760 if ((status = psa_key_derivation_output_bytes(operation, *data, m_bytes)) != 0) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005761 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005762 }
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005763
5764 /* 2. If m is not a multiple of 8 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005765 if (m % 8 != 0) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005766 /* Set the most significant
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005767 * (8 * ceiling(m/8) - m) bits of the first byte in
5768 * the string to zero.
5769 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005770 uint8_t clear_bit_mask = (1 << (m % 8)) - 1;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005771 (*data)[0] &= clear_bit_mask;
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005772 }
5773
5774 /* 3. Convert the string to integer k by decoding it as a
Gilles Peskine449bd832023-01-11 14:50:10 +01005775 * big-endian byte string.
5776 */
5777 MBEDTLS_MPI_CHK(mbedtls_mpi_read_binary(&k, *data, m_bytes));
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005778
5779 /* 4. If k > N - 2, discard the result and return to step 1.
Gilles Peskine449bd832023-01-11 14:50:10 +01005780 * Result of comparison is returned. When it indicates error
5781 * then this function is called again.
5782 */
5783 MBEDTLS_MPI_CHK(mbedtls_mpi_lt_mpi_ct(&diff_N_2, &k, &key_out_of_range));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005784 }
5785
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005786 /* 5. Output k + 1 as the private key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005787 MBEDTLS_MPI_CHK(mbedtls_mpi_add_int(&k, &k, 1));
5788 MBEDTLS_MPI_CHK(mbedtls_mpi_write_binary(&k, *data, m_bytes));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005789cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01005790 if (ret != 0) {
5791 status = mbedtls_to_psa_error(ret);
5792 }
5793 if (status != PSA_SUCCESS) {
5794 mbedtls_free(*data);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005795 *data = NULL;
5796 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005797 mbedtls_mpi_free(&k);
5798 mbedtls_mpi_free(&diff_N_2);
5799 return status;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005800}
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005801
5802/* ECC keys on a Montgomery elliptic curve draws a byte string whose length
5803 * is determined by the curve, and sets the mandatory bits accordingly. That is:
5804 *
5805 * - Curve25519 (PSA_ECC_FAMILY_MONTGOMERY, 255 bits):
5806 * draw a 32-byte string and process it as specified in
5807 * Elliptic Curves for Security [RFC7748] §5.
5808 *
5809 * - Curve448 (PSA_ECC_FAMILY_MONTGOMERY, 448 bits):
5810 * draw a 56-byte string and process it as specified in [RFC7748] §5.
5811 *
5812 * Note: Function allocates memory for *data buffer, so given *data should be
5813 * always NULL.
5814 */
5815
5816static psa_status_t psa_generate_derived_ecc_key_montgomery_helper(
5817 size_t bits,
5818 psa_key_derivation_operation_t *operation,
5819 uint8_t **data
5820 )
5821{
5822 size_t output_length;
Przemek Stekiela81aed22022-03-01 15:13:30 +01005823 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005824
Gilles Peskine449bd832023-01-11 14:50:10 +01005825 switch (bits) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005826 case 255:
5827 output_length = 32;
5828 break;
5829 case 448:
5830 output_length = 56;
5831 break;
5832 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005833 return PSA_ERROR_INVALID_ARGUMENT;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005834 break;
5835 }
5836
Gilles Peskine449bd832023-01-11 14:50:10 +01005837 *data = mbedtls_calloc(1, output_length);
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005838
Gilles Peskine449bd832023-01-11 14:50:10 +01005839 if (*data == NULL) {
5840 return PSA_ERROR_INSUFFICIENT_MEMORY;
5841 }
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005842
Gilles Peskine449bd832023-01-11 14:50:10 +01005843 status = psa_key_derivation_output_bytes(operation, *data, output_length);
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005844
Gilles Peskine449bd832023-01-11 14:50:10 +01005845 if (status != PSA_SUCCESS) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005846 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01005847 }
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005848
Gilles Peskine449bd832023-01-11 14:50:10 +01005849 switch (bits) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005850 case 255:
5851 (*data)[0] &= 248;
5852 (*data)[31] &= 127;
5853 (*data)[31] |= 64;
5854 break;
5855 case 448:
5856 (*data)[0] &= 252;
5857 (*data)[55] |= 128;
5858 break;
5859 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005860 return PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005861 break;
5862 }
5863
5864 return status;
5865}
Valerio Setti86587ab2023-06-27 13:09:30 +02005866#else /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE */
5867static psa_status_t psa_generate_derived_ecc_key_weierstrass_helper(
5868 psa_key_slot_t *slot, size_t bits,
5869 psa_key_derivation_operation_t *operation, uint8_t **data)
5870{
5871 (void) slot;
5872 (void) bits;
5873 (void) operation;
5874 (void) data;
5875 return PSA_ERROR_NOT_SUPPORTED;
5876}
5877
5878static psa_status_t psa_generate_derived_ecc_key_montgomery_helper(
5879 size_t bits, psa_key_derivation_operation_t *operation, uint8_t **data)
5880{
5881 (void) bits;
5882 (void) operation;
5883 (void) data;
5884 return PSA_ERROR_NOT_SUPPORTED;
5885}
5886#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE */
5887#endif /* PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE */
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005888
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01005889static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005890 psa_key_slot_t *slot,
5891 size_t bits,
Gilles Peskine449bd832023-01-11 14:50:10 +01005892 psa_key_derivation_operation_t *operation)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005893{
5894 uint8_t *data = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01005895 size_t bytes = PSA_BITS_TO_BYTES(bits);
Archanad8a83dc2021-06-14 10:04:16 +05305896 size_t storage_size = bytes;
Przemek Stekiela81aed22022-03-01 15:13:30 +01005897 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01005898 psa_key_attributes_t attributes;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005899
Gilles Peskine449bd832023-01-11 14:50:10 +01005900 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(slot->attr.type)) {
5901 return PSA_ERROR_INVALID_ARGUMENT;
5902 }
Gilles Peskineeab56e42018-07-12 17:12:33 +02005903
Valerio Setti8ffdb5d2023-06-20 13:14:08 +02005904#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE) || \
Valerio Settidd24f292023-06-26 12:21:17 +02005905 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE)
Gilles Peskine449bd832023-01-11 14:50:10 +01005906 if (PSA_KEY_TYPE_IS_ECC(slot->attr.type)) {
5907 psa_ecc_family_t curve = PSA_KEY_TYPE_ECC_GET_FAMILY(slot->attr.type);
5908 if (PSA_ECC_FAMILY_IS_WEIERSTRASS(curve)) {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01005909 /* Weierstrass elliptic curve */
Gilles Peskine449bd832023-01-11 14:50:10 +01005910 status = psa_generate_derived_ecc_key_weierstrass_helper(slot, bits, operation, &data);
5911 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005912 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005913 }
5914 } else {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01005915 /* Montgomery elliptic curve */
Gilles Peskine449bd832023-01-11 14:50:10 +01005916 status = psa_generate_derived_ecc_key_montgomery_helper(bits, operation, &data);
5917 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01005918 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005919 }
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01005920 }
Przemyslaw Stekiel1dfd1222021-11-18 13:35:00 +01005921 } else
Valerio Setti8ffdb5d2023-06-20 13:14:08 +02005922#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE) ||
Valerio Settidd24f292023-06-26 12:21:17 +02005923 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE) */
Gilles Peskine449bd832023-01-11 14:50:10 +01005924 if (key_type_is_raw_bytes(slot->attr.type)) {
5925 if (bits % 8 != 0) {
5926 return PSA_ERROR_INVALID_ARGUMENT;
5927 }
5928 data = mbedtls_calloc(1, bytes);
5929 if (data == NULL) {
5930 return PSA_ERROR_INSUFFICIENT_MEMORY;
5931 }
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01005932
Gilles Peskine449bd832023-01-11 14:50:10 +01005933 status = psa_key_derivation_output_bytes(operation, data, bytes);
5934 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01005935 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005936 }
David Brown12ca5032021-02-11 11:02:00 -07005937#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01005938 if (slot->attr.type == PSA_KEY_TYPE_DES) {
5939 psa_des_set_key_parity(data, bytes);
5940 }
Przemek Stekielf110dc02022-03-01 14:48:05 +01005941#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES) */
Gilles Peskine449bd832023-01-11 14:50:10 +01005942 } else {
5943 return PSA_ERROR_NOT_SUPPORTED;
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01005944 }
Ronald Crondd04d422020-11-28 15:14:42 +01005945
Ronald Cronbf33c932020-11-28 18:06:53 +01005946 slot->attr.bits = (psa_key_bits_t) bits;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01005947 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01005948 .core = slot->attr
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01005949 };
5950
Gilles Peskine449bd832023-01-11 14:50:10 +01005951 if (psa_key_lifetime_is_external(attributes.core.lifetime)) {
5952 status = psa_driver_wrapper_get_key_buffer_size(&attributes,
5953 &storage_size);
5954 if (status != PSA_SUCCESS) {
Archanad8a83dc2021-06-14 10:04:16 +05305955 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005956 }
Archanad8a83dc2021-06-14 10:04:16 +05305957 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005958 status = psa_allocate_buffer_to_slot(slot, storage_size);
5959 if (status != PSA_SUCCESS) {
Archanad8a83dc2021-06-14 10:04:16 +05305960 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005961 }
Archanad8a83dc2021-06-14 10:04:16 +05305962
Gilles Peskine449bd832023-01-11 14:50:10 +01005963 status = psa_driver_wrapper_import_key(&attributes,
5964 data, bytes,
5965 slot->key.data,
5966 slot->key.bytes,
5967 &slot->key.bytes, &bits);
5968 if (bits != slot->attr.bits) {
Ronald Cronbf33c932020-11-28 18:06:53 +01005969 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine449bd832023-01-11 14:50:10 +01005970 }
Gilles Peskineeab56e42018-07-12 17:12:33 +02005971
5972exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005973 mbedtls_free(data);
5974 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005975}
5976
Gilles Peskine449bd832023-01-11 14:50:10 +01005977psa_status_t psa_key_derivation_output_key(const psa_key_attributes_t *attributes,
5978 psa_key_derivation_operation_t *operation,
5979 mbedtls_svc_key_id_t *key)
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005980{
5981 psa_status_t status;
5982 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02005983 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine0f84d622019-09-12 19:03:13 +02005984
Ronald Cron81709fc2020-11-14 12:10:32 +01005985 *key = MBEDTLS_SVC_KEY_ID_INIT;
5986
Gilles Peskine0f84d622019-09-12 19:03:13 +02005987 /* Reject any attempt to create a zero-length key so that we don't
5988 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005989 if (psa_get_key_bits(attributes) == 0) {
5990 return PSA_ERROR_INVALID_ARGUMENT;
5991 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02005992
Gilles Peskine449bd832023-01-11 14:50:10 +01005993 if (operation->alg == PSA_ALG_NONE) {
5994 return PSA_ERROR_BAD_STATE;
5995 }
Dave Rodgmand69da6c2021-11-16 10:32:48 +00005996
Gilles Peskine449bd832023-01-11 14:50:10 +01005997 if (!operation->can_output_key) {
5998 return PSA_ERROR_NOT_PERMITTED;
5999 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02006000
Gilles Peskine449bd832023-01-11 14:50:10 +01006001 status = psa_start_key_creation(PSA_KEY_CREATION_DERIVE, attributes,
6002 &slot, &driver);
Gilles Peskinef4ee6622019-07-24 13:44:30 +02006003#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006004 if (driver != NULL) {
Gilles Peskinef4ee6622019-07-24 13:44:30 +02006005 /* Deriving a key in a secure element is not implemented yet. */
6006 status = PSA_ERROR_NOT_SUPPORTED;
6007 }
6008#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine449bd832023-01-11 14:50:10 +01006009 if (status == PSA_SUCCESS) {
6010 status = psa_generate_derived_key_internal(slot,
6011 attributes->core.bits,
6012 operation);
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006013 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006014 if (status == PSA_SUCCESS) {
6015 status = psa_finish_key_creation(slot, driver, key);
6016 }
6017 if (status != PSA_SUCCESS) {
6018 psa_fail_key_creation(slot, driver);
6019 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02006020
Gilles Peskine449bd832023-01-11 14:50:10 +01006021 return status;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006022}
6023
Gilles Peskineeab56e42018-07-12 17:12:33 +02006024
6025
6026/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02006027/* Key derivation */
6028/****************************************************************/
6029
Steven Cooreman932ffb72021-02-15 12:14:32 +01006030#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006031static int is_kdf_alg_supported(psa_algorithm_t kdf_alg)
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006032{
6033#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006034 if (PSA_ALG_IS_HKDF(kdf_alg)) {
6035 return 1;
6036 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006037#endif
Przemek Stekielb57a44b2022-06-06 08:33:45 +02006038#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006039 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6040 return 1;
6041 }
Przemek Stekielb57a44b2022-06-06 08:33:45 +02006042#endif
6043#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006044 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
6045 return 1;
6046 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006047#endif
6048#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006049 if (PSA_ALG_IS_TLS12_PRF(kdf_alg)) {
6050 return 1;
6051 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006052#endif
6053#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006054 if (PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
6055 return 1;
6056 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006057#endif
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006058#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006059 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
6060 return 1;
6061 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006062#endif
Kusumit Ghoderaod132cac2023-05-03 12:00:27 +05306063#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
6064 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
6065 return 1;
6066 }
6067#endif
Kusumit Ghoderao2cd64962023-06-22 15:38:57 +05306068#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128)
6069 if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
6070 return 1;
6071 }
6072#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006073 return 0;
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006074}
6075
Gilles Peskine449bd832023-01-11 14:50:10 +01006076static psa_status_t psa_hash_try_support(psa_algorithm_t alg)
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006077{
6078 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01006079 psa_status_t status = psa_hash_setup(&operation, alg);
6080 psa_hash_abort(&operation);
6081 return status;
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006082}
6083
Gilles Peskine969c5d62019-01-16 15:53:06 +01006084static psa_status_t psa_key_derivation_setup_kdf(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006085 psa_key_derivation_operation_t *operation,
Gilles Peskine449bd832023-01-11 14:50:10 +01006086 psa_algorithm_t kdf_alg)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006087{
Janos Follath5fe19732019-06-20 15:09:30 +01006088 /* Make sure that operation->ctx is properly zero-initialised. (Macro
6089 * initialisers for this union leave some bytes unspecified.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01006090 memset(&operation->ctx, 0, sizeof(operation->ctx));
Janos Follath5fe19732019-06-20 15:09:30 +01006091
Gilles Peskine969c5d62019-01-16 15:53:06 +01006092 /* Make sure that kdf_alg is a supported key derivation algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006093 if (!is_kdf_alg_supported(kdf_alg)) {
6094 return PSA_ERROR_NOT_SUPPORTED;
6095 }
John Durkop07cc04a2020-11-16 22:08:34 -08006096
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006097 /* All currently supported key derivation algorithms (apart from
Kusumit Ghoderao2cd64962023-06-22 15:38:57 +05306098 * ecjpake to pms and pbkdf2_aes_cmac_128) are based on a hash algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006099 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
6100 size_t hash_size = PSA_HASH_LENGTH(hash_alg);
Kusumit Ghoderao2cd64962023-06-22 15:38:57 +05306101 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
6102 hash_size = PSA_HASH_LENGTH(PSA_ALG_SHA_256);
6103 } else if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306104 hash_size = PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC);
Kusumit Ghoderao2cd64962023-06-22 15:38:57 +05306105 } else {
Gilles Peskine449bd832023-01-11 14:50:10 +01006106 if (hash_size == 0) {
6107 return PSA_ERROR_NOT_SUPPORTED;
6108 }
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006109
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006110 /* Make sure that hash_alg is a supported hash algorithm. Otherwise
6111 * we might fail later, which is somewhat unfriendly and potentially
6112 * risk-prone. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006113 psa_status_t status = psa_hash_try_support(hash_alg);
6114 if (status != PSA_SUCCESS) {
6115 return status;
6116 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006117 }
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006118
Gilles Peskine449bd832023-01-11 14:50:10 +01006119 if ((PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
6120 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) &&
6121 !(hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384)) {
6122 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006123 }
Andrzej Kurek77638292022-09-16 12:24:52 -04006124#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT) || \
Andrzej Kurekb510cd22022-09-26 10:50:22 -04006125 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006126 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg) ||
6127 (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS)) {
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006128 operation->capacity = hash_size;
Gilles Peskine449bd832023-01-11 14:50:10 +01006129 } else
Andrzej Kurekb510cd22022-09-26 10:50:22 -04006130#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT ||
6131 MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Gilles Peskine449bd832023-01-11 14:50:10 +01006132 operation->capacity = 255 * hash_size;
6133 return PSA_SUCCESS;
Gilles Peskine969c5d62019-01-16 15:53:06 +01006134}
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006135
Gilles Peskine449bd832023-01-11 14:50:10 +01006136static psa_status_t psa_key_agreement_try_support(psa_algorithm_t alg)
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006137{
6138#if defined(PSA_WANT_ALG_ECDH)
Gilles Peskine449bd832023-01-11 14:50:10 +01006139 if (alg == PSA_ALG_ECDH) {
6140 return PSA_SUCCESS;
6141 }
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006142#endif
Przemek Stekielfb3dd542022-12-01 14:59:15 +01006143#if defined(PSA_WANT_ALG_FFDH)
6144 if (alg == PSA_ALG_FFDH) {
6145 return PSA_SUCCESS;
6146 }
6147#endif
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006148 (void) alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01006149 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006150}
Gilles Peskinebb3814c2022-12-16 01:12:12 +01006151
6152static int psa_key_derivation_allows_free_form_secret_input(
6153 psa_algorithm_t kdf_alg)
6154{
6155#if defined(PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS)
6156 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
6157 return 0;
6158 }
6159#endif
6160 (void) kdf_alg;
6161 return 1;
6162}
John Durkop07cc04a2020-11-16 22:08:34 -08006163#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01006164
Gilles Peskine449bd832023-01-11 14:50:10 +01006165psa_status_t psa_key_derivation_setup(psa_key_derivation_operation_t *operation,
6166 psa_algorithm_t alg)
Gilles Peskine969c5d62019-01-16 15:53:06 +01006167{
6168 psa_status_t status;
6169
Gilles Peskine449bd832023-01-11 14:50:10 +01006170 if (operation->alg != 0) {
6171 return PSA_ERROR_BAD_STATE;
Gilles Peskine969c5d62019-01-16 15:53:06 +01006172 }
Gilles Peskine969c5d62019-01-16 15:53:06 +01006173
Gilles Peskine449bd832023-01-11 14:50:10 +01006174 if (PSA_ALG_IS_RAW_KEY_AGREEMENT(alg)) {
6175 return PSA_ERROR_INVALID_ARGUMENT;
6176 } else if (PSA_ALG_IS_KEY_AGREEMENT(alg)) {
6177#if defined(AT_LEAST_ONE_BUILTIN_KDF)
6178 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF(alg);
6179 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE(alg);
6180 status = psa_key_agreement_try_support(ka_alg);
6181 if (status != PSA_SUCCESS) {
6182 return status;
6183 }
Gilles Peskinebb3814c2022-12-16 01:12:12 +01006184 if (!psa_key_derivation_allows_free_form_secret_input(kdf_alg)) {
6185 return PSA_ERROR_INVALID_ARGUMENT;
6186 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006187 status = psa_key_derivation_setup_kdf(operation, kdf_alg);
6188#else
6189 return PSA_ERROR_NOT_SUPPORTED;
6190#endif /* AT_LEAST_ONE_BUILTIN_KDF */
6191 } else if (PSA_ALG_IS_KEY_DERIVATION(alg)) {
6192#if defined(AT_LEAST_ONE_BUILTIN_KDF)
6193 status = psa_key_derivation_setup_kdf(operation, alg);
6194#else
6195 return PSA_ERROR_NOT_SUPPORTED;
6196#endif /* AT_LEAST_ONE_BUILTIN_KDF */
6197 } else {
6198 return PSA_ERROR_INVALID_ARGUMENT;
6199 }
6200
6201 if (status == PSA_SUCCESS) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006202 operation->alg = alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01006203 }
6204 return status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006205}
6206
Przemek Stekiel69c46792022-06-10 12:59:51 +02006207#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006208static psa_status_t psa_hkdf_input(psa_hkdf_key_derivation_t *hkdf,
6209 psa_algorithm_t kdf_alg,
6210 psa_key_derivation_step_t step,
6211 const uint8_t *data,
6212 size_t data_length)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006213{
Gilles Peskine449bd832023-01-11 14:50:10 +01006214 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006215 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006216 switch (step) {
Gilles Peskine03410b52019-05-16 16:05:19 +02006217 case PSA_KEY_DERIVATION_INPUT_SALT:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006218#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006219 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
6220 return PSA_ERROR_INVALID_ARGUMENT;
6221 }
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006222#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND */
Gilles Peskine449bd832023-01-11 14:50:10 +01006223 if (hkdf->state != HKDF_STATE_INIT) {
6224 return PSA_ERROR_BAD_STATE;
6225 } else {
6226 status = psa_key_derivation_start_hmac(&hkdf->hmac,
6227 hash_alg,
6228 data, data_length);
6229 if (status != PSA_SUCCESS) {
6230 return status;
6231 }
Steven Cooremand1ed1d92021-04-29 19:11:25 +02006232 hkdf->state = HKDF_STATE_STARTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01006233 return PSA_SUCCESS;
Steven Cooremand1ed1d92021-04-29 19:11:25 +02006234 }
Gilles Peskine03410b52019-05-16 16:05:19 +02006235 case PSA_KEY_DERIVATION_INPUT_SECRET:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006236#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006237 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
Przemek Stekiel2fb0dcd2022-05-19 10:34:37 +02006238 /* We shouldn't be in different state as HKDF_EXPAND only allows
6239 * two inputs: SECRET (this case) and INFO which does not modify
6240 * the state. It could happen only if the hkdf
6241 * object was corrupted. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006242 if (hkdf->state != HKDF_STATE_INIT) {
6243 return PSA_ERROR_BAD_STATE;
6244 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006245
Przemek Stekiel2fb0dcd2022-05-19 10:34:37 +02006246 /* Allow only input that fits expected prk size */
Gilles Peskine449bd832023-01-11 14:50:10 +01006247 if (data_length != PSA_HASH_LENGTH(hash_alg)) {
6248 return PSA_ERROR_INVALID_ARGUMENT;
6249 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006250
Gilles Peskine449bd832023-01-11 14:50:10 +01006251 memcpy(hkdf->prk, data, data_length);
6252 } else
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006253#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND */
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006254 {
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006255 /* HKDF: If no salt was provided, use an empty salt.
6256 * HKDF-EXTRACT: salt is mandatory. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006257 if (hkdf->state == HKDF_STATE_INIT) {
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006258#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006259 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6260 return PSA_ERROR_BAD_STATE;
6261 }
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006262#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01006263 status = psa_key_derivation_start_hmac(&hkdf->hmac,
6264 hash_alg,
6265 NULL, 0);
6266 if (status != PSA_SUCCESS) {
6267 return status;
6268 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006269 hkdf->state = HKDF_STATE_STARTED;
6270 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006271 if (hkdf->state != HKDF_STATE_STARTED) {
6272 return PSA_ERROR_BAD_STATE;
6273 }
6274 status = psa_mac_update(&hkdf->hmac,
6275 data, data_length);
6276 if (status != PSA_SUCCESS) {
6277 return status;
6278 }
6279 status = psa_mac_sign_finish(&hkdf->hmac,
6280 hkdf->prk,
6281 sizeof(hkdf->prk),
6282 &data_length);
6283 if (status != PSA_SUCCESS) {
6284 return status;
6285 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006286 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006287
Gilles Peskine2b522db2019-04-12 15:11:49 +02006288 hkdf->state = HKDF_STATE_KEYED;
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006289 hkdf->block_number = 0;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006290#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006291 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006292 /* The only block of output is the PRK. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006293 memcpy(hkdf->output_block, hkdf->prk, PSA_HASH_LENGTH(hash_alg));
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006294 hkdf->offset_in_block = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01006295 } else
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006296#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006297 {
6298 /* Block 0 is empty, and the next block will be
6299 * generated by psa_key_derivation_hkdf_read(). */
Gilles Peskine449bd832023-01-11 14:50:10 +01006300 hkdf->offset_in_block = PSA_HASH_LENGTH(hash_alg);
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006301 }
6302
Gilles Peskine449bd832023-01-11 14:50:10 +01006303 return PSA_SUCCESS;
Gilles Peskine03410b52019-05-16 16:05:19 +02006304 case PSA_KEY_DERIVATION_INPUT_INFO:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006305#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006306 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6307 return PSA_ERROR_INVALID_ARGUMENT;
6308 }
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006309#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Przemek Stekielcde3f782022-06-03 16:12:27 +02006310#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006311 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg) &&
6312 hkdf->state == HKDF_STATE_INIT) {
6313 return PSA_ERROR_BAD_STATE;
6314 }
Przemek Stekielcde3f782022-06-03 16:12:27 +02006315#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01006316 if (hkdf->state == HKDF_STATE_OUTPUT) {
6317 return PSA_ERROR_BAD_STATE;
6318 }
6319 if (hkdf->info_set) {
6320 return PSA_ERROR_BAD_STATE;
6321 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006322 hkdf->info_length = data_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01006323 if (data_length != 0) {
6324 hkdf->info = mbedtls_calloc(1, data_length);
6325 if (hkdf->info == NULL) {
6326 return PSA_ERROR_INSUFFICIENT_MEMORY;
6327 }
6328 memcpy(hkdf->info, data, data_length);
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006329 }
6330 hkdf->info_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01006331 return PSA_SUCCESS;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006332 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006333 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006334 }
6335}
Przemek Stekiel69c46792022-06-10 12:59:51 +02006336#endif /* BUILTIN_ALG_ANY_HKDF */
Janos Follathb03233e2019-06-11 15:30:30 +01006337
John Durkop07cc04a2020-11-16 22:08:34 -08006338#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
6339 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006340static psa_status_t psa_tls12_prf_set_seed(psa_tls12_prf_key_derivation_t *prf,
6341 const uint8_t *data,
6342 size_t data_length)
Janos Follathf08e2652019-06-13 09:05:41 +01006343{
Gilles Peskine449bd832023-01-11 14:50:10 +01006344 if (prf->state != PSA_TLS12_PRF_STATE_INIT) {
6345 return PSA_ERROR_BAD_STATE;
6346 }
Janos Follathf08e2652019-06-13 09:05:41 +01006347
Gilles Peskine449bd832023-01-11 14:50:10 +01006348 if (data_length != 0) {
6349 prf->seed = mbedtls_calloc(1, data_length);
6350 if (prf->seed == NULL) {
6351 return PSA_ERROR_INSUFFICIENT_MEMORY;
6352 }
Janos Follathf08e2652019-06-13 09:05:41 +01006353
Gilles Peskine449bd832023-01-11 14:50:10 +01006354 memcpy(prf->seed, data, data_length);
Janos Follathd6dce9f2019-07-04 09:11:38 +01006355 prf->seed_length = data_length;
6356 }
Janos Follathf08e2652019-06-13 09:05:41 +01006357
Gilles Peskine43f958b2020-12-13 14:55:14 +01006358 prf->state = PSA_TLS12_PRF_STATE_SEED_SET;
Janos Follathf08e2652019-06-13 09:05:41 +01006359
Gilles Peskine449bd832023-01-11 14:50:10 +01006360 return PSA_SUCCESS;
Janos Follathf08e2652019-06-13 09:05:41 +01006361}
6362
Gilles Peskine449bd832023-01-11 14:50:10 +01006363static psa_status_t psa_tls12_prf_set_key(psa_tls12_prf_key_derivation_t *prf,
6364 const uint8_t *data,
6365 size_t data_length)
Janos Follath81550542019-06-13 14:26:34 +01006366{
Gilles Peskine449bd832023-01-11 14:50:10 +01006367 if (prf->state != PSA_TLS12_PRF_STATE_SEED_SET &&
6368 prf->state != PSA_TLS12_PRF_STATE_OTHER_KEY_SET) {
6369 return PSA_ERROR_BAD_STATE;
6370 }
Janos Follath81550542019-06-13 14:26:34 +01006371
Gilles Peskine449bd832023-01-11 14:50:10 +01006372 if (data_length != 0) {
6373 prf->secret = mbedtls_calloc(1, data_length);
6374 if (prf->secret == NULL) {
6375 return PSA_ERROR_INSUFFICIENT_MEMORY;
6376 }
Steven Cooremana6df6042021-04-29 19:32:25 +02006377
Gilles Peskine449bd832023-01-11 14:50:10 +01006378 memcpy(prf->secret, data, data_length);
Steven Cooremana6df6042021-04-29 19:32:25 +02006379 prf->secret_length = data_length;
6380 }
Janos Follath81550542019-06-13 14:26:34 +01006381
Gilles Peskine43f958b2020-12-13 14:55:14 +01006382 prf->state = PSA_TLS12_PRF_STATE_KEY_SET;
Janos Follath81550542019-06-13 14:26:34 +01006383
Gilles Peskine449bd832023-01-11 14:50:10 +01006384 return PSA_SUCCESS;
Janos Follath81550542019-06-13 14:26:34 +01006385}
6386
Gilles Peskine449bd832023-01-11 14:50:10 +01006387static psa_status_t psa_tls12_prf_set_label(psa_tls12_prf_key_derivation_t *prf,
6388 const uint8_t *data,
6389 size_t data_length)
Janos Follath63028dd2019-06-13 09:15:47 +01006390{
Gilles Peskine449bd832023-01-11 14:50:10 +01006391 if (prf->state != PSA_TLS12_PRF_STATE_KEY_SET) {
6392 return PSA_ERROR_BAD_STATE;
6393 }
Janos Follath63028dd2019-06-13 09:15:47 +01006394
Gilles Peskine449bd832023-01-11 14:50:10 +01006395 if (data_length != 0) {
6396 prf->label = mbedtls_calloc(1, data_length);
6397 if (prf->label == NULL) {
6398 return PSA_ERROR_INSUFFICIENT_MEMORY;
6399 }
Janos Follath63028dd2019-06-13 09:15:47 +01006400
Gilles Peskine449bd832023-01-11 14:50:10 +01006401 memcpy(prf->label, data, data_length);
Janos Follathd6dce9f2019-07-04 09:11:38 +01006402 prf->label_length = data_length;
6403 }
Janos Follath63028dd2019-06-13 09:15:47 +01006404
Gilles Peskine43f958b2020-12-13 14:55:14 +01006405 prf->state = PSA_TLS12_PRF_STATE_LABEL_SET;
Janos Follath63028dd2019-06-13 09:15:47 +01006406
Gilles Peskine449bd832023-01-11 14:50:10 +01006407 return PSA_SUCCESS;
Janos Follath63028dd2019-06-13 09:15:47 +01006408}
6409
Gilles Peskine449bd832023-01-11 14:50:10 +01006410static psa_status_t psa_tls12_prf_input(psa_tls12_prf_key_derivation_t *prf,
6411 psa_key_derivation_step_t step,
6412 const uint8_t *data,
6413 size_t data_length)
Janos Follathb03233e2019-06-11 15:30:30 +01006414{
Gilles Peskine449bd832023-01-11 14:50:10 +01006415 switch (step) {
Janos Follathf08e2652019-06-13 09:05:41 +01006416 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskine449bd832023-01-11 14:50:10 +01006417 return psa_tls12_prf_set_seed(prf, data, data_length);
Janos Follath81550542019-06-13 14:26:34 +01006418 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006419 return psa_tls12_prf_set_key(prf, data, data_length);
Janos Follath63028dd2019-06-13 09:15:47 +01006420 case PSA_KEY_DERIVATION_INPUT_LABEL:
Gilles Peskine449bd832023-01-11 14:50:10 +01006421 return psa_tls12_prf_set_label(prf, data, data_length);
Janos Follathb03233e2019-06-11 15:30:30 +01006422 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006423 return PSA_ERROR_INVALID_ARGUMENT;
Janos Follathb03233e2019-06-11 15:30:30 +01006424 }
6425}
John Durkop07cc04a2020-11-16 22:08:34 -08006426#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
6427 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
6428
6429#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
6430static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
6431 psa_tls12_prf_key_derivation_t *prf,
John Durkop07cc04a2020-11-16 22:08:34 -08006432 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006433 size_t data_length)
John Durkop07cc04a2020-11-16 22:08:34 -08006434{
6435 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006436 const size_t pms_len = (prf->state == PSA_TLS12_PRF_STATE_OTHER_KEY_SET ?
6437 4 + data_length + prf->other_secret_length :
6438 4 + 2 * data_length);
John Durkop07cc04a2020-11-16 22:08:34 -08006439
Gilles Peskine449bd832023-01-11 14:50:10 +01006440 if (data_length > PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE) {
6441 return PSA_ERROR_INVALID_ARGUMENT;
6442 }
John Durkop07cc04a2020-11-16 22:08:34 -08006443
Gilles Peskine449bd832023-01-11 14:50:10 +01006444 uint8_t *pms = mbedtls_calloc(1, pms_len);
6445 if (pms == NULL) {
6446 return PSA_ERROR_INSUFFICIENT_MEMORY;
6447 }
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02006448 uint8_t *cur = pms;
6449
6450 /* pure-PSK:
6451 * Quoting RFC 4279, Section 2:
John Durkop07cc04a2020-11-16 22:08:34 -08006452 *
6453 * The premaster secret is formed as follows: if the PSK is N octets
6454 * long, concatenate a uint16 with the value N, N zero octets, a second
6455 * uint16 with the value N, and the PSK itself.
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02006456 *
6457 * mixed-PSK:
6458 * In a DHE-PSK, RSA-PSK, ECDHE-PSK the premaster secret is formed as
6459 * follows: concatenate a uint16 with the length of the other secret,
6460 * the other secret itself, uint16 with the length of PSK, and the
6461 * PSK itself.
6462 * For details please check:
6463 * - RFC 4279, Section 4 for the definition of RSA-PSK,
6464 * - RFC 4279, Section 3 for the definition of DHE-PSK,
6465 * - RFC 5489 for the definition of ECDHE-PSK.
John Durkop07cc04a2020-11-16 22:08:34 -08006466 */
6467
Gilles Peskine449bd832023-01-11 14:50:10 +01006468 if (prf->state == PSA_TLS12_PRF_STATE_OTHER_KEY_SET) {
6469 *cur++ = MBEDTLS_BYTE_1(prf->other_secret_length);
6470 *cur++ = MBEDTLS_BYTE_0(prf->other_secret_length);
6471 if (prf->other_secret_length != 0) {
6472 memcpy(cur, prf->other_secret, prf->other_secret_length);
6473 mbedtls_platform_zeroize(prf->other_secret, prf->other_secret_length);
Przemek Stekiel2503f7e2022-04-12 12:08:01 +02006474 cur += prf->other_secret_length;
6475 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006476 } else {
6477 *cur++ = MBEDTLS_BYTE_1(data_length);
6478 *cur++ = MBEDTLS_BYTE_0(data_length);
6479 memset(cur, 0, data_length);
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02006480 cur += data_length;
6481 }
6482
Gilles Peskine449bd832023-01-11 14:50:10 +01006483 *cur++ = MBEDTLS_BYTE_1(data_length);
6484 *cur++ = MBEDTLS_BYTE_0(data_length);
6485 memcpy(cur, data, data_length);
John Durkop07cc04a2020-11-16 22:08:34 -08006486 cur += data_length;
6487
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00006488 status = psa_tls12_prf_set_key(prf, pms, (size_t) (cur - pms));
John Durkop07cc04a2020-11-16 22:08:34 -08006489
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01006490 mbedtls_zeroize_and_free(pms, pms_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01006491 return status;
John Durkop07cc04a2020-11-16 22:08:34 -08006492}
Janos Follath6660f0e2019-06-17 08:44:03 +01006493
Przemek Stekiele47201b2022-04-19 13:53:28 +02006494static psa_status_t psa_tls12_prf_psk_to_ms_set_other_key(
6495 psa_tls12_prf_key_derivation_t *prf,
6496 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006497 size_t data_length)
Przemek Stekiele47201b2022-04-19 13:53:28 +02006498{
Gilles Peskine449bd832023-01-11 14:50:10 +01006499 if (prf->state != PSA_TLS12_PRF_STATE_SEED_SET) {
6500 return PSA_ERROR_BAD_STATE;
Przemek Stekiele47201b2022-04-19 13:53:28 +02006501 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006502
6503 if (data_length != 0) {
6504 prf->other_secret = mbedtls_calloc(1, data_length);
6505 if (prf->other_secret == NULL) {
6506 return PSA_ERROR_INSUFFICIENT_MEMORY;
6507 }
6508
6509 memcpy(prf->other_secret, data, data_length);
6510 prf->other_secret_length = data_length;
6511 } else {
Przemek Stekiele47201b2022-04-19 13:53:28 +02006512 prf->other_secret_length = 0;
6513 }
6514
6515 prf->state = PSA_TLS12_PRF_STATE_OTHER_KEY_SET;
6516
Gilles Peskine449bd832023-01-11 14:50:10 +01006517 return PSA_SUCCESS;
Przemek Stekiele47201b2022-04-19 13:53:28 +02006518}
6519
Janos Follath6660f0e2019-06-17 08:44:03 +01006520static psa_status_t psa_tls12_prf_psk_to_ms_input(
6521 psa_tls12_prf_key_derivation_t *prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01006522 psa_key_derivation_step_t step,
6523 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006524 size_t data_length)
Janos Follath6660f0e2019-06-17 08:44:03 +01006525{
Gilles Peskine449bd832023-01-11 14:50:10 +01006526 switch (step) {
Przemek Stekiele47201b2022-04-19 13:53:28 +02006527 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006528 return psa_tls12_prf_psk_to_ms_set_key(prf,
6529 data, data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02006530 break;
6531 case PSA_KEY_DERIVATION_INPUT_OTHER_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006532 return psa_tls12_prf_psk_to_ms_set_other_key(prf,
6533 data,
6534 data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02006535 break;
6536 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006537 return psa_tls12_prf_input(prf, step, data, data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02006538 break;
Janos Follath6660f0e2019-06-17 08:44:03 +01006539
Przemek Stekiele47201b2022-04-19 13:53:28 +02006540 }
Janos Follath6660f0e2019-06-17 08:44:03 +01006541}
John Durkop07cc04a2020-11-16 22:08:34 -08006542#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006543
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006544#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
6545static psa_status_t psa_tls12_ecjpake_to_pms_input(
6546 psa_tls12_ecjpake_to_pms_t *ecjpake,
Andrzej Kurek702776f2022-09-16 06:22:44 -04006547 psa_key_derivation_step_t step,
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006548 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006549 size_t data_length)
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006550{
Gilles Peskine449bd832023-01-11 14:50:10 +01006551 if (data_length != PSA_TLS12_ECJPAKE_TO_PMS_INPUT_SIZE ||
6552 step != PSA_KEY_DERIVATION_INPUT_SECRET) {
6553 return PSA_ERROR_INVALID_ARGUMENT;
Andrzej Kurek5603efd2022-09-26 10:49:16 -04006554 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006555
6556 /* Check if the passed point is in an uncompressed form */
Gilles Peskine449bd832023-01-11 14:50:10 +01006557 if (data[0] != 0x04) {
6558 return PSA_ERROR_INVALID_ARGUMENT;
6559 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006560
6561 /* Only K.X has to be extracted - bytes 1 to 32 inclusive. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006562 memcpy(ecjpake->data, data + 1, PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE);
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006563
Gilles Peskine449bd832023-01-11 14:50:10 +01006564 return PSA_SUCCESS;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006565}
6566#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306567
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306568#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306569static psa_status_t psa_pbkdf2_set_input_cost(
6570 psa_pbkdf2_key_derivation_t *pbkdf2,
6571 psa_key_derivation_step_t step,
6572 uint64_t data)
6573{
6574 if (step != PSA_KEY_DERIVATION_INPUT_COST) {
6575 return PSA_ERROR_INVALID_ARGUMENT;
6576 }
6577
6578 if (pbkdf2->state != PSA_PBKDF2_STATE_INIT) {
6579 return PSA_ERROR_BAD_STATE;
6580 }
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05306581
Kusumit Ghoderaoe66a8ad2023-05-24 12:30:43 +05306582 if (data > PSA_VENDOR_PBKDF2_MAX_ITERATIONS) {
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05306583 return PSA_ERROR_NOT_SUPPORTED;
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306584 }
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05306585
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306586 if (data == 0) {
6587 return PSA_ERROR_INVALID_ARGUMENT;
6588 }
Kusumit Ghoderaoe66a8ad2023-05-24 12:30:43 +05306589
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306590 pbkdf2->input_cost = data;
6591 pbkdf2->state = PSA_PBKDF2_STATE_INPUT_COST_SET;
6592
6593 return PSA_SUCCESS;
6594}
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306595
6596static psa_status_t psa_pbkdf2_set_salt(psa_pbkdf2_key_derivation_t *pbkdf2,
6597 const uint8_t *data,
6598 size_t data_length)
6599{
Gilles Peskineead17662023-08-20 22:02:51 +02006600 if (pbkdf2->state == PSA_PBKDF2_STATE_INPUT_COST_SET) {
6601 pbkdf2->state = PSA_PBKDF2_STATE_SALT_SET;
6602 } else if (pbkdf2->state == PSA_PBKDF2_STATE_SALT_SET) {
6603 /* Appending to existing salt. No state change. */
6604 } else {
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306605 return PSA_ERROR_BAD_STATE;
6606 }
6607
Gilles Peskineca57d782023-07-20 19:08:06 +02006608 if (data_length == 0) {
Gilles Peskineead17662023-08-20 22:02:51 +02006609 /* Appending an empty string, nothing to do. */
6610 } else {
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306611 uint8_t *next_salt;
Kusumit Ghoderaob538bb72023-05-24 12:32:14 +05306612
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306613 next_salt = mbedtls_calloc(1, data_length + pbkdf2->salt_length);
6614 if (next_salt == NULL) {
Kusumit Ghoderaod0422f32023-05-08 15:56:19 +05306615 return PSA_ERROR_INSUFFICIENT_MEMORY;
6616 }
6617
Gilles Peskineead17662023-08-20 22:02:51 +02006618 if (pbkdf2->salt_length != 0) {
6619 memcpy(next_salt, pbkdf2->salt, pbkdf2->salt_length);
6620 }
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306621 memcpy(next_salt + pbkdf2->salt_length, data, data_length);
Kusumit Ghoderaod0422f32023-05-08 15:56:19 +05306622 pbkdf2->salt_length += data_length;
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306623 mbedtls_free(pbkdf2->salt);
6624 pbkdf2->salt = next_salt;
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306625 }
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306626 return PSA_SUCCESS;
6627}
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306628
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05306629#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306630static psa_status_t psa_pbkdf2_hmac_set_password(psa_algorithm_t hash_alg,
Kusumit Ghoderaoaac9a582023-05-24 14:19:17 +05306631 const uint8_t *input,
6632 size_t input_len,
6633 uint8_t *output,
Kusumit Ghoderao91f99f52023-05-24 22:21:48 +05306634 size_t *output_len)
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306635{
6636 psa_status_t status = PSA_SUCCESS;
6637 if (input_len > PSA_HASH_BLOCK_LENGTH(hash_alg)) {
6638 status = psa_hash_compute(hash_alg, input, input_len, output,
Kusumit Ghoderao91f99f52023-05-24 22:21:48 +05306639 PSA_HMAC_MAX_HASH_BLOCK_SIZE, output_len);
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306640 } else {
6641 memcpy(output, input, input_len);
Kusumit Ghoderao91f99f52023-05-24 22:21:48 +05306642 *output_len = PSA_HASH_BLOCK_LENGTH(hash_alg);
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306643 }
6644 return status;
6645}
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05306646#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC */
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306647
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05306648#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128)
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306649static psa_status_t psa_pbkdf2_cmac_set_password(const uint8_t *input,
6650 size_t input_len,
6651 uint8_t *output,
6652 size_t *output_len)
6653{
6654 psa_status_t status = PSA_SUCCESS;
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306655 if (input_len != PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC)) {
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306656 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Kusumit Ghoderao3fde8fe2023-06-27 10:41:43 +05306657 uint8_t zeros[16] = { 0 };
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306658 psa_set_key_type(&attributes, PSA_KEY_TYPE_AES);
6659 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(sizeof(zeros)));
6660 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306661 /* Passing PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC) as
Kusumit Ghoderao5f3345a2023-07-27 21:21:38 +05306662 * mac_size as the driver function sets mac_output_length = mac_size
6663 * on success. See https://github.com/Mbed-TLS/mbedtls/issues/7801 */
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306664 status = psa_driver_wrapper_mac_compute(&attributes,
6665 zeros, sizeof(zeros),
6666 PSA_ALG_CMAC, input, input_len,
6667 output,
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306668 PSA_MAC_LENGTH(PSA_KEY_TYPE_AES,
6669 128U,
6670 PSA_ALG_CMAC),
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306671 output_len);
6672 } else {
6673 memcpy(output, input, input_len);
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306674 *output_len = PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC);
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306675 }
6676 return status;
6677}
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05306678#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128 */
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306679
6680static psa_status_t psa_pbkdf2_set_password(psa_pbkdf2_key_derivation_t *pbkdf2,
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306681 psa_algorithm_t kdf_alg,
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306682 const uint8_t *data,
6683 size_t data_length)
6684{
Kusumit Ghoderaoaac9a582023-05-24 14:19:17 +05306685 psa_status_t status = PSA_SUCCESS;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306686 if (pbkdf2->state != PSA_PBKDF2_STATE_SALT_SET) {
6687 return PSA_ERROR_BAD_STATE;
6688 }
6689
Kusumit Ghoderaof3e696d2023-07-28 13:30:50 +05306690#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306691 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
6692 psa_algorithm_t hash_alg = PSA_ALG_PBKDF2_HMAC_GET_HASH(kdf_alg);
6693 status = psa_pbkdf2_hmac_set_password(hash_alg, data, data_length,
6694 pbkdf2->password,
6695 &pbkdf2->password_length);
Kusumit Ghoderaof3e696d2023-07-28 13:30:50 +05306696 } else
6697#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC */
6698#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128)
6699 if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306700 status = psa_pbkdf2_cmac_set_password(data, data_length,
6701 pbkdf2->password,
6702 &pbkdf2->password_length);
Kusumit Ghoderaof3e696d2023-07-28 13:30:50 +05306703 } else
6704#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128 */
6705 {
6706 return PSA_ERROR_INVALID_ARGUMENT;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306707 }
6708
6709 pbkdf2->state = PSA_PBKDF2_STATE_PASSWORD_SET;
6710
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306711 return status;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306712}
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05306713
6714static psa_status_t psa_pbkdf2_input(psa_pbkdf2_key_derivation_t *pbkdf2,
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306715 psa_algorithm_t kdf_alg,
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05306716 psa_key_derivation_step_t step,
6717 const uint8_t *data,
6718 size_t data_length)
6719{
6720 switch (step) {
6721 case PSA_KEY_DERIVATION_INPUT_SALT:
6722 return psa_pbkdf2_set_salt(pbkdf2, data, data_length);
6723 case PSA_KEY_DERIVATION_INPUT_PASSWORD:
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306724 return psa_pbkdf2_set_password(pbkdf2, kdf_alg, data, data_length);
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05306725 default:
6726 return PSA_ERROR_INVALID_ARGUMENT;
6727 }
6728}
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306729#endif /* PSA_HAVE_SOFT_PBKDF2 */
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306730
Gilles Peskineb8965192019-09-24 16:21:10 +02006731/** Check whether the given key type is acceptable for the given
6732 * input step of a key derivation.
6733 *
6734 * Secret inputs must have the type #PSA_KEY_TYPE_DERIVE.
6735 * Non-secret inputs must have the type #PSA_KEY_TYPE_RAW_DATA.
6736 * Both secret and non-secret inputs can alternatively have the type
6737 * #PSA_KEY_TYPE_NONE, which is never the type of a key object, meaning
6738 * that the input was passed as a buffer rather than via a key object.
6739 */
Gilles Peskine224b0d62019-09-23 18:13:17 +02006740static int psa_key_derivation_check_input_type(
6741 psa_key_derivation_step_t step,
Gilles Peskine449bd832023-01-11 14:50:10 +01006742 psa_key_type_t key_type)
Gilles Peskine224b0d62019-09-23 18:13:17 +02006743{
Gilles Peskine449bd832023-01-11 14:50:10 +01006744 switch (step) {
Gilles Peskine224b0d62019-09-23 18:13:17 +02006745 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006746 if (key_type == PSA_KEY_TYPE_DERIVE) {
6747 return PSA_SUCCESS;
6748 }
6749 if (key_type == PSA_KEY_TYPE_NONE) {
6750 return PSA_SUCCESS;
6751 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02006752 break;
Przemek Stekiela7695a22022-04-07 15:39:01 +02006753 case PSA_KEY_DERIVATION_INPUT_OTHER_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006754 if (key_type == PSA_KEY_TYPE_DERIVE) {
6755 return PSA_SUCCESS;
6756 }
6757 if (key_type == PSA_KEY_TYPE_NONE) {
6758 return PSA_SUCCESS;
6759 }
Przemek Stekiela7695a22022-04-07 15:39:01 +02006760 break;
Gilles Peskine224b0d62019-09-23 18:13:17 +02006761 case PSA_KEY_DERIVATION_INPUT_LABEL:
6762 case PSA_KEY_DERIVATION_INPUT_SALT:
6763 case PSA_KEY_DERIVATION_INPUT_INFO:
6764 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskine449bd832023-01-11 14:50:10 +01006765 if (key_type == PSA_KEY_TYPE_RAW_DATA) {
6766 return PSA_SUCCESS;
6767 }
6768 if (key_type == PSA_KEY_TYPE_NONE) {
6769 return PSA_SUCCESS;
6770 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02006771 break;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306772 case PSA_KEY_DERIVATION_INPUT_PASSWORD:
6773 if (key_type == PSA_KEY_TYPE_PASSWORD) {
6774 return PSA_SUCCESS;
6775 }
6776 if (key_type == PSA_KEY_TYPE_DERIVE) {
6777 return PSA_SUCCESS;
6778 }
6779 if (key_type == PSA_KEY_TYPE_NONE) {
6780 return PSA_SUCCESS;
6781 }
6782 break;
Gilles Peskine224b0d62019-09-23 18:13:17 +02006783 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006784 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine224b0d62019-09-23 18:13:17 +02006785}
6786
Janos Follathb80a94e2019-06-12 15:54:46 +01006787static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006788 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01006789 psa_key_derivation_step_t step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02006790 psa_key_type_t key_type,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01006791 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006792 size_t data_length)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006793{
Gilles Peskine46d7faf2019-09-23 19:22:55 +02006794 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006795 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
Gilles Peskine46d7faf2019-09-23 19:22:55 +02006796
Gilles Peskine449bd832023-01-11 14:50:10 +01006797 status = psa_key_derivation_check_input_type(step, key_type);
6798 if (status != PSA_SUCCESS) {
Gilles Peskine224b0d62019-09-23 18:13:17 +02006799 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006800 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02006801
Przemek Stekiel69c46792022-06-10 12:59:51 +02006802#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006803 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
6804 status = psa_hkdf_input(&operation->ctx.hkdf, kdf_alg,
6805 step, data, data_length);
6806 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02006807#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08006808#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006809 if (PSA_ALG_IS_TLS12_PRF(kdf_alg)) {
6810 status = psa_tls12_prf_input(&operation->ctx.tls12_prf,
6811 step, data, data_length);
6812 } else
John Durkop07cc04a2020-11-16 22:08:34 -08006813#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF */
6814#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006815 if (PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
6816 status = psa_tls12_prf_psk_to_ms_input(&operation->ctx.tls12_prf,
6817 step, data, data_length);
6818 } else
John Durkop07cc04a2020-11-16 22:08:34 -08006819#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006820#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006821 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006822 status = psa_tls12_ecjpake_to_pms_input(
Gilles Peskine449bd832023-01-11 14:50:10 +01006823 &operation->ctx.tls12_ecjpake_to_pms, step, data, data_length);
6824 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006825#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306826#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05306827 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306828 status = psa_pbkdf2_input(&operation->ctx.pbkdf2, kdf_alg,
6829 step, data, data_length);
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05306830 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306831#endif /* PSA_HAVE_SOFT_PBKDF2 */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006832 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006833 /* This can't happen unless the operation object was not initialized */
Steven Cooreman74afe472021-02-10 17:19:22 +01006834 (void) data;
6835 (void) data_length;
6836 (void) kdf_alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01006837 return PSA_ERROR_BAD_STATE;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006838 }
6839
Gilles Peskine224b0d62019-09-23 18:13:17 +02006840exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01006841 if (status != PSA_SUCCESS) {
6842 psa_key_derivation_abort(operation);
6843 }
6844 return status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006845}
6846
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05306847static psa_status_t psa_key_derivation_input_integer_internal(
6848 psa_key_derivation_operation_t *operation,
6849 psa_key_derivation_step_t step,
6850 uint64_t value)
6851{
6852 psa_status_t status;
6853 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
6854
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306855#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05306856 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306857 status = psa_pbkdf2_set_input_cost(
6858 &operation->ctx.pbkdf2, step, value);
6859 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306860#endif /* PSA_HAVE_SOFT_PBKDF2 */
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05306861 {
Kusumit Ghoderao3a18dee2023-04-07 16:16:27 +05306862 (void) step;
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05306863 (void) value;
6864 (void) kdf_alg;
Kusumit Ghoderaoa14ae5a2023-04-19 14:16:26 +05306865 status = PSA_ERROR_INVALID_ARGUMENT;
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05306866 }
6867
6868 if (status != PSA_SUCCESS) {
6869 psa_key_derivation_abort(operation);
6870 }
6871 return status;
6872}
6873
Janos Follath51f4a0f2019-06-14 11:35:55 +01006874psa_status_t psa_key_derivation_input_bytes(
6875 psa_key_derivation_operation_t *operation,
6876 psa_key_derivation_step_t step,
6877 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006878 size_t data_length)
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01006879{
Gilles Peskine449bd832023-01-11 14:50:10 +01006880 return psa_key_derivation_input_internal(operation, step,
6881 PSA_KEY_TYPE_NONE,
6882 data, data_length);
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01006883}
6884
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05306885psa_status_t psa_key_derivation_input_integer(
6886 psa_key_derivation_operation_t *operation,
6887 psa_key_derivation_step_t step,
6888 uint64_t value)
6889{
6890 return psa_key_derivation_input_integer_internal(operation, step, value);
6891}
6892
Janos Follath51f4a0f2019-06-14 11:35:55 +01006893psa_status_t psa_key_derivation_input_key(
6894 psa_key_derivation_operation_t *operation,
6895 psa_key_derivation_step_t step,
Gilles Peskine449bd832023-01-11 14:50:10 +01006896 mbedtls_svc_key_id_t key)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006897{
Ronald Cronf95a2b12020-10-22 15:24:49 +02006898 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01006899 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006900 psa_key_slot_t *slot;
Gilles Peskine178c9aa2019-09-24 18:21:06 +02006901
Ronald Cron5c522922020-11-14 16:35:34 +01006902 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01006903 key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg);
6904 if (status != PSA_SUCCESS) {
6905 psa_key_derivation_abort(operation);
6906 return status;
Gilles Peskine593773d2019-09-23 18:17:40 +02006907 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02006908
Kusumit Ghoderao3128c5d2023-05-03 12:27:57 +05306909 /* Passing a key object as a SECRET or PASSWORD input unlocks the
6910 * permission to output to a key object. */
6911 if (step == PSA_KEY_DERIVATION_INPUT_SECRET ||
6912 step == PSA_KEY_DERIVATION_INPUT_PASSWORD) {
Gilles Peskine178c9aa2019-09-24 18:21:06 +02006913 operation->can_output_key = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01006914 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02006915
Gilles Peskine449bd832023-01-11 14:50:10 +01006916 status = psa_key_derivation_input_internal(operation,
6917 step, slot->attr.type,
6918 slot->key.data,
6919 slot->key.bytes);
Ronald Cronf95a2b12020-10-22 15:24:49 +02006920
Gilles Peskine449bd832023-01-11 14:50:10 +01006921 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02006922
Gilles Peskine449bd832023-01-11 14:50:10 +01006923 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006924}
Gilles Peskineea0fb492018-07-12 17:17:20 +02006925
6926
6927
6928/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02006929/* Key agreement */
6930/****************************************************************/
6931
Gilles Peskine449bd832023-01-11 14:50:10 +01006932psa_status_t psa_key_agreement_raw_builtin(const psa_key_attributes_t *attributes,
6933 const uint8_t *key_buffer,
6934 size_t key_buffer_size,
6935 psa_algorithm_t alg,
6936 const uint8_t *peer_key,
6937 size_t peer_key_length,
6938 uint8_t *shared_secret,
6939 size_t shared_secret_size,
6940 size_t *shared_secret_length)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02006941{
Gilles Peskine449bd832023-01-11 14:50:10 +01006942 switch (alg) {
John Durkop6ba40d12020-11-10 08:50:04 -08006943#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskine0216fe12019-04-11 21:23:21 +02006944 case PSA_ALG_ECDH:
Gilles Peskine449bd832023-01-11 14:50:10 +01006945 return mbedtls_psa_key_agreement_ecdh(attributes, key_buffer,
6946 key_buffer_size, alg,
6947 peer_key, peer_key_length,
6948 shared_secret,
6949 shared_secret_size,
6950 shared_secret_length);
Gilles Peskine01d718c2018-09-18 12:01:02 +02006951#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Przemek Stekielfb3dd542022-12-01 14:59:15 +01006952
6953#if defined(MBEDTLS_PSA_BUILTIN_ALG_FFDH)
6954 case PSA_ALG_FFDH:
Przemek Stekiel152bb462023-06-01 11:52:39 +02006955 return mbedtls_psa_ffdh_key_agreement(attributes,
Przemek Stekiel359f4622022-12-05 14:11:55 +01006956 peer_key,
6957 peer_key_length,
6958 key_buffer,
6959 key_buffer_size,
6960 shared_secret,
6961 shared_secret_size,
6962 shared_secret_length);
Przemek Stekielfb3dd542022-12-01 14:59:15 +01006963#endif /* MBEDTLS_PSA_BUILTIN_ALG_FFDH */
6964
Gilles Peskine01d718c2018-09-18 12:01:02 +02006965 default:
Aditya Deshpande17845b82022-10-13 17:21:01 +01006966 (void) attributes;
6967 (void) key_buffer;
6968 (void) key_buffer_size;
Gilles Peskine93f85002018-11-16 16:43:31 +01006969 (void) peer_key;
6970 (void) peer_key_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02006971 (void) shared_secret;
6972 (void) shared_secret_size;
6973 (void) shared_secret_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01006974 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine01d718c2018-09-18 12:01:02 +02006975 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02006976}
Gilles Peskine01d718c2018-09-18 12:01:02 +02006977
Aditya Deshpande17845b82022-10-13 17:21:01 +01006978/** Internal function for raw key agreement
6979 * Calls the driver wrapper which will hand off key agreement task
Aditya Deshpande40c05cc2022-10-14 16:41:40 +01006980 * to the driver's implementation if a driver is present.
6981 * Fallback specified in the driver wrapper is built-in raw key agreement
Aditya Deshpande17845b82022-10-13 17:21:01 +01006982 * (psa_key_agreement_raw_builtin).
6983 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006984static psa_status_t psa_key_agreement_raw_internal(psa_algorithm_t alg,
6985 psa_key_slot_t *private_key,
6986 const uint8_t *peer_key,
6987 size_t peer_key_length,
6988 uint8_t *shared_secret,
6989 size_t shared_secret_size,
6990 size_t *shared_secret_length)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006991{
Gilles Peskine449bd832023-01-11 14:50:10 +01006992 if (!PSA_ALG_IS_RAW_KEY_AGREEMENT(alg)) {
6993 return PSA_ERROR_NOT_SUPPORTED;
6994 }
Aditya Deshpande17845b82022-10-13 17:21:01 +01006995
6996 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01006997 .core = private_key->attr
Aditya Deshpande17845b82022-10-13 17:21:01 +01006998 };
6999
Gilles Peskine449bd832023-01-11 14:50:10 +01007000 return psa_driver_wrapper_key_agreement(&attributes,
7001 private_key->key.data,
7002 private_key->key.bytes, alg,
7003 peer_key, peer_key_length,
7004 shared_secret,
7005 shared_secret_size,
7006 shared_secret_length);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007007}
7008
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02007009/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine01d718c2018-09-18 12:01:02 +02007010 * to potentially free embedded data structures and wipe confidential data.
7011 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007012static psa_status_t psa_key_agreement_internal(psa_key_derivation_operation_t *operation,
7013 psa_key_derivation_step_t step,
7014 psa_key_slot_t *private_key,
7015 const uint8_t *peer_key,
7016 size_t peer_key_length)
Gilles Peskine01d718c2018-09-18 12:01:02 +02007017{
7018 psa_status_t status;
Aditya Deshpande2f7fd762022-11-22 11:10:34 +00007019 uint8_t shared_secret[PSA_RAW_KEY_AGREEMENT_OUTPUT_MAX_SIZE];
Gilles Peskine01d718c2018-09-18 12:01:02 +02007020 size_t shared_secret_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007021 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE(operation->alg);
Gilles Peskine01d718c2018-09-18 12:01:02 +02007022
7023 /* Step 1: run the secret agreement algorithm to generate the shared
7024 * secret. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007025 status = psa_key_agreement_raw_internal(ka_alg,
7026 private_key,
7027 peer_key, peer_key_length,
7028 shared_secret,
7029 sizeof(shared_secret),
7030 &shared_secret_length);
7031 if (status != PSA_SUCCESS) {
Gilles Peskine12313cd2018-06-20 00:20:32 +02007032 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007033 }
Gilles Peskine12313cd2018-06-20 00:20:32 +02007034
Gilles Peskineb0b255c2018-07-06 17:01:38 +02007035 /* Step 2: set up the key derivation to generate key material from
Gilles Peskine224b0d62019-09-23 18:13:17 +02007036 * the shared secret. A shared secret is permitted wherever a key
7037 * of type DERIVE is permitted. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007038 status = psa_key_derivation_input_internal(operation, step,
7039 PSA_KEY_TYPE_DERIVE,
7040 shared_secret,
7041 shared_secret_length);
Gilles Peskine12313cd2018-06-20 00:20:32 +02007042exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007043 mbedtls_platform_zeroize(shared_secret, shared_secret_length);
7044 return status;
Gilles Peskine12313cd2018-06-20 00:20:32 +02007045}
7046
Gilles Peskine449bd832023-01-11 14:50:10 +01007047psa_status_t psa_key_derivation_key_agreement(psa_key_derivation_operation_t *operation,
7048 psa_key_derivation_step_t step,
7049 mbedtls_svc_key_id_t private_key,
7050 const uint8_t *peer_key,
7051 size_t peer_key_length)
Gilles Peskine12313cd2018-06-20 00:20:32 +02007052{
Ronald Cronf95a2b12020-10-22 15:24:49 +02007053 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01007054 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01007055 psa_key_slot_t *slot;
Ronald Cronf95a2b12020-10-22 15:24:49 +02007056
Gilles Peskine449bd832023-01-11 14:50:10 +01007057 if (!PSA_ALG_IS_KEY_AGREEMENT(operation->alg)) {
7058 return PSA_ERROR_INVALID_ARGUMENT;
7059 }
Ronald Cron5c522922020-11-14 16:35:34 +01007060 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01007061 private_key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg);
7062 if (status != PSA_SUCCESS) {
7063 return status;
7064 }
7065 status = psa_key_agreement_internal(operation, step,
7066 slot,
7067 peer_key, peer_key_length);
7068 if (status != PSA_SUCCESS) {
7069 psa_key_derivation_abort(operation);
7070 } else {
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007071 /* If a private key has been added as SECRET, we allow the derived
7072 * key material to be used as a key in PSA Crypto. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007073 if (step == PSA_KEY_DERIVATION_INPUT_SECRET) {
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007074 operation->can_output_key = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01007075 }
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007076 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007077
Gilles Peskine449bd832023-01-11 14:50:10 +01007078 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007079
Gilles Peskine449bd832023-01-11 14:50:10 +01007080 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskineaf3baab2018-06-27 22:55:52 +02007081}
7082
Gilles Peskine449bd832023-01-11 14:50:10 +01007083psa_status_t psa_raw_key_agreement(psa_algorithm_t alg,
7084 mbedtls_svc_key_id_t private_key,
7085 const uint8_t *peer_key,
7086 size_t peer_key_length,
7087 uint8_t *output,
7088 size_t output_size,
7089 size_t *output_length)
Gilles Peskine0216fe12019-04-11 21:23:21 +02007090{
Ronald Cronf95a2b12020-10-22 15:24:49 +02007091 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01007092 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +02007093 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007094 size_t expected_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02007095
Gilles Peskine449bd832023-01-11 14:50:10 +01007096 if (!PSA_ALG_IS_KEY_AGREEMENT(alg)) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007097 status = PSA_ERROR_INVALID_ARGUMENT;
7098 goto exit;
7099 }
Ronald Cron5c522922020-11-14 16:35:34 +01007100 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01007101 private_key, &slot, PSA_KEY_USAGE_DERIVE, alg);
7102 if (status != PSA_SUCCESS) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007103 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007104 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02007105
Gilles Peskine3e561302022-04-14 00:17:15 +02007106 /* PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() is in general an upper bound
7107 * for the output size. The PSA specification only guarantees that this
7108 * function works if output_size >= PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE(...),
7109 * but it might be nice to allow smaller buffers if the output fits.
7110 * At the time of writing this comment, with only ECDH implemented,
7111 * PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() is exact so the point is moot.
7112 * If FFDH is implemented, PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() can easily
7113 * be exact for it as well. */
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007114 expected_length =
Gilles Peskine449bd832023-01-11 14:50:10 +01007115 PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE(slot->attr.type, slot->attr.bits);
7116 if (output_size < expected_length) {
Gilles Peskine3e561302022-04-14 00:17:15 +02007117 status = PSA_ERROR_BUFFER_TOO_SMALL;
7118 goto exit;
7119 }
7120
Gilles Peskine449bd832023-01-11 14:50:10 +01007121 status = psa_key_agreement_raw_internal(alg, slot,
7122 peer_key, peer_key_length,
7123 output, output_size,
7124 output_length);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007125
7126exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007127 if (status != PSA_SUCCESS) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007128 /* If an error happens and is not handled properly, the output
7129 * may be used as a key to protect sensitive data. Arrange for such
7130 * a key to be random, which is likely to result in decryption or
7131 * verification errors. This is better than filling the buffer with
7132 * some constant data such as zeros, which would result in the data
7133 * being protected with a reproducible, easily knowable key.
7134 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007135 psa_generate_random(output, output_size);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007136 *output_length = output_size;
7137 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007138
Gilles Peskine449bd832023-01-11 14:50:10 +01007139 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007140
Gilles Peskine449bd832023-01-11 14:50:10 +01007141 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine0216fe12019-04-11 21:23:21 +02007142}
Gilles Peskine86a440b2018-11-12 18:39:40 +01007143
7144
Gilles Peskine30524eb2020-11-13 17:02:26 +01007145
Gilles Peskine86a440b2018-11-12 18:39:40 +01007146/****************************************************************/
7147/* Random generation */
Gilles Peskine53d991e2018-07-12 01:14:59 +02007148/****************************************************************/
Gilles Peskine12313cd2018-06-20 00:20:32 +02007149
Gilles Peskine672a7712023-04-28 21:00:28 +02007150#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
7151#include "entropy_poll.h"
7152#endif
7153
Gilles Peskine30524eb2020-11-13 17:02:26 +01007154/** Initialize the PSA random generator.
7155 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007156static void mbedtls_psa_random_init(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01007157{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007158#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine449bd832023-01-11 14:50:10 +01007159 memset(rng, 0, sizeof(*rng));
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007160#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
7161
Gilles Peskine30524eb2020-11-13 17:02:26 +01007162 /* Set default configuration if
7163 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007164 if (rng->entropy_init == NULL) {
Gilles Peskine30524eb2020-11-13 17:02:26 +01007165 rng->entropy_init = mbedtls_entropy_init;
Gilles Peskine449bd832023-01-11 14:50:10 +01007166 }
7167 if (rng->entropy_free == NULL) {
Gilles Peskine30524eb2020-11-13 17:02:26 +01007168 rng->entropy_free = mbedtls_entropy_free;
Gilles Peskine449bd832023-01-11 14:50:10 +01007169 }
Gilles Peskine30524eb2020-11-13 17:02:26 +01007170
Gilles Peskine449bd832023-01-11 14:50:10 +01007171 rng->entropy_init(&rng->entropy);
Gilles Peskine30524eb2020-11-13 17:02:26 +01007172#if defined(MBEDTLS_PSA_INJECT_ENTROPY) && \
7173 defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
7174 /* The PSA entropy injection feature depends on using NV seed as an entropy
7175 * source. Add NV seed as an entropy source for PSA entropy injection. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007176 mbedtls_entropy_add_source(&rng->entropy,
7177 mbedtls_nv_seed_poll, NULL,
7178 MBEDTLS_ENTROPY_BLOCK_SIZE,
7179 MBEDTLS_ENTROPY_SOURCE_STRONG);
Gilles Peskine30524eb2020-11-13 17:02:26 +01007180#endif
7181
Gilles Peskine449bd832023-01-11 14:50:10 +01007182 mbedtls_psa_drbg_init(MBEDTLS_PSA_RANDOM_STATE);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007183#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007184}
7185
7186/** Deinitialize the PSA random generator.
7187 */
Valerio Setti83e0de82023-11-24 12:13:05 +01007188static void mbedtls_psa_random_free(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01007189{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007190#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Valerio Setti83e0de82023-11-24 12:13:05 +01007191 memset(rng, 0, sizeof(*rng));
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007192#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Valerio Setti83e0de82023-11-24 12:13:05 +01007193 mbedtls_psa_drbg_free(MBEDTLS_PSA_RANDOM_STATE);
7194 rng->entropy_free(&rng->entropy);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007195#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007196}
7197
7198/** Seed the PSA random generator.
7199 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007200static psa_status_t mbedtls_psa_random_seed(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01007201{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007202#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
7203 /* Do nothing: the external RNG seeds itself. */
7204 (void) rng;
Gilles Peskine449bd832023-01-11 14:50:10 +01007205 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007206#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007207 const unsigned char drbg_seed[] = "PSA";
Gilles Peskine449bd832023-01-11 14:50:10 +01007208 int ret = mbedtls_psa_drbg_seed(&rng->entropy,
7209 drbg_seed, sizeof(drbg_seed) - 1);
7210 return mbedtls_to_psa_error(ret);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007211#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007212}
7213
Gilles Peskine449bd832023-01-11 14:50:10 +01007214psa_status_t psa_generate_random(uint8_t *output,
7215 size_t output_size)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007216{
Gilles Peskinee59236f2018-01-27 23:32:46 +01007217 GUARD_MODULE_INITIALIZED;
7218
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007219#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
7220
7221 size_t output_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007222 psa_status_t status = mbedtls_psa_external_get_random(&global_data.rng,
7223 output, output_size,
7224 &output_length);
7225 if (status != PSA_SUCCESS) {
7226 return status;
7227 }
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007228 /* Breaking up a request into smaller chunks is currently not supported
Tom Cosgrove1797b052022-12-04 17:19:59 +00007229 * for the external RNG interface. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007230 if (output_length != output_size) {
7231 return PSA_ERROR_INSUFFICIENT_ENTROPY;
7232 }
7233 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007234
7235#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
7236
Gilles Peskine449bd832023-01-11 14:50:10 +01007237 while (output_size > 0) {
Gilles Peskine71ddab92021-01-04 21:01:07 +01007238 size_t request_size =
Gilles Peskine449bd832023-01-11 14:50:10 +01007239 (output_size > MBEDTLS_PSA_RANDOM_MAX_REQUEST ?
7240 MBEDTLS_PSA_RANDOM_MAX_REQUEST :
7241 output_size);
7242 int ret = mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE,
7243 output, request_size);
7244 if (ret != 0) {
7245 return mbedtls_to_psa_error(ret);
7246 }
Gilles Peskine71ddab92021-01-04 21:01:07 +01007247 output_size -= request_size;
7248 output += request_size;
Gilles Peskinef181eca2019-08-07 13:49:00 +02007249 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007250 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007251#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskinee59236f2018-01-27 23:32:46 +01007252}
7253
Gilles Peskine8814fc42020-12-14 15:33:44 +01007254/* Wrapper function allowing the classic API to use the PSA RNG.
Gilles Peskine9c3e0602021-01-05 16:03:55 +01007255 *
7256 * `mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE, ...)` calls
7257 * `psa_generate_random(...)`. The state parameter is ignored since the
7258 * PSA API doesn't support passing an explicit state.
7259 *
7260 * In the non-external case, psa_generate_random() calls an
7261 * `mbedtls_xxx_drbg_random` function which has exactly the same signature
7262 * and semantics as mbedtls_psa_get_random(). As an optimization,
7263 * instead of doing this back-and-forth between the PSA API and the
7264 * classic API, psa_crypto_random_impl.h defines `mbedtls_psa_get_random`
7265 * as a constant function pointer to `mbedtls_xxx_drbg_random`.
Gilles Peskine8814fc42020-12-14 15:33:44 +01007266 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007267#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
7268int mbedtls_psa_get_random(void *p_rng,
7269 unsigned char *output,
7270 size_t output_size)
Gilles Peskine8814fc42020-12-14 15:33:44 +01007271{
Gilles Peskine9c3e0602021-01-05 16:03:55 +01007272 /* This function takes a pointer to the RNG state because that's what
7273 * classic mbedtls functions using an RNG expect. The PSA RNG manages
7274 * its own state internally and doesn't let the caller access that state.
7275 * So we just ignore the state parameter, and in practice we'll pass
7276 * NULL. */
Gilles Peskine8814fc42020-12-14 15:33:44 +01007277 (void) p_rng;
Gilles Peskine449bd832023-01-11 14:50:10 +01007278 psa_status_t status = psa_generate_random(output, output_size);
7279 if (status == PSA_SUCCESS) {
7280 return 0;
7281 } else {
7282 return MBEDTLS_ERR_ENTROPY_SOURCE_FAILED;
7283 }
Gilles Peskine8814fc42020-12-14 15:33:44 +01007284}
7285#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
7286
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01007287#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
Gilles Peskine449bd832023-01-11 14:50:10 +01007288psa_status_t mbedtls_psa_inject_entropy(const uint8_t *seed,
7289 size_t seed_size)
Netanel Gonen2bcd3122018-11-19 11:53:02 +02007290{
Gilles Peskine449bd832023-01-11 14:50:10 +01007291 if (global_data.initialized) {
7292 return PSA_ERROR_NOT_PERMITTED;
7293 }
Netanel Gonen21f37cb2018-11-19 11:53:55 +02007294
Gilles Peskine449bd832023-01-11 14:50:10 +01007295 if (((seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM) ||
7296 (seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE)) ||
7297 (seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE)) {
7298 return PSA_ERROR_INVALID_ARGUMENT;
7299 }
Netanel Gonen21f37cb2018-11-19 11:53:55 +02007300
Gilles Peskine449bd832023-01-11 14:50:10 +01007301 return mbedtls_psa_storage_inject_entropy(seed, seed_size);
Netanel Gonen2bcd3122018-11-19 11:53:02 +02007302}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01007303#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02007304
Ronald Cron3772afe2021-02-08 16:10:05 +01007305/** Validate the key type and size for key generation
Ronald Cron01b2aba2020-10-05 09:42:02 +02007306 *
Ronald Cron3772afe2021-02-08 16:10:05 +01007307 * \param type The key type
7308 * \param bits The number of bits of the key
Ronald Cron01b2aba2020-10-05 09:42:02 +02007309 *
7310 * \retval #PSA_SUCCESS
Ronald Cron3772afe2021-02-08 16:10:05 +01007311 * The key type and size are valid.
Ronald Cron01b2aba2020-10-05 09:42:02 +02007312 * \retval #PSA_ERROR_INVALID_ARGUMENT
7313 * The size in bits of the key is not valid.
7314 * \retval #PSA_ERROR_NOT_SUPPORTED
7315 * The type and/or the size in bits of the key or the combination of
7316 * the two is not supported.
7317 */
Ronald Cron3772afe2021-02-08 16:10:05 +01007318static psa_status_t psa_validate_key_type_and_size_for_key_generation(
Gilles Peskine449bd832023-01-11 14:50:10 +01007319 psa_key_type_t type, size_t bits)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007320{
Ronald Cronf3bb7612020-10-02 20:11:59 +02007321 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007322
Gilles Peskine449bd832023-01-11 14:50:10 +01007323 if (key_type_is_raw_bytes(type)) {
7324 status = psa_validate_unstructured_key_bit_size(type, bits);
7325 if (status != PSA_SUCCESS) {
7326 return status;
7327 }
7328 } else
Valerio Settif6d4dfb2023-07-10 10:55:12 +02007329#if defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007330 if (PSA_KEY_TYPE_IS_RSA(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
7331 if (bits > PSA_VENDOR_RSA_MAX_KEY_BITS) {
7332 return PSA_ERROR_NOT_SUPPORTED;
7333 }
Waleed Elmelegyd7bdbbe2023-07-20 16:26:58 +00007334 if (bits < PSA_VENDOR_RSA_GENERATE_MIN_KEY_BITS) {
Waleed Elmelegyab570712023-07-05 16:40:58 +00007335 return PSA_ERROR_NOT_SUPPORTED;
7336 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +02007337
Ronald Cron01b2aba2020-10-05 09:42:02 +02007338 /* Accept only byte-aligned keys, for the same reasons as
7339 * in psa_import_rsa_key(). */
Gilles Peskine449bd832023-01-11 14:50:10 +01007340 if (bits % 8 != 0) {
7341 return PSA_ERROR_NOT_SUPPORTED;
7342 }
7343 } else
Valerio Settif6d4dfb2023-07-10 10:55:12 +02007344#endif /* defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02007345
Valerio Setti6a9d0ee2023-06-21 10:07:21 +02007346#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007347 if (PSA_KEY_TYPE_IS_ECC(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
Ronald Crond81ab562021-02-16 09:01:16 +01007348 /* To avoid empty block, return successfully here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007349 return PSA_SUCCESS;
7350 } else
Valerio Setti6a9d0ee2023-06-21 10:07:21 +02007351#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_GENERATE) */
Przemek Stekielfedd1342022-12-01 15:00:02 +01007352
Valerio Settia55f0422023-07-10 15:34:41 +02007353#if defined(PSA_WANT_KEY_TYPE_DH_KEY_PAIR_GENERATE)
Przemek Stekielfedd1342022-12-01 15:00:02 +01007354 if (PSA_KEY_TYPE_IS_DH(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
Przemek Stekield1cf1ba2023-04-27 12:04:21 +02007355 if (psa_is_dh_key_size_valid(bits) == 0) {
Przemek Stekielfedd1342022-12-01 15:00:02 +01007356 return PSA_ERROR_NOT_SUPPORTED;
7357 }
7358 } else
Valerio Settia55f0422023-07-10 15:34:41 +02007359#endif /* defined(PSA_WANT_KEY_TYPE_DH_KEY_PAIR_GENERATE) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02007360 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007361 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007362 }
7363
Gilles Peskine449bd832023-01-11 14:50:10 +01007364 return PSA_SUCCESS;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007365}
7366
Ronald Cron55ed0592020-10-05 10:30:40 +02007367psa_status_t psa_generate_key_internal(
Ronald Cron2a38a6b2020-10-02 20:02:04 +02007368 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01007369 uint8_t *key_buffer, size_t key_buffer_size, size_t *key_buffer_length)
Ronald Cron01b2aba2020-10-05 09:42:02 +02007370{
7371 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2a38a6b2020-10-02 20:02:04 +02007372 psa_key_type_t type = attributes->core.type;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007373
Gilles Peskine449bd832023-01-11 14:50:10 +01007374 if ((attributes->domain_parameters == NULL) &&
7375 (attributes->domain_parameters_size != 0)) {
7376 return PSA_ERROR_INVALID_ARGUMENT;
7377 }
Ronald Cron01b2aba2020-10-05 09:42:02 +02007378
Gilles Peskine449bd832023-01-11 14:50:10 +01007379 if (key_type_is_raw_bytes(type)) {
7380 status = psa_generate_random(key_buffer, key_buffer_size);
7381 if (status != PSA_SUCCESS) {
7382 return status;
7383 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +02007384
David Brown12ca5032021-02-11 11:02:00 -07007385#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01007386 if (type == PSA_KEY_TYPE_DES) {
7387 psa_des_set_key_parity(key_buffer, key_buffer_size);
7388 }
David Brown8107e312021-02-12 08:08:46 -07007389#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine449bd832023-01-11 14:50:10 +01007390 } else
Gilles Peskinee59236f2018-01-27 23:32:46 +01007391
Valerio Setti76df8c12023-07-11 14:11:28 +02007392#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007393 if (type == PSA_KEY_TYPE_RSA_KEY_PAIR) {
7394 return mbedtls_psa_rsa_generate_key(attributes,
7395 key_buffer,
7396 key_buffer_size,
7397 key_buffer_length);
7398 } else
Valerio Setti76df8c12023-07-11 14:11:28 +02007399#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_GENERATE) */
Gilles Peskinee59236f2018-01-27 23:32:46 +01007400
Valerio Settibfeaf5b2023-06-20 13:27:46 +02007401#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007402 if (PSA_KEY_TYPE_IS_ECC(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
7403 return mbedtls_psa_ecp_generate_key(attributes,
7404 key_buffer,
7405 key_buffer_size,
7406 key_buffer_length);
7407 } else
Valerio Settibfeaf5b2023-06-20 13:27:46 +02007408#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_GENERATE) */
Przemek Stekielfedd1342022-12-01 15:00:02 +01007409
Valerio Settia55f0422023-07-10 15:34:41 +02007410#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_GENERATE)
Przemek Stekielfedd1342022-12-01 15:00:02 +01007411 if (PSA_KEY_TYPE_IS_DH(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
7412 return mbedtls_psa_ffdh_generate_key(attributes,
7413 key_buffer,
7414 key_buffer_size,
7415 key_buffer_length);
7416 } else
Valerio Settia55f0422023-07-10 15:34:41 +02007417#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_GENERATE) */
Steven Cooreman29149862020-08-05 15:43:42 +02007418 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007419 (void) key_buffer_length;
7420 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman29149862020-08-05 15:43:42 +02007421 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01007422
Gilles Peskine449bd832023-01-11 14:50:10 +01007423 return PSA_SUCCESS;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02007424}
Darryl Green0c6575a2018-11-07 16:05:30 +00007425
Gilles Peskine449bd832023-01-11 14:50:10 +01007426psa_status_t psa_generate_key(const psa_key_attributes_t *attributes,
7427 mbedtls_svc_key_id_t *key)
Gilles Peskineff5f0e72019-04-18 12:53:30 +02007428{
7429 psa_status_t status;
7430 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02007431 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cron2b56bc82020-10-05 10:02:26 +02007432 size_t key_buffer_size;
Gilles Peskine11792082019-08-06 18:36:36 +02007433
Ronald Cron81709fc2020-11-14 12:10:32 +01007434 *key = MBEDTLS_SVC_KEY_ID_INIT;
7435
Gilles Peskine0f84d622019-09-12 19:03:13 +02007436 /* Reject any attempt to create a zero-length key so that we don't
7437 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007438 if (psa_get_key_bits(attributes) == 0) {
7439 return PSA_ERROR_INVALID_ARGUMENT;
7440 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02007441
Przemyslaw Stekielc0fe8202021-10-07 11:08:56 +02007442 /* Reject any attempt to create a public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007443 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(attributes->core.type)) {
7444 return PSA_ERROR_INVALID_ARGUMENT;
7445 }
Przemyslaw Stekielc0fe8202021-10-07 11:08:56 +02007446
Gilles Peskine449bd832023-01-11 14:50:10 +01007447 status = psa_start_key_creation(PSA_KEY_CREATION_GENERATE, attributes,
7448 &slot, &driver);
7449 if (status != PSA_SUCCESS) {
Gilles Peskine11792082019-08-06 18:36:36 +02007450 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007451 }
Gilles Peskine11792082019-08-06 18:36:36 +02007452
Ronald Cron977c2472020-10-13 08:32:21 +02007453 /* In the case of a transparent key or an opaque key stored in local
Archana449608b2021-09-08 15:36:05 +05307454 * storage ( thus not in the case of generating a key in a secure element
7455 * with storage ( MBEDTLS_PSA_CRYPTO_SE_C ) ),we have to allocate a
7456 * buffer to hold the generated key material. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007457 if (slot->key.data == NULL) {
7458 if (PSA_KEY_LIFETIME_GET_LOCATION(attributes->core.lifetime) ==
7459 PSA_KEY_LOCATION_LOCAL_STORAGE) {
Ronald Cron3772afe2021-02-08 16:10:05 +01007460 status = psa_validate_key_type_and_size_for_key_generation(
Gilles Peskine449bd832023-01-11 14:50:10 +01007461 attributes->core.type, attributes->core.bits);
7462 if (status != PSA_SUCCESS) {
Ronald Cron3772afe2021-02-08 16:10:05 +01007463 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007464 }
Ronald Cron3772afe2021-02-08 16:10:05 +01007465
7466 key_buffer_size = PSA_EXPORT_KEY_OUTPUT_SIZE(
Gilles Peskine449bd832023-01-11 14:50:10 +01007467 attributes->core.type,
7468 attributes->core.bits);
7469 } else {
Ronald Cron977c2472020-10-13 08:32:21 +02007470 status = psa_driver_wrapper_get_key_buffer_size(
Gilles Peskine449bd832023-01-11 14:50:10 +01007471 attributes, &key_buffer_size);
7472 if (status != PSA_SUCCESS) {
Ronald Cron3772afe2021-02-08 16:10:05 +01007473 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007474 }
Ronald Cron977c2472020-10-13 08:32:21 +02007475 }
Ronald Cron977c2472020-10-13 08:32:21 +02007476
Gilles Peskine449bd832023-01-11 14:50:10 +01007477 status = psa_allocate_buffer_to_slot(slot, key_buffer_size);
7478 if (status != PSA_SUCCESS) {
Ronald Cron977c2472020-10-13 08:32:21 +02007479 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007480 }
Ronald Cron977c2472020-10-13 08:32:21 +02007481 }
7482
Gilles Peskine449bd832023-01-11 14:50:10 +01007483 status = psa_driver_wrapper_generate_key(attributes,
7484 slot->key.data, slot->key.bytes, &slot->key.bytes);
Gilles Peskine11792082019-08-06 18:36:36 +02007485
Gilles Peskine449bd832023-01-11 14:50:10 +01007486 if (status != PSA_SUCCESS) {
7487 psa_remove_key_data_from_memory(slot);
7488 }
Ronald Cron2b56bc82020-10-05 10:02:26 +02007489
Gilles Peskine11792082019-08-06 18:36:36 +02007490exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007491 if (status == PSA_SUCCESS) {
7492 status = psa_finish_key_creation(slot, driver, key);
7493 }
7494 if (status != PSA_SUCCESS) {
7495 psa_fail_key_creation(slot, driver);
7496 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007497
Gilles Peskine449bd832023-01-11 14:50:10 +01007498 return status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007499}
7500
Gilles Peskinee59236f2018-01-27 23:32:46 +01007501/****************************************************************/
7502/* Module setup */
7503/****************************************************************/
7504
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007505#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine5e769522018-11-20 21:59:56 +01007506psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
Gilles Peskine449bd832023-01-11 14:50:10 +01007507 void (* entropy_init)(mbedtls_entropy_context *ctx),
7508 void (* entropy_free)(mbedtls_entropy_context *ctx))
Gilles Peskine5e769522018-11-20 21:59:56 +01007509{
Gilles Peskine449bd832023-01-11 14:50:10 +01007510 if (global_data.rng_state != RNG_NOT_INITIALIZED) {
7511 return PSA_ERROR_BAD_STATE;
7512 }
Gilles Peskine30524eb2020-11-13 17:02:26 +01007513 global_data.rng.entropy_init = entropy_init;
7514 global_data.rng.entropy_free = entropy_free;
Gilles Peskine449bd832023-01-11 14:50:10 +01007515 return PSA_SUCCESS;
Gilles Peskine5e769522018-11-20 21:59:56 +01007516}
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007517#endif /* !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) */
Gilles Peskine5e769522018-11-20 21:59:56 +01007518
Gilles Peskine449bd832023-01-11 14:50:10 +01007519void mbedtls_psa_crypto_free(void)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007520{
Gilles Peskine449bd832023-01-11 14:50:10 +01007521 psa_wipe_all_key_slots();
Valerio Setti83e0de82023-11-24 12:13:05 +01007522 if (global_data.rng_state != RNG_NOT_INITIALIZED) {
7523 mbedtls_psa_random_free(&global_data.rng);
7524 }
Gilles Peskinec6b69072018-11-20 21:42:52 +01007525 /* Wipe all remaining data, including configuration.
7526 * In particular, this sets all state indicator to the value
7527 * indicating "uninitialized". */
Gilles Peskine449bd832023-01-11 14:50:10 +01007528 mbedtls_platform_zeroize(&global_data, sizeof(global_data));
Ronald Cron9ba76912021-04-10 16:57:30 +02007529
7530 /* Terminate drivers */
Gilles Peskine449bd832023-01-11 14:50:10 +01007531 psa_driver_wrapper_free();
Gilles Peskinee59236f2018-01-27 23:32:46 +01007532}
7533
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007534#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
7535/** Recover a transaction that was interrupted by a power failure.
7536 *
7537 * This function is called during initialization, before psa_crypto_init()
7538 * returns. If this function returns a failure status, the initialization
7539 * fails.
7540 */
7541static psa_status_t psa_crypto_recover_transaction(
Gilles Peskine449bd832023-01-11 14:50:10 +01007542 const psa_crypto_transaction_t *transaction)
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007543{
Gilles Peskine449bd832023-01-11 14:50:10 +01007544 switch (transaction->unknown.type) {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007545 case PSA_CRYPTO_TRANSACTION_CREATE_KEY:
7546 case PSA_CRYPTO_TRANSACTION_DESTROY_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01007547 /* TODO - fall through to the failure case until this
7548 * is implemented.
7549 * https://github.com/ARMmbed/mbed-crypto/issues/218
7550 */
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007551 default:
7552 /* We found an unsupported transaction in the storage.
7553 * We don't know what state the storage is in. Give up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007554 return PSA_ERROR_DATA_INVALID;
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007555 }
7556}
7557#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
7558
Gilles Peskine449bd832023-01-11 14:50:10 +01007559psa_status_t psa_crypto_init(void)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007560{
Gilles Peskine66fb1262018-12-10 16:29:04 +01007561 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007562
Gilles Peskinec6b69072018-11-20 21:42:52 +01007563 /* Double initialization is explicitly allowed. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007564 if (global_data.initialized != 0) {
7565 return PSA_SUCCESS;
7566 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01007567
Manuel Pégourié-Gonnard7abdf7e2023-03-09 11:17:43 +01007568 /* Init drivers */
7569 status = psa_driver_wrapper_init();
7570 if (status != PSA_SUCCESS) {
7571 goto exit;
7572 }
7573 global_data.drivers_initialized = 1;
7574
Valerio Setti402cfba2023-11-13 10:24:32 +01007575 status = psa_initialize_key_slots();
7576 if (status != PSA_SUCCESS) {
7577 goto exit;
7578 }
7579
Gilles Peskine30524eb2020-11-13 17:02:26 +01007580 /* Initialize and seed the random generator. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007581 mbedtls_psa_random_init(&global_data.rng);
Gilles Peskinec6b69072018-11-20 21:42:52 +01007582 global_data.rng_state = RNG_INITIALIZED;
Gilles Peskine449bd832023-01-11 14:50:10 +01007583 status = mbedtls_psa_random_seed(&global_data.rng);
7584 if (status != PSA_SUCCESS) {
Gilles Peskinee59236f2018-01-27 23:32:46 +01007585 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007586 }
Gilles Peskinec6b69072018-11-20 21:42:52 +01007587 global_data.rng_state = RNG_SEEDED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007588
Gilles Peskine4b734222019-07-24 15:56:31 +02007589#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007590 status = psa_crypto_load_transaction();
7591 if (status == PSA_SUCCESS) {
7592 status = psa_crypto_recover_transaction(&psa_crypto_transaction);
7593 if (status != PSA_SUCCESS) {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007594 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007595 }
7596 status = psa_crypto_stop_transaction();
7597 } else if (status == PSA_ERROR_DOES_NOT_EXIST) {
Gilles Peskinefc762652019-07-22 19:30:34 +02007598 /* There's no transaction to complete. It's all good. */
7599 status = PSA_SUCCESS;
7600 }
Gilles Peskine4b734222019-07-24 15:56:31 +02007601#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
Gilles Peskinefc762652019-07-22 19:30:34 +02007602
Gilles Peskinec6b69072018-11-20 21:42:52 +01007603 /* All done. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01007604 global_data.initialized = 1;
7605
7606exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007607 if (status != PSA_SUCCESS) {
7608 mbedtls_psa_crypto_free();
7609 }
7610 return status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007611}
7612
Yanray Wangffc3c482023-07-11 12:01:04 +08007613#if defined(PSA_WANT_ALG_SOME_PAKE)
Przemek Stekielca8d2b22023-01-17 16:21:33 +01007614psa_status_t psa_crypto_driver_pake_get_password_len(
7615 const psa_crypto_driver_pake_inputs_t *inputs,
7616 size_t *password_len)
7617{
7618 if (inputs->password_len == 0) {
7619 return PSA_ERROR_BAD_STATE;
7620 }
7621
7622 *password_len = inputs->password_len;
7623
7624 return PSA_SUCCESS;
7625}
7626
7627psa_status_t psa_crypto_driver_pake_get_password(
7628 const psa_crypto_driver_pake_inputs_t *inputs,
7629 uint8_t *buffer, size_t buffer_size, size_t *buffer_length)
7630{
7631 if (inputs->password_len == 0) {
7632 return PSA_ERROR_BAD_STATE;
7633 }
7634
7635 if (buffer_size < inputs->password_len) {
7636 return PSA_ERROR_BUFFER_TOO_SMALL;
7637 }
7638
7639 memcpy(buffer, inputs->password, inputs->password_len);
7640 *buffer_length = inputs->password_len;
7641
7642 return PSA_SUCCESS;
7643}
7644
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007645psa_status_t psa_crypto_driver_pake_get_user_len(
7646 const psa_crypto_driver_pake_inputs_t *inputs,
7647 size_t *user_len)
7648{
7649 if (inputs->user_len == 0) {
7650 return PSA_ERROR_BAD_STATE;
7651 }
7652
7653 *user_len = inputs->user_len;
7654
7655 return PSA_SUCCESS;
7656}
7657
7658psa_status_t psa_crypto_driver_pake_get_user(
7659 const psa_crypto_driver_pake_inputs_t *inputs,
Przemek Stekielc0e62502023-03-14 11:49:36 +01007660 uint8_t *user_id, size_t user_id_size, size_t *user_id_len)
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007661{
7662 if (inputs->user_len == 0) {
7663 return PSA_ERROR_BAD_STATE;
7664 }
7665
Przemek Stekielc0e62502023-03-14 11:49:36 +01007666 if (user_id_size < inputs->user_len) {
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007667 return PSA_ERROR_BUFFER_TOO_SMALL;
7668 }
7669
Przemek Stekielc0e62502023-03-14 11:49:36 +01007670 memcpy(user_id, inputs->user, inputs->user_len);
7671 *user_id_len = inputs->user_len;
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007672
7673 return PSA_SUCCESS;
7674}
7675
7676psa_status_t psa_crypto_driver_pake_get_peer_len(
7677 const psa_crypto_driver_pake_inputs_t *inputs,
7678 size_t *peer_len)
7679{
7680 if (inputs->peer_len == 0) {
7681 return PSA_ERROR_BAD_STATE;
7682 }
7683
7684 *peer_len = inputs->peer_len;
7685
7686 return PSA_SUCCESS;
7687}
7688
7689psa_status_t psa_crypto_driver_pake_get_peer(
7690 const psa_crypto_driver_pake_inputs_t *inputs,
Przemek Stekielc0e62502023-03-14 11:49:36 +01007691 uint8_t *peer_id, size_t peer_id_size, size_t *peer_id_length)
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007692{
7693 if (inputs->peer_len == 0) {
7694 return PSA_ERROR_BAD_STATE;
7695 }
7696
Przemek Stekielc0e62502023-03-14 11:49:36 +01007697 if (peer_id_size < inputs->peer_len) {
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007698 return PSA_ERROR_BUFFER_TOO_SMALL;
7699 }
7700
Przemek Stekielc0e62502023-03-14 11:49:36 +01007701 memcpy(peer_id, inputs->peer, inputs->peer_len);
7702 *peer_id_length = inputs->peer_len;
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007703
7704 return PSA_SUCCESS;
7705}
7706
Przemek Stekielca8d2b22023-01-17 16:21:33 +01007707psa_status_t psa_crypto_driver_pake_get_cipher_suite(
7708 const psa_crypto_driver_pake_inputs_t *inputs,
7709 psa_pake_cipher_suite_t *cipher_suite)
7710{
7711 if (inputs->cipher_suite.algorithm == PSA_ALG_NONE) {
7712 return PSA_ERROR_BAD_STATE;
7713 }
7714
7715 *cipher_suite = inputs->cipher_suite;
7716
7717 return PSA_SUCCESS;
7718}
7719
Neil Armstronga7d08c32022-06-01 18:21:20 +02007720psa_status_t psa_pake_setup(
7721 psa_pake_operation_t *operation,
7722 const psa_pake_cipher_suite_t *cipher_suite)
7723{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007724 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007725
Przemek Stekiel1c3cfb42023-01-26 10:35:02 +01007726 if (operation->stage != PSA_PAKE_OPERATION_STAGE_SETUP) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007727 status = PSA_ERROR_BAD_STATE;
7728 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007729 }
7730
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01007731 if (PSA_ALG_IS_PAKE(cipher_suite->algorithm) == 0 ||
Przemek Stekiel51eac532022-12-07 11:04:51 +01007732 PSA_ALG_IS_HASH(cipher_suite->hash) == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007733 status = PSA_ERROR_INVALID_ARGUMENT;
7734 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007735 }
7736
Przemek Stekiel51eac532022-12-07 11:04:51 +01007737 memset(&operation->data.inputs, 0, sizeof(operation->data.inputs));
7738
Przemek Stekiele12ed362022-12-21 12:54:46 +01007739 operation->alg = cipher_suite->algorithm;
Przemek Stekiel656b2592023-03-22 13:15:33 +01007740 operation->primitive = PSA_PAKE_PRIMITIVE(cipher_suite->type,
7741 cipher_suite->family, cipher_suite->bits);
Przemek Stekiel51eac532022-12-07 11:04:51 +01007742 operation->data.inputs.cipher_suite = *cipher_suite;
7743
Przemek Stekiel4aa99402023-02-27 13:00:57 +01007744#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01007745 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01007746 psa_jpake_computation_stage_t *computation_stage =
Przemek Stekieldde6a912023-01-26 08:46:37 +01007747 &operation->computation_stage.jpake;
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01007748
David Horstmann16f01512023-06-14 17:21:07 +01007749 memset(computation_stage, 0, sizeof(*computation_stage));
David Horstmanne7f21e62023-05-12 18:17:21 +01007750 computation_stage->step = PSA_PAKE_STEP_KEY_SHARE;
Przemek Stekiel80a88492023-02-20 13:32:22 +01007751 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007752#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01007753 {
7754 status = PSA_ERROR_NOT_SUPPORTED;
7755 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01007756 }
7757
Przemek Stekiel1c3cfb42023-01-26 10:35:02 +01007758 operation->stage = PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS;
7759
Przemek Stekiel51eac532022-12-07 11:04:51 +01007760 return PSA_SUCCESS;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007761exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007762 psa_pake_abort(operation);
7763 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02007764}
7765
7766psa_status_t psa_pake_set_password_key(
7767 psa_pake_operation_t *operation,
7768 mbedtls_svc_key_id_t password)
7769{
Neil Armstrong5ae60962022-09-15 11:29:46 +02007770 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel6c764412022-11-22 14:05:12 +01007771 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
7772 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007773 psa_key_attributes_t attributes;
7774 psa_key_type_t type;
Neil Armstrong5ae60962022-09-15 11:29:46 +02007775
Przemek Stekiel51eac532022-12-07 11:04:51 +01007776 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007777 status = PSA_ERROR_BAD_STATE;
7778 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007779 }
7780
Przemek Stekiel6c764412022-11-22 14:05:12 +01007781 status = psa_get_and_lock_key_slot_with_policy(password, &slot,
7782 PSA_KEY_USAGE_DERIVE,
Przemek Stekield5d28a22023-01-26 10:46:05 +01007783 operation->alg);
Neil Armstrong5ae60962022-09-15 11:29:46 +02007784 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007785 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02007786 }
7787
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007788 attributes = (psa_key_attributes_t) {
Przemek Stekiel6c764412022-11-22 14:05:12 +01007789 .core = slot->attr
7790 };
Neil Armstrong5ae60962022-09-15 11:29:46 +02007791
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007792 type = psa_get_key_type(&attributes);
Neil Armstrong5ae60962022-09-15 11:29:46 +02007793
Przemek Stekiel51eac532022-12-07 11:04:51 +01007794 if (type != PSA_KEY_TYPE_PASSWORD &&
7795 type != PSA_KEY_TYPE_PASSWORD_HASH) {
7796 status = PSA_ERROR_INVALID_ARGUMENT;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007797 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007798 }
7799
Przemek Stekiel51eac532022-12-07 11:04:51 +01007800 operation->data.inputs.password = mbedtls_calloc(1, slot->key.bytes);
7801 if (operation->data.inputs.password == NULL) {
Przemek Stekiele12ed362022-12-21 12:54:46 +01007802 status = PSA_ERROR_INSUFFICIENT_MEMORY;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007803 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007804 }
7805
7806 memcpy(operation->data.inputs.password, slot->key.data, slot->key.bytes);
7807 operation->data.inputs.password_len = slot->key.bytes;
Przemek Stekiel9dd24402023-01-26 15:06:09 +01007808 operation->data.inputs.attributes = attributes;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007809exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007810 if (status != PSA_SUCCESS) {
7811 psa_pake_abort(operation);
7812 }
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007813 unlock_status = psa_unlock_key_slot(slot);
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007814 return (status == PSA_SUCCESS) ? unlock_status : status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02007815}
7816
7817psa_status_t psa_pake_set_user(
7818 psa_pake_operation_t *operation,
7819 const uint8_t *user_id,
7820 size_t user_id_len)
7821{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007822 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007823
7824 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007825 status = PSA_ERROR_BAD_STATE;
7826 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02007827 }
7828
Przemek Stekiel51eac532022-12-07 11:04:51 +01007829 if (user_id_len == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007830 status = PSA_ERROR_INVALID_ARGUMENT;
7831 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02007832 }
7833
Przemek Stekielf309d6b2023-03-10 09:54:45 +01007834 if (operation->data.inputs.user_len != 0) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007835 status = PSA_ERROR_BAD_STATE;
7836 goto exit;
7837 }
7838
Przemek Stekielf309d6b2023-03-10 09:54:45 +01007839 operation->data.inputs.user = mbedtls_calloc(1, user_id_len);
7840 if (operation->data.inputs.user == NULL) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007841 status = PSA_ERROR_INSUFFICIENT_MEMORY;
7842 goto exit;
7843 }
7844
Przemek Stekielf309d6b2023-03-10 09:54:45 +01007845 memcpy(operation->data.inputs.user, user_id, user_id_len);
7846 operation->data.inputs.user_len = user_id_len;
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007847
7848 return PSA_SUCCESS;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007849exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007850 psa_pake_abort(operation);
7851 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02007852}
7853
7854psa_status_t psa_pake_set_peer(
7855 psa_pake_operation_t *operation,
7856 const uint8_t *peer_id,
7857 size_t peer_id_len)
7858{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007859 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007860
7861 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007862 status = PSA_ERROR_BAD_STATE;
7863 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02007864 }
7865
Przemek Stekiel51eac532022-12-07 11:04:51 +01007866 if (peer_id_len == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007867 status = PSA_ERROR_INVALID_ARGUMENT;
7868 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02007869 }
7870
Przemek Stekielf309d6b2023-03-10 09:54:45 +01007871 if (operation->data.inputs.peer_len != 0) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007872 status = PSA_ERROR_BAD_STATE;
7873 goto exit;
7874 }
7875
Przemek Stekielf309d6b2023-03-10 09:54:45 +01007876 operation->data.inputs.peer = mbedtls_calloc(1, peer_id_len);
7877 if (operation->data.inputs.peer == NULL) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007878 status = PSA_ERROR_INSUFFICIENT_MEMORY;
7879 goto exit;
7880 }
7881
Przemek Stekielf309d6b2023-03-10 09:54:45 +01007882 memcpy(operation->data.inputs.peer, peer_id, peer_id_len);
7883 operation->data.inputs.peer_len = peer_id_len;
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007884
7885 return PSA_SUCCESS;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007886exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007887 psa_pake_abort(operation);
7888 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02007889}
7890
7891psa_status_t psa_pake_set_role(
7892 psa_pake_operation_t *operation,
7893 psa_pake_role_t role)
7894{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007895 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007896
Przemek Stekiel51eac532022-12-07 11:04:51 +01007897 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007898 status = PSA_ERROR_BAD_STATE;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007899 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007900 }
7901
Przemek Stekiel09104b82023-03-06 14:11:51 +01007902 switch (operation->alg) {
7903#if defined(PSA_WANT_ALG_JPAKE)
7904 case PSA_ALG_JPAKE:
7905 if (role == PSA_PAKE_ROLE_NONE) {
7906 return PSA_SUCCESS;
7907 }
7908 status = PSA_ERROR_INVALID_ARGUMENT;
7909 break;
7910#endif
7911 default:
7912 (void) role;
7913 status = PSA_ERROR_NOT_SUPPORTED;
7914 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02007915 }
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007916exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007917 psa_pake_abort(operation);
7918 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02007919}
7920
David Horstmanne7f21e62023-05-12 18:17:21 +01007921/* Auxiliary function to convert core computation stage to single driver step. */
Przemek Stekiel4aa99402023-02-27 13:00:57 +01007922#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiel251e86a2023-02-17 14:30:50 +01007923static psa_crypto_driver_pake_step_t convert_jpake_computation_stage_to_driver_step(
Przemek Stekieldde6a912023-01-26 08:46:37 +01007924 psa_jpake_computation_stage_t *stage)
Przemek Stekielb09c4872023-01-17 12:05:38 +01007925{
David Horstmann74a3d8c2023-06-14 18:28:19 +01007926 psa_crypto_driver_pake_step_t key_share_step;
David Horstmann5da95602023-06-08 15:37:12 +01007927 if (stage->round == PSA_JPAKE_FIRST) {
David Horstmanne7f21e62023-05-12 18:17:21 +01007928 int is_x1;
David Horstmann74a3d8c2023-06-14 18:28:19 +01007929
David Horstmann024e5c52023-06-14 15:48:21 +01007930 if (stage->io_mode == PSA_JPAKE_OUTPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01007931 is_x1 = (stage->outputs < 1);
7932 } else {
7933 is_x1 = (stage->inputs < 1);
7934 }
7935
David Horstmann74a3d8c2023-06-14 18:28:19 +01007936 key_share_step = is_x1 ?
7937 PSA_JPAKE_X1_STEP_KEY_SHARE :
7938 PSA_JPAKE_X2_STEP_KEY_SHARE;
David Horstmann5da95602023-06-08 15:37:12 +01007939 } else if (stage->round == PSA_JPAKE_SECOND) {
David Horstmann74a3d8c2023-06-14 18:28:19 +01007940 key_share_step = (stage->io_mode == PSA_JPAKE_OUTPUT) ?
7941 PSA_JPAKE_X2S_STEP_KEY_SHARE :
7942 PSA_JPAKE_X4S_STEP_KEY_SHARE;
7943 } else {
7944 return PSA_JPAKE_STEP_INVALID;
Przemek Stekielb09c4872023-01-17 12:05:38 +01007945 }
Agathiyan Bragadeesh387bfa52023-07-17 17:01:33 +01007946 return (psa_crypto_driver_pake_step_t) (key_share_step + stage->step - PSA_PAKE_STEP_KEY_SHARE);
Przemek Stekielb09c4872023-01-17 12:05:38 +01007947}
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007948#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekielb09c4872023-01-17 12:05:38 +01007949
Przemek Stekiel2797d372022-12-22 11:19:22 +01007950static psa_status_t psa_pake_complete_inputs(
7951 psa_pake_operation_t *operation)
7952{
Przemek Stekiel2797d372022-12-22 11:19:22 +01007953 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel18620a32023-01-17 16:34:52 +01007954 /* Create copy of the inputs on stack as inputs share memory
7955 with the driver context which will be setup by the driver. */
7956 psa_crypto_driver_pake_inputs_t inputs = operation->data.inputs;
Przemek Stekiel2797d372022-12-22 11:19:22 +01007957
Przemek Stekielfde11282023-03-13 16:06:09 +01007958 if (inputs.password_len == 0) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01007959 return PSA_ERROR_BAD_STATE;
7960 }
7961
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007962 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekielfde11282023-03-13 16:06:09 +01007963 if (inputs.user_len == 0 || inputs.peer_len == 0) {
7964 return PSA_ERROR_BAD_STATE;
7965 }
Przemek Stekieldff21d32023-02-14 20:09:10 +01007966 }
7967
Przemek Stekiel18620a32023-01-17 16:34:52 +01007968 /* Clear driver context */
7969 mbedtls_platform_zeroize(&operation->data, sizeof(operation->data));
7970
7971 status = psa_driver_wrapper_pake_setup(operation, &inputs);
Przemek Stekiel2797d372022-12-22 11:19:22 +01007972
7973 /* Driver is responsible for creating its own copy of the password. */
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01007974 mbedtls_zeroize_and_free(inputs.password, inputs.password_len);
Przemek Stekiel2797d372022-12-22 11:19:22 +01007975
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007976 /* User and peer are translated to role. */
7977 mbedtls_free(inputs.user);
7978 mbedtls_free(inputs.peer);
7979
Przemek Stekiel2797d372022-12-22 11:19:22 +01007980 if (status == PSA_SUCCESS) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01007981#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiel2797d372022-12-22 11:19:22 +01007982 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekield93de322023-02-24 08:39:04 +01007983 operation->stage = PSA_PAKE_OPERATION_STAGE_COMPUTATION;
Przemek Stekiel80a88492023-02-20 13:32:22 +01007984 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007985#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01007986 {
7987 status = PSA_ERROR_NOT_SUPPORTED;
Przemek Stekiel2797d372022-12-22 11:19:22 +01007988 }
Przemek Stekiel2797d372022-12-22 11:19:22 +01007989 }
Przemek Stekiel2797d372022-12-22 11:19:22 +01007990 return status;
7991}
7992
Przemek Stekiel4aa99402023-02-27 13:00:57 +01007993#if defined(PSA_WANT_ALG_JPAKE)
David Horstmanne7f21e62023-05-12 18:17:21 +01007994static psa_status_t psa_jpake_prologue(
Przemek Stekiele12ed362022-12-21 12:54:46 +01007995 psa_pake_operation_t *operation,
David Horstmanne7f21e62023-05-12 18:17:21 +01007996 psa_pake_step_t step,
David Horstmann00ad6bf2023-06-14 15:44:24 +01007997 psa_jpake_io_mode_t io_mode)
Przemek Stekiele12ed362022-12-21 12:54:46 +01007998{
Przemek Stekiele12ed362022-12-21 12:54:46 +01007999 if (step != PSA_PAKE_STEP_KEY_SHARE &&
8000 step != PSA_PAKE_STEP_ZK_PUBLIC &&
8001 step != PSA_PAKE_STEP_ZK_PROOF) {
8002 return PSA_ERROR_INVALID_ARGUMENT;
8003 }
8004
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008005 psa_jpake_computation_stage_t *computation_stage =
8006 &operation->computation_stage.jpake;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008007
David Horstmann5da95602023-06-08 15:37:12 +01008008 if (computation_stage->round != PSA_JPAKE_FIRST &&
8009 computation_stage->round != PSA_JPAKE_SECOND) {
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008010 return PSA_ERROR_BAD_STATE;
8011 }
8012
David Horstmanne7f21e62023-05-12 18:17:21 +01008013 /* Check that the step we are given is the one we were expecting */
8014 if (step != computation_stage->step) {
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008015 return PSA_ERROR_BAD_STATE;
8016 }
8017
David Horstmanne7f21e62023-05-12 18:17:21 +01008018 if (step == PSA_PAKE_STEP_KEY_SHARE &&
8019 computation_stage->inputs == 0 &&
8020 computation_stage->outputs == 0) {
8021 /* Start of the round, so function decides whether we are inputting
8022 * or outputting */
David Horstmann024e5c52023-06-14 15:48:21 +01008023 computation_stage->io_mode = io_mode;
8024 } else if (computation_stage->io_mode != io_mode) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008025 /* Middle of the round so the mode we are in must match the function
8026 * called by the user */
8027 return PSA_ERROR_BAD_STATE;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008028 }
8029
8030 return PSA_SUCCESS;
8031}
8032
David Horstmanne7f21e62023-05-12 18:17:21 +01008033static psa_status_t psa_jpake_epilogue(
8034 psa_pake_operation_t *operation,
David Horstmann00ad6bf2023-06-14 15:44:24 +01008035 psa_jpake_io_mode_t io_mode)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008036{
David Horstmanne7f21e62023-05-12 18:17:21 +01008037 psa_jpake_computation_stage_t *stage =
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008038 &operation->computation_stage.jpake;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008039
David Horstmanne7f21e62023-05-12 18:17:21 +01008040 if (stage->step == PSA_PAKE_STEP_ZK_PROOF) {
8041 /* End of an input/output */
David Horstmann00ad6bf2023-06-14 15:44:24 +01008042 if (io_mode == PSA_JPAKE_INPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008043 stage->inputs++;
David Horstmann246ec5a2023-06-27 10:33:06 +01008044 if (stage->inputs == PSA_JPAKE_EXPECTED_INPUTS(stage->round)) {
David Horstmann024e5c52023-06-14 15:48:21 +01008045 stage->io_mode = PSA_JPAKE_OUTPUT;
David Horstmanne7f21e62023-05-12 18:17:21 +01008046 }
8047 }
David Horstmann00ad6bf2023-06-14 15:44:24 +01008048 if (io_mode == PSA_JPAKE_OUTPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008049 stage->outputs++;
David Horstmann246ec5a2023-06-27 10:33:06 +01008050 if (stage->outputs == PSA_JPAKE_EXPECTED_OUTPUTS(stage->round)) {
David Horstmann024e5c52023-06-14 15:48:21 +01008051 stage->io_mode = PSA_JPAKE_INPUT;
David Horstmanne7f21e62023-05-12 18:17:21 +01008052 }
8053 }
David Horstmann246ec5a2023-06-27 10:33:06 +01008054 if (stage->inputs == PSA_JPAKE_EXPECTED_INPUTS(stage->round) &&
8055 stage->outputs == PSA_JPAKE_EXPECTED_OUTPUTS(stage->round)) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008056 /* End of a round, move to the next round */
8057 stage->inputs = 0;
8058 stage->outputs = 0;
8059 stage->round++;
8060 }
8061 stage->step = PSA_PAKE_STEP_KEY_SHARE;
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008062 } else {
David Horstmanne7f21e62023-05-12 18:17:21 +01008063 stage->step++;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008064 }
Przemek Stekiele12ed362022-12-21 12:54:46 +01008065 return PSA_SUCCESS;
8066}
David Horstmanne7f21e62023-05-12 18:17:21 +01008067
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008068#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008069
Neil Armstronga7d08c32022-06-01 18:21:20 +02008070psa_status_t psa_pake_output(
8071 psa_pake_operation_t *operation,
8072 psa_pake_step_t step,
8073 uint8_t *output,
8074 size_t output_size,
8075 size_t *output_length)
8076{
Przemek Stekiel51eac532022-12-07 11:04:51 +01008077 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008078 psa_crypto_driver_pake_step_t driver_step = PSA_JPAKE_STEP_INVALID;
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008079 *output_length = 0;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008080
8081 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01008082 status = psa_pake_complete_inputs(operation);
8083 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008084 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008085 }
8086 }
8087
8088 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008089 status = PSA_ERROR_BAD_STATE;
8090 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008091 }
8092
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008093 if (output_size == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008094 status = PSA_ERROR_INVALID_ARGUMENT;
8095 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008096 }
8097
Przemek Stekiele12ed362022-12-21 12:54:46 +01008098 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008099#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008100 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008101 status = psa_jpake_prologue(operation, step, PSA_JPAKE_OUTPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008102 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008103 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008104 }
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008105 driver_step = convert_jpake_computation_stage_to_driver_step(
8106 &operation->computation_stage.jpake);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008107 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008108#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008109 default:
Przemek Stekiel80a88492023-02-20 13:32:22 +01008110 (void) step;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008111 status = PSA_ERROR_NOT_SUPPORTED;
8112 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008113 }
8114
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008115 status = psa_driver_wrapper_pake_output(operation, driver_step,
8116 output, output_size, output_length);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008117
8118 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008119 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008120 }
8121
8122 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008123#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008124 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008125 status = psa_jpake_epilogue(operation, PSA_JPAKE_OUTPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008126 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008127 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008128 }
8129 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008130#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008131 default:
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008132 status = PSA_ERROR_NOT_SUPPORTED;
8133 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008134 }
8135
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008136 return PSA_SUCCESS;
8137exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008138 psa_pake_abort(operation);
8139 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008140}
8141
8142psa_status_t psa_pake_input(
8143 psa_pake_operation_t *operation,
8144 psa_pake_step_t step,
8145 const uint8_t *input,
8146 size_t input_length)
8147{
Przemek Stekiel51eac532022-12-07 11:04:51 +01008148 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008149 psa_crypto_driver_pake_step_t driver_step = PSA_JPAKE_STEP_INVALID;
Przemek Stekiel256c75d2023-03-23 14:09:34 +01008150 const size_t max_input_length = (size_t) PSA_PAKE_INPUT_SIZE(operation->alg,
8151 operation->primitive,
8152 step);
Przemek Stekiel51eac532022-12-07 11:04:51 +01008153
8154 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01008155 status = psa_pake_complete_inputs(operation);
8156 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008157 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008158 }
8159 }
8160
8161 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008162 status = PSA_ERROR_BAD_STATE;
8163 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008164 }
8165
Przemek Stekiel256c75d2023-03-23 14:09:34 +01008166 if (input_length == 0 || input_length > max_input_length) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008167 status = PSA_ERROR_INVALID_ARGUMENT;
8168 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008169 }
8170
Przemek Stekiele12ed362022-12-21 12:54:46 +01008171 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008172#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008173 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008174 status = psa_jpake_prologue(operation, step, PSA_JPAKE_INPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008175 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008176 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008177 }
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008178 driver_step = convert_jpake_computation_stage_to_driver_step(
8179 &operation->computation_stage.jpake);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008180 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008181#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008182 default:
Przemek Stekiel80a88492023-02-20 13:32:22 +01008183 (void) step;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008184 status = PSA_ERROR_NOT_SUPPORTED;
8185 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008186 }
8187
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008188 status = psa_driver_wrapper_pake_input(operation, driver_step,
8189 input, input_length);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008190
8191 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008192 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008193 }
8194
8195 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008196#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008197 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008198 status = psa_jpake_epilogue(operation, PSA_JPAKE_INPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008199 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008200 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008201 }
8202 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008203#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008204 default:
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008205 status = PSA_ERROR_NOT_SUPPORTED;
8206 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008207 }
8208
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008209 return PSA_SUCCESS;
8210exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008211 psa_pake_abort(operation);
8212 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008213}
8214
8215psa_status_t psa_pake_get_implicit_key(
8216 psa_pake_operation_t *operation,
8217 psa_key_derivation_operation_t *output)
8218{
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008219 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008220 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel251e86a2023-02-17 14:30:50 +01008221 uint8_t shared_key[MBEDTLS_PSA_JPAKE_BUFFER_SIZE];
Przemek Stekiel0c781802022-11-29 14:53:13 +01008222 size_t shared_key_len = 0;
8223
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008224 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008225 status = PSA_ERROR_BAD_STATE;
8226 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008227 }
8228
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008229#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008230 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008231 psa_jpake_computation_stage_t *computation_stage =
Przemek Stekiel083745e2023-02-23 17:28:23 +01008232 &operation->computation_stage.jpake;
David Horstmann5da95602023-06-08 15:37:12 +01008233 if (computation_stage->round != PSA_JPAKE_FINISHED) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008234 status = PSA_ERROR_BAD_STATE;
8235 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008236 }
Przemek Stekiel80a88492023-02-20 13:32:22 +01008237 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008238#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01008239 {
8240 status = PSA_ERROR_NOT_SUPPORTED;
8241 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008242 }
8243
Przemek Stekiel0c781802022-11-29 14:53:13 +01008244 status = psa_driver_wrapper_pake_get_implicit_key(operation,
8245 shared_key,
Przemek Stekiel6b648622023-02-19 22:55:33 +01008246 sizeof(shared_key),
Przemek Stekiel0c781802022-11-29 14:53:13 +01008247 &shared_key_len);
8248
8249 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008250 goto exit;
Przemek Stekiel0c781802022-11-29 14:53:13 +01008251 }
8252
8253 status = psa_key_derivation_input_bytes(output,
8254 PSA_KEY_DERIVATION_INPUT_SECRET,
8255 shared_key,
8256 shared_key_len);
8257
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008258 mbedtls_platform_zeroize(shared_key, sizeof(shared_key));
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008259exit:
8260 abort_status = psa_pake_abort(operation);
8261 return status == PSA_SUCCESS ? abort_status : status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008262}
8263
8264psa_status_t psa_pake_abort(
8265 psa_pake_operation_t *operation)
8266{
Przemek Stekield69dca92023-01-31 19:59:20 +01008267 psa_status_t status = PSA_SUCCESS;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008268
Przemek Stekield69dca92023-01-31 19:59:20 +01008269 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008270 status = psa_driver_wrapper_pake_abort(operation);
Neil Armstrong5ae60962022-09-15 11:29:46 +02008271 }
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008272
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008273 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
8274 if (operation->data.inputs.password != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01008275 mbedtls_zeroize_and_free(operation->data.inputs.password,
Przemek Stekielaa183422023-03-06 14:21:44 +01008276 operation->data.inputs.password_len);
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008277 }
8278 if (operation->data.inputs.user != NULL) {
8279 mbedtls_free(operation->data.inputs.user);
8280 }
8281 if (operation->data.inputs.peer != NULL) {
8282 mbedtls_free(operation->data.inputs.peer);
8283 }
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008284 }
Przemek Stekield69dca92023-01-31 19:59:20 +01008285 memset(operation, 0, sizeof(psa_pake_operation_t));
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008286
Przemek Stekield69dca92023-01-31 19:59:20 +01008287 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008288}
Tom Cosgrove6d62fac2023-05-10 14:40:05 +01008289#endif /* PSA_WANT_ALG_SOME_PAKE */
Neil Armstronga7d08c32022-06-01 18:21:20 +02008290
Gilles Peskinee59236f2018-01-27 23:32:46 +01008291#endif /* MBEDTLS_PSA_CRYPTO_C */