blob: 565b5e14ce2cdf9e190e3c7cd5bbc3c18ddb9878 [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 Settia55f0422023-07-10 15:34:41 +0200118#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_IMPORT) || \
Przemek Stekiel53410502023-04-28 13:18:43 +0200119 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY) || \
Valerio Settia55f0422023-07-10 15:34:41 +0200120 defined(PSA_WANT_KEY_TYPE_DH_KEY_PAIR_GENERATE)
Przemek Stekiel134cc2e2023-05-05 10:13:37 +0200121static int psa_is_dh_key_size_valid(size_t bits)
122{
Przemek Stekield1cf1ba2023-04-27 12:04:21 +0200123 if (bits != 2048 && bits != 3072 && bits != 4096 &&
124 bits != 6144 && bits != 8192) {
125 return 0;
126 }
127
128 return 1;
129}
Valerio Settia55f0422023-07-10 15:34:41 +0200130#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_IMPORT ||
Przemek Stekiel53410502023-04-28 13:18:43 +0200131 MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY ||
Valerio Settia55f0422023-07-10 15:34:41 +0200132 PSA_WANT_KEY_TYPE_DH_KEY_PAIR_GENERATE */
Manuel Pégourié-Gonnard7abdf7e2023-03-09 11:17:43 +0100133
Gilles Peskine449bd832023-01-11 14:50:10 +0100134psa_status_t mbedtls_to_psa_error(int ret)
Gilles Peskinee59236f2018-01-27 23:32:46 +0100135{
Gilles Peskinedbf68962021-01-06 20:04:23 +0100136 /* Mbed TLS error codes can combine a high-level error code and a
137 * low-level error code. The low-level error usually reflects the
138 * root cause better, so dispatch on that preferably. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100139 int low_level_ret = -(-ret & 0x007f);
140 switch (low_level_ret != 0 ? low_level_ret : ret) {
Gilles Peskinee59236f2018-01-27 23:32:46 +0100141 case 0:
Gilles Peskine449bd832023-01-11 14:50:10 +0100142 return PSA_SUCCESS;
Gilles Peskinea5905292018-02-07 20:59:33 +0100143
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100144#if defined(MBEDTLS_AES_C)
Gilles Peskinea5905292018-02-07 20:59:33 +0100145 case MBEDTLS_ERR_AES_INVALID_KEY_LENGTH:
146 case MBEDTLS_ERR_AES_INVALID_INPUT_LENGTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100147 return PSA_ERROR_NOT_SUPPORTED;
Dave Rodgman09a9e582023-08-31 11:05:22 +0100148 case MBEDTLS_ERR_AES_BAD_INPUT_DATA:
149 return PSA_ERROR_INVALID_ARGUMENT;
Dave Rodgman509b5672023-08-16 19:26:23 +0100150#endif
151
152#if defined(MBEDTLS_ASN1_PARSE_C) || defined(MBEDTLS_ASN1_WRITE_C)
Gilles Peskine9a944802018-06-21 09:35:35 +0200153 case MBEDTLS_ERR_ASN1_OUT_OF_DATA:
154 case MBEDTLS_ERR_ASN1_UNEXPECTED_TAG:
155 case MBEDTLS_ERR_ASN1_INVALID_LENGTH:
156 case MBEDTLS_ERR_ASN1_LENGTH_MISMATCH:
157 case MBEDTLS_ERR_ASN1_INVALID_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100158 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine9a944802018-06-21 09:35:35 +0200159 case MBEDTLS_ERR_ASN1_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100160 return PSA_ERROR_INSUFFICIENT_MEMORY;
Gilles Peskine9a944802018-06-21 09:35:35 +0200161 case MBEDTLS_ERR_ASN1_BUF_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +0100162 return PSA_ERROR_BUFFER_TOO_SMALL;
Dave Rodgman509b5672023-08-16 19:26:23 +0100163#endif
Gilles Peskine9a944802018-06-21 09:35:35 +0200164
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100165#if defined(MBEDTLS_CAMELLIA_C)
Jaeden Amero892cd6d2019-02-11 12:21:12 +0000166 case MBEDTLS_ERR_CAMELLIA_BAD_INPUT_DATA:
Gilles Peskinea5905292018-02-07 20:59:33 +0100167 case MBEDTLS_ERR_CAMELLIA_INVALID_INPUT_LENGTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100168 return PSA_ERROR_NOT_SUPPORTED;
Dave Rodgman509b5672023-08-16 19:26:23 +0100169#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100170
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100171#if defined(MBEDTLS_CCM_C)
Gilles Peskinea5905292018-02-07 20:59:33 +0100172 case MBEDTLS_ERR_CCM_BAD_INPUT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100173 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100174 case MBEDTLS_ERR_CCM_AUTH_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100175 return PSA_ERROR_INVALID_SIGNATURE;
Dave Rodgman509b5672023-08-16 19:26:23 +0100176#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100177
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100178#if defined(MBEDTLS_CHACHA20_C)
Gilles Peskine26869f22019-05-06 15:25:00 +0200179 case MBEDTLS_ERR_CHACHA20_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100180 return PSA_ERROR_INVALID_ARGUMENT;
Dave Rodgman509b5672023-08-16 19:26:23 +0100181#endif
Gilles Peskine26869f22019-05-06 15:25:00 +0200182
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100183#if defined(MBEDTLS_CHACHAPOLY_C)
Gilles Peskine26869f22019-05-06 15:25:00 +0200184 case MBEDTLS_ERR_CHACHAPOLY_BAD_STATE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100185 return PSA_ERROR_BAD_STATE;
Gilles Peskine26869f22019-05-06 15:25:00 +0200186 case MBEDTLS_ERR_CHACHAPOLY_AUTH_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100187 return PSA_ERROR_INVALID_SIGNATURE;
Dave Rodgman509b5672023-08-16 19:26:23 +0100188#endif
Gilles Peskine26869f22019-05-06 15:25:00 +0200189
Dave Rodgman509b5672023-08-16 19:26:23 +0100190#if defined(MBEDTLS_CIPHER_C)
Gilles Peskinea5905292018-02-07 20:59:33 +0100191 case MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100192 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea5905292018-02-07 20:59:33 +0100193 case MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100194 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100195 case MBEDTLS_ERR_CIPHER_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100196 return PSA_ERROR_INSUFFICIENT_MEMORY;
Gilles Peskinea5905292018-02-07 20:59:33 +0100197 case MBEDTLS_ERR_CIPHER_INVALID_PADDING:
Gilles Peskine449bd832023-01-11 14:50:10 +0100198 return PSA_ERROR_INVALID_PADDING;
Gilles Peskinea5905292018-02-07 20:59:33 +0100199 case MBEDTLS_ERR_CIPHER_FULL_BLOCK_EXPECTED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100200 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100201 case MBEDTLS_ERR_CIPHER_AUTH_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100202 return PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskinea5905292018-02-07 20:59:33 +0100203 case MBEDTLS_ERR_CIPHER_INVALID_CONTEXT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100204 return PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman509b5672023-08-16 19:26:23 +0100205#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100206
Gilles Peskine449bd832023-01-11 14:50:10 +0100207#if !(defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) || \
208 defined(MBEDTLS_PSA_HMAC_DRBG_MD_TYPE))
Gilles Peskinebee96c82020-11-23 21:00:09 +0100209 /* Only check CTR_DRBG error codes if underlying mbedtls_xxx
210 * functions are passed a CTR_DRBG instance. */
Gilles Peskinea5905292018-02-07 20:59:33 +0100211 case MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100212 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskinea5905292018-02-07 20:59:33 +0100213 case MBEDTLS_ERR_CTR_DRBG_REQUEST_TOO_BIG:
214 case MBEDTLS_ERR_CTR_DRBG_INPUT_TOO_BIG:
Gilles Peskine449bd832023-01-11 14:50:10 +0100215 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea5905292018-02-07 20:59:33 +0100216 case MBEDTLS_ERR_CTR_DRBG_FILE_IO_ERROR:
Gilles Peskine449bd832023-01-11 14:50:10 +0100217 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskine82e57d12020-11-13 21:31:17 +0100218#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100219
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100220#if defined(MBEDTLS_DES_C)
Gilles Peskinea5905292018-02-07 20:59:33 +0100221 case MBEDTLS_ERR_DES_INVALID_INPUT_LENGTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100222 return PSA_ERROR_NOT_SUPPORTED;
Dave Rodgman509b5672023-08-16 19:26:23 +0100223#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100224
Gilles Peskinee59236f2018-01-27 23:32:46 +0100225 case MBEDTLS_ERR_ENTROPY_NO_SOURCES_DEFINED:
226 case MBEDTLS_ERR_ENTROPY_NO_STRONG_SOURCE:
227 case MBEDTLS_ERR_ENTROPY_SOURCE_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100228 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskinea5905292018-02-07 20:59:33 +0100229
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100230#if defined(MBEDTLS_GCM_C)
Gilles Peskinea5905292018-02-07 20:59:33 +0100231 case MBEDTLS_ERR_GCM_AUTH_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100232 return PSA_ERROR_INVALID_SIGNATURE;
Mateusz Starzykf28261f2021-09-30 16:39:07 +0200233 case MBEDTLS_ERR_GCM_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +0100234 return PSA_ERROR_BUFFER_TOO_SMALL;
Gilles Peskinea5905292018-02-07 20:59:33 +0100235 case MBEDTLS_ERR_GCM_BAD_INPUT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100236 return PSA_ERROR_INVALID_ARGUMENT;
Dave Rodgman509b5672023-08-16 19:26:23 +0100237#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100238
Gilles Peskine82e57d12020-11-13 21:31:17 +0100239#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) && \
Gilles Peskine449bd832023-01-11 14:50:10 +0100240 defined(MBEDTLS_PSA_HMAC_DRBG_MD_TYPE)
Gilles Peskinebee96c82020-11-23 21:00:09 +0100241 /* Only check HMAC_DRBG error codes if underlying mbedtls_xxx
242 * functions are passed a HMAC_DRBG instance. */
Gilles Peskine82e57d12020-11-13 21:31:17 +0100243 case MBEDTLS_ERR_HMAC_DRBG_ENTROPY_SOURCE_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100244 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskine82e57d12020-11-13 21:31:17 +0100245 case MBEDTLS_ERR_HMAC_DRBG_REQUEST_TOO_BIG:
246 case MBEDTLS_ERR_HMAC_DRBG_INPUT_TOO_BIG:
Gilles Peskine449bd832023-01-11 14:50:10 +0100247 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine82e57d12020-11-13 21:31:17 +0100248 case MBEDTLS_ERR_HMAC_DRBG_FILE_IO_ERROR:
Gilles Peskine449bd832023-01-11 14:50:10 +0100249 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskine82e57d12020-11-13 21:31:17 +0100250#endif
251
Dave Rodgmandea266f2023-08-31 11:52:43 +0100252#if defined(MBEDTLS_MD_LIGHT)
Gilles Peskinea5905292018-02-07 20:59:33 +0100253 case MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100254 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea5905292018-02-07 20:59:33 +0100255 case MBEDTLS_ERR_MD_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100256 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100257 case MBEDTLS_ERR_MD_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100258 return PSA_ERROR_INSUFFICIENT_MEMORY;
Dave Rodgman509b5672023-08-16 19:26:23 +0100259#if defined(MBEDTLS_FS_IO)
Gilles Peskinea5905292018-02-07 20:59:33 +0100260 case MBEDTLS_ERR_MD_FILE_IO_ERROR:
Gilles Peskine449bd832023-01-11 14:50:10 +0100261 return PSA_ERROR_STORAGE_FAILURE;
Dave Rodgman509b5672023-08-16 19:26:23 +0100262#endif
263#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100264
Dave Rodgman509b5672023-08-16 19:26:23 +0100265#if defined(MBEDTLS_BIGNUM_C)
266#if defined(MBEDTLS_FS_IO)
Gilles Peskinef76aa772018-10-29 19:24:33 +0100267 case MBEDTLS_ERR_MPI_FILE_IO_ERROR:
Gilles Peskine449bd832023-01-11 14:50:10 +0100268 return PSA_ERROR_STORAGE_FAILURE;
Dave Rodgman509b5672023-08-16 19:26:23 +0100269#endif
Gilles Peskinef76aa772018-10-29 19:24:33 +0100270 case MBEDTLS_ERR_MPI_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100271 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100272 case MBEDTLS_ERR_MPI_INVALID_CHARACTER:
Gilles Peskine449bd832023-01-11 14:50:10 +0100273 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100274 case MBEDTLS_ERR_MPI_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +0100275 return PSA_ERROR_BUFFER_TOO_SMALL;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100276 case MBEDTLS_ERR_MPI_NEGATIVE_VALUE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100277 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100278 case MBEDTLS_ERR_MPI_DIVISION_BY_ZERO:
Gilles Peskine449bd832023-01-11 14:50:10 +0100279 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100280 case MBEDTLS_ERR_MPI_NOT_ACCEPTABLE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100281 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100282 case MBEDTLS_ERR_MPI_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100283 return PSA_ERROR_INSUFFICIENT_MEMORY;
Dave Rodgman509b5672023-08-16 19:26:23 +0100284#endif
Gilles Peskinef76aa772018-10-29 19:24:33 +0100285
Dave Rodgman509b5672023-08-16 19:26:23 +0100286#if defined(MBEDTLS_PK_C)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100287 case MBEDTLS_ERR_PK_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100288 return PSA_ERROR_INSUFFICIENT_MEMORY;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100289 case MBEDTLS_ERR_PK_TYPE_MISMATCH:
290 case MBEDTLS_ERR_PK_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100291 return PSA_ERROR_INVALID_ARGUMENT;
Dave Rodgman509b5672023-08-16 19:26:23 +0100292#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) || defined(MBEDTLS_FS_IO) || \
293 defined(MBEDTLS_PSA_ITS_FILE_C)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100294 case MBEDTLS_ERR_PK_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 Peskine2f9c4dc2018-01-28 13:16:24 +0100297 case MBEDTLS_ERR_PK_KEY_INVALID_VERSION:
298 case MBEDTLS_ERR_PK_KEY_INVALID_FORMAT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100299 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100300 case MBEDTLS_ERR_PK_UNKNOWN_PK_ALG:
Gilles Peskine449bd832023-01-11 14:50:10 +0100301 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100302 case MBEDTLS_ERR_PK_PASSWORD_REQUIRED:
303 case MBEDTLS_ERR_PK_PASSWORD_MISMATCH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100304 return PSA_ERROR_NOT_PERMITTED;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100305 case MBEDTLS_ERR_PK_INVALID_PUBKEY:
Gilles Peskine449bd832023-01-11 14:50:10 +0100306 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100307 case MBEDTLS_ERR_PK_INVALID_ALG:
308 case MBEDTLS_ERR_PK_UNKNOWN_NAMED_CURVE:
309 case MBEDTLS_ERR_PK_FEATURE_UNAVAILABLE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100310 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100311 case MBEDTLS_ERR_PK_SIG_LEN_MISMATCH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100312 return PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskinef9f1bdf2021-06-23 20:32:27 +0200313 case MBEDTLS_ERR_PK_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +0100314 return PSA_ERROR_BUFFER_TOO_SMALL;
Dave Rodgman509b5672023-08-16 19:26:23 +0100315#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100316
Gilles Peskineff2d2002019-05-06 15:26:23 +0200317 case MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100318 return PSA_ERROR_HARDWARE_FAILURE;
Gilles Peskineff2d2002019-05-06 15:26:23 +0200319 case MBEDTLS_ERR_PLATFORM_FEATURE_UNSUPPORTED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100320 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskineff2d2002019-05-06 15:26:23 +0200321
Dave Rodgman509b5672023-08-16 19:26:23 +0100322#if defined(MBEDTLS_RSA_C)
Gilles Peskinea5905292018-02-07 20:59:33 +0100323 case MBEDTLS_ERR_RSA_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100324 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100325 case MBEDTLS_ERR_RSA_INVALID_PADDING:
Gilles Peskine449bd832023-01-11 14:50:10 +0100326 return PSA_ERROR_INVALID_PADDING;
Gilles Peskinea5905292018-02-07 20:59:33 +0100327 case MBEDTLS_ERR_RSA_KEY_GEN_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100328 return PSA_ERROR_HARDWARE_FAILURE;
Gilles Peskinea5905292018-02-07 20:59:33 +0100329 case MBEDTLS_ERR_RSA_KEY_CHECK_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100330 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100331 case MBEDTLS_ERR_RSA_PUBLIC_FAILED:
332 case MBEDTLS_ERR_RSA_PRIVATE_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100333 return PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinea5905292018-02-07 20:59:33 +0100334 case MBEDTLS_ERR_RSA_VERIFY_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100335 return PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskinea5905292018-02-07 20:59:33 +0100336 case MBEDTLS_ERR_RSA_OUTPUT_TOO_LARGE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100337 return PSA_ERROR_BUFFER_TOO_SMALL;
Gilles Peskinea5905292018-02-07 20:59:33 +0100338 case MBEDTLS_ERR_RSA_RNG_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100339 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Dave Rodgman509b5672023-08-16 19:26:23 +0100340#endif
Manuel Pégourié-Gonnard93c08472021-04-15 12:23:55 +0200341
Dave Rodgman1dab4452023-09-01 09:59:51 +0100342#if defined(MBEDTLS_ECP_LIGHT)
itayzafrir5c753392018-05-08 11:18:38 +0300343 case MBEDTLS_ERR_ECP_BAD_INPUT_DATA:
itayzafrir7b30f8b2018-05-09 16:07:36 +0300344 case MBEDTLS_ERR_ECP_INVALID_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +0100345 return PSA_ERROR_INVALID_ARGUMENT;
itayzafrir7b30f8b2018-05-09 16:07:36 +0300346 case MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +0100347 return PSA_ERROR_BUFFER_TOO_SMALL;
itayzafrir7b30f8b2018-05-09 16:07:36 +0300348 case MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100349 return PSA_ERROR_NOT_SUPPORTED;
itayzafrir7b30f8b2018-05-09 16:07:36 +0300350 case MBEDTLS_ERR_ECP_SIG_LEN_MISMATCH:
351 case MBEDTLS_ERR_ECP_VERIFY_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100352 return PSA_ERROR_INVALID_SIGNATURE;
itayzafrir7b30f8b2018-05-09 16:07:36 +0300353 case MBEDTLS_ERR_ECP_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100354 return PSA_ERROR_INSUFFICIENT_MEMORY;
Gilles Peskine40d81602020-11-25 00:09:47 +0100355 case MBEDTLS_ERR_ECP_RANDOM_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100356 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskine40d81602020-11-25 00:09:47 +0100357
Dave Rodgman509b5672023-08-16 19:26:23 +0100358#if defined(MBEDTLS_ECP_RESTARTABLE)
Paul Elliott588f8ed2022-12-02 18:10:26 +0000359 case MBEDTLS_ERR_ECP_IN_PROGRESS:
360 return PSA_OPERATION_INCOMPLETE;
Dave Rodgman509b5672023-08-16 19:26:23 +0100361#endif
362#endif
Paul Elliott588f8ed2022-12-02 18:10:26 +0000363
Janos Follatha13b9052019-11-22 12:48:59 +0000364 case MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100365 return PSA_ERROR_CORRUPTION_DETECTED;
itayzafrir5c753392018-05-08 11:18:38 +0300366
Gilles Peskinee59236f2018-01-27 23:32:46 +0100367 default:
Gilles Peskine449bd832023-01-11 14:50:10 +0100368 return PSA_ERROR_GENERIC_ERROR;
Gilles Peskinee59236f2018-01-27 23:32:46 +0100369 }
370}
371
Paul Elliottdc42ca82023-02-24 18:11:59 +0000372/**
373 * \brief For output buffers which contain "tags"
374 * (outputs that may be checked for validity like
375 * hashes, MACs and signatures), fill the unused
376 * part of the output buffer (the whole buffer on
377 * error, the trailing part on success) with
378 * something that isn't a valid tag (barring an
379 * attack on the tag and deliberately-crafted
380 * input), in case the caller doesn't check the
381 * return status properly.
382 *
383 * \param output_buffer Pointer to buffer to wipe. May not be NULL
384 * unless \p output_buffer_size is zero.
385 * \param status Status of function called to generate
386 * output_buffer originally
387 * \param output_buffer_size Size of output buffer. If zero, \p output_buffer
388 * could be NULL.
389 * \param output_buffer_length Length of data written to output_buffer, must be
390 * less than \p output_buffer_size
391 */
392static void psa_wipe_tag_output_buffer(uint8_t *output_buffer, psa_status_t status,
Paul Elliott7118d172023-02-26 16:57:05 +0000393 size_t output_buffer_size, size_t output_buffer_length)
394{
Paul Elliottdc42ca82023-02-24 18:11:59 +0000395 size_t offset = 0;
396
397 if (output_buffer_size == 0) {
398 /* If output_buffer_size is 0 then we have nothing to do. We must not
399 call memset because output_buffer may be NULL in this case */
400 return;
401 }
402
403 if (status == PSA_SUCCESS) {
404 offset = output_buffer_length;
405 }
406
407 memset(output_buffer + offset, '!', output_buffer_size - offset);
408}
409
Gilles Peskineb0b255c2018-07-06 17:01:38 +0200410
Gilles Peskine449bd832023-01-11 14:50:10 +0100411psa_status_t psa_validate_unstructured_key_bit_size(psa_key_type_t type,
412 size_t bits)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200413{
414 /* Check that the bit size is acceptable for the key type */
Gilles Peskine449bd832023-01-11 14:50:10 +0100415 switch (type) {
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200416 case PSA_KEY_TYPE_RAW_DATA:
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200417 case PSA_KEY_TYPE_HMAC:
Gilles Peskineea0fb492018-07-12 17:17:20 +0200418 case PSA_KEY_TYPE_DERIVE:
Neil Armstrong4b5710f2022-05-25 11:30:27 +0200419 case PSA_KEY_TYPE_PASSWORD:
420 case PSA_KEY_TYPE_PASSWORD_HASH:
Gilles Peskineea0fb492018-07-12 17:17:20 +0200421 break;
Ronald Cron1f0db802021-03-12 09:59:30 +0100422#if defined(PSA_WANT_KEY_TYPE_AES)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200423 case PSA_KEY_TYPE_AES:
Gilles Peskine449bd832023-01-11 14:50:10 +0100424 if (bits != 128 && bits != 192 && bits != 256) {
425 return PSA_ERROR_INVALID_ARGUMENT;
426 }
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200427 break;
428#endif
Gilles Peskine6c12a1e2021-09-21 11:59:39 +0200429#if defined(PSA_WANT_KEY_TYPE_ARIA)
430 case PSA_KEY_TYPE_ARIA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100431 if (bits != 128 && bits != 192 && bits != 256) {
432 return PSA_ERROR_INVALID_ARGUMENT;
433 }
Gilles Peskine6c12a1e2021-09-21 11:59:39 +0200434 break;
435#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100436#if defined(PSA_WANT_KEY_TYPE_CAMELLIA)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200437 case PSA_KEY_TYPE_CAMELLIA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100438 if (bits != 128 && bits != 192 && bits != 256) {
439 return PSA_ERROR_INVALID_ARGUMENT;
440 }
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200441 break;
442#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100443#if defined(PSA_WANT_KEY_TYPE_DES)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200444 case PSA_KEY_TYPE_DES:
Gilles Peskine449bd832023-01-11 14:50:10 +0100445 if (bits != 64 && bits != 128 && bits != 192) {
446 return PSA_ERROR_INVALID_ARGUMENT;
447 }
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200448 break;
449#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100450#if defined(PSA_WANT_KEY_TYPE_CHACHA20)
Gilles Peskine26869f22019-05-06 15:25:00 +0200451 case PSA_KEY_TYPE_CHACHA20:
Gilles Peskine449bd832023-01-11 14:50:10 +0100452 if (bits != 256) {
453 return PSA_ERROR_INVALID_ARGUMENT;
454 }
Gilles Peskine26869f22019-05-06 15:25:00 +0200455 break;
456#endif
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200457 default:
Gilles Peskine449bd832023-01-11 14:50:10 +0100458 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200459 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100460 if (bits % 8 != 0) {
461 return PSA_ERROR_INVALID_ARGUMENT;
462 }
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200463
Gilles Peskine449bd832023-01-11 14:50:10 +0100464 return PSA_SUCCESS;
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200465}
466
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100467/** Check whether a given key type is valid for use with a given MAC algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100468 *
Steven Cooremancd640932021-03-08 12:00:27 +0100469 * Upon successful return of this function, the behavior of #PSA_MAC_LENGTH
470 * when called with the validated \p algorithm and \p key_type is well-defined.
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100471 *
472 * \param[in] algorithm The specific MAC algorithm (can be wildcard).
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100473 * \param[in] key_type The key type of the key to be used with the
474 * \p algorithm.
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100475 *
476 * \retval #PSA_SUCCESS
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100477 * The \p key_type is valid for use with the \p algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100478 * \retval #PSA_ERROR_INVALID_ARGUMENT
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100479 * The \p key_type is not valid for use with the \p algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100480 */
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100481MBEDTLS_STATIC_TESTABLE psa_status_t psa_mac_key_can_do(
Steven Cooreman58c94d32021-03-02 21:31:17 +0100482 psa_algorithm_t algorithm,
Gilles Peskine449bd832023-01-11 14:50:10 +0100483 psa_key_type_t key_type)
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100484{
Gilles Peskine449bd832023-01-11 14:50:10 +0100485 if (PSA_ALG_IS_HMAC(algorithm)) {
486 if (key_type == PSA_KEY_TYPE_HMAC) {
487 return PSA_SUCCESS;
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100488 }
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100489 }
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100490
Gilles Peskine449bd832023-01-11 14:50:10 +0100491 if (PSA_ALG_IS_BLOCK_CIPHER_MAC(algorithm)) {
492 /* Check that we're calling PSA_BLOCK_CIPHER_BLOCK_LENGTH with a cipher
493 * key. */
494 if ((key_type & PSA_KEY_TYPE_CATEGORY_MASK) ==
495 PSA_KEY_TYPE_CATEGORY_SYMMETRIC) {
496 /* PSA_BLOCK_CIPHER_BLOCK_LENGTH returns 1 for stream ciphers and
497 * the block length (larger than 1) for block ciphers. */
498 if (PSA_BLOCK_CIPHER_BLOCK_LENGTH(key_type) > 1) {
499 return PSA_SUCCESS;
500 }
501 }
502 }
503
504 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100505}
506
Gilles Peskine449bd832023-01-11 14:50:10 +0100507psa_status_t psa_allocate_buffer_to_slot(psa_key_slot_t *slot,
508 size_t buffer_length)
Steven Cooreman75b74362020-07-28 14:30:13 +0200509{
Gilles Peskine449bd832023-01-11 14:50:10 +0100510 if (slot->key.data != NULL) {
511 return PSA_ERROR_ALREADY_EXISTS;
512 }
Steven Cooreman75b74362020-07-28 14:30:13 +0200513
Gilles Peskine449bd832023-01-11 14:50:10 +0100514 slot->key.data = mbedtls_calloc(1, buffer_length);
515 if (slot->key.data == NULL) {
516 return PSA_ERROR_INSUFFICIENT_MEMORY;
517 }
Steven Cooreman75b74362020-07-28 14:30:13 +0200518
Ronald Cronea0f8a62020-11-25 17:52:23 +0100519 slot->key.bytes = buffer_length;
Gilles Peskine449bd832023-01-11 14:50:10 +0100520 return PSA_SUCCESS;
Steven Cooreman75b74362020-07-28 14:30:13 +0200521}
522
Gilles Peskine449bd832023-01-11 14:50:10 +0100523psa_status_t psa_copy_key_material_into_slot(psa_key_slot_t *slot,
524 const uint8_t *data,
525 size_t data_length)
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200526{
Gilles Peskine449bd832023-01-11 14:50:10 +0100527 psa_status_t status = psa_allocate_buffer_to_slot(slot,
528 data_length);
529 if (status != PSA_SUCCESS) {
530 return status;
531 }
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200532
Gilles Peskine449bd832023-01-11 14:50:10 +0100533 memcpy(slot->key.data, data, data_length);
534 return PSA_SUCCESS;
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200535}
536
Ronald Crona0fe59f2020-11-29 11:14:53 +0100537psa_status_t psa_import_key_into_slot(
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100538 const psa_key_attributes_t *attributes,
539 const uint8_t *data, size_t data_length,
540 uint8_t *key_buffer, size_t key_buffer_size,
Gilles Peskine449bd832023-01-11 14:50:10 +0100541 size_t *key_buffer_length, size_t *bits)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100542{
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100543 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
544 psa_key_type_t type = attributes->core.type;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100545
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200546 /* zero-length keys are never supported. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100547 if (data_length == 0) {
548 return PSA_ERROR_NOT_SUPPORTED;
549 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200550
Gilles Peskine449bd832023-01-11 14:50:10 +0100551 if (key_type_is_raw_bytes(type)) {
552 *bits = PSA_BYTES_TO_BITS(data_length);
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200553
Gilles Peskine449bd832023-01-11 14:50:10 +0100554 status = psa_validate_unstructured_key_bit_size(attributes->core.type,
555 *bits);
556 if (status != PSA_SUCCESS) {
557 return status;
558 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200559
Ronald Crondd04d422020-11-28 15:14:42 +0100560 /* Copy the key material. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100561 memcpy(key_buffer, data, data_length);
Ronald Crondd04d422020-11-28 15:14:42 +0100562 *key_buffer_length = data_length;
Gilles Peskine449bd832023-01-11 14:50:10 +0100563 (void) key_buffer_size;
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200564
Gilles Peskine449bd832023-01-11 14:50:10 +0100565 return PSA_SUCCESS;
566 } else if (PSA_KEY_TYPE_IS_ASYMMETRIC(type)) {
Valerio Settia55f0422023-07-10 15:34:41 +0200567#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_IMPORT) || \
Przemek Stekiel6d85afa2023-04-28 11:42:17 +0200568 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY)
Przemek Stekiel472b3f32022-12-01 14:38:49 +0100569 if (PSA_KEY_TYPE_IS_DH(type)) {
Przemek Stekield1cf1ba2023-04-27 12:04:21 +0200570 if (psa_is_dh_key_size_valid(PSA_BYTES_TO_BITS(data_length)) == 0) {
Przemek Stekiel472b3f32022-12-01 14:38:49 +0100571 return PSA_ERROR_INVALID_ARGUMENT;
572 }
Przemek Stekiel33c91eb2023-05-30 15:16:35 +0200573 return mbedtls_psa_ffdh_import_key(attributes,
574 data, data_length,
575 key_buffer, key_buffer_size,
576 key_buffer_length,
577 bits);
Przemek Stekiel472b3f32022-12-01 14:38:49 +0100578 }
Valerio Settia55f0422023-07-10 15:34:41 +0200579#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_IMPORT) ||
Przemek Stekiel6d85afa2023-04-28 11:42:17 +0200580 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY) */
Valerio Setti27c501a2023-06-27 16:58:52 +0200581#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_IMPORT) || \
Gilles Peskine449bd832023-01-11 14:50:10 +0100582 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
583 if (PSA_KEY_TYPE_IS_ECC(type)) {
584 return mbedtls_psa_ecp_import_key(attributes,
585 data, data_length,
586 key_buffer, key_buffer_size,
587 key_buffer_length,
588 bits);
Steven Cooreman40120f62020-10-29 11:42:22 +0100589 }
Valerio Setti27c501a2023-06-27 16:58:52 +0200590#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_IMPORT) ||
John Durkop9814fa22020-11-04 12:28:15 -0800591 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
Valerio Settife478902023-07-25 12:27:19 +0200592#if (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) && \
593 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) || \
Gilles Peskine449bd832023-01-11 14:50:10 +0100594 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
595 if (PSA_KEY_TYPE_IS_RSA(type)) {
596 return mbedtls_psa_rsa_import_key(attributes,
597 data, data_length,
598 key_buffer, key_buffer_size,
599 key_buffer_length,
600 bits);
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200601 }
Valerio Settife478902023-07-25 12:27:19 +0200602#endif /* (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) &&
603 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) ||
John Durkop9814fa22020-11-04 12:28:15 -0800604 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100605 }
Steven Cooreman40120f62020-10-29 11:42:22 +0100606
Gilles Peskine449bd832023-01-11 14:50:10 +0100607 return PSA_ERROR_NOT_SUPPORTED;
Darryl Green06fd18d2018-07-16 11:21:11 +0100608}
609
Gilles Peskinef603c712019-01-19 13:40:11 +0100610/** Calculate the intersection of two algorithm usage policies.
611 *
612 * Return 0 (which allows no operation) on incompatibility.
613 */
614static psa_algorithm_t psa_key_policy_algorithm_intersection(
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100615 psa_key_type_t key_type,
Gilles Peskinef603c712019-01-19 13:40:11 +0100616 psa_algorithm_t alg1,
Gilles Peskine449bd832023-01-11 14:50:10 +0100617 psa_algorithm_t alg2)
Gilles Peskinef603c712019-01-19 13:40:11 +0100618{
Gilles Peskine549ea862019-05-22 11:45:59 +0200619 /* Common case: both sides actually specify the same policy. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100620 if (alg1 == alg2) {
621 return alg1;
622 }
Steven Cooreman03488022021-02-18 12:07:20 +0100623 /* If the policies are from the same hash-and-sign family, check
624 * if one is a wildcard. If so the other has the specific algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100625 if (PSA_ALG_IS_SIGN_HASH(alg1) &&
626 PSA_ALG_IS_SIGN_HASH(alg2) &&
627 (alg1 & ~PSA_ALG_HASH_MASK) == (alg2 & ~PSA_ALG_HASH_MASK)) {
628 if (PSA_ALG_SIGN_GET_HASH(alg1) == PSA_ALG_ANY_HASH) {
629 return alg2;
630 }
631 if (PSA_ALG_SIGN_GET_HASH(alg2) == PSA_ALG_ANY_HASH) {
632 return alg1;
633 }
Steven Cooreman03488022021-02-18 12:07:20 +0100634 }
635 /* If the policies are from the same AEAD family, check whether
Steven Cooreman7de9e2d2021-02-22 17:05:56 +0100636 * one of them is a minimum-tag-length wildcard. Calculate the most
Steven Cooreman03488022021-02-18 12:07:20 +0100637 * restrictive tag length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100638 if (PSA_ALG_IS_AEAD(alg1) && PSA_ALG_IS_AEAD(alg2) &&
639 (PSA_ALG_AEAD_WITH_SHORTENED_TAG(alg1, 0) ==
640 PSA_ALG_AEAD_WITH_SHORTENED_TAG(alg2, 0))) {
641 size_t alg1_len = PSA_ALG_AEAD_GET_TAG_LENGTH(alg1);
642 size_t alg2_len = PSA_ALG_AEAD_GET_TAG_LENGTH(alg2);
Steven Cooremancd640932021-03-08 12:00:27 +0100643 size_t restricted_len = alg1_len > alg2_len ? alg1_len : alg2_len;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100644
Steven Cooreman7de9e2d2021-02-22 17:05:56 +0100645 /* If both are wildcards, return most restrictive wildcard */
Gilles Peskine449bd832023-01-11 14:50:10 +0100646 if (((alg1 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0) &&
647 ((alg2 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0)) {
648 return PSA_ALG_AEAD_WITH_AT_LEAST_THIS_LENGTH_TAG(
649 alg1, restricted_len);
Steven Cooreman03488022021-02-18 12:07:20 +0100650 }
651 /* If only one is a wildcard, return specific algorithm if compatible. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100652 if (((alg1 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0) &&
653 (alg1_len <= alg2_len)) {
654 return alg2;
Steven Cooreman03488022021-02-18 12:07:20 +0100655 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100656 if (((alg2 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0) &&
657 (alg2_len <= alg1_len)) {
658 return alg1;
Steven Cooreman03488022021-02-18 12:07:20 +0100659 }
660 }
661 /* If the policies are from the same MAC family, check whether one
662 * of them is a minimum-MAC-length policy. Calculate the most
663 * restrictive tag length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100664 if (PSA_ALG_IS_MAC(alg1) && PSA_ALG_IS_MAC(alg2) &&
665 (PSA_ALG_FULL_LENGTH_MAC(alg1) ==
666 PSA_ALG_FULL_LENGTH_MAC(alg2))) {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100667 /* Validate the combination of key type and algorithm. Since the base
668 * algorithm of alg1 and alg2 are the same, we only need this once. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100669 if (PSA_SUCCESS != psa_mac_key_can_do(alg1, key_type)) {
670 return 0;
671 }
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100672
Steven Cooreman31a876d2021-03-03 20:47:40 +0100673 /* Get the (exact or at-least) output lengths for both sides of the
674 * requested intersection. None of the currently supported algorithms
675 * have an output length dependent on the actual key size, so setting it
676 * to a bogus value of 0 is currently OK.
677 *
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100678 * Note that for at-least-this-length wildcard algorithms, the output
679 * length is set to the shortest allowed length, which allows us to
680 * calculate the most restrictive tag length for the intersection. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100681 size_t alg1_len = PSA_MAC_LENGTH(key_type, 0, alg1);
682 size_t alg2_len = PSA_MAC_LENGTH(key_type, 0, alg2);
Steven Cooremancd640932021-03-08 12:00:27 +0100683 size_t restricted_len = alg1_len > alg2_len ? alg1_len : alg2_len;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100684
Steven Cooremana1d83222021-02-25 10:20:29 +0100685 /* If both are wildcards, return most restrictive wildcard */
Gilles Peskine449bd832023-01-11 14:50:10 +0100686 if (((alg1 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0) &&
687 ((alg2 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0)) {
688 return PSA_ALG_AT_LEAST_THIS_LENGTH_MAC(alg1, restricted_len);
Steven Cooreman03488022021-02-18 12:07:20 +0100689 }
Steven Cooreman31a876d2021-03-03 20:47:40 +0100690
691 /* If only one is an at-least-this-length policy, the intersection would
692 * be the other (fixed-length) policy as long as said fixed length is
693 * equal to or larger than the shortest allowed length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100694 if ((alg1 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0) {
695 return (alg1_len <= alg2_len) ? alg2 : 0;
Steven Cooreman03488022021-02-18 12:07:20 +0100696 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100697 if ((alg2 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0) {
698 return (alg2_len <= alg1_len) ? alg1 : 0;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100699 }
Steven Cooreman31a876d2021-03-03 20:47:40 +0100700
Steven Cooremancd640932021-03-08 12:00:27 +0100701 /* If none of them are wildcards, check whether they define the same tag
702 * length. This is still possible here when one is default-length and
703 * the other specific-length. Ensure to always return the
704 * specific-length version for the intersection. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100705 if (alg1_len == alg2_len) {
706 return PSA_ALG_TRUNCATED_MAC(alg1, alg1_len);
707 }
Gilles Peskinef603c712019-01-19 13:40:11 +0100708 }
709 /* If the policies are incompatible, allow nothing. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100710 return 0;
Gilles Peskinef603c712019-01-19 13:40:11 +0100711}
712
Gilles Peskine449bd832023-01-11 14:50:10 +0100713static int psa_key_algorithm_permits(psa_key_type_t key_type,
714 psa_algorithm_t policy_alg,
715 psa_algorithm_t requested_alg)
Gilles Peskined6f371b2019-05-10 19:33:38 +0200716{
Gilles Peskine549ea862019-05-22 11:45:59 +0200717 /* Common case: the policy only allows requested_alg. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100718 if (requested_alg == policy_alg) {
719 return 1;
720 }
Steven Cooreman03488022021-02-18 12:07:20 +0100721 /* If policy_alg is a hash-and-sign with a wildcard for the hash,
722 * and requested_alg is the same hash-and-sign family with any hash,
723 * then requested_alg is compliant with policy_alg. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100724 if (PSA_ALG_IS_SIGN_HASH(requested_alg) &&
725 PSA_ALG_SIGN_GET_HASH(policy_alg) == PSA_ALG_ANY_HASH) {
726 return (policy_alg & ~PSA_ALG_HASH_MASK) ==
727 (requested_alg & ~PSA_ALG_HASH_MASK);
Steven Cooreman03488022021-02-18 12:07:20 +0100728 }
729 /* If policy_alg is a wildcard AEAD algorithm of the same base as
730 * the requested algorithm, check the requested tag length to be
731 * equal-length or longer than the wildcard-specified length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100732 if (PSA_ALG_IS_AEAD(policy_alg) &&
733 PSA_ALG_IS_AEAD(requested_alg) &&
734 (PSA_ALG_AEAD_WITH_SHORTENED_TAG(policy_alg, 0) ==
735 PSA_ALG_AEAD_WITH_SHORTENED_TAG(requested_alg, 0)) &&
736 ((policy_alg & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0)) {
737 return PSA_ALG_AEAD_GET_TAG_LENGTH(policy_alg) <=
738 PSA_ALG_AEAD_GET_TAG_LENGTH(requested_alg);
Steven Cooreman03488022021-02-18 12:07:20 +0100739 }
Steven Cooremancd640932021-03-08 12:00:27 +0100740 /* If policy_alg is a MAC algorithm of the same base as the requested
741 * algorithm, check whether their MAC lengths are compatible. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100742 if (PSA_ALG_IS_MAC(policy_alg) &&
743 PSA_ALG_IS_MAC(requested_alg) &&
744 (PSA_ALG_FULL_LENGTH_MAC(policy_alg) ==
745 PSA_ALG_FULL_LENGTH_MAC(requested_alg))) {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100746 /* Validate the combination of key type and algorithm. Since the policy
747 * and requested algorithms are the same, we only need this once. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100748 if (PSA_SUCCESS != psa_mac_key_can_do(policy_alg, key_type)) {
749 return 0;
750 }
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100751
Steven Cooreman31a876d2021-03-03 20:47:40 +0100752 /* Get both the requested output length for the algorithm which is to be
753 * verified, and the default output length for the base algorithm.
754 * Note that none of the currently supported algorithms have an output
755 * length dependent on actual key size, so setting it to a bogus value
756 * of 0 is currently OK. */
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100757 size_t requested_output_length = PSA_MAC_LENGTH(
Gilles Peskine449bd832023-01-11 14:50:10 +0100758 key_type, 0, requested_alg);
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100759 size_t default_output_length = PSA_MAC_LENGTH(
Gilles Peskine449bd832023-01-11 14:50:10 +0100760 key_type, 0,
761 PSA_ALG_FULL_LENGTH_MAC(requested_alg));
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100762
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100763 /* If the policy is default-length, only allow an algorithm with
764 * a declared exact-length matching the default. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100765 if (PSA_MAC_TRUNCATED_LENGTH(policy_alg) == 0) {
766 return requested_output_length == default_output_length;
767 }
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100768
769 /* If the requested algorithm is default-length, allow it if the policy
Steven Cooremancd640932021-03-08 12:00:27 +0100770 * length exactly matches the default length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100771 if (PSA_MAC_TRUNCATED_LENGTH(requested_alg) == 0 &&
772 PSA_MAC_TRUNCATED_LENGTH(policy_alg) == default_output_length) {
773 return 1;
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100774 }
775
Steven Cooremancd640932021-03-08 12:00:27 +0100776 /* If policy_alg is an at-least-this-length wildcard MAC algorithm,
777 * check for the requested MAC length to be equal to or longer than the
778 * minimum allowed length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100779 if ((policy_alg & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0) {
780 return PSA_MAC_TRUNCATED_LENGTH(policy_alg) <=
781 requested_output_length;
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100782 }
Gilles Peskined6f371b2019-05-10 19:33:38 +0200783 }
Steven Cooremance48e852020-10-05 16:02:45 +0200784 /* If policy_alg is a generic key agreement operation, then using it for
Steven Cooremanfa5e6312020-10-15 17:07:12 +0200785 * a key derivation with that key agreement should also be allowed. This
786 * behaviour is expected to be defined in a future specification version. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100787 if (PSA_ALG_IS_RAW_KEY_AGREEMENT(policy_alg) &&
788 PSA_ALG_IS_KEY_AGREEMENT(requested_alg)) {
789 return PSA_ALG_KEY_AGREEMENT_GET_BASE(requested_alg) ==
790 policy_alg;
Steven Cooremance48e852020-10-05 16:02:45 +0200791 }
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100792 /* If it isn't explicitly permitted, it's forbidden. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100793 return 0;
Gilles Peskined6f371b2019-05-10 19:33:38 +0200794}
795
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100796/** Test whether a policy permits an algorithm.
797 *
798 * The caller must test usage flags separately.
Steven Cooreman7e39f052021-02-23 14:18:32 +0100799 *
Steven Cooreman5a172672021-03-02 21:27:42 +0100800 * \note This function requires providing the key type for which the policy is
801 * being validated, since some algorithm policy definitions (e.g. MAC)
802 * have different properties depending on what kind of cipher it is
803 * combined with.
804 *
Steven Cooreman7e39f052021-02-23 14:18:32 +0100805 * \retval PSA_SUCCESS When \p alg is a specific algorithm
806 * allowed by the \p policy.
807 * \retval PSA_ERROR_INVALID_ARGUMENT When \p alg is not a specific algorithm
808 * \retval PSA_ERROR_NOT_PERMITTED When \p alg is a specific algorithm, but
809 * the \p policy does not allow it.
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100810 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100811static psa_status_t psa_key_policy_permits(const psa_key_policy_t *policy,
812 psa_key_type_t key_type,
813 psa_algorithm_t alg)
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100814{
Steven Cooremand788fab2021-02-25 11:29:17 +0100815 /* '0' is not a valid algorithm */
Gilles Peskine449bd832023-01-11 14:50:10 +0100816 if (alg == 0) {
817 return PSA_ERROR_INVALID_ARGUMENT;
818 }
Steven Cooremand788fab2021-02-25 11:29:17 +0100819
Steven Cooreman7e39f052021-02-23 14:18:32 +0100820 /* A requested algorithm cannot be a wildcard. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100821 if (PSA_ALG_IS_WILDCARD(alg)) {
822 return PSA_ERROR_INVALID_ARGUMENT;
823 }
Steven Cooreman7e39f052021-02-23 14:18:32 +0100824
Gilles Peskine449bd832023-01-11 14:50:10 +0100825 if (psa_key_algorithm_permits(key_type, policy->alg, alg) ||
826 psa_key_algorithm_permits(key_type, policy->alg2, alg)) {
827 return PSA_SUCCESS;
828 } else {
829 return PSA_ERROR_NOT_PERMITTED;
830 }
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100831}
832
Gilles Peskinef603c712019-01-19 13:40:11 +0100833/** Restrict a key policy based on a constraint.
834 *
Steven Cooreman5a172672021-03-02 21:27:42 +0100835 * \note This function requires providing the key type for which the policy is
836 * being restricted, since some algorithm policy definitions (e.g. MAC)
837 * have different properties depending on what kind of cipher it is
838 * combined with.
839 *
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100840 * \param[in] key_type The key type for which to restrict the policy
Gilles Peskinef603c712019-01-19 13:40:11 +0100841 * \param[in,out] policy The policy to restrict.
842 * \param[in] constraint The policy constraint to apply.
843 *
844 * \retval #PSA_SUCCESS
845 * \c *policy contains the intersection of the original value of
846 * \c *policy and \c *constraint.
847 * \retval #PSA_ERROR_INVALID_ARGUMENT
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100848 * \c key_type, \c *policy and \c *constraint are incompatible.
Gilles Peskinef603c712019-01-19 13:40:11 +0100849 * \c *policy is unchanged.
850 */
851static psa_status_t psa_restrict_key_policy(
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100852 psa_key_type_t key_type,
Gilles Peskinef603c712019-01-19 13:40:11 +0100853 psa_key_policy_t *policy,
Gilles Peskine449bd832023-01-11 14:50:10 +0100854 const psa_key_policy_t *constraint)
Gilles Peskinef603c712019-01-19 13:40:11 +0100855{
856 psa_algorithm_t intersection_alg =
Gilles Peskine449bd832023-01-11 14:50:10 +0100857 psa_key_policy_algorithm_intersection(key_type, policy->alg,
858 constraint->alg);
Gilles Peskined6f371b2019-05-10 19:33:38 +0200859 psa_algorithm_t intersection_alg2 =
Gilles Peskine449bd832023-01-11 14:50:10 +0100860 psa_key_policy_algorithm_intersection(key_type, policy->alg2,
861 constraint->alg2);
862 if (intersection_alg == 0 && policy->alg != 0 && constraint->alg != 0) {
863 return PSA_ERROR_INVALID_ARGUMENT;
864 }
865 if (intersection_alg2 == 0 && policy->alg2 != 0 && constraint->alg2 != 0) {
866 return PSA_ERROR_INVALID_ARGUMENT;
867 }
Gilles Peskinef603c712019-01-19 13:40:11 +0100868 policy->usage &= constraint->usage;
869 policy->alg = intersection_alg;
Gilles Peskined6f371b2019-05-10 19:33:38 +0200870 policy->alg2 = intersection_alg2;
Gilles Peskine449bd832023-01-11 14:50:10 +0100871 return PSA_SUCCESS;
Gilles Peskinef603c712019-01-19 13:40:11 +0100872}
873
Przemek Stekiel061f6942022-11-30 10:51:35 +0100874/** Get the description of a key given its identifier and policy constraints
875 * and lock it.
876 *
877 * The key must have allow all the usage flags set in \p usage. If \p alg is
878 * nonzero, the key must allow operations with this algorithm. If \p alg is
879 * zero, the algorithm is not checked.
880 *
881 * In case of a persistent key, the function loads the description of the key
882 * into a key slot if not already done.
883 *
Ryan Everett098c6652024-01-03 13:03:36 +0000884 * On success, the returned key slot has been registered for reading.
885 * It is the responsibility of the caller to call psa_unregister_read(slot)
886 * when they have finished reading the contents of the slot.
Przemek Stekiel061f6942022-11-30 10:51:35 +0100887 */
888static psa_status_t psa_get_and_lock_key_slot_with_policy(
Ronald Cron5c522922020-11-14 16:35:34 +0100889 mbedtls_svc_key_id_t key,
890 psa_key_slot_t **p_slot,
891 psa_key_usage_t usage,
Gilles Peskine449bd832023-01-11 14:50:10 +0100892 psa_algorithm_t alg)
Darryl Green06fd18d2018-07-16 11:21:11 +0100893{
Ronald Cronf95a2b12020-10-22 15:24:49 +0200894 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel9a5b8122022-12-22 13:34:47 +0100895 psa_key_slot_t *slot = NULL;
Darryl Green06fd18d2018-07-16 11:21:11 +0100896
Gilles Peskine449bd832023-01-11 14:50:10 +0100897 status = psa_get_and_lock_key_slot(key, p_slot);
898 if (status != PSA_SUCCESS) {
899 return status;
900 }
Ronald Cronf95a2b12020-10-22 15:24:49 +0200901 slot = *p_slot;
Darryl Green06fd18d2018-07-16 11:21:11 +0100902
903 /* Enforce that usage policy for the key slot contains all the flags
904 * required by the usage parameter. There is one exception: public
905 * keys can always be exported, so we treat public key objects as
906 * if they had the export flag. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100907 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(slot->attr.type)) {
Darryl Green06fd18d2018-07-16 11:21:11 +0100908 usage &= ~PSA_KEY_USAGE_EXPORT;
Gilles Peskine449bd832023-01-11 14:50:10 +0100909 }
Ronald Cronf95a2b12020-10-22 15:24:49 +0200910
Gilles Peskine449bd832023-01-11 14:50:10 +0100911 if ((slot->attr.policy.usage & usage) != usage) {
Steven Cooreman328f11c2021-03-02 11:44:51 +0100912 status = PSA_ERROR_NOT_PERMITTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +0200913 goto error;
Steven Cooreman328f11c2021-03-02 11:44:51 +0100914 }
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100915
Shaun Case8b0ecbc2021-12-20 21:14:10 -0800916 /* Enforce that the usage policy permits the requested algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100917 if (alg != 0) {
918 status = psa_key_policy_permits(&slot->attr.policy,
919 slot->attr.type,
920 alg);
921 if (status != PSA_SUCCESS) {
Steven Cooreman7e39f052021-02-23 14:18:32 +0100922 goto error;
Gilles Peskine449bd832023-01-11 14:50:10 +0100923 }
Steven Cooreman7e39f052021-02-23 14:18:32 +0100924 }
Darryl Green06fd18d2018-07-16 11:21:11 +0100925
Gilles Peskine449bd832023-01-11 14:50:10 +0100926 return PSA_SUCCESS;
Ronald Cronf95a2b12020-10-22 15:24:49 +0200927
928error:
929 *p_slot = NULL;
Ryan Everett098c6652024-01-03 13:03:36 +0000930 psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +0200931
Gilles Peskine449bd832023-01-11 14:50:10 +0100932 return status;
Darryl Green06fd18d2018-07-16 11:21:11 +0100933}
Darryl Green940d72c2018-07-13 13:18:51 +0100934
Ronald Cron5c522922020-11-14 16:35:34 +0100935/** Get a key slot containing a transparent key and lock it.
Gilles Peskine28f8f302019-07-24 13:30:31 +0200936 *
937 * A transparent key is a key for which the key material is directly
Ronald Cronddae0f52021-08-24 15:39:44 +0200938 * available, as opposed to a key in a secure element and/or to be used
939 * by a secure element.
Gilles Peskine28f8f302019-07-24 13:30:31 +0200940 *
Ronald Cronddae0f52021-08-24 15:39:44 +0200941 * This is a temporary function that may be used instead of
942 * psa_get_and_lock_key_slot_with_policy() when there is no opaque key support
943 * for a cryptographic operation.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200944 *
Ryan Everett098c6652024-01-03 13:03:36 +0000945 * On success, the returned key slot has been registered for reading.
946 * It is the responsibility of the caller to call psa_unregister_read(slot)
947 * when they have finished reading the contents of the slot.
Gilles Peskine28f8f302019-07-24 13:30:31 +0200948 */
Ronald Cron5c522922020-11-14 16:35:34 +0100949static psa_status_t psa_get_and_lock_transparent_key_slot_with_policy(
950 mbedtls_svc_key_id_t key,
951 psa_key_slot_t **p_slot,
952 psa_key_usage_t usage,
Gilles Peskine449bd832023-01-11 14:50:10 +0100953 psa_algorithm_t alg)
Gilles Peskine28f8f302019-07-24 13:30:31 +0200954{
Gilles Peskine449bd832023-01-11 14:50:10 +0100955 psa_status_t status = psa_get_and_lock_key_slot_with_policy(key, p_slot,
956 usage, alg);
957 if (status != PSA_SUCCESS) {
958 return status;
Gilles Peskine28f8f302019-07-24 13:30:31 +0200959 }
Ronald Cronf95a2b12020-10-22 15:24:49 +0200960
Gilles Peskine449bd832023-01-11 14:50:10 +0100961 if (psa_key_lifetime_is_external((*p_slot)->attr.lifetime)) {
Ryan Everett098c6652024-01-03 13:03:36 +0000962 psa_unregister_read(*p_slot);
Gilles Peskine449bd832023-01-11 14:50:10 +0100963 *p_slot = NULL;
964 return PSA_ERROR_NOT_SUPPORTED;
965 }
966
967 return PSA_SUCCESS;
Gilles Peskine28f8f302019-07-24 13:30:31 +0200968}
Gilles Peskine28f8f302019-07-24 13:30:31 +0200969
Gilles Peskine449bd832023-01-11 14:50:10 +0100970psa_status_t psa_remove_key_data_from_memory(psa_key_slot_t *slot)
Darryl Green40225ba2018-11-15 14:48:15 +0000971{
Gilles Peskine449bd832023-01-11 14:50:10 +0100972 if (slot->key.data != NULL) {
Tom Cosgrove52f7e182023-08-01 09:08:48 +0100973 mbedtls_zeroize_and_free(slot->key.data, slot->key.bytes);
Gilles Peskine449bd832023-01-11 14:50:10 +0100974 }
Ronald Cronea0f8a62020-11-25 17:52:23 +0100975
Ronald Cronea0f8a62020-11-25 17:52:23 +0100976 slot->key.data = NULL;
977 slot->key.bytes = 0;
Darryl Green40225ba2018-11-15 14:48:15 +0000978
Gilles Peskine449bd832023-01-11 14:50:10 +0100979 return PSA_SUCCESS;
Darryl Green40225ba2018-11-15 14:48:15 +0000980}
981
Gilles Peskinef77ed1f2018-12-03 11:58:46 +0100982/** Completely wipe a slot in memory, including its policy.
983 * Persistent storage is not affected. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100984psa_status_t psa_wipe_key_slot(psa_key_slot_t *slot)
Gilles Peskinef77ed1f2018-12-03 11:58:46 +0100985{
Gilles Peskine449bd832023-01-11 14:50:10 +0100986 psa_status_t status = psa_remove_key_data_from_memory(slot);
Ronald Cronddd3d052020-10-30 14:07:07 +0100987
Gilles Peskine449bd832023-01-11 14:50:10 +0100988 /*
989 * As the return error code may not be handled in case of multiple errors,
Ryan Everett7ed542e2024-01-17 11:39:09 +0000990 * do our best to report an unexpected amount of registered readers or
991 * an unexpected state.
992 * Assert with MBEDTLS_TEST_HOOK_TEST_ASSERT that the slot is valid for
993 * wiping.
Gilles Peskine449bd832023-01-11 14:50:10 +0100994 * if the MBEDTLS_TEST_HOOKS configuration option is enabled and the
995 * function is called as part of the execution of a test suite, the
996 * execution of the test suite is stopped in error if the assertion fails.
997 */
Ryan Everett7ed542e2024-01-17 11:39:09 +0000998 switch (slot->state) {
999 case PSA_SLOT_FULL:
1000 /* In this state psa_wipe_key_slot() must only be called if the
1001 * caller is the last reader. */
1002 case PSA_SLOT_PENDING_DELETION:
1003 /* In this state psa_wipe_key_slot() must only be called if the
1004 * caller is the last reader. */
1005 if (slot->registered_readers != 1) {
1006 MBEDTLS_TEST_HOOK_TEST_ASSERT(slot->registered_readers == 1);
1007 status = PSA_ERROR_CORRUPTION_DETECTED;
1008 }
1009 break;
1010 case PSA_SLOT_FILLING:
1011 /* In this state registered_readers must be 0. */
1012 if (slot->registered_readers != 0) {
1013 MBEDTLS_TEST_HOOK_TEST_ASSERT(slot->registered_readers == 0);
1014 status = PSA_ERROR_CORRUPTION_DETECTED;
1015 }
1016 break;
1017 case PSA_SLOT_EMPTY:
1018 /* The slot is already empty, it cannot be wiped. */
1019 MBEDTLS_TEST_HOOK_TEST_ASSERT(slot->state != PSA_SLOT_EMPTY);
1020 status = PSA_ERROR_CORRUPTION_DETECTED;
1021 break;
1022 default:
1023 /* The slot's state is invalid. */
1024 status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronddd3d052020-10-30 14:07:07 +01001025 }
1026
Gilles Peskine3f7cd622019-08-13 15:01:08 +02001027 /* Multipart operations may still be using the key. This is safe
1028 * because all multipart operation objects are independent from
1029 * the key slot: if they need to access the key after the setup
1030 * phase, they have a copy of the key. Note that this means that
1031 * key material can linger until all operations are completed. */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001032 /* At this point, key material and other type-specific content has
1033 * been wiped. Clear remaining metadata. We can call memset and not
Ryan Everettaa33c512023-12-21 17:32:07 +00001034 * zeroize because the metadata is not particularly sensitive.
1035 * This memset also sets the slot's state to PSA_SLOT_EMPTY. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001036 memset(slot, 0, sizeof(*slot));
1037 return status;
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001038}
1039
Gilles Peskine449bd832023-01-11 14:50:10 +01001040psa_status_t psa_destroy_key(mbedtls_svc_key_id_t key)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001041{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001042 psa_key_slot_t *slot;
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001043 psa_status_t status; /* status of the last operation */
1044 psa_status_t overall_status = PSA_SUCCESS;
Gilles Peskine354f7672019-07-12 23:46:38 +02001045#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1046 psa_se_drv_table_entry_t *driver;
1047#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001048
Gilles Peskine449bd832023-01-11 14:50:10 +01001049 if (mbedtls_svc_key_id_is_null(key)) {
1050 return PSA_SUCCESS;
1051 }
Gilles Peskine1841cf42019-10-08 15:48:25 +02001052
Ronald Cronf2911112020-10-29 17:51:10 +01001053 /*
Ryan Everett7ed542e2024-01-17 11:39:09 +00001054 * Get the description of the key in a key slot, and register to read it.
1055 * In the case of a persistent key, this will load the key description
1056 * from persistent memory if not done yet.
1057 * We cannot avoid this loading as without it we don't know if
Ronald Cronf2911112020-10-29 17:51:10 +01001058 * the key is operated by an SE or not and this information is needed by
Ryan Everett7ed542e2024-01-17 11:39:09 +00001059 * the current implementation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001060 status = psa_get_and_lock_key_slot(key, &slot);
1061 if (status != PSA_SUCCESS) {
1062 return status;
1063 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001064
Ryan Everett7ed542e2024-01-17 11:39:09 +00001065 /* Set the key slot containing the key description's state to
1066 * PENDING_DELETION. This stops new operations from registering
1067 * to read the slot. Current readers can safely continue to access
1068 * the key within the slot; the last registered reader will
1069 * automatically wipe the slot when they call psa_unregister_read().
1070 * If the key is persistent, we can now delete the copy of the key
1071 * from memory. If the key is opaque, we require the driver to
1072 * deal with the deletion. */
Ryan Everettc70ce572024-01-03 16:04:33 +00001073 slot->state = PSA_SLOT_PENDING_DELETION;
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)) {
Ryan Everett7ed542e2024-01-17 11:39:09 +00001121 /* Destroy the copy of the persistent key from memory.
1122 * The slot will still hold a copy of the key until the last reader
1123 * unregisters. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001124 status = psa_destroy_persistent_key(slot->attr.id);
1125 if (overall_status == PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001126 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001127 }
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001128
Gilles Peskine9ce31c42019-08-13 15:14:20 +02001129 /* TODO: other slots may have a copy of the same key. We should
1130 * invalidate them.
1131 * https://github.com/ARMmbed/mbed-crypto/issues/214
1132 */
Darryl Greend49a4992018-06-18 17:27:26 +01001133 }
1134#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
Gilles Peskine354f7672019-07-12 23:46:38 +02001135
Gilles Peskinefc762652019-07-22 19:30:34 +02001136#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001137 if (driver != NULL) {
1138 status = psa_save_se_persistent_data(driver);
1139 if (overall_status == PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001140 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001141 }
1142 status = psa_crypto_stop_transaction();
1143 if (overall_status == PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001144 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001145 }
Gilles Peskinefc762652019-07-22 19:30:34 +02001146 }
1147#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1148
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001149exit:
Ryan Everett7ed542e2024-01-17 11:39:09 +00001150 /* Unregister from reading the slot. If we are the last active reader
1151 * then this will wipe the slot. */
1152 status = psa_unregister_read(slot);
1153 /* Prioritize CORRUPTION_DETECTED from unregistering over
1154 * a storage error. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001155 if (status != PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001156 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001157 }
1158 return overall_status;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001159}
1160
Valerio Settib2bcedb2023-07-10 11:24:00 +02001161#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT) || \
John Durkop0e005192020-10-31 22:06:54 -07001162 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskineb699f072019-04-26 16:06:02 +02001163static psa_status_t psa_get_rsa_public_exponent(
1164 const mbedtls_rsa_context *rsa,
Gilles Peskine449bd832023-01-11 14:50:10 +01001165 psa_key_attributes_t *attributes)
Gilles Peskineb699f072019-04-26 16:06:02 +02001166{
1167 mbedtls_mpi mpi;
Janos Follath24eed8d2019-11-22 13:21:35 +00001168 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb699f072019-04-26 16:06:02 +02001169 uint8_t *buffer = NULL;
1170 size_t buflen;
Gilles Peskine449bd832023-01-11 14:50:10 +01001171 mbedtls_mpi_init(&mpi);
Gilles Peskineb699f072019-04-26 16:06:02 +02001172
Gilles Peskine449bd832023-01-11 14:50:10 +01001173 ret = mbedtls_rsa_export(rsa, NULL, NULL, NULL, NULL, &mpi);
1174 if (ret != 0) {
Gilles Peskineb699f072019-04-26 16:06:02 +02001175 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001176 }
1177 if (mbedtls_mpi_cmp_int(&mpi, 65537) == 0) {
Gilles Peskine772c8b12019-04-26 17:37:21 +02001178 /* It's the default value, which is reported as an empty string,
1179 * so there's nothing to do. */
1180 goto exit;
1181 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001182
Gilles Peskine449bd832023-01-11 14:50:10 +01001183 buflen = mbedtls_mpi_size(&mpi);
1184 buffer = mbedtls_calloc(1, buflen);
1185 if (buffer == NULL) {
Gilles Peskineb699f072019-04-26 16:06:02 +02001186 ret = MBEDTLS_ERR_MPI_ALLOC_FAILED;
1187 goto exit;
1188 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001189 ret = mbedtls_mpi_write_binary(&mpi, buffer, buflen);
1190 if (ret != 0) {
Gilles Peskineb699f072019-04-26 16:06:02 +02001191 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001192 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001193 attributes->domain_parameters = buffer;
1194 attributes->domain_parameters_size = buflen;
1195
1196exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01001197 mbedtls_mpi_free(&mpi);
1198 if (ret != 0) {
1199 mbedtls_free(buffer);
1200 }
1201 return mbedtls_to_psa_error(ret);
Gilles Peskineb699f072019-04-26 16:06:02 +02001202}
Valerio Settib2bcedb2023-07-10 11:24:00 +02001203#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT) ||
John Durkop9814fa22020-11-04 12:28:15 -08001204 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001205
Gilles Peskinebfd322f2019-07-23 11:58:03 +02001206/** Retrieve all the publicly-accessible attributes of a key.
1207 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001208psa_status_t psa_get_key_attributes(mbedtls_svc_key_id_t key,
1209 psa_key_attributes_t *attributes)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001210{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001211 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001212 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001213 psa_key_slot_t *slot;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001214
Gilles Peskine449bd832023-01-11 14:50:10 +01001215 psa_reset_key_attributes(attributes);
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001216
Gilles Peskine449bd832023-01-11 14:50:10 +01001217 status = psa_get_and_lock_key_slot_with_policy(key, &slot, 0, 0);
1218 if (status != PSA_SUCCESS) {
1219 return status;
1220 }
Gilles Peskineb870b182018-07-06 16:02:09 +02001221
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001222 attributes->core = slot->attr;
Gilles Peskine449bd832023-01-11 14:50:10 +01001223 attributes->core.flags &= (MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1224 MBEDTLS_PSA_KA_MASK_DUAL_USE);
Gilles Peskinec8000c02019-08-02 20:15:51 +02001225
1226#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001227 if (psa_get_se_driver_entry(slot->attr.lifetime) != NULL) {
1228 psa_set_key_slot_number(attributes,
1229 psa_key_slot_get_slot_number(slot));
1230 }
Gilles Peskinec8000c02019-08-02 20:15:51 +02001231#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineb699f072019-04-26 16:06:02 +02001232
Gilles Peskine449bd832023-01-11 14:50:10 +01001233 switch (slot->attr.type) {
Valerio Settib2bcedb2023-07-10 11:24:00 +02001234#if (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) && \
1235 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) || \
John Durkop0e005192020-10-31 22:06:54 -07001236 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02001237 case PSA_KEY_TYPE_RSA_KEY_PAIR:
Gilles Peskineb699f072019-04-26 16:06:02 +02001238 case PSA_KEY_TYPE_RSA_PUBLIC_KEY:
Pengyu Lvf75893b2023-12-08 17:21:39 +08001239 /* TODO: This is a temporary situation where domain parameters are deprecated,
1240 * but we need it for namely generating an RSA key with a non-default exponent.
1241 * This would be improved after https://github.com/Mbed-TLS/mbedtls/issues/6494.
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001242 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001243 if (!psa_key_lifetime_is_external(slot->attr.lifetime)) {
Steven Cooremana2371e52020-07-28 14:30:39 +02001244 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02001245
Ronald Cron90857082020-11-25 14:58:33 +01001246 status = mbedtls_psa_rsa_load_representation(
Gilles Peskine449bd832023-01-11 14:50:10 +01001247 slot->attr.type,
1248 slot->key.data,
1249 slot->key.bytes,
1250 &rsa);
1251 if (status != PSA_SUCCESS) {
Steven Cooremana01795d2020-07-24 22:48:15 +02001252 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01001253 }
Steven Cooremana01795d2020-07-24 22:48:15 +02001254
Gilles Peskine449bd832023-01-11 14:50:10 +01001255 status = psa_get_rsa_public_exponent(rsa,
1256 attributes);
1257 mbedtls_rsa_free(rsa);
1258 mbedtls_free(rsa);
Steven Cooremana01795d2020-07-24 22:48:15 +02001259 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001260 break;
Pengyu Lve9efbc22023-12-08 16:59:08 +08001261#else
1262 case PSA_KEY_TYPE_RSA_KEY_PAIR:
1263 case PSA_KEY_TYPE_RSA_PUBLIC_KEY:
1264 attributes->domain_parameters = NULL;
1265 attributes->domain_parameters_size = SIZE_MAX;
1266 break;
Valerio Settib2bcedb2023-07-10 11:24:00 +02001267#endif /* (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) && \
1268 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) ||
John Durkop9814fa22020-11-04 12:28:15 -08001269 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001270 default:
1271 /* Nothing else to do. */
1272 break;
1273 }
1274
Gilles Peskine449bd832023-01-11 14:50:10 +01001275 if (status != PSA_SUCCESS) {
1276 psa_reset_key_attributes(attributes);
1277 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001278
Ryan Everett1b70a072024-01-04 10:32:49 +00001279 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02001280
Gilles Peskine449bd832023-01-11 14:50:10 +01001281 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001282}
1283
Gilles Peskinec8000c02019-08-02 20:15:51 +02001284#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1285psa_status_t psa_get_key_slot_number(
1286 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01001287 psa_key_slot_number_t *slot_number)
Gilles Peskinec8000c02019-08-02 20:15:51 +02001288{
Gilles Peskine449bd832023-01-11 14:50:10 +01001289 if (attributes->core.flags & MBEDTLS_PSA_KA_FLAG_HAS_SLOT_NUMBER) {
Gilles Peskinec8000c02019-08-02 20:15:51 +02001290 *slot_number = attributes->slot_number;
Gilles Peskine449bd832023-01-11 14:50:10 +01001291 return PSA_SUCCESS;
1292 } else {
1293 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinec8000c02019-08-02 20:15:51 +02001294 }
Gilles Peskinec8000c02019-08-02 20:15:51 +02001295}
1296#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1297
Gilles Peskine449bd832023-01-11 14:50:10 +01001298static psa_status_t psa_export_key_buffer_internal(const uint8_t *key_buffer,
1299 size_t key_buffer_size,
1300 uint8_t *data,
1301 size_t data_size,
1302 size_t *data_length)
Steven Cooremana01795d2020-07-24 22:48:15 +02001303{
Gilles Peskine449bd832023-01-11 14:50:10 +01001304 if (key_buffer_size > data_size) {
1305 return PSA_ERROR_BUFFER_TOO_SMALL;
1306 }
1307 memcpy(data, key_buffer, key_buffer_size);
1308 memset(data + key_buffer_size, 0,
1309 data_size - key_buffer_size);
Ronald Crond18b5f82020-11-25 16:46:05 +01001310 *data_length = key_buffer_size;
Gilles Peskine449bd832023-01-11 14:50:10 +01001311 return PSA_SUCCESS;
Steven Cooremana01795d2020-07-24 22:48:15 +02001312}
1313
Ronald Cron7285cda2020-11-26 14:46:37 +01001314psa_status_t psa_export_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001315 const psa_key_attributes_t *attributes,
1316 const uint8_t *key_buffer, size_t key_buffer_size,
Gilles Peskine449bd832023-01-11 14:50:10 +01001317 uint8_t *data, size_t data_size, size_t *data_length)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001318{
Ronald Crond18b5f82020-11-25 16:46:05 +01001319 psa_key_type_t type = attributes->core.type;
1320
Gilles Peskine449bd832023-01-11 14:50:10 +01001321 if (key_type_is_raw_bytes(type) ||
1322 PSA_KEY_TYPE_IS_RSA(type) ||
Przemek Stekiel472b3f32022-12-01 14:38:49 +01001323 PSA_KEY_TYPE_IS_ECC(type) ||
1324 PSA_KEY_TYPE_IS_DH(type)) {
Gilles Peskine449bd832023-01-11 14:50:10 +01001325 return psa_export_key_buffer_internal(
1326 key_buffer, key_buffer_size,
1327 data, data_size, data_length);
1328 } else {
Ronald Cron9486f9d2020-11-26 13:36:23 +01001329 /* This shouldn't happen in the reference implementation, but
1330 it is valid for a special-purpose implementation to omit
1331 support for exporting certain key types. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001332 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron9486f9d2020-11-26 13:36:23 +01001333 }
1334}
1335
Gilles Peskine449bd832023-01-11 14:50:10 +01001336psa_status_t psa_export_key(mbedtls_svc_key_id_t key,
1337 uint8_t *data,
1338 size_t data_size,
1339 size_t *data_length)
Ronald Cron9486f9d2020-11-26 13:36:23 +01001340{
1341 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
1342 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
1343 psa_key_slot_t *slot;
1344
Ronald Crone907e552021-01-18 13:22:38 +01001345 /* Reject a zero-length output buffer now, since this can never be a
1346 * valid key representation. This way we know that data must be a valid
1347 * pointer and we can do things like memset(data, ..., data_size). */
Gilles Peskine449bd832023-01-11 14:50:10 +01001348 if (data_size == 0) {
1349 return PSA_ERROR_BUFFER_TOO_SMALL;
1350 }
Ronald Crone907e552021-01-18 13:22:38 +01001351
Ronald Cron9486f9d2020-11-26 13:36:23 +01001352 /* Set the key to empty now, so that even when there are errors, we always
1353 * set data_length to a value between 0 and data_size. On error, setting
1354 * the key to empty is a good choice because an empty key representation is
1355 * unlikely to be accepted anywhere. */
Jaeden Amerof24c7f82018-06-27 17:20:43 +01001356 *data_length = 0;
1357
Ronald Cron9486f9d2020-11-26 13:36:23 +01001358 /* Export requires the EXPORT flag. There is an exception for public keys,
1359 * which don't require any flag, but
1360 * psa_get_and_lock_key_slot_with_policy() takes care of this.
1361 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001362 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
1363 PSA_KEY_USAGE_EXPORT, 0);
1364 if (status != PSA_SUCCESS) {
1365 return status;
1366 }
mohammad160306e79202018-03-28 13:17:44 +03001367
Ronald Crond18b5f82020-11-25 16:46:05 +01001368 psa_key_attributes_t attributes = {
1369 .core = slot->attr
1370 };
Gilles Peskine449bd832023-01-11 14:50:10 +01001371 status = psa_driver_wrapper_export_key(&attributes,
1372 slot->key.data, slot->key.bytes,
1373 data, data_size, data_length);
Ronald Cron9486f9d2020-11-26 13:36:23 +01001374
Ryan Everett1b70a072024-01-04 10:32:49 +00001375 unlock_status = psa_unregister_read(slot);
Ronald Cron9486f9d2020-11-26 13:36:23 +01001376
Gilles Peskine449bd832023-01-11 14:50:10 +01001377 return (status == PSA_SUCCESS) ? unlock_status : status;
Ronald Cron9486f9d2020-11-26 13:36:23 +01001378}
1379
Ronald Cron7285cda2020-11-26 14:46:37 +01001380psa_status_t psa_export_public_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001381 const psa_key_attributes_t *attributes,
1382 const uint8_t *key_buffer,
1383 size_t key_buffer_size,
1384 uint8_t *data,
1385 size_t data_size,
Gilles Peskine449bd832023-01-11 14:50:10 +01001386 size_t *data_length)
Ronald Cron9486f9d2020-11-26 13:36:23 +01001387{
Ronald Crond18b5f82020-11-25 16:46:05 +01001388 psa_key_type_t type = attributes->core.type;
Ronald Crond18b5f82020-11-25 16:46:05 +01001389
Przemek Stekiel6fd72b62023-04-27 10:20:56 +02001390 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(type) &&
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001391 (PSA_KEY_TYPE_IS_RSA(type) || PSA_KEY_TYPE_IS_ECC(type) ||
1392 PSA_KEY_TYPE_IS_DH(type))) {
Przemek Stekiel6fd72b62023-04-27 10:20:56 +02001393 /* Exporting public -> public */
1394 return psa_export_key_buffer_internal(
1395 key_buffer, key_buffer_size,
1396 data, data_size, data_length);
1397 } else if (PSA_KEY_TYPE_IS_RSA(type)) {
Valerio Settib2bcedb2023-07-10 11:24:00 +02001398#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT) || \
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001399 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
1400 return mbedtls_psa_rsa_export_public_key(attributes,
1401 key_buffer,
1402 key_buffer_size,
1403 data,
1404 data_size,
1405 data_length);
Darryl Green9e2d7a02018-07-24 16:33:30 +01001406#else
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001407 /* We don't know how to convert a private RSA key to public. */
1408 return PSA_ERROR_NOT_SUPPORTED;
Valerio Settib2bcedb2023-07-10 11:24:00 +02001409#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT) ||
John Durkop9814fa22020-11-04 12:28:15 -08001410 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Przemek Stekiel6fd72b62023-04-27 10:20:56 +02001411 } else if (PSA_KEY_TYPE_IS_ECC(type)) {
Valerio Setti27c501a2023-06-27 16:58:52 +02001412#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_EXPORT) || \
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001413 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
1414 return mbedtls_psa_ecp_export_public_key(attributes,
1415 key_buffer,
1416 key_buffer_size,
1417 data,
1418 data_size,
1419 data_length);
Steven Cooreman560c28a2020-07-24 23:20:24 +02001420#else
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001421 /* We don't know how to convert a private ECC key to public */
1422 return PSA_ERROR_NOT_SUPPORTED;
Valerio Setti27c501a2023-06-27 16:58:52 +02001423#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_EXPORT) ||
John Durkop9814fa22020-11-04 12:28:15 -08001424 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
Przemek Stekiel6fd72b62023-04-27 10:20:56 +02001425 } else if (PSA_KEY_TYPE_IS_DH(type)) {
Valerio Settia55f0422023-07-10 15:34:41 +02001426#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_EXPORT) || \
Przemek Stekiel6d85afa2023-04-28 11:42:17 +02001427 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY)
Przemek Stekiel152bb462023-06-01 11:52:39 +02001428 return mbedtls_psa_ffdh_export_public_key(attributes,
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001429 key_buffer,
1430 key_buffer_size,
1431 data, data_size,
1432 data_length);
Przemek Stekiel472b3f32022-12-01 14:38:49 +01001433#else
Przemek Stekiel472b3f32022-12-01 14:38:49 +01001434 return PSA_ERROR_NOT_SUPPORTED;
Valerio Settia55f0422023-07-10 15:34:41 +02001435#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_EXPORT) ||
Przemek Stekiel6d85afa2023-04-28 11:42:17 +02001436 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY) */
Gilles Peskine449bd832023-01-11 14:50:10 +01001437 } else {
Przemek Stekiel0b11ee02023-05-16 13:26:06 +02001438 (void) key_buffer;
1439 (void) key_buffer_size;
1440 (void) data;
1441 (void) data_size;
1442 (void) data_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01001443 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman560c28a2020-07-24 23:20:24 +02001444 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001445}
Ronald Crond18b5f82020-11-25 16:46:05 +01001446
Gilles Peskine449bd832023-01-11 14:50:10 +01001447psa_status_t psa_export_public_key(mbedtls_svc_key_id_t key,
1448 uint8_t *data,
1449 size_t data_size,
1450 size_t *data_length)
Moran Pekerdd4ea382018-04-03 15:30:03 +03001451{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001452 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001453 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001454 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01001455 psa_key_attributes_t attributes;
Darryl Greendd8fb772018-11-07 16:00:44 +00001456
Ronald Crone907e552021-01-18 13:22:38 +01001457 /* Reject a zero-length output buffer now, since this can never be a
1458 * valid key representation. This way we know that data must be a valid
1459 * pointer and we can do things like memset(data, ..., data_size). */
Gilles Peskine449bd832023-01-11 14:50:10 +01001460 if (data_size == 0) {
1461 return PSA_ERROR_BUFFER_TOO_SMALL;
1462 }
Ronald Crone907e552021-01-18 13:22:38 +01001463
Darryl Greendd8fb772018-11-07 16:00:44 +00001464 /* Set the key to empty now, so that even when there are errors, we always
1465 * set data_length to a value between 0 and data_size. On error, setting
1466 * the key to empty is a good choice because an empty key representation is
1467 * unlikely to be accepted anywhere. */
1468 *data_length = 0;
1469
1470 /* Exporting a public key doesn't require a usage flag. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001471 status = psa_get_and_lock_key_slot_with_policy(key, &slot, 0, 0);
1472 if (status != PSA_SUCCESS) {
1473 return status;
1474 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001475
Gilles Peskine449bd832023-01-11 14:50:10 +01001476 if (!PSA_KEY_TYPE_IS_ASYMMETRIC(slot->attr.type)) {
1477 status = PSA_ERROR_INVALID_ARGUMENT;
1478 goto exit;
Ronald Cron9486f9d2020-11-26 13:36:23 +01001479 }
1480
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01001481 attributes = (psa_key_attributes_t) {
Ronald Crond18b5f82020-11-25 16:46:05 +01001482 .core = slot->attr
1483 };
Ronald Cron67227982020-11-26 15:16:05 +01001484 status = psa_driver_wrapper_export_public_key(
Ronald Crond18b5f82020-11-25 16:46:05 +01001485 &attributes, slot->key.data, slot->key.bytes,
Gilles Peskine449bd832023-01-11 14:50:10 +01001486 data, data_size, data_length);
Ronald Cron9486f9d2020-11-26 13:36:23 +01001487
1488exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00001489 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02001490
Gilles Peskine449bd832023-01-11 14:50:10 +01001491 return (status == PSA_SUCCESS) ? unlock_status : status;
Moran Pekerdd4ea382018-04-03 15:30:03 +03001492}
1493
Tom Cosgrove6ef9bb32023-03-08 14:19:51 +00001494MBEDTLS_STATIC_ASSERT(
1495 (MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE) == 0,
1496 "One or more key attribute flag is listed as both external-only and dual-use")
1497MBEDTLS_STATIC_ASSERT(
1498 (PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE) == 0,
1499 "One or more key attribute flag is listed as both internal-only and dual-use")
1500MBEDTLS_STATIC_ASSERT(
1501 (PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY) == 0,
1502 "One or more key attribute flag is listed as both internal-only and external-only")
Gilles Peskine91e8c332019-08-02 19:19:39 +02001503
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001504/** Validate that a key policy is internally well-formed.
1505 *
1506 * This function only rejects invalid policies. It does not validate the
1507 * consistency of the policy with respect to other attributes of the key
1508 * such as the key type.
1509 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001510static psa_status_t psa_validate_key_policy(const psa_key_policy_t *policy)
Gilles Peskine4747d192019-04-17 15:05:45 +02001511{
Gilles Peskine449bd832023-01-11 14:50:10 +01001512 if ((policy->usage & ~(PSA_KEY_USAGE_EXPORT |
1513 PSA_KEY_USAGE_COPY |
1514 PSA_KEY_USAGE_ENCRYPT |
1515 PSA_KEY_USAGE_DECRYPT |
1516 PSA_KEY_USAGE_SIGN_MESSAGE |
1517 PSA_KEY_USAGE_VERIFY_MESSAGE |
1518 PSA_KEY_USAGE_SIGN_HASH |
1519 PSA_KEY_USAGE_VERIFY_HASH |
1520 PSA_KEY_USAGE_VERIFY_DERIVATION |
1521 PSA_KEY_USAGE_DERIVE)) != 0) {
1522 return PSA_ERROR_INVALID_ARGUMENT;
1523 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001524
Gilles Peskine449bd832023-01-11 14:50:10 +01001525 return PSA_SUCCESS;
Gilles Peskine4747d192019-04-17 15:05:45 +02001526}
1527
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001528/** Validate the internal consistency of key attributes.
1529 *
1530 * This function only rejects invalid attribute values. If does not
1531 * validate the consistency of the attributes with any key data that may
1532 * be involved in the creation of the key.
1533 *
1534 * Call this function early in the key creation process.
1535 *
1536 * \param[in] attributes Key attributes for the new key.
1537 * \param[out] p_drv On any return, the driver for the key, if any.
1538 * NULL for a transparent key.
1539 *
1540 */
1541static psa_status_t psa_validate_key_attributes(
1542 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01001543 psa_se_drv_table_entry_t **p_drv)
Darryl Green0c6575a2018-11-07 16:05:30 +00001544{
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001545 psa_status_t status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine449bd832023-01-11 14:50:10 +01001546 psa_key_lifetime_t lifetime = psa_get_key_lifetime(attributes);
1547 mbedtls_svc_key_id_t key = psa_get_key_id(attributes);
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001548
Gilles Peskine449bd832023-01-11 14:50:10 +01001549 status = psa_validate_key_location(lifetime, p_drv);
1550 if (status != PSA_SUCCESS) {
1551 return status;
Ronald Crond2ed4812020-07-17 16:11:30 +02001552 }
1553
Gilles Peskine449bd832023-01-11 14:50:10 +01001554 status = psa_validate_key_persistence(lifetime);
1555 if (status != PSA_SUCCESS) {
1556 return status;
1557 }
1558
1559 if (PSA_KEY_LIFETIME_IS_VOLATILE(lifetime)) {
1560 if (MBEDTLS_SVC_KEY_ID_GET_KEY_ID(key) != 0) {
1561 return PSA_ERROR_INVALID_ARGUMENT;
1562 }
1563 } else {
1564 if (!psa_is_valid_key_id(psa_get_key_id(attributes), 0)) {
1565 return PSA_ERROR_INVALID_ARGUMENT;
1566 }
1567 }
1568
1569 status = psa_validate_key_policy(&attributes->core.policy);
1570 if (status != PSA_SUCCESS) {
1571 return status;
1572 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001573
1574 /* Refuse to create overly large keys.
1575 * Note that this doesn't trigger on import if the attributes don't
1576 * explicitly specify a size (so psa_get_key_bits returns 0), so
1577 * psa_import_key() needs its own checks. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001578 if (psa_get_key_bits(attributes) > PSA_MAX_KEY_BITS) {
1579 return PSA_ERROR_NOT_SUPPORTED;
1580 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001581
Gilles Peskine91e8c332019-08-02 19:19:39 +02001582 /* Reject invalid flags. These should not be reachable through the API. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001583 if (attributes->core.flags & ~(MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1584 MBEDTLS_PSA_KA_MASK_DUAL_USE)) {
1585 return PSA_ERROR_INVALID_ARGUMENT;
1586 }
Gilles Peskine91e8c332019-08-02 19:19:39 +02001587
Gilles Peskine449bd832023-01-11 14:50:10 +01001588 return PSA_SUCCESS;
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001589}
1590
Gilles Peskine4747d192019-04-17 15:05:45 +02001591/** Prepare a key slot to receive key material.
1592 *
1593 * This function allocates a key slot and sets its metadata.
1594 *
1595 * If this function fails, call psa_fail_key_creation().
1596 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001597 * This function is intended to be used as follows:
1598 * -# Call psa_start_key_creation() to allocate a key slot, prepare
Ronald Croncf56a0a2020-08-04 09:51:30 +02001599 * it with the specified attributes, and in case of a volatile key assign it
1600 * a volatile key identifier.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001601 * -# Populate the slot with the key material.
1602 * -# Call psa_finish_key_creation() to finalize the creation of the slot.
1603 * In case of failure at any step, stop the sequence and call
1604 * psa_fail_key_creation().
1605 *
Ryan Everettb69118e2024-01-02 15:54:32 +00001606 * On success, the key slot's state is PSA_SLOT_FILLING.
1607 * It is the responsibility of the caller to change the slot's state to
1608 * PSA_SLOT_EMPTY/FULL once key creation has finished.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001609 *
Gilles Peskinedf179142019-07-15 22:02:14 +02001610 * \param method An identification of the calling function.
Gilles Peskine011e4282019-06-26 18:34:38 +02001611 * \param[in] attributes Key attributes for the new key.
Gilles Peskine011e4282019-06-26 18:34:38 +02001612 * \param[out] p_slot On success, a pointer to the prepared slot.
1613 * \param[out] p_drv On any return, the driver for the key, if any.
1614 * NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001615 *
1616 * \retval #PSA_SUCCESS
1617 * The key slot is ready to receive key material.
1618 * \return If this function fails, the key slot is an invalid state.
1619 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001620 */
1621static psa_status_t psa_start_key_creation(
Gilles Peskinedf179142019-07-15 22:02:14 +02001622 psa_key_creation_method_t method,
Gilles Peskine4747d192019-04-17 15:05:45 +02001623 const psa_key_attributes_t *attributes,
Gilles Peskine011e4282019-06-26 18:34:38 +02001624 psa_key_slot_t **p_slot,
Gilles Peskine449bd832023-01-11 14:50:10 +01001625 psa_se_drv_table_entry_t **p_drv)
Gilles Peskine4747d192019-04-17 15:05:45 +02001626{
1627 psa_status_t status;
Ronald Cron2a993152020-07-17 14:13:26 +02001628 psa_key_id_t volatile_key_id;
Gilles Peskine4747d192019-04-17 15:05:45 +02001629 psa_key_slot_t *slot;
1630
Gilles Peskinedf179142019-07-15 22:02:14 +02001631 (void) method;
Gilles Peskine011e4282019-06-26 18:34:38 +02001632 *p_drv = NULL;
1633
Gilles Peskine449bd832023-01-11 14:50:10 +01001634 status = psa_validate_key_attributes(attributes, p_drv);
1635 if (status != PSA_SUCCESS) {
1636 return status;
1637 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001638
Ryan Everettb69118e2024-01-02 15:54:32 +00001639 status = psa_reserve_free_key_slot(&volatile_key_id, p_slot);
Gilles Peskine449bd832023-01-11 14:50:10 +01001640 if (status != PSA_SUCCESS) {
1641 return status;
1642 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001643 slot = *p_slot;
1644
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001645 /* We're storing the declared bit-size of the key. It's up to each
1646 * creation mechanism to verify that this information is correct.
1647 * It's automatically correct for mechanisms that use the bit-size as
Gilles Peskineb46bef22019-07-30 21:32:04 +02001648 * an input (generate, device) but not for those where the bit-size
Ronald Cronc4d1b512020-07-31 11:26:37 +02001649 * is optional (import, copy). In case of a volatile key, assign it the
1650 * volatile key identifier associated to the slot returned to contain its
1651 * definition. */
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001652
1653 slot->attr = attributes->core;
Gilles Peskine449bd832023-01-11 14:50:10 +01001654 if (PSA_KEY_LIFETIME_IS_VOLATILE(slot->attr.lifetime)) {
Ronald Cronc4d1b512020-07-31 11:26:37 +02001655#if !defined(MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER)
1656 slot->attr.id = volatile_key_id;
1657#else
1658 slot->attr.id.key_id = volatile_key_id;
1659#endif
1660 }
Gilles Peskinec744d992019-07-30 17:26:54 +02001661
Gilles Peskine91e8c332019-08-02 19:19:39 +02001662 /* Erase external-only flags from the internal copy. To access
Gilles Peskine013f5472019-08-07 15:42:14 +02001663 * external-only flags, query `attributes`. Thanks to the check
1664 * in psa_validate_key_attributes(), this leaves the dual-use
Ryan Everettb69118e2024-01-02 15:54:32 +00001665 * flags and any internal flag that psa_reserve_free_key_slot()
Gilles Peskine013f5472019-08-07 15:42:14 +02001666 * may have set. */
1667 slot->attr.flags &= ~MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY;
Gilles Peskine91e8c332019-08-02 19:19:39 +02001668
Gilles Peskinecbaff462019-07-12 23:46:04 +02001669#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001670 /* For a key in a secure element, we need to do three things
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001671 * when creating or registering a persistent key:
Gilles Peskine60450a42019-07-25 11:32:45 +02001672 * create the key file in internal storage, create the
1673 * key inside the secure element, and update the driver's
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001674 * persistent data. This is done by starting a transaction that will
1675 * encompass these three actions.
1676 * For registering a volatile key, we just need to find an appropriate
1677 * slot number inside the SE. Since the key is designated volatile, creating
1678 * a transaction is not required. */
Gilles Peskine60450a42019-07-25 11:32:45 +02001679 /* The first thing to do is to find a slot number for the new key.
1680 * We save the slot number in persistent storage as part of the
1681 * transaction data. It will be needed to recover if the power
1682 * fails during the key creation process, to clean up on the secure
1683 * element side after restarting. Obtaining a slot number from the
1684 * secure element driver updates its persistent state, but we do not yet
1685 * save the driver's persistent state, so that if the power fails,
Gilles Peskinefc762652019-07-22 19:30:34 +02001686 * we can roll back to a state where the key doesn't exist. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001687 if (*p_drv != NULL) {
Ronald Cronea0f8a62020-11-25 17:52:23 +01001688 psa_key_slot_number_t slot_number;
Gilles Peskine449bd832023-01-11 14:50:10 +01001689 status = psa_find_se_slot_for_key(attributes, method, *p_drv,
1690 &slot_number);
1691 if (status != PSA_SUCCESS) {
1692 return status;
1693 }
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001694
Gilles Peskine449bd832023-01-11 14:50:10 +01001695 if (!PSA_KEY_LIFETIME_IS_VOLATILE(attributes->core.lifetime)) {
1696 psa_crypto_prepare_transaction(PSA_CRYPTO_TRANSACTION_CREATE_KEY);
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001697 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001698 psa_crypto_transaction.key.slot = slot_number;
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001699 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskine449bd832023-01-11 14:50:10 +01001700 status = psa_crypto_save_transaction();
1701 if (status != PSA_SUCCESS) {
1702 (void) psa_crypto_stop_transaction();
1703 return status;
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001704 }
Gilles Peskine66be51c2019-07-25 18:02:52 +02001705 }
Ronald Cronea0f8a62020-11-25 17:52:23 +01001706
1707 status = psa_copy_key_material_into_slot(
Gilles Peskine449bd832023-01-11 14:50:10 +01001708 slot, (uint8_t *) (&slot_number), sizeof(slot_number));
Darryl Green0c6575a2018-11-07 16:05:30 +00001709 }
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001710
Gilles Peskine449bd832023-01-11 14:50:10 +01001711 if (*p_drv == NULL && method == PSA_KEY_CREATION_REGISTER) {
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001712 /* Key registration only makes sense with a secure element. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001713 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001714 }
Gilles Peskinecbaff462019-07-12 23:46:04 +02001715#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1716
Gilles Peskine449bd832023-01-11 14:50:10 +01001717 return PSA_SUCCESS;
Darryl Green0c6575a2018-11-07 16:05:30 +00001718}
Gilles Peskine4747d192019-04-17 15:05:45 +02001719
1720/** Finalize the creation of a key once its key material has been set.
1721 *
1722 * This entails writing the key to persistent storage.
1723 *
1724 * If this function fails, call psa_fail_key_creation().
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001725 * See the documentation of psa_start_key_creation() for the intended use
1726 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001727 *
Ryan Everettb69118e2024-01-02 15:54:32 +00001728 * If the finalization succeeds, the function sets the key slot's state to
1729 * PSA_SLOT_FULL, and the key slot can no longer be accessed as part of the
1730 * key creation process.
Ronald Cron50972942020-11-14 11:28:25 +01001731 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001732 * \param[in,out] slot Pointer to the slot with key material.
1733 * \param[in] driver The secure element driver for the key,
1734 * or NULL for a transparent key.
Ronald Cron81709fc2020-11-14 12:10:32 +01001735 * \param[out] key On success, identifier of the key. Note that the
1736 * key identifier is also stored in the key slot.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001737 *
1738 * \retval #PSA_SUCCESS
Ronald Croncf56a0a2020-08-04 09:51:30 +02001739 * The key was successfully created.
Gilles Peskineed733552023-02-14 19:21:09 +01001740 * \retval #PSA_ERROR_INSUFFICIENT_MEMORY \emptydescription
1741 * \retval #PSA_ERROR_INSUFFICIENT_STORAGE \emptydescription
1742 * \retval #PSA_ERROR_ALREADY_EXISTS \emptydescription
1743 * \retval #PSA_ERROR_DATA_INVALID \emptydescription
1744 * \retval #PSA_ERROR_DATA_CORRUPT \emptydescription
1745 * \retval #PSA_ERROR_STORAGE_FAILURE \emptydescription
gabor-mezei-arm452b0a32020-11-09 17:42:55 +01001746 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001747 * \return If this function fails, the key slot is an invalid state.
1748 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001749 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001750static psa_status_t psa_finish_key_creation(
1751 psa_key_slot_t *slot,
Ronald Cron81709fc2020-11-14 12:10:32 +01001752 psa_se_drv_table_entry_t *driver,
1753 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02001754{
1755 psa_status_t status = PSA_SUCCESS;
Gilles Peskine30afafd2019-04-25 13:47:40 +02001756 (void) slot;
Gilles Peskine011e4282019-06-26 18:34:38 +02001757 (void) driver;
Gilles Peskine4747d192019-04-17 15:05:45 +02001758
1759#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001760 if (!PSA_KEY_LIFETIME_IS_VOLATILE(slot->attr.lifetime)) {
Gilles Peskine1df83d42019-07-23 16:13:14 +02001761#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001762 if (driver != NULL) {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001763 psa_se_key_data_storage_t data;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001764 psa_key_slot_number_t slot_number =
Gilles Peskine449bd832023-01-11 14:50:10 +01001765 psa_key_slot_get_slot_number(slot);
Ronald Cronea0f8a62020-11-25 17:52:23 +01001766
Tom Cosgrove6ef9bb32023-03-08 14:19:51 +00001767 MBEDTLS_STATIC_ASSERT(sizeof(slot_number) ==
1768 sizeof(data.slot_number),
1769 "Slot number size does not match psa_se_key_data_storage_t");
1770
Gilles Peskine449bd832023-01-11 14:50:10 +01001771 memcpy(&data.slot_number, &slot_number, sizeof(slot_number));
1772 status = psa_save_persistent_key(&slot->attr,
1773 (uint8_t *) &data,
1774 sizeof(data));
1775 } else
Gilles Peskine1df83d42019-07-23 16:13:14 +02001776#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1777 {
Steven Cooreman40120f62020-10-29 11:42:22 +01001778 /* Key material is saved in export representation in the slot, so
1779 * just pass the slot buffer for storage. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001780 status = psa_save_persistent_key(&slot->attr,
1781 slot->key.data,
1782 slot->key.bytes);
Gilles Peskine1df83d42019-07-23 16:13:14 +02001783 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001784 }
Darryl Green0c6575a2018-11-07 16:05:30 +00001785#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
1786
Gilles Peskinecbaff462019-07-12 23:46:04 +02001787#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001788 /* Finish the transaction for a key creation. This does not
1789 * happen when registering an existing key. Detect this case
1790 * by checking whether a transaction is in progress (actual
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001791 * creation of a persistent key in a secure element requires a transaction,
1792 * but registration or volatile key creation doesn't use one). */
Gilles Peskine449bd832023-01-11 14:50:10 +01001793 if (driver != NULL &&
1794 psa_crypto_transaction.unknown.type == PSA_CRYPTO_TRANSACTION_CREATE_KEY) {
1795 status = psa_save_se_persistent_data(driver);
1796 if (status != PSA_SUCCESS) {
1797 psa_destroy_persistent_key(slot->attr.id);
1798 return status;
Gilles Peskinecbaff462019-07-12 23:46:04 +02001799 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001800 status = psa_crypto_stop_transaction();
Gilles Peskinecbaff462019-07-12 23:46:04 +02001801 }
1802#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1803
Gilles Peskine449bd832023-01-11 14:50:10 +01001804 if (status == PSA_SUCCESS) {
Ronald Cron81709fc2020-11-14 12:10:32 +01001805 *key = slot->attr.id;
Ryan Everettb69118e2024-01-02 15:54:32 +00001806 status = psa_key_slot_state_transition(slot, PSA_SLOT_FILLING,
1807 PSA_SLOT_FULL);
Gilles Peskine449bd832023-01-11 14:50:10 +01001808 if (status != PSA_SUCCESS) {
Ronald Cron81709fc2020-11-14 12:10:32 +01001809 *key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01001810 }
Ronald Cron81709fc2020-11-14 12:10:32 +01001811 }
Ronald Cron50972942020-11-14 11:28:25 +01001812
Gilles Peskine449bd832023-01-11 14:50:10 +01001813 return status;
Gilles Peskine4747d192019-04-17 15:05:45 +02001814}
1815
1816/** Abort the creation of a key.
1817 *
1818 * You may call this function after calling psa_start_key_creation(),
1819 * or after psa_finish_key_creation() fails. In other circumstances, this
1820 * function may not clean up persistent storage.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001821 * See the documentation of psa_start_key_creation() for the intended use
Ryan Everettb69118e2024-01-02 15:54:32 +00001822 * of this function. Sets the slot's state to PSA_SLOT_EMPTY.
Gilles Peskine4747d192019-04-17 15:05:45 +02001823 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001824 * \param[in,out] slot Pointer to the slot with key material.
1825 * \param[in] driver The secure element driver for the key,
1826 * or NULL for a transparent key.
Gilles Peskine4747d192019-04-17 15:05:45 +02001827 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001828static void psa_fail_key_creation(psa_key_slot_t *slot,
1829 psa_se_drv_table_entry_t *driver)
Gilles Peskine4747d192019-04-17 15:05:45 +02001830{
Gilles Peskine011e4282019-06-26 18:34:38 +02001831 (void) driver;
1832
Gilles Peskine449bd832023-01-11 14:50:10 +01001833 if (slot == NULL) {
Gilles Peskine4747d192019-04-17 15:05:45 +02001834 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01001835 }
Gilles Peskine011e4282019-06-26 18:34:38 +02001836
1837#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001838 /* TODO: If the key has already been created in the secure
Gilles Peskine011e4282019-06-26 18:34:38 +02001839 * element, and the failure happened later (when saving metadata
1840 * to internal storage), we need to destroy the key in the secure
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001841 * element.
1842 * https://github.com/ARMmbed/mbed-crypto/issues/217
1843 */
Gilles Peskinefc762652019-07-22 19:30:34 +02001844
Gilles Peskined7729582019-08-05 15:55:54 +02001845 /* Abort the ongoing transaction if any (there may not be one if
1846 * the creation process failed before starting one, or if the
1847 * key creation is a registration of a key in a secure element).
1848 * Earlier functions must already have done what it takes to undo any
1849 * partial creation. All that's left is to update the transaction data
1850 * itself. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001851 (void) psa_crypto_stop_transaction();
Gilles Peskine011e4282019-06-26 18:34:38 +02001852#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Ryan Everett7ed542e2024-01-17 11:39:09 +00001853
Gilles Peskine449bd832023-01-11 14:50:10 +01001854 psa_wipe_key_slot(slot);
Gilles Peskine4747d192019-04-17 15:05:45 +02001855}
1856
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001857/** Validate optional attributes during key creation.
1858 *
1859 * Some key attributes are optional during key creation. If they are
1860 * specified in the attributes structure, check that they are consistent
1861 * with the data in the slot.
1862 *
1863 * This function should be called near the end of key creation, after
1864 * the slot in memory is fully populated but before saving persistent data.
1865 */
1866static psa_status_t psa_validate_optional_attributes(
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001867 const psa_key_slot_t *slot,
Gilles Peskine449bd832023-01-11 14:50:10 +01001868 const psa_key_attributes_t *attributes)
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001869{
Gilles Peskine449bd832023-01-11 14:50:10 +01001870 if (attributes->core.type != 0) {
1871 if (attributes->core.type != slot->attr.type) {
1872 return PSA_ERROR_INVALID_ARGUMENT;
1873 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001874 }
1875
Gilles Peskine449bd832023-01-11 14:50:10 +01001876 if (attributes->domain_parameters_size != 0) {
Valerio Settib2bcedb2023-07-10 11:24:00 +02001877#if (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) && \
1878 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01001879 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
1880 if (PSA_KEY_TYPE_IS_RSA(slot->attr.type)) {
Steven Cooremana2371e52020-07-28 14:30:39 +02001881 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman75b74362020-07-28 14:30:13 +02001882 mbedtls_mpi actual, required;
Steven Cooreman6d839f02020-07-30 11:36:45 +02001883 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooremana01795d2020-07-24 22:48:15 +02001884
Ronald Cron90857082020-11-25 14:58:33 +01001885 psa_status_t status = mbedtls_psa_rsa_load_representation(
Gilles Peskine449bd832023-01-11 14:50:10 +01001886 slot->attr.type,
1887 slot->key.data,
1888 slot->key.bytes,
1889 &rsa);
1890 if (status != PSA_SUCCESS) {
1891 return status;
1892 }
Steven Cooreman75b74362020-07-28 14:30:13 +02001893
Gilles Peskine449bd832023-01-11 14:50:10 +01001894 mbedtls_mpi_init(&actual);
1895 mbedtls_mpi_init(&required);
1896 ret = mbedtls_rsa_export(rsa,
1897 NULL, NULL, NULL, NULL, &actual);
1898 mbedtls_rsa_free(rsa);
1899 mbedtls_free(rsa);
1900 if (ret != 0) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001901 goto rsa_exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001902 }
1903 ret = mbedtls_mpi_read_binary(&required,
1904 attributes->domain_parameters,
1905 attributes->domain_parameters_size);
1906 if (ret != 0) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001907 goto rsa_exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001908 }
1909 if (mbedtls_mpi_cmp_mpi(&actual, &required) != 0) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001910 ret = MBEDTLS_ERR_RSA_BAD_INPUT_DATA;
Gilles Peskine449bd832023-01-11 14:50:10 +01001911 }
1912rsa_exit:
1913 mbedtls_mpi_free(&actual);
1914 mbedtls_mpi_free(&required);
1915 if (ret != 0) {
1916 return mbedtls_to_psa_error(ret);
1917 }
1918 } else
Valerio Settib2bcedb2023-07-10 11:24:00 +02001919#endif /* (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) &&
1920 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) ||
John Durkop9814fa22020-11-04 12:28:15 -08001921 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001922 {
Gilles Peskine449bd832023-01-11 14:50:10 +01001923 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001924 }
1925 }
1926
Gilles Peskine449bd832023-01-11 14:50:10 +01001927 if (attributes->core.bits != 0) {
1928 if (attributes->core.bits != slot->attr.bits) {
1929 return PSA_ERROR_INVALID_ARGUMENT;
1930 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001931 }
1932
Gilles Peskine449bd832023-01-11 14:50:10 +01001933 return PSA_SUCCESS;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001934}
1935
Gilles Peskine449bd832023-01-11 14:50:10 +01001936psa_status_t psa_import_key(const psa_key_attributes_t *attributes,
1937 const uint8_t *data,
1938 size_t data_length,
1939 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02001940{
1941 psa_status_t status;
1942 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001943 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001944 size_t bits;
Archanad8a83dc2021-06-14 10:04:16 +05301945 size_t storage_size = data_length;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001946
Ronald Cron81709fc2020-11-14 12:10:32 +01001947 *key = MBEDTLS_SVC_KEY_ID_INIT;
1948
Gilles Peskine0f84d622019-09-12 19:03:13 +02001949 /* Reject zero-length symmetric keys (including raw data key objects).
1950 * This also rejects any key which might be encoded as an empty string,
1951 * which is never valid. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001952 if (data_length == 0) {
1953 return PSA_ERROR_INVALID_ARGUMENT;
1954 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02001955
Archana449608b2021-09-08 15:36:05 +05301956 /* Ensure that the bytes-to-bits conversion cannot overflow. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001957 if (data_length > SIZE_MAX / 8) {
1958 return PSA_ERROR_NOT_SUPPORTED;
1959 }
Archana6ed4bda2021-08-04 10:47:15 +05301960
Gilles Peskine449bd832023-01-11 14:50:10 +01001961 status = psa_start_key_creation(PSA_KEY_CREATION_IMPORT, attributes,
1962 &slot, &driver);
1963 if (status != PSA_SUCCESS) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001964 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001965 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001966
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001967 /* In the case of a transparent key or an opaque key stored in local
Archana449608b2021-09-08 15:36:05 +05301968 * storage ( thus not in the case of importing a key in a secure element
1969 * with storage ( MBEDTLS_PSA_CRYPTO_SE_C ) ),we have to allocate a
1970 * buffer to hold the imported key material. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001971 if (slot->key.data == NULL) {
1972 if (psa_key_lifetime_is_external(attributes->core.lifetime)) {
Archana449608b2021-09-08 15:36:05 +05301973 status = psa_driver_wrapper_get_key_buffer_size_from_key_data(
Gilles Peskine449bd832023-01-11 14:50:10 +01001974 attributes, data, data_length, &storage_size);
1975 if (status != PSA_SUCCESS) {
Archanad8a83dc2021-06-14 10:04:16 +05301976 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001977 }
Archanad8a83dc2021-06-14 10:04:16 +05301978 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001979 status = psa_allocate_buffer_to_slot(slot, storage_size);
1980 if (status != PSA_SUCCESS) {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001981 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001982 }
Gilles Peskine5d309672019-07-12 23:47:28 +02001983 }
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001984
1985 bits = slot->attr.bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01001986 status = psa_driver_wrapper_import_key(attributes,
1987 data, data_length,
1988 slot->key.data,
1989 slot->key.bytes,
1990 &slot->key.bytes, &bits);
1991 if (status != PSA_SUCCESS) {
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001992 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001993 }
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001994
Gilles Peskine449bd832023-01-11 14:50:10 +01001995 if (slot->attr.bits == 0) {
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001996 slot->attr.bits = (psa_key_bits_t) bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01001997 } else if (bits != slot->attr.bits) {
Steven Cooremanac3434f2021-01-15 17:36:02 +01001998 status = PSA_ERROR_INVALID_ARGUMENT;
1999 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02002000 }
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01002001
Archana6ed4bda2021-08-04 10:47:15 +05302002 /* Enforce a size limit, and in particular ensure that the bit
2003 * size fits in its representation type.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01002004 if (bits > PSA_MAX_KEY_BITS) {
Archana6ed4bda2021-08-04 10:47:15 +05302005 status = PSA_ERROR_NOT_SUPPORTED;
2006 goto exit;
2007 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002008 status = psa_validate_optional_attributes(slot, attributes);
2009 if (status != PSA_SUCCESS) {
Gilles Peskine18017402019-07-24 20:25:59 +02002010 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002011 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002012
Gilles Peskine449bd832023-01-11 14:50:10 +01002013 status = psa_finish_key_creation(slot, driver, key);
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002014exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002015 if (status != PSA_SUCCESS) {
2016 psa_fail_key_creation(slot, driver);
2017 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002018
Gilles Peskine449bd832023-01-11 14:50:10 +01002019 return status;
Gilles Peskine4747d192019-04-17 15:05:45 +02002020}
2021
Gilles Peskined7729582019-08-05 15:55:54 +02002022#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2023psa_status_t mbedtls_psa_register_se_key(
Gilles Peskine449bd832023-01-11 14:50:10 +01002024 const psa_key_attributes_t *attributes)
Gilles Peskined7729582019-08-05 15:55:54 +02002025{
2026 psa_status_t status;
2027 psa_key_slot_t *slot = NULL;
2028 psa_se_drv_table_entry_t *driver = NULL;
Ronald Croncf56a0a2020-08-04 09:51:30 +02002029 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskined7729582019-08-05 15:55:54 +02002030
2031 /* Leaving attributes unspecified is not currently supported.
2032 * It could make sense to query the key type and size from the
2033 * secure element, but not all secure elements support this
2034 * and the driver HAL doesn't currently support it. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002035 if (psa_get_key_type(attributes) == PSA_KEY_TYPE_NONE) {
2036 return PSA_ERROR_NOT_SUPPORTED;
2037 }
2038 if (psa_get_key_bits(attributes) == 0) {
2039 return PSA_ERROR_NOT_SUPPORTED;
2040 }
Gilles Peskined7729582019-08-05 15:55:54 +02002041
Gilles Peskine449bd832023-01-11 14:50:10 +01002042 status = psa_start_key_creation(PSA_KEY_CREATION_REGISTER, attributes,
2043 &slot, &driver);
2044 if (status != PSA_SUCCESS) {
Gilles Peskined7729582019-08-05 15:55:54 +02002045 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002046 }
Gilles Peskined7729582019-08-05 15:55:54 +02002047
Gilles Peskine449bd832023-01-11 14:50:10 +01002048 status = psa_finish_key_creation(slot, driver, &key);
Gilles Peskined7729582019-08-05 15:55:54 +02002049
2050exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002051 if (status != PSA_SUCCESS) {
2052 psa_fail_key_creation(slot, driver);
2053 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002054
Gilles Peskined7729582019-08-05 15:55:54 +02002055 /* Registration doesn't keep the key in RAM. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002056 psa_close_key(key);
2057 return status;
Gilles Peskined7729582019-08-05 15:55:54 +02002058}
2059#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2060
Gilles Peskine449bd832023-01-11 14:50:10 +01002061psa_status_t psa_copy_key(mbedtls_svc_key_id_t source_key,
2062 const psa_key_attributes_t *specified_attributes,
2063 mbedtls_svc_key_id_t *target_key)
Gilles Peskinef603c712019-01-19 13:40:11 +01002064{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002065 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01002066 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinef603c712019-01-19 13:40:11 +01002067 psa_key_slot_t *source_slot = NULL;
2068 psa_key_slot_t *target_slot = NULL;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002069 psa_key_attributes_t actual_attributes = *specified_attributes;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002070 psa_se_drv_table_entry_t *driver = NULL;
Archana8a180362021-07-05 02:18:48 +05302071 size_t storage_size = 0;
Gilles Peskinef603c712019-01-19 13:40:11 +01002072
Ronald Cron81709fc2020-11-14 12:10:32 +01002073 *target_key = MBEDTLS_SVC_KEY_ID_INIT;
2074
Archana8a180362021-07-05 02:18:48 +05302075 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002076 source_key, &source_slot, PSA_KEY_USAGE_COPY, 0);
2077 if (status != PSA_SUCCESS) {
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002078 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002079 }
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002080
Gilles Peskine449bd832023-01-11 14:50:10 +01002081 status = psa_validate_optional_attributes(source_slot,
2082 specified_attributes);
2083 if (status != PSA_SUCCESS) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002084 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002085 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002086
Archana9d17bf42021-09-10 06:22:44 +05302087 /* The target key type and number of bits have been validated by
2088 * psa_validate_optional_attributes() to be either equal to zero or
2089 * equal to the ones of the source key. So it is safe to inherit
2090 * them from the source key now."
Archana374fe5b2021-09-08 15:50:28 +05302091 * */
Archana9d17bf42021-09-10 06:22:44 +05302092 actual_attributes.core.bits = source_slot->attr.bits;
2093 actual_attributes.core.type = source_slot->attr.type;
Archana374fe5b2021-09-08 15:50:28 +05302094
2095
Gilles Peskine449bd832023-01-11 14:50:10 +01002096 status = psa_restrict_key_policy(source_slot->attr.type,
2097 &actual_attributes.core.policy,
2098 &source_slot->attr.policy);
2099 if (status != PSA_SUCCESS) {
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002100 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002101 }
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002102
Gilles Peskine449bd832023-01-11 14:50:10 +01002103 status = psa_start_key_creation(PSA_KEY_CREATION_COPY, &actual_attributes,
2104 &target_slot, &driver);
2105 if (status != PSA_SUCCESS) {
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002106 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002107 }
2108 if (PSA_KEY_LIFETIME_GET_LOCATION(target_slot->attr.lifetime) !=
2109 PSA_KEY_LIFETIME_GET_LOCATION(source_slot->attr.lifetime)) {
Archana8a180362021-07-05 02:18:48 +05302110 /*
Archana9d17bf42021-09-10 06:22:44 +05302111 * If the source and target keys are stored in different locations,
Archana8a180362021-07-05 02:18:48 +05302112 * the source key would need to be exported as plaintext and re-imported
2113 * in the other location. This has security implications which have not
Archana449608b2021-09-08 15:36:05 +05302114 * been fully mapped. For now, this can be achieved through
Archana8a180362021-07-05 02:18:48 +05302115 * appropriate API invocations from the application, if needed.
2116 * */
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002117 status = PSA_ERROR_NOT_SUPPORTED;
2118 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002119 }
Archana8a180362021-07-05 02:18:48 +05302120 /*
2121 * When the source and target keys are within the same location,
Archana449608b2021-09-08 15:36:05 +05302122 * - For transparent keys it is a blind copy without any driver invocation,
Archana8a180362021-07-05 02:18:48 +05302123 * - For opaque keys this translates to an invocation of the drivers'
2124 * copy_key entry point through the dispatch layer.
2125 * */
Gilles Peskine449bd832023-01-11 14:50:10 +01002126 if (psa_key_lifetime_is_external(actual_attributes.core.lifetime)) {
2127 status = psa_driver_wrapper_get_key_buffer_size(&actual_attributes,
2128 &storage_size);
2129 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302130 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002131 }
Archana374fe5b2021-09-08 15:50:28 +05302132
Gilles Peskine449bd832023-01-11 14:50:10 +01002133 status = psa_allocate_buffer_to_slot(target_slot, storage_size);
2134 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302135 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002136 }
Archana374fe5b2021-09-08 15:50:28 +05302137
Gilles Peskine449bd832023-01-11 14:50:10 +01002138 status = psa_driver_wrapper_copy_key(&actual_attributes,
2139 source_slot->key.data,
2140 source_slot->key.bytes,
2141 target_slot->key.data,
2142 target_slot->key.bytes,
2143 &target_slot->key.bytes);
2144 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302145 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002146 }
2147 } else {
2148 status = psa_copy_key_material_into_slot(target_slot,
Archana9d17bf42021-09-10 06:22:44 +05302149 source_slot->key.data,
Gilles Peskine449bd832023-01-11 14:50:10 +01002150 source_slot->key.bytes);
2151 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302152 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002153 }
Archana8a180362021-07-05 02:18:48 +05302154 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002155 status = psa_finish_key_creation(target_slot, driver, target_key);
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002156exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002157 if (status != PSA_SUCCESS) {
2158 psa_fail_key_creation(target_slot, driver);
2159 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002160
Ryan Everett1b70a072024-01-04 10:32:49 +00002161 unlock_status = psa_unregister_read(source_slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02002162
Gilles Peskine449bd832023-01-11 14:50:10 +01002163 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskinef603c712019-01-19 13:40:11 +01002164}
2165
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02002166
2167
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01002168/****************************************************************/
Gilles Peskine20035e32018-02-03 22:44:14 +01002169/* Message digests */
2170/****************************************************************/
2171
Gilles Peskine449bd832023-01-11 14:50:10 +01002172psa_status_t psa_hash_abort(psa_hash_operation_t *operation)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002173{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002174 /* Aborting a non-active operation is allowed */
Gilles Peskine449bd832023-01-11 14:50:10 +01002175 if (operation->id == 0) {
2176 return PSA_SUCCESS;
2177 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002178
Gilles Peskine449bd832023-01-11 14:50:10 +01002179 psa_status_t status = psa_driver_wrapper_hash_abort(operation);
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002180 operation->id = 0;
2181
Gilles Peskine449bd832023-01-11 14:50:10 +01002182 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002183}
2184
Gilles Peskine449bd832023-01-11 14:50:10 +01002185psa_status_t psa_hash_setup(psa_hash_operation_t *operation,
2186 psa_algorithm_t alg)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002187{
Dave Rodgman685b6a72021-06-24 11:49:14 +01002188 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002189
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002190 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002191 if (operation->id != 0) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002192 status = PSA_ERROR_BAD_STATE;
2193 goto exit;
2194 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002195
Gilles Peskine449bd832023-01-11 14:50:10 +01002196 if (!PSA_ALG_IS_HASH(alg)) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002197 status = PSA_ERROR_INVALID_ARGUMENT;
2198 goto exit;
2199 }
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002200
Steven Cooremanb6bf4bb2021-03-15 19:00:14 +01002201 /* Ensure all of the context is zeroized, since PSA_HASH_OPERATION_INIT only
2202 * directly zeroes the int-sized dummy member of the context union. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002203 memset(&operation->ctx, 0, sizeof(operation->ctx));
Steven Cooreman893232f2021-03-15 12:23:37 +01002204
Gilles Peskine449bd832023-01-11 14:50:10 +01002205 status = psa_driver_wrapper_hash_setup(operation, alg);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002206
2207exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002208 if (status != PSA_SUCCESS) {
2209 psa_hash_abort(operation);
2210 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002211
2212 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002213}
2214
Gilles Peskine449bd832023-01-11 14:50:10 +01002215psa_status_t psa_hash_update(psa_hash_operation_t *operation,
2216 const uint8_t *input,
2217 size_t input_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002218{
Dave Rodgman685b6a72021-06-24 11:49:14 +01002219 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2220
Gilles Peskine449bd832023-01-11 14:50:10 +01002221 if (operation->id == 0) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002222 status = PSA_ERROR_BAD_STATE;
2223 goto exit;
2224 }
Gilles Peskine94e44542018-07-12 16:58:43 +02002225
Steven Cooremanc8288352021-03-04 14:02:19 +01002226 /* Don't require hash implementations to behave correctly on a
2227 * zero-length input, which may have an invalid pointer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002228 if (input_length == 0) {
2229 return PSA_SUCCESS;
2230 }
Steven Cooremanc8288352021-03-04 14:02:19 +01002231
Gilles Peskine449bd832023-01-11 14:50:10 +01002232 status = psa_driver_wrapper_hash_update(operation, input, input_length);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002233
2234exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002235 if (status != PSA_SUCCESS) {
2236 psa_hash_abort(operation);
2237 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002238
Gilles Peskine449bd832023-01-11 14:50:10 +01002239 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002240}
2241
Gilles Peskine449bd832023-01-11 14:50:10 +01002242psa_status_t psa_hash_finish(psa_hash_operation_t *operation,
2243 uint8_t *hash,
2244 size_t hash_size,
2245 size_t *hash_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002246{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002247 *hash_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002248 if (operation->id == 0) {
2249 return PSA_ERROR_BAD_STATE;
2250 }
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002251
Steven Cooreman1e582352021-02-18 17:24:37 +01002252 psa_status_t status = psa_driver_wrapper_hash_finish(
Gilles Peskine449bd832023-01-11 14:50:10 +01002253 operation, hash, hash_size, hash_length);
2254 psa_hash_abort(operation);
2255 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002256}
2257
Gilles Peskine449bd832023-01-11 14:50:10 +01002258psa_status_t psa_hash_verify(psa_hash_operation_t *operation,
2259 const uint8_t *hash,
2260 size_t hash_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002261{
Ronald Cron69a63422021-10-18 09:47:58 +02002262 uint8_t actual_hash[PSA_HASH_MAX_SIZE];
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002263 size_t actual_hash_length;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002264 psa_status_t status = psa_hash_finish(
Gilles Peskine449bd832023-01-11 14:50:10 +01002265 operation,
2266 actual_hash, sizeof(actual_hash),
2267 &actual_hash_length);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002268
Gilles Peskine449bd832023-01-11 14:50:10 +01002269 if (status != PSA_SUCCESS) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002270 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002271 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002272
Gilles Peskine449bd832023-01-11 14:50:10 +01002273 if (actual_hash_length != hash_length) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002274 status = PSA_ERROR_INVALID_SIGNATURE;
2275 goto exit;
2276 }
2277
Dave Rodgman78701152023-08-29 14:20:18 +01002278 if (mbedtls_ct_memcmp(hash, actual_hash, actual_hash_length) != 0) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002279 status = PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01002280 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002281
2282exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002283 mbedtls_platform_zeroize(actual_hash, sizeof(actual_hash));
2284 if (status != PSA_SUCCESS) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002285 psa_hash_abort(operation);
Gilles Peskine449bd832023-01-11 14:50:10 +01002286 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002287
Gilles Peskine449bd832023-01-11 14:50:10 +01002288 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002289}
2290
Gilles Peskine449bd832023-01-11 14:50:10 +01002291psa_status_t psa_hash_compute(psa_algorithm_t alg,
2292 const uint8_t *input, size_t input_length,
2293 uint8_t *hash, size_t hash_size,
2294 size_t *hash_length)
Gilles Peskine0a749c82019-11-28 19:33:58 +01002295{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002296 *hash_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002297 if (!PSA_ALG_IS_HASH(alg)) {
2298 return PSA_ERROR_INVALID_ARGUMENT;
2299 }
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002300
Gilles Peskine449bd832023-01-11 14:50:10 +01002301 return psa_driver_wrapper_hash_compute(alg, input, input_length,
2302 hash, hash_size, hash_length);
Gilles Peskine0a749c82019-11-28 19:33:58 +01002303}
2304
Gilles Peskine449bd832023-01-11 14:50:10 +01002305psa_status_t psa_hash_compare(psa_algorithm_t alg,
2306 const uint8_t *input, size_t input_length,
2307 const uint8_t *hash, size_t hash_length)
Gilles Peskine0a749c82019-11-28 19:33:58 +01002308{
Ronald Cron69a63422021-10-18 09:47:58 +02002309 uint8_t actual_hash[PSA_HASH_MAX_SIZE];
Steven Cooreman84d670d2021-02-18 16:22:53 +01002310 size_t actual_hash_length;
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002311
Gilles Peskine449bd832023-01-11 14:50:10 +01002312 if (!PSA_ALG_IS_HASH(alg)) {
2313 return PSA_ERROR_INVALID_ARGUMENT;
2314 }
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002315
Steven Cooreman1e582352021-02-18 17:24:37 +01002316 psa_status_t status = psa_driver_wrapper_hash_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01002317 alg, input, input_length,
2318 actual_hash, sizeof(actual_hash),
2319 &actual_hash_length);
2320 if (status != PSA_SUCCESS) {
Gilles Peskine60aebec2021-12-13 12:33:18 +01002321 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002322 }
2323 if (actual_hash_length != hash_length) {
Gilles Peskine60aebec2021-12-13 12:33:18 +01002324 status = PSA_ERROR_INVALID_SIGNATURE;
2325 goto exit;
2326 }
Dave Rodgman78701152023-08-29 14:20:18 +01002327 if (mbedtls_ct_memcmp(hash, actual_hash, actual_hash_length) != 0) {
Gilles Peskine60aebec2021-12-13 12:33:18 +01002328 status = PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01002329 }
Gilles Peskine60aebec2021-12-13 12:33:18 +01002330
2331exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002332 mbedtls_platform_zeroize(actual_hash, sizeof(actual_hash));
2333 return status;
Gilles Peskine0a749c82019-11-28 19:33:58 +01002334}
2335
Gilles Peskine449bd832023-01-11 14:50:10 +01002336psa_status_t psa_hash_clone(const psa_hash_operation_t *source_operation,
2337 psa_hash_operation_t *target_operation)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002338{
Gilles Peskine449bd832023-01-11 14:50:10 +01002339 if (source_operation->id == 0 ||
2340 target_operation->id != 0) {
2341 return PSA_ERROR_BAD_STATE;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002342 }
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002343
Gilles Peskine449bd832023-01-11 14:50:10 +01002344 psa_status_t status = psa_driver_wrapper_hash_clone(source_operation,
2345 target_operation);
2346 if (status != PSA_SUCCESS) {
2347 psa_hash_abort(target_operation);
2348 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002349
Gilles Peskine449bd832023-01-11 14:50:10 +01002350 return status;
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002351}
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002352
2353
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002354/****************************************************************/
Gilles Peskine8c9def32018-02-08 10:02:12 +01002355/* MAC */
2356/****************************************************************/
2357
Gilles Peskine449bd832023-01-11 14:50:10 +01002358psa_status_t psa_mac_abort(psa_mac_operation_t *operation)
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002359{
Steven Cooremane6804192021-03-19 18:28:56 +01002360 /* Aborting a non-active operation is allowed */
Gilles Peskine449bd832023-01-11 14:50:10 +01002361 if (operation->id == 0) {
2362 return PSA_SUCCESS;
2363 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002364
Gilles Peskine449bd832023-01-11 14:50:10 +01002365 psa_status_t status = psa_driver_wrapper_mac_abort(operation);
Steven Cooreman72f736a2021-05-07 14:14:37 +02002366 operation->mac_size = 0;
2367 operation->is_sign = 0;
Steven Cooremane6804192021-03-19 18:28:56 +01002368 operation->id = 0;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002369
Gilles Peskine449bd832023-01-11 14:50:10 +01002370 return status;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002371}
2372
Ronald Cron2dff3b22021-06-17 16:33:22 +02002373static psa_status_t psa_mac_finalize_alg_and_key_validation(
2374 psa_algorithm_t alg,
Ronald Cron79bdd822021-06-17 16:46:44 +02002375 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01002376 uint8_t *mac_size)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002377{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002378 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002379 psa_key_type_t key_type = psa_get_key_type(attributes);
2380 size_t key_bits = psa_get_key_bits(attributes);
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002381
Gilles Peskine449bd832023-01-11 14:50:10 +01002382 if (!PSA_ALG_IS_MAC(alg)) {
2383 return PSA_ERROR_INVALID_ARGUMENT;
2384 }
Steven Cooremane6804192021-03-19 18:28:56 +01002385
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002386 /* Validate the combination of key type and algorithm */
Gilles Peskine449bd832023-01-11 14:50:10 +01002387 status = psa_mac_key_can_do(alg, key_type);
2388 if (status != PSA_SUCCESS) {
2389 return status;
2390 }
Steven Cooreman15472f82021-03-02 16:16:22 +01002391
Steven Cooremand1a68f12021-05-10 11:13:41 +02002392 /* Get the output length for the algorithm and key combination */
Gilles Peskine449bd832023-01-11 14:50:10 +01002393 *mac_size = PSA_MAC_LENGTH(key_type, key_bits, alg);
Steven Cooreman15472f82021-03-02 16:16:22 +01002394
Gilles Peskine449bd832023-01-11 14:50:10 +01002395 if (*mac_size < 4) {
Steven Cooreman15472f82021-03-02 16:16:22 +01002396 /* A very short MAC is too short for security since it can be
2397 * brute-forced. Ancient protocols with 32-bit MACs do exist,
2398 * so we make this our minimum, even though 32 bits is still
2399 * too small for security. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002400 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman15472f82021-03-02 16:16:22 +01002401 }
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02002402
Gilles Peskine449bd832023-01-11 14:50:10 +01002403 if (*mac_size > PSA_MAC_LENGTH(key_type, key_bits,
2404 PSA_ALG_FULL_LENGTH_MAC(alg))) {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002405 /* It's impossible to "truncate" to a larger length than the full length
2406 * of the algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002407 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002408 }
2409
Gilles Peskine449bd832023-01-11 14:50:10 +01002410 if (*mac_size > PSA_MAC_MAX_SIZE) {
Gilles Peskinea9b6c802022-03-16 13:54:49 +01002411 /* PSA_MAC_LENGTH returns the correct length even for a MAC algorithm
2412 * that is disabled in the compile-time configuration. The result can
2413 * therefore be larger than PSA_MAC_MAX_SIZE, which does take the
2414 * configuration into account. In this case, force a return of
2415 * PSA_ERROR_NOT_SUPPORTED here. Otherwise psa_mac_verify(), or
2416 * psa_mac_compute(mac_size=PSA_MAC_MAX_SIZE), would return
2417 * PSA_ERROR_BUFFER_TOO_SMALL for an unsupported algorithm whose MAC size
2418 * is larger than PSA_MAC_MAX_SIZE, which is misleading and which breaks
2419 * systematically generated tests. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002420 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea9b6c802022-03-16 13:54:49 +01002421 }
2422
Gilles Peskine449bd832023-01-11 14:50:10 +01002423 return PSA_SUCCESS;
Ronald Cron2dff3b22021-06-17 16:33:22 +02002424}
2425
Gilles Peskine449bd832023-01-11 14:50:10 +01002426static psa_status_t psa_mac_setup(psa_mac_operation_t *operation,
2427 mbedtls_svc_key_id_t key,
2428 psa_algorithm_t alg,
2429 int is_sign)
Gilles Peskinee59236f2018-01-27 23:32:46 +01002430{
2431 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2432 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman54648242021-06-24 11:49:45 +01002433 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002434 psa_key_attributes_t attributes;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002435
2436 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002437 if (operation->id != 0) {
Dave Rodgman54648242021-06-24 11:49:45 +01002438 status = PSA_ERROR_BAD_STATE;
2439 goto exit;
2440 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002441
2442 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002443 key,
2444 &slot,
2445 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
2446 alg);
2447 if (status != PSA_SUCCESS) {
Dave Rodgman54648242021-06-24 11:49:45 +01002448 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002449 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002450
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002451 attributes = (psa_key_attributes_t) {
Gilles Peskine8c9def32018-02-08 10:02:12 +01002452 .core = slot->attr
2453 };
2454
Gilles Peskine449bd832023-01-11 14:50:10 +01002455 status = psa_mac_finalize_alg_and_key_validation(alg, &attributes,
2456 &operation->mac_size);
2457 if (status != PSA_SUCCESS) {
Gilles Peskine8c9def32018-02-08 10:02:12 +01002458 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002459 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002460
2461 operation->is_sign = is_sign;
Steven Cooremane6804192021-03-19 18:28:56 +01002462 /* Dispatch the MAC setup call with validated input */
Gilles Peskine449bd832023-01-11 14:50:10 +01002463 if (is_sign) {
2464 status = psa_driver_wrapper_mac_sign_setup(operation,
2465 &attributes,
2466 slot->key.data,
2467 slot->key.bytes,
2468 alg);
2469 } else {
2470 status = psa_driver_wrapper_mac_verify_setup(operation,
2471 &attributes,
2472 slot->key.data,
2473 slot->key.bytes,
2474 alg);
Gilles Peskine8c9def32018-02-08 10:02:12 +01002475 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002476
Gilles Peskinefbfac682018-07-08 20:51:54 +02002477exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002478 if (status != PSA_SUCCESS) {
2479 psa_mac_abort(operation);
2480 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002481
Ryan Everett1b70a072024-01-04 10:32:49 +00002482 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02002483
Gilles Peskine449bd832023-01-11 14:50:10 +01002484 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002485}
2486
Gilles Peskine449bd832023-01-11 14:50:10 +01002487psa_status_t psa_mac_sign_setup(psa_mac_operation_t *operation,
2488 mbedtls_svc_key_id_t key,
2489 psa_algorithm_t alg)
Gilles Peskine89167cb2018-07-08 20:12:23 +02002490{
Gilles Peskine449bd832023-01-11 14:50:10 +01002491 return psa_mac_setup(operation, key, alg, 1);
Gilles Peskine89167cb2018-07-08 20:12:23 +02002492}
2493
Gilles Peskine449bd832023-01-11 14:50:10 +01002494psa_status_t psa_mac_verify_setup(psa_mac_operation_t *operation,
2495 mbedtls_svc_key_id_t key,
2496 psa_algorithm_t alg)
Gilles Peskine89167cb2018-07-08 20:12:23 +02002497{
Gilles Peskine449bd832023-01-11 14:50:10 +01002498 return psa_mac_setup(operation, key, alg, 0);
Gilles Peskine89167cb2018-07-08 20:12:23 +02002499}
2500
Gilles Peskine449bd832023-01-11 14:50:10 +01002501psa_status_t psa_mac_update(psa_mac_operation_t *operation,
2502 const uint8_t *input,
2503 size_t input_length)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002504{
Gilles Peskine449bd832023-01-11 14:50:10 +01002505 if (operation->id == 0) {
2506 return PSA_ERROR_BAD_STATE;
2507 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002508
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002509 /* Don't require hash implementations to behave correctly on a
2510 * zero-length input, which may have an invalid pointer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002511 if (input_length == 0) {
2512 return PSA_SUCCESS;
2513 }
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03002514
Gilles Peskine449bd832023-01-11 14:50:10 +01002515 psa_status_t status = psa_driver_wrapper_mac_update(operation,
2516 input, input_length);
2517 if (status != PSA_SUCCESS) {
2518 psa_mac_abort(operation);
2519 }
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002520
Gilles Peskine449bd832023-01-11 14:50:10 +01002521 return status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002522}
2523
Gilles Peskine449bd832023-01-11 14:50:10 +01002524psa_status_t psa_mac_sign_finish(psa_mac_operation_t *operation,
2525 uint8_t *mac,
2526 size_t mac_size,
2527 size_t *mac_length)
mohammad16036df908f2018-04-02 08:34:15 -07002528{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002529 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2530 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002531
Gilles Peskine449bd832023-01-11 14:50:10 +01002532 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002533 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002534 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002535 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002536
Gilles Peskine449bd832023-01-11 14:50:10 +01002537 if (!operation->is_sign) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002538 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002539 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002540 }
Steven Cooreman72f736a2021-05-07 14:14:37 +02002541
Steven Cooreman8af5c5c2021-05-11 11:09:13 +02002542 /* Sanity check. This will guarantee that mac_size != 0 (and so mac != NULL)
2543 * once all the error checks are done. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002544 if (operation->mac_size == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002545 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002546 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002547 }
Steven Cooreman8af5c5c2021-05-11 11:09:13 +02002548
Gilles Peskine449bd832023-01-11 14:50:10 +01002549 if (mac_size < operation->mac_size) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002550 status = PSA_ERROR_BUFFER_TOO_SMALL;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002551 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002552 }
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002553
Gilles Peskine449bd832023-01-11 14:50:10 +01002554 status = psa_driver_wrapper_mac_sign_finish(operation,
2555 mac, operation->mac_size,
2556 mac_length);
Steven Cooreman72f736a2021-05-07 14:14:37 +02002557
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002558exit:
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002559 /* In case of success, set the potential excess room in the output buffer
2560 * to an invalid value, to avoid potentially leaking a longer MAC.
2561 * In case of error, set the output length and content to a safe default,
2562 * such that in case the caller misses an error check, the output would be
2563 * an unachievable MAC.
2564 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002565 if (status != PSA_SUCCESS) {
Steven Cooreman72f736a2021-05-07 14:14:37 +02002566 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002567 operation->mac_size = 0;
Steven Cooreman72f736a2021-05-07 14:14:37 +02002568 }
mohammad16036df908f2018-04-02 08:34:15 -07002569
Paul Elliottdc42ca82023-02-24 18:11:59 +00002570 psa_wipe_tag_output_buffer(mac, status, mac_size, *mac_length);
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002571
Gilles Peskine449bd832023-01-11 14:50:10 +01002572 abort_status = psa_mac_abort(operation);
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002573
Gilles Peskine449bd832023-01-11 14:50:10 +01002574 return status == PSA_SUCCESS ? abort_status : status;
mohammad16036df908f2018-04-02 08:34:15 -07002575}
2576
Gilles Peskine449bd832023-01-11 14:50:10 +01002577psa_status_t psa_mac_verify_finish(psa_mac_operation_t *operation,
2578 const uint8_t *mac,
2579 size_t mac_length)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002580{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002581 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2582 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002583
Gilles Peskine449bd832023-01-11 14:50:10 +01002584 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002585 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002586 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002587 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002588
Gilles Peskine449bd832023-01-11 14:50:10 +01002589 if (operation->is_sign) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002590 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002591 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002592 }
Steven Cooreman72f736a2021-05-07 14:14:37 +02002593
Gilles Peskine449bd832023-01-11 14:50:10 +01002594 if (operation->mac_size != mac_length) {
Steven Cooreman72f736a2021-05-07 14:14:37 +02002595 status = PSA_ERROR_INVALID_SIGNATURE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002596 goto exit;
Steven Cooreman72f736a2021-05-07 14:14:37 +02002597 }
2598
Gilles Peskine449bd832023-01-11 14:50:10 +01002599 status = psa_driver_wrapper_mac_verify_finish(operation,
2600 mac, mac_length);
Steven Cooreman72f736a2021-05-07 14:14:37 +02002601
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002602exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002603 abort_status = psa_mac_abort(operation);
mohammad16036df908f2018-04-02 08:34:15 -07002604
Gilles Peskine449bd832023-01-11 14:50:10 +01002605 return status == PSA_SUCCESS ? abort_status : status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002606}
2607
Gilles Peskine449bd832023-01-11 14:50:10 +01002608static psa_status_t psa_mac_compute_internal(mbedtls_svc_key_id_t key,
2609 psa_algorithm_t alg,
2610 const uint8_t *input,
2611 size_t input_length,
2612 uint8_t *mac,
2613 size_t mac_size,
2614 size_t *mac_length,
2615 int is_sign)
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002616{
2617 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron51131b52021-06-17 17:17:20 +02002618 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2619 psa_key_slot_t *slot;
2620 uint8_t operation_mac_size = 0;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002621 psa_key_attributes_t attributes;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002622
Ronald Cron51131b52021-06-17 17:17:20 +02002623 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002624 key,
2625 &slot,
2626 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
2627 alg);
2628 if (status != PSA_SUCCESS) {
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002629 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002630 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002631
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002632 attributes = (psa_key_attributes_t) {
Ronald Cron51131b52021-06-17 17:17:20 +02002633 .core = slot->attr
2634 };
2635
Gilles Peskine449bd832023-01-11 14:50:10 +01002636 status = psa_mac_finalize_alg_and_key_validation(alg, &attributes,
2637 &operation_mac_size);
2638 if (status != PSA_SUCCESS) {
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002639 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002640 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002641
Gilles Peskine449bd832023-01-11 14:50:10 +01002642 if (mac_size < operation_mac_size) {
Ronald Cron51131b52021-06-17 17:17:20 +02002643 status = PSA_ERROR_BUFFER_TOO_SMALL;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002644 goto exit;
Ronald Cron51131b52021-06-17 17:17:20 +02002645 }
2646
2647 status = psa_driver_wrapper_mac_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01002648 &attributes,
2649 slot->key.data, slot->key.bytes,
2650 alg,
2651 input, input_length,
2652 mac, operation_mac_size, mac_length);
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002653
2654exit:
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002655 /* In case of success, set the potential excess room in the output buffer
2656 * to an invalid value, to avoid potentially leaking a longer MAC.
2657 * In case of error, set the output length and content to a safe default,
2658 * such that in case the caller misses an error check, the output would be
2659 * an unachievable MAC.
2660 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002661 if (status != PSA_SUCCESS) {
Ronald Cron51131b52021-06-17 17:17:20 +02002662 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002663 operation_mac_size = 0;
Ronald Cron51131b52021-06-17 17:17:20 +02002664 }
Paul Elliottdc42ca82023-02-24 18:11:59 +00002665
2666 psa_wipe_tag_output_buffer(mac, status, mac_size, *mac_length);
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002667
Ryan Everett1b70a072024-01-04 10:32:49 +00002668 unlock_status = psa_unregister_read(slot);
Ronald Cron51131b52021-06-17 17:17:20 +02002669
Gilles Peskine449bd832023-01-11 14:50:10 +01002670 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002671}
2672
Gilles Peskine449bd832023-01-11 14:50:10 +01002673psa_status_t psa_mac_compute(mbedtls_svc_key_id_t key,
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002674 psa_algorithm_t alg,
2675 const uint8_t *input,
2676 size_t input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002677 uint8_t *mac,
2678 size_t mac_size,
2679 size_t *mac_length)
2680{
2681 return psa_mac_compute_internal(key, alg,
2682 input, input_length,
2683 mac, mac_size, mac_length, 1);
2684}
2685
2686psa_status_t psa_mac_verify(mbedtls_svc_key_id_t key,
2687 psa_algorithm_t alg,
2688 const uint8_t *input,
2689 size_t input_length,
2690 const uint8_t *mac,
2691 size_t mac_length)
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002692{
2693 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Crona587cbc2021-06-18 14:51:29 +02002694 uint8_t actual_mac[PSA_MAC_MAX_SIZE];
2695 size_t actual_mac_length;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002696
Gilles Peskine449bd832023-01-11 14:50:10 +01002697 status = psa_mac_compute_internal(key, alg,
2698 input, input_length,
2699 actual_mac, sizeof(actual_mac),
2700 &actual_mac_length, 0);
2701 if (status != PSA_SUCCESS) {
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002702 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002703 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002704
Gilles Peskine449bd832023-01-11 14:50:10 +01002705 if (mac_length != actual_mac_length) {
Ronald Crona587cbc2021-06-18 14:51:29 +02002706 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002707 goto exit;
Ronald Crona587cbc2021-06-18 14:51:29 +02002708 }
Dave Rodgman78701152023-08-29 14:20:18 +01002709 if (mbedtls_ct_memcmp(mac, actual_mac, actual_mac_length) != 0) {
Ronald Crona587cbc2021-06-18 14:51:29 +02002710 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002711 goto exit;
Ronald Crona587cbc2021-06-18 14:51:29 +02002712 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002713
2714exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002715 mbedtls_platform_zeroize(actual_mac, sizeof(actual_mac));
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002716
Gilles Peskine449bd832023-01-11 14:50:10 +01002717 return status;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002718}
Gilles Peskinee59236f2018-01-27 23:32:46 +01002719
Gilles Peskinee59236f2018-01-27 23:32:46 +01002720/****************************************************************/
2721/* Asymmetric cryptography */
2722/****************************************************************/
2723
Gilles Peskine449bd832023-01-11 14:50:10 +01002724static psa_status_t psa_sign_verify_check_alg(int input_is_message,
2725 psa_algorithm_t alg)
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002726{
Gilles Peskine449bd832023-01-11 14:50:10 +01002727 if (input_is_message) {
2728 if (!PSA_ALG_IS_SIGN_MESSAGE(alg)) {
2729 return PSA_ERROR_INVALID_ARGUMENT;
2730 }
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002731
Gilles Peskine449bd832023-01-11 14:50:10 +01002732 if (PSA_ALG_IS_SIGN_HASH(alg)) {
2733 if (!PSA_ALG_IS_HASH(PSA_ALG_SIGN_GET_HASH(alg))) {
2734 return PSA_ERROR_INVALID_ARGUMENT;
2735 }
2736 }
2737 } else {
2738 if (!PSA_ALG_IS_SIGN_HASH(alg)) {
2739 return PSA_ERROR_INVALID_ARGUMENT;
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002740 }
2741 }
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002742
Gilles Peskine449bd832023-01-11 14:50:10 +01002743 return PSA_SUCCESS;
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002744}
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002745
Gilles Peskine449bd832023-01-11 14:50:10 +01002746static psa_status_t psa_sign_internal(mbedtls_svc_key_id_t key,
2747 int input_is_message,
2748 psa_algorithm_t alg,
2749 const uint8_t *input,
2750 size_t input_length,
2751 uint8_t *signature,
2752 size_t signature_size,
2753 size_t *signature_length)
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002754{
2755 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2756 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2757 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002758 psa_key_attributes_t attributes;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002759
2760 *signature_length = 0;
2761
Gilles Peskine449bd832023-01-11 14:50:10 +01002762 status = psa_sign_verify_check_alg(input_is_message, alg);
2763 if (status != PSA_SUCCESS) {
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002764 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002765 }
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002766
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002767 /* Immediately reject a zero-length signature buffer. This guarantees
gabor-mezei-arm12b4f342021-05-05 13:54:55 +02002768 * that signature must be a valid pointer. (On the other hand, the input
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002769 * buffer can in principle be empty since it doesn't actually have
2770 * to be a hash.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01002771 if (signature_size == 0) {
2772 return PSA_ERROR_BUFFER_TOO_SMALL;
2773 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002774
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002775 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002776 key, &slot,
2777 input_is_message ? PSA_KEY_USAGE_SIGN_MESSAGE :
2778 PSA_KEY_USAGE_SIGN_HASH,
2779 alg);
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002780
Gilles Peskine449bd832023-01-11 14:50:10 +01002781 if (status != PSA_SUCCESS) {
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002782 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002783 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002784
Gilles Peskine449bd832023-01-11 14:50:10 +01002785 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002786 status = PSA_ERROR_INVALID_ARGUMENT;
2787 goto exit;
2788 }
2789
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002790 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01002791 .core = slot->attr
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002792 };
2793
Gilles Peskine449bd832023-01-11 14:50:10 +01002794 if (input_is_message) {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002795 status = psa_driver_wrapper_sign_message(
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002796 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002797 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002798 signature, signature_size, signature_length);
2799 } else {
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002800
2801 status = psa_driver_wrapper_sign_hash(
2802 &attributes, slot->key.data, slot->key.bytes,
2803 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002804 signature, signature_size, signature_length);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002805 }
2806
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002807
2808exit:
Paul Elliott59200a22023-02-21 15:07:40 +00002809 psa_wipe_tag_output_buffer(signature, status, signature_size,
2810 *signature_length);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002811
Ryan Everett1b70a072024-01-04 10:32:49 +00002812 unlock_status = psa_unregister_read(slot);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002813
Gilles Peskine449bd832023-01-11 14:50:10 +01002814 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002815}
2816
Gilles Peskine449bd832023-01-11 14:50:10 +01002817static psa_status_t psa_verify_internal(mbedtls_svc_key_id_t key,
2818 int input_is_message,
2819 psa_algorithm_t alg,
2820 const uint8_t *input,
2821 size_t input_length,
2822 const uint8_t *signature,
2823 size_t signature_length)
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002824{
2825 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2826 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2827 psa_key_slot_t *slot;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002828
Gilles Peskine449bd832023-01-11 14:50:10 +01002829 status = psa_sign_verify_check_alg(input_is_message, alg);
2830 if (status != PSA_SUCCESS) {
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002831 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002832 }
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002833
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002834 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002835 key, &slot,
2836 input_is_message ? PSA_KEY_USAGE_VERIFY_MESSAGE :
2837 PSA_KEY_USAGE_VERIFY_HASH,
2838 alg);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002839
Gilles Peskine449bd832023-01-11 14:50:10 +01002840 if (status != PSA_SUCCESS) {
2841 return status;
2842 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002843
2844 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01002845 .core = slot->attr
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002846 };
2847
Gilles Peskine449bd832023-01-11 14:50:10 +01002848 if (input_is_message) {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002849 status = psa_driver_wrapper_verify_message(
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002850 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002851 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002852 signature, signature_length);
2853 } else {
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002854 status = psa_driver_wrapper_verify_hash(
2855 &attributes, slot->key.data, slot->key.bytes,
2856 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002857 signature, signature_length);
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002858 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002859
Ryan Everett1b70a072024-01-04 10:32:49 +00002860 unlock_status = psa_unregister_read(slot);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002861
Gilles Peskine449bd832023-01-11 14:50:10 +01002862 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002863
2864}
2865
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002866psa_status_t psa_sign_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002867 const psa_key_attributes_t *attributes,
2868 const uint8_t *key_buffer,
2869 size_t key_buffer_size,
2870 psa_algorithm_t alg,
2871 const uint8_t *input,
2872 size_t input_length,
2873 uint8_t *signature,
2874 size_t signature_size,
Gilles Peskine449bd832023-01-11 14:50:10 +01002875 size_t *signature_length)
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002876{
2877 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002878
Gilles Peskine449bd832023-01-11 14:50:10 +01002879 if (PSA_ALG_IS_SIGN_HASH(alg)) {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002880 size_t hash_length;
2881 uint8_t hash[PSA_HASH_MAX_SIZE];
2882
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002883 status = psa_driver_wrapper_hash_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01002884 PSA_ALG_SIGN_GET_HASH(alg),
2885 input, input_length,
2886 hash, sizeof(hash), &hash_length);
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002887
Gilles Peskine449bd832023-01-11 14:50:10 +01002888 if (status != PSA_SUCCESS) {
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002889 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002890 }
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002891
2892 return psa_driver_wrapper_sign_hash(
Gilles Peskine449bd832023-01-11 14:50:10 +01002893 attributes, key_buffer, key_buffer_size,
2894 alg, hash, hash_length,
2895 signature, signature_size, signature_length);
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002896 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002897
Gilles Peskine449bd832023-01-11 14:50:10 +01002898 return PSA_ERROR_NOT_SUPPORTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002899}
2900
Gilles Peskine449bd832023-01-11 14:50:10 +01002901psa_status_t psa_sign_message(mbedtls_svc_key_id_t key,
2902 psa_algorithm_t alg,
2903 const uint8_t *input,
2904 size_t input_length,
2905 uint8_t *signature,
2906 size_t signature_size,
2907 size_t *signature_length)
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002908{
2909 return psa_sign_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002910 key, 1, alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002911 signature, signature_size, signature_length);
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002912}
2913
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002914psa_status_t psa_verify_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002915 const psa_key_attributes_t *attributes,
2916 const uint8_t *key_buffer,
2917 size_t key_buffer_size,
2918 psa_algorithm_t alg,
2919 const uint8_t *input,
2920 size_t input_length,
2921 const uint8_t *signature,
Gilles Peskine449bd832023-01-11 14:50:10 +01002922 size_t signature_length)
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002923{
2924 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002925
Gilles Peskine449bd832023-01-11 14:50:10 +01002926 if (PSA_ALG_IS_SIGN_HASH(alg)) {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002927 size_t hash_length;
2928 uint8_t hash[PSA_HASH_MAX_SIZE];
2929
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002930 status = psa_driver_wrapper_hash_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01002931 PSA_ALG_SIGN_GET_HASH(alg),
2932 input, input_length,
2933 hash, sizeof(hash), &hash_length);
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002934
Gilles Peskine449bd832023-01-11 14:50:10 +01002935 if (status != PSA_SUCCESS) {
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002936 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002937 }
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002938
2939 return psa_driver_wrapper_verify_hash(
Gilles Peskine449bd832023-01-11 14:50:10 +01002940 attributes, key_buffer, key_buffer_size,
2941 alg, hash, hash_length,
2942 signature, signature_length);
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002943 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002944
Gilles Peskine449bd832023-01-11 14:50:10 +01002945 return PSA_ERROR_NOT_SUPPORTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002946}
2947
Gilles Peskine449bd832023-01-11 14:50:10 +01002948psa_status_t psa_verify_message(mbedtls_svc_key_id_t key,
2949 psa_algorithm_t alg,
2950 const uint8_t *input,
2951 size_t input_length,
2952 const uint8_t *signature,
2953 size_t signature_length)
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002954{
2955 return psa_verify_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002956 key, 1, alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002957 signature, signature_length);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002958}
2959
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002960psa_status_t psa_sign_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01002961 const psa_key_attributes_t *attributes,
2962 const uint8_t *key_buffer, size_t key_buffer_size,
2963 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002964 uint8_t *signature, size_t signature_size, size_t *signature_length)
Gilles Peskinee59236f2018-01-27 23:32:46 +01002965{
Gilles Peskine449bd832023-01-11 14:50:10 +01002966 if (attributes->core.type == PSA_KEY_TYPE_RSA_KEY_PAIR) {
2967 if (PSA_ALG_IS_RSA_PKCS1V15_SIGN(alg) ||
2968 PSA_ALG_IS_RSA_PSS(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01002969#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01002970 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
2971 return mbedtls_psa_rsa_sign_hash(
2972 attributes,
2973 key_buffer, key_buffer_size,
2974 alg, hash, hash_length,
2975 signature, signature_size, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01002976#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
2977 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine449bd832023-01-11 14:50:10 +01002978 } else {
2979 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanacda8342020-07-24 23:09:52 +02002980 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002981 } else if (PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
2982 if (PSA_ALG_IS_ECDSA(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01002983#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01002984 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
2985 return mbedtls_psa_ecdsa_sign_hash(
2986 attributes,
2987 key_buffer, key_buffer_size,
2988 alg, hash, hash_length,
2989 signature, signature_size, signature_length);
Gilles Peskinee59236f2018-01-27 23:32:46 +01002990#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
2991 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskine449bd832023-01-11 14:50:10 +01002992 } else {
2993 return PSA_ERROR_INVALID_ARGUMENT;
Ronald Cron4501c982021-03-19 20:09:32 +01002994 }
Ronald Cron8a494f32021-02-17 09:49:51 +01002995 }
Ronald Cron4501c982021-03-19 20:09:32 +01002996
Gilles Peskine449bd832023-01-11 14:50:10 +01002997 (void) key_buffer;
2998 (void) key_buffer_size;
2999 (void) hash;
3000 (void) hash_length;
3001 (void) signature;
3002 (void) signature_size;
3003 (void) signature_length;
Ronald Cron4501c982021-03-19 20:09:32 +01003004
Gilles Peskine449bd832023-01-11 14:50:10 +01003005 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron18659932020-12-08 16:32:23 +01003006}
Gilles Peskinee59236f2018-01-27 23:32:46 +01003007
Gilles Peskine449bd832023-01-11 14:50:10 +01003008psa_status_t psa_sign_hash(mbedtls_svc_key_id_t key,
3009 psa_algorithm_t alg,
3010 const uint8_t *hash,
3011 size_t hash_length,
3012 uint8_t *signature,
3013 size_t signature_size,
3014 size_t *signature_length)
Gilles Peskinee59236f2018-01-27 23:32:46 +01003015{
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003016 return psa_sign_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02003017 key, 0, alg, hash, hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003018 signature, signature_size, signature_length);
itayzafrir5c753392018-05-08 11:18:38 +03003019}
3020
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02003021psa_status_t psa_verify_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01003022 const psa_key_attributes_t *attributes,
3023 const uint8_t *key_buffer, size_t key_buffer_size,
3024 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003025 const uint8_t *signature, size_t signature_length)
itayzafrir5c753392018-05-08 11:18:38 +03003026{
Gilles Peskine449bd832023-01-11 14:50:10 +01003027 if (PSA_KEY_TYPE_IS_RSA(attributes->core.type)) {
3028 if (PSA_ALG_IS_RSA_PKCS1V15_SIGN(alg) ||
3029 PSA_ALG_IS_RSA_PSS(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003030#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003031 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
3032 return mbedtls_psa_rsa_verify_hash(
3033 attributes,
3034 key_buffer, key_buffer_size,
3035 alg, hash, hash_length,
3036 signature, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01003037#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
3038 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003039 } else {
3040 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanacda8342020-07-24 23:09:52 +02003041 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003042 } else if (PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3043 if (PSA_ALG_IS_ECDSA(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003044#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003045 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3046 return mbedtls_psa_ecdsa_verify_hash(
3047 attributes,
3048 key_buffer, key_buffer_size,
3049 alg, hash, hash_length,
3050 signature, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01003051#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3052 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003053 } else {
3054 return PSA_ERROR_INVALID_ARGUMENT;
Ronald Cron4501c982021-03-19 20:09:32 +01003055 }
Ronald Cron8a494f32021-02-17 09:49:51 +01003056 }
Ronald Cron4501c982021-03-19 20:09:32 +01003057
Gilles Peskine449bd832023-01-11 14:50:10 +01003058 (void) key_buffer;
3059 (void) key_buffer_size;
3060 (void) hash;
3061 (void) hash_length;
3062 (void) signature;
3063 (void) signature_length;
Ronald Cron4501c982021-03-19 20:09:32 +01003064
Gilles Peskine449bd832023-01-11 14:50:10 +01003065 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron18659932020-12-08 16:32:23 +01003066}
3067
Gilles Peskine449bd832023-01-11 14:50:10 +01003068psa_status_t psa_verify_hash(mbedtls_svc_key_id_t key,
3069 psa_algorithm_t alg,
3070 const uint8_t *hash,
3071 size_t hash_length,
3072 const uint8_t *signature,
3073 size_t signature_length)
itayzafrir5c753392018-05-08 11:18:38 +03003074{
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003075 return psa_verify_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02003076 key, 0, alg, hash, hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003077 signature, signature_length);
Gilles Peskinee59236f2018-01-27 23:32:46 +01003078}
3079
Gilles Peskine449bd832023-01-11 14:50:10 +01003080psa_status_t psa_asymmetric_encrypt(mbedtls_svc_key_id_t key,
3081 psa_algorithm_t alg,
3082 const uint8_t *input,
3083 size_t input_length,
3084 const uint8_t *salt,
3085 size_t salt_length,
3086 uint8_t *output,
3087 size_t output_size,
3088 size_t *output_length)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003089{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003090 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003091 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003092 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003093 psa_key_attributes_t attributes;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003094
Darryl Green5cc689a2018-07-24 15:34:10 +01003095 (void) input;
3096 (void) input_length;
3097 (void) salt;
3098 (void) output;
3099 (void) output_size;
3100
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003101 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003102
Gilles Peskine449bd832023-01-11 14:50:10 +01003103 if (!PSA_ALG_IS_RSA_OAEP(alg) && salt_length != 0) {
3104 return PSA_ERROR_INVALID_ARGUMENT;
3105 }
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003106
Ronald Cron5c522922020-11-14 16:35:34 +01003107 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01003108 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg);
3109 if (status != PSA_SUCCESS) {
3110 return status;
3111 }
3112 if (!(PSA_KEY_TYPE_IS_PUBLIC_KEY(slot->attr.type) ||
3113 PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type))) {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003114 status = PSA_ERROR_INVALID_ARGUMENT;
3115 goto exit;
3116 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003117
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003118 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01003119 .core = slot->attr
Przemyslaw Stekiel19e61422021-12-09 11:09:11 +01003120 };
Steven Cooremana2371e52020-07-28 14:30:39 +02003121
Przemyslaw Stekiel19e61422021-12-09 11:09:11 +01003122 status = psa_driver_wrapper_asymmetric_encrypt(
3123 &attributes, slot->key.data, slot->key.bytes,
3124 alg, input, input_length, salt, salt_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003125 output, output_size, output_length);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003126exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00003127 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003128
Gilles Peskine449bd832023-01-11 14:50:10 +01003129 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003130}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003131
Gilles Peskine449bd832023-01-11 14:50:10 +01003132psa_status_t psa_asymmetric_decrypt(mbedtls_svc_key_id_t key,
3133 psa_algorithm_t alg,
3134 const uint8_t *input,
3135 size_t input_length,
3136 const uint8_t *salt,
3137 size_t salt_length,
3138 uint8_t *output,
3139 size_t output_size,
3140 size_t *output_length)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003141{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003142 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003143 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003144 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003145 psa_key_attributes_t attributes;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003146
Darryl Green5cc689a2018-07-24 15:34:10 +01003147 (void) input;
3148 (void) input_length;
3149 (void) salt;
3150 (void) output;
3151 (void) output_size;
3152
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003153 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003154
Gilles Peskine449bd832023-01-11 14:50:10 +01003155 if (!PSA_ALG_IS_RSA_OAEP(alg) && salt_length != 0) {
3156 return PSA_ERROR_INVALID_ARGUMENT;
3157 }
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003158
Ronald Cron5c522922020-11-14 16:35:34 +01003159 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01003160 key, &slot, PSA_KEY_USAGE_DECRYPT, alg);
3161 if (status != PSA_SUCCESS) {
3162 return status;
3163 }
3164 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003165 status = PSA_ERROR_INVALID_ARGUMENT;
3166 goto exit;
3167 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003168
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003169 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01003170 .core = slot->attr
Przemyslaw Stekiel8d45c002021-12-13 08:58:19 +01003171 };
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003172
Przemyslaw Stekiel8d45c002021-12-13 08:58:19 +01003173 status = psa_driver_wrapper_asymmetric_decrypt(
3174 &attributes, slot->key.data, slot->key.bytes,
3175 alg, input, input_length, salt, salt_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003176 output, output_size, output_length);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003177
3178exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00003179 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003180
Gilles Peskine449bd832023-01-11 14:50:10 +01003181 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003182}
Gilles Peskinee59236f2018-01-27 23:32:46 +01003183
Paul Elliott9fe12f62022-11-30 19:16:02 +00003184/****************************************************************/
3185/* Asymmetric interruptible cryptography */
3186/****************************************************************/
3187
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003188static uint32_t psa_interruptible_max_ops = PSA_INTERRUPTIBLE_MAX_OPS_UNLIMITED;
3189
Paul Elliott9fe12f62022-11-30 19:16:02 +00003190void psa_interruptible_set_max_ops(uint32_t max_ops)
3191{
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003192 psa_interruptible_max_ops = max_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003193}
3194
3195uint32_t psa_interruptible_get_max_ops(void)
3196{
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003197 return psa_interruptible_max_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003198}
3199
Paul Elliott9fe12f62022-11-30 19:16:02 +00003200uint32_t psa_sign_hash_get_num_ops(
3201 const psa_sign_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
3206uint32_t psa_verify_hash_get_num_ops(
3207 const psa_verify_hash_interruptible_operation_t *operation)
3208{
Paul Elliott296ede92022-12-15 17:00:30 +00003209 return operation->num_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003210}
3211
Paul Elliott59ad9452022-12-18 15:09:02 +00003212static psa_status_t psa_sign_hash_abort_internal(
3213 psa_sign_hash_interruptible_operation_t *operation)
3214{
3215 if (operation->id == 0) {
3216 /* The object has (apparently) been initialized but it is not (yet)
3217 * in use. It's ok to call abort on such an object, and there's
3218 * nothing to do. */
3219 return PSA_SUCCESS;
3220 }
3221
3222 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3223
3224 status = psa_driver_wrapper_sign_hash_abort(operation);
3225
3226 operation->id = 0;
3227
Paul Elliotte6145dc2023-02-07 12:51:21 +00003228 /* Do not clear either the error_occurred or num_ops elements here as they
3229 * only want to be cleared by the application calling abort, not by abort
3230 * being called at completion of an operation. */
3231
Paul Elliott59ad9452022-12-18 15:09:02 +00003232 return status;
3233}
3234
Paul Elliott9fe12f62022-11-30 19:16:02 +00003235psa_status_t psa_sign_hash_start(
3236 psa_sign_hash_interruptible_operation_t *operation,
3237 mbedtls_svc_key_id_t key, psa_algorithm_t alg,
3238 const uint8_t *hash, size_t hash_length)
3239{
3240 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3241 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3242 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003243 psa_key_attributes_t attributes;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003244
Paul Elliottc9774412023-02-06 15:14:07 +00003245 /* Check that start has not been previously called, or operation has not
3246 * previously errored. */
3247 if (operation->id != 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003248 return PSA_ERROR_BAD_STATE;
3249 }
3250
Paul Elliott9fe12f62022-11-30 19:16:02 +00003251 status = psa_sign_verify_check_alg(0, alg);
3252 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003253 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003254 return status;
3255 }
3256
3257 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
3258 PSA_KEY_USAGE_SIGN_HASH,
3259 alg);
3260
3261 if (status != PSA_SUCCESS) {
3262 goto exit;
3263 }
3264
3265 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
3266 status = PSA_ERROR_INVALID_ARGUMENT;
3267 goto exit;
3268 }
3269
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003270 attributes = (psa_key_attributes_t) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003271 .core = slot->attr
3272 };
3273
Paul Elliott296ede92022-12-15 17:00:30 +00003274 /* Ensure ops count gets reset, in case of operation re-use. */
3275 operation->num_ops = 0;
3276
Paul Elliott9fe12f62022-11-30 19:16:02 +00003277 status = psa_driver_wrapper_sign_hash_start(operation, &attributes,
3278 slot->key.data,
3279 slot->key.bytes, alg,
3280 hash, hash_length);
3281exit:
3282
3283 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003284 operation->error_occurred = 1;
Paul Elliott59ad9452022-12-18 15:09:02 +00003285 psa_sign_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003286 }
3287
Ryan Everett1b70a072024-01-04 10:32:49 +00003288 unlock_status = psa_unregister_read(slot);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003289
Paul Elliottc9774412023-02-06 15:14:07 +00003290 if (unlock_status != PSA_SUCCESS) {
3291 operation->error_occurred = 1;
3292 }
Paul Elliott9fe12f62022-11-30 19:16:02 +00003293
Paul Elliottc9774412023-02-06 15:14:07 +00003294 return (status == PSA_SUCCESS) ? unlock_status : status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003295}
3296
3297
3298psa_status_t psa_sign_hash_complete(
3299 psa_sign_hash_interruptible_operation_t *operation,
3300 uint8_t *signature, size_t signature_size,
3301 size_t *signature_length)
3302{
3303 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3304
3305 *signature_length = 0;
3306
Paul Elliottc9774412023-02-06 15:14:07 +00003307 /* Check that start has been called first, and that operation has not
3308 * previously errored. */
3309 if (operation->id == 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003310 status = PSA_ERROR_BAD_STATE;
3311 goto exit;
3312 }
3313
Paul Elliott096abc42023-02-03 18:33:23 +00003314 /* Immediately reject a zero-length signature buffer. This guarantees that
3315 * signature must be a valid pointer. */
Paul Elliott9fe12f62022-11-30 19:16:02 +00003316 if (signature_size == 0) {
3317 status = PSA_ERROR_BUFFER_TOO_SMALL;
3318 goto exit;
3319 }
3320
3321 status = psa_driver_wrapper_sign_hash_complete(operation, signature,
3322 signature_size,
3323 signature_length);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003324
Paul Elliott296ede92022-12-15 17:00:30 +00003325 /* Update ops count with work done. */
Paul Elliottde1114c2023-02-07 12:43:11 +00003326 operation->num_ops = psa_driver_wrapper_sign_hash_get_num_ops(operation);
Paul Elliott296ede92022-12-15 17:00:30 +00003327
Paul Elliottebe225c2023-02-10 14:32:53 +00003328exit:
3329
Paul Elliott59200a22023-02-21 15:07:40 +00003330 psa_wipe_tag_output_buffer(signature, status, signature_size,
3331 *signature_length);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003332
Paul Elliott53bb3122023-02-10 14:22:22 +00003333 if (status != PSA_OPERATION_INCOMPLETE) {
Paul Elliottc9774412023-02-06 15:14:07 +00003334 if (status != PSA_SUCCESS) {
3335 operation->error_occurred = 1;
3336 }
3337
Paul Elliott59ad9452022-12-18 15:09:02 +00003338 psa_sign_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003339 }
3340
3341 return status;
3342}
3343
3344psa_status_t psa_sign_hash_abort(
3345 psa_sign_hash_interruptible_operation_t *operation)
3346{
Paul Elliott59ad9452022-12-18 15:09:02 +00003347 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3348
3349 status = psa_sign_hash_abort_internal(operation);
3350
3351 /* We clear the number of ops done here, so that it is not cleared when
3352 * the operation fails or succeeds, only on manual abort. */
3353 operation->num_ops = 0;
3354
Paul Elliottc9774412023-02-06 15:14:07 +00003355 /* Likewise, failure state. */
3356 operation->error_occurred = 0;
3357
Paul Elliott59ad9452022-12-18 15:09:02 +00003358 return status;
3359}
3360
3361static psa_status_t psa_verify_hash_abort_internal(
3362 psa_verify_hash_interruptible_operation_t *operation)
3363{
Paul Elliott9fe12f62022-11-30 19:16:02 +00003364 if (operation->id == 0) {
3365 /* The object has (apparently) been initialized but it is not (yet)
3366 * in use. It's ok to call abort on such an object, and there's
3367 * nothing to do. */
3368 return PSA_SUCCESS;
3369 }
3370
Paul Elliott59ad9452022-12-18 15:09:02 +00003371 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3372
3373 status = psa_driver_wrapper_verify_hash_abort(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003374
3375 operation->id = 0;
3376
Paul Elliotte6145dc2023-02-07 12:51:21 +00003377 /* Do not clear either the error_occurred or num_ops elements here as they
3378 * only want to be cleared by the application calling abort, not by abort
3379 * being called at completion of an operation. */
3380
Paul Elliott59ad9452022-12-18 15:09:02 +00003381 return status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003382}
3383
3384psa_status_t psa_verify_hash_start(
3385 psa_verify_hash_interruptible_operation_t *operation,
3386 mbedtls_svc_key_id_t key, psa_algorithm_t alg,
3387 const uint8_t *hash, size_t hash_length,
3388 const uint8_t *signature, size_t signature_length)
3389{
3390 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3391 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3392 psa_key_slot_t *slot;
3393
Paul Elliottc9774412023-02-06 15:14:07 +00003394 /* Check that start has not been previously called, or operation has not
3395 * previously errored. */
3396 if (operation->id != 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003397 return PSA_ERROR_BAD_STATE;
3398 }
3399
3400 status = psa_sign_verify_check_alg(0, alg);
3401 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003402 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003403 return status;
3404 }
3405
3406 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
3407 PSA_KEY_USAGE_VERIFY_HASH,
3408 alg);
3409
3410 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003411 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003412 return status;
3413 }
3414
3415 psa_key_attributes_t attributes = {
3416 .core = slot->attr
3417 };
3418
Paul Elliott296ede92022-12-15 17:00:30 +00003419 /* Ensure ops count gets reset, in case of operation re-use. */
3420 operation->num_ops = 0;
3421
Paul Elliott9fe12f62022-11-30 19:16:02 +00003422 status = psa_driver_wrapper_verify_hash_start(operation, &attributes,
3423 slot->key.data,
3424 slot->key.bytes,
3425 alg, hash, hash_length,
3426 signature, signature_length);
3427
3428 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003429 operation->error_occurred = 1;
Paul Elliott59ad9452022-12-18 15:09:02 +00003430 psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003431 }
3432
Ryan Everett1b70a072024-01-04 10:32:49 +00003433 unlock_status = psa_unregister_read(slot);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003434
Paul Elliottc9774412023-02-06 15:14:07 +00003435 if (unlock_status != PSA_SUCCESS) {
3436 operation->error_occurred = 1;
3437 }
Paul Elliott9fe12f62022-11-30 19:16:02 +00003438
Paul Elliottc9774412023-02-06 15:14:07 +00003439 return (status == PSA_SUCCESS) ? unlock_status : status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003440}
3441
3442psa_status_t psa_verify_hash_complete(
3443 psa_verify_hash_interruptible_operation_t *operation)
3444{
3445 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3446
Paul Elliottc9774412023-02-06 15:14:07 +00003447 /* Check that start has been called first, and that operation has not
3448 * previously errored. */
3449 if (operation->id == 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003450 status = PSA_ERROR_BAD_STATE;
3451 goto exit;
3452 }
3453
3454 status = psa_driver_wrapper_verify_hash_complete(operation);
3455
Paul Elliott296ede92022-12-15 17:00:30 +00003456 /* Update ops count with work done. */
Paul Elliottde1114c2023-02-07 12:43:11 +00003457 operation->num_ops = psa_driver_wrapper_verify_hash_get_num_ops(
Paul Elliott296ede92022-12-15 17:00:30 +00003458 operation);
3459
Paul Elliottebe225c2023-02-10 14:32:53 +00003460exit:
3461
Paul Elliott9fe12f62022-11-30 19:16:02 +00003462 if (status != PSA_OPERATION_INCOMPLETE) {
Paul Elliottc9774412023-02-06 15:14:07 +00003463 if (status != PSA_SUCCESS) {
3464 operation->error_occurred = 1;
3465 }
3466
Paul Elliott59ad9452022-12-18 15:09:02 +00003467 psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003468 }
3469
3470 return status;
3471}
3472
3473psa_status_t psa_verify_hash_abort(
3474 psa_verify_hash_interruptible_operation_t *operation)
3475{
Paul Elliott59ad9452022-12-18 15:09:02 +00003476 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003477
Paul Elliott59ad9452022-12-18 15:09:02 +00003478 status = psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003479
Paul Elliott59ad9452022-12-18 15:09:02 +00003480 /* We clear the number of ops done here, so that it is not cleared when
3481 * the operation fails or succeeds, only on manual abort. */
3482 operation->num_ops = 0;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003483
Paul Elliottc9774412023-02-06 15:14:07 +00003484 /* Likewise, failure state. */
3485 operation->error_occurred = 0;
3486
Paul Elliott59ad9452022-12-18 15:09:02 +00003487 return status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003488}
3489
Paul Elliott588f8ed2022-12-02 18:10:26 +00003490/****************************************************************/
3491/* Asymmetric interruptible cryptography internal */
3492/* implementations */
3493/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003494
Paul Elliott588f8ed2022-12-02 18:10:26 +00003495void mbedtls_psa_interruptible_set_max_ops(uint32_t max_ops)
3496{
Paul Elliott7cc4e812023-01-10 17:14:11 +00003497
Paul Elliott588f8ed2022-12-02 18:10:26 +00003498#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3499 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3500 defined(MBEDTLS_ECP_RESTARTABLE)
3501
3502 /* Internal implementation uses zero to indicate infinite number max ops,
3503 * therefore avoid this value, and set to minimum possible. */
3504 if (max_ops == 0) {
3505 max_ops = 1;
3506 }
3507
Paul Elliott588f8ed2022-12-02 18:10:26 +00003508 mbedtls_ecp_set_max_ops(max_ops);
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003509#else
3510 (void) max_ops;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003511#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3512 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3513 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3514}
3515
Paul Elliott588f8ed2022-12-02 18:10:26 +00003516uint32_t mbedtls_psa_sign_hash_get_num_ops(
Paul Elliottf8e5b562023-02-19 18:43:45 +00003517 const mbedtls_psa_sign_hash_interruptible_operation_t *operation)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003518{
3519#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3520 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3521 defined(MBEDTLS_ECP_RESTARTABLE)
3522
Paul Elliott93d9ca82023-02-15 18:14:21 +00003523 return operation->num_ops;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003524#else
3525 (void) operation;
3526 return 0;
3527#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3528 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3529 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3530}
3531
3532uint32_t mbedtls_psa_verify_hash_get_num_ops(
Paul Elliottf8e5b562023-02-19 18:43:45 +00003533 const mbedtls_psa_verify_hash_interruptible_operation_t *operation)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003534{
3535 #if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3536 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3537 defined(MBEDTLS_ECP_RESTARTABLE)
3538
Paul Elliott93d9ca82023-02-15 18:14:21 +00003539 return operation->num_ops;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003540#else
3541 (void) operation;
3542 return 0;
3543#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3544 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3545 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3546}
3547
3548psa_status_t mbedtls_psa_sign_hash_start(
3549 mbedtls_psa_sign_hash_interruptible_operation_t *operation,
3550 const psa_key_attributes_t *attributes, const uint8_t *key_buffer,
3551 size_t key_buffer_size, psa_algorithm_t alg,
3552 const uint8_t *hash, size_t hash_length)
3553{
3554 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott0290a762023-02-09 14:30:24 +00003555 size_t required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003556
Paul Elliott068fe072023-01-16 13:59:15 +00003557 if (!PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3558 return PSA_ERROR_NOT_SUPPORTED;
3559 }
3560
3561 if (!PSA_ALG_IS_ECDSA(alg)) {
Paul Elliott813f9cd2023-02-05 15:28:46 +00003562 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott068fe072023-01-16 13:59:15 +00003563 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003564
3565#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Paul Elliott068fe072023-01-16 13:59:15 +00003566 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3567 defined(MBEDTLS_ECP_RESTARTABLE)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003568
Paul Elliotta1c94092023-02-15 16:38:04 +00003569 mbedtls_ecdsa_restart_init(&operation->restart_ctx);
3570
Paul Elliott93d9ca82023-02-15 18:14:21 +00003571 /* Ensure num_ops is zero'ed in case of context re-use. */
3572 operation->num_ops = 0;
3573
Paul Elliott068fe072023-01-16 13:59:15 +00003574 status = mbedtls_psa_ecp_load_representation(attributes->core.type,
3575 attributes->core.bits,
3576 key_buffer,
3577 key_buffer_size,
3578 &operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003579
Paul Elliott068fe072023-01-16 13:59:15 +00003580 if (status != PSA_SUCCESS) {
3581 return status;
3582 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003583
Paul Elliott1bc59df2023-02-05 13:41:57 +00003584 operation->coordinate_bytes = PSA_BITS_TO_BYTES(
Paul Elliottc569fc22023-02-10 13:02:54 +00003585 operation->ctx->grp.nbits);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003586
Paul Elliott068fe072023-01-16 13:59:15 +00003587 psa_algorithm_t hash_alg = PSA_ALG_SIGN_GET_HASH(alg);
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02003588 operation->md_alg = mbedtls_md_type_from_psa_alg(hash_alg);
Paul Elliott068fe072023-01-16 13:59:15 +00003589 operation->alg = alg;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003590
Paul Elliott0290a762023-02-09 14:30:24 +00003591 /* We only need to store the same length of hash as the private key size
3592 * here, it would be truncated by the internal implementation anyway. */
3593 required_hash_length = (hash_length < operation->coordinate_bytes ?
3594 hash_length : operation->coordinate_bytes);
3595
Paul Elliottba70ad42023-02-15 18:23:53 +00003596 if (required_hash_length > sizeof(operation->hash)) {
3597 /* Shouldn't happen, but better safe than sorry. */
3598 return PSA_ERROR_CORRUPTION_DETECTED;
3599 }
3600
Paul Elliott0290a762023-02-09 14:30:24 +00003601 memcpy(operation->hash, hash, required_hash_length);
3602 operation->hash_length = required_hash_length;
Paul Elliott068fe072023-01-16 13:59:15 +00003603
3604 return PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003605
3606#else
Paul Elliott068fe072023-01-16 13:59:15 +00003607 (void) operation;
3608 (void) key_buffer;
3609 (void) key_buffer_size;
3610 (void) alg;
3611 (void) hash;
3612 (void) hash_length;
3613 (void) status;
Paul Elliott0290a762023-02-09 14:30:24 +00003614 (void) required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003615
Paul Elliott068fe072023-01-16 13:59:15 +00003616 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003617#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3618 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3619 * defined( MBEDTLS_ECP_RESTARTABLE ) */
Paul Elliott588f8ed2022-12-02 18:10:26 +00003620}
3621
3622psa_status_t mbedtls_psa_sign_hash_complete(
3623 mbedtls_psa_sign_hash_interruptible_operation_t *operation,
3624 uint8_t *signature, size_t signature_size,
3625 size_t *signature_length)
3626{
Paul Elliott588f8ed2022-12-02 18:10:26 +00003627#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3628 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3629 defined(MBEDTLS_ECP_RESTARTABLE)
3630
Paul Elliotta1c94092023-02-15 16:38:04 +00003631 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott1243f932023-02-07 11:21:10 +00003632 mbedtls_mpi r;
3633 mbedtls_mpi s;
3634
Paul Elliott46845252023-02-03 14:59:11 +00003635 mbedtls_mpi_init(&r);
3636 mbedtls_mpi_init(&s);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003637
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003638 /* Ensure max_ops is set to the current value (or default). */
3639 mbedtls_psa_interruptible_set_max_ops(psa_interruptible_get_max_ops());
3640
Paul Elliotta1c94092023-02-15 16:38:04 +00003641 if (signature_size < 2 * operation->coordinate_bytes) {
3642 status = PSA_ERROR_BUFFER_TOO_SMALL;
3643 goto exit;
3644 }
3645
Paul Elliott588f8ed2022-12-02 18:10:26 +00003646 if (PSA_ALG_ECDSA_IS_DETERMINISTIC(operation->alg)) {
Paul Elliott46845252023-02-03 14:59:11 +00003647
Paul Elliott588f8ed2022-12-02 18:10:26 +00003648#if defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3649 status = mbedtls_to_psa_error(
3650 mbedtls_ecdsa_sign_det_restartable(&operation->ctx->grp,
Paul Elliott46845252023-02-03 14:59:11 +00003651 &r,
3652 &s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003653 &operation->ctx->d,
3654 operation->hash,
3655 operation->hash_length,
3656 operation->md_alg,
3657 mbedtls_psa_get_random,
3658 MBEDTLS_PSA_RANDOM_STATE,
3659 &operation->restart_ctx));
3660#else /* defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Paul Elliott724bd252023-02-08 12:35:08 +00003661 status = PSA_ERROR_NOT_SUPPORTED;
3662 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003663#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
3664 } else {
Paul Elliott588f8ed2022-12-02 18:10:26 +00003665 status = mbedtls_to_psa_error(
3666 mbedtls_ecdsa_sign_restartable(&operation->ctx->grp,
Paul Elliott46845252023-02-03 14:59:11 +00003667 &r,
3668 &s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003669 &operation->ctx->d,
3670 operation->hash,
3671 operation->hash_length,
3672 mbedtls_psa_get_random,
3673 MBEDTLS_PSA_RANDOM_STATE,
3674 mbedtls_psa_get_random,
3675 MBEDTLS_PSA_RANDOM_STATE,
3676 &operation->restart_ctx));
3677 }
3678
Paul Elliottf8e5b562023-02-19 18:43:45 +00003679 /* Hide the fact that the restart context only holds a delta of number of
3680 * ops done during the last operation, not an absolute value. */
3681 operation->num_ops += operation->restart_ctx.ecp.ops_done;
3682
Paul Elliott724bd252023-02-08 12:35:08 +00003683 if (status == PSA_SUCCESS) {
Paul Elliott588f8ed2022-12-02 18:10:26 +00003684 status = mbedtls_to_psa_error(
Paul Elliott46845252023-02-03 14:59:11 +00003685 mbedtls_mpi_write_binary(&r,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003686 signature,
Paul Elliott1bc59df2023-02-05 13:41:57 +00003687 operation->coordinate_bytes)
3688 );
Paul Elliott588f8ed2022-12-02 18:10:26 +00003689
3690 if (status != PSA_SUCCESS) {
Paul Elliott724bd252023-02-08 12:35:08 +00003691 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003692 }
3693
3694 status = mbedtls_to_psa_error(
Paul Elliott46845252023-02-03 14:59:11 +00003695 mbedtls_mpi_write_binary(&s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003696 signature +
Paul Elliott1bc59df2023-02-05 13:41:57 +00003697 operation->coordinate_bytes,
3698 operation->coordinate_bytes)
3699 );
Paul Elliott588f8ed2022-12-02 18:10:26 +00003700
3701 if (status != PSA_SUCCESS) {
Paul Elliott724bd252023-02-08 12:35:08 +00003702 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003703 }
3704
Paul Elliott1bc59df2023-02-05 13:41:57 +00003705 *signature_length = operation->coordinate_bytes * 2;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003706
Paul Elliott724bd252023-02-08 12:35:08 +00003707 status = PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003708 }
Paul Elliott724bd252023-02-08 12:35:08 +00003709
3710exit:
3711
3712 mbedtls_mpi_free(&r);
3713 mbedtls_mpi_free(&s);
3714 return status;
3715
Paul Elliott588f8ed2022-12-02 18:10:26 +00003716 #else
3717
3718 (void) operation;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003719 (void) signature;
3720 (void) signature_size;
3721 (void) signature_length;
3722
3723 return PSA_ERROR_NOT_SUPPORTED;
3724
3725#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3726 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3727 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3728}
3729
3730psa_status_t mbedtls_psa_sign_hash_abort(
3731 mbedtls_psa_sign_hash_interruptible_operation_t *operation)
3732{
3733
3734#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3735 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3736 defined(MBEDTLS_ECP_RESTARTABLE)
3737
3738 if (operation->ctx) {
3739 mbedtls_ecdsa_free(operation->ctx);
3740 mbedtls_free(operation->ctx);
Paul Elliottf9c91a72023-02-05 18:06:38 +00003741 operation->ctx = NULL;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003742 }
3743
3744 mbedtls_ecdsa_restart_free(&operation->restart_ctx);
3745
Paul Elliott93d9ca82023-02-15 18:14:21 +00003746 operation->num_ops = 0;
3747
Paul Elliott588f8ed2022-12-02 18:10:26 +00003748 return PSA_SUCCESS;
3749
3750#else
3751
3752 (void) operation;
3753
3754 return PSA_ERROR_NOT_SUPPORTED;
3755
3756#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3757 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3758 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3759}
3760
3761psa_status_t mbedtls_psa_verify_hash_start(
3762 mbedtls_psa_verify_hash_interruptible_operation_t *operation,
3763 const psa_key_attributes_t *attributes,
3764 const uint8_t *key_buffer, size_t key_buffer_size,
3765 psa_algorithm_t alg,
3766 const uint8_t *hash, size_t hash_length,
3767 const uint8_t *signature, size_t signature_length)
3768{
3769 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott1bc59df2023-02-05 13:41:57 +00003770 size_t coordinate_bytes = 0;
Paul Elliott0290a762023-02-09 14:30:24 +00003771 size_t required_hash_length = 0;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003772
Paul Elliott068fe072023-01-16 13:59:15 +00003773 if (!PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3774 return PSA_ERROR_NOT_SUPPORTED;
3775 }
3776
3777 if (!PSA_ALG_IS_ECDSA(alg)) {
Paul Elliott813f9cd2023-02-05 15:28:46 +00003778 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott068fe072023-01-16 13:59:15 +00003779 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003780
3781#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Paul Elliott068fe072023-01-16 13:59:15 +00003782 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3783 defined(MBEDTLS_ECP_RESTARTABLE)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003784
Paul Elliotta1c94092023-02-15 16:38:04 +00003785 mbedtls_ecdsa_restart_init(&operation->restart_ctx);
3786 mbedtls_mpi_init(&operation->r);
3787 mbedtls_mpi_init(&operation->s);
3788
Paul Elliott93d9ca82023-02-15 18:14:21 +00003789 /* Ensure num_ops is zero'ed in case of context re-use. */
3790 operation->num_ops = 0;
3791
Paul Elliott068fe072023-01-16 13:59:15 +00003792 status = mbedtls_psa_ecp_load_representation(attributes->core.type,
3793 attributes->core.bits,
3794 key_buffer,
3795 key_buffer_size,
3796 &operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003797
Paul Elliott068fe072023-01-16 13:59:15 +00003798 if (status != PSA_SUCCESS) {
3799 return status;
3800 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003801
Paul Elliottc569fc22023-02-10 13:02:54 +00003802 coordinate_bytes = PSA_BITS_TO_BYTES(operation->ctx->grp.nbits);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003803
Paul Elliott1bc59df2023-02-05 13:41:57 +00003804 if (signature_length != 2 * coordinate_bytes) {
Paul Elliott068fe072023-01-16 13:59:15 +00003805 return PSA_ERROR_INVALID_SIGNATURE;
3806 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003807
Paul Elliott068fe072023-01-16 13:59:15 +00003808 status = mbedtls_to_psa_error(
3809 mbedtls_mpi_read_binary(&operation->r,
3810 signature,
Paul Elliott1bc59df2023-02-05 13:41:57 +00003811 coordinate_bytes));
Paul Elliott588f8ed2022-12-02 18:10:26 +00003812
Paul Elliott068fe072023-01-16 13:59:15 +00003813 if (status != PSA_SUCCESS) {
3814 return status;
3815 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003816
Paul Elliott068fe072023-01-16 13:59:15 +00003817 status = mbedtls_to_psa_error(
3818 mbedtls_mpi_read_binary(&operation->s,
3819 signature +
Paul Elliott1bc59df2023-02-05 13:41:57 +00003820 coordinate_bytes,
3821 coordinate_bytes));
Paul Elliott588f8ed2022-12-02 18:10:26 +00003822
Paul Elliott068fe072023-01-16 13:59:15 +00003823 if (status != PSA_SUCCESS) {
3824 return status;
3825 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003826
Paul Elliott2c9843f2023-02-15 17:32:42 +00003827 status = mbedtls_psa_ecp_load_public_part(operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003828
Paul Elliott2c9843f2023-02-15 17:32:42 +00003829 if (status != PSA_SUCCESS) {
3830 return status;
Paul Elliott068fe072023-01-16 13:59:15 +00003831 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003832
Paul Elliott0290a762023-02-09 14:30:24 +00003833 /* We only need to store the same length of hash as the private key size
3834 * here, it would be truncated by the internal implementation anyway. */
3835 required_hash_length = (hash_length < coordinate_bytes ? hash_length :
3836 coordinate_bytes);
3837
Paul Elliottba70ad42023-02-15 18:23:53 +00003838 if (required_hash_length > sizeof(operation->hash)) {
3839 /* Shouldn't happen, but better safe than sorry. */
3840 return PSA_ERROR_CORRUPTION_DETECTED;
3841 }
3842
Paul Elliott0290a762023-02-09 14:30:24 +00003843 memcpy(operation->hash, hash, required_hash_length);
3844 operation->hash_length = required_hash_length;
Paul Elliott068fe072023-01-16 13:59:15 +00003845
3846 return PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003847#else
Paul Elliott068fe072023-01-16 13:59:15 +00003848 (void) operation;
3849 (void) key_buffer;
3850 (void) key_buffer_size;
3851 (void) alg;
3852 (void) hash;
3853 (void) hash_length;
3854 (void) signature;
3855 (void) signature_length;
3856 (void) status;
Paul Elliott1243f932023-02-07 11:21:10 +00003857 (void) coordinate_bytes;
Paul Elliott0290a762023-02-09 14:30:24 +00003858 (void) required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003859
Paul Elliott068fe072023-01-16 13:59:15 +00003860 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003861#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3862 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3863 * defined( MBEDTLS_ECP_RESTARTABLE ) */
Paul Elliott588f8ed2022-12-02 18:10:26 +00003864}
3865
3866psa_status_t mbedtls_psa_verify_hash_complete(
3867 mbedtls_psa_verify_hash_interruptible_operation_t *operation)
3868{
3869
3870#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3871 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3872 defined(MBEDTLS_ECP_RESTARTABLE)
3873
Paul Elliottf8e5b562023-02-19 18:43:45 +00003874 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3875
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003876 /* Ensure max_ops is set to the current value (or default). */
3877 mbedtls_psa_interruptible_set_max_ops(psa_interruptible_get_max_ops());
3878
Paul Elliottf8e5b562023-02-19 18:43:45 +00003879 status = mbedtls_to_psa_error(
Paul Elliott588f8ed2022-12-02 18:10:26 +00003880 mbedtls_ecdsa_verify_restartable(&operation->ctx->grp,
3881 operation->hash,
3882 operation->hash_length,
3883 &operation->ctx->Q,
3884 &operation->r,
3885 &operation->s,
3886 &operation->restart_ctx));
3887
Paul Elliottf8e5b562023-02-19 18:43:45 +00003888 /* Hide the fact that the restart context only holds a delta of number of
3889 * ops done during the last operation, not an absolute value. */
3890 operation->num_ops += operation->restart_ctx.ecp.ops_done;
3891
3892 return status;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003893#else
3894 (void) operation;
3895
3896 return PSA_ERROR_NOT_SUPPORTED;
3897
3898#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3899 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3900 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3901}
3902
3903psa_status_t mbedtls_psa_verify_hash_abort(
3904 mbedtls_psa_verify_hash_interruptible_operation_t *operation)
3905{
3906
3907#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3908 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3909 defined(MBEDTLS_ECP_RESTARTABLE)
3910
3911 if (operation->ctx) {
3912 mbedtls_ecdsa_free(operation->ctx);
3913 mbedtls_free(operation->ctx);
Paul Elliottf9c91a72023-02-05 18:06:38 +00003914 operation->ctx = NULL;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003915 }
3916
3917 mbedtls_ecdsa_restart_free(&operation->restart_ctx);
3918
Paul Elliott93d9ca82023-02-15 18:14:21 +00003919 operation->num_ops = 0;
3920
Paul Elliott588f8ed2022-12-02 18:10:26 +00003921 mbedtls_mpi_free(&operation->r);
3922 mbedtls_mpi_free(&operation->s);
3923
3924 return PSA_SUCCESS;
3925
3926#else
3927 (void) operation;
3928
3929 return PSA_ERROR_NOT_SUPPORTED;
3930
3931#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3932 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3933 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3934}
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003935
mohammad1603503973b2018-03-12 15:59:30 +02003936/****************************************************************/
3937/* Symmetric cryptography */
3938/****************************************************************/
3939
Gilles Peskine449bd832023-01-11 14:50:10 +01003940static psa_status_t psa_cipher_setup(psa_cipher_operation_t *operation,
3941 mbedtls_svc_key_id_t key,
3942 psa_algorithm_t alg,
3943 mbedtls_operation_t cipher_operation)
Ronald Cronab99ac22020-10-01 16:38:28 +02003944{
3945 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3946 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman54648242021-06-24 11:49:45 +01003947 psa_key_slot_t *slot = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01003948 psa_key_usage_t usage = (cipher_operation == MBEDTLS_ENCRYPT ?
3949 PSA_KEY_USAGE_ENCRYPT :
3950 PSA_KEY_USAGE_DECRYPT);
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003951 psa_key_attributes_t attributes;
Ronald Cronab99ac22020-10-01 16:38:28 +02003952
3953 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003954 if (operation->id != 0) {
Dave Rodgman54648242021-06-24 11:49:45 +01003955 status = PSA_ERROR_BAD_STATE;
3956 goto exit;
3957 }
Ronald Cronab99ac22020-10-01 16:38:28 +02003958
Gilles Peskine449bd832023-01-11 14:50:10 +01003959 if (!PSA_ALG_IS_CIPHER(alg)) {
Dave Rodgman54648242021-06-24 11:49:45 +01003960 status = PSA_ERROR_INVALID_ARGUMENT;
3961 goto exit;
3962 }
Ronald Cronab99ac22020-10-01 16:38:28 +02003963
Gilles Peskine449bd832023-01-11 14:50:10 +01003964 status = psa_get_and_lock_key_slot_with_policy(key, &slot, usage, alg);
3965 if (status != PSA_SUCCESS) {
Ronald Cronab99ac22020-10-01 16:38:28 +02003966 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01003967 }
Ronald Cronab99ac22020-10-01 16:38:28 +02003968
Ronald Cron49fafa92021-03-10 08:34:23 +01003969 /* Initialize the operation struct members, except for id. The id member
Ronald Cronab99ac22020-10-01 16:38:28 +02003970 * is used to indicate to psa_cipher_abort that there are resources to free,
Ronald Cron49fafa92021-03-10 08:34:23 +01003971 * so we only set it (in the driver wrapper) after resources have been
3972 * allocated/initialized. */
Ronald Cronab99ac22020-10-01 16:38:28 +02003973 operation->iv_set = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01003974 if (alg == PSA_ALG_ECB_NO_PADDING) {
Ronald Cronab99ac22020-10-01 16:38:28 +02003975 operation->iv_required = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01003976 } else {
Ronald Cronab99ac22020-10-01 16:38:28 +02003977 operation->iv_required = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003978 }
3979 operation->default_iv_length = PSA_CIPHER_IV_LENGTH(slot->attr.type, alg);
Ronald Cronab99ac22020-10-01 16:38:28 +02003980
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003981 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01003982 .core = slot->attr
Ronald Crona4af55f2020-12-14 14:36:06 +01003983 };
3984
Ronald Cronab99ac22020-10-01 16:38:28 +02003985 /* Try doing the operation through a driver before using software fallback. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003986 if (cipher_operation == MBEDTLS_ENCRYPT) {
3987 status = psa_driver_wrapper_cipher_encrypt_setup(operation,
3988 &attributes,
3989 slot->key.data,
3990 slot->key.bytes,
3991 alg);
3992 } else {
3993 status = psa_driver_wrapper_cipher_decrypt_setup(operation,
3994 &attributes,
3995 slot->key.data,
3996 slot->key.bytes,
3997 alg);
3998 }
Ronald Cronab99ac22020-10-01 16:38:28 +02003999
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004000exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004001 if (status != PSA_SUCCESS) {
4002 psa_cipher_abort(operation);
4003 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004004
Ryan Everett1b70a072024-01-04 10:32:49 +00004005 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02004006
Gilles Peskine449bd832023-01-11 14:50:10 +01004007 return (status == PSA_SUCCESS) ? unlock_status : status;
mohammad1603503973b2018-03-12 15:59:30 +02004008}
4009
Gilles Peskine449bd832023-01-11 14:50:10 +01004010psa_status_t psa_cipher_encrypt_setup(psa_cipher_operation_t *operation,
4011 mbedtls_svc_key_id_t key,
4012 psa_algorithm_t alg)
mohammad16038481e742018-03-18 13:57:31 +02004013{
Gilles Peskine449bd832023-01-11 14:50:10 +01004014 return psa_cipher_setup(operation, key, alg, MBEDTLS_ENCRYPT);
mohammad16038481e742018-03-18 13:57:31 +02004015}
4016
Gilles Peskine449bd832023-01-11 14:50:10 +01004017psa_status_t psa_cipher_decrypt_setup(psa_cipher_operation_t *operation,
4018 mbedtls_svc_key_id_t key,
4019 psa_algorithm_t alg)
mohammad16038481e742018-03-18 13:57:31 +02004020{
Gilles Peskine449bd832023-01-11 14:50:10 +01004021 return psa_cipher_setup(operation, key, alg, MBEDTLS_DECRYPT);
mohammad16038481e742018-03-18 13:57:31 +02004022}
4023
Gilles Peskine449bd832023-01-11 14:50:10 +01004024psa_status_t psa_cipher_generate_iv(psa_cipher_operation_t *operation,
4025 uint8_t *iv,
4026 size_t iv_size,
4027 size_t *iv_length)
mohammad1603503973b2018-03-12 15:59:30 +02004028{
Ronald Cron6d051732020-10-01 14:10:20 +02004029 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2fb90522021-07-05 12:31:44 +02004030 uint8_t local_iv[PSA_CIPHER_IV_MAX_SIZE];
Sergeybef1f632023-03-06 15:25:06 -07004031 size_t default_iv_length = 0;
Ronald Cron5618a392021-03-26 09:52:26 +01004032
Gilles Peskine449bd832023-01-11 14:50:10 +01004033 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004034 status = PSA_ERROR_BAD_STATE;
4035 goto exit;
Ronald Cronc45b4af2020-09-29 16:18:05 +02004036 }
4037
Gilles Peskine449bd832023-01-11 14:50:10 +01004038 if (operation->iv_set || !operation->iv_required) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004039 status = PSA_ERROR_BAD_STATE;
4040 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004041 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004042
Ronald Cron2fb90522021-07-05 12:31:44 +02004043 default_iv_length = operation->default_iv_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01004044 if (iv_size < default_iv_length) {
Ronald Cron5618a392021-03-26 09:52:26 +01004045 status = PSA_ERROR_BUFFER_TOO_SMALL;
4046 goto exit;
4047 }
Gilles Peskinee553c652018-06-04 16:22:46 +02004048
Gilles Peskine449bd832023-01-11 14:50:10 +01004049 if (default_iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Ronald Cron2fb90522021-07-05 12:31:44 +02004050 status = PSA_ERROR_GENERIC_ERROR;
4051 goto exit;
4052 }
4053
Gilles Peskine449bd832023-01-11 14:50:10 +01004054 status = psa_generate_random(local_iv, default_iv_length);
4055 if (status != PSA_SUCCESS) {
Ronald Cron5618a392021-03-26 09:52:26 +01004056 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004057 }
Ronald Cron5618a392021-03-26 09:52:26 +01004058
Gilles Peskine449bd832023-01-11 14:50:10 +01004059 status = psa_driver_wrapper_cipher_set_iv(operation,
4060 local_iv, default_iv_length);
Ronald Cron5618a392021-03-26 09:52:26 +01004061
4062exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004063 if (status == PSA_SUCCESS) {
4064 memcpy(iv, local_iv, default_iv_length);
Ronald Cron2fb90522021-07-05 12:31:44 +02004065 *iv_length = default_iv_length;
Steven Cooreman7df02922020-09-09 15:28:49 +02004066 operation->iv_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004067 } else {
Ronald Cron2fb90522021-07-05 12:31:44 +02004068 *iv_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004069 psa_cipher_abort(operation);
Ronald Cron2fb90522021-07-05 12:31:44 +02004070 }
Ronald Cron6d051732020-10-01 14:10:20 +02004071
Gilles Peskine449bd832023-01-11 14:50:10 +01004072 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004073}
4074
Gilles Peskine449bd832023-01-11 14:50:10 +01004075psa_status_t psa_cipher_set_iv(psa_cipher_operation_t *operation,
4076 const uint8_t *iv,
4077 size_t iv_length)
mohammad1603503973b2018-03-12 15:59:30 +02004078{
Ronald Cron6d051732020-10-01 14:10:20 +02004079 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronc45b4af2020-09-29 16:18:05 +02004080
Gilles Peskine449bd832023-01-11 14:50:10 +01004081 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004082 status = PSA_ERROR_BAD_STATE;
4083 goto exit;
4084 }
Ronald Cronc45b4af2020-09-29 16:18:05 +02004085
Gilles Peskine449bd832023-01-11 14:50:10 +01004086 if (operation->iv_set || !operation->iv_required) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004087 status = PSA_ERROR_BAD_STATE;
4088 goto exit;
4089 }
Ronald Crona0d68172021-03-26 10:15:08 +01004090
Gilles Peskine449bd832023-01-11 14:50:10 +01004091 if (iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004092 status = PSA_ERROR_INVALID_ARGUMENT;
4093 goto exit;
4094 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004095
Gilles Peskine449bd832023-01-11 14:50:10 +01004096 status = psa_driver_wrapper_cipher_set_iv(operation,
4097 iv,
4098 iv_length);
Steven Cooremand3feccd2020-09-01 15:56:14 +02004099
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004100exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004101 if (status == PSA_SUCCESS) {
itayzafrir534bd7c2018-08-02 13:56:32 +03004102 operation->iv_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004103 } else {
4104 psa_cipher_abort(operation);
4105 }
4106 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004107}
4108
Gilles Peskine449bd832023-01-11 14:50:10 +01004109psa_status_t psa_cipher_update(psa_cipher_operation_t *operation,
4110 const uint8_t *input,
4111 size_t input_length,
4112 uint8_t *output,
4113 size_t output_size,
4114 size_t *output_length)
mohammad1603503973b2018-03-12 15:59:30 +02004115{
Steven Cooremanffecb7b2020-08-25 15:13:13 +02004116 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron6d051732020-10-01 14:10:20 +02004117
Gilles Peskine449bd832023-01-11 14:50:10 +01004118 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004119 status = PSA_ERROR_BAD_STATE;
4120 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004121 }
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004122
Gilles Peskine449bd832023-01-11 14:50:10 +01004123 if (operation->iv_required && !operation->iv_set) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004124 status = PSA_ERROR_BAD_STATE;
4125 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004126 }
Jaeden Ameroab439972019-02-15 14:12:05 +00004127
Gilles Peskine449bd832023-01-11 14:50:10 +01004128 status = psa_driver_wrapper_cipher_update(operation,
4129 input,
4130 input_length,
4131 output,
4132 output_size,
4133 output_length);
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004134
4135exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004136 if (status != PSA_SUCCESS) {
4137 psa_cipher_abort(operation);
4138 }
Ronald Cron6d051732020-10-01 14:10:20 +02004139
Gilles Peskine449bd832023-01-11 14:50:10 +01004140 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004141}
4142
Gilles Peskine449bd832023-01-11 14:50:10 +01004143psa_status_t psa_cipher_finish(psa_cipher_operation_t *operation,
4144 uint8_t *output,
4145 size_t output_size,
4146 size_t *output_length)
mohammad1603503973b2018-03-12 15:59:30 +02004147{
David Saadab4ecc272019-02-14 13:48:10 +02004148 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Ronald Cron6d051732020-10-01 14:10:20 +02004149
Gilles Peskine449bd832023-01-11 14:50:10 +01004150 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004151 status = PSA_ERROR_BAD_STATE;
4152 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004153 }
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004154
Gilles Peskine449bd832023-01-11 14:50:10 +01004155 if (operation->iv_required && !operation->iv_set) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004156 status = PSA_ERROR_BAD_STATE;
4157 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004158 }
Moran Pekerbed71a22018-04-22 20:19:20 +03004159
Gilles Peskine449bd832023-01-11 14:50:10 +01004160 status = psa_driver_wrapper_cipher_finish(operation,
4161 output,
4162 output_size,
4163 output_length);
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004164
4165exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004166 if (status == PSA_SUCCESS) {
4167 return psa_cipher_abort(operation);
4168 } else {
Steven Cooremanef8575e2020-09-11 11:44:50 +02004169 *output_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004170 (void) psa_cipher_abort(operation);
Janos Follath315b51c2018-07-09 16:04:51 +01004171
Gilles Peskine449bd832023-01-11 14:50:10 +01004172 return status;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004173 }
mohammad1603503973b2018-03-12 15:59:30 +02004174}
4175
Gilles Peskine449bd832023-01-11 14:50:10 +01004176psa_status_t psa_cipher_abort(psa_cipher_operation_t *operation)
Gilles Peskinee553c652018-06-04 16:22:46 +02004177{
Gilles Peskine449bd832023-01-11 14:50:10 +01004178 if (operation->id == 0) {
Steven Cooremana07b9972020-09-10 14:54:14 +02004179 /* The object has (apparently) been initialized but it is not (yet)
Gilles Peskine81736312018-06-26 15:04:31 +02004180 * in use. It's ok to call abort on such an object, and there's
4181 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004182 return PSA_SUCCESS;
Gilles Peskine81736312018-06-26 15:04:31 +02004183 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004184
Gilles Peskine449bd832023-01-11 14:50:10 +01004185 psa_driver_wrapper_cipher_abort(operation);
Gilles Peskinee553c652018-06-04 16:22:46 +02004186
Ronald Cron49fafa92021-03-10 08:34:23 +01004187 operation->id = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004188 operation->iv_set = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004189 operation->iv_required = 0;
Moran Peker41deec42018-04-04 15:43:05 +03004190
Gilles Peskine449bd832023-01-11 14:50:10 +01004191 return PSA_SUCCESS;
mohammad1603503973b2018-03-12 15:59:30 +02004192}
4193
Gilles Peskine449bd832023-01-11 14:50:10 +01004194psa_status_t psa_cipher_encrypt(mbedtls_svc_key_id_t key,
4195 psa_algorithm_t alg,
4196 const uint8_t *input,
4197 size_t input_length,
4198 uint8_t *output,
4199 size_t output_size,
4200 size_t *output_length)
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004201{
4202 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004203 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron23919522021-07-08 19:00:07 +02004204 psa_key_slot_t *slot = NULL;
Ronald Cronc6e6f502021-07-09 18:44:58 +02004205 uint8_t local_iv[PSA_CIPHER_IV_MAX_SIZE];
4206 size_t default_iv_length = 0;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004207 psa_key_attributes_t attributes;
gabor-mezei-arm6f4e5bb2021-06-25 15:21:11 +02004208
Gilles Peskine449bd832023-01-11 14:50:10 +01004209 if (!PSA_ALG_IS_CIPHER(alg)) {
Ronald Cron23919522021-07-08 19:00:07 +02004210 status = PSA_ERROR_INVALID_ARGUMENT;
4211 goto exit;
4212 }
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004213
Gilles Peskine449bd832023-01-11 14:50:10 +01004214 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
4215 PSA_KEY_USAGE_ENCRYPT,
4216 alg);
4217 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004218 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004219 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004220
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004221 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004222 .core = slot->attr
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004223 };
4224
Gilles Peskine449bd832023-01-11 14:50:10 +01004225 default_iv_length = PSA_CIPHER_IV_LENGTH(slot->attr.type, alg);
4226 if (default_iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Ronald Cronc6e6f502021-07-09 18:44:58 +02004227 status = PSA_ERROR_GENERIC_ERROR;
4228 goto exit;
4229 }
4230
Gilles Peskine449bd832023-01-11 14:50:10 +01004231 if (default_iv_length > 0) {
4232 if (output_size < default_iv_length) {
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004233 status = PSA_ERROR_BUFFER_TOO_SMALL;
4234 goto exit;
4235 }
4236
Gilles Peskine449bd832023-01-11 14:50:10 +01004237 status = psa_generate_random(local_iv, default_iv_length);
4238 if (status != PSA_SUCCESS) {
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004239 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004240 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004241 }
4242
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004243 status = psa_driver_wrapper_cipher_encrypt(
4244 &attributes, slot->key.data, slot->key.bytes,
Ronald Cronc6e6f502021-07-09 18:44:58 +02004245 alg, local_iv, default_iv_length, input, input_length,
Ronald Cronafbc7ed2023-01-24 16:02:04 +01004246 psa_crypto_buffer_offset(output, default_iv_length),
Gilles Peskine449bd832023-01-11 14:50:10 +01004247 output_size - default_iv_length, output_length);
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004248
4249exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00004250 unlock_status = psa_unregister_read(slot);
Gilles Peskine449bd832023-01-11 14:50:10 +01004251 if (status == PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004252 status = unlock_status;
Ronald Cronc6e6f502021-07-09 18:44:58 +02004253 }
Ronald Cron23919522021-07-08 19:00:07 +02004254
Gilles Peskine449bd832023-01-11 14:50:10 +01004255 if (status == PSA_SUCCESS) {
4256 if (default_iv_length > 0) {
4257 memcpy(output, local_iv, default_iv_length);
4258 }
4259 *output_length += default_iv_length;
4260 } else {
4261 *output_length = 0;
4262 }
4263
4264 return status;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004265}
4266
Gilles Peskine449bd832023-01-11 14:50:10 +01004267psa_status_t psa_cipher_decrypt(mbedtls_svc_key_id_t key,
4268 psa_algorithm_t alg,
4269 const uint8_t *input,
4270 size_t input_length,
4271 uint8_t *output,
4272 size_t output_size,
4273 size_t *output_length)
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004274{
4275 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004276 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron23919522021-07-08 19:00:07 +02004277 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004278 psa_key_attributes_t attributes;
gabor-mezei-arm6f4e5bb2021-06-25 15:21:11 +02004279
Gilles Peskine449bd832023-01-11 14:50:10 +01004280 if (!PSA_ALG_IS_CIPHER(alg)) {
Ronald Cron23919522021-07-08 19:00:07 +02004281 status = PSA_ERROR_INVALID_ARGUMENT;
4282 goto exit;
4283 }
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004284
Gilles Peskine449bd832023-01-11 14:50:10 +01004285 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
4286 PSA_KEY_USAGE_DECRYPT,
4287 alg);
4288 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004289 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004290 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004291
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004292 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004293 .core = slot->attr
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004294 };
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004295
Gilles Peskine449bd832023-01-11 14:50:10 +01004296 if (alg == PSA_ALG_CCM_STAR_NO_TAG &&
4297 input_length < PSA_BLOCK_CIPHER_BLOCK_LENGTH(slot->attr.type)) {
Mateusz Starzyk594215b2021-10-14 12:23:06 +02004298 status = PSA_ERROR_INVALID_ARGUMENT;
4299 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004300 } else if (input_length < PSA_CIPHER_IV_LENGTH(slot->attr.type, alg)) {
gabor-mezei-arm258ae072021-06-25 15:25:38 +02004301 status = PSA_ERROR_INVALID_ARGUMENT;
4302 goto exit;
4303 }
4304
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004305 status = psa_driver_wrapper_cipher_decrypt(
4306 &attributes, slot->key.data, slot->key.bytes,
4307 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004308 output, output_size, output_length);
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004309
gabor-mezei-arm258ae072021-06-25 15:25:38 +02004310exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00004311 unlock_status = psa_unregister_read(slot);
Gilles Peskine449bd832023-01-11 14:50:10 +01004312 if (status == PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004313 status = unlock_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01004314 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004315
Gilles Peskine449bd832023-01-11 14:50:10 +01004316 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004317 *output_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004318 }
Ronald Cron23919522021-07-08 19:00:07 +02004319
Gilles Peskine449bd832023-01-11 14:50:10 +01004320 return status;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004321}
4322
4323
mohammad16035955c982018-04-26 00:53:03 +03004324/****************************************************************/
4325/* AEAD */
4326/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004327
Paul Elliottbaff51c2021-09-28 17:44:45 +01004328/* Helper function to get the base algorithm from its variants. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004329static psa_algorithm_t psa_aead_get_base_algorithm(psa_algorithm_t alg)
Paul Elliottbaff51c2021-09-28 17:44:45 +01004330{
Gilles Peskine449bd832023-01-11 14:50:10 +01004331 return PSA_ALG_AEAD_WITH_DEFAULT_LENGTH_TAG(alg);
Paul Elliottbaff51c2021-09-28 17:44:45 +01004332}
4333
4334/* Helper function to perform common nonce length checks. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004335static psa_status_t psa_aead_check_nonce_length(psa_algorithm_t alg,
4336 size_t nonce_length)
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004337{
Gilles Peskine449bd832023-01-11 14:50:10 +01004338 psa_algorithm_t base_alg = psa_aead_get_base_algorithm(alg);
Paul Elliottbaff51c2021-09-28 17:44:45 +01004339
Gilles Peskine449bd832023-01-11 14:50:10 +01004340 switch (base_alg) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004341#if defined(PSA_WANT_ALG_GCM)
4342 case PSA_ALG_GCM:
4343 /* Not checking max nonce size here as GCM spec allows almost
Gilles Peskine449bd832023-01-11 14:50:10 +01004344 * arbitrarily large nonces. Please note that we do not generally
4345 * recommend the usage of nonces of greater length than
4346 * PSA_AEAD_NONCE_MAX_SIZE, as large nonces are hashed to a shorter
4347 * size, which can then lead to collisions if you encrypt a very
4348 * large number of messages.*/
4349 if (nonce_length != 0) {
4350 return PSA_SUCCESS;
4351 }
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004352 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004353#endif /* PSA_WANT_ALG_GCM */
4354#if defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004355 case PSA_ALG_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01004356 if (nonce_length >= 7 && nonce_length <= 13) {
4357 return PSA_SUCCESS;
4358 }
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004359 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004360#endif /* PSA_WANT_ALG_CCM */
4361#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004362 case PSA_ALG_CHACHA20_POLY1305:
Gilles Peskine449bd832023-01-11 14:50:10 +01004363 if (nonce_length == 12) {
4364 return PSA_SUCCESS;
4365 } else if (nonce_length == 8) {
4366 return PSA_ERROR_NOT_SUPPORTED;
4367 }
Bence Szépkúti6d48e202021-11-15 20:04:15 +01004368 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004369#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004370 default:
Przemek Stekiel4c499272022-09-27 13:55:37 +02004371 (void) nonce_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01004372 return PSA_ERROR_NOT_SUPPORTED;
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004373 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004374
Gilles Peskine449bd832023-01-11 14:50:10 +01004375 return PSA_ERROR_INVALID_ARGUMENT;
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004376}
4377
Gilles Peskine449bd832023-01-11 14:50:10 +01004378static psa_status_t psa_aead_check_algorithm(psa_algorithm_t alg)
Bence Szépkútiaa3a6e42022-01-13 16:26:03 +01004379{
Gilles Peskine449bd832023-01-11 14:50:10 +01004380 if (!PSA_ALG_IS_AEAD(alg) || PSA_ALG_IS_WILDCARD(alg)) {
4381 return PSA_ERROR_INVALID_ARGUMENT;
4382 }
Bence Szépkúti08f34652021-12-08 21:07:13 +01004383
Gilles Peskine449bd832023-01-11 14:50:10 +01004384 return PSA_SUCCESS;
Bence Szépkúti08f34652021-12-08 21:07:13 +01004385}
4386
Gilles Peskine449bd832023-01-11 14:50:10 +01004387psa_status_t psa_aead_encrypt(mbedtls_svc_key_id_t key,
4388 psa_algorithm_t alg,
4389 const uint8_t *nonce,
4390 size_t nonce_length,
4391 const uint8_t *additional_data,
4392 size_t additional_data_length,
4393 const uint8_t *plaintext,
4394 size_t plaintext_length,
4395 uint8_t *ciphertext,
4396 size_t ciphertext_size,
4397 size_t *ciphertext_length)
mohammad16035955c982018-04-26 00:53:03 +03004398{
Ronald Cron215633c2021-03-16 17:15:37 +01004399 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4400 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02004401
mohammad1603f08a5502018-06-03 15:05:47 +03004402 *ciphertext_length = 0;
mohammad1603e58e6842018-05-09 04:58:32 -07004403
Gilles Peskine449bd832023-01-11 14:50:10 +01004404 status = psa_aead_check_algorithm(alg);
4405 if (status != PSA_SUCCESS) {
4406 return status;
4407 }
Steven Cooremanea7ab132021-03-17 16:28:00 +01004408
Ronald Cron9a986162021-03-26 12:40:07 +01004409 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01004410 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg);
4411 if (status != PSA_SUCCESS) {
4412 return status;
4413 }
mohammad16035955c982018-04-26 00:53:03 +03004414
Ronald Cron215633c2021-03-16 17:15:37 +01004415 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01004416 .core = slot->attr
Ronald Cron215633c2021-03-16 17:15:37 +01004417 };
mohammad16035955c982018-04-26 00:53:03 +03004418
Gilles Peskine449bd832023-01-11 14:50:10 +01004419 status = psa_aead_check_nonce_length(alg, nonce_length);
4420 if (status != PSA_SUCCESS) {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004421 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004422 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004423
Ronald Cronde822812021-03-17 16:08:20 +01004424 status = psa_driver_wrapper_aead_encrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01004425 &attributes, slot->key.data, slot->key.bytes,
4426 alg,
4427 nonce, nonce_length,
4428 additional_data, additional_data_length,
4429 plaintext, plaintext_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004430 ciphertext, ciphertext_size, ciphertext_length);
Gilles Peskine2d277862018-06-18 15:41:12 +02004431
Gilles Peskine449bd832023-01-11 14:50:10 +01004432 if (status != PSA_SUCCESS && ciphertext_size != 0) {
4433 memset(ciphertext, 0, ciphertext_size);
4434 }
Gilles Peskine2d277862018-06-18 15:41:12 +02004435
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004436exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00004437 psa_unregister_read(slot);
mohammad16035955c982018-04-26 00:53:03 +03004438
Gilles Peskine449bd832023-01-11 14:50:10 +01004439 return status;
Gilles Peskineee652a32018-06-01 19:23:52 +02004440}
4441
Gilles Peskine449bd832023-01-11 14:50:10 +01004442psa_status_t psa_aead_decrypt(mbedtls_svc_key_id_t key,
4443 psa_algorithm_t alg,
4444 const uint8_t *nonce,
4445 size_t nonce_length,
4446 const uint8_t *additional_data,
4447 size_t additional_data_length,
4448 const uint8_t *ciphertext,
4449 size_t ciphertext_length,
4450 uint8_t *plaintext,
4451 size_t plaintext_size,
4452 size_t *plaintext_length)
mohammad16035955c982018-04-26 00:53:03 +03004453{
Ronald Cron215633c2021-03-16 17:15:37 +01004454 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4455 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02004456
Gilles Peskineee652a32018-06-01 19:23:52 +02004457 *plaintext_length = 0;
mohammad16039e5a5152018-04-26 12:07:35 +03004458
Gilles Peskine449bd832023-01-11 14:50:10 +01004459 status = psa_aead_check_algorithm(alg);
4460 if (status != PSA_SUCCESS) {
4461 return status;
4462 }
Steven Cooremanea7ab132021-03-17 16:28:00 +01004463
Ronald Cron9a986162021-03-26 12:40:07 +01004464 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01004465 key, &slot, PSA_KEY_USAGE_DECRYPT, alg);
4466 if (status != PSA_SUCCESS) {
4467 return status;
4468 }
mohammad16035955c982018-04-26 00:53:03 +03004469
Ronald Cron215633c2021-03-16 17:15:37 +01004470 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01004471 .core = slot->attr
Ronald Cron215633c2021-03-16 17:15:37 +01004472 };
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004473
Gilles Peskine449bd832023-01-11 14:50:10 +01004474 status = psa_aead_check_nonce_length(alg, nonce_length);
4475 if (status != PSA_SUCCESS) {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004476 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004477 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004478
Ronald Cronde822812021-03-17 16:08:20 +01004479 status = psa_driver_wrapper_aead_decrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01004480 &attributes, slot->key.data, slot->key.bytes,
4481 alg,
4482 nonce, nonce_length,
4483 additional_data, additional_data_length,
4484 ciphertext, ciphertext_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004485 plaintext, plaintext_size, plaintext_length);
Gilles Peskinea40d7742018-06-01 16:28:30 +02004486
Gilles Peskine449bd832023-01-11 14:50:10 +01004487 if (status != PSA_SUCCESS && plaintext_size != 0) {
4488 memset(plaintext, 0, plaintext_size);
4489 }
mohammad160360a64d02018-06-03 17:20:42 +03004490
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004491exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00004492 psa_unregister_read(slot);
Ronald Cron215633c2021-03-16 17:15:37 +01004493
Gilles Peskine449bd832023-01-11 14:50:10 +01004494 return status;
mohammad16035955c982018-04-26 00:53:03 +03004495}
4496
Gilles Peskine449bd832023-01-11 14:50:10 +01004497static psa_status_t psa_validate_tag_length(psa_algorithm_t alg)
4498{
4499 const uint8_t tag_len = PSA_ALG_AEAD_GET_TAG_LENGTH(alg);
Andrzej Kurekf8816012021-12-19 17:00:12 +01004500
Gilles Peskine449bd832023-01-11 14:50:10 +01004501 switch (PSA_ALG_AEAD_WITH_SHORTENED_TAG(alg, 0)) {
Przemek Stekiel86679c72022-10-06 17:06:56 +02004502#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004503 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004504 /* CCM allows the following tag lengths: 4, 6, 8, 10, 12, 14, 16.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004505 if (tag_len < 4 || tag_len > 16 || tag_len % 2) {
4506 return PSA_ERROR_INVALID_ARGUMENT;
4507 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01004508 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02004509#endif /* PSA_WANT_ALG_CCM */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004510
Przemek Stekiel86679c72022-10-06 17:06:56 +02004511#if defined(PSA_WANT_ALG_GCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004512 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_GCM, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004513 /* GCM allows the following tag lengths: 4, 8, 12, 13, 14, 15, 16. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004514 if (tag_len != 4 && tag_len != 8 && (tag_len < 12 || tag_len > 16)) {
4515 return PSA_ERROR_INVALID_ARGUMENT;
4516 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01004517 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02004518#endif /* PSA_WANT_ALG_GCM */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004519
Przemek Stekiel86679c72022-10-06 17:06:56 +02004520#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Gilles Peskine449bd832023-01-11 14:50:10 +01004521 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CHACHA20_POLY1305, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004522 /* We only support the default tag length. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004523 if (tag_len != 16) {
4524 return PSA_ERROR_INVALID_ARGUMENT;
4525 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01004526 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02004527#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004528
4529 default:
4530 (void) tag_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004531 return PSA_ERROR_NOT_SUPPORTED;
Andrzej Kurekf8816012021-12-19 17:00:12 +01004532 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004533 return PSA_SUCCESS;
Andrzej Kurekf8816012021-12-19 17:00:12 +01004534}
4535
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004536/* Set the key for a multipart authenticated operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004537static psa_status_t psa_aead_setup(psa_aead_operation_t *operation,
4538 int is_encrypt,
4539 mbedtls_svc_key_id_t key,
4540 psa_algorithm_t alg)
Paul Elliottc2b71442021-06-24 18:17:52 +01004541{
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004542 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4543 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
4544 psa_key_slot_t *slot = NULL;
4545 psa_key_usage_t key_usage = 0;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004546 psa_key_attributes_t attributes;
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004547
Gilles Peskine449bd832023-01-11 14:50:10 +01004548 status = psa_aead_check_algorithm(alg);
4549 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004550 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004551 }
Paul Elliottc2b71442021-06-24 18:17:52 +01004552
Gilles Peskine449bd832023-01-11 14:50:10 +01004553 if (operation->id != 0) {
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 (operation->nonce_set || operation->lengths_set ||
4559 operation->ad_started || operation->body_started) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004560 status = PSA_ERROR_BAD_STATE;
4561 goto exit;
Paul Elliottc2b71442021-06-24 18:17:52 +01004562 }
4563
Gilles Peskine449bd832023-01-11 14:50:10 +01004564 if (is_encrypt) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004565 key_usage = PSA_KEY_USAGE_ENCRYPT;
Gilles Peskine449bd832023-01-11 14:50:10 +01004566 } else {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004567 key_usage = PSA_KEY_USAGE_DECRYPT;
Gilles Peskine449bd832023-01-11 14:50:10 +01004568 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004569
Gilles Peskine449bd832023-01-11 14:50:10 +01004570 status = psa_get_and_lock_key_slot_with_policy(key, &slot, key_usage,
4571 alg);
4572 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004573 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004574 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004575
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004576 attributes = (psa_key_attributes_t) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004577 .core = slot->attr
4578 };
4579
Gilles Peskine449bd832023-01-11 14:50:10 +01004580 if ((status = psa_validate_tag_length(alg)) != PSA_SUCCESS) {
Przemek Stekiel6ab50762022-10-08 17:54:30 +02004581 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004582 }
Przemek Stekiel6ab50762022-10-08 17:54:30 +02004583
Gilles Peskine449bd832023-01-11 14:50:10 +01004584 if (is_encrypt) {
4585 status = psa_driver_wrapper_aead_encrypt_setup(operation,
4586 &attributes,
4587 slot->key.data,
4588 slot->key.bytes,
4589 alg);
4590 } else {
4591 status = psa_driver_wrapper_aead_decrypt_setup(operation,
4592 &attributes,
4593 slot->key.data,
4594 slot->key.bytes,
4595 alg);
4596 }
4597 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004598 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004599 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004600
Gilles Peskine449bd832023-01-11 14:50:10 +01004601 operation->key_type = psa_get_key_type(&attributes);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004602
4603exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00004604 unlock_status = psa_unregister_read(slot);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004605
Gilles Peskine449bd832023-01-11 14:50:10 +01004606 if (status == PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004607 status = unlock_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01004608 operation->alg = psa_aead_get_base_algorithm(alg);
Paul Elliottd9343f22021-08-23 18:59:49 +01004609 operation->is_encrypt = is_encrypt;
Gilles Peskine449bd832023-01-11 14:50:10 +01004610 } else {
4611 psa_aead_abort(operation);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004612 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004613
Gilles Peskine449bd832023-01-11 14:50:10 +01004614 return status;
Paul Elliottc2b71442021-06-24 18:17:52 +01004615}
4616
Paul Elliott302ff6b2021-04-20 18:10:30 +01004617/* Set the key for a multipart authenticated encryption operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004618psa_status_t psa_aead_encrypt_setup(psa_aead_operation_t *operation,
4619 mbedtls_svc_key_id_t key,
4620 psa_algorithm_t alg)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004621{
Gilles Peskine449bd832023-01-11 14:50:10 +01004622 return psa_aead_setup(operation, 1, key, alg);
Paul Elliott302ff6b2021-04-20 18:10:30 +01004623}
4624
4625/* Set the key for a multipart authenticated decryption operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004626psa_status_t psa_aead_decrypt_setup(psa_aead_operation_t *operation,
4627 mbedtls_svc_key_id_t key,
4628 psa_algorithm_t alg)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004629{
Gilles Peskine449bd832023-01-11 14:50:10 +01004630 return psa_aead_setup(operation, 0, key, alg);
Paul Elliott302ff6b2021-04-20 18:10:30 +01004631}
4632
4633/* Generate a random nonce / IV for multipart AEAD operation */
Gilles Peskine449bd832023-01-11 14:50:10 +01004634psa_status_t psa_aead_generate_nonce(psa_aead_operation_t *operation,
4635 uint8_t *nonce,
4636 size_t nonce_size,
4637 size_t *nonce_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004638{
4639 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Croncae59092021-11-26 18:53:58 +01004640 uint8_t local_nonce[PSA_AEAD_NONCE_MAX_SIZE];
Sergeybef1f632023-03-06 15:25:06 -07004641 size_t required_nonce_size = 0;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004642
Paul Elliott8eb9daf2021-06-04 16:42:21 +01004643 *nonce_length = 0;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004644
Gilles Peskine449bd832023-01-11 14:50:10 +01004645 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004646 status = PSA_ERROR_BAD_STATE;
4647 goto exit;
4648 }
4649
Gilles Peskine449bd832023-01-11 14:50:10 +01004650 if (operation->nonce_set || !operation->is_encrypt) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004651 status = PSA_ERROR_BAD_STATE;
4652 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004653 }
4654
Paul Elliotte193ea82021-10-01 13:00:16 +01004655 /* For CCM, this size may not be correct according to the PSA
4656 * specification. The PSA Crypto 1.0.1 specification states:
4657 *
4658 * CCM encodes the plaintext length pLen in L octets, with L the smallest
4659 * integer >= 2 where pLen < 2^(8L). The nonce length is then 15 - L bytes.
4660 *
4661 * However this restriction that L has to be the smallest integer is not
4662 * applied in practice, and it is not implementable here since the
4663 * plaintext length may or may not be known at this time. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004664 required_nonce_size = PSA_AEAD_NONCE_LENGTH(operation->key_type,
4665 operation->alg);
4666 if (nonce_size < required_nonce_size) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004667 status = PSA_ERROR_BUFFER_TOO_SMALL;
4668 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004669 }
4670
Gilles Peskine449bd832023-01-11 14:50:10 +01004671 status = psa_generate_random(local_nonce, required_nonce_size);
4672 if (status != PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004673 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004674 }
Paul Elliott302ff6b2021-04-20 18:10:30 +01004675
Gilles Peskine449bd832023-01-11 14:50:10 +01004676 status = psa_aead_set_nonce(operation, local_nonce, required_nonce_size);
Paul Elliott302ff6b2021-04-20 18:10:30 +01004677
Paul Elliott39dc6b82021-05-11 19:16:09 +01004678exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004679 if (status == PSA_SUCCESS) {
4680 memcpy(nonce, local_nonce, required_nonce_size);
Paul Elliott39dc6b82021-05-11 19:16:09 +01004681 *nonce_length = required_nonce_size;
Gilles Peskine449bd832023-01-11 14:50:10 +01004682 } else {
4683 psa_aead_abort(operation);
Ronald Croncae59092021-11-26 18:53:58 +01004684 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01004685
Gilles Peskine449bd832023-01-11 14:50:10 +01004686 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004687}
4688
4689/* Set the nonce for a multipart authenticated encryption or decryption
4690 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004691psa_status_t psa_aead_set_nonce(psa_aead_operation_t *operation,
4692 const uint8_t *nonce,
4693 size_t nonce_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004694{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004695 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4696
Gilles Peskine449bd832023-01-11 14:50:10 +01004697 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004698 status = PSA_ERROR_BAD_STATE;
4699 goto exit;
4700 }
4701
Gilles Peskine449bd832023-01-11 14:50:10 +01004702 if (operation->nonce_set) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004703 status = PSA_ERROR_BAD_STATE;
4704 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004705 }
4706
Gilles Peskine449bd832023-01-11 14:50:10 +01004707 status = psa_aead_check_nonce_length(operation->alg, nonce_length);
4708 if (status != PSA_SUCCESS) {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004709 status = PSA_ERROR_INVALID_ARGUMENT;
4710 goto exit;
Paul Elliott4ed1ed12021-09-27 18:09:28 +01004711 }
Paul Elliott1a98aca2021-05-20 18:24:07 +01004712
Gilles Peskine449bd832023-01-11 14:50:10 +01004713 status = psa_driver_wrapper_aead_set_nonce(operation, nonce,
4714 nonce_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004715
Paul Elliott39dc6b82021-05-11 19:16:09 +01004716exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004717 if (status == PSA_SUCCESS) {
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004718 operation->nonce_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004719 } else {
4720 psa_aead_abort(operation);
4721 }
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004722
Gilles Peskine449bd832023-01-11 14:50:10 +01004723 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004724}
4725
4726/* Declare the lengths of the message and additional data for multipart AEAD. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004727psa_status_t psa_aead_set_lengths(psa_aead_operation_t *operation,
4728 size_t ad_length,
4729 size_t plaintext_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004730{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004731 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4732
Gilles Peskine449bd832023-01-11 14:50:10 +01004733 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004734 status = PSA_ERROR_BAD_STATE;
4735 goto exit;
4736 }
4737
Gilles Peskine449bd832023-01-11 14:50:10 +01004738 if (operation->lengths_set || operation->ad_started ||
4739 operation->body_started) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004740 status = PSA_ERROR_BAD_STATE;
4741 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004742 }
4743
Gilles Peskine449bd832023-01-11 14:50:10 +01004744 switch (operation->alg) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004745#if defined(PSA_WANT_ALG_GCM)
4746 case PSA_ALG_GCM:
4747 /* Lengths can only be too large for GCM if size_t is bigger than 32
Gilles Peskine449bd832023-01-11 14:50:10 +01004748 * bits. Without the guard this code will generate warnings on 32bit
4749 * builds. */
Paul Elliott325d3742021-09-27 17:56:28 +01004750#if SIZE_MAX > UINT32_MAX
Gilles Peskine449bd832023-01-11 14:50:10 +01004751 if (((uint64_t) ad_length) >> 61 != 0 ||
4752 ((uint64_t) plaintext_length) > 0xFFFFFFFE0ull) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004753 status = PSA_ERROR_INVALID_ARGUMENT;
4754 goto exit;
4755 }
Paul Elliott325d3742021-09-27 17:56:28 +01004756#endif
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004757 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004758#endif /* PSA_WANT_ALG_GCM */
4759#if defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004760 case PSA_ALG_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01004761 if (ad_length > 0xFF00) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004762 status = PSA_ERROR_INVALID_ARGUMENT;
4763 goto exit;
4764 }
4765 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004766#endif /* PSA_WANT_ALG_CCM */
4767#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004768 case PSA_ALG_CHACHA20_POLY1305:
4769 /* No length restrictions for ChaChaPoly. */
4770 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004771#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004772 default:
4773 break;
4774 }
Paul Elliott325d3742021-09-27 17:56:28 +01004775
Gilles Peskine449bd832023-01-11 14:50:10 +01004776 status = psa_driver_wrapper_aead_set_lengths(operation, ad_length,
4777 plaintext_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004778
Paul Elliott39dc6b82021-05-11 19:16:09 +01004779exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004780 if (status == PSA_SUCCESS) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01004781 operation->ad_remaining = ad_length;
4782 operation->body_remaining = plaintext_length;
Paul Elliott39dc6b82021-05-11 19:16:09 +01004783 operation->lengths_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004784 } else {
4785 psa_aead_abort(operation);
Paul Elliottee4ffe02021-05-20 17:25:06 +01004786 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01004787
Gilles Peskine449bd832023-01-11 14:50:10 +01004788 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004789}
Paul Elliott3d7d52c2021-09-01 10:33:14 +01004790
4791/* Pass additional data to an active multipart AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004792psa_status_t psa_aead_update_ad(psa_aead_operation_t *operation,
4793 const uint8_t *input,
4794 size_t input_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004795{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004796 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4797
Gilles Peskine449bd832023-01-11 14:50:10 +01004798 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004799 status = PSA_ERROR_BAD_STATE;
4800 goto exit;
4801 }
4802
Gilles Peskine449bd832023-01-11 14:50:10 +01004803 if (!operation->nonce_set || operation->body_started) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004804 status = PSA_ERROR_BAD_STATE;
4805 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004806 }
4807
Gilles Peskine449bd832023-01-11 14:50:10 +01004808 if (operation->lengths_set) {
4809 if (operation->ad_remaining < input_length) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01004810 status = PSA_ERROR_INVALID_ARGUMENT;
4811 goto exit;
4812 }
4813
4814 operation->ad_remaining -= input_length;
4815 }
Paul Elliotte193ea82021-10-01 13:00:16 +01004816#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004817 else if (operation->alg == PSA_ALG_CCM) {
Paul Elliotte193ea82021-10-01 13:00:16 +01004818 status = PSA_ERROR_BAD_STATE;
4819 goto exit;
4820 }
4821#endif /* PSA_WANT_ALG_CCM */
Paul Elliottee4ffe02021-05-20 17:25:06 +01004822
Gilles Peskine449bd832023-01-11 14:50:10 +01004823 status = psa_driver_wrapper_aead_update_ad(operation, input,
4824 input_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004825
Paul Elliott39dc6b82021-05-11 19:16:09 +01004826exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004827 if (status == PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004828 operation->ad_started = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004829 } else {
4830 psa_aead_abort(operation);
4831 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01004832
Gilles Peskine449bd832023-01-11 14:50:10 +01004833 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004834}
4835
4836/* Encrypt or decrypt a message fragment in an active multipart AEAD
4837 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004838psa_status_t psa_aead_update(psa_aead_operation_t *operation,
4839 const uint8_t *input,
4840 size_t input_length,
4841 uint8_t *output,
4842 size_t output_size,
4843 size_t *output_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004844{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004845 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004846
4847 *output_length = 0;
4848
Gilles Peskine449bd832023-01-11 14:50:10 +01004849 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004850 status = PSA_ERROR_BAD_STATE;
4851 goto exit;
4852 }
4853
Gilles Peskine449bd832023-01-11 14:50:10 +01004854 if (!operation->nonce_set) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004855 status = PSA_ERROR_BAD_STATE;
4856 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004857 }
4858
Gilles Peskine449bd832023-01-11 14:50:10 +01004859 if (operation->lengths_set) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01004860 /* Additional data length was supplied, but not all the additional
4861 data was supplied.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004862 if (operation->ad_remaining != 0) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01004863 status = PSA_ERROR_INVALID_ARGUMENT;
4864 goto exit;
4865 }
4866
4867 /* Too much data provided. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004868 if (operation->body_remaining < input_length) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01004869 status = PSA_ERROR_INVALID_ARGUMENT;
4870 goto exit;
4871 }
4872
4873 operation->body_remaining -= input_length;
4874 }
Paul Elliotte193ea82021-10-01 13:00:16 +01004875#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004876 else if (operation->alg == PSA_ALG_CCM) {
Paul Elliotte193ea82021-10-01 13:00:16 +01004877 status = PSA_ERROR_BAD_STATE;
4878 goto exit;
4879 }
4880#endif /* PSA_WANT_ALG_CCM */
Paul Elliottee4ffe02021-05-20 17:25:06 +01004881
Gilles Peskine449bd832023-01-11 14:50:10 +01004882 status = psa_driver_wrapper_aead_update(operation, input, input_length,
4883 output, output_size,
4884 output_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004885
Paul Elliott39dc6b82021-05-11 19:16:09 +01004886exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004887 if (status == PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004888 operation->body_started = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004889 } else {
4890 psa_aead_abort(operation);
4891 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01004892
Gilles Peskine449bd832023-01-11 14:50:10 +01004893 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004894}
4895
Gilles Peskine449bd832023-01-11 14:50:10 +01004896static psa_status_t psa_aead_final_checks(const psa_aead_operation_t *operation)
Paul Elliottad53dcc2021-06-23 08:50:14 +01004897{
Gilles Peskine449bd832023-01-11 14:50:10 +01004898 if (operation->id == 0 || !operation->nonce_set) {
4899 return PSA_ERROR_BAD_STATE;
4900 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01004901
Gilles Peskine449bd832023-01-11 14:50:10 +01004902 if (operation->lengths_set && (operation->ad_remaining != 0 ||
4903 operation->body_remaining != 0)) {
4904 return PSA_ERROR_INVALID_ARGUMENT;
4905 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01004906
Gilles Peskine449bd832023-01-11 14:50:10 +01004907 return PSA_SUCCESS;
Paul Elliottad53dcc2021-06-23 08:50:14 +01004908}
4909
Paul Elliott302ff6b2021-04-20 18:10:30 +01004910/* Finish encrypting a message in a multipart AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004911psa_status_t psa_aead_finish(psa_aead_operation_t *operation,
4912 uint8_t *ciphertext,
4913 size_t ciphertext_size,
4914 size_t *ciphertext_length,
4915 uint8_t *tag,
4916 size_t tag_size,
4917 size_t *tag_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004918{
Paul Elliott39dc6b82021-05-11 19:16:09 +01004919 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4920
Paul Elliott302ff6b2021-04-20 18:10:30 +01004921 *ciphertext_length = 0;
Paul Elliottf88a5652021-06-22 17:53:45 +01004922 *tag_length = tag_size;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004923
Gilles Peskine449bd832023-01-11 14:50:10 +01004924 status = psa_aead_final_checks(operation);
4925 if (status != PSA_SUCCESS) {
Paul Elliottad53dcc2021-06-23 08:50:14 +01004926 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004927 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01004928
Gilles Peskine449bd832023-01-11 14:50:10 +01004929 if (!operation->is_encrypt) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004930 status = PSA_ERROR_BAD_STATE;
4931 goto exit;
4932 }
4933
Gilles Peskine449bd832023-01-11 14:50:10 +01004934 status = psa_driver_wrapper_aead_finish(operation, ciphertext,
4935 ciphertext_size,
4936 ciphertext_length,
4937 tag, tag_size, tag_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004938
Paul Elliott39dc6b82021-05-11 19:16:09 +01004939exit:
Paul Elliottdc42ca82023-02-24 18:11:59 +00004940
4941
Paul Elliottf47b0952021-05-21 18:02:33 +01004942 /* In case the operation fails and the user fails to check for failure or
Paul Elliott4c916e82021-09-19 18:34:50 +01004943 * the zero tag size, make sure the tag is set to something implausible.
4944 * Even if the operation succeeds, make sure we clear the rest of the
4945 * buffer to prevent potential leakage of anything previously placed in
4946 * the same buffer.*/
Paul Elliottdc42ca82023-02-24 18:11:59 +00004947 psa_wipe_tag_output_buffer(tag, status, tag_size, *tag_length);
Paul Elliottf47b0952021-05-21 18:02:33 +01004948
Gilles Peskine449bd832023-01-11 14:50:10 +01004949 psa_aead_abort(operation);
Paul Elliott39dc6b82021-05-11 19:16:09 +01004950
Gilles Peskine449bd832023-01-11 14:50:10 +01004951 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004952}
4953
4954/* Finish authenticating and decrypting a message in a multipart AEAD
4955 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004956psa_status_t psa_aead_verify(psa_aead_operation_t *operation,
4957 uint8_t *plaintext,
4958 size_t plaintext_size,
4959 size_t *plaintext_length,
4960 const uint8_t *tag,
4961 size_t tag_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004962{
Paul Elliott39dc6b82021-05-11 19:16:09 +01004963 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4964
Paul Elliott302ff6b2021-04-20 18:10:30 +01004965 *plaintext_length = 0;
4966
Gilles Peskine449bd832023-01-11 14:50:10 +01004967 status = psa_aead_final_checks(operation);
4968 if (status != PSA_SUCCESS) {
Paul Elliottad53dcc2021-06-23 08:50:14 +01004969 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004970 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01004971
Gilles Peskine449bd832023-01-11 14:50:10 +01004972 if (operation->is_encrypt) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004973 status = PSA_ERROR_BAD_STATE;
4974 goto exit;
4975 }
4976
Gilles Peskine449bd832023-01-11 14:50:10 +01004977 status = psa_driver_wrapper_aead_verify(operation, plaintext,
4978 plaintext_size,
4979 plaintext_length,
4980 tag, tag_length);
Paul Elliott39dc6b82021-05-11 19:16:09 +01004981
4982exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004983 psa_aead_abort(operation);
Paul Elliott39dc6b82021-05-11 19:16:09 +01004984
Gilles Peskine449bd832023-01-11 14:50:10 +01004985 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004986}
4987
4988/* Abort an AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004989psa_status_t psa_aead_abort(psa_aead_operation_t *operation)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004990{
4991 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4992
Gilles Peskine449bd832023-01-11 14:50:10 +01004993 if (operation->id == 0) {
Paul Elliott302ff6b2021-04-20 18:10:30 +01004994 /* The object has (apparently) been initialized but it is not (yet)
4995 * in use. It's ok to call abort on such an object, and there's
4996 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004997 return PSA_SUCCESS;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004998 }
4999
Gilles Peskine449bd832023-01-11 14:50:10 +01005000 status = psa_driver_wrapper_aead_abort(operation);
Paul Elliott302ff6b2021-04-20 18:10:30 +01005001
Gilles Peskine449bd832023-01-11 14:50:10 +01005002 memset(operation, 0, sizeof(*operation));
Paul Elliott302ff6b2021-04-20 18:10:30 +01005003
Gilles Peskine449bd832023-01-11 14:50:10 +01005004 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005005}
5006
Gilles Peskinee59236f2018-01-27 23:32:46 +01005007/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02005008/* Generators */
5009/****************************************************************/
5010
Przemek Stekiel69c46792022-06-10 12:59:51 +02005011#if defined(BUILTIN_ALG_ANY_HKDF) || \
John Durkop07cc04a2020-11-16 22:08:34 -08005012 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005013 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) || \
Kusumit Ghoderaoaf0b5342023-05-03 11:58:46 +05305014 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS) || \
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305015 defined(PSA_HAVE_SOFT_PBKDF2)
John Durkop07cc04a2020-11-16 22:08:34 -08005016#define AT_LEAST_ONE_BUILTIN_KDF
Steven Cooreman094a77e2021-05-06 17:58:36 +02005017#endif /* At least one builtin KDF */
5018
Przemek Stekiel69c46792022-06-10 12:59:51 +02005019#if defined(BUILTIN_ALG_ANY_HKDF) || \
Steven Cooreman094a77e2021-05-06 17:58:36 +02005020 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5021 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
5022static psa_status_t psa_key_derivation_start_hmac(
5023 psa_mac_operation_t *operation,
5024 psa_algorithm_t hash_alg,
5025 const uint8_t *hmac_key,
Gilles Peskine449bd832023-01-11 14:50:10 +01005026 size_t hmac_key_length)
Steven Cooreman094a77e2021-05-06 17:58:36 +02005027{
5028 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5029 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01005030 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
5031 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(hmac_key_length));
5032 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_HASH);
Steven Cooreman094a77e2021-05-06 17:58:36 +02005033
Steven Cooreman72f736a2021-05-07 14:14:37 +02005034 operation->is_sign = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005035 operation->mac_size = PSA_HASH_LENGTH(hash_alg);
Steven Cooreman72f736a2021-05-07 14:14:37 +02005036
Gilles Peskine449bd832023-01-11 14:50:10 +01005037 status = psa_driver_wrapper_mac_sign_setup(operation,
5038 &attributes,
5039 hmac_key, hmac_key_length,
5040 PSA_ALG_HMAC(hash_alg));
Steven Cooreman094a77e2021-05-06 17:58:36 +02005041
Gilles Peskine449bd832023-01-11 14:50:10 +01005042 psa_reset_key_attributes(&attributes);
5043 return status;
Steven Cooreman094a77e2021-05-06 17:58:36 +02005044}
5045#endif /* KDF algorithms reliant on HMAC */
John Durkop07cc04a2020-11-16 22:08:34 -08005046
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005047#define HKDF_STATE_INIT 0 /* no input yet */
5048#define HKDF_STATE_STARTED 1 /* got salt */
5049#define HKDF_STATE_KEYED 2 /* got key */
5050#define HKDF_STATE_OUTPUT 3 /* output started */
5051
Gilles Peskinecbe66502019-05-16 16:59:18 +02005052static psa_algorithm_t psa_key_derivation_get_kdf_alg(
Gilles Peskine449bd832023-01-11 14:50:10 +01005053 const psa_key_derivation_operation_t *operation)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005054{
Gilles Peskine449bd832023-01-11 14:50:10 +01005055 if (PSA_ALG_IS_KEY_AGREEMENT(operation->alg)) {
5056 return PSA_ALG_KEY_AGREEMENT_GET_KDF(operation->alg);
5057 } else {
5058 return operation->alg;
5059 }
Gilles Peskine969c5d62019-01-16 15:53:06 +01005060}
5061
Gilles Peskine449bd832023-01-11 14:50:10 +01005062psa_status_t psa_key_derivation_abort(psa_key_derivation_operation_t *operation)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005063{
5064 psa_status_t status = PSA_SUCCESS;
Gilles Peskine449bd832023-01-11 14:50:10 +01005065 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
5066 if (kdf_alg == 0) {
Gilles Peskineeab56e42018-07-12 17:12:33 +02005067 /* The object has (apparently) been initialized but it is not
5068 * in use. It's ok to call abort on such an object, and there's
5069 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005070 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02005071#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01005072 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
5073 mbedtls_free(operation->ctx.hkdf.info);
5074 status = psa_mac_abort(&operation->ctx.hkdf.hmac);
5075 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02005076#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08005077#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5078 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005079 if (PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
5080 /* TLS-1.2 PSK-to-MS KDF uses the same core as TLS-1.2 PRF */
5081 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
5082 if (operation->ctx.tls12_prf.secret != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005083 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.secret,
Gilles Peskine449bd832023-01-11 14:50:10 +01005084 operation->ctx.tls12_prf.secret_length);
Steven Cooremana6df6042021-04-29 19:32:25 +02005085 }
5086
Gilles Peskine449bd832023-01-11 14:50:10 +01005087 if (operation->ctx.tls12_prf.seed != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005088 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.seed,
Gilles Peskine449bd832023-01-11 14:50:10 +01005089 operation->ctx.tls12_prf.seed_length);
Janos Follath6a1d2622019-06-11 10:37:28 +01005090 }
5091
Gilles Peskine449bd832023-01-11 14:50:10 +01005092 if (operation->ctx.tls12_prf.label != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005093 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.label,
Gilles Peskine449bd832023-01-11 14:50:10 +01005094 operation->ctx.tls12_prf.label_length);
Janos Follath6a1d2622019-06-11 10:37:28 +01005095 }
Przemek Stekiel6c764412022-11-22 14:05:12 +01005096#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005097 if (operation->ctx.tls12_prf.other_secret != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005098 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.other_secret,
Gilles Peskine449bd832023-01-11 14:50:10 +01005099 operation->ctx.tls12_prf.other_secret_length);
Przemek Stekiele3ee2212022-04-07 14:29:56 +02005100 }
Przemek Stekiel6c764412022-11-22 14:05:12 +01005101#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Steven Cooremana6df6042021-04-29 19:32:25 +02005102 status = PSA_SUCCESS;
Janos Follath6a1d2622019-06-11 10:37:28 +01005103
5104 /* We leave the fields Ai and output_block to be erased safely by the
5105 * mbedtls_platform_zeroize() in the end of this function. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005106 } else
John Durkop07cc04a2020-11-16 22:08:34 -08005107#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
5108 * defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005109#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005110 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
5111 mbedtls_platform_zeroize(operation->ctx.tls12_ecjpake_to_pms.data,
5112 sizeof(operation->ctx.tls12_ecjpake_to_pms.data));
5113 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005114#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS) */
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305115#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05305116 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305117 if (operation->ctx.pbkdf2.salt != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005118 mbedtls_zeroize_and_free(operation->ctx.pbkdf2.salt,
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305119 operation->ctx.pbkdf2.salt_length);
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305120 }
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305121
5122 status = PSA_SUCCESS;
5123 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305124#endif /* defined(PSA_HAVE_SOFT_PBKDF2) */
Gilles Peskineeab56e42018-07-12 17:12:33 +02005125 {
5126 status = PSA_ERROR_BAD_STATE;
5127 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005128 mbedtls_platform_zeroize(operation, sizeof(*operation));
5129 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005130}
5131
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005132psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskine449bd832023-01-11 14:50:10 +01005133 size_t *capacity)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005134{
Gilles Peskine449bd832023-01-11 14:50:10 +01005135 if (operation->alg == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005136 /* This is a blank key derivation operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005137 return PSA_ERROR_BAD_STATE;
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005138 }
5139
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005140 *capacity = operation->capacity;
Gilles Peskine449bd832023-01-11 14:50:10 +01005141 return PSA_SUCCESS;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005142}
5143
Gilles Peskine449bd832023-01-11 14:50:10 +01005144psa_status_t psa_key_derivation_set_capacity(psa_key_derivation_operation_t *operation,
5145 size_t capacity)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005146{
Gilles Peskine449bd832023-01-11 14:50:10 +01005147 if (operation->alg == 0) {
5148 return PSA_ERROR_BAD_STATE;
5149 }
5150 if (capacity > operation->capacity) {
5151 return PSA_ERROR_INVALID_ARGUMENT;
5152 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005153 operation->capacity = capacity;
Gilles Peskine449bd832023-01-11 14:50:10 +01005154 return PSA_SUCCESS;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005155}
5156
Przemek Stekiel69c46792022-06-10 12:59:51 +02005157#if defined(BUILTIN_ALG_ANY_HKDF)
Przemek Stekiel03d948c2022-05-19 11:45:20 +02005158/* Read some bytes from an HKDF-based operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005159static psa_status_t psa_key_derivation_hkdf_read(psa_hkdf_key_derivation_t *hkdf,
5160 psa_algorithm_t kdf_alg,
5161 uint8_t *output,
5162 size_t output_length)
Gilles Peskinebef7f142018-07-12 17:22:21 +02005163{
Gilles Peskine449bd832023-01-11 14:50:10 +01005164 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
5165 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Steven Cooremand1ed1d92021-04-29 19:11:25 +02005166 size_t hmac_output_length;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005167 psa_status_t status;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005168#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01005169 const uint8_t last_block = PSA_ALG_IS_HKDF_EXTRACT(kdf_alg) ? 0 : 0xff;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005170#else
5171 const uint8_t last_block = 0xff;
5172#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskinebef7f142018-07-12 17:22:21 +02005173
Gilles Peskine449bd832023-01-11 14:50:10 +01005174 if (hkdf->state < HKDF_STATE_KEYED ||
5175 (!hkdf->info_set
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005176#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01005177 && !PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005178#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01005179 )) {
5180 return PSA_ERROR_BAD_STATE;
5181 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005182 hkdf->state = HKDF_STATE_OUTPUT;
5183
Gilles Peskine449bd832023-01-11 14:50:10 +01005184 while (output_length != 0) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005185 /* Copy what remains of the current block */
5186 uint8_t n = hash_length - hkdf->offset_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005187 if (n > output_length) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005188 n = (uint8_t) output_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01005189 }
5190 memcpy(output, hkdf->output_block + hkdf->offset_in_block, n);
Gilles Peskinebef7f142018-07-12 17:22:21 +02005191 output += n;
5192 output_length -= n;
5193 hkdf->offset_in_block += n;
Gilles Peskine449bd832023-01-11 14:50:10 +01005194 if (output_length == 0) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005195 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01005196 }
Przemek Stekiel03d948c2022-05-19 11:45:20 +02005197 /* We can't be wanting more output after the last block, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005198 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005199 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02005200 * object was corrupted or if this function is called directly
5201 * inside the library. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005202 if (hkdf->block_number == last_block) {
5203 return PSA_ERROR_BAD_STATE;
5204 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02005205
5206 /* We need a new block */
5207 ++hkdf->block_number;
5208 hkdf->offset_in_block = 0;
Steven Cooremand1ed1d92021-04-29 19:11:25 +02005209
Gilles Peskine449bd832023-01-11 14:50:10 +01005210 status = psa_key_derivation_start_hmac(&hkdf->hmac,
5211 hash_alg,
5212 hkdf->prk,
5213 hash_length);
5214 if (status != PSA_SUCCESS) {
5215 return status;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005216 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005217
5218 if (hkdf->block_number != 1) {
5219 status = psa_mac_update(&hkdf->hmac,
5220 hkdf->output_block,
5221 hash_length);
5222 if (status != PSA_SUCCESS) {
5223 return status;
5224 }
5225 }
5226 status = psa_mac_update(&hkdf->hmac,
5227 hkdf->info,
5228 hkdf->info_length);
5229 if (status != PSA_SUCCESS) {
5230 return status;
5231 }
5232 status = psa_mac_update(&hkdf->hmac,
5233 &hkdf->block_number, 1);
5234 if (status != PSA_SUCCESS) {
5235 return status;
5236 }
5237 status = psa_mac_sign_finish(&hkdf->hmac,
5238 hkdf->output_block,
5239 sizeof(hkdf->output_block),
5240 &hmac_output_length);
5241 if (status != PSA_SUCCESS) {
5242 return status;
5243 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02005244 }
5245
Gilles Peskine449bd832023-01-11 14:50:10 +01005246 return PSA_SUCCESS;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005247}
Przemek Stekiel69c46792022-06-10 12:59:51 +02005248#endif /* BUILTIN_ALG_ANY_HKDF */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005249
John Durkop07cc04a2020-11-16 22:08:34 -08005250#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5251 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follath7742fee2019-06-17 12:58:10 +01005252static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
5253 psa_tls12_prf_key_derivation_t *tls12_prf,
Gilles Peskine449bd832023-01-11 14:50:10 +01005254 psa_algorithm_t alg)
Janos Follath7742fee2019-06-17 12:58:10 +01005255{
Gilles Peskine449bd832023-01-11 14:50:10 +01005256 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(alg);
5257 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Steven Cooremana6df6042021-04-29 19:32:25 +02005258 psa_mac_operation_t hmac = PSA_MAC_OPERATION_INIT;
5259 size_t hmac_output_length;
Janos Follathea29bfb2019-06-19 12:21:20 +01005260 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005261
Janos Follath7742fee2019-06-17 12:58:10 +01005262 /* We can't be wanting more output after block 0xff, otherwise
5263 * the capacity check in psa_key_derivation_output_bytes() would have
5264 * prevented this call. It could happen only if the operation
5265 * object was corrupted or if this function is called directly
5266 * inside the library. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005267 if (tls12_prf->block_number == 0xff) {
5268 return PSA_ERROR_CORRUPTION_DETECTED;
5269 }
Janos Follath7742fee2019-06-17 12:58:10 +01005270
5271 /* We need a new block */
5272 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01005273 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01005274
5275 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
5276 *
5277 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
5278 *
5279 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
5280 * HMAC_hash(secret, A(2) + seed) +
5281 * HMAC_hash(secret, A(3) + seed) + ...
5282 *
5283 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01005284 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01005285 *
Janos Follathea29bfb2019-06-19 12:21:20 +01005286 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01005287 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01005288 * is currently extracted as `output_block` and where i is
5289 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01005290 */
5291
Gilles Peskine449bd832023-01-11 14:50:10 +01005292 status = psa_key_derivation_start_hmac(&hmac,
5293 hash_alg,
5294 tls12_prf->secret,
5295 tls12_prf->secret_length);
5296 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005297 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005298 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005299
5300 /* Calculate A(i) where i = tls12_prf->block_number. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005301 if (tls12_prf->block_number == 1) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005302 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
5303 * the variable seed and in this instance means it in the context of the
5304 * P_hash function, where seed = label + seed.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01005305 status = psa_mac_update(&hmac,
5306 tls12_prf->label,
5307 tls12_prf->label_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 status = psa_mac_update(&hmac,
5312 tls12_prf->seed,
5313 tls12_prf->seed_length);
5314 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005315 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005316 }
5317 } else {
Janos Follathea29bfb2019-06-19 12:21:20 +01005318 /* A(i) = HMAC_hash(secret, A(i-1)) */
Gilles Peskine449bd832023-01-11 14:50:10 +01005319 status = psa_mac_update(&hmac, tls12_prf->Ai, hash_length);
5320 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005321 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005322 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005323 }
5324
Gilles Peskine449bd832023-01-11 14:50:10 +01005325 status = psa_mac_sign_finish(&hmac,
5326 tls12_prf->Ai, hash_length,
5327 &hmac_output_length);
5328 if (hmac_output_length != hash_length) {
Steven Cooremana6df6042021-04-29 19:32:25 +02005329 status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01005330 }
5331 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005332 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005333 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005334
5335 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
Gilles Peskine449bd832023-01-11 14:50:10 +01005336 status = psa_key_derivation_start_hmac(&hmac,
5337 hash_alg,
5338 tls12_prf->secret,
5339 tls12_prf->secret_length);
5340 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005341 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005342 }
5343 status = psa_mac_update(&hmac, tls12_prf->Ai, hash_length);
5344 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005345 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005346 }
5347 status = psa_mac_update(&hmac, tls12_prf->label, tls12_prf->label_length);
5348 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005349 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005350 }
5351 status = psa_mac_update(&hmac, tls12_prf->seed, tls12_prf->seed_length);
5352 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005353 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005354 }
5355 status = psa_mac_sign_finish(&hmac,
5356 tls12_prf->output_block, hash_length,
5357 &hmac_output_length);
5358 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005359 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005360 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005361
Janos Follath7742fee2019-06-17 12:58:10 +01005362
5363cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01005364 cleanup_status = psa_mac_abort(&hmac);
5365 if (status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005366 status = cleanup_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01005367 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005368
Gilles Peskine449bd832023-01-11 14:50:10 +01005369 return status;
Janos Follath7742fee2019-06-17 12:58:10 +01005370}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005371
Janos Follath844eb0e2019-06-19 12:10:49 +01005372static psa_status_t psa_key_derivation_tls12_prf_read(
5373 psa_tls12_prf_key_derivation_t *tls12_prf,
5374 psa_algorithm_t alg,
5375 uint8_t *output,
Gilles Peskine449bd832023-01-11 14:50:10 +01005376 size_t output_length)
Janos Follath844eb0e2019-06-19 12:10:49 +01005377{
Gilles Peskine449bd832023-01-11 14:50:10 +01005378 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH(alg);
5379 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Janos Follath844eb0e2019-06-19 12:10:49 +01005380 psa_status_t status;
5381 uint8_t offset, length;
5382
Gilles Peskine449bd832023-01-11 14:50:10 +01005383 switch (tls12_prf->state) {
Gilles Peskineb1edaec2021-06-11 22:41:46 +02005384 case PSA_TLS12_PRF_STATE_LABEL_SET:
5385 tls12_prf->state = PSA_TLS12_PRF_STATE_OUTPUT;
5386 break;
5387 case PSA_TLS12_PRF_STATE_OUTPUT:
5388 break;
5389 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005390 return PSA_ERROR_BAD_STATE;
Gilles Peskineb1edaec2021-06-11 22:41:46 +02005391 }
5392
Gilles Peskine449bd832023-01-11 14:50:10 +01005393 while (output_length != 0) {
Janos Follath844eb0e2019-06-19 12:10:49 +01005394 /* Check if we have fully processed the current block. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005395 if (tls12_prf->left_in_block == 0) {
5396 status = psa_key_derivation_tls12_prf_generate_next_block(tls12_prf,
5397 alg);
5398 if (status != PSA_SUCCESS) {
5399 return status;
5400 }
Janos Follath844eb0e2019-06-19 12:10:49 +01005401
5402 continue;
5403 }
5404
Gilles Peskine449bd832023-01-11 14:50:10 +01005405 if (tls12_prf->left_in_block > output_length) {
Janos Follath844eb0e2019-06-19 12:10:49 +01005406 length = (uint8_t) output_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01005407 } else {
Janos Follath844eb0e2019-06-19 12:10:49 +01005408 length = tls12_prf->left_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005409 }
Janos Follath844eb0e2019-06-19 12:10:49 +01005410
5411 offset = hash_length - tls12_prf->left_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005412 memcpy(output, tls12_prf->output_block + offset, length);
Janos Follath844eb0e2019-06-19 12:10:49 +01005413 output += length;
5414 output_length -= length;
5415 tls12_prf->left_in_block -= length;
5416 }
5417
Gilles Peskine449bd832023-01-11 14:50:10 +01005418 return PSA_SUCCESS;
Janos Follath844eb0e2019-06-19 12:10:49 +01005419}
John Durkop07cc04a2020-11-16 22:08:34 -08005420#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
5421 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskinebef7f142018-07-12 17:22:21 +02005422
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005423#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
5424static psa_status_t psa_key_derivation_tls12_ecjpake_to_pms_read(
5425 psa_tls12_ecjpake_to_pms_t *ecjpake,
5426 uint8_t *output,
Gilles Peskine449bd832023-01-11 14:50:10 +01005427 size_t output_length)
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005428{
5429 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Andrzej Kurek5603efd2022-09-26 10:49:16 -04005430 size_t output_size = 0;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005431
Gilles Peskine449bd832023-01-11 14:50:10 +01005432 if (output_length != 32) {
5433 return PSA_ERROR_INVALID_ARGUMENT;
5434 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005435
Gilles Peskine449bd832023-01-11 14:50:10 +01005436 status = psa_hash_compute(PSA_ALG_SHA_256, ecjpake->data,
5437 PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE, output, output_length,
5438 &output_size);
5439 if (status != PSA_SUCCESS) {
5440 return status;
5441 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005442
Gilles Peskine449bd832023-01-11 14:50:10 +01005443 if (output_size != output_length) {
5444 return PSA_ERROR_GENERIC_ERROR;
5445 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005446
Gilles Peskine449bd832023-01-11 14:50:10 +01005447 return PSA_SUCCESS;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005448}
5449#endif
5450
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305451#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305452static psa_status_t psa_key_derivation_pbkdf2_generate_block(
5453 psa_pbkdf2_key_derivation_t *pbkdf2,
5454 psa_algorithm_t prf_alg,
5455 uint8_t prf_output_length,
5456 psa_key_attributes_t *attributes)
5457{
5458 psa_status_t status;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305459 psa_mac_operation_t mac_operation = PSA_MAC_OPERATION_INIT;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305460 size_t mac_output_length;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305461 uint8_t U_i[PSA_MAC_MAX_SIZE];
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305462 uint8_t *U_accumulator = pbkdf2->output_block;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305463 uint64_t i;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305464 uint8_t block_counter[4];
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305465
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305466 mac_operation.is_sign = 1;
5467 mac_operation.mac_size = prf_output_length;
5468 MBEDTLS_PUT_UINT32_BE(pbkdf2->block_number, block_counter, 0);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305469
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305470 status = psa_driver_wrapper_mac_sign_setup(&mac_operation,
5471 attributes,
5472 pbkdf2->password,
5473 pbkdf2->password_length,
5474 prf_alg);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305475 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305476 goto cleanup;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305477 }
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305478 status = psa_mac_update(&mac_operation, pbkdf2->salt, pbkdf2->salt_length);
5479 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305480 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305481 }
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305482 status = psa_mac_update(&mac_operation, block_counter, sizeof(block_counter));
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305483 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305484 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305485 }
5486 status = psa_mac_sign_finish(&mac_operation, U_i, sizeof(U_i),
5487 &mac_output_length);
5488 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305489 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305490 }
5491
5492 if (mac_output_length != prf_output_length) {
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305493 status = PSA_ERROR_CORRUPTION_DETECTED;
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305494 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305495 }
5496
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305497 memcpy(U_accumulator, U_i, prf_output_length);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305498
5499 for (i = 1; i < pbkdf2->input_cost; i++) {
Kusumit Ghoderao4536bb62023-06-22 15:42:59 +05305500 /* We are passing prf_output_length as mac_size because the driver
5501 * function directly sets mac_output_length as mac_size upon success.
Kusumit Ghoderao5f3345a2023-07-27 21:21:38 +05305502 * See https://github.com/Mbed-TLS/mbedtls/issues/7801 */
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305503 status = psa_driver_wrapper_mac_compute(attributes,
5504 pbkdf2->password,
5505 pbkdf2->password_length,
5506 prf_alg, U_i, prf_output_length,
Kusumit Ghoderao4536bb62023-06-22 15:42:59 +05305507 U_i, prf_output_length,
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305508 &mac_output_length);
5509 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305510 goto cleanup;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305511 }
5512
Kusumit Ghoderao109ee3d2023-06-08 16:36:45 +05305513 mbedtls_xor(U_accumulator, U_accumulator, U_i, prf_output_length);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305514 }
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305515
5516cleanup:
5517 /* Zeroise buffers to clear sensitive data from memory. */
5518 mbedtls_platform_zeroize(U_i, PSA_MAC_MAX_SIZE);
5519 return status;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305520}
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05305521
5522static psa_status_t psa_key_derivation_pbkdf2_read(
5523 psa_pbkdf2_key_derivation_t *pbkdf2,
5524 psa_algorithm_t kdf_alg,
5525 uint8_t *output,
5526 size_t output_length)
5527{
5528 psa_status_t status;
5529 psa_algorithm_t prf_alg;
5530 uint8_t prf_output_length;
5531 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
5532 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(pbkdf2->password_length));
5533 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
5534
5535 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
5536 prf_alg = PSA_ALG_HMAC(PSA_ALG_PBKDF2_HMAC_GET_HASH(kdf_alg));
5537 prf_output_length = PSA_HASH_LENGTH(prf_alg);
5538 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
Kusumit Ghoderaoa2520a52023-06-22 15:42:19 +05305539 } else if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
5540 prf_alg = PSA_ALG_CMAC;
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05305541 prf_output_length = PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC);
Kusumit Ghoderaoa2520a52023-06-22 15:42:19 +05305542 psa_set_key_type(&attributes, PSA_KEY_TYPE_AES);
Kusumit Ghoderaod9ec1af2023-06-08 20:19:51 +05305543 } else {
5544 return PSA_ERROR_INVALID_ARGUMENT;
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05305545 }
5546
5547 switch (pbkdf2->state) {
5548 case PSA_PBKDF2_STATE_PASSWORD_SET:
5549 /* Initially we need a new block so bytes_used is equal to block size*/
5550 pbkdf2->bytes_used = prf_output_length;
5551 pbkdf2->state = PSA_PBKDF2_STATE_OUTPUT;
5552 break;
5553 case PSA_PBKDF2_STATE_OUTPUT:
5554 break;
5555 default:
5556 return PSA_ERROR_BAD_STATE;
5557 }
5558
5559 while (output_length != 0) {
5560 uint8_t n = prf_output_length - pbkdf2->bytes_used;
5561 if (n > output_length) {
5562 n = (uint8_t) output_length;
5563 }
5564 memcpy(output, pbkdf2->output_block + pbkdf2->bytes_used, n);
5565 output += n;
5566 output_length -= n;
5567 pbkdf2->bytes_used += n;
5568
5569 if (output_length == 0) {
5570 break;
5571 }
5572
5573 /* We need a new block */
5574 pbkdf2->bytes_used = 0;
5575 pbkdf2->block_number++;
5576
5577 status = psa_key_derivation_pbkdf2_generate_block(pbkdf2, prf_alg,
5578 prf_output_length,
5579 &attributes);
5580 if (status != PSA_SUCCESS) {
5581 return status;
5582 }
5583 }
5584
5585 return PSA_SUCCESS;
5586}
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305587#endif /* PSA_HAVE_SOFT_PBKDF2 */
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305588
Janos Follath6c6c8fc2019-06-17 12:38:20 +01005589psa_status_t psa_key_derivation_output_bytes(
5590 psa_key_derivation_operation_t *operation,
5591 uint8_t *output,
Gilles Peskine449bd832023-01-11 14:50:10 +01005592 size_t output_length)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005593{
5594 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01005595 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
Gilles Peskineeab56e42018-07-12 17:12:33 +02005596
Gilles Peskine449bd832023-01-11 14:50:10 +01005597 if (operation->alg == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005598 /* This is a blank operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005599 return PSA_ERROR_BAD_STATE;
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005600 }
5601
Gilles Peskine449bd832023-01-11 14:50:10 +01005602 if (output_length > operation->capacity) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005603 operation->capacity = 0;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005604 /* Go through the error path to wipe all confidential data now
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005605 * that the operation object is useless. */
David Saadab4ecc272019-02-14 13:48:10 +02005606 status = PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005607 goto exit;
5608 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005609 if (output_length == 0 && operation->capacity == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005610 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005611 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02005612 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
5613 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005614 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02005615 * output_length > 0. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005616 return PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005617 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005618 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005619
Przemek Stekiel69c46792022-06-10 12:59:51 +02005620#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01005621 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
5622 status = psa_key_derivation_hkdf_read(&operation->ctx.hkdf, kdf_alg,
5623 output, output_length);
5624 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02005625#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08005626#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5627 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005628 if (PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
5629 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
5630 status = psa_key_derivation_tls12_prf_read(&operation->ctx.tls12_prf,
5631 kdf_alg, output,
5632 output_length);
5633 } else
John Durkop07cc04a2020-11-16 22:08:34 -08005634#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
5635 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005636#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005637 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005638 status = psa_key_derivation_tls12_ecjpake_to_pms_read(
Gilles Peskine449bd832023-01-11 14:50:10 +01005639 &operation->ctx.tls12_ecjpake_to_pms, output, output_length);
5640 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005641#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305642#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05305643 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05305644 status = psa_key_derivation_pbkdf2_read(&operation->ctx.pbkdf2, kdf_alg,
5645 output, output_length);
Kusumit Ghoderao056f0c52023-05-03 15:58:34 +05305646 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305647#endif /* PSA_HAVE_SOFT_PBKDF2 */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005648
Gilles Peskineeab56e42018-07-12 17:12:33 +02005649 {
Steven Cooreman74afe472021-02-10 17:19:22 +01005650 (void) kdf_alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01005651 return PSA_ERROR_BAD_STATE;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005652 }
5653
5654exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005655 if (status != PSA_SUCCESS) {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005656 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005657 * This allows us to differentiate between exhausted operations and
5658 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
5659 * operations. */
5660 psa_algorithm_t alg = operation->alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01005661 psa_key_derivation_abort(operation);
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005662 operation->alg = alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01005663 memset(output, '!', output_length);
Gilles Peskineeab56e42018-07-12 17:12:33 +02005664 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005665 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005666}
5667
David Brown7807bf72021-02-09 16:28:23 -07005668#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01005669static void psa_des_set_key_parity(uint8_t *data, size_t data_size)
Gilles Peskine08542d82018-07-19 17:05:42 +02005670{
Gilles Peskine449bd832023-01-11 14:50:10 +01005671 if (data_size >= 8) {
5672 mbedtls_des_key_set_parity(data);
5673 }
5674 if (data_size >= 16) {
5675 mbedtls_des_key_set_parity(data + 8);
5676 }
5677 if (data_size >= 24) {
5678 mbedtls_des_key_set_parity(data + 16);
5679 }
Gilles Peskine08542d82018-07-19 17:05:42 +02005680}
David Brown7807bf72021-02-09 16:28:23 -07005681#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine08542d82018-07-19 17:05:42 +02005682
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005683/*
Gilles Peskine449bd832023-01-11 14:50:10 +01005684 * ECC keys on a Weierstrass elliptic curve require the generation
5685 * of a private key which is an integer
5686 * in the range [1, N - 1], where N is the boundary of the private key domain:
5687 * N is the prime p for Diffie-Hellman, or the order of the
5688 * curve’s base point for ECC.
5689 *
5690 * Let m be the bit size of N, such that 2^m > N >= 2^(m-1).
5691 * This function generates the private key using the following process:
5692 *
5693 * 1. Draw a byte string of length ceiling(m/8) bytes.
5694 * 2. If m is not a multiple of 8, set the most significant
5695 * (8 * ceiling(m/8) - m) bits of the first byte in the string to zero.
5696 * 3. Convert the string to integer k by decoding it as a big-endian byte string.
5697 * 4. If k > N - 2, discard the result and return to step 1.
5698 * 5. Output k + 1 as the private key.
5699 *
5700 * This method allows compliance to NIST standards, specifically the methods titled
5701 * Key-Pair Generation by Testing Candidates in the following publications:
5702 * - NIST Special Publication 800-56A: Recommendation for Pair-Wise Key-Establishment
5703 * Schemes Using Discrete Logarithm Cryptography [SP800-56A] §5.6.1.1.4 for
5704 * Diffie-Hellman keys.
5705 *
5706 * - [SP800-56A] §5.6.1.2.2 or FIPS Publication 186-4: Digital Signature
5707 * Standard (DSS) [FIPS186-4] §B.4.2 for elliptic curve keys.
5708 *
5709 * Note: Function allocates memory for *data buffer, so given *data should be
5710 * always NULL.
5711 */
Valerio Setti86587ab2023-06-27 13:09:30 +02005712#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE)
5713#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE)
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01005714static psa_status_t psa_generate_derived_ecc_key_weierstrass_helper(
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005715 psa_key_slot_t *slot,
5716 size_t bits,
5717 psa_key_derivation_operation_t *operation,
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005718 uint8_t **data
5719 )
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005720{
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005721 unsigned key_out_of_range = 1;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005722 mbedtls_mpi k;
5723 mbedtls_mpi diff_N_2;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005724 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Przemek Stekiela81aed22022-03-01 15:13:30 +01005725 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01005726 size_t m;
5727 size_t m_bytes;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005728
Gilles Peskine449bd832023-01-11 14:50:10 +01005729 mbedtls_mpi_init(&k);
5730 mbedtls_mpi_init(&diff_N_2);
Przemyslaw Stekiel1dfd1222021-11-18 13:35:00 +01005731
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005732 psa_ecc_family_t curve = PSA_KEY_TYPE_ECC_GET_FAMILY(
Gilles Peskine449bd832023-01-11 14:50:10 +01005733 slot->attr.type);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005734 mbedtls_ecp_group_id grp_id =
Gilles Peskine449bd832023-01-11 14:50:10 +01005735 mbedtls_ecc_group_of_psa(curve, bits, 0);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005736
Gilles Peskine449bd832023-01-11 14:50:10 +01005737 if (grp_id == MBEDTLS_ECP_DP_NONE) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005738 ret = MBEDTLS_ERR_ASN1_INVALID_DATA;
Przemyslaw Stekiel871a3362021-12-02 08:46:39 +01005739 goto cleanup;
5740 }
5741
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005742 mbedtls_ecp_group ecp_group;
Gilles Peskine449bd832023-01-11 14:50:10 +01005743 mbedtls_ecp_group_init(&ecp_group);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005744
Gilles Peskine449bd832023-01-11 14:50:10 +01005745 MBEDTLS_MPI_CHK(mbedtls_ecp_group_load(&ecp_group, grp_id));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005746
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005747 /* N is the boundary of the private key domain (ecp_group.N). */
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005748 /* Let m be the bit size of N. */
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01005749 m = ecp_group.nbits;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005750
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01005751 m_bytes = PSA_BITS_TO_BYTES(m);
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005752
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005753 /* Calculate N - 2 - it will be needed later. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005754 MBEDTLS_MPI_CHK(mbedtls_mpi_sub_int(&diff_N_2, &ecp_group.N, 2));
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005755
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005756 /* Note: This function is always called with *data == NULL and it
5757 * allocates memory for the data buffer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005758 *data = mbedtls_calloc(1, m_bytes);
5759 if (*data == NULL) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005760 ret = MBEDTLS_ERR_ASN1_ALLOC_FAILED;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005761 goto cleanup;
5762 }
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005763
Gilles Peskine449bd832023-01-11 14:50:10 +01005764 while (key_out_of_range) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005765 /* 1. Draw a byte string of length ceiling(m/8) bytes. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005766 if ((status = psa_key_derivation_output_bytes(operation, *data, m_bytes)) != 0) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005767 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005768 }
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005769
5770 /* 2. If m is not a multiple of 8 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005771 if (m % 8 != 0) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005772 /* Set the most significant
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005773 * (8 * ceiling(m/8) - m) bits of the first byte in
5774 * the string to zero.
5775 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005776 uint8_t clear_bit_mask = (1 << (m % 8)) - 1;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005777 (*data)[0] &= clear_bit_mask;
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005778 }
5779
5780 /* 3. Convert the string to integer k by decoding it as a
Gilles Peskine449bd832023-01-11 14:50:10 +01005781 * big-endian byte string.
5782 */
5783 MBEDTLS_MPI_CHK(mbedtls_mpi_read_binary(&k, *data, m_bytes));
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005784
5785 /* 4. If k > N - 2, discard the result and return to step 1.
Gilles Peskine449bd832023-01-11 14:50:10 +01005786 * Result of comparison is returned. When it indicates error
5787 * then this function is called again.
5788 */
5789 MBEDTLS_MPI_CHK(mbedtls_mpi_lt_mpi_ct(&diff_N_2, &k, &key_out_of_range));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005790 }
5791
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005792 /* 5. Output k + 1 as the private key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005793 MBEDTLS_MPI_CHK(mbedtls_mpi_add_int(&k, &k, 1));
5794 MBEDTLS_MPI_CHK(mbedtls_mpi_write_binary(&k, *data, m_bytes));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005795cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01005796 if (ret != 0) {
5797 status = mbedtls_to_psa_error(ret);
5798 }
5799 if (status != PSA_SUCCESS) {
5800 mbedtls_free(*data);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005801 *data = NULL;
5802 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005803 mbedtls_mpi_free(&k);
5804 mbedtls_mpi_free(&diff_N_2);
5805 return status;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005806}
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005807
5808/* ECC keys on a Montgomery elliptic curve draws a byte string whose length
5809 * is determined by the curve, and sets the mandatory bits accordingly. That is:
5810 *
5811 * - Curve25519 (PSA_ECC_FAMILY_MONTGOMERY, 255 bits):
5812 * draw a 32-byte string and process it as specified in
5813 * Elliptic Curves for Security [RFC7748] §5.
5814 *
5815 * - Curve448 (PSA_ECC_FAMILY_MONTGOMERY, 448 bits):
5816 * draw a 56-byte string and process it as specified in [RFC7748] §5.
5817 *
5818 * Note: Function allocates memory for *data buffer, so given *data should be
5819 * always NULL.
5820 */
5821
5822static psa_status_t psa_generate_derived_ecc_key_montgomery_helper(
5823 size_t bits,
5824 psa_key_derivation_operation_t *operation,
5825 uint8_t **data
5826 )
5827{
5828 size_t output_length;
Przemek Stekiela81aed22022-03-01 15:13:30 +01005829 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005830
Gilles Peskine449bd832023-01-11 14:50:10 +01005831 switch (bits) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005832 case 255:
5833 output_length = 32;
5834 break;
5835 case 448:
5836 output_length = 56;
5837 break;
5838 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005839 return PSA_ERROR_INVALID_ARGUMENT;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005840 break;
5841 }
5842
Gilles Peskine449bd832023-01-11 14:50:10 +01005843 *data = mbedtls_calloc(1, output_length);
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005844
Gilles Peskine449bd832023-01-11 14:50:10 +01005845 if (*data == NULL) {
5846 return PSA_ERROR_INSUFFICIENT_MEMORY;
5847 }
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005848
Gilles Peskine449bd832023-01-11 14:50:10 +01005849 status = psa_key_derivation_output_bytes(operation, *data, output_length);
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005850
Gilles Peskine449bd832023-01-11 14:50:10 +01005851 if (status != PSA_SUCCESS) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005852 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01005853 }
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005854
Gilles Peskine449bd832023-01-11 14:50:10 +01005855 switch (bits) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005856 case 255:
5857 (*data)[0] &= 248;
5858 (*data)[31] &= 127;
5859 (*data)[31] |= 64;
5860 break;
5861 case 448:
5862 (*data)[0] &= 252;
5863 (*data)[55] |= 128;
5864 break;
5865 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005866 return PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005867 break;
5868 }
5869
5870 return status;
5871}
Valerio Setti86587ab2023-06-27 13:09:30 +02005872#else /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE */
5873static psa_status_t psa_generate_derived_ecc_key_weierstrass_helper(
5874 psa_key_slot_t *slot, size_t bits,
5875 psa_key_derivation_operation_t *operation, uint8_t **data)
5876{
5877 (void) slot;
5878 (void) bits;
5879 (void) operation;
5880 (void) data;
5881 return PSA_ERROR_NOT_SUPPORTED;
5882}
5883
5884static psa_status_t psa_generate_derived_ecc_key_montgomery_helper(
5885 size_t bits, psa_key_derivation_operation_t *operation, uint8_t **data)
5886{
5887 (void) bits;
5888 (void) operation;
5889 (void) data;
5890 return PSA_ERROR_NOT_SUPPORTED;
5891}
5892#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE */
5893#endif /* PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE */
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005894
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01005895static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005896 psa_key_slot_t *slot,
5897 size_t bits,
Gilles Peskine449bd832023-01-11 14:50:10 +01005898 psa_key_derivation_operation_t *operation)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005899{
5900 uint8_t *data = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01005901 size_t bytes = PSA_BITS_TO_BYTES(bits);
Archanad8a83dc2021-06-14 10:04:16 +05305902 size_t storage_size = bytes;
Przemek Stekiela81aed22022-03-01 15:13:30 +01005903 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01005904 psa_key_attributes_t attributes;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005905
Gilles Peskine449bd832023-01-11 14:50:10 +01005906 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(slot->attr.type)) {
5907 return PSA_ERROR_INVALID_ARGUMENT;
5908 }
Gilles Peskineeab56e42018-07-12 17:12:33 +02005909
Valerio Setti8ffdb5d2023-06-20 13:14:08 +02005910#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE) || \
Valerio Settidd24f292023-06-26 12:21:17 +02005911 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE)
Gilles Peskine449bd832023-01-11 14:50:10 +01005912 if (PSA_KEY_TYPE_IS_ECC(slot->attr.type)) {
5913 psa_ecc_family_t curve = PSA_KEY_TYPE_ECC_GET_FAMILY(slot->attr.type);
5914 if (PSA_ECC_FAMILY_IS_WEIERSTRASS(curve)) {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01005915 /* Weierstrass elliptic curve */
Gilles Peskine449bd832023-01-11 14:50:10 +01005916 status = psa_generate_derived_ecc_key_weierstrass_helper(slot, bits, operation, &data);
5917 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005918 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005919 }
5920 } else {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01005921 /* Montgomery elliptic curve */
Gilles Peskine449bd832023-01-11 14:50:10 +01005922 status = psa_generate_derived_ecc_key_montgomery_helper(bits, operation, &data);
5923 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01005924 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005925 }
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01005926 }
Przemyslaw Stekiel1dfd1222021-11-18 13:35:00 +01005927 } else
Valerio Setti8ffdb5d2023-06-20 13:14:08 +02005928#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE) ||
Valerio Settidd24f292023-06-26 12:21:17 +02005929 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE) */
Gilles Peskine449bd832023-01-11 14:50:10 +01005930 if (key_type_is_raw_bytes(slot->attr.type)) {
5931 if (bits % 8 != 0) {
5932 return PSA_ERROR_INVALID_ARGUMENT;
5933 }
5934 data = mbedtls_calloc(1, bytes);
5935 if (data == NULL) {
5936 return PSA_ERROR_INSUFFICIENT_MEMORY;
5937 }
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01005938
Gilles Peskine449bd832023-01-11 14:50:10 +01005939 status = psa_key_derivation_output_bytes(operation, data, bytes);
5940 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01005941 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005942 }
David Brown12ca5032021-02-11 11:02:00 -07005943#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01005944 if (slot->attr.type == PSA_KEY_TYPE_DES) {
5945 psa_des_set_key_parity(data, bytes);
5946 }
Przemek Stekielf110dc02022-03-01 14:48:05 +01005947#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES) */
Gilles Peskine449bd832023-01-11 14:50:10 +01005948 } else {
5949 return PSA_ERROR_NOT_SUPPORTED;
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01005950 }
Ronald Crondd04d422020-11-28 15:14:42 +01005951
Ronald Cronbf33c932020-11-28 18:06:53 +01005952 slot->attr.bits = (psa_key_bits_t) bits;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01005953 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01005954 .core = slot->attr
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01005955 };
5956
Gilles Peskine449bd832023-01-11 14:50:10 +01005957 if (psa_key_lifetime_is_external(attributes.core.lifetime)) {
5958 status = psa_driver_wrapper_get_key_buffer_size(&attributes,
5959 &storage_size);
5960 if (status != PSA_SUCCESS) {
Archanad8a83dc2021-06-14 10:04:16 +05305961 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005962 }
Archanad8a83dc2021-06-14 10:04:16 +05305963 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005964 status = psa_allocate_buffer_to_slot(slot, storage_size);
5965 if (status != PSA_SUCCESS) {
Archanad8a83dc2021-06-14 10:04:16 +05305966 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005967 }
Archanad8a83dc2021-06-14 10:04:16 +05305968
Gilles Peskine449bd832023-01-11 14:50:10 +01005969 status = psa_driver_wrapper_import_key(&attributes,
5970 data, bytes,
5971 slot->key.data,
5972 slot->key.bytes,
5973 &slot->key.bytes, &bits);
5974 if (bits != slot->attr.bits) {
Ronald Cronbf33c932020-11-28 18:06:53 +01005975 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine449bd832023-01-11 14:50:10 +01005976 }
Gilles Peskineeab56e42018-07-12 17:12:33 +02005977
5978exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005979 mbedtls_free(data);
5980 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005981}
5982
Gilles Peskine449bd832023-01-11 14:50:10 +01005983psa_status_t psa_key_derivation_output_key(const psa_key_attributes_t *attributes,
5984 psa_key_derivation_operation_t *operation,
5985 mbedtls_svc_key_id_t *key)
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005986{
5987 psa_status_t status;
5988 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02005989 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine0f84d622019-09-12 19:03:13 +02005990
Ronald Cron81709fc2020-11-14 12:10:32 +01005991 *key = MBEDTLS_SVC_KEY_ID_INIT;
5992
Gilles Peskine0f84d622019-09-12 19:03:13 +02005993 /* Reject any attempt to create a zero-length key so that we don't
5994 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005995 if (psa_get_key_bits(attributes) == 0) {
5996 return PSA_ERROR_INVALID_ARGUMENT;
5997 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02005998
Gilles Peskine449bd832023-01-11 14:50:10 +01005999 if (operation->alg == PSA_ALG_NONE) {
6000 return PSA_ERROR_BAD_STATE;
6001 }
Dave Rodgmand69da6c2021-11-16 10:32:48 +00006002
Gilles Peskine449bd832023-01-11 14:50:10 +01006003 if (!operation->can_output_key) {
6004 return PSA_ERROR_NOT_PERMITTED;
6005 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02006006
Gilles Peskine449bd832023-01-11 14:50:10 +01006007 status = psa_start_key_creation(PSA_KEY_CREATION_DERIVE, attributes,
6008 &slot, &driver);
Gilles Peskinef4ee6622019-07-24 13:44:30 +02006009#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006010 if (driver != NULL) {
Gilles Peskinef4ee6622019-07-24 13:44:30 +02006011 /* Deriving a key in a secure element is not implemented yet. */
6012 status = PSA_ERROR_NOT_SUPPORTED;
6013 }
6014#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine449bd832023-01-11 14:50:10 +01006015 if (status == PSA_SUCCESS) {
6016 status = psa_generate_derived_key_internal(slot,
6017 attributes->core.bits,
6018 operation);
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006019 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006020 if (status == PSA_SUCCESS) {
6021 status = psa_finish_key_creation(slot, driver, key);
6022 }
6023 if (status != PSA_SUCCESS) {
6024 psa_fail_key_creation(slot, driver);
6025 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02006026
Gilles Peskine449bd832023-01-11 14:50:10 +01006027 return status;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006028}
6029
Gilles Peskineeab56e42018-07-12 17:12:33 +02006030
6031
6032/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02006033/* Key derivation */
6034/****************************************************************/
6035
Steven Cooreman932ffb72021-02-15 12:14:32 +01006036#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006037static int is_kdf_alg_supported(psa_algorithm_t kdf_alg)
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006038{
6039#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006040 if (PSA_ALG_IS_HKDF(kdf_alg)) {
6041 return 1;
6042 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006043#endif
Przemek Stekielb57a44b2022-06-06 08:33:45 +02006044#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006045 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6046 return 1;
6047 }
Przemek Stekielb57a44b2022-06-06 08:33:45 +02006048#endif
6049#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006050 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
6051 return 1;
6052 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006053#endif
6054#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006055 if (PSA_ALG_IS_TLS12_PRF(kdf_alg)) {
6056 return 1;
6057 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006058#endif
6059#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006060 if (PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
6061 return 1;
6062 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006063#endif
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006064#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006065 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
6066 return 1;
6067 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006068#endif
Kusumit Ghoderaod132cac2023-05-03 12:00:27 +05306069#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
6070 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
6071 return 1;
6072 }
6073#endif
Kusumit Ghoderao2cd64962023-06-22 15:38:57 +05306074#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128)
6075 if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
6076 return 1;
6077 }
6078#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006079 return 0;
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006080}
6081
Gilles Peskine449bd832023-01-11 14:50:10 +01006082static psa_status_t psa_hash_try_support(psa_algorithm_t alg)
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006083{
6084 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01006085 psa_status_t status = psa_hash_setup(&operation, alg);
6086 psa_hash_abort(&operation);
6087 return status;
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006088}
6089
Gilles Peskine969c5d62019-01-16 15:53:06 +01006090static psa_status_t psa_key_derivation_setup_kdf(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006091 psa_key_derivation_operation_t *operation,
Gilles Peskine449bd832023-01-11 14:50:10 +01006092 psa_algorithm_t kdf_alg)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006093{
Janos Follath5fe19732019-06-20 15:09:30 +01006094 /* Make sure that operation->ctx is properly zero-initialised. (Macro
6095 * initialisers for this union leave some bytes unspecified.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01006096 memset(&operation->ctx, 0, sizeof(operation->ctx));
Janos Follath5fe19732019-06-20 15:09:30 +01006097
Gilles Peskine969c5d62019-01-16 15:53:06 +01006098 /* Make sure that kdf_alg is a supported key derivation algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006099 if (!is_kdf_alg_supported(kdf_alg)) {
6100 return PSA_ERROR_NOT_SUPPORTED;
6101 }
John Durkop07cc04a2020-11-16 22:08:34 -08006102
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006103 /* All currently supported key derivation algorithms (apart from
Kusumit Ghoderao2cd64962023-06-22 15:38:57 +05306104 * ecjpake to pms and pbkdf2_aes_cmac_128) are based on a hash algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006105 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
6106 size_t hash_size = PSA_HASH_LENGTH(hash_alg);
Kusumit Ghoderao2cd64962023-06-22 15:38:57 +05306107 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
6108 hash_size = PSA_HASH_LENGTH(PSA_ALG_SHA_256);
6109 } else if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306110 hash_size = PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC);
Kusumit Ghoderao2cd64962023-06-22 15:38:57 +05306111 } else {
Gilles Peskine449bd832023-01-11 14:50:10 +01006112 if (hash_size == 0) {
6113 return PSA_ERROR_NOT_SUPPORTED;
6114 }
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006115
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006116 /* Make sure that hash_alg is a supported hash algorithm. Otherwise
6117 * we might fail later, which is somewhat unfriendly and potentially
6118 * risk-prone. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006119 psa_status_t status = psa_hash_try_support(hash_alg);
6120 if (status != PSA_SUCCESS) {
6121 return status;
6122 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006123 }
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006124
Gilles Peskine449bd832023-01-11 14:50:10 +01006125 if ((PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
6126 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) &&
6127 !(hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384)) {
6128 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006129 }
Andrzej Kurek77638292022-09-16 12:24:52 -04006130#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT) || \
Andrzej Kurekb510cd22022-09-26 10:50:22 -04006131 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006132 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg) ||
6133 (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS)) {
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006134 operation->capacity = hash_size;
Gilles Peskine449bd832023-01-11 14:50:10 +01006135 } else
Andrzej Kurekb510cd22022-09-26 10:50:22 -04006136#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT ||
6137 MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Gilles Peskine449bd832023-01-11 14:50:10 +01006138 operation->capacity = 255 * hash_size;
6139 return PSA_SUCCESS;
Gilles Peskine969c5d62019-01-16 15:53:06 +01006140}
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006141
Gilles Peskine449bd832023-01-11 14:50:10 +01006142static psa_status_t psa_key_agreement_try_support(psa_algorithm_t alg)
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006143{
6144#if defined(PSA_WANT_ALG_ECDH)
Gilles Peskine449bd832023-01-11 14:50:10 +01006145 if (alg == PSA_ALG_ECDH) {
6146 return PSA_SUCCESS;
6147 }
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006148#endif
Przemek Stekielfb3dd542022-12-01 14:59:15 +01006149#if defined(PSA_WANT_ALG_FFDH)
6150 if (alg == PSA_ALG_FFDH) {
6151 return PSA_SUCCESS;
6152 }
6153#endif
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006154 (void) alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01006155 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006156}
Gilles Peskinebb3814c2022-12-16 01:12:12 +01006157
6158static int psa_key_derivation_allows_free_form_secret_input(
6159 psa_algorithm_t kdf_alg)
6160{
6161#if defined(PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS)
6162 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
6163 return 0;
6164 }
6165#endif
6166 (void) kdf_alg;
6167 return 1;
6168}
John Durkop07cc04a2020-11-16 22:08:34 -08006169#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01006170
Gilles Peskine449bd832023-01-11 14:50:10 +01006171psa_status_t psa_key_derivation_setup(psa_key_derivation_operation_t *operation,
6172 psa_algorithm_t alg)
Gilles Peskine969c5d62019-01-16 15:53:06 +01006173{
6174 psa_status_t status;
6175
Gilles Peskine449bd832023-01-11 14:50:10 +01006176 if (operation->alg != 0) {
6177 return PSA_ERROR_BAD_STATE;
Gilles Peskine969c5d62019-01-16 15:53:06 +01006178 }
Gilles Peskine969c5d62019-01-16 15:53:06 +01006179
Gilles Peskine449bd832023-01-11 14:50:10 +01006180 if (PSA_ALG_IS_RAW_KEY_AGREEMENT(alg)) {
6181 return PSA_ERROR_INVALID_ARGUMENT;
6182 } else if (PSA_ALG_IS_KEY_AGREEMENT(alg)) {
6183#if defined(AT_LEAST_ONE_BUILTIN_KDF)
6184 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF(alg);
6185 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE(alg);
6186 status = psa_key_agreement_try_support(ka_alg);
6187 if (status != PSA_SUCCESS) {
6188 return status;
6189 }
Gilles Peskinebb3814c2022-12-16 01:12:12 +01006190 if (!psa_key_derivation_allows_free_form_secret_input(kdf_alg)) {
6191 return PSA_ERROR_INVALID_ARGUMENT;
6192 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006193 status = psa_key_derivation_setup_kdf(operation, kdf_alg);
6194#else
6195 return PSA_ERROR_NOT_SUPPORTED;
6196#endif /* AT_LEAST_ONE_BUILTIN_KDF */
6197 } else if (PSA_ALG_IS_KEY_DERIVATION(alg)) {
6198#if defined(AT_LEAST_ONE_BUILTIN_KDF)
6199 status = psa_key_derivation_setup_kdf(operation, alg);
6200#else
6201 return PSA_ERROR_NOT_SUPPORTED;
6202#endif /* AT_LEAST_ONE_BUILTIN_KDF */
6203 } else {
6204 return PSA_ERROR_INVALID_ARGUMENT;
6205 }
6206
6207 if (status == PSA_SUCCESS) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006208 operation->alg = alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01006209 }
6210 return status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006211}
6212
Przemek Stekiel69c46792022-06-10 12:59:51 +02006213#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006214static psa_status_t psa_hkdf_input(psa_hkdf_key_derivation_t *hkdf,
6215 psa_algorithm_t kdf_alg,
6216 psa_key_derivation_step_t step,
6217 const uint8_t *data,
6218 size_t data_length)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006219{
Gilles Peskine449bd832023-01-11 14:50:10 +01006220 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006221 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006222 switch (step) {
Gilles Peskine03410b52019-05-16 16:05:19 +02006223 case PSA_KEY_DERIVATION_INPUT_SALT:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006224#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006225 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
6226 return PSA_ERROR_INVALID_ARGUMENT;
6227 }
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006228#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND */
Gilles Peskine449bd832023-01-11 14:50:10 +01006229 if (hkdf->state != HKDF_STATE_INIT) {
6230 return PSA_ERROR_BAD_STATE;
6231 } else {
6232 status = psa_key_derivation_start_hmac(&hkdf->hmac,
6233 hash_alg,
6234 data, data_length);
6235 if (status != PSA_SUCCESS) {
6236 return status;
6237 }
Steven Cooremand1ed1d92021-04-29 19:11:25 +02006238 hkdf->state = HKDF_STATE_STARTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01006239 return PSA_SUCCESS;
Steven Cooremand1ed1d92021-04-29 19:11:25 +02006240 }
Gilles Peskine03410b52019-05-16 16:05:19 +02006241 case PSA_KEY_DERIVATION_INPUT_SECRET:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006242#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006243 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
Przemek Stekiel2fb0dcd2022-05-19 10:34:37 +02006244 /* We shouldn't be in different state as HKDF_EXPAND only allows
6245 * two inputs: SECRET (this case) and INFO which does not modify
6246 * the state. It could happen only if the hkdf
6247 * object was corrupted. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006248 if (hkdf->state != HKDF_STATE_INIT) {
6249 return PSA_ERROR_BAD_STATE;
6250 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006251
Przemek Stekiel2fb0dcd2022-05-19 10:34:37 +02006252 /* Allow only input that fits expected prk size */
Gilles Peskine449bd832023-01-11 14:50:10 +01006253 if (data_length != PSA_HASH_LENGTH(hash_alg)) {
6254 return PSA_ERROR_INVALID_ARGUMENT;
6255 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006256
Gilles Peskine449bd832023-01-11 14:50:10 +01006257 memcpy(hkdf->prk, data, data_length);
6258 } else
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006259#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND */
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006260 {
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006261 /* HKDF: If no salt was provided, use an empty salt.
6262 * HKDF-EXTRACT: salt is mandatory. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006263 if (hkdf->state == HKDF_STATE_INIT) {
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006264#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006265 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6266 return PSA_ERROR_BAD_STATE;
6267 }
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006268#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01006269 status = psa_key_derivation_start_hmac(&hkdf->hmac,
6270 hash_alg,
6271 NULL, 0);
6272 if (status != PSA_SUCCESS) {
6273 return status;
6274 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006275 hkdf->state = HKDF_STATE_STARTED;
6276 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006277 if (hkdf->state != HKDF_STATE_STARTED) {
6278 return PSA_ERROR_BAD_STATE;
6279 }
6280 status = psa_mac_update(&hkdf->hmac,
6281 data, data_length);
6282 if (status != PSA_SUCCESS) {
6283 return status;
6284 }
6285 status = psa_mac_sign_finish(&hkdf->hmac,
6286 hkdf->prk,
6287 sizeof(hkdf->prk),
6288 &data_length);
6289 if (status != PSA_SUCCESS) {
6290 return status;
6291 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006292 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006293
Gilles Peskine2b522db2019-04-12 15:11:49 +02006294 hkdf->state = HKDF_STATE_KEYED;
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006295 hkdf->block_number = 0;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006296#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006297 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006298 /* The only block of output is the PRK. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006299 memcpy(hkdf->output_block, hkdf->prk, PSA_HASH_LENGTH(hash_alg));
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006300 hkdf->offset_in_block = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01006301 } else
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006302#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006303 {
6304 /* Block 0 is empty, and the next block will be
6305 * generated by psa_key_derivation_hkdf_read(). */
Gilles Peskine449bd832023-01-11 14:50:10 +01006306 hkdf->offset_in_block = PSA_HASH_LENGTH(hash_alg);
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006307 }
6308
Gilles Peskine449bd832023-01-11 14:50:10 +01006309 return PSA_SUCCESS;
Gilles Peskine03410b52019-05-16 16:05:19 +02006310 case PSA_KEY_DERIVATION_INPUT_INFO:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006311#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006312 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6313 return PSA_ERROR_INVALID_ARGUMENT;
6314 }
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006315#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Przemek Stekielcde3f782022-06-03 16:12:27 +02006316#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006317 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg) &&
6318 hkdf->state == HKDF_STATE_INIT) {
6319 return PSA_ERROR_BAD_STATE;
6320 }
Przemek Stekielcde3f782022-06-03 16:12:27 +02006321#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01006322 if (hkdf->state == HKDF_STATE_OUTPUT) {
6323 return PSA_ERROR_BAD_STATE;
6324 }
6325 if (hkdf->info_set) {
6326 return PSA_ERROR_BAD_STATE;
6327 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006328 hkdf->info_length = data_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01006329 if (data_length != 0) {
6330 hkdf->info = mbedtls_calloc(1, data_length);
6331 if (hkdf->info == NULL) {
6332 return PSA_ERROR_INSUFFICIENT_MEMORY;
6333 }
6334 memcpy(hkdf->info, data, data_length);
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006335 }
6336 hkdf->info_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01006337 return PSA_SUCCESS;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006338 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006339 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006340 }
6341}
Przemek Stekiel69c46792022-06-10 12:59:51 +02006342#endif /* BUILTIN_ALG_ANY_HKDF */
Janos Follathb03233e2019-06-11 15:30:30 +01006343
John Durkop07cc04a2020-11-16 22:08:34 -08006344#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
6345 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006346static psa_status_t psa_tls12_prf_set_seed(psa_tls12_prf_key_derivation_t *prf,
6347 const uint8_t *data,
6348 size_t data_length)
Janos Follathf08e2652019-06-13 09:05:41 +01006349{
Gilles Peskine449bd832023-01-11 14:50:10 +01006350 if (prf->state != PSA_TLS12_PRF_STATE_INIT) {
6351 return PSA_ERROR_BAD_STATE;
6352 }
Janos Follathf08e2652019-06-13 09:05:41 +01006353
Gilles Peskine449bd832023-01-11 14:50:10 +01006354 if (data_length != 0) {
6355 prf->seed = mbedtls_calloc(1, data_length);
6356 if (prf->seed == NULL) {
6357 return PSA_ERROR_INSUFFICIENT_MEMORY;
6358 }
Janos Follathf08e2652019-06-13 09:05:41 +01006359
Gilles Peskine449bd832023-01-11 14:50:10 +01006360 memcpy(prf->seed, data, data_length);
Janos Follathd6dce9f2019-07-04 09:11:38 +01006361 prf->seed_length = data_length;
6362 }
Janos Follathf08e2652019-06-13 09:05:41 +01006363
Gilles Peskine43f958b2020-12-13 14:55:14 +01006364 prf->state = PSA_TLS12_PRF_STATE_SEED_SET;
Janos Follathf08e2652019-06-13 09:05:41 +01006365
Gilles Peskine449bd832023-01-11 14:50:10 +01006366 return PSA_SUCCESS;
Janos Follathf08e2652019-06-13 09:05:41 +01006367}
6368
Gilles Peskine449bd832023-01-11 14:50:10 +01006369static psa_status_t psa_tls12_prf_set_key(psa_tls12_prf_key_derivation_t *prf,
6370 const uint8_t *data,
6371 size_t data_length)
Janos Follath81550542019-06-13 14:26:34 +01006372{
Gilles Peskine449bd832023-01-11 14:50:10 +01006373 if (prf->state != PSA_TLS12_PRF_STATE_SEED_SET &&
6374 prf->state != PSA_TLS12_PRF_STATE_OTHER_KEY_SET) {
6375 return PSA_ERROR_BAD_STATE;
6376 }
Janos Follath81550542019-06-13 14:26:34 +01006377
Gilles Peskine449bd832023-01-11 14:50:10 +01006378 if (data_length != 0) {
6379 prf->secret = mbedtls_calloc(1, data_length);
6380 if (prf->secret == NULL) {
6381 return PSA_ERROR_INSUFFICIENT_MEMORY;
6382 }
Steven Cooremana6df6042021-04-29 19:32:25 +02006383
Gilles Peskine449bd832023-01-11 14:50:10 +01006384 memcpy(prf->secret, data, data_length);
Steven Cooremana6df6042021-04-29 19:32:25 +02006385 prf->secret_length = data_length;
6386 }
Janos Follath81550542019-06-13 14:26:34 +01006387
Gilles Peskine43f958b2020-12-13 14:55:14 +01006388 prf->state = PSA_TLS12_PRF_STATE_KEY_SET;
Janos Follath81550542019-06-13 14:26:34 +01006389
Gilles Peskine449bd832023-01-11 14:50:10 +01006390 return PSA_SUCCESS;
Janos Follath81550542019-06-13 14:26:34 +01006391}
6392
Gilles Peskine449bd832023-01-11 14:50:10 +01006393static psa_status_t psa_tls12_prf_set_label(psa_tls12_prf_key_derivation_t *prf,
6394 const uint8_t *data,
6395 size_t data_length)
Janos Follath63028dd2019-06-13 09:15:47 +01006396{
Gilles Peskine449bd832023-01-11 14:50:10 +01006397 if (prf->state != PSA_TLS12_PRF_STATE_KEY_SET) {
6398 return PSA_ERROR_BAD_STATE;
6399 }
Janos Follath63028dd2019-06-13 09:15:47 +01006400
Gilles Peskine449bd832023-01-11 14:50:10 +01006401 if (data_length != 0) {
6402 prf->label = mbedtls_calloc(1, data_length);
6403 if (prf->label == NULL) {
6404 return PSA_ERROR_INSUFFICIENT_MEMORY;
6405 }
Janos Follath63028dd2019-06-13 09:15:47 +01006406
Gilles Peskine449bd832023-01-11 14:50:10 +01006407 memcpy(prf->label, data, data_length);
Janos Follathd6dce9f2019-07-04 09:11:38 +01006408 prf->label_length = data_length;
6409 }
Janos Follath63028dd2019-06-13 09:15:47 +01006410
Gilles Peskine43f958b2020-12-13 14:55:14 +01006411 prf->state = PSA_TLS12_PRF_STATE_LABEL_SET;
Janos Follath63028dd2019-06-13 09:15:47 +01006412
Gilles Peskine449bd832023-01-11 14:50:10 +01006413 return PSA_SUCCESS;
Janos Follath63028dd2019-06-13 09:15:47 +01006414}
6415
Gilles Peskine449bd832023-01-11 14:50:10 +01006416static psa_status_t psa_tls12_prf_input(psa_tls12_prf_key_derivation_t *prf,
6417 psa_key_derivation_step_t step,
6418 const uint8_t *data,
6419 size_t data_length)
Janos Follathb03233e2019-06-11 15:30:30 +01006420{
Gilles Peskine449bd832023-01-11 14:50:10 +01006421 switch (step) {
Janos Follathf08e2652019-06-13 09:05:41 +01006422 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskine449bd832023-01-11 14:50:10 +01006423 return psa_tls12_prf_set_seed(prf, data, data_length);
Janos Follath81550542019-06-13 14:26:34 +01006424 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006425 return psa_tls12_prf_set_key(prf, data, data_length);
Janos Follath63028dd2019-06-13 09:15:47 +01006426 case PSA_KEY_DERIVATION_INPUT_LABEL:
Gilles Peskine449bd832023-01-11 14:50:10 +01006427 return psa_tls12_prf_set_label(prf, data, data_length);
Janos Follathb03233e2019-06-11 15:30:30 +01006428 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006429 return PSA_ERROR_INVALID_ARGUMENT;
Janos Follathb03233e2019-06-11 15:30:30 +01006430 }
6431}
John Durkop07cc04a2020-11-16 22:08:34 -08006432#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
6433 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
6434
6435#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
6436static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
6437 psa_tls12_prf_key_derivation_t *prf,
John Durkop07cc04a2020-11-16 22:08:34 -08006438 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006439 size_t data_length)
John Durkop07cc04a2020-11-16 22:08:34 -08006440{
6441 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006442 const size_t pms_len = (prf->state == PSA_TLS12_PRF_STATE_OTHER_KEY_SET ?
6443 4 + data_length + prf->other_secret_length :
6444 4 + 2 * data_length);
John Durkop07cc04a2020-11-16 22:08:34 -08006445
Gilles Peskine449bd832023-01-11 14:50:10 +01006446 if (data_length > PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE) {
6447 return PSA_ERROR_INVALID_ARGUMENT;
6448 }
John Durkop07cc04a2020-11-16 22:08:34 -08006449
Gilles Peskine449bd832023-01-11 14:50:10 +01006450 uint8_t *pms = mbedtls_calloc(1, pms_len);
6451 if (pms == NULL) {
6452 return PSA_ERROR_INSUFFICIENT_MEMORY;
6453 }
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02006454 uint8_t *cur = pms;
6455
6456 /* pure-PSK:
6457 * Quoting RFC 4279, Section 2:
John Durkop07cc04a2020-11-16 22:08:34 -08006458 *
6459 * The premaster secret is formed as follows: if the PSK is N octets
6460 * long, concatenate a uint16 with the value N, N zero octets, a second
6461 * uint16 with the value N, and the PSK itself.
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02006462 *
6463 * mixed-PSK:
6464 * In a DHE-PSK, RSA-PSK, ECDHE-PSK the premaster secret is formed as
6465 * follows: concatenate a uint16 with the length of the other secret,
6466 * the other secret itself, uint16 with the length of PSK, and the
6467 * PSK itself.
6468 * For details please check:
6469 * - RFC 4279, Section 4 for the definition of RSA-PSK,
6470 * - RFC 4279, Section 3 for the definition of DHE-PSK,
6471 * - RFC 5489 for the definition of ECDHE-PSK.
John Durkop07cc04a2020-11-16 22:08:34 -08006472 */
6473
Gilles Peskine449bd832023-01-11 14:50:10 +01006474 if (prf->state == PSA_TLS12_PRF_STATE_OTHER_KEY_SET) {
6475 *cur++ = MBEDTLS_BYTE_1(prf->other_secret_length);
6476 *cur++ = MBEDTLS_BYTE_0(prf->other_secret_length);
6477 if (prf->other_secret_length != 0) {
6478 memcpy(cur, prf->other_secret, prf->other_secret_length);
6479 mbedtls_platform_zeroize(prf->other_secret, prf->other_secret_length);
Przemek Stekiel2503f7e2022-04-12 12:08:01 +02006480 cur += prf->other_secret_length;
6481 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006482 } else {
6483 *cur++ = MBEDTLS_BYTE_1(data_length);
6484 *cur++ = MBEDTLS_BYTE_0(data_length);
6485 memset(cur, 0, data_length);
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02006486 cur += data_length;
6487 }
6488
Gilles Peskine449bd832023-01-11 14:50:10 +01006489 *cur++ = MBEDTLS_BYTE_1(data_length);
6490 *cur++ = MBEDTLS_BYTE_0(data_length);
6491 memcpy(cur, data, data_length);
John Durkop07cc04a2020-11-16 22:08:34 -08006492 cur += data_length;
6493
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00006494 status = psa_tls12_prf_set_key(prf, pms, (size_t) (cur - pms));
John Durkop07cc04a2020-11-16 22:08:34 -08006495
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01006496 mbedtls_zeroize_and_free(pms, pms_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01006497 return status;
John Durkop07cc04a2020-11-16 22:08:34 -08006498}
Janos Follath6660f0e2019-06-17 08:44:03 +01006499
Przemek Stekiele47201b2022-04-19 13:53:28 +02006500static psa_status_t psa_tls12_prf_psk_to_ms_set_other_key(
6501 psa_tls12_prf_key_derivation_t *prf,
6502 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006503 size_t data_length)
Przemek Stekiele47201b2022-04-19 13:53:28 +02006504{
Gilles Peskine449bd832023-01-11 14:50:10 +01006505 if (prf->state != PSA_TLS12_PRF_STATE_SEED_SET) {
6506 return PSA_ERROR_BAD_STATE;
Przemek Stekiele47201b2022-04-19 13:53:28 +02006507 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006508
6509 if (data_length != 0) {
6510 prf->other_secret = mbedtls_calloc(1, data_length);
6511 if (prf->other_secret == NULL) {
6512 return PSA_ERROR_INSUFFICIENT_MEMORY;
6513 }
6514
6515 memcpy(prf->other_secret, data, data_length);
6516 prf->other_secret_length = data_length;
6517 } else {
Przemek Stekiele47201b2022-04-19 13:53:28 +02006518 prf->other_secret_length = 0;
6519 }
6520
6521 prf->state = PSA_TLS12_PRF_STATE_OTHER_KEY_SET;
6522
Gilles Peskine449bd832023-01-11 14:50:10 +01006523 return PSA_SUCCESS;
Przemek Stekiele47201b2022-04-19 13:53:28 +02006524}
6525
Janos Follath6660f0e2019-06-17 08:44:03 +01006526static psa_status_t psa_tls12_prf_psk_to_ms_input(
6527 psa_tls12_prf_key_derivation_t *prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01006528 psa_key_derivation_step_t step,
6529 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006530 size_t data_length)
Janos Follath6660f0e2019-06-17 08:44:03 +01006531{
Gilles Peskine449bd832023-01-11 14:50:10 +01006532 switch (step) {
Przemek Stekiele47201b2022-04-19 13:53:28 +02006533 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006534 return psa_tls12_prf_psk_to_ms_set_key(prf,
6535 data, data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02006536 break;
6537 case PSA_KEY_DERIVATION_INPUT_OTHER_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006538 return psa_tls12_prf_psk_to_ms_set_other_key(prf,
6539 data,
6540 data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02006541 break;
6542 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006543 return psa_tls12_prf_input(prf, step, data, data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02006544 break;
Janos Follath6660f0e2019-06-17 08:44:03 +01006545
Przemek Stekiele47201b2022-04-19 13:53:28 +02006546 }
Janos Follath6660f0e2019-06-17 08:44:03 +01006547}
John Durkop07cc04a2020-11-16 22:08:34 -08006548#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006549
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006550#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
6551static psa_status_t psa_tls12_ecjpake_to_pms_input(
6552 psa_tls12_ecjpake_to_pms_t *ecjpake,
Andrzej Kurek702776f2022-09-16 06:22:44 -04006553 psa_key_derivation_step_t step,
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006554 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006555 size_t data_length)
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006556{
Gilles Peskine449bd832023-01-11 14:50:10 +01006557 if (data_length != PSA_TLS12_ECJPAKE_TO_PMS_INPUT_SIZE ||
6558 step != PSA_KEY_DERIVATION_INPUT_SECRET) {
6559 return PSA_ERROR_INVALID_ARGUMENT;
Andrzej Kurek5603efd2022-09-26 10:49:16 -04006560 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006561
6562 /* Check if the passed point is in an uncompressed form */
Gilles Peskine449bd832023-01-11 14:50:10 +01006563 if (data[0] != 0x04) {
6564 return PSA_ERROR_INVALID_ARGUMENT;
6565 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006566
6567 /* Only K.X has to be extracted - bytes 1 to 32 inclusive. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006568 memcpy(ecjpake->data, data + 1, PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE);
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006569
Gilles Peskine449bd832023-01-11 14:50:10 +01006570 return PSA_SUCCESS;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006571}
6572#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306573
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306574#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306575static psa_status_t psa_pbkdf2_set_input_cost(
6576 psa_pbkdf2_key_derivation_t *pbkdf2,
6577 psa_key_derivation_step_t step,
6578 uint64_t data)
6579{
6580 if (step != PSA_KEY_DERIVATION_INPUT_COST) {
6581 return PSA_ERROR_INVALID_ARGUMENT;
6582 }
6583
6584 if (pbkdf2->state != PSA_PBKDF2_STATE_INIT) {
6585 return PSA_ERROR_BAD_STATE;
6586 }
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05306587
Kusumit Ghoderaoe66a8ad2023-05-24 12:30:43 +05306588 if (data > PSA_VENDOR_PBKDF2_MAX_ITERATIONS) {
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05306589 return PSA_ERROR_NOT_SUPPORTED;
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306590 }
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05306591
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306592 if (data == 0) {
6593 return PSA_ERROR_INVALID_ARGUMENT;
6594 }
Kusumit Ghoderaoe66a8ad2023-05-24 12:30:43 +05306595
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306596 pbkdf2->input_cost = data;
6597 pbkdf2->state = PSA_PBKDF2_STATE_INPUT_COST_SET;
6598
6599 return PSA_SUCCESS;
6600}
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306601
6602static psa_status_t psa_pbkdf2_set_salt(psa_pbkdf2_key_derivation_t *pbkdf2,
6603 const uint8_t *data,
6604 size_t data_length)
6605{
Gilles Peskineead17662023-08-20 22:02:51 +02006606 if (pbkdf2->state == PSA_PBKDF2_STATE_INPUT_COST_SET) {
6607 pbkdf2->state = PSA_PBKDF2_STATE_SALT_SET;
6608 } else if (pbkdf2->state == PSA_PBKDF2_STATE_SALT_SET) {
6609 /* Appending to existing salt. No state change. */
6610 } else {
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306611 return PSA_ERROR_BAD_STATE;
6612 }
6613
Gilles Peskineca57d782023-07-20 19:08:06 +02006614 if (data_length == 0) {
Gilles Peskineead17662023-08-20 22:02:51 +02006615 /* Appending an empty string, nothing to do. */
6616 } else {
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306617 uint8_t *next_salt;
Kusumit Ghoderaob538bb72023-05-24 12:32:14 +05306618
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306619 next_salt = mbedtls_calloc(1, data_length + pbkdf2->salt_length);
6620 if (next_salt == NULL) {
Kusumit Ghoderaod0422f32023-05-08 15:56:19 +05306621 return PSA_ERROR_INSUFFICIENT_MEMORY;
6622 }
6623
Gilles Peskineead17662023-08-20 22:02:51 +02006624 if (pbkdf2->salt_length != 0) {
6625 memcpy(next_salt, pbkdf2->salt, pbkdf2->salt_length);
6626 }
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306627 memcpy(next_salt + pbkdf2->salt_length, data, data_length);
Kusumit Ghoderaod0422f32023-05-08 15:56:19 +05306628 pbkdf2->salt_length += data_length;
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306629 mbedtls_free(pbkdf2->salt);
6630 pbkdf2->salt = next_salt;
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306631 }
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306632 return PSA_SUCCESS;
6633}
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306634
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05306635#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306636static psa_status_t psa_pbkdf2_hmac_set_password(psa_algorithm_t hash_alg,
Kusumit Ghoderaoaac9a582023-05-24 14:19:17 +05306637 const uint8_t *input,
6638 size_t input_len,
6639 uint8_t *output,
Kusumit Ghoderao91f99f52023-05-24 22:21:48 +05306640 size_t *output_len)
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306641{
6642 psa_status_t status = PSA_SUCCESS;
6643 if (input_len > PSA_HASH_BLOCK_LENGTH(hash_alg)) {
6644 status = psa_hash_compute(hash_alg, input, input_len, output,
Kusumit Ghoderao91f99f52023-05-24 22:21:48 +05306645 PSA_HMAC_MAX_HASH_BLOCK_SIZE, output_len);
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306646 } else {
6647 memcpy(output, input, input_len);
Kusumit Ghoderao91f99f52023-05-24 22:21:48 +05306648 *output_len = PSA_HASH_BLOCK_LENGTH(hash_alg);
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306649 }
6650 return status;
6651}
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05306652#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC */
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306653
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05306654#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128)
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306655static psa_status_t psa_pbkdf2_cmac_set_password(const uint8_t *input,
6656 size_t input_len,
6657 uint8_t *output,
6658 size_t *output_len)
6659{
6660 psa_status_t status = PSA_SUCCESS;
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306661 if (input_len != PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC)) {
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306662 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Kusumit Ghoderao3fde8fe2023-06-27 10:41:43 +05306663 uint8_t zeros[16] = { 0 };
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306664 psa_set_key_type(&attributes, PSA_KEY_TYPE_AES);
6665 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(sizeof(zeros)));
6666 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306667 /* Passing PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC) as
Kusumit Ghoderao5f3345a2023-07-27 21:21:38 +05306668 * mac_size as the driver function sets mac_output_length = mac_size
6669 * on success. See https://github.com/Mbed-TLS/mbedtls/issues/7801 */
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306670 status = psa_driver_wrapper_mac_compute(&attributes,
6671 zeros, sizeof(zeros),
6672 PSA_ALG_CMAC, input, input_len,
6673 output,
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306674 PSA_MAC_LENGTH(PSA_KEY_TYPE_AES,
6675 128U,
6676 PSA_ALG_CMAC),
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306677 output_len);
6678 } else {
6679 memcpy(output, input, input_len);
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306680 *output_len = PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC);
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306681 }
6682 return status;
6683}
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05306684#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128 */
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306685
6686static psa_status_t psa_pbkdf2_set_password(psa_pbkdf2_key_derivation_t *pbkdf2,
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306687 psa_algorithm_t kdf_alg,
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306688 const uint8_t *data,
6689 size_t data_length)
6690{
Kusumit Ghoderaoaac9a582023-05-24 14:19:17 +05306691 psa_status_t status = PSA_SUCCESS;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306692 if (pbkdf2->state != PSA_PBKDF2_STATE_SALT_SET) {
6693 return PSA_ERROR_BAD_STATE;
6694 }
6695
Kusumit Ghoderaof3e696d2023-07-28 13:30:50 +05306696#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306697 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
6698 psa_algorithm_t hash_alg = PSA_ALG_PBKDF2_HMAC_GET_HASH(kdf_alg);
6699 status = psa_pbkdf2_hmac_set_password(hash_alg, data, data_length,
6700 pbkdf2->password,
6701 &pbkdf2->password_length);
Kusumit Ghoderaof3e696d2023-07-28 13:30:50 +05306702 } else
6703#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC */
6704#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128)
6705 if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306706 status = psa_pbkdf2_cmac_set_password(data, data_length,
6707 pbkdf2->password,
6708 &pbkdf2->password_length);
Kusumit Ghoderaof3e696d2023-07-28 13:30:50 +05306709 } else
6710#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128 */
6711 {
6712 return PSA_ERROR_INVALID_ARGUMENT;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306713 }
6714
6715 pbkdf2->state = PSA_PBKDF2_STATE_PASSWORD_SET;
6716
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306717 return status;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306718}
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05306719
6720static psa_status_t psa_pbkdf2_input(psa_pbkdf2_key_derivation_t *pbkdf2,
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306721 psa_algorithm_t kdf_alg,
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05306722 psa_key_derivation_step_t step,
6723 const uint8_t *data,
6724 size_t data_length)
6725{
6726 switch (step) {
6727 case PSA_KEY_DERIVATION_INPUT_SALT:
6728 return psa_pbkdf2_set_salt(pbkdf2, data, data_length);
6729 case PSA_KEY_DERIVATION_INPUT_PASSWORD:
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306730 return psa_pbkdf2_set_password(pbkdf2, kdf_alg, data, data_length);
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05306731 default:
6732 return PSA_ERROR_INVALID_ARGUMENT;
6733 }
6734}
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306735#endif /* PSA_HAVE_SOFT_PBKDF2 */
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306736
Gilles Peskineb8965192019-09-24 16:21:10 +02006737/** Check whether the given key type is acceptable for the given
6738 * input step of a key derivation.
6739 *
6740 * Secret inputs must have the type #PSA_KEY_TYPE_DERIVE.
6741 * Non-secret inputs must have the type #PSA_KEY_TYPE_RAW_DATA.
6742 * Both secret and non-secret inputs can alternatively have the type
6743 * #PSA_KEY_TYPE_NONE, which is never the type of a key object, meaning
6744 * that the input was passed as a buffer rather than via a key object.
6745 */
Gilles Peskine224b0d62019-09-23 18:13:17 +02006746static int psa_key_derivation_check_input_type(
6747 psa_key_derivation_step_t step,
Gilles Peskine449bd832023-01-11 14:50:10 +01006748 psa_key_type_t key_type)
Gilles Peskine224b0d62019-09-23 18:13:17 +02006749{
Gilles Peskine449bd832023-01-11 14:50:10 +01006750 switch (step) {
Gilles Peskine224b0d62019-09-23 18:13:17 +02006751 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006752 if (key_type == PSA_KEY_TYPE_DERIVE) {
6753 return PSA_SUCCESS;
6754 }
6755 if (key_type == PSA_KEY_TYPE_NONE) {
6756 return PSA_SUCCESS;
6757 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02006758 break;
Przemek Stekiela7695a22022-04-07 15:39:01 +02006759 case PSA_KEY_DERIVATION_INPUT_OTHER_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006760 if (key_type == PSA_KEY_TYPE_DERIVE) {
6761 return PSA_SUCCESS;
6762 }
6763 if (key_type == PSA_KEY_TYPE_NONE) {
6764 return PSA_SUCCESS;
6765 }
Przemek Stekiela7695a22022-04-07 15:39:01 +02006766 break;
Gilles Peskine224b0d62019-09-23 18:13:17 +02006767 case PSA_KEY_DERIVATION_INPUT_LABEL:
6768 case PSA_KEY_DERIVATION_INPUT_SALT:
6769 case PSA_KEY_DERIVATION_INPUT_INFO:
6770 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskine449bd832023-01-11 14:50:10 +01006771 if (key_type == PSA_KEY_TYPE_RAW_DATA) {
6772 return PSA_SUCCESS;
6773 }
6774 if (key_type == PSA_KEY_TYPE_NONE) {
6775 return PSA_SUCCESS;
6776 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02006777 break;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306778 case PSA_KEY_DERIVATION_INPUT_PASSWORD:
6779 if (key_type == PSA_KEY_TYPE_PASSWORD) {
6780 return PSA_SUCCESS;
6781 }
6782 if (key_type == PSA_KEY_TYPE_DERIVE) {
6783 return PSA_SUCCESS;
6784 }
6785 if (key_type == PSA_KEY_TYPE_NONE) {
6786 return PSA_SUCCESS;
6787 }
6788 break;
Gilles Peskine224b0d62019-09-23 18:13:17 +02006789 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006790 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine224b0d62019-09-23 18:13:17 +02006791}
6792
Janos Follathb80a94e2019-06-12 15:54:46 +01006793static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006794 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01006795 psa_key_derivation_step_t step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02006796 psa_key_type_t key_type,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01006797 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006798 size_t data_length)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006799{
Gilles Peskine46d7faf2019-09-23 19:22:55 +02006800 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006801 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
Gilles Peskine46d7faf2019-09-23 19:22:55 +02006802
Gilles Peskine449bd832023-01-11 14:50:10 +01006803 status = psa_key_derivation_check_input_type(step, key_type);
6804 if (status != PSA_SUCCESS) {
Gilles Peskine224b0d62019-09-23 18:13:17 +02006805 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006806 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02006807
Przemek Stekiel69c46792022-06-10 12:59:51 +02006808#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006809 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
6810 status = psa_hkdf_input(&operation->ctx.hkdf, kdf_alg,
6811 step, data, data_length);
6812 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02006813#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08006814#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006815 if (PSA_ALG_IS_TLS12_PRF(kdf_alg)) {
6816 status = psa_tls12_prf_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_PRF */
6820#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006821 if (PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
6822 status = psa_tls12_prf_psk_to_ms_input(&operation->ctx.tls12_prf,
6823 step, data, data_length);
6824 } else
John Durkop07cc04a2020-11-16 22:08:34 -08006825#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006826#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006827 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006828 status = psa_tls12_ecjpake_to_pms_input(
Gilles Peskine449bd832023-01-11 14:50:10 +01006829 &operation->ctx.tls12_ecjpake_to_pms, step, data, data_length);
6830 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006831#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306832#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05306833 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306834 status = psa_pbkdf2_input(&operation->ctx.pbkdf2, kdf_alg,
6835 step, data, data_length);
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05306836 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306837#endif /* PSA_HAVE_SOFT_PBKDF2 */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006838 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006839 /* This can't happen unless the operation object was not initialized */
Steven Cooreman74afe472021-02-10 17:19:22 +01006840 (void) data;
6841 (void) data_length;
6842 (void) kdf_alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01006843 return PSA_ERROR_BAD_STATE;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006844 }
6845
Gilles Peskine224b0d62019-09-23 18:13:17 +02006846exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01006847 if (status != PSA_SUCCESS) {
6848 psa_key_derivation_abort(operation);
6849 }
6850 return status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006851}
6852
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05306853static psa_status_t psa_key_derivation_input_integer_internal(
6854 psa_key_derivation_operation_t *operation,
6855 psa_key_derivation_step_t step,
6856 uint64_t value)
6857{
6858 psa_status_t status;
6859 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
6860
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306861#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05306862 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306863 status = psa_pbkdf2_set_input_cost(
6864 &operation->ctx.pbkdf2, step, value);
6865 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306866#endif /* PSA_HAVE_SOFT_PBKDF2 */
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05306867 {
Kusumit Ghoderao3a18dee2023-04-07 16:16:27 +05306868 (void) step;
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05306869 (void) value;
6870 (void) kdf_alg;
Kusumit Ghoderaoa14ae5a2023-04-19 14:16:26 +05306871 status = PSA_ERROR_INVALID_ARGUMENT;
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05306872 }
6873
6874 if (status != PSA_SUCCESS) {
6875 psa_key_derivation_abort(operation);
6876 }
6877 return status;
6878}
6879
Janos Follath51f4a0f2019-06-14 11:35:55 +01006880psa_status_t psa_key_derivation_input_bytes(
6881 psa_key_derivation_operation_t *operation,
6882 psa_key_derivation_step_t step,
6883 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006884 size_t data_length)
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01006885{
Gilles Peskine449bd832023-01-11 14:50:10 +01006886 return psa_key_derivation_input_internal(operation, step,
6887 PSA_KEY_TYPE_NONE,
6888 data, data_length);
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01006889}
6890
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05306891psa_status_t psa_key_derivation_input_integer(
6892 psa_key_derivation_operation_t *operation,
6893 psa_key_derivation_step_t step,
6894 uint64_t value)
6895{
6896 return psa_key_derivation_input_integer_internal(operation, step, value);
6897}
6898
Janos Follath51f4a0f2019-06-14 11:35:55 +01006899psa_status_t psa_key_derivation_input_key(
6900 psa_key_derivation_operation_t *operation,
6901 psa_key_derivation_step_t step,
Gilles Peskine449bd832023-01-11 14:50:10 +01006902 mbedtls_svc_key_id_t key)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006903{
Ronald Cronf95a2b12020-10-22 15:24:49 +02006904 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01006905 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006906 psa_key_slot_t *slot;
Gilles Peskine178c9aa2019-09-24 18:21:06 +02006907
Ronald Cron5c522922020-11-14 16:35:34 +01006908 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01006909 key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg);
6910 if (status != PSA_SUCCESS) {
6911 psa_key_derivation_abort(operation);
6912 return status;
Gilles Peskine593773d2019-09-23 18:17:40 +02006913 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02006914
Kusumit Ghoderao3128c5d2023-05-03 12:27:57 +05306915 /* Passing a key object as a SECRET or PASSWORD input unlocks the
6916 * permission to output to a key object. */
6917 if (step == PSA_KEY_DERIVATION_INPUT_SECRET ||
6918 step == PSA_KEY_DERIVATION_INPUT_PASSWORD) {
Gilles Peskine178c9aa2019-09-24 18:21:06 +02006919 operation->can_output_key = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01006920 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02006921
Gilles Peskine449bd832023-01-11 14:50:10 +01006922 status = psa_key_derivation_input_internal(operation,
6923 step, slot->attr.type,
6924 slot->key.data,
6925 slot->key.bytes);
Ronald Cronf95a2b12020-10-22 15:24:49 +02006926
Ryan Everett1b70a072024-01-04 10:32:49 +00006927 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02006928
Gilles Peskine449bd832023-01-11 14:50:10 +01006929 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006930}
Gilles Peskineea0fb492018-07-12 17:17:20 +02006931
6932
6933
6934/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02006935/* Key agreement */
6936/****************************************************************/
6937
Gilles Peskine449bd832023-01-11 14:50:10 +01006938psa_status_t psa_key_agreement_raw_builtin(const psa_key_attributes_t *attributes,
6939 const uint8_t *key_buffer,
6940 size_t key_buffer_size,
6941 psa_algorithm_t alg,
6942 const uint8_t *peer_key,
6943 size_t peer_key_length,
6944 uint8_t *shared_secret,
6945 size_t shared_secret_size,
6946 size_t *shared_secret_length)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02006947{
Gilles Peskine449bd832023-01-11 14:50:10 +01006948 switch (alg) {
John Durkop6ba40d12020-11-10 08:50:04 -08006949#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskine0216fe12019-04-11 21:23:21 +02006950 case PSA_ALG_ECDH:
Gilles Peskine449bd832023-01-11 14:50:10 +01006951 return mbedtls_psa_key_agreement_ecdh(attributes, key_buffer,
6952 key_buffer_size, alg,
6953 peer_key, peer_key_length,
6954 shared_secret,
6955 shared_secret_size,
6956 shared_secret_length);
Gilles Peskine01d718c2018-09-18 12:01:02 +02006957#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Przemek Stekielfb3dd542022-12-01 14:59:15 +01006958
6959#if defined(MBEDTLS_PSA_BUILTIN_ALG_FFDH)
6960 case PSA_ALG_FFDH:
Przemek Stekiel152bb462023-06-01 11:52:39 +02006961 return mbedtls_psa_ffdh_key_agreement(attributes,
Przemek Stekiel359f4622022-12-05 14:11:55 +01006962 peer_key,
6963 peer_key_length,
6964 key_buffer,
6965 key_buffer_size,
6966 shared_secret,
6967 shared_secret_size,
6968 shared_secret_length);
Przemek Stekielfb3dd542022-12-01 14:59:15 +01006969#endif /* MBEDTLS_PSA_BUILTIN_ALG_FFDH */
6970
Gilles Peskine01d718c2018-09-18 12:01:02 +02006971 default:
Aditya Deshpande17845b82022-10-13 17:21:01 +01006972 (void) attributes;
6973 (void) key_buffer;
6974 (void) key_buffer_size;
Gilles Peskine93f85002018-11-16 16:43:31 +01006975 (void) peer_key;
6976 (void) peer_key_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02006977 (void) shared_secret;
6978 (void) shared_secret_size;
6979 (void) shared_secret_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01006980 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine01d718c2018-09-18 12:01:02 +02006981 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02006982}
Gilles Peskine01d718c2018-09-18 12:01:02 +02006983
Aditya Deshpande17845b82022-10-13 17:21:01 +01006984/** Internal function for raw key agreement
6985 * Calls the driver wrapper which will hand off key agreement task
Aditya Deshpande40c05cc2022-10-14 16:41:40 +01006986 * to the driver's implementation if a driver is present.
6987 * Fallback specified in the driver wrapper is built-in raw key agreement
Aditya Deshpande17845b82022-10-13 17:21:01 +01006988 * (psa_key_agreement_raw_builtin).
6989 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006990static psa_status_t psa_key_agreement_raw_internal(psa_algorithm_t alg,
6991 psa_key_slot_t *private_key,
6992 const uint8_t *peer_key,
6993 size_t peer_key_length,
6994 uint8_t *shared_secret,
6995 size_t shared_secret_size,
6996 size_t *shared_secret_length)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006997{
Gilles Peskine449bd832023-01-11 14:50:10 +01006998 if (!PSA_ALG_IS_RAW_KEY_AGREEMENT(alg)) {
6999 return PSA_ERROR_NOT_SUPPORTED;
7000 }
Aditya Deshpande17845b82022-10-13 17:21:01 +01007001
7002 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01007003 .core = private_key->attr
Aditya Deshpande17845b82022-10-13 17:21:01 +01007004 };
7005
Gilles Peskine449bd832023-01-11 14:50:10 +01007006 return psa_driver_wrapper_key_agreement(&attributes,
7007 private_key->key.data,
7008 private_key->key.bytes, alg,
7009 peer_key, peer_key_length,
7010 shared_secret,
7011 shared_secret_size,
7012 shared_secret_length);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007013}
7014
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02007015/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine01d718c2018-09-18 12:01:02 +02007016 * to potentially free embedded data structures and wipe confidential data.
7017 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007018static psa_status_t psa_key_agreement_internal(psa_key_derivation_operation_t *operation,
7019 psa_key_derivation_step_t step,
7020 psa_key_slot_t *private_key,
7021 const uint8_t *peer_key,
7022 size_t peer_key_length)
Gilles Peskine01d718c2018-09-18 12:01:02 +02007023{
7024 psa_status_t status;
Aditya Deshpande2f7fd762022-11-22 11:10:34 +00007025 uint8_t shared_secret[PSA_RAW_KEY_AGREEMENT_OUTPUT_MAX_SIZE];
Gilles Peskine01d718c2018-09-18 12:01:02 +02007026 size_t shared_secret_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007027 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE(operation->alg);
Gilles Peskine01d718c2018-09-18 12:01:02 +02007028
7029 /* Step 1: run the secret agreement algorithm to generate the shared
7030 * secret. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007031 status = psa_key_agreement_raw_internal(ka_alg,
7032 private_key,
7033 peer_key, peer_key_length,
7034 shared_secret,
7035 sizeof(shared_secret),
7036 &shared_secret_length);
7037 if (status != PSA_SUCCESS) {
Gilles Peskine12313cd2018-06-20 00:20:32 +02007038 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007039 }
Gilles Peskine12313cd2018-06-20 00:20:32 +02007040
Gilles Peskineb0b255c2018-07-06 17:01:38 +02007041 /* Step 2: set up the key derivation to generate key material from
Gilles Peskine224b0d62019-09-23 18:13:17 +02007042 * the shared secret. A shared secret is permitted wherever a key
7043 * of type DERIVE is permitted. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007044 status = psa_key_derivation_input_internal(operation, step,
7045 PSA_KEY_TYPE_DERIVE,
7046 shared_secret,
7047 shared_secret_length);
Gilles Peskine12313cd2018-06-20 00:20:32 +02007048exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007049 mbedtls_platform_zeroize(shared_secret, shared_secret_length);
7050 return status;
Gilles Peskine12313cd2018-06-20 00:20:32 +02007051}
7052
Gilles Peskine449bd832023-01-11 14:50:10 +01007053psa_status_t psa_key_derivation_key_agreement(psa_key_derivation_operation_t *operation,
7054 psa_key_derivation_step_t step,
7055 mbedtls_svc_key_id_t private_key,
7056 const uint8_t *peer_key,
7057 size_t peer_key_length)
Gilles Peskine12313cd2018-06-20 00:20:32 +02007058{
Ronald Cronf95a2b12020-10-22 15:24:49 +02007059 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01007060 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01007061 psa_key_slot_t *slot;
Ronald Cronf95a2b12020-10-22 15:24:49 +02007062
Gilles Peskine449bd832023-01-11 14:50:10 +01007063 if (!PSA_ALG_IS_KEY_AGREEMENT(operation->alg)) {
7064 return PSA_ERROR_INVALID_ARGUMENT;
7065 }
Ronald Cron5c522922020-11-14 16:35:34 +01007066 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01007067 private_key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg);
7068 if (status != PSA_SUCCESS) {
7069 return status;
7070 }
7071 status = psa_key_agreement_internal(operation, step,
7072 slot,
7073 peer_key, peer_key_length);
7074 if (status != PSA_SUCCESS) {
7075 psa_key_derivation_abort(operation);
7076 } else {
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007077 /* If a private key has been added as SECRET, we allow the derived
7078 * key material to be used as a key in PSA Crypto. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007079 if (step == PSA_KEY_DERIVATION_INPUT_SECRET) {
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007080 operation->can_output_key = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01007081 }
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007082 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007083
Ryan Everett1b70a072024-01-04 10:32:49 +00007084 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007085
Gilles Peskine449bd832023-01-11 14:50:10 +01007086 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskineaf3baab2018-06-27 22:55:52 +02007087}
7088
Gilles Peskine449bd832023-01-11 14:50:10 +01007089psa_status_t psa_raw_key_agreement(psa_algorithm_t alg,
7090 mbedtls_svc_key_id_t private_key,
7091 const uint8_t *peer_key,
7092 size_t peer_key_length,
7093 uint8_t *output,
7094 size_t output_size,
7095 size_t *output_length)
Gilles Peskine0216fe12019-04-11 21:23:21 +02007096{
Ronald Cronf95a2b12020-10-22 15:24:49 +02007097 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01007098 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +02007099 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007100 size_t expected_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02007101
Gilles Peskine449bd832023-01-11 14:50:10 +01007102 if (!PSA_ALG_IS_KEY_AGREEMENT(alg)) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007103 status = PSA_ERROR_INVALID_ARGUMENT;
7104 goto exit;
7105 }
Ronald Cron5c522922020-11-14 16:35:34 +01007106 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01007107 private_key, &slot, PSA_KEY_USAGE_DERIVE, alg);
7108 if (status != PSA_SUCCESS) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007109 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007110 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02007111
Gilles Peskine3e561302022-04-14 00:17:15 +02007112 /* PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() is in general an upper bound
7113 * for the output size. The PSA specification only guarantees that this
7114 * function works if output_size >= PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE(...),
7115 * but it might be nice to allow smaller buffers if the output fits.
7116 * At the time of writing this comment, with only ECDH implemented,
7117 * PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() is exact so the point is moot.
7118 * If FFDH is implemented, PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() can easily
7119 * be exact for it as well. */
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007120 expected_length =
Gilles Peskine449bd832023-01-11 14:50:10 +01007121 PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE(slot->attr.type, slot->attr.bits);
7122 if (output_size < expected_length) {
Gilles Peskine3e561302022-04-14 00:17:15 +02007123 status = PSA_ERROR_BUFFER_TOO_SMALL;
7124 goto exit;
7125 }
7126
Gilles Peskine449bd832023-01-11 14:50:10 +01007127 status = psa_key_agreement_raw_internal(alg, slot,
7128 peer_key, peer_key_length,
7129 output, output_size,
7130 output_length);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007131
7132exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007133 if (status != PSA_SUCCESS) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007134 /* If an error happens and is not handled properly, the output
7135 * may be used as a key to protect sensitive data. Arrange for such
7136 * a key to be random, which is likely to result in decryption or
7137 * verification errors. This is better than filling the buffer with
7138 * some constant data such as zeros, which would result in the data
7139 * being protected with a reproducible, easily knowable key.
7140 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007141 psa_generate_random(output, output_size);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007142 *output_length = output_size;
7143 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007144
Ryan Everett1b70a072024-01-04 10:32:49 +00007145 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007146
Gilles Peskine449bd832023-01-11 14:50:10 +01007147 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine0216fe12019-04-11 21:23:21 +02007148}
Gilles Peskine86a440b2018-11-12 18:39:40 +01007149
7150
Gilles Peskine30524eb2020-11-13 17:02:26 +01007151
Gilles Peskine86a440b2018-11-12 18:39:40 +01007152/****************************************************************/
7153/* Random generation */
Gilles Peskine53d991e2018-07-12 01:14:59 +02007154/****************************************************************/
Gilles Peskine12313cd2018-06-20 00:20:32 +02007155
Gilles Peskine672a7712023-04-28 21:00:28 +02007156#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
7157#include "entropy_poll.h"
7158#endif
7159
Gilles Peskine30524eb2020-11-13 17:02:26 +01007160/** Initialize the PSA random generator.
7161 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007162static void mbedtls_psa_random_init(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01007163{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007164#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine449bd832023-01-11 14:50:10 +01007165 memset(rng, 0, sizeof(*rng));
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007166#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
7167
Gilles Peskine30524eb2020-11-13 17:02:26 +01007168 /* Set default configuration if
7169 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007170 if (rng->entropy_init == NULL) {
Gilles Peskine30524eb2020-11-13 17:02:26 +01007171 rng->entropy_init = mbedtls_entropy_init;
Gilles Peskine449bd832023-01-11 14:50:10 +01007172 }
7173 if (rng->entropy_free == NULL) {
Gilles Peskine30524eb2020-11-13 17:02:26 +01007174 rng->entropy_free = mbedtls_entropy_free;
Gilles Peskine449bd832023-01-11 14:50:10 +01007175 }
Gilles Peskine30524eb2020-11-13 17:02:26 +01007176
Gilles Peskine449bd832023-01-11 14:50:10 +01007177 rng->entropy_init(&rng->entropy);
Gilles Peskine30524eb2020-11-13 17:02:26 +01007178#if defined(MBEDTLS_PSA_INJECT_ENTROPY) && \
7179 defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
7180 /* The PSA entropy injection feature depends on using NV seed as an entropy
7181 * source. Add NV seed as an entropy source for PSA entropy injection. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007182 mbedtls_entropy_add_source(&rng->entropy,
7183 mbedtls_nv_seed_poll, NULL,
7184 MBEDTLS_ENTROPY_BLOCK_SIZE,
7185 MBEDTLS_ENTROPY_SOURCE_STRONG);
Gilles Peskine30524eb2020-11-13 17:02:26 +01007186#endif
7187
Gilles Peskine449bd832023-01-11 14:50:10 +01007188 mbedtls_psa_drbg_init(MBEDTLS_PSA_RANDOM_STATE);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007189#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007190}
7191
7192/** Deinitialize the PSA random generator.
7193 */
Valerio Setti83e0de82023-11-24 12:13:05 +01007194static void mbedtls_psa_random_free(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01007195{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007196#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Valerio Setti83e0de82023-11-24 12:13:05 +01007197 memset(rng, 0, sizeof(*rng));
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007198#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Valerio Setti83e0de82023-11-24 12:13:05 +01007199 mbedtls_psa_drbg_free(MBEDTLS_PSA_RANDOM_STATE);
7200 rng->entropy_free(&rng->entropy);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007201#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007202}
7203
7204/** Seed the PSA random generator.
7205 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007206static psa_status_t mbedtls_psa_random_seed(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01007207{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007208#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
7209 /* Do nothing: the external RNG seeds itself. */
7210 (void) rng;
Gilles Peskine449bd832023-01-11 14:50:10 +01007211 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007212#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007213 const unsigned char drbg_seed[] = "PSA";
Gilles Peskine449bd832023-01-11 14:50:10 +01007214 int ret = mbedtls_psa_drbg_seed(&rng->entropy,
7215 drbg_seed, sizeof(drbg_seed) - 1);
7216 return mbedtls_to_psa_error(ret);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007217#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007218}
7219
Gilles Peskine449bd832023-01-11 14:50:10 +01007220psa_status_t psa_generate_random(uint8_t *output,
7221 size_t output_size)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007222{
Gilles Peskinee59236f2018-01-27 23:32:46 +01007223 GUARD_MODULE_INITIALIZED;
7224
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007225#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
7226
7227 size_t output_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007228 psa_status_t status = mbedtls_psa_external_get_random(&global_data.rng,
7229 output, output_size,
7230 &output_length);
7231 if (status != PSA_SUCCESS) {
7232 return status;
7233 }
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007234 /* Breaking up a request into smaller chunks is currently not supported
Tom Cosgrove1797b052022-12-04 17:19:59 +00007235 * for the external RNG interface. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007236 if (output_length != output_size) {
7237 return PSA_ERROR_INSUFFICIENT_ENTROPY;
7238 }
7239 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007240
7241#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
7242
Gilles Peskine449bd832023-01-11 14:50:10 +01007243 while (output_size > 0) {
Gilles Peskine71ddab92021-01-04 21:01:07 +01007244 size_t request_size =
Gilles Peskine449bd832023-01-11 14:50:10 +01007245 (output_size > MBEDTLS_PSA_RANDOM_MAX_REQUEST ?
7246 MBEDTLS_PSA_RANDOM_MAX_REQUEST :
7247 output_size);
7248 int ret = mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE,
7249 output, request_size);
7250 if (ret != 0) {
7251 return mbedtls_to_psa_error(ret);
7252 }
Gilles Peskine71ddab92021-01-04 21:01:07 +01007253 output_size -= request_size;
7254 output += request_size;
Gilles Peskinef181eca2019-08-07 13:49:00 +02007255 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007256 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007257#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskinee59236f2018-01-27 23:32:46 +01007258}
7259
Gilles Peskine8814fc42020-12-14 15:33:44 +01007260/* Wrapper function allowing the classic API to use the PSA RNG.
Gilles Peskine9c3e0602021-01-05 16:03:55 +01007261 *
7262 * `mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE, ...)` calls
7263 * `psa_generate_random(...)`. The state parameter is ignored since the
7264 * PSA API doesn't support passing an explicit state.
7265 *
7266 * In the non-external case, psa_generate_random() calls an
7267 * `mbedtls_xxx_drbg_random` function which has exactly the same signature
7268 * and semantics as mbedtls_psa_get_random(). As an optimization,
7269 * instead of doing this back-and-forth between the PSA API and the
7270 * classic API, psa_crypto_random_impl.h defines `mbedtls_psa_get_random`
7271 * as a constant function pointer to `mbedtls_xxx_drbg_random`.
Gilles Peskine8814fc42020-12-14 15:33:44 +01007272 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007273#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
7274int mbedtls_psa_get_random(void *p_rng,
7275 unsigned char *output,
7276 size_t output_size)
Gilles Peskine8814fc42020-12-14 15:33:44 +01007277{
Gilles Peskine9c3e0602021-01-05 16:03:55 +01007278 /* This function takes a pointer to the RNG state because that's what
7279 * classic mbedtls functions using an RNG expect. The PSA RNG manages
7280 * its own state internally and doesn't let the caller access that state.
7281 * So we just ignore the state parameter, and in practice we'll pass
7282 * NULL. */
Gilles Peskine8814fc42020-12-14 15:33:44 +01007283 (void) p_rng;
Gilles Peskine449bd832023-01-11 14:50:10 +01007284 psa_status_t status = psa_generate_random(output, output_size);
7285 if (status == PSA_SUCCESS) {
7286 return 0;
7287 } else {
7288 return MBEDTLS_ERR_ENTROPY_SOURCE_FAILED;
7289 }
Gilles Peskine8814fc42020-12-14 15:33:44 +01007290}
7291#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
7292
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01007293#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
Gilles Peskine449bd832023-01-11 14:50:10 +01007294psa_status_t mbedtls_psa_inject_entropy(const uint8_t *seed,
7295 size_t seed_size)
Netanel Gonen2bcd3122018-11-19 11:53:02 +02007296{
Gilles Peskine449bd832023-01-11 14:50:10 +01007297 if (global_data.initialized) {
7298 return PSA_ERROR_NOT_PERMITTED;
7299 }
Netanel Gonen21f37cb2018-11-19 11:53:55 +02007300
Gilles Peskine449bd832023-01-11 14:50:10 +01007301 if (((seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM) ||
7302 (seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE)) ||
7303 (seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE)) {
7304 return PSA_ERROR_INVALID_ARGUMENT;
7305 }
Netanel Gonen21f37cb2018-11-19 11:53:55 +02007306
Gilles Peskine449bd832023-01-11 14:50:10 +01007307 return mbedtls_psa_storage_inject_entropy(seed, seed_size);
Netanel Gonen2bcd3122018-11-19 11:53:02 +02007308}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01007309#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02007310
Ronald Cron3772afe2021-02-08 16:10:05 +01007311/** Validate the key type and size for key generation
Ronald Cron01b2aba2020-10-05 09:42:02 +02007312 *
Ronald Cron3772afe2021-02-08 16:10:05 +01007313 * \param type The key type
7314 * \param bits The number of bits of the key
Ronald Cron01b2aba2020-10-05 09:42:02 +02007315 *
7316 * \retval #PSA_SUCCESS
Ronald Cron3772afe2021-02-08 16:10:05 +01007317 * The key type and size are valid.
Ronald Cron01b2aba2020-10-05 09:42:02 +02007318 * \retval #PSA_ERROR_INVALID_ARGUMENT
7319 * The size in bits of the key is not valid.
7320 * \retval #PSA_ERROR_NOT_SUPPORTED
7321 * The type and/or the size in bits of the key or the combination of
7322 * the two is not supported.
7323 */
Ronald Cron3772afe2021-02-08 16:10:05 +01007324static psa_status_t psa_validate_key_type_and_size_for_key_generation(
Gilles Peskine449bd832023-01-11 14:50:10 +01007325 psa_key_type_t type, size_t bits)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007326{
Ronald Cronf3bb7612020-10-02 20:11:59 +02007327 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007328
Gilles Peskine449bd832023-01-11 14:50:10 +01007329 if (key_type_is_raw_bytes(type)) {
7330 status = psa_validate_unstructured_key_bit_size(type, bits);
7331 if (status != PSA_SUCCESS) {
7332 return status;
7333 }
7334 } else
Valerio Settif6d4dfb2023-07-10 10:55:12 +02007335#if defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007336 if (PSA_KEY_TYPE_IS_RSA(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
7337 if (bits > PSA_VENDOR_RSA_MAX_KEY_BITS) {
7338 return PSA_ERROR_NOT_SUPPORTED;
7339 }
Waleed Elmelegyd7bdbbe2023-07-20 16:26:58 +00007340 if (bits < PSA_VENDOR_RSA_GENERATE_MIN_KEY_BITS) {
Waleed Elmelegyab570712023-07-05 16:40:58 +00007341 return PSA_ERROR_NOT_SUPPORTED;
7342 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +02007343
Ronald Cron01b2aba2020-10-05 09:42:02 +02007344 /* Accept only byte-aligned keys, for the same reasons as
7345 * in psa_import_rsa_key(). */
Gilles Peskine449bd832023-01-11 14:50:10 +01007346 if (bits % 8 != 0) {
7347 return PSA_ERROR_NOT_SUPPORTED;
7348 }
7349 } else
Valerio Settif6d4dfb2023-07-10 10:55:12 +02007350#endif /* defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02007351
Valerio Setti6a9d0ee2023-06-21 10:07:21 +02007352#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007353 if (PSA_KEY_TYPE_IS_ECC(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
Ronald Crond81ab562021-02-16 09:01:16 +01007354 /* To avoid empty block, return successfully here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007355 return PSA_SUCCESS;
7356 } else
Valerio Setti6a9d0ee2023-06-21 10:07:21 +02007357#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_GENERATE) */
Przemek Stekielfedd1342022-12-01 15:00:02 +01007358
Valerio Settia55f0422023-07-10 15:34:41 +02007359#if defined(PSA_WANT_KEY_TYPE_DH_KEY_PAIR_GENERATE)
Przemek Stekielfedd1342022-12-01 15:00:02 +01007360 if (PSA_KEY_TYPE_IS_DH(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
Przemek Stekield1cf1ba2023-04-27 12:04:21 +02007361 if (psa_is_dh_key_size_valid(bits) == 0) {
Przemek Stekielfedd1342022-12-01 15:00:02 +01007362 return PSA_ERROR_NOT_SUPPORTED;
7363 }
7364 } else
Valerio Settia55f0422023-07-10 15:34:41 +02007365#endif /* defined(PSA_WANT_KEY_TYPE_DH_KEY_PAIR_GENERATE) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02007366 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007367 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007368 }
7369
Gilles Peskine449bd832023-01-11 14:50:10 +01007370 return PSA_SUCCESS;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007371}
7372
Ronald Cron55ed0592020-10-05 10:30:40 +02007373psa_status_t psa_generate_key_internal(
Ronald Cron2a38a6b2020-10-02 20:02:04 +02007374 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01007375 uint8_t *key_buffer, size_t key_buffer_size, size_t *key_buffer_length)
Ronald Cron01b2aba2020-10-05 09:42:02 +02007376{
7377 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2a38a6b2020-10-02 20:02:04 +02007378 psa_key_type_t type = attributes->core.type;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007379
Gilles Peskine449bd832023-01-11 14:50:10 +01007380 if ((attributes->domain_parameters == NULL) &&
7381 (attributes->domain_parameters_size != 0)) {
7382 return PSA_ERROR_INVALID_ARGUMENT;
7383 }
Ronald Cron01b2aba2020-10-05 09:42:02 +02007384
Gilles Peskine449bd832023-01-11 14:50:10 +01007385 if (key_type_is_raw_bytes(type)) {
7386 status = psa_generate_random(key_buffer, key_buffer_size);
7387 if (status != PSA_SUCCESS) {
7388 return status;
7389 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +02007390
David Brown12ca5032021-02-11 11:02:00 -07007391#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01007392 if (type == PSA_KEY_TYPE_DES) {
7393 psa_des_set_key_parity(key_buffer, key_buffer_size);
7394 }
David Brown8107e312021-02-12 08:08:46 -07007395#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine449bd832023-01-11 14:50:10 +01007396 } else
Gilles Peskinee59236f2018-01-27 23:32:46 +01007397
Valerio Setti76df8c12023-07-11 14:11:28 +02007398#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007399 if (type == PSA_KEY_TYPE_RSA_KEY_PAIR) {
7400 return mbedtls_psa_rsa_generate_key(attributes,
7401 key_buffer,
7402 key_buffer_size,
7403 key_buffer_length);
7404 } else
Valerio Setti76df8c12023-07-11 14:11:28 +02007405#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_GENERATE) */
Gilles Peskinee59236f2018-01-27 23:32:46 +01007406
Valerio Settibfeaf5b2023-06-20 13:27:46 +02007407#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007408 if (PSA_KEY_TYPE_IS_ECC(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
7409 return mbedtls_psa_ecp_generate_key(attributes,
7410 key_buffer,
7411 key_buffer_size,
7412 key_buffer_length);
7413 } else
Valerio Settibfeaf5b2023-06-20 13:27:46 +02007414#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_GENERATE) */
Przemek Stekielfedd1342022-12-01 15:00:02 +01007415
Valerio Settia55f0422023-07-10 15:34:41 +02007416#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_GENERATE)
Przemek Stekielfedd1342022-12-01 15:00:02 +01007417 if (PSA_KEY_TYPE_IS_DH(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
7418 return mbedtls_psa_ffdh_generate_key(attributes,
7419 key_buffer,
7420 key_buffer_size,
7421 key_buffer_length);
7422 } else
Valerio Settia55f0422023-07-10 15:34:41 +02007423#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_GENERATE) */
Steven Cooreman29149862020-08-05 15:43:42 +02007424 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007425 (void) key_buffer_length;
7426 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman29149862020-08-05 15:43:42 +02007427 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01007428
Gilles Peskine449bd832023-01-11 14:50:10 +01007429 return PSA_SUCCESS;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02007430}
Darryl Green0c6575a2018-11-07 16:05:30 +00007431
Gilles Peskine449bd832023-01-11 14:50:10 +01007432psa_status_t psa_generate_key(const psa_key_attributes_t *attributes,
7433 mbedtls_svc_key_id_t *key)
Gilles Peskineff5f0e72019-04-18 12:53:30 +02007434{
7435 psa_status_t status;
7436 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02007437 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cron2b56bc82020-10-05 10:02:26 +02007438 size_t key_buffer_size;
Gilles Peskine11792082019-08-06 18:36:36 +02007439
Ronald Cron81709fc2020-11-14 12:10:32 +01007440 *key = MBEDTLS_SVC_KEY_ID_INIT;
7441
Gilles Peskine0f84d622019-09-12 19:03:13 +02007442 /* Reject any attempt to create a zero-length key so that we don't
7443 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007444 if (psa_get_key_bits(attributes) == 0) {
7445 return PSA_ERROR_INVALID_ARGUMENT;
7446 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02007447
Przemyslaw Stekielc0fe8202021-10-07 11:08:56 +02007448 /* Reject any attempt to create a public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007449 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(attributes->core.type)) {
7450 return PSA_ERROR_INVALID_ARGUMENT;
7451 }
Przemyslaw Stekielc0fe8202021-10-07 11:08:56 +02007452
Gilles Peskine449bd832023-01-11 14:50:10 +01007453 status = psa_start_key_creation(PSA_KEY_CREATION_GENERATE, attributes,
7454 &slot, &driver);
7455 if (status != PSA_SUCCESS) {
Gilles Peskine11792082019-08-06 18:36:36 +02007456 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007457 }
Gilles Peskine11792082019-08-06 18:36:36 +02007458
Ronald Cron977c2472020-10-13 08:32:21 +02007459 /* In the case of a transparent key or an opaque key stored in local
Archana449608b2021-09-08 15:36:05 +05307460 * storage ( thus not in the case of generating a key in a secure element
7461 * with storage ( MBEDTLS_PSA_CRYPTO_SE_C ) ),we have to allocate a
7462 * buffer to hold the generated key material. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007463 if (slot->key.data == NULL) {
7464 if (PSA_KEY_LIFETIME_GET_LOCATION(attributes->core.lifetime) ==
7465 PSA_KEY_LOCATION_LOCAL_STORAGE) {
Ronald Cron3772afe2021-02-08 16:10:05 +01007466 status = psa_validate_key_type_and_size_for_key_generation(
Gilles Peskine449bd832023-01-11 14:50:10 +01007467 attributes->core.type, attributes->core.bits);
7468 if (status != PSA_SUCCESS) {
Ronald Cron3772afe2021-02-08 16:10:05 +01007469 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007470 }
Ronald Cron3772afe2021-02-08 16:10:05 +01007471
7472 key_buffer_size = PSA_EXPORT_KEY_OUTPUT_SIZE(
Gilles Peskine449bd832023-01-11 14:50:10 +01007473 attributes->core.type,
7474 attributes->core.bits);
7475 } else {
Ronald Cron977c2472020-10-13 08:32:21 +02007476 status = psa_driver_wrapper_get_key_buffer_size(
Gilles Peskine449bd832023-01-11 14:50:10 +01007477 attributes, &key_buffer_size);
7478 if (status != PSA_SUCCESS) {
Ronald Cron3772afe2021-02-08 16:10:05 +01007479 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007480 }
Ronald Cron977c2472020-10-13 08:32:21 +02007481 }
Ronald Cron977c2472020-10-13 08:32:21 +02007482
Gilles Peskine449bd832023-01-11 14:50:10 +01007483 status = psa_allocate_buffer_to_slot(slot, key_buffer_size);
7484 if (status != PSA_SUCCESS) {
Ronald Cron977c2472020-10-13 08:32:21 +02007485 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007486 }
Ronald Cron977c2472020-10-13 08:32:21 +02007487 }
7488
Gilles Peskine449bd832023-01-11 14:50:10 +01007489 status = psa_driver_wrapper_generate_key(attributes,
7490 slot->key.data, slot->key.bytes, &slot->key.bytes);
Gilles Peskine11792082019-08-06 18:36:36 +02007491
Gilles Peskine449bd832023-01-11 14:50:10 +01007492 if (status != PSA_SUCCESS) {
7493 psa_remove_key_data_from_memory(slot);
7494 }
Ronald Cron2b56bc82020-10-05 10:02:26 +02007495
Gilles Peskine11792082019-08-06 18:36:36 +02007496exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007497 if (status == PSA_SUCCESS) {
7498 status = psa_finish_key_creation(slot, driver, key);
7499 }
7500 if (status != PSA_SUCCESS) {
7501 psa_fail_key_creation(slot, driver);
7502 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007503
Gilles Peskine449bd832023-01-11 14:50:10 +01007504 return status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007505}
7506
Gilles Peskinee59236f2018-01-27 23:32:46 +01007507/****************************************************************/
7508/* Module setup */
7509/****************************************************************/
7510
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007511#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine5e769522018-11-20 21:59:56 +01007512psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
Gilles Peskine449bd832023-01-11 14:50:10 +01007513 void (* entropy_init)(mbedtls_entropy_context *ctx),
7514 void (* entropy_free)(mbedtls_entropy_context *ctx))
Gilles Peskine5e769522018-11-20 21:59:56 +01007515{
Gilles Peskine449bd832023-01-11 14:50:10 +01007516 if (global_data.rng_state != RNG_NOT_INITIALIZED) {
7517 return PSA_ERROR_BAD_STATE;
7518 }
Gilles Peskine30524eb2020-11-13 17:02:26 +01007519 global_data.rng.entropy_init = entropy_init;
7520 global_data.rng.entropy_free = entropy_free;
Gilles Peskine449bd832023-01-11 14:50:10 +01007521 return PSA_SUCCESS;
Gilles Peskine5e769522018-11-20 21:59:56 +01007522}
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007523#endif /* !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) */
Gilles Peskine5e769522018-11-20 21:59:56 +01007524
Gilles Peskine449bd832023-01-11 14:50:10 +01007525void mbedtls_psa_crypto_free(void)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007526{
Gilles Peskine449bd832023-01-11 14:50:10 +01007527 psa_wipe_all_key_slots();
Valerio Setti83e0de82023-11-24 12:13:05 +01007528 if (global_data.rng_state != RNG_NOT_INITIALIZED) {
7529 mbedtls_psa_random_free(&global_data.rng);
7530 }
Gilles Peskinec6b69072018-11-20 21:42:52 +01007531 /* Wipe all remaining data, including configuration.
7532 * In particular, this sets all state indicator to the value
7533 * indicating "uninitialized". */
Gilles Peskine449bd832023-01-11 14:50:10 +01007534 mbedtls_platform_zeroize(&global_data, sizeof(global_data));
Ronald Cron9ba76912021-04-10 16:57:30 +02007535
7536 /* Terminate drivers */
Gilles Peskine449bd832023-01-11 14:50:10 +01007537 psa_driver_wrapper_free();
Gilles Peskinee59236f2018-01-27 23:32:46 +01007538}
7539
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007540#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
7541/** Recover a transaction that was interrupted by a power failure.
7542 *
7543 * This function is called during initialization, before psa_crypto_init()
7544 * returns. If this function returns a failure status, the initialization
7545 * fails.
7546 */
7547static psa_status_t psa_crypto_recover_transaction(
Gilles Peskine449bd832023-01-11 14:50:10 +01007548 const psa_crypto_transaction_t *transaction)
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007549{
Gilles Peskine449bd832023-01-11 14:50:10 +01007550 switch (transaction->unknown.type) {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007551 case PSA_CRYPTO_TRANSACTION_CREATE_KEY:
7552 case PSA_CRYPTO_TRANSACTION_DESTROY_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01007553 /* TODO - fall through to the failure case until this
7554 * is implemented.
7555 * https://github.com/ARMmbed/mbed-crypto/issues/218
7556 */
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007557 default:
7558 /* We found an unsupported transaction in the storage.
7559 * We don't know what state the storage is in. Give up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007560 return PSA_ERROR_DATA_INVALID;
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007561 }
7562}
7563#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
7564
Gilles Peskine449bd832023-01-11 14:50:10 +01007565psa_status_t psa_crypto_init(void)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007566{
Gilles Peskine66fb1262018-12-10 16:29:04 +01007567 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007568
Gilles Peskinec6b69072018-11-20 21:42:52 +01007569 /* Double initialization is explicitly allowed. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007570 if (global_data.initialized != 0) {
7571 return PSA_SUCCESS;
7572 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01007573
Manuel Pégourié-Gonnard7abdf7e2023-03-09 11:17:43 +01007574 /* Init drivers */
7575 status = psa_driver_wrapper_init();
7576 if (status != PSA_SUCCESS) {
7577 goto exit;
7578 }
7579 global_data.drivers_initialized = 1;
7580
Valerio Setti402cfba2023-11-13 10:24:32 +01007581 status = psa_initialize_key_slots();
7582 if (status != PSA_SUCCESS) {
7583 goto exit;
7584 }
7585
Gilles Peskine30524eb2020-11-13 17:02:26 +01007586 /* Initialize and seed the random generator. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007587 mbedtls_psa_random_init(&global_data.rng);
Gilles Peskinec6b69072018-11-20 21:42:52 +01007588 global_data.rng_state = RNG_INITIALIZED;
Gilles Peskine449bd832023-01-11 14:50:10 +01007589 status = mbedtls_psa_random_seed(&global_data.rng);
7590 if (status != PSA_SUCCESS) {
Gilles Peskinee59236f2018-01-27 23:32:46 +01007591 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007592 }
Gilles Peskinec6b69072018-11-20 21:42:52 +01007593 global_data.rng_state = RNG_SEEDED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007594
Gilles Peskine4b734222019-07-24 15:56:31 +02007595#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007596 status = psa_crypto_load_transaction();
7597 if (status == PSA_SUCCESS) {
7598 status = psa_crypto_recover_transaction(&psa_crypto_transaction);
7599 if (status != PSA_SUCCESS) {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007600 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007601 }
7602 status = psa_crypto_stop_transaction();
7603 } else if (status == PSA_ERROR_DOES_NOT_EXIST) {
Gilles Peskinefc762652019-07-22 19:30:34 +02007604 /* There's no transaction to complete. It's all good. */
7605 status = PSA_SUCCESS;
7606 }
Gilles Peskine4b734222019-07-24 15:56:31 +02007607#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
Gilles Peskinefc762652019-07-22 19:30:34 +02007608
Gilles Peskinec6b69072018-11-20 21:42:52 +01007609 /* All done. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01007610 global_data.initialized = 1;
7611
7612exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007613 if (status != PSA_SUCCESS) {
7614 mbedtls_psa_crypto_free();
7615 }
7616 return status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007617}
7618
Yanray Wangffc3c482023-07-11 12:01:04 +08007619#if defined(PSA_WANT_ALG_SOME_PAKE)
Przemek Stekielca8d2b22023-01-17 16:21:33 +01007620psa_status_t psa_crypto_driver_pake_get_password_len(
7621 const psa_crypto_driver_pake_inputs_t *inputs,
7622 size_t *password_len)
7623{
7624 if (inputs->password_len == 0) {
7625 return PSA_ERROR_BAD_STATE;
7626 }
7627
7628 *password_len = inputs->password_len;
7629
7630 return PSA_SUCCESS;
7631}
7632
7633psa_status_t psa_crypto_driver_pake_get_password(
7634 const psa_crypto_driver_pake_inputs_t *inputs,
7635 uint8_t *buffer, size_t buffer_size, size_t *buffer_length)
7636{
7637 if (inputs->password_len == 0) {
7638 return PSA_ERROR_BAD_STATE;
7639 }
7640
7641 if (buffer_size < inputs->password_len) {
7642 return PSA_ERROR_BUFFER_TOO_SMALL;
7643 }
7644
7645 memcpy(buffer, inputs->password, inputs->password_len);
7646 *buffer_length = inputs->password_len;
7647
7648 return PSA_SUCCESS;
7649}
7650
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007651psa_status_t psa_crypto_driver_pake_get_user_len(
7652 const psa_crypto_driver_pake_inputs_t *inputs,
7653 size_t *user_len)
7654{
7655 if (inputs->user_len == 0) {
7656 return PSA_ERROR_BAD_STATE;
7657 }
7658
7659 *user_len = inputs->user_len;
7660
7661 return PSA_SUCCESS;
7662}
7663
7664psa_status_t psa_crypto_driver_pake_get_user(
7665 const psa_crypto_driver_pake_inputs_t *inputs,
Przemek Stekielc0e62502023-03-14 11:49:36 +01007666 uint8_t *user_id, size_t user_id_size, size_t *user_id_len)
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007667{
7668 if (inputs->user_len == 0) {
7669 return PSA_ERROR_BAD_STATE;
7670 }
7671
Przemek Stekielc0e62502023-03-14 11:49:36 +01007672 if (user_id_size < inputs->user_len) {
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007673 return PSA_ERROR_BUFFER_TOO_SMALL;
7674 }
7675
Przemek Stekielc0e62502023-03-14 11:49:36 +01007676 memcpy(user_id, inputs->user, inputs->user_len);
7677 *user_id_len = inputs->user_len;
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007678
7679 return PSA_SUCCESS;
7680}
7681
7682psa_status_t psa_crypto_driver_pake_get_peer_len(
7683 const psa_crypto_driver_pake_inputs_t *inputs,
7684 size_t *peer_len)
7685{
7686 if (inputs->peer_len == 0) {
7687 return PSA_ERROR_BAD_STATE;
7688 }
7689
7690 *peer_len = inputs->peer_len;
7691
7692 return PSA_SUCCESS;
7693}
7694
7695psa_status_t psa_crypto_driver_pake_get_peer(
7696 const psa_crypto_driver_pake_inputs_t *inputs,
Przemek Stekielc0e62502023-03-14 11:49:36 +01007697 uint8_t *peer_id, size_t peer_id_size, size_t *peer_id_length)
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007698{
7699 if (inputs->peer_len == 0) {
7700 return PSA_ERROR_BAD_STATE;
7701 }
7702
Przemek Stekielc0e62502023-03-14 11:49:36 +01007703 if (peer_id_size < inputs->peer_len) {
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007704 return PSA_ERROR_BUFFER_TOO_SMALL;
7705 }
7706
Przemek Stekielc0e62502023-03-14 11:49:36 +01007707 memcpy(peer_id, inputs->peer, inputs->peer_len);
7708 *peer_id_length = inputs->peer_len;
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007709
7710 return PSA_SUCCESS;
7711}
7712
Przemek Stekielca8d2b22023-01-17 16:21:33 +01007713psa_status_t psa_crypto_driver_pake_get_cipher_suite(
7714 const psa_crypto_driver_pake_inputs_t *inputs,
7715 psa_pake_cipher_suite_t *cipher_suite)
7716{
7717 if (inputs->cipher_suite.algorithm == PSA_ALG_NONE) {
7718 return PSA_ERROR_BAD_STATE;
7719 }
7720
7721 *cipher_suite = inputs->cipher_suite;
7722
7723 return PSA_SUCCESS;
7724}
7725
Neil Armstronga7d08c32022-06-01 18:21:20 +02007726psa_status_t psa_pake_setup(
7727 psa_pake_operation_t *operation,
7728 const psa_pake_cipher_suite_t *cipher_suite)
7729{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007730 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007731
Przemek Stekiel1c3cfb42023-01-26 10:35:02 +01007732 if (operation->stage != PSA_PAKE_OPERATION_STAGE_SETUP) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007733 status = PSA_ERROR_BAD_STATE;
7734 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007735 }
7736
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01007737 if (PSA_ALG_IS_PAKE(cipher_suite->algorithm) == 0 ||
Przemek Stekiel51eac532022-12-07 11:04:51 +01007738 PSA_ALG_IS_HASH(cipher_suite->hash) == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007739 status = PSA_ERROR_INVALID_ARGUMENT;
7740 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007741 }
7742
Przemek Stekiel51eac532022-12-07 11:04:51 +01007743 memset(&operation->data.inputs, 0, sizeof(operation->data.inputs));
7744
Przemek Stekiele12ed362022-12-21 12:54:46 +01007745 operation->alg = cipher_suite->algorithm;
Przemek Stekiel656b2592023-03-22 13:15:33 +01007746 operation->primitive = PSA_PAKE_PRIMITIVE(cipher_suite->type,
7747 cipher_suite->family, cipher_suite->bits);
Przemek Stekiel51eac532022-12-07 11:04:51 +01007748 operation->data.inputs.cipher_suite = *cipher_suite;
7749
Przemek Stekiel4aa99402023-02-27 13:00:57 +01007750#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01007751 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01007752 psa_jpake_computation_stage_t *computation_stage =
Przemek Stekieldde6a912023-01-26 08:46:37 +01007753 &operation->computation_stage.jpake;
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01007754
David Horstmann16f01512023-06-14 17:21:07 +01007755 memset(computation_stage, 0, sizeof(*computation_stage));
David Horstmanne7f21e62023-05-12 18:17:21 +01007756 computation_stage->step = PSA_PAKE_STEP_KEY_SHARE;
Przemek Stekiel80a88492023-02-20 13:32:22 +01007757 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007758#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01007759 {
7760 status = PSA_ERROR_NOT_SUPPORTED;
7761 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01007762 }
7763
Przemek Stekiel1c3cfb42023-01-26 10:35:02 +01007764 operation->stage = PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS;
7765
Przemek Stekiel51eac532022-12-07 11:04:51 +01007766 return PSA_SUCCESS;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007767exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007768 psa_pake_abort(operation);
7769 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02007770}
7771
7772psa_status_t psa_pake_set_password_key(
7773 psa_pake_operation_t *operation,
7774 mbedtls_svc_key_id_t password)
7775{
Neil Armstrong5ae60962022-09-15 11:29:46 +02007776 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel6c764412022-11-22 14:05:12 +01007777 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
7778 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007779 psa_key_attributes_t attributes;
7780 psa_key_type_t type;
Neil Armstrong5ae60962022-09-15 11:29:46 +02007781
Przemek Stekiel51eac532022-12-07 11:04:51 +01007782 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007783 status = PSA_ERROR_BAD_STATE;
7784 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007785 }
7786
Przemek Stekiel6c764412022-11-22 14:05:12 +01007787 status = psa_get_and_lock_key_slot_with_policy(password, &slot,
7788 PSA_KEY_USAGE_DERIVE,
Przemek Stekield5d28a22023-01-26 10:46:05 +01007789 operation->alg);
Neil Armstrong5ae60962022-09-15 11:29:46 +02007790 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007791 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02007792 }
7793
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007794 attributes = (psa_key_attributes_t) {
Przemek Stekiel6c764412022-11-22 14:05:12 +01007795 .core = slot->attr
7796 };
Neil Armstrong5ae60962022-09-15 11:29:46 +02007797
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007798 type = psa_get_key_type(&attributes);
Neil Armstrong5ae60962022-09-15 11:29:46 +02007799
Przemek Stekiel51eac532022-12-07 11:04:51 +01007800 if (type != PSA_KEY_TYPE_PASSWORD &&
7801 type != PSA_KEY_TYPE_PASSWORD_HASH) {
7802 status = PSA_ERROR_INVALID_ARGUMENT;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007803 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007804 }
7805
Przemek Stekiel51eac532022-12-07 11:04:51 +01007806 operation->data.inputs.password = mbedtls_calloc(1, slot->key.bytes);
7807 if (operation->data.inputs.password == NULL) {
Przemek Stekiele12ed362022-12-21 12:54:46 +01007808 status = PSA_ERROR_INSUFFICIENT_MEMORY;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007809 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007810 }
7811
7812 memcpy(operation->data.inputs.password, slot->key.data, slot->key.bytes);
7813 operation->data.inputs.password_len = slot->key.bytes;
Przemek Stekiel9dd24402023-01-26 15:06:09 +01007814 operation->data.inputs.attributes = attributes;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007815exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007816 if (status != PSA_SUCCESS) {
7817 psa_pake_abort(operation);
7818 }
Ryan Everett1b70a072024-01-04 10:32:49 +00007819 unlock_status = psa_unregister_read(slot);
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007820 return (status == PSA_SUCCESS) ? unlock_status : status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02007821}
7822
7823psa_status_t psa_pake_set_user(
7824 psa_pake_operation_t *operation,
7825 const uint8_t *user_id,
7826 size_t user_id_len)
7827{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007828 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007829
7830 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007831 status = PSA_ERROR_BAD_STATE;
7832 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02007833 }
7834
Przemek Stekiel51eac532022-12-07 11:04:51 +01007835 if (user_id_len == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007836 status = PSA_ERROR_INVALID_ARGUMENT;
7837 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02007838 }
7839
Przemek Stekielf309d6b2023-03-10 09:54:45 +01007840 if (operation->data.inputs.user_len != 0) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007841 status = PSA_ERROR_BAD_STATE;
7842 goto exit;
7843 }
7844
Przemek Stekielf309d6b2023-03-10 09:54:45 +01007845 operation->data.inputs.user = mbedtls_calloc(1, user_id_len);
7846 if (operation->data.inputs.user == NULL) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007847 status = PSA_ERROR_INSUFFICIENT_MEMORY;
7848 goto exit;
7849 }
7850
Przemek Stekielf309d6b2023-03-10 09:54:45 +01007851 memcpy(operation->data.inputs.user, user_id, user_id_len);
7852 operation->data.inputs.user_len = user_id_len;
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007853
7854 return PSA_SUCCESS;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007855exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007856 psa_pake_abort(operation);
7857 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02007858}
7859
7860psa_status_t psa_pake_set_peer(
7861 psa_pake_operation_t *operation,
7862 const uint8_t *peer_id,
7863 size_t peer_id_len)
7864{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007865 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007866
7867 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007868 status = PSA_ERROR_BAD_STATE;
7869 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02007870 }
7871
Przemek Stekiel51eac532022-12-07 11:04:51 +01007872 if (peer_id_len == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007873 status = PSA_ERROR_INVALID_ARGUMENT;
7874 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02007875 }
7876
Przemek Stekielf309d6b2023-03-10 09:54:45 +01007877 if (operation->data.inputs.peer_len != 0) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007878 status = PSA_ERROR_BAD_STATE;
7879 goto exit;
7880 }
7881
Przemek Stekielf309d6b2023-03-10 09:54:45 +01007882 operation->data.inputs.peer = mbedtls_calloc(1, peer_id_len);
7883 if (operation->data.inputs.peer == NULL) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007884 status = PSA_ERROR_INSUFFICIENT_MEMORY;
7885 goto exit;
7886 }
7887
Przemek Stekielf309d6b2023-03-10 09:54:45 +01007888 memcpy(operation->data.inputs.peer, peer_id, peer_id_len);
7889 operation->data.inputs.peer_len = peer_id_len;
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007890
7891 return PSA_SUCCESS;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007892exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007893 psa_pake_abort(operation);
7894 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02007895}
7896
7897psa_status_t psa_pake_set_role(
7898 psa_pake_operation_t *operation,
7899 psa_pake_role_t role)
7900{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007901 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007902
Przemek Stekiel51eac532022-12-07 11:04:51 +01007903 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007904 status = PSA_ERROR_BAD_STATE;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007905 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007906 }
7907
Przemek Stekiel09104b82023-03-06 14:11:51 +01007908 switch (operation->alg) {
7909#if defined(PSA_WANT_ALG_JPAKE)
7910 case PSA_ALG_JPAKE:
7911 if (role == PSA_PAKE_ROLE_NONE) {
7912 return PSA_SUCCESS;
7913 }
7914 status = PSA_ERROR_INVALID_ARGUMENT;
7915 break;
7916#endif
7917 default:
7918 (void) role;
7919 status = PSA_ERROR_NOT_SUPPORTED;
7920 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02007921 }
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007922exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007923 psa_pake_abort(operation);
7924 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02007925}
7926
David Horstmanne7f21e62023-05-12 18:17:21 +01007927/* Auxiliary function to convert core computation stage to single driver step. */
Przemek Stekiel4aa99402023-02-27 13:00:57 +01007928#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiel251e86a2023-02-17 14:30:50 +01007929static psa_crypto_driver_pake_step_t convert_jpake_computation_stage_to_driver_step(
Przemek Stekieldde6a912023-01-26 08:46:37 +01007930 psa_jpake_computation_stage_t *stage)
Przemek Stekielb09c4872023-01-17 12:05:38 +01007931{
David Horstmann74a3d8c2023-06-14 18:28:19 +01007932 psa_crypto_driver_pake_step_t key_share_step;
David Horstmann5da95602023-06-08 15:37:12 +01007933 if (stage->round == PSA_JPAKE_FIRST) {
David Horstmanne7f21e62023-05-12 18:17:21 +01007934 int is_x1;
David Horstmann74a3d8c2023-06-14 18:28:19 +01007935
David Horstmann024e5c52023-06-14 15:48:21 +01007936 if (stage->io_mode == PSA_JPAKE_OUTPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01007937 is_x1 = (stage->outputs < 1);
7938 } else {
7939 is_x1 = (stage->inputs < 1);
7940 }
7941
David Horstmann74a3d8c2023-06-14 18:28:19 +01007942 key_share_step = is_x1 ?
7943 PSA_JPAKE_X1_STEP_KEY_SHARE :
7944 PSA_JPAKE_X2_STEP_KEY_SHARE;
David Horstmann5da95602023-06-08 15:37:12 +01007945 } else if (stage->round == PSA_JPAKE_SECOND) {
David Horstmann74a3d8c2023-06-14 18:28:19 +01007946 key_share_step = (stage->io_mode == PSA_JPAKE_OUTPUT) ?
7947 PSA_JPAKE_X2S_STEP_KEY_SHARE :
7948 PSA_JPAKE_X4S_STEP_KEY_SHARE;
7949 } else {
7950 return PSA_JPAKE_STEP_INVALID;
Przemek Stekielb09c4872023-01-17 12:05:38 +01007951 }
Agathiyan Bragadeesh387bfa52023-07-17 17:01:33 +01007952 return (psa_crypto_driver_pake_step_t) (key_share_step + stage->step - PSA_PAKE_STEP_KEY_SHARE);
Przemek Stekielb09c4872023-01-17 12:05:38 +01007953}
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007954#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekielb09c4872023-01-17 12:05:38 +01007955
Przemek Stekiel2797d372022-12-22 11:19:22 +01007956static psa_status_t psa_pake_complete_inputs(
7957 psa_pake_operation_t *operation)
7958{
Przemek Stekiel2797d372022-12-22 11:19:22 +01007959 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel18620a32023-01-17 16:34:52 +01007960 /* Create copy of the inputs on stack as inputs share memory
7961 with the driver context which will be setup by the driver. */
7962 psa_crypto_driver_pake_inputs_t inputs = operation->data.inputs;
Przemek Stekiel2797d372022-12-22 11:19:22 +01007963
Przemek Stekielfde11282023-03-13 16:06:09 +01007964 if (inputs.password_len == 0) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01007965 return PSA_ERROR_BAD_STATE;
7966 }
7967
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007968 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekielfde11282023-03-13 16:06:09 +01007969 if (inputs.user_len == 0 || inputs.peer_len == 0) {
7970 return PSA_ERROR_BAD_STATE;
7971 }
Przemek Stekieldff21d32023-02-14 20:09:10 +01007972 }
7973
Przemek Stekiel18620a32023-01-17 16:34:52 +01007974 /* Clear driver context */
7975 mbedtls_platform_zeroize(&operation->data, sizeof(operation->data));
7976
7977 status = psa_driver_wrapper_pake_setup(operation, &inputs);
Przemek Stekiel2797d372022-12-22 11:19:22 +01007978
7979 /* Driver is responsible for creating its own copy of the password. */
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01007980 mbedtls_zeroize_and_free(inputs.password, inputs.password_len);
Przemek Stekiel2797d372022-12-22 11:19:22 +01007981
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007982 /* User and peer are translated to role. */
7983 mbedtls_free(inputs.user);
7984 mbedtls_free(inputs.peer);
7985
Przemek Stekiel2797d372022-12-22 11:19:22 +01007986 if (status == PSA_SUCCESS) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01007987#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiel2797d372022-12-22 11:19:22 +01007988 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekield93de322023-02-24 08:39:04 +01007989 operation->stage = PSA_PAKE_OPERATION_STAGE_COMPUTATION;
Przemek Stekiel80a88492023-02-20 13:32:22 +01007990 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007991#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01007992 {
7993 status = PSA_ERROR_NOT_SUPPORTED;
Przemek Stekiel2797d372022-12-22 11:19:22 +01007994 }
Przemek Stekiel2797d372022-12-22 11:19:22 +01007995 }
Przemek Stekiel2797d372022-12-22 11:19:22 +01007996 return status;
7997}
7998
Przemek Stekiel4aa99402023-02-27 13:00:57 +01007999#if defined(PSA_WANT_ALG_JPAKE)
David Horstmanne7f21e62023-05-12 18:17:21 +01008000static psa_status_t psa_jpake_prologue(
Przemek Stekiele12ed362022-12-21 12:54:46 +01008001 psa_pake_operation_t *operation,
David Horstmanne7f21e62023-05-12 18:17:21 +01008002 psa_pake_step_t step,
David Horstmann00ad6bf2023-06-14 15:44:24 +01008003 psa_jpake_io_mode_t io_mode)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008004{
Przemek Stekiele12ed362022-12-21 12:54:46 +01008005 if (step != PSA_PAKE_STEP_KEY_SHARE &&
8006 step != PSA_PAKE_STEP_ZK_PUBLIC &&
8007 step != PSA_PAKE_STEP_ZK_PROOF) {
8008 return PSA_ERROR_INVALID_ARGUMENT;
8009 }
8010
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008011 psa_jpake_computation_stage_t *computation_stage =
8012 &operation->computation_stage.jpake;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008013
David Horstmann5da95602023-06-08 15:37:12 +01008014 if (computation_stage->round != PSA_JPAKE_FIRST &&
8015 computation_stage->round != PSA_JPAKE_SECOND) {
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008016 return PSA_ERROR_BAD_STATE;
8017 }
8018
David Horstmanne7f21e62023-05-12 18:17:21 +01008019 /* Check that the step we are given is the one we were expecting */
8020 if (step != computation_stage->step) {
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008021 return PSA_ERROR_BAD_STATE;
8022 }
8023
David Horstmanne7f21e62023-05-12 18:17:21 +01008024 if (step == PSA_PAKE_STEP_KEY_SHARE &&
8025 computation_stage->inputs == 0 &&
8026 computation_stage->outputs == 0) {
8027 /* Start of the round, so function decides whether we are inputting
8028 * or outputting */
David Horstmann024e5c52023-06-14 15:48:21 +01008029 computation_stage->io_mode = io_mode;
8030 } else if (computation_stage->io_mode != io_mode) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008031 /* Middle of the round so the mode we are in must match the function
8032 * called by the user */
8033 return PSA_ERROR_BAD_STATE;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008034 }
8035
8036 return PSA_SUCCESS;
8037}
8038
David Horstmanne7f21e62023-05-12 18:17:21 +01008039static psa_status_t psa_jpake_epilogue(
8040 psa_pake_operation_t *operation,
David Horstmann00ad6bf2023-06-14 15:44:24 +01008041 psa_jpake_io_mode_t io_mode)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008042{
David Horstmanne7f21e62023-05-12 18:17:21 +01008043 psa_jpake_computation_stage_t *stage =
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008044 &operation->computation_stage.jpake;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008045
David Horstmanne7f21e62023-05-12 18:17:21 +01008046 if (stage->step == PSA_PAKE_STEP_ZK_PROOF) {
8047 /* End of an input/output */
David Horstmann00ad6bf2023-06-14 15:44:24 +01008048 if (io_mode == PSA_JPAKE_INPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008049 stage->inputs++;
David Horstmann246ec5a2023-06-27 10:33:06 +01008050 if (stage->inputs == PSA_JPAKE_EXPECTED_INPUTS(stage->round)) {
David Horstmann024e5c52023-06-14 15:48:21 +01008051 stage->io_mode = PSA_JPAKE_OUTPUT;
David Horstmanne7f21e62023-05-12 18:17:21 +01008052 }
8053 }
David Horstmann00ad6bf2023-06-14 15:44:24 +01008054 if (io_mode == PSA_JPAKE_OUTPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008055 stage->outputs++;
David Horstmann246ec5a2023-06-27 10:33:06 +01008056 if (stage->outputs == PSA_JPAKE_EXPECTED_OUTPUTS(stage->round)) {
David Horstmann024e5c52023-06-14 15:48:21 +01008057 stage->io_mode = PSA_JPAKE_INPUT;
David Horstmanne7f21e62023-05-12 18:17:21 +01008058 }
8059 }
David Horstmann246ec5a2023-06-27 10:33:06 +01008060 if (stage->inputs == PSA_JPAKE_EXPECTED_INPUTS(stage->round) &&
8061 stage->outputs == PSA_JPAKE_EXPECTED_OUTPUTS(stage->round)) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008062 /* End of a round, move to the next round */
8063 stage->inputs = 0;
8064 stage->outputs = 0;
8065 stage->round++;
8066 }
8067 stage->step = PSA_PAKE_STEP_KEY_SHARE;
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008068 } else {
David Horstmanne7f21e62023-05-12 18:17:21 +01008069 stage->step++;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008070 }
Przemek Stekiele12ed362022-12-21 12:54:46 +01008071 return PSA_SUCCESS;
8072}
David Horstmanne7f21e62023-05-12 18:17:21 +01008073
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008074#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008075
Neil Armstronga7d08c32022-06-01 18:21:20 +02008076psa_status_t psa_pake_output(
8077 psa_pake_operation_t *operation,
8078 psa_pake_step_t step,
8079 uint8_t *output,
8080 size_t output_size,
8081 size_t *output_length)
8082{
Przemek Stekiel51eac532022-12-07 11:04:51 +01008083 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008084 psa_crypto_driver_pake_step_t driver_step = PSA_JPAKE_STEP_INVALID;
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008085 *output_length = 0;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008086
8087 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01008088 status = psa_pake_complete_inputs(operation);
8089 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008090 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008091 }
8092 }
8093
8094 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008095 status = PSA_ERROR_BAD_STATE;
8096 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008097 }
8098
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008099 if (output_size == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008100 status = PSA_ERROR_INVALID_ARGUMENT;
8101 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008102 }
8103
Przemek Stekiele12ed362022-12-21 12:54:46 +01008104 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008105#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008106 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008107 status = psa_jpake_prologue(operation, step, PSA_JPAKE_OUTPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008108 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008109 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008110 }
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008111 driver_step = convert_jpake_computation_stage_to_driver_step(
8112 &operation->computation_stage.jpake);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008113 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008114#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008115 default:
Przemek Stekiel80a88492023-02-20 13:32:22 +01008116 (void) step;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008117 status = PSA_ERROR_NOT_SUPPORTED;
8118 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008119 }
8120
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008121 status = psa_driver_wrapper_pake_output(operation, driver_step,
8122 output, output_size, output_length);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008123
8124 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008125 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008126 }
8127
8128 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008129#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008130 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008131 status = psa_jpake_epilogue(operation, PSA_JPAKE_OUTPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008132 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008133 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008134 }
8135 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008136#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008137 default:
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008138 status = PSA_ERROR_NOT_SUPPORTED;
8139 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008140 }
8141
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008142 return PSA_SUCCESS;
8143exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008144 psa_pake_abort(operation);
8145 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008146}
8147
8148psa_status_t psa_pake_input(
8149 psa_pake_operation_t *operation,
8150 psa_pake_step_t step,
8151 const uint8_t *input,
8152 size_t input_length)
8153{
Przemek Stekiel51eac532022-12-07 11:04:51 +01008154 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008155 psa_crypto_driver_pake_step_t driver_step = PSA_JPAKE_STEP_INVALID;
Przemek Stekiel256c75d2023-03-23 14:09:34 +01008156 const size_t max_input_length = (size_t) PSA_PAKE_INPUT_SIZE(operation->alg,
8157 operation->primitive,
8158 step);
Przemek Stekiel51eac532022-12-07 11:04:51 +01008159
8160 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01008161 status = psa_pake_complete_inputs(operation);
8162 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008163 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008164 }
8165 }
8166
8167 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008168 status = PSA_ERROR_BAD_STATE;
8169 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008170 }
8171
Przemek Stekiel256c75d2023-03-23 14:09:34 +01008172 if (input_length == 0 || input_length > max_input_length) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008173 status = PSA_ERROR_INVALID_ARGUMENT;
8174 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008175 }
8176
Przemek Stekiele12ed362022-12-21 12:54:46 +01008177 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008178#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008179 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008180 status = psa_jpake_prologue(operation, step, PSA_JPAKE_INPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008181 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008182 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008183 }
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008184 driver_step = convert_jpake_computation_stage_to_driver_step(
8185 &operation->computation_stage.jpake);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008186 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008187#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008188 default:
Przemek Stekiel80a88492023-02-20 13:32:22 +01008189 (void) step;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008190 status = PSA_ERROR_NOT_SUPPORTED;
8191 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008192 }
8193
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008194 status = psa_driver_wrapper_pake_input(operation, driver_step,
8195 input, input_length);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008196
8197 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008198 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008199 }
8200
8201 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008202#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008203 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008204 status = psa_jpake_epilogue(operation, PSA_JPAKE_INPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008205 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008206 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008207 }
8208 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008209#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008210 default:
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008211 status = PSA_ERROR_NOT_SUPPORTED;
8212 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008213 }
8214
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008215 return PSA_SUCCESS;
8216exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008217 psa_pake_abort(operation);
8218 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008219}
8220
8221psa_status_t psa_pake_get_implicit_key(
8222 psa_pake_operation_t *operation,
8223 psa_key_derivation_operation_t *output)
8224{
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008225 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008226 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel251e86a2023-02-17 14:30:50 +01008227 uint8_t shared_key[MBEDTLS_PSA_JPAKE_BUFFER_SIZE];
Przemek Stekiel0c781802022-11-29 14:53:13 +01008228 size_t shared_key_len = 0;
8229
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008230 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008231 status = PSA_ERROR_BAD_STATE;
8232 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008233 }
8234
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008235#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008236 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008237 psa_jpake_computation_stage_t *computation_stage =
Przemek Stekiel083745e2023-02-23 17:28:23 +01008238 &operation->computation_stage.jpake;
David Horstmann5da95602023-06-08 15:37:12 +01008239 if (computation_stage->round != PSA_JPAKE_FINISHED) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008240 status = PSA_ERROR_BAD_STATE;
8241 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008242 }
Przemek Stekiel80a88492023-02-20 13:32:22 +01008243 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008244#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01008245 {
8246 status = PSA_ERROR_NOT_SUPPORTED;
8247 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008248 }
8249
Przemek Stekiel0c781802022-11-29 14:53:13 +01008250 status = psa_driver_wrapper_pake_get_implicit_key(operation,
8251 shared_key,
Przemek Stekiel6b648622023-02-19 22:55:33 +01008252 sizeof(shared_key),
Przemek Stekiel0c781802022-11-29 14:53:13 +01008253 &shared_key_len);
8254
8255 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008256 goto exit;
Przemek Stekiel0c781802022-11-29 14:53:13 +01008257 }
8258
8259 status = psa_key_derivation_input_bytes(output,
8260 PSA_KEY_DERIVATION_INPUT_SECRET,
8261 shared_key,
8262 shared_key_len);
8263
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008264 mbedtls_platform_zeroize(shared_key, sizeof(shared_key));
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008265exit:
8266 abort_status = psa_pake_abort(operation);
8267 return status == PSA_SUCCESS ? abort_status : status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008268}
8269
8270psa_status_t psa_pake_abort(
8271 psa_pake_operation_t *operation)
8272{
Przemek Stekield69dca92023-01-31 19:59:20 +01008273 psa_status_t status = PSA_SUCCESS;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008274
Przemek Stekield69dca92023-01-31 19:59:20 +01008275 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008276 status = psa_driver_wrapper_pake_abort(operation);
Neil Armstrong5ae60962022-09-15 11:29:46 +02008277 }
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008278
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008279 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
8280 if (operation->data.inputs.password != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01008281 mbedtls_zeroize_and_free(operation->data.inputs.password,
Przemek Stekielaa183422023-03-06 14:21:44 +01008282 operation->data.inputs.password_len);
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008283 }
8284 if (operation->data.inputs.user != NULL) {
8285 mbedtls_free(operation->data.inputs.user);
8286 }
8287 if (operation->data.inputs.peer != NULL) {
8288 mbedtls_free(operation->data.inputs.peer);
8289 }
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008290 }
Przemek Stekield69dca92023-01-31 19:59:20 +01008291 memset(operation, 0, sizeof(psa_pake_operation_t));
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008292
Przemek Stekield69dca92023-01-31 19:59:20 +01008293 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008294}
Tom Cosgrove6d62fac2023-05-10 14:40:05 +01008295#endif /* PSA_WANT_ALG_SOME_PAKE */
Neil Armstronga7d08c32022-06-01 18:21:20 +02008296
Gilles Peskinee59236f2018-01-27 23:32:46 +01008297#endif /* MBEDTLS_PSA_CRYPTO_C */