blob: a27fd42c42e54dec4923c4c3fcfddcfe87ef642e [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{
Ryan Everettaa33c512023-12-21 17:32:07 +0000986 if (slot->state != PSA_SLOT_PENDING_DELETION) {
987 return PSA_ERROR_BAD_STATE;
988 }
989
Gilles Peskine449bd832023-01-11 14:50:10 +0100990 psa_status_t status = psa_remove_key_data_from_memory(slot);
Ronald Cronddd3d052020-10-30 14:07:07 +0100991
Gilles Peskine449bd832023-01-11 14:50:10 +0100992 /*
993 * As the return error code may not be handled in case of multiple errors,
Ryan Everettaa33c512023-12-21 17:32:07 +0000994 * do our best to report an unexpected amount of registered readers.
995 * Assert with MBEDTLS_TEST_HOOK_TEST_ASSERT that registered_readers is
996 * equal to one:
Gilles Peskine449bd832023-01-11 14:50:10 +0100997 * if the MBEDTLS_TEST_HOOKS configuration option is enabled and the
998 * function is called as part of the execution of a test suite, the
999 * execution of the test suite is stopped in error if the assertion fails.
1000 */
Ryan Everettaa33c512023-12-21 17:32:07 +00001001 if (slot->registered_readers != 1) {
1002 MBEDTLS_TEST_HOOK_TEST_ASSERT(slot->registered_readers == 1);
Ronald Cronddd3d052020-10-30 14:07:07 +01001003 status = PSA_ERROR_CORRUPTION_DETECTED;
1004 }
1005
Gilles Peskine3f7cd622019-08-13 15:01:08 +02001006 /* Multipart operations may still be using the key. This is safe
1007 * because all multipart operation objects are independent from
1008 * the key slot: if they need to access the key after the setup
1009 * phase, they have a copy of the key. Note that this means that
1010 * key material can linger until all operations are completed. */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001011 /* At this point, key material and other type-specific content has
1012 * been wiped. Clear remaining metadata. We can call memset and not
Ryan Everettaa33c512023-12-21 17:32:07 +00001013 * zeroize because the metadata is not particularly sensitive.
1014 * This memset also sets the slot's state to PSA_SLOT_EMPTY. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001015 memset(slot, 0, sizeof(*slot));
1016 return status;
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001017}
1018
Gilles Peskine449bd832023-01-11 14:50:10 +01001019psa_status_t psa_destroy_key(mbedtls_svc_key_id_t key)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001020{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001021 psa_key_slot_t *slot;
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001022 psa_status_t status; /* status of the last operation */
1023 psa_status_t overall_status = PSA_SUCCESS;
Gilles Peskine354f7672019-07-12 23:46:38 +02001024#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1025 psa_se_drv_table_entry_t *driver;
1026#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001027
Gilles Peskine449bd832023-01-11 14:50:10 +01001028 if (mbedtls_svc_key_id_is_null(key)) {
1029 return PSA_SUCCESS;
1030 }
Gilles Peskine1841cf42019-10-08 15:48:25 +02001031
Ronald Cronf2911112020-10-29 17:51:10 +01001032 /*
Ronald Cron19daca92020-11-10 18:08:03 +01001033 * Get the description of the key in a key slot. In case of a persistent
Ronald Cronf2911112020-10-29 17:51:10 +01001034 * key, this will load the key description from persistent memory if not
1035 * done yet. We cannot avoid this loading as without it we don't know if
1036 * the key is operated by an SE or not and this information is needed by
1037 * the current implementation.
1038 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001039 status = psa_get_and_lock_key_slot(key, &slot);
1040 if (status != PSA_SUCCESS) {
1041 return status;
1042 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001043
Ronald Cronf2911112020-10-29 17:51:10 +01001044 /*
1045 * If the key slot containing the key description is under access by the
1046 * library (apart from the present access), the key cannot be destroyed
1047 * yet. For the time being, just return in error. Eventually (to be
1048 * implemented), the key should be destroyed when all accesses have
1049 * stopped.
1050 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001051 if (slot->lock_count > 1) {
1052 psa_unlock_key_slot(slot);
1053 return PSA_ERROR_GENERIC_ERROR;
Ronald Cronf2911112020-10-29 17:51:10 +01001054 }
1055
Gilles Peskine449bd832023-01-11 14:50:10 +01001056 if (PSA_KEY_LIFETIME_IS_READ_ONLY(slot->attr.lifetime)) {
Gilles Peskine6687cd02021-04-21 22:32:05 +02001057 /* Refuse the destruction of a read-only key (which may or may not work
1058 * if we attempt it, depending on whether the key is merely read-only
1059 * by policy or actually physically read-only).
Gilles Peskinef9a046e2021-06-07 23:27:54 +02001060 * Just do the best we can, which is to wipe the copy in memory
1061 * (done in this function's cleanup code). */
1062 overall_status = PSA_ERROR_NOT_PERMITTED;
1063 goto exit;
Gilles Peskine6687cd02021-04-21 22:32:05 +02001064 }
1065
Gilles Peskine354f7672019-07-12 23:46:38 +02001066#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001067 driver = psa_get_se_driver_entry(slot->attr.lifetime);
1068 if (driver != NULL) {
Gilles Peskine60450a42019-07-25 11:32:45 +02001069 /* For a key in a secure element, we need to do three things:
1070 * remove the key file in internal storage, destroy the
1071 * key inside the secure element, and update the driver's
1072 * persistent data. Start a transaction that will encompass these
1073 * three actions. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001074 psa_crypto_prepare_transaction(PSA_CRYPTO_TRANSACTION_DESTROY_KEY);
Gilles Peskine8e338702019-07-30 20:06:31 +02001075 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Gilles Peskine449bd832023-01-11 14:50:10 +01001076 psa_crypto_transaction.key.slot = psa_key_slot_get_slot_number(slot);
Gilles Peskine8e338702019-07-30 20:06:31 +02001077 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskine449bd832023-01-11 14:50:10 +01001078 status = psa_crypto_save_transaction();
1079 if (status != PSA_SUCCESS) {
1080 (void) psa_crypto_stop_transaction();
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001081 /* We should still try to destroy the key in the secure
1082 * element and the key metadata in storage. This is especially
1083 * important if the error is that the storage is full.
1084 * But how to do it exactly without risking an inconsistent
1085 * state after a reset?
1086 * https://github.com/ARMmbed/mbed-crypto/issues/215
1087 */
1088 overall_status = status;
1089 goto exit;
Gilles Peskinefc762652019-07-22 19:30:34 +02001090 }
1091
Gilles Peskine449bd832023-01-11 14:50:10 +01001092 status = psa_destroy_se_key(driver,
1093 psa_key_slot_get_slot_number(slot));
1094 if (overall_status == PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001095 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001096 }
Gilles Peskinefc762652019-07-22 19:30:34 +02001097 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001098#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1099
Darryl Greend49a4992018-06-18 17:27:26 +01001100#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001101 if (!PSA_KEY_LIFETIME_IS_VOLATILE(slot->attr.lifetime)) {
1102 status = psa_destroy_persistent_key(slot->attr.id);
1103 if (overall_status == PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001104 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001105 }
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001106
Gilles Peskine9ce31c42019-08-13 15:14:20 +02001107 /* TODO: other slots may have a copy of the same key. We should
1108 * invalidate them.
1109 * https://github.com/ARMmbed/mbed-crypto/issues/214
1110 */
Darryl Greend49a4992018-06-18 17:27:26 +01001111 }
1112#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
Gilles Peskine354f7672019-07-12 23:46:38 +02001113
Gilles Peskinefc762652019-07-22 19:30:34 +02001114#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001115 if (driver != NULL) {
1116 status = psa_save_se_persistent_data(driver);
1117 if (overall_status == PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001118 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001119 }
1120 status = psa_crypto_stop_transaction();
1121 if (overall_status == PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001122 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001123 }
Gilles Peskinefc762652019-07-22 19:30:34 +02001124 }
1125#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1126
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001127exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01001128 status = psa_wipe_key_slot(slot);
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001129 /* Prioritize CORRUPTION_DETECTED from wiping over a storage error */
Gilles Peskine449bd832023-01-11 14:50:10 +01001130 if (status != PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001131 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001132 }
1133 return overall_status;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001134}
1135
Valerio Settib2bcedb2023-07-10 11:24:00 +02001136#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT) || \
John Durkop0e005192020-10-31 22:06:54 -07001137 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskineb699f072019-04-26 16:06:02 +02001138static psa_status_t psa_get_rsa_public_exponent(
1139 const mbedtls_rsa_context *rsa,
Gilles Peskine449bd832023-01-11 14:50:10 +01001140 psa_key_attributes_t *attributes)
Gilles Peskineb699f072019-04-26 16:06:02 +02001141{
1142 mbedtls_mpi mpi;
Janos Follath24eed8d2019-11-22 13:21:35 +00001143 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb699f072019-04-26 16:06:02 +02001144 uint8_t *buffer = NULL;
1145 size_t buflen;
Gilles Peskine449bd832023-01-11 14:50:10 +01001146 mbedtls_mpi_init(&mpi);
Gilles Peskineb699f072019-04-26 16:06:02 +02001147
Gilles Peskine449bd832023-01-11 14:50:10 +01001148 ret = mbedtls_rsa_export(rsa, NULL, NULL, NULL, NULL, &mpi);
1149 if (ret != 0) {
Gilles Peskineb699f072019-04-26 16:06:02 +02001150 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001151 }
1152 if (mbedtls_mpi_cmp_int(&mpi, 65537) == 0) {
Gilles Peskine772c8b12019-04-26 17:37:21 +02001153 /* It's the default value, which is reported as an empty string,
1154 * so there's nothing to do. */
1155 goto exit;
1156 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001157
Gilles Peskine449bd832023-01-11 14:50:10 +01001158 buflen = mbedtls_mpi_size(&mpi);
1159 buffer = mbedtls_calloc(1, buflen);
1160 if (buffer == NULL) {
Gilles Peskineb699f072019-04-26 16:06:02 +02001161 ret = MBEDTLS_ERR_MPI_ALLOC_FAILED;
1162 goto exit;
1163 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001164 ret = mbedtls_mpi_write_binary(&mpi, buffer, buflen);
1165 if (ret != 0) {
Gilles Peskineb699f072019-04-26 16:06:02 +02001166 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001167 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001168 attributes->domain_parameters = buffer;
1169 attributes->domain_parameters_size = buflen;
1170
1171exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01001172 mbedtls_mpi_free(&mpi);
1173 if (ret != 0) {
1174 mbedtls_free(buffer);
1175 }
1176 return mbedtls_to_psa_error(ret);
Gilles Peskineb699f072019-04-26 16:06:02 +02001177}
Valerio Settib2bcedb2023-07-10 11:24:00 +02001178#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT) ||
John Durkop9814fa22020-11-04 12:28:15 -08001179 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001180
Gilles Peskinebfd322f2019-07-23 11:58:03 +02001181/** Retrieve all the publicly-accessible attributes of a key.
1182 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001183psa_status_t psa_get_key_attributes(mbedtls_svc_key_id_t key,
1184 psa_key_attributes_t *attributes)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001185{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001186 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001187 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001188 psa_key_slot_t *slot;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001189
Gilles Peskine449bd832023-01-11 14:50:10 +01001190 psa_reset_key_attributes(attributes);
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001191
Gilles Peskine449bd832023-01-11 14:50:10 +01001192 status = psa_get_and_lock_key_slot_with_policy(key, &slot, 0, 0);
1193 if (status != PSA_SUCCESS) {
1194 return status;
1195 }
Gilles Peskineb870b182018-07-06 16:02:09 +02001196
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001197 attributes->core = slot->attr;
Gilles Peskine449bd832023-01-11 14:50:10 +01001198 attributes->core.flags &= (MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1199 MBEDTLS_PSA_KA_MASK_DUAL_USE);
Gilles Peskinec8000c02019-08-02 20:15:51 +02001200
1201#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001202 if (psa_get_se_driver_entry(slot->attr.lifetime) != NULL) {
1203 psa_set_key_slot_number(attributes,
1204 psa_key_slot_get_slot_number(slot));
1205 }
Gilles Peskinec8000c02019-08-02 20:15:51 +02001206#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineb699f072019-04-26 16:06:02 +02001207
Gilles Peskine449bd832023-01-11 14:50:10 +01001208 switch (slot->attr.type) {
Valerio Settib2bcedb2023-07-10 11:24:00 +02001209#if (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) && \
1210 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) || \
John Durkop0e005192020-10-31 22:06:54 -07001211 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02001212 case PSA_KEY_TYPE_RSA_KEY_PAIR:
Gilles Peskineb699f072019-04-26 16:06:02 +02001213 case PSA_KEY_TYPE_RSA_PUBLIC_KEY:
Pengyu Lvf75893b2023-12-08 17:21:39 +08001214 /* TODO: This is a temporary situation where domain parameters are deprecated,
1215 * but we need it for namely generating an RSA key with a non-default exponent.
1216 * This would be improved after https://github.com/Mbed-TLS/mbedtls/issues/6494.
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001217 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001218 if (!psa_key_lifetime_is_external(slot->attr.lifetime)) {
Steven Cooremana2371e52020-07-28 14:30:39 +02001219 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02001220
Ronald Cron90857082020-11-25 14:58:33 +01001221 status = mbedtls_psa_rsa_load_representation(
Gilles Peskine449bd832023-01-11 14:50:10 +01001222 slot->attr.type,
1223 slot->key.data,
1224 slot->key.bytes,
1225 &rsa);
1226 if (status != PSA_SUCCESS) {
Steven Cooremana01795d2020-07-24 22:48:15 +02001227 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01001228 }
Steven Cooremana01795d2020-07-24 22:48:15 +02001229
Gilles Peskine449bd832023-01-11 14:50:10 +01001230 status = psa_get_rsa_public_exponent(rsa,
1231 attributes);
1232 mbedtls_rsa_free(rsa);
1233 mbedtls_free(rsa);
Steven Cooremana01795d2020-07-24 22:48:15 +02001234 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001235 break;
Pengyu Lve9efbc22023-12-08 16:59:08 +08001236#else
1237 case PSA_KEY_TYPE_RSA_KEY_PAIR:
1238 case PSA_KEY_TYPE_RSA_PUBLIC_KEY:
1239 attributes->domain_parameters = NULL;
1240 attributes->domain_parameters_size = SIZE_MAX;
1241 break;
Valerio Settib2bcedb2023-07-10 11:24:00 +02001242#endif /* (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) && \
1243 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) ||
John Durkop9814fa22020-11-04 12:28:15 -08001244 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001245 default:
1246 /* Nothing else to do. */
1247 break;
1248 }
1249
Gilles Peskine449bd832023-01-11 14:50:10 +01001250 if (status != PSA_SUCCESS) {
1251 psa_reset_key_attributes(attributes);
1252 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001253
Gilles Peskine449bd832023-01-11 14:50:10 +01001254 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02001255
Gilles Peskine449bd832023-01-11 14:50:10 +01001256 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001257}
1258
Gilles Peskinec8000c02019-08-02 20:15:51 +02001259#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1260psa_status_t psa_get_key_slot_number(
1261 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01001262 psa_key_slot_number_t *slot_number)
Gilles Peskinec8000c02019-08-02 20:15:51 +02001263{
Gilles Peskine449bd832023-01-11 14:50:10 +01001264 if (attributes->core.flags & MBEDTLS_PSA_KA_FLAG_HAS_SLOT_NUMBER) {
Gilles Peskinec8000c02019-08-02 20:15:51 +02001265 *slot_number = attributes->slot_number;
Gilles Peskine449bd832023-01-11 14:50:10 +01001266 return PSA_SUCCESS;
1267 } else {
1268 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinec8000c02019-08-02 20:15:51 +02001269 }
Gilles Peskinec8000c02019-08-02 20:15:51 +02001270}
1271#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1272
Gilles Peskine449bd832023-01-11 14:50:10 +01001273static psa_status_t psa_export_key_buffer_internal(const uint8_t *key_buffer,
1274 size_t key_buffer_size,
1275 uint8_t *data,
1276 size_t data_size,
1277 size_t *data_length)
Steven Cooremana01795d2020-07-24 22:48:15 +02001278{
Gilles Peskine449bd832023-01-11 14:50:10 +01001279 if (key_buffer_size > data_size) {
1280 return PSA_ERROR_BUFFER_TOO_SMALL;
1281 }
1282 memcpy(data, key_buffer, key_buffer_size);
1283 memset(data + key_buffer_size, 0,
1284 data_size - key_buffer_size);
Ronald Crond18b5f82020-11-25 16:46:05 +01001285 *data_length = key_buffer_size;
Gilles Peskine449bd832023-01-11 14:50:10 +01001286 return PSA_SUCCESS;
Steven Cooremana01795d2020-07-24 22:48:15 +02001287}
1288
Ronald Cron7285cda2020-11-26 14:46:37 +01001289psa_status_t psa_export_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001290 const psa_key_attributes_t *attributes,
1291 const uint8_t *key_buffer, size_t key_buffer_size,
Gilles Peskine449bd832023-01-11 14:50:10 +01001292 uint8_t *data, size_t data_size, size_t *data_length)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001293{
Ronald Crond18b5f82020-11-25 16:46:05 +01001294 psa_key_type_t type = attributes->core.type;
1295
Gilles Peskine449bd832023-01-11 14:50:10 +01001296 if (key_type_is_raw_bytes(type) ||
1297 PSA_KEY_TYPE_IS_RSA(type) ||
Przemek Stekiel472b3f32022-12-01 14:38:49 +01001298 PSA_KEY_TYPE_IS_ECC(type) ||
1299 PSA_KEY_TYPE_IS_DH(type)) {
Gilles Peskine449bd832023-01-11 14:50:10 +01001300 return psa_export_key_buffer_internal(
1301 key_buffer, key_buffer_size,
1302 data, data_size, data_length);
1303 } else {
Ronald Cron9486f9d2020-11-26 13:36:23 +01001304 /* This shouldn't happen in the reference implementation, but
1305 it is valid for a special-purpose implementation to omit
1306 support for exporting certain key types. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001307 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron9486f9d2020-11-26 13:36:23 +01001308 }
1309}
1310
Gilles Peskine449bd832023-01-11 14:50:10 +01001311psa_status_t psa_export_key(mbedtls_svc_key_id_t key,
1312 uint8_t *data,
1313 size_t data_size,
1314 size_t *data_length)
Ronald Cron9486f9d2020-11-26 13:36:23 +01001315{
1316 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
1317 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
1318 psa_key_slot_t *slot;
1319
Ronald Crone907e552021-01-18 13:22:38 +01001320 /* Reject a zero-length output buffer now, since this can never be a
1321 * valid key representation. This way we know that data must be a valid
1322 * pointer and we can do things like memset(data, ..., data_size). */
Gilles Peskine449bd832023-01-11 14:50:10 +01001323 if (data_size == 0) {
1324 return PSA_ERROR_BUFFER_TOO_SMALL;
1325 }
Ronald Crone907e552021-01-18 13:22:38 +01001326
Ronald Cron9486f9d2020-11-26 13:36:23 +01001327 /* Set the key to empty now, so that even when there are errors, we always
1328 * set data_length to a value between 0 and data_size. On error, setting
1329 * the key to empty is a good choice because an empty key representation is
1330 * unlikely to be accepted anywhere. */
Jaeden Amerof24c7f82018-06-27 17:20:43 +01001331 *data_length = 0;
1332
Ronald Cron9486f9d2020-11-26 13:36:23 +01001333 /* Export requires the EXPORT flag. There is an exception for public keys,
1334 * which don't require any flag, but
1335 * psa_get_and_lock_key_slot_with_policy() takes care of this.
1336 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001337 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
1338 PSA_KEY_USAGE_EXPORT, 0);
1339 if (status != PSA_SUCCESS) {
1340 return status;
1341 }
mohammad160306e79202018-03-28 13:17:44 +03001342
Ronald Crond18b5f82020-11-25 16:46:05 +01001343 psa_key_attributes_t attributes = {
1344 .core = slot->attr
1345 };
Gilles Peskine449bd832023-01-11 14:50:10 +01001346 status = psa_driver_wrapper_export_key(&attributes,
1347 slot->key.data, slot->key.bytes,
1348 data, data_size, data_length);
Ronald Cron9486f9d2020-11-26 13:36:23 +01001349
Gilles Peskine449bd832023-01-11 14:50:10 +01001350 unlock_status = psa_unlock_key_slot(slot);
Ronald Cron9486f9d2020-11-26 13:36:23 +01001351
Gilles Peskine449bd832023-01-11 14:50:10 +01001352 return (status == PSA_SUCCESS) ? unlock_status : status;
Ronald Cron9486f9d2020-11-26 13:36:23 +01001353}
1354
Ronald Cron7285cda2020-11-26 14:46:37 +01001355psa_status_t psa_export_public_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001356 const psa_key_attributes_t *attributes,
1357 const uint8_t *key_buffer,
1358 size_t key_buffer_size,
1359 uint8_t *data,
1360 size_t data_size,
Gilles Peskine449bd832023-01-11 14:50:10 +01001361 size_t *data_length)
Ronald Cron9486f9d2020-11-26 13:36:23 +01001362{
Ronald Crond18b5f82020-11-25 16:46:05 +01001363 psa_key_type_t type = attributes->core.type;
Ronald Crond18b5f82020-11-25 16:46:05 +01001364
Przemek Stekiel6fd72b62023-04-27 10:20:56 +02001365 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(type) &&
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001366 (PSA_KEY_TYPE_IS_RSA(type) || PSA_KEY_TYPE_IS_ECC(type) ||
1367 PSA_KEY_TYPE_IS_DH(type))) {
Przemek Stekiel6fd72b62023-04-27 10:20:56 +02001368 /* Exporting public -> public */
1369 return psa_export_key_buffer_internal(
1370 key_buffer, key_buffer_size,
1371 data, data_size, data_length);
1372 } else if (PSA_KEY_TYPE_IS_RSA(type)) {
Valerio Settib2bcedb2023-07-10 11:24:00 +02001373#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT) || \
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001374 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
1375 return mbedtls_psa_rsa_export_public_key(attributes,
1376 key_buffer,
1377 key_buffer_size,
1378 data,
1379 data_size,
1380 data_length);
Darryl Green9e2d7a02018-07-24 16:33:30 +01001381#else
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001382 /* We don't know how to convert a private RSA key to public. */
1383 return PSA_ERROR_NOT_SUPPORTED;
Valerio Settib2bcedb2023-07-10 11:24:00 +02001384#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT) ||
John Durkop9814fa22020-11-04 12:28:15 -08001385 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Przemek Stekiel6fd72b62023-04-27 10:20:56 +02001386 } else if (PSA_KEY_TYPE_IS_ECC(type)) {
Valerio Setti27c501a2023-06-27 16:58:52 +02001387#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_EXPORT) || \
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001388 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
1389 return mbedtls_psa_ecp_export_public_key(attributes,
1390 key_buffer,
1391 key_buffer_size,
1392 data,
1393 data_size,
1394 data_length);
Steven Cooreman560c28a2020-07-24 23:20:24 +02001395#else
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001396 /* We don't know how to convert a private ECC key to public */
1397 return PSA_ERROR_NOT_SUPPORTED;
Valerio Setti27c501a2023-06-27 16:58:52 +02001398#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_EXPORT) ||
John Durkop9814fa22020-11-04 12:28:15 -08001399 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
Przemek Stekiel6fd72b62023-04-27 10:20:56 +02001400 } else if (PSA_KEY_TYPE_IS_DH(type)) {
Valerio Settia55f0422023-07-10 15:34:41 +02001401#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_EXPORT) || \
Przemek Stekiel6d85afa2023-04-28 11:42:17 +02001402 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY)
Przemek Stekiel152bb462023-06-01 11:52:39 +02001403 return mbedtls_psa_ffdh_export_public_key(attributes,
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001404 key_buffer,
1405 key_buffer_size,
1406 data, data_size,
1407 data_length);
Przemek Stekiel472b3f32022-12-01 14:38:49 +01001408#else
Przemek Stekiel472b3f32022-12-01 14:38:49 +01001409 return PSA_ERROR_NOT_SUPPORTED;
Valerio Settia55f0422023-07-10 15:34:41 +02001410#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_EXPORT) ||
Przemek Stekiel6d85afa2023-04-28 11:42:17 +02001411 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY) */
Gilles Peskine449bd832023-01-11 14:50:10 +01001412 } else {
Przemek Stekiel0b11ee02023-05-16 13:26:06 +02001413 (void) key_buffer;
1414 (void) key_buffer_size;
1415 (void) data;
1416 (void) data_size;
1417 (void) data_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01001418 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman560c28a2020-07-24 23:20:24 +02001419 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001420}
Ronald Crond18b5f82020-11-25 16:46:05 +01001421
Gilles Peskine449bd832023-01-11 14:50:10 +01001422psa_status_t psa_export_public_key(mbedtls_svc_key_id_t key,
1423 uint8_t *data,
1424 size_t data_size,
1425 size_t *data_length)
Moran Pekerdd4ea382018-04-03 15:30:03 +03001426{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001427 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001428 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001429 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01001430 psa_key_attributes_t attributes;
Darryl Greendd8fb772018-11-07 16:00:44 +00001431
Ronald Crone907e552021-01-18 13:22:38 +01001432 /* Reject a zero-length output buffer now, since this can never be a
1433 * valid key representation. This way we know that data must be a valid
1434 * pointer and we can do things like memset(data, ..., data_size). */
Gilles Peskine449bd832023-01-11 14:50:10 +01001435 if (data_size == 0) {
1436 return PSA_ERROR_BUFFER_TOO_SMALL;
1437 }
Ronald Crone907e552021-01-18 13:22:38 +01001438
Darryl Greendd8fb772018-11-07 16:00:44 +00001439 /* Set the key to empty now, so that even when there are errors, we always
1440 * set data_length to a value between 0 and data_size. On error, setting
1441 * the key to empty is a good choice because an empty key representation is
1442 * unlikely to be accepted anywhere. */
1443 *data_length = 0;
1444
1445 /* Exporting a public key doesn't require a usage flag. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001446 status = psa_get_and_lock_key_slot_with_policy(key, &slot, 0, 0);
1447 if (status != PSA_SUCCESS) {
1448 return status;
1449 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001450
Gilles Peskine449bd832023-01-11 14:50:10 +01001451 if (!PSA_KEY_TYPE_IS_ASYMMETRIC(slot->attr.type)) {
1452 status = PSA_ERROR_INVALID_ARGUMENT;
1453 goto exit;
Ronald Cron9486f9d2020-11-26 13:36:23 +01001454 }
1455
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01001456 attributes = (psa_key_attributes_t) {
Ronald Crond18b5f82020-11-25 16:46:05 +01001457 .core = slot->attr
1458 };
Ronald Cron67227982020-11-26 15:16:05 +01001459 status = psa_driver_wrapper_export_public_key(
Ronald Crond18b5f82020-11-25 16:46:05 +01001460 &attributes, slot->key.data, slot->key.bytes,
Gilles Peskine449bd832023-01-11 14:50:10 +01001461 data, data_size, data_length);
Ronald Cron9486f9d2020-11-26 13:36:23 +01001462
1463exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01001464 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02001465
Gilles Peskine449bd832023-01-11 14:50:10 +01001466 return (status == PSA_SUCCESS) ? unlock_status : status;
Moran Pekerdd4ea382018-04-03 15:30:03 +03001467}
1468
Tom Cosgrove6ef9bb32023-03-08 14:19:51 +00001469MBEDTLS_STATIC_ASSERT(
1470 (MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE) == 0,
1471 "One or more key attribute flag is listed as both external-only and dual-use")
1472MBEDTLS_STATIC_ASSERT(
1473 (PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE) == 0,
1474 "One or more key attribute flag is listed as both internal-only and dual-use")
1475MBEDTLS_STATIC_ASSERT(
1476 (PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY) == 0,
1477 "One or more key attribute flag is listed as both internal-only and external-only")
Gilles Peskine91e8c332019-08-02 19:19:39 +02001478
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001479/** Validate that a key policy is internally well-formed.
1480 *
1481 * This function only rejects invalid policies. It does not validate the
1482 * consistency of the policy with respect to other attributes of the key
1483 * such as the key type.
1484 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001485static psa_status_t psa_validate_key_policy(const psa_key_policy_t *policy)
Gilles Peskine4747d192019-04-17 15:05:45 +02001486{
Gilles Peskine449bd832023-01-11 14:50:10 +01001487 if ((policy->usage & ~(PSA_KEY_USAGE_EXPORT |
1488 PSA_KEY_USAGE_COPY |
1489 PSA_KEY_USAGE_ENCRYPT |
1490 PSA_KEY_USAGE_DECRYPT |
1491 PSA_KEY_USAGE_SIGN_MESSAGE |
1492 PSA_KEY_USAGE_VERIFY_MESSAGE |
1493 PSA_KEY_USAGE_SIGN_HASH |
1494 PSA_KEY_USAGE_VERIFY_HASH |
1495 PSA_KEY_USAGE_VERIFY_DERIVATION |
1496 PSA_KEY_USAGE_DERIVE)) != 0) {
1497 return PSA_ERROR_INVALID_ARGUMENT;
1498 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001499
Gilles Peskine449bd832023-01-11 14:50:10 +01001500 return PSA_SUCCESS;
Gilles Peskine4747d192019-04-17 15:05:45 +02001501}
1502
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001503/** Validate the internal consistency of key attributes.
1504 *
1505 * This function only rejects invalid attribute values. If does not
1506 * validate the consistency of the attributes with any key data that may
1507 * be involved in the creation of the key.
1508 *
1509 * Call this function early in the key creation process.
1510 *
1511 * \param[in] attributes Key attributes for the new key.
1512 * \param[out] p_drv On any return, the driver for the key, if any.
1513 * NULL for a transparent key.
1514 *
1515 */
1516static psa_status_t psa_validate_key_attributes(
1517 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01001518 psa_se_drv_table_entry_t **p_drv)
Darryl Green0c6575a2018-11-07 16:05:30 +00001519{
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001520 psa_status_t status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine449bd832023-01-11 14:50:10 +01001521 psa_key_lifetime_t lifetime = psa_get_key_lifetime(attributes);
1522 mbedtls_svc_key_id_t key = psa_get_key_id(attributes);
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001523
Gilles Peskine449bd832023-01-11 14:50:10 +01001524 status = psa_validate_key_location(lifetime, p_drv);
1525 if (status != PSA_SUCCESS) {
1526 return status;
Ronald Crond2ed4812020-07-17 16:11:30 +02001527 }
1528
Gilles Peskine449bd832023-01-11 14:50:10 +01001529 status = psa_validate_key_persistence(lifetime);
1530 if (status != PSA_SUCCESS) {
1531 return status;
1532 }
1533
1534 if (PSA_KEY_LIFETIME_IS_VOLATILE(lifetime)) {
1535 if (MBEDTLS_SVC_KEY_ID_GET_KEY_ID(key) != 0) {
1536 return PSA_ERROR_INVALID_ARGUMENT;
1537 }
1538 } else {
1539 if (!psa_is_valid_key_id(psa_get_key_id(attributes), 0)) {
1540 return PSA_ERROR_INVALID_ARGUMENT;
1541 }
1542 }
1543
1544 status = psa_validate_key_policy(&attributes->core.policy);
1545 if (status != PSA_SUCCESS) {
1546 return status;
1547 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001548
1549 /* Refuse to create overly large keys.
1550 * Note that this doesn't trigger on import if the attributes don't
1551 * explicitly specify a size (so psa_get_key_bits returns 0), so
1552 * psa_import_key() needs its own checks. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001553 if (psa_get_key_bits(attributes) > PSA_MAX_KEY_BITS) {
1554 return PSA_ERROR_NOT_SUPPORTED;
1555 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001556
Gilles Peskine91e8c332019-08-02 19:19:39 +02001557 /* Reject invalid flags. These should not be reachable through the API. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001558 if (attributes->core.flags & ~(MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1559 MBEDTLS_PSA_KA_MASK_DUAL_USE)) {
1560 return PSA_ERROR_INVALID_ARGUMENT;
1561 }
Gilles Peskine91e8c332019-08-02 19:19:39 +02001562
Gilles Peskine449bd832023-01-11 14:50:10 +01001563 return PSA_SUCCESS;
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001564}
1565
Gilles Peskine4747d192019-04-17 15:05:45 +02001566/** Prepare a key slot to receive key material.
1567 *
1568 * This function allocates a key slot and sets its metadata.
1569 *
1570 * If this function fails, call psa_fail_key_creation().
1571 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001572 * This function is intended to be used as follows:
1573 * -# Call psa_start_key_creation() to allocate a key slot, prepare
Ronald Croncf56a0a2020-08-04 09:51:30 +02001574 * it with the specified attributes, and in case of a volatile key assign it
1575 * a volatile key identifier.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001576 * -# Populate the slot with the key material.
1577 * -# Call psa_finish_key_creation() to finalize the creation of the slot.
1578 * In case of failure at any step, stop the sequence and call
1579 * psa_fail_key_creation().
1580 *
Ryan Everettb69118e2024-01-02 15:54:32 +00001581 * On success, the key slot's state is PSA_SLOT_FILLING.
1582 * It is the responsibility of the caller to change the slot's state to
1583 * PSA_SLOT_EMPTY/FULL once key creation has finished.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001584 *
Gilles Peskinedf179142019-07-15 22:02:14 +02001585 * \param method An identification of the calling function.
Gilles Peskine011e4282019-06-26 18:34:38 +02001586 * \param[in] attributes Key attributes for the new key.
Gilles Peskine011e4282019-06-26 18:34:38 +02001587 * \param[out] p_slot On success, a pointer to the prepared slot.
1588 * \param[out] p_drv On any return, the driver for the key, if any.
1589 * NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001590 *
1591 * \retval #PSA_SUCCESS
1592 * The key slot is ready to receive key material.
1593 * \return If this function fails, the key slot is an invalid state.
1594 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001595 */
1596static psa_status_t psa_start_key_creation(
Gilles Peskinedf179142019-07-15 22:02:14 +02001597 psa_key_creation_method_t method,
Gilles Peskine4747d192019-04-17 15:05:45 +02001598 const psa_key_attributes_t *attributes,
Gilles Peskine011e4282019-06-26 18:34:38 +02001599 psa_key_slot_t **p_slot,
Gilles Peskine449bd832023-01-11 14:50:10 +01001600 psa_se_drv_table_entry_t **p_drv)
Gilles Peskine4747d192019-04-17 15:05:45 +02001601{
1602 psa_status_t status;
Ronald Cron2a993152020-07-17 14:13:26 +02001603 psa_key_id_t volatile_key_id;
Gilles Peskine4747d192019-04-17 15:05:45 +02001604 psa_key_slot_t *slot;
1605
Gilles Peskinedf179142019-07-15 22:02:14 +02001606 (void) method;
Gilles Peskine011e4282019-06-26 18:34:38 +02001607 *p_drv = NULL;
1608
Gilles Peskine449bd832023-01-11 14:50:10 +01001609 status = psa_validate_key_attributes(attributes, p_drv);
1610 if (status != PSA_SUCCESS) {
1611 return status;
1612 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001613
Ryan Everettb69118e2024-01-02 15:54:32 +00001614 status = psa_reserve_free_key_slot(&volatile_key_id, p_slot);
Gilles Peskine449bd832023-01-11 14:50:10 +01001615 if (status != PSA_SUCCESS) {
1616 return status;
1617 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001618 slot = *p_slot;
1619
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001620 /* We're storing the declared bit-size of the key. It's up to each
1621 * creation mechanism to verify that this information is correct.
1622 * It's automatically correct for mechanisms that use the bit-size as
Gilles Peskineb46bef22019-07-30 21:32:04 +02001623 * an input (generate, device) but not for those where the bit-size
Ronald Cronc4d1b512020-07-31 11:26:37 +02001624 * is optional (import, copy). In case of a volatile key, assign it the
1625 * volatile key identifier associated to the slot returned to contain its
1626 * definition. */
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001627
1628 slot->attr = attributes->core;
Gilles Peskine449bd832023-01-11 14:50:10 +01001629 if (PSA_KEY_LIFETIME_IS_VOLATILE(slot->attr.lifetime)) {
Ronald Cronc4d1b512020-07-31 11:26:37 +02001630#if !defined(MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER)
1631 slot->attr.id = volatile_key_id;
1632#else
1633 slot->attr.id.key_id = volatile_key_id;
1634#endif
1635 }
Gilles Peskinec744d992019-07-30 17:26:54 +02001636
Gilles Peskine91e8c332019-08-02 19:19:39 +02001637 /* Erase external-only flags from the internal copy. To access
Gilles Peskine013f5472019-08-07 15:42:14 +02001638 * external-only flags, query `attributes`. Thanks to the check
1639 * in psa_validate_key_attributes(), this leaves the dual-use
Ryan Everettb69118e2024-01-02 15:54:32 +00001640 * flags and any internal flag that psa_reserve_free_key_slot()
Gilles Peskine013f5472019-08-07 15:42:14 +02001641 * may have set. */
1642 slot->attr.flags &= ~MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY;
Gilles Peskine91e8c332019-08-02 19:19:39 +02001643
Gilles Peskinecbaff462019-07-12 23:46:04 +02001644#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001645 /* For a key in a secure element, we need to do three things
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001646 * when creating or registering a persistent key:
Gilles Peskine60450a42019-07-25 11:32:45 +02001647 * create the key file in internal storage, create the
1648 * key inside the secure element, and update the driver's
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001649 * persistent data. This is done by starting a transaction that will
1650 * encompass these three actions.
1651 * For registering a volatile key, we just need to find an appropriate
1652 * slot number inside the SE. Since the key is designated volatile, creating
1653 * a transaction is not required. */
Gilles Peskine60450a42019-07-25 11:32:45 +02001654 /* The first thing to do is to find a slot number for the new key.
1655 * We save the slot number in persistent storage as part of the
1656 * transaction data. It will be needed to recover if the power
1657 * fails during the key creation process, to clean up on the secure
1658 * element side after restarting. Obtaining a slot number from the
1659 * secure element driver updates its persistent state, but we do not yet
1660 * save the driver's persistent state, so that if the power fails,
Gilles Peskinefc762652019-07-22 19:30:34 +02001661 * we can roll back to a state where the key doesn't exist. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001662 if (*p_drv != NULL) {
Ronald Cronea0f8a62020-11-25 17:52:23 +01001663 psa_key_slot_number_t slot_number;
Gilles Peskine449bd832023-01-11 14:50:10 +01001664 status = psa_find_se_slot_for_key(attributes, method, *p_drv,
1665 &slot_number);
1666 if (status != PSA_SUCCESS) {
1667 return status;
1668 }
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001669
Gilles Peskine449bd832023-01-11 14:50:10 +01001670 if (!PSA_KEY_LIFETIME_IS_VOLATILE(attributes->core.lifetime)) {
1671 psa_crypto_prepare_transaction(PSA_CRYPTO_TRANSACTION_CREATE_KEY);
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001672 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001673 psa_crypto_transaction.key.slot = slot_number;
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001674 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskine449bd832023-01-11 14:50:10 +01001675 status = psa_crypto_save_transaction();
1676 if (status != PSA_SUCCESS) {
1677 (void) psa_crypto_stop_transaction();
1678 return status;
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001679 }
Gilles Peskine66be51c2019-07-25 18:02:52 +02001680 }
Ronald Cronea0f8a62020-11-25 17:52:23 +01001681
1682 status = psa_copy_key_material_into_slot(
Gilles Peskine449bd832023-01-11 14:50:10 +01001683 slot, (uint8_t *) (&slot_number), sizeof(slot_number));
Darryl Green0c6575a2018-11-07 16:05:30 +00001684 }
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001685
Gilles Peskine449bd832023-01-11 14:50:10 +01001686 if (*p_drv == NULL && method == PSA_KEY_CREATION_REGISTER) {
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001687 /* Key registration only makes sense with a secure element. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001688 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001689 }
Gilles Peskinecbaff462019-07-12 23:46:04 +02001690#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1691
Gilles Peskine449bd832023-01-11 14:50:10 +01001692 return PSA_SUCCESS;
Darryl Green0c6575a2018-11-07 16:05:30 +00001693}
Gilles Peskine4747d192019-04-17 15:05:45 +02001694
1695/** Finalize the creation of a key once its key material has been set.
1696 *
1697 * This entails writing the key to persistent storage.
1698 *
1699 * If this function fails, call psa_fail_key_creation().
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001700 * See the documentation of psa_start_key_creation() for the intended use
1701 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001702 *
Ryan Everettb69118e2024-01-02 15:54:32 +00001703 * If the finalization succeeds, the function sets the key slot's state to
1704 * PSA_SLOT_FULL, and the key slot can no longer be accessed as part of the
1705 * key creation process.
Ronald Cron50972942020-11-14 11:28:25 +01001706 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001707 * \param[in,out] slot Pointer to the slot with key material.
1708 * \param[in] driver The secure element driver for the key,
1709 * or NULL for a transparent key.
Ronald Cron81709fc2020-11-14 12:10:32 +01001710 * \param[out] key On success, identifier of the key. Note that the
1711 * key identifier is also stored in the key slot.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001712 *
1713 * \retval #PSA_SUCCESS
Ronald Croncf56a0a2020-08-04 09:51:30 +02001714 * The key was successfully created.
Gilles Peskineed733552023-02-14 19:21:09 +01001715 * \retval #PSA_ERROR_INSUFFICIENT_MEMORY \emptydescription
1716 * \retval #PSA_ERROR_INSUFFICIENT_STORAGE \emptydescription
1717 * \retval #PSA_ERROR_ALREADY_EXISTS \emptydescription
1718 * \retval #PSA_ERROR_DATA_INVALID \emptydescription
1719 * \retval #PSA_ERROR_DATA_CORRUPT \emptydescription
1720 * \retval #PSA_ERROR_STORAGE_FAILURE \emptydescription
Ryan Everettb69118e2024-01-02 15:54:32 +00001721 * \retval #PSA_ERROR_BAD_STATE \emptydescription
gabor-mezei-arm452b0a32020-11-09 17:42:55 +01001722 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001723 * \return If this function fails, the key slot is an invalid state.
1724 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001725 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001726static psa_status_t psa_finish_key_creation(
1727 psa_key_slot_t *slot,
Ronald Cron81709fc2020-11-14 12:10:32 +01001728 psa_se_drv_table_entry_t *driver,
1729 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02001730{
1731 psa_status_t status = PSA_SUCCESS;
Gilles Peskine30afafd2019-04-25 13:47:40 +02001732 (void) slot;
Gilles Peskine011e4282019-06-26 18:34:38 +02001733 (void) driver;
Gilles Peskine4747d192019-04-17 15:05:45 +02001734
1735#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001736 if (!PSA_KEY_LIFETIME_IS_VOLATILE(slot->attr.lifetime)) {
Gilles Peskine1df83d42019-07-23 16:13:14 +02001737#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001738 if (driver != NULL) {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001739 psa_se_key_data_storage_t data;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001740 psa_key_slot_number_t slot_number =
Gilles Peskine449bd832023-01-11 14:50:10 +01001741 psa_key_slot_get_slot_number(slot);
Ronald Cronea0f8a62020-11-25 17:52:23 +01001742
Tom Cosgrove6ef9bb32023-03-08 14:19:51 +00001743 MBEDTLS_STATIC_ASSERT(sizeof(slot_number) ==
1744 sizeof(data.slot_number),
1745 "Slot number size does not match psa_se_key_data_storage_t");
1746
Gilles Peskine449bd832023-01-11 14:50:10 +01001747 memcpy(&data.slot_number, &slot_number, sizeof(slot_number));
1748 status = psa_save_persistent_key(&slot->attr,
1749 (uint8_t *) &data,
1750 sizeof(data));
1751 } else
Gilles Peskine1df83d42019-07-23 16:13:14 +02001752#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1753 {
Steven Cooreman40120f62020-10-29 11:42:22 +01001754 /* Key material is saved in export representation in the slot, so
1755 * just pass the slot buffer for storage. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001756 status = psa_save_persistent_key(&slot->attr,
1757 slot->key.data,
1758 slot->key.bytes);
Gilles Peskine1df83d42019-07-23 16:13:14 +02001759 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001760 }
Darryl Green0c6575a2018-11-07 16:05:30 +00001761#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
1762
Gilles Peskinecbaff462019-07-12 23:46:04 +02001763#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001764 /* Finish the transaction for a key creation. This does not
1765 * happen when registering an existing key. Detect this case
1766 * by checking whether a transaction is in progress (actual
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001767 * creation of a persistent key in a secure element requires a transaction,
1768 * but registration or volatile key creation doesn't use one). */
Gilles Peskine449bd832023-01-11 14:50:10 +01001769 if (driver != NULL &&
1770 psa_crypto_transaction.unknown.type == PSA_CRYPTO_TRANSACTION_CREATE_KEY) {
1771 status = psa_save_se_persistent_data(driver);
1772 if (status != PSA_SUCCESS) {
1773 psa_destroy_persistent_key(slot->attr.id);
1774 return status;
Gilles Peskinecbaff462019-07-12 23:46:04 +02001775 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001776 status = psa_crypto_stop_transaction();
Gilles Peskinecbaff462019-07-12 23:46:04 +02001777 }
1778#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1779
Gilles Peskine449bd832023-01-11 14:50:10 +01001780 if (status == PSA_SUCCESS) {
Ronald Cron81709fc2020-11-14 12:10:32 +01001781 *key = slot->attr.id;
Ryan Everettb69118e2024-01-02 15:54:32 +00001782 status = psa_key_slot_state_transition(slot, PSA_SLOT_FILLING,
1783 PSA_SLOT_FULL);
Gilles Peskine449bd832023-01-11 14:50:10 +01001784 if (status != PSA_SUCCESS) {
Ronald Cron81709fc2020-11-14 12:10:32 +01001785 *key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01001786 }
Ronald Cron81709fc2020-11-14 12:10:32 +01001787 }
Ronald Cron50972942020-11-14 11:28:25 +01001788
Gilles Peskine449bd832023-01-11 14:50:10 +01001789 return status;
Gilles Peskine4747d192019-04-17 15:05:45 +02001790}
1791
1792/** Abort the creation of a key.
1793 *
1794 * You may call this function after calling psa_start_key_creation(),
1795 * or after psa_finish_key_creation() fails. In other circumstances, this
1796 * function may not clean up persistent storage.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001797 * See the documentation of psa_start_key_creation() for the intended use
Ryan Everettb69118e2024-01-02 15:54:32 +00001798 * of this function. Sets the slot's state to PSA_SLOT_EMPTY.
Gilles Peskine4747d192019-04-17 15:05:45 +02001799 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001800 * \param[in,out] slot Pointer to the slot with key material.
1801 * \param[in] driver The secure element driver for the key,
1802 * or NULL for a transparent key.
Gilles Peskine4747d192019-04-17 15:05:45 +02001803 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001804static void psa_fail_key_creation(psa_key_slot_t *slot,
1805 psa_se_drv_table_entry_t *driver)
Gilles Peskine4747d192019-04-17 15:05:45 +02001806{
Gilles Peskine011e4282019-06-26 18:34:38 +02001807 (void) driver;
1808
Gilles Peskine449bd832023-01-11 14:50:10 +01001809 if (slot == NULL) {
Gilles Peskine4747d192019-04-17 15:05:45 +02001810 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01001811 }
Gilles Peskine011e4282019-06-26 18:34:38 +02001812
1813#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001814 /* TODO: If the key has already been created in the secure
Gilles Peskine011e4282019-06-26 18:34:38 +02001815 * element, and the failure happened later (when saving metadata
1816 * to internal storage), we need to destroy the key in the secure
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001817 * element.
1818 * https://github.com/ARMmbed/mbed-crypto/issues/217
1819 */
Gilles Peskinefc762652019-07-22 19:30:34 +02001820
Gilles Peskined7729582019-08-05 15:55:54 +02001821 /* Abort the ongoing transaction if any (there may not be one if
1822 * the creation process failed before starting one, or if the
1823 * key creation is a registration of a key in a secure element).
1824 * Earlier functions must already have done what it takes to undo any
1825 * partial creation. All that's left is to update the transaction data
1826 * itself. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001827 (void) psa_crypto_stop_transaction();
Gilles Peskine011e4282019-06-26 18:34:38 +02001828#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1829
Ryan Everettb69118e2024-01-02 15:54:32 +00001830 /* Prepare the key slot to be wiped, and then wipe it. */
1831 slot->registered_readers = 1;
1832 psa_key_slot_state_transition(slot, PSA_SLOT_FILLING,
1833 PSA_SLOT_PENDING_DELETION);
1834
Gilles Peskine449bd832023-01-11 14:50:10 +01001835 psa_wipe_key_slot(slot);
Gilles Peskine4747d192019-04-17 15:05:45 +02001836}
1837
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001838/** Validate optional attributes during key creation.
1839 *
1840 * Some key attributes are optional during key creation. If they are
1841 * specified in the attributes structure, check that they are consistent
1842 * with the data in the slot.
1843 *
1844 * This function should be called near the end of key creation, after
1845 * the slot in memory is fully populated but before saving persistent data.
1846 */
1847static psa_status_t psa_validate_optional_attributes(
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001848 const psa_key_slot_t *slot,
Gilles Peskine449bd832023-01-11 14:50:10 +01001849 const psa_key_attributes_t *attributes)
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001850{
Gilles Peskine449bd832023-01-11 14:50:10 +01001851 if (attributes->core.type != 0) {
1852 if (attributes->core.type != slot->attr.type) {
1853 return PSA_ERROR_INVALID_ARGUMENT;
1854 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001855 }
1856
Gilles Peskine449bd832023-01-11 14:50:10 +01001857 if (attributes->domain_parameters_size != 0) {
Valerio Settib2bcedb2023-07-10 11:24:00 +02001858#if (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) && \
1859 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01001860 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
1861 if (PSA_KEY_TYPE_IS_RSA(slot->attr.type)) {
Steven Cooremana2371e52020-07-28 14:30:39 +02001862 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman75b74362020-07-28 14:30:13 +02001863 mbedtls_mpi actual, required;
Steven Cooreman6d839f02020-07-30 11:36:45 +02001864 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooremana01795d2020-07-24 22:48:15 +02001865
Ronald Cron90857082020-11-25 14:58:33 +01001866 psa_status_t status = mbedtls_psa_rsa_load_representation(
Gilles Peskine449bd832023-01-11 14:50:10 +01001867 slot->attr.type,
1868 slot->key.data,
1869 slot->key.bytes,
1870 &rsa);
1871 if (status != PSA_SUCCESS) {
1872 return status;
1873 }
Steven Cooreman75b74362020-07-28 14:30:13 +02001874
Gilles Peskine449bd832023-01-11 14:50:10 +01001875 mbedtls_mpi_init(&actual);
1876 mbedtls_mpi_init(&required);
1877 ret = mbedtls_rsa_export(rsa,
1878 NULL, NULL, NULL, NULL, &actual);
1879 mbedtls_rsa_free(rsa);
1880 mbedtls_free(rsa);
1881 if (ret != 0) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001882 goto rsa_exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001883 }
1884 ret = mbedtls_mpi_read_binary(&required,
1885 attributes->domain_parameters,
1886 attributes->domain_parameters_size);
1887 if (ret != 0) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001888 goto rsa_exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001889 }
1890 if (mbedtls_mpi_cmp_mpi(&actual, &required) != 0) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001891 ret = MBEDTLS_ERR_RSA_BAD_INPUT_DATA;
Gilles Peskine449bd832023-01-11 14:50:10 +01001892 }
1893rsa_exit:
1894 mbedtls_mpi_free(&actual);
1895 mbedtls_mpi_free(&required);
1896 if (ret != 0) {
1897 return mbedtls_to_psa_error(ret);
1898 }
1899 } else
Valerio Settib2bcedb2023-07-10 11:24:00 +02001900#endif /* (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) &&
1901 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) ||
John Durkop9814fa22020-11-04 12:28:15 -08001902 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001903 {
Gilles Peskine449bd832023-01-11 14:50:10 +01001904 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001905 }
1906 }
1907
Gilles Peskine449bd832023-01-11 14:50:10 +01001908 if (attributes->core.bits != 0) {
1909 if (attributes->core.bits != slot->attr.bits) {
1910 return PSA_ERROR_INVALID_ARGUMENT;
1911 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001912 }
1913
Gilles Peskine449bd832023-01-11 14:50:10 +01001914 return PSA_SUCCESS;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001915}
1916
Gilles Peskine449bd832023-01-11 14:50:10 +01001917psa_status_t psa_import_key(const psa_key_attributes_t *attributes,
1918 const uint8_t *data,
1919 size_t data_length,
1920 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02001921{
1922 psa_status_t status;
1923 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001924 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001925 size_t bits;
Archanad8a83dc2021-06-14 10:04:16 +05301926 size_t storage_size = data_length;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001927
Ronald Cron81709fc2020-11-14 12:10:32 +01001928 *key = MBEDTLS_SVC_KEY_ID_INIT;
1929
Gilles Peskine0f84d622019-09-12 19:03:13 +02001930 /* Reject zero-length symmetric keys (including raw data key objects).
1931 * This also rejects any key which might be encoded as an empty string,
1932 * which is never valid. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001933 if (data_length == 0) {
1934 return PSA_ERROR_INVALID_ARGUMENT;
1935 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02001936
Archana449608b2021-09-08 15:36:05 +05301937 /* Ensure that the bytes-to-bits conversion cannot overflow. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001938 if (data_length > SIZE_MAX / 8) {
1939 return PSA_ERROR_NOT_SUPPORTED;
1940 }
Archana6ed4bda2021-08-04 10:47:15 +05301941
Gilles Peskine449bd832023-01-11 14:50:10 +01001942 status = psa_start_key_creation(PSA_KEY_CREATION_IMPORT, attributes,
1943 &slot, &driver);
1944 if (status != PSA_SUCCESS) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001945 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001946 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001947
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001948 /* In the case of a transparent key or an opaque key stored in local
Archana449608b2021-09-08 15:36:05 +05301949 * storage ( thus not in the case of importing a key in a secure element
1950 * with storage ( MBEDTLS_PSA_CRYPTO_SE_C ) ),we have to allocate a
1951 * buffer to hold the imported key material. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001952 if (slot->key.data == NULL) {
1953 if (psa_key_lifetime_is_external(attributes->core.lifetime)) {
Archana449608b2021-09-08 15:36:05 +05301954 status = psa_driver_wrapper_get_key_buffer_size_from_key_data(
Gilles Peskine449bd832023-01-11 14:50:10 +01001955 attributes, data, data_length, &storage_size);
1956 if (status != PSA_SUCCESS) {
Archanad8a83dc2021-06-14 10:04:16 +05301957 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001958 }
Archanad8a83dc2021-06-14 10:04:16 +05301959 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001960 status = psa_allocate_buffer_to_slot(slot, storage_size);
1961 if (status != PSA_SUCCESS) {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001962 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001963 }
Gilles Peskine5d309672019-07-12 23:47:28 +02001964 }
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001965
1966 bits = slot->attr.bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01001967 status = psa_driver_wrapper_import_key(attributes,
1968 data, data_length,
1969 slot->key.data,
1970 slot->key.bytes,
1971 &slot->key.bytes, &bits);
1972 if (status != PSA_SUCCESS) {
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001973 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001974 }
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001975
Gilles Peskine449bd832023-01-11 14:50:10 +01001976 if (slot->attr.bits == 0) {
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001977 slot->attr.bits = (psa_key_bits_t) bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01001978 } else if (bits != slot->attr.bits) {
Steven Cooremanac3434f2021-01-15 17:36:02 +01001979 status = PSA_ERROR_INVALID_ARGUMENT;
1980 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02001981 }
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01001982
Archana6ed4bda2021-08-04 10:47:15 +05301983 /* Enforce a size limit, and in particular ensure that the bit
1984 * size fits in its representation type.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01001985 if (bits > PSA_MAX_KEY_BITS) {
Archana6ed4bda2021-08-04 10:47:15 +05301986 status = PSA_ERROR_NOT_SUPPORTED;
1987 goto exit;
1988 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001989 status = psa_validate_optional_attributes(slot, attributes);
1990 if (status != PSA_SUCCESS) {
Gilles Peskine18017402019-07-24 20:25:59 +02001991 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001992 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001993
Gilles Peskine449bd832023-01-11 14:50:10 +01001994 status = psa_finish_key_creation(slot, driver, key);
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001995exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01001996 if (status != PSA_SUCCESS) {
1997 psa_fail_key_creation(slot, driver);
1998 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001999
Gilles Peskine449bd832023-01-11 14:50:10 +01002000 return status;
Gilles Peskine4747d192019-04-17 15:05:45 +02002001}
2002
Gilles Peskined7729582019-08-05 15:55:54 +02002003#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2004psa_status_t mbedtls_psa_register_se_key(
Gilles Peskine449bd832023-01-11 14:50:10 +01002005 const psa_key_attributes_t *attributes)
Gilles Peskined7729582019-08-05 15:55:54 +02002006{
2007 psa_status_t status;
2008 psa_key_slot_t *slot = NULL;
2009 psa_se_drv_table_entry_t *driver = NULL;
Ronald Croncf56a0a2020-08-04 09:51:30 +02002010 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskined7729582019-08-05 15:55:54 +02002011
2012 /* Leaving attributes unspecified is not currently supported.
2013 * It could make sense to query the key type and size from the
2014 * secure element, but not all secure elements support this
2015 * and the driver HAL doesn't currently support it. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002016 if (psa_get_key_type(attributes) == PSA_KEY_TYPE_NONE) {
2017 return PSA_ERROR_NOT_SUPPORTED;
2018 }
2019 if (psa_get_key_bits(attributes) == 0) {
2020 return PSA_ERROR_NOT_SUPPORTED;
2021 }
Gilles Peskined7729582019-08-05 15:55:54 +02002022
Gilles Peskine449bd832023-01-11 14:50:10 +01002023 status = psa_start_key_creation(PSA_KEY_CREATION_REGISTER, attributes,
2024 &slot, &driver);
2025 if (status != PSA_SUCCESS) {
Gilles Peskined7729582019-08-05 15:55:54 +02002026 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002027 }
Gilles Peskined7729582019-08-05 15:55:54 +02002028
Gilles Peskine449bd832023-01-11 14:50:10 +01002029 status = psa_finish_key_creation(slot, driver, &key);
Gilles Peskined7729582019-08-05 15:55:54 +02002030
2031exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002032 if (status != PSA_SUCCESS) {
2033 psa_fail_key_creation(slot, driver);
2034 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002035
Gilles Peskined7729582019-08-05 15:55:54 +02002036 /* Registration doesn't keep the key in RAM. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002037 psa_close_key(key);
2038 return status;
Gilles Peskined7729582019-08-05 15:55:54 +02002039}
2040#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2041
Gilles Peskine449bd832023-01-11 14:50:10 +01002042psa_status_t psa_copy_key(mbedtls_svc_key_id_t source_key,
2043 const psa_key_attributes_t *specified_attributes,
2044 mbedtls_svc_key_id_t *target_key)
Gilles Peskinef603c712019-01-19 13:40:11 +01002045{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002046 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01002047 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinef603c712019-01-19 13:40:11 +01002048 psa_key_slot_t *source_slot = NULL;
2049 psa_key_slot_t *target_slot = NULL;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002050 psa_key_attributes_t actual_attributes = *specified_attributes;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002051 psa_se_drv_table_entry_t *driver = NULL;
Archana8a180362021-07-05 02:18:48 +05302052 size_t storage_size = 0;
Gilles Peskinef603c712019-01-19 13:40:11 +01002053
Ronald Cron81709fc2020-11-14 12:10:32 +01002054 *target_key = MBEDTLS_SVC_KEY_ID_INIT;
2055
Archana8a180362021-07-05 02:18:48 +05302056 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002057 source_key, &source_slot, PSA_KEY_USAGE_COPY, 0);
2058 if (status != PSA_SUCCESS) {
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002059 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002060 }
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002061
Gilles Peskine449bd832023-01-11 14:50:10 +01002062 status = psa_validate_optional_attributes(source_slot,
2063 specified_attributes);
2064 if (status != PSA_SUCCESS) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002065 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002066 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002067
Archana9d17bf42021-09-10 06:22:44 +05302068 /* The target key type and number of bits have been validated by
2069 * psa_validate_optional_attributes() to be either equal to zero or
2070 * equal to the ones of the source key. So it is safe to inherit
2071 * them from the source key now."
Archana374fe5b2021-09-08 15:50:28 +05302072 * */
Archana9d17bf42021-09-10 06:22:44 +05302073 actual_attributes.core.bits = source_slot->attr.bits;
2074 actual_attributes.core.type = source_slot->attr.type;
Archana374fe5b2021-09-08 15:50:28 +05302075
2076
Gilles Peskine449bd832023-01-11 14:50:10 +01002077 status = psa_restrict_key_policy(source_slot->attr.type,
2078 &actual_attributes.core.policy,
2079 &source_slot->attr.policy);
2080 if (status != PSA_SUCCESS) {
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002081 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002082 }
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002083
Gilles Peskine449bd832023-01-11 14:50:10 +01002084 status = psa_start_key_creation(PSA_KEY_CREATION_COPY, &actual_attributes,
2085 &target_slot, &driver);
2086 if (status != PSA_SUCCESS) {
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002087 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002088 }
2089 if (PSA_KEY_LIFETIME_GET_LOCATION(target_slot->attr.lifetime) !=
2090 PSA_KEY_LIFETIME_GET_LOCATION(source_slot->attr.lifetime)) {
Archana8a180362021-07-05 02:18:48 +05302091 /*
Archana9d17bf42021-09-10 06:22:44 +05302092 * If the source and target keys are stored in different locations,
Archana8a180362021-07-05 02:18:48 +05302093 * the source key would need to be exported as plaintext and re-imported
2094 * in the other location. This has security implications which have not
Archana449608b2021-09-08 15:36:05 +05302095 * been fully mapped. For now, this can be achieved through
Archana8a180362021-07-05 02:18:48 +05302096 * appropriate API invocations from the application, if needed.
2097 * */
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002098 status = PSA_ERROR_NOT_SUPPORTED;
2099 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002100 }
Archana8a180362021-07-05 02:18:48 +05302101 /*
2102 * When the source and target keys are within the same location,
Archana449608b2021-09-08 15:36:05 +05302103 * - For transparent keys it is a blind copy without any driver invocation,
Archana8a180362021-07-05 02:18:48 +05302104 * - For opaque keys this translates to an invocation of the drivers'
2105 * copy_key entry point through the dispatch layer.
2106 * */
Gilles Peskine449bd832023-01-11 14:50:10 +01002107 if (psa_key_lifetime_is_external(actual_attributes.core.lifetime)) {
2108 status = psa_driver_wrapper_get_key_buffer_size(&actual_attributes,
2109 &storage_size);
2110 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302111 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002112 }
Archana374fe5b2021-09-08 15:50:28 +05302113
Gilles Peskine449bd832023-01-11 14:50:10 +01002114 status = psa_allocate_buffer_to_slot(target_slot, storage_size);
2115 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302116 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002117 }
Archana374fe5b2021-09-08 15:50:28 +05302118
Gilles Peskine449bd832023-01-11 14:50:10 +01002119 status = psa_driver_wrapper_copy_key(&actual_attributes,
2120 source_slot->key.data,
2121 source_slot->key.bytes,
2122 target_slot->key.data,
2123 target_slot->key.bytes,
2124 &target_slot->key.bytes);
2125 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302126 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002127 }
2128 } else {
2129 status = psa_copy_key_material_into_slot(target_slot,
Archana9d17bf42021-09-10 06:22:44 +05302130 source_slot->key.data,
Gilles Peskine449bd832023-01-11 14:50:10 +01002131 source_slot->key.bytes);
2132 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302133 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002134 }
Archana8a180362021-07-05 02:18:48 +05302135 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002136 status = psa_finish_key_creation(target_slot, driver, target_key);
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002137exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002138 if (status != PSA_SUCCESS) {
2139 psa_fail_key_creation(target_slot, driver);
2140 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002141
Gilles Peskine449bd832023-01-11 14:50:10 +01002142 unlock_status = psa_unlock_key_slot(source_slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02002143
Gilles Peskine449bd832023-01-11 14:50:10 +01002144 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskinef603c712019-01-19 13:40:11 +01002145}
2146
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02002147
2148
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01002149/****************************************************************/
Gilles Peskine20035e32018-02-03 22:44:14 +01002150/* Message digests */
2151/****************************************************************/
2152
Gilles Peskine449bd832023-01-11 14:50:10 +01002153psa_status_t psa_hash_abort(psa_hash_operation_t *operation)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002154{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002155 /* Aborting a non-active operation is allowed */
Gilles Peskine449bd832023-01-11 14:50:10 +01002156 if (operation->id == 0) {
2157 return PSA_SUCCESS;
2158 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002159
Gilles Peskine449bd832023-01-11 14:50:10 +01002160 psa_status_t status = psa_driver_wrapper_hash_abort(operation);
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002161 operation->id = 0;
2162
Gilles Peskine449bd832023-01-11 14:50:10 +01002163 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002164}
2165
Gilles Peskine449bd832023-01-11 14:50:10 +01002166psa_status_t psa_hash_setup(psa_hash_operation_t *operation,
2167 psa_algorithm_t alg)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002168{
Dave Rodgman685b6a72021-06-24 11:49:14 +01002169 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002170
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002171 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002172 if (operation->id != 0) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002173 status = PSA_ERROR_BAD_STATE;
2174 goto exit;
2175 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002176
Gilles Peskine449bd832023-01-11 14:50:10 +01002177 if (!PSA_ALG_IS_HASH(alg)) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002178 status = PSA_ERROR_INVALID_ARGUMENT;
2179 goto exit;
2180 }
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002181
Steven Cooremanb6bf4bb2021-03-15 19:00:14 +01002182 /* Ensure all of the context is zeroized, since PSA_HASH_OPERATION_INIT only
2183 * directly zeroes the int-sized dummy member of the context union. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002184 memset(&operation->ctx, 0, sizeof(operation->ctx));
Steven Cooreman893232f2021-03-15 12:23:37 +01002185
Gilles Peskine449bd832023-01-11 14:50:10 +01002186 status = psa_driver_wrapper_hash_setup(operation, alg);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002187
2188exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002189 if (status != PSA_SUCCESS) {
2190 psa_hash_abort(operation);
2191 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002192
2193 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002194}
2195
Gilles Peskine449bd832023-01-11 14:50:10 +01002196psa_status_t psa_hash_update(psa_hash_operation_t *operation,
2197 const uint8_t *input,
2198 size_t input_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002199{
Dave Rodgman685b6a72021-06-24 11:49:14 +01002200 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2201
Gilles Peskine449bd832023-01-11 14:50:10 +01002202 if (operation->id == 0) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002203 status = PSA_ERROR_BAD_STATE;
2204 goto exit;
2205 }
Gilles Peskine94e44542018-07-12 16:58:43 +02002206
Steven Cooremanc8288352021-03-04 14:02:19 +01002207 /* Don't require hash implementations to behave correctly on a
2208 * zero-length input, which may have an invalid pointer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002209 if (input_length == 0) {
2210 return PSA_SUCCESS;
2211 }
Steven Cooremanc8288352021-03-04 14:02:19 +01002212
Gilles Peskine449bd832023-01-11 14:50:10 +01002213 status = psa_driver_wrapper_hash_update(operation, input, input_length);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002214
2215exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002216 if (status != PSA_SUCCESS) {
2217 psa_hash_abort(operation);
2218 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002219
Gilles Peskine449bd832023-01-11 14:50:10 +01002220 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002221}
2222
Gilles Peskine449bd832023-01-11 14:50:10 +01002223psa_status_t psa_hash_finish(psa_hash_operation_t *operation,
2224 uint8_t *hash,
2225 size_t hash_size,
2226 size_t *hash_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002227{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002228 *hash_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002229 if (operation->id == 0) {
2230 return PSA_ERROR_BAD_STATE;
2231 }
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002232
Steven Cooreman1e582352021-02-18 17:24:37 +01002233 psa_status_t status = psa_driver_wrapper_hash_finish(
Gilles Peskine449bd832023-01-11 14:50:10 +01002234 operation, hash, hash_size, hash_length);
2235 psa_hash_abort(operation);
2236 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002237}
2238
Gilles Peskine449bd832023-01-11 14:50:10 +01002239psa_status_t psa_hash_verify(psa_hash_operation_t *operation,
2240 const uint8_t *hash,
2241 size_t hash_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002242{
Ronald Cron69a63422021-10-18 09:47:58 +02002243 uint8_t actual_hash[PSA_HASH_MAX_SIZE];
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002244 size_t actual_hash_length;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002245 psa_status_t status = psa_hash_finish(
Gilles Peskine449bd832023-01-11 14:50:10 +01002246 operation,
2247 actual_hash, sizeof(actual_hash),
2248 &actual_hash_length);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002249
Gilles Peskine449bd832023-01-11 14:50:10 +01002250 if (status != PSA_SUCCESS) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002251 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002252 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002253
Gilles Peskine449bd832023-01-11 14:50:10 +01002254 if (actual_hash_length != hash_length) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002255 status = PSA_ERROR_INVALID_SIGNATURE;
2256 goto exit;
2257 }
2258
Dave Rodgman78701152023-08-29 14:20:18 +01002259 if (mbedtls_ct_memcmp(hash, actual_hash, actual_hash_length) != 0) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002260 status = PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01002261 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002262
2263exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002264 mbedtls_platform_zeroize(actual_hash, sizeof(actual_hash));
2265 if (status != PSA_SUCCESS) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002266 psa_hash_abort(operation);
Gilles Peskine449bd832023-01-11 14:50:10 +01002267 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002268
Gilles Peskine449bd832023-01-11 14:50:10 +01002269 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002270}
2271
Gilles Peskine449bd832023-01-11 14:50:10 +01002272psa_status_t psa_hash_compute(psa_algorithm_t alg,
2273 const uint8_t *input, size_t input_length,
2274 uint8_t *hash, size_t hash_size,
2275 size_t *hash_length)
Gilles Peskine0a749c82019-11-28 19:33:58 +01002276{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002277 *hash_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002278 if (!PSA_ALG_IS_HASH(alg)) {
2279 return PSA_ERROR_INVALID_ARGUMENT;
2280 }
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002281
Gilles Peskine449bd832023-01-11 14:50:10 +01002282 return psa_driver_wrapper_hash_compute(alg, input, input_length,
2283 hash, hash_size, hash_length);
Gilles Peskine0a749c82019-11-28 19:33:58 +01002284}
2285
Gilles Peskine449bd832023-01-11 14:50:10 +01002286psa_status_t psa_hash_compare(psa_algorithm_t alg,
2287 const uint8_t *input, size_t input_length,
2288 const uint8_t *hash, size_t hash_length)
Gilles Peskine0a749c82019-11-28 19:33:58 +01002289{
Ronald Cron69a63422021-10-18 09:47:58 +02002290 uint8_t actual_hash[PSA_HASH_MAX_SIZE];
Steven Cooreman84d670d2021-02-18 16:22:53 +01002291 size_t actual_hash_length;
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002292
Gilles Peskine449bd832023-01-11 14:50:10 +01002293 if (!PSA_ALG_IS_HASH(alg)) {
2294 return PSA_ERROR_INVALID_ARGUMENT;
2295 }
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002296
Steven Cooreman1e582352021-02-18 17:24:37 +01002297 psa_status_t status = psa_driver_wrapper_hash_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01002298 alg, input, input_length,
2299 actual_hash, sizeof(actual_hash),
2300 &actual_hash_length);
2301 if (status != PSA_SUCCESS) {
Gilles Peskine60aebec2021-12-13 12:33:18 +01002302 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002303 }
2304 if (actual_hash_length != hash_length) {
Gilles Peskine60aebec2021-12-13 12:33:18 +01002305 status = PSA_ERROR_INVALID_SIGNATURE;
2306 goto exit;
2307 }
Dave Rodgman78701152023-08-29 14:20:18 +01002308 if (mbedtls_ct_memcmp(hash, actual_hash, actual_hash_length) != 0) {
Gilles Peskine60aebec2021-12-13 12:33:18 +01002309 status = PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01002310 }
Gilles Peskine60aebec2021-12-13 12:33:18 +01002311
2312exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002313 mbedtls_platform_zeroize(actual_hash, sizeof(actual_hash));
2314 return status;
Gilles Peskine0a749c82019-11-28 19:33:58 +01002315}
2316
Gilles Peskine449bd832023-01-11 14:50:10 +01002317psa_status_t psa_hash_clone(const psa_hash_operation_t *source_operation,
2318 psa_hash_operation_t *target_operation)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002319{
Gilles Peskine449bd832023-01-11 14:50:10 +01002320 if (source_operation->id == 0 ||
2321 target_operation->id != 0) {
2322 return PSA_ERROR_BAD_STATE;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002323 }
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002324
Gilles Peskine449bd832023-01-11 14:50:10 +01002325 psa_status_t status = psa_driver_wrapper_hash_clone(source_operation,
2326 target_operation);
2327 if (status != PSA_SUCCESS) {
2328 psa_hash_abort(target_operation);
2329 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002330
Gilles Peskine449bd832023-01-11 14:50:10 +01002331 return status;
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002332}
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002333
2334
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002335/****************************************************************/
Gilles Peskine8c9def32018-02-08 10:02:12 +01002336/* MAC */
2337/****************************************************************/
2338
Gilles Peskine449bd832023-01-11 14:50:10 +01002339psa_status_t psa_mac_abort(psa_mac_operation_t *operation)
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002340{
Steven Cooremane6804192021-03-19 18:28:56 +01002341 /* Aborting a non-active operation is allowed */
Gilles Peskine449bd832023-01-11 14:50:10 +01002342 if (operation->id == 0) {
2343 return PSA_SUCCESS;
2344 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002345
Gilles Peskine449bd832023-01-11 14:50:10 +01002346 psa_status_t status = psa_driver_wrapper_mac_abort(operation);
Steven Cooreman72f736a2021-05-07 14:14:37 +02002347 operation->mac_size = 0;
2348 operation->is_sign = 0;
Steven Cooremane6804192021-03-19 18:28:56 +01002349 operation->id = 0;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002350
Gilles Peskine449bd832023-01-11 14:50:10 +01002351 return status;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002352}
2353
Ronald Cron2dff3b22021-06-17 16:33:22 +02002354static psa_status_t psa_mac_finalize_alg_and_key_validation(
2355 psa_algorithm_t alg,
Ronald Cron79bdd822021-06-17 16:46:44 +02002356 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01002357 uint8_t *mac_size)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002358{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002359 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002360 psa_key_type_t key_type = psa_get_key_type(attributes);
2361 size_t key_bits = psa_get_key_bits(attributes);
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002362
Gilles Peskine449bd832023-01-11 14:50:10 +01002363 if (!PSA_ALG_IS_MAC(alg)) {
2364 return PSA_ERROR_INVALID_ARGUMENT;
2365 }
Steven Cooremane6804192021-03-19 18:28:56 +01002366
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002367 /* Validate the combination of key type and algorithm */
Gilles Peskine449bd832023-01-11 14:50:10 +01002368 status = psa_mac_key_can_do(alg, key_type);
2369 if (status != PSA_SUCCESS) {
2370 return status;
2371 }
Steven Cooreman15472f82021-03-02 16:16:22 +01002372
Steven Cooremand1a68f12021-05-10 11:13:41 +02002373 /* Get the output length for the algorithm and key combination */
Gilles Peskine449bd832023-01-11 14:50:10 +01002374 *mac_size = PSA_MAC_LENGTH(key_type, key_bits, alg);
Steven Cooreman15472f82021-03-02 16:16:22 +01002375
Gilles Peskine449bd832023-01-11 14:50:10 +01002376 if (*mac_size < 4) {
Steven Cooreman15472f82021-03-02 16:16:22 +01002377 /* A very short MAC is too short for security since it can be
2378 * brute-forced. Ancient protocols with 32-bit MACs do exist,
2379 * so we make this our minimum, even though 32 bits is still
2380 * too small for security. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002381 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman15472f82021-03-02 16:16:22 +01002382 }
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02002383
Gilles Peskine449bd832023-01-11 14:50:10 +01002384 if (*mac_size > PSA_MAC_LENGTH(key_type, key_bits,
2385 PSA_ALG_FULL_LENGTH_MAC(alg))) {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002386 /* It's impossible to "truncate" to a larger length than the full length
2387 * of the algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002388 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002389 }
2390
Gilles Peskine449bd832023-01-11 14:50:10 +01002391 if (*mac_size > PSA_MAC_MAX_SIZE) {
Gilles Peskinea9b6c802022-03-16 13:54:49 +01002392 /* PSA_MAC_LENGTH returns the correct length even for a MAC algorithm
2393 * that is disabled in the compile-time configuration. The result can
2394 * therefore be larger than PSA_MAC_MAX_SIZE, which does take the
2395 * configuration into account. In this case, force a return of
2396 * PSA_ERROR_NOT_SUPPORTED here. Otherwise psa_mac_verify(), or
2397 * psa_mac_compute(mac_size=PSA_MAC_MAX_SIZE), would return
2398 * PSA_ERROR_BUFFER_TOO_SMALL for an unsupported algorithm whose MAC size
2399 * is larger than PSA_MAC_MAX_SIZE, which is misleading and which breaks
2400 * systematically generated tests. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002401 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea9b6c802022-03-16 13:54:49 +01002402 }
2403
Gilles Peskine449bd832023-01-11 14:50:10 +01002404 return PSA_SUCCESS;
Ronald Cron2dff3b22021-06-17 16:33:22 +02002405}
2406
Gilles Peskine449bd832023-01-11 14:50:10 +01002407static psa_status_t psa_mac_setup(psa_mac_operation_t *operation,
2408 mbedtls_svc_key_id_t key,
2409 psa_algorithm_t alg,
2410 int is_sign)
Gilles Peskinee59236f2018-01-27 23:32:46 +01002411{
2412 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2413 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman54648242021-06-24 11:49:45 +01002414 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002415 psa_key_attributes_t attributes;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002416
2417 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002418 if (operation->id != 0) {
Dave Rodgman54648242021-06-24 11:49:45 +01002419 status = PSA_ERROR_BAD_STATE;
2420 goto exit;
2421 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002422
2423 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002424 key,
2425 &slot,
2426 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
2427 alg);
2428 if (status != PSA_SUCCESS) {
Dave Rodgman54648242021-06-24 11:49:45 +01002429 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002430 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002431
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002432 attributes = (psa_key_attributes_t) {
Gilles Peskine8c9def32018-02-08 10:02:12 +01002433 .core = slot->attr
2434 };
2435
Gilles Peskine449bd832023-01-11 14:50:10 +01002436 status = psa_mac_finalize_alg_and_key_validation(alg, &attributes,
2437 &operation->mac_size);
2438 if (status != PSA_SUCCESS) {
Gilles Peskine8c9def32018-02-08 10:02:12 +01002439 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002440 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002441
2442 operation->is_sign = is_sign;
Steven Cooremane6804192021-03-19 18:28:56 +01002443 /* Dispatch the MAC setup call with validated input */
Gilles Peskine449bd832023-01-11 14:50:10 +01002444 if (is_sign) {
2445 status = psa_driver_wrapper_mac_sign_setup(operation,
2446 &attributes,
2447 slot->key.data,
2448 slot->key.bytes,
2449 alg);
2450 } else {
2451 status = psa_driver_wrapper_mac_verify_setup(operation,
2452 &attributes,
2453 slot->key.data,
2454 slot->key.bytes,
2455 alg);
Gilles Peskine8c9def32018-02-08 10:02:12 +01002456 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002457
Gilles Peskinefbfac682018-07-08 20:51:54 +02002458exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002459 if (status != PSA_SUCCESS) {
2460 psa_mac_abort(operation);
2461 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002462
Gilles Peskine449bd832023-01-11 14:50:10 +01002463 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02002464
Gilles Peskine449bd832023-01-11 14:50:10 +01002465 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002466}
2467
Gilles Peskine449bd832023-01-11 14:50:10 +01002468psa_status_t psa_mac_sign_setup(psa_mac_operation_t *operation,
2469 mbedtls_svc_key_id_t key,
2470 psa_algorithm_t alg)
Gilles Peskine89167cb2018-07-08 20:12:23 +02002471{
Gilles Peskine449bd832023-01-11 14:50:10 +01002472 return psa_mac_setup(operation, key, alg, 1);
Gilles Peskine89167cb2018-07-08 20:12:23 +02002473}
2474
Gilles Peskine449bd832023-01-11 14:50:10 +01002475psa_status_t psa_mac_verify_setup(psa_mac_operation_t *operation,
2476 mbedtls_svc_key_id_t key,
2477 psa_algorithm_t alg)
Gilles Peskine89167cb2018-07-08 20:12:23 +02002478{
Gilles Peskine449bd832023-01-11 14:50:10 +01002479 return psa_mac_setup(operation, key, alg, 0);
Gilles Peskine89167cb2018-07-08 20:12:23 +02002480}
2481
Gilles Peskine449bd832023-01-11 14:50:10 +01002482psa_status_t psa_mac_update(psa_mac_operation_t *operation,
2483 const uint8_t *input,
2484 size_t input_length)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002485{
Gilles Peskine449bd832023-01-11 14:50:10 +01002486 if (operation->id == 0) {
2487 return PSA_ERROR_BAD_STATE;
2488 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002489
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002490 /* Don't require hash implementations to behave correctly on a
2491 * zero-length input, which may have an invalid pointer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002492 if (input_length == 0) {
2493 return PSA_SUCCESS;
2494 }
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03002495
Gilles Peskine449bd832023-01-11 14:50:10 +01002496 psa_status_t status = psa_driver_wrapper_mac_update(operation,
2497 input, input_length);
2498 if (status != PSA_SUCCESS) {
2499 psa_mac_abort(operation);
2500 }
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002501
Gilles Peskine449bd832023-01-11 14:50:10 +01002502 return status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002503}
2504
Gilles Peskine449bd832023-01-11 14:50:10 +01002505psa_status_t psa_mac_sign_finish(psa_mac_operation_t *operation,
2506 uint8_t *mac,
2507 size_t mac_size,
2508 size_t *mac_length)
mohammad16036df908f2018-04-02 08:34:15 -07002509{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002510 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2511 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002512
Gilles Peskine449bd832023-01-11 14:50:10 +01002513 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002514 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002515 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002516 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002517
Gilles Peskine449bd832023-01-11 14:50:10 +01002518 if (!operation->is_sign) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002519 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002520 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002521 }
Steven Cooreman72f736a2021-05-07 14:14:37 +02002522
Steven Cooreman8af5c5c2021-05-11 11:09:13 +02002523 /* Sanity check. This will guarantee that mac_size != 0 (and so mac != NULL)
2524 * once all the error checks are done. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002525 if (operation->mac_size == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002526 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002527 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002528 }
Steven Cooreman8af5c5c2021-05-11 11:09:13 +02002529
Gilles Peskine449bd832023-01-11 14:50:10 +01002530 if (mac_size < operation->mac_size) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002531 status = PSA_ERROR_BUFFER_TOO_SMALL;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002532 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002533 }
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002534
Gilles Peskine449bd832023-01-11 14:50:10 +01002535 status = psa_driver_wrapper_mac_sign_finish(operation,
2536 mac, operation->mac_size,
2537 mac_length);
Steven Cooreman72f736a2021-05-07 14:14:37 +02002538
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002539exit:
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002540 /* In case of success, set the potential excess room in the output buffer
2541 * to an invalid value, to avoid potentially leaking a longer MAC.
2542 * In case of error, set the output length and content to a safe default,
2543 * such that in case the caller misses an error check, the output would be
2544 * an unachievable MAC.
2545 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002546 if (status != PSA_SUCCESS) {
Steven Cooreman72f736a2021-05-07 14:14:37 +02002547 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002548 operation->mac_size = 0;
Steven Cooreman72f736a2021-05-07 14:14:37 +02002549 }
mohammad16036df908f2018-04-02 08:34:15 -07002550
Paul Elliottdc42ca82023-02-24 18:11:59 +00002551 psa_wipe_tag_output_buffer(mac, status, mac_size, *mac_length);
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002552
Gilles Peskine449bd832023-01-11 14:50:10 +01002553 abort_status = psa_mac_abort(operation);
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002554
Gilles Peskine449bd832023-01-11 14:50:10 +01002555 return status == PSA_SUCCESS ? abort_status : status;
mohammad16036df908f2018-04-02 08:34:15 -07002556}
2557
Gilles Peskine449bd832023-01-11 14:50:10 +01002558psa_status_t psa_mac_verify_finish(psa_mac_operation_t *operation,
2559 const uint8_t *mac,
2560 size_t mac_length)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002561{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002562 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2563 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002564
Gilles Peskine449bd832023-01-11 14:50:10 +01002565 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002566 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002567 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002568 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002569
Gilles Peskine449bd832023-01-11 14:50:10 +01002570 if (operation->is_sign) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002571 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002572 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002573 }
Steven Cooreman72f736a2021-05-07 14:14:37 +02002574
Gilles Peskine449bd832023-01-11 14:50:10 +01002575 if (operation->mac_size != mac_length) {
Steven Cooreman72f736a2021-05-07 14:14:37 +02002576 status = PSA_ERROR_INVALID_SIGNATURE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002577 goto exit;
Steven Cooreman72f736a2021-05-07 14:14:37 +02002578 }
2579
Gilles Peskine449bd832023-01-11 14:50:10 +01002580 status = psa_driver_wrapper_mac_verify_finish(operation,
2581 mac, mac_length);
Steven Cooreman72f736a2021-05-07 14:14:37 +02002582
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002583exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002584 abort_status = psa_mac_abort(operation);
mohammad16036df908f2018-04-02 08:34:15 -07002585
Gilles Peskine449bd832023-01-11 14:50:10 +01002586 return status == PSA_SUCCESS ? abort_status : status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002587}
2588
Gilles Peskine449bd832023-01-11 14:50:10 +01002589static psa_status_t psa_mac_compute_internal(mbedtls_svc_key_id_t key,
2590 psa_algorithm_t alg,
2591 const uint8_t *input,
2592 size_t input_length,
2593 uint8_t *mac,
2594 size_t mac_size,
2595 size_t *mac_length,
2596 int is_sign)
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002597{
2598 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron51131b52021-06-17 17:17:20 +02002599 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2600 psa_key_slot_t *slot;
2601 uint8_t operation_mac_size = 0;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002602 psa_key_attributes_t attributes;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002603
Ronald Cron51131b52021-06-17 17:17:20 +02002604 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002605 key,
2606 &slot,
2607 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
2608 alg);
2609 if (status != PSA_SUCCESS) {
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002610 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002611 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002612
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002613 attributes = (psa_key_attributes_t) {
Ronald Cron51131b52021-06-17 17:17:20 +02002614 .core = slot->attr
2615 };
2616
Gilles Peskine449bd832023-01-11 14:50:10 +01002617 status = psa_mac_finalize_alg_and_key_validation(alg, &attributes,
2618 &operation_mac_size);
2619 if (status != PSA_SUCCESS) {
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002620 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002621 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002622
Gilles Peskine449bd832023-01-11 14:50:10 +01002623 if (mac_size < operation_mac_size) {
Ronald Cron51131b52021-06-17 17:17:20 +02002624 status = PSA_ERROR_BUFFER_TOO_SMALL;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002625 goto exit;
Ronald Cron51131b52021-06-17 17:17:20 +02002626 }
2627
2628 status = psa_driver_wrapper_mac_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01002629 &attributes,
2630 slot->key.data, slot->key.bytes,
2631 alg,
2632 input, input_length,
2633 mac, operation_mac_size, mac_length);
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002634
2635exit:
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002636 /* In case of success, set the potential excess room in the output buffer
2637 * to an invalid value, to avoid potentially leaking a longer MAC.
2638 * In case of error, set the output length and content to a safe default,
2639 * such that in case the caller misses an error check, the output would be
2640 * an unachievable MAC.
2641 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002642 if (status != PSA_SUCCESS) {
Ronald Cron51131b52021-06-17 17:17:20 +02002643 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002644 operation_mac_size = 0;
Ronald Cron51131b52021-06-17 17:17:20 +02002645 }
Paul Elliottdc42ca82023-02-24 18:11:59 +00002646
2647 psa_wipe_tag_output_buffer(mac, status, mac_size, *mac_length);
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002648
Gilles Peskine449bd832023-01-11 14:50:10 +01002649 unlock_status = psa_unlock_key_slot(slot);
Ronald Cron51131b52021-06-17 17:17:20 +02002650
Gilles Peskine449bd832023-01-11 14:50:10 +01002651 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002652}
2653
Gilles Peskine449bd832023-01-11 14:50:10 +01002654psa_status_t psa_mac_compute(mbedtls_svc_key_id_t key,
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002655 psa_algorithm_t alg,
2656 const uint8_t *input,
2657 size_t input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002658 uint8_t *mac,
2659 size_t mac_size,
2660 size_t *mac_length)
2661{
2662 return psa_mac_compute_internal(key, alg,
2663 input, input_length,
2664 mac, mac_size, mac_length, 1);
2665}
2666
2667psa_status_t psa_mac_verify(mbedtls_svc_key_id_t key,
2668 psa_algorithm_t alg,
2669 const uint8_t *input,
2670 size_t input_length,
2671 const uint8_t *mac,
2672 size_t mac_length)
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002673{
2674 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Crona587cbc2021-06-18 14:51:29 +02002675 uint8_t actual_mac[PSA_MAC_MAX_SIZE];
2676 size_t actual_mac_length;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002677
Gilles Peskine449bd832023-01-11 14:50:10 +01002678 status = psa_mac_compute_internal(key, alg,
2679 input, input_length,
2680 actual_mac, sizeof(actual_mac),
2681 &actual_mac_length, 0);
2682 if (status != PSA_SUCCESS) {
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002683 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002684 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002685
Gilles Peskine449bd832023-01-11 14:50:10 +01002686 if (mac_length != actual_mac_length) {
Ronald Crona587cbc2021-06-18 14:51:29 +02002687 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002688 goto exit;
Ronald Crona587cbc2021-06-18 14:51:29 +02002689 }
Dave Rodgman78701152023-08-29 14:20:18 +01002690 if (mbedtls_ct_memcmp(mac, actual_mac, actual_mac_length) != 0) {
Ronald Crona587cbc2021-06-18 14:51:29 +02002691 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002692 goto exit;
Ronald Crona587cbc2021-06-18 14:51:29 +02002693 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002694
2695exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002696 mbedtls_platform_zeroize(actual_mac, sizeof(actual_mac));
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002697
Gilles Peskine449bd832023-01-11 14:50:10 +01002698 return status;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002699}
Gilles Peskinee59236f2018-01-27 23:32:46 +01002700
Gilles Peskinee59236f2018-01-27 23:32:46 +01002701/****************************************************************/
2702/* Asymmetric cryptography */
2703/****************************************************************/
2704
Gilles Peskine449bd832023-01-11 14:50:10 +01002705static psa_status_t psa_sign_verify_check_alg(int input_is_message,
2706 psa_algorithm_t alg)
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002707{
Gilles Peskine449bd832023-01-11 14:50:10 +01002708 if (input_is_message) {
2709 if (!PSA_ALG_IS_SIGN_MESSAGE(alg)) {
2710 return PSA_ERROR_INVALID_ARGUMENT;
2711 }
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002712
Gilles Peskine449bd832023-01-11 14:50:10 +01002713 if (PSA_ALG_IS_SIGN_HASH(alg)) {
2714 if (!PSA_ALG_IS_HASH(PSA_ALG_SIGN_GET_HASH(alg))) {
2715 return PSA_ERROR_INVALID_ARGUMENT;
2716 }
2717 }
2718 } else {
2719 if (!PSA_ALG_IS_SIGN_HASH(alg)) {
2720 return PSA_ERROR_INVALID_ARGUMENT;
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002721 }
2722 }
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002723
Gilles Peskine449bd832023-01-11 14:50:10 +01002724 return PSA_SUCCESS;
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002725}
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002726
Gilles Peskine449bd832023-01-11 14:50:10 +01002727static psa_status_t psa_sign_internal(mbedtls_svc_key_id_t key,
2728 int input_is_message,
2729 psa_algorithm_t alg,
2730 const uint8_t *input,
2731 size_t input_length,
2732 uint8_t *signature,
2733 size_t signature_size,
2734 size_t *signature_length)
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002735{
2736 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2737 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2738 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002739 psa_key_attributes_t attributes;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002740
2741 *signature_length = 0;
2742
Gilles Peskine449bd832023-01-11 14:50:10 +01002743 status = psa_sign_verify_check_alg(input_is_message, alg);
2744 if (status != PSA_SUCCESS) {
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002745 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002746 }
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002747
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002748 /* Immediately reject a zero-length signature buffer. This guarantees
gabor-mezei-arm12b4f342021-05-05 13:54:55 +02002749 * that signature must be a valid pointer. (On the other hand, the input
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002750 * buffer can in principle be empty since it doesn't actually have
2751 * to be a hash.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01002752 if (signature_size == 0) {
2753 return PSA_ERROR_BUFFER_TOO_SMALL;
2754 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002755
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002756 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002757 key, &slot,
2758 input_is_message ? PSA_KEY_USAGE_SIGN_MESSAGE :
2759 PSA_KEY_USAGE_SIGN_HASH,
2760 alg);
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002761
Gilles Peskine449bd832023-01-11 14:50:10 +01002762 if (status != PSA_SUCCESS) {
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002763 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002764 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002765
Gilles Peskine449bd832023-01-11 14:50:10 +01002766 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002767 status = PSA_ERROR_INVALID_ARGUMENT;
2768 goto exit;
2769 }
2770
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002771 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01002772 .core = slot->attr
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002773 };
2774
Gilles Peskine449bd832023-01-11 14:50:10 +01002775 if (input_is_message) {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002776 status = psa_driver_wrapper_sign_message(
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002777 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002778 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002779 signature, signature_size, signature_length);
2780 } else {
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002781
2782 status = psa_driver_wrapper_sign_hash(
2783 &attributes, slot->key.data, slot->key.bytes,
2784 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002785 signature, signature_size, signature_length);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002786 }
2787
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002788
2789exit:
Paul Elliott59200a22023-02-21 15:07:40 +00002790 psa_wipe_tag_output_buffer(signature, status, signature_size,
2791 *signature_length);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002792
Gilles Peskine449bd832023-01-11 14:50:10 +01002793 unlock_status = psa_unlock_key_slot(slot);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002794
Gilles Peskine449bd832023-01-11 14:50:10 +01002795 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002796}
2797
Gilles Peskine449bd832023-01-11 14:50:10 +01002798static psa_status_t psa_verify_internal(mbedtls_svc_key_id_t key,
2799 int input_is_message,
2800 psa_algorithm_t alg,
2801 const uint8_t *input,
2802 size_t input_length,
2803 const uint8_t *signature,
2804 size_t signature_length)
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002805{
2806 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2807 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2808 psa_key_slot_t *slot;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002809
Gilles Peskine449bd832023-01-11 14:50:10 +01002810 status = psa_sign_verify_check_alg(input_is_message, alg);
2811 if (status != PSA_SUCCESS) {
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002812 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002813 }
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002814
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002815 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002816 key, &slot,
2817 input_is_message ? PSA_KEY_USAGE_VERIFY_MESSAGE :
2818 PSA_KEY_USAGE_VERIFY_HASH,
2819 alg);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002820
Gilles Peskine449bd832023-01-11 14:50:10 +01002821 if (status != PSA_SUCCESS) {
2822 return status;
2823 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002824
2825 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01002826 .core = slot->attr
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002827 };
2828
Gilles Peskine449bd832023-01-11 14:50:10 +01002829 if (input_is_message) {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002830 status = psa_driver_wrapper_verify_message(
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002831 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002832 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002833 signature, signature_length);
2834 } else {
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002835 status = psa_driver_wrapper_verify_hash(
2836 &attributes, slot->key.data, slot->key.bytes,
2837 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002838 signature, signature_length);
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002839 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002840
Gilles Peskine449bd832023-01-11 14:50:10 +01002841 unlock_status = psa_unlock_key_slot(slot);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002842
Gilles Peskine449bd832023-01-11 14:50:10 +01002843 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002844
2845}
2846
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002847psa_status_t psa_sign_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002848 const psa_key_attributes_t *attributes,
2849 const uint8_t *key_buffer,
2850 size_t key_buffer_size,
2851 psa_algorithm_t alg,
2852 const uint8_t *input,
2853 size_t input_length,
2854 uint8_t *signature,
2855 size_t signature_size,
Gilles Peskine449bd832023-01-11 14:50:10 +01002856 size_t *signature_length)
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002857{
2858 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002859
Gilles Peskine449bd832023-01-11 14:50:10 +01002860 if (PSA_ALG_IS_SIGN_HASH(alg)) {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002861 size_t hash_length;
2862 uint8_t hash[PSA_HASH_MAX_SIZE];
2863
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002864 status = psa_driver_wrapper_hash_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01002865 PSA_ALG_SIGN_GET_HASH(alg),
2866 input, input_length,
2867 hash, sizeof(hash), &hash_length);
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002868
Gilles Peskine449bd832023-01-11 14:50:10 +01002869 if (status != PSA_SUCCESS) {
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002870 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002871 }
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002872
2873 return psa_driver_wrapper_sign_hash(
Gilles Peskine449bd832023-01-11 14:50:10 +01002874 attributes, key_buffer, key_buffer_size,
2875 alg, hash, hash_length,
2876 signature, signature_size, signature_length);
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002877 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002878
Gilles Peskine449bd832023-01-11 14:50:10 +01002879 return PSA_ERROR_NOT_SUPPORTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002880}
2881
Gilles Peskine449bd832023-01-11 14:50:10 +01002882psa_status_t psa_sign_message(mbedtls_svc_key_id_t key,
2883 psa_algorithm_t alg,
2884 const uint8_t *input,
2885 size_t input_length,
2886 uint8_t *signature,
2887 size_t signature_size,
2888 size_t *signature_length)
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002889{
2890 return psa_sign_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002891 key, 1, alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002892 signature, signature_size, signature_length);
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002893}
2894
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002895psa_status_t psa_verify_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002896 const psa_key_attributes_t *attributes,
2897 const uint8_t *key_buffer,
2898 size_t key_buffer_size,
2899 psa_algorithm_t alg,
2900 const uint8_t *input,
2901 size_t input_length,
2902 const uint8_t *signature,
Gilles Peskine449bd832023-01-11 14:50:10 +01002903 size_t signature_length)
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002904{
2905 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002906
Gilles Peskine449bd832023-01-11 14:50:10 +01002907 if (PSA_ALG_IS_SIGN_HASH(alg)) {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002908 size_t hash_length;
2909 uint8_t hash[PSA_HASH_MAX_SIZE];
2910
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002911 status = psa_driver_wrapper_hash_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01002912 PSA_ALG_SIGN_GET_HASH(alg),
2913 input, input_length,
2914 hash, sizeof(hash), &hash_length);
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002915
Gilles Peskine449bd832023-01-11 14:50:10 +01002916 if (status != PSA_SUCCESS) {
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002917 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002918 }
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002919
2920 return psa_driver_wrapper_verify_hash(
Gilles Peskine449bd832023-01-11 14:50:10 +01002921 attributes, key_buffer, key_buffer_size,
2922 alg, hash, hash_length,
2923 signature, signature_length);
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002924 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002925
Gilles Peskine449bd832023-01-11 14:50:10 +01002926 return PSA_ERROR_NOT_SUPPORTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002927}
2928
Gilles Peskine449bd832023-01-11 14:50:10 +01002929psa_status_t psa_verify_message(mbedtls_svc_key_id_t key,
2930 psa_algorithm_t alg,
2931 const uint8_t *input,
2932 size_t input_length,
2933 const uint8_t *signature,
2934 size_t signature_length)
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002935{
2936 return psa_verify_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002937 key, 1, alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002938 signature, signature_length);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002939}
2940
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002941psa_status_t psa_sign_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01002942 const psa_key_attributes_t *attributes,
2943 const uint8_t *key_buffer, size_t key_buffer_size,
2944 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002945 uint8_t *signature, size_t signature_size, size_t *signature_length)
Gilles Peskinee59236f2018-01-27 23:32:46 +01002946{
Gilles Peskine449bd832023-01-11 14:50:10 +01002947 if (attributes->core.type == PSA_KEY_TYPE_RSA_KEY_PAIR) {
2948 if (PSA_ALG_IS_RSA_PKCS1V15_SIGN(alg) ||
2949 PSA_ALG_IS_RSA_PSS(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01002950#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01002951 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
2952 return mbedtls_psa_rsa_sign_hash(
2953 attributes,
2954 key_buffer, key_buffer_size,
2955 alg, hash, hash_length,
2956 signature, signature_size, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01002957#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
2958 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine449bd832023-01-11 14:50:10 +01002959 } else {
2960 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanacda8342020-07-24 23:09:52 +02002961 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002962 } else if (PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
2963 if (PSA_ALG_IS_ECDSA(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01002964#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01002965 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
2966 return mbedtls_psa_ecdsa_sign_hash(
2967 attributes,
2968 key_buffer, key_buffer_size,
2969 alg, hash, hash_length,
2970 signature, signature_size, signature_length);
Gilles Peskinee59236f2018-01-27 23:32:46 +01002971#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
2972 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskine449bd832023-01-11 14:50:10 +01002973 } else {
2974 return PSA_ERROR_INVALID_ARGUMENT;
Ronald Cron4501c982021-03-19 20:09:32 +01002975 }
Ronald Cron8a494f32021-02-17 09:49:51 +01002976 }
Ronald Cron4501c982021-03-19 20:09:32 +01002977
Gilles Peskine449bd832023-01-11 14:50:10 +01002978 (void) key_buffer;
2979 (void) key_buffer_size;
2980 (void) hash;
2981 (void) hash_length;
2982 (void) signature;
2983 (void) signature_size;
2984 (void) signature_length;
Ronald Cron4501c982021-03-19 20:09:32 +01002985
Gilles Peskine449bd832023-01-11 14:50:10 +01002986 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron18659932020-12-08 16:32:23 +01002987}
Gilles Peskinee59236f2018-01-27 23:32:46 +01002988
Gilles Peskine449bd832023-01-11 14:50:10 +01002989psa_status_t psa_sign_hash(mbedtls_svc_key_id_t key,
2990 psa_algorithm_t alg,
2991 const uint8_t *hash,
2992 size_t hash_length,
2993 uint8_t *signature,
2994 size_t signature_size,
2995 size_t *signature_length)
Gilles Peskinee59236f2018-01-27 23:32:46 +01002996{
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002997 return psa_sign_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002998 key, 0, alg, hash, hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002999 signature, signature_size, signature_length);
itayzafrir5c753392018-05-08 11:18:38 +03003000}
3001
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02003002psa_status_t psa_verify_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01003003 const psa_key_attributes_t *attributes,
3004 const uint8_t *key_buffer, size_t key_buffer_size,
3005 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003006 const uint8_t *signature, size_t signature_length)
itayzafrir5c753392018-05-08 11:18:38 +03003007{
Gilles Peskine449bd832023-01-11 14:50:10 +01003008 if (PSA_KEY_TYPE_IS_RSA(attributes->core.type)) {
3009 if (PSA_ALG_IS_RSA_PKCS1V15_SIGN(alg) ||
3010 PSA_ALG_IS_RSA_PSS(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003011#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003012 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
3013 return mbedtls_psa_rsa_verify_hash(
3014 attributes,
3015 key_buffer, key_buffer_size,
3016 alg, hash, hash_length,
3017 signature, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01003018#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
3019 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003020 } else {
3021 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanacda8342020-07-24 23:09:52 +02003022 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003023 } else if (PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3024 if (PSA_ALG_IS_ECDSA(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003025#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003026 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3027 return mbedtls_psa_ecdsa_verify_hash(
3028 attributes,
3029 key_buffer, key_buffer_size,
3030 alg, hash, hash_length,
3031 signature, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01003032#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3033 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003034 } else {
3035 return PSA_ERROR_INVALID_ARGUMENT;
Ronald Cron4501c982021-03-19 20:09:32 +01003036 }
Ronald Cron8a494f32021-02-17 09:49:51 +01003037 }
Ronald Cron4501c982021-03-19 20:09:32 +01003038
Gilles Peskine449bd832023-01-11 14:50:10 +01003039 (void) key_buffer;
3040 (void) key_buffer_size;
3041 (void) hash;
3042 (void) hash_length;
3043 (void) signature;
3044 (void) signature_length;
Ronald Cron4501c982021-03-19 20:09:32 +01003045
Gilles Peskine449bd832023-01-11 14:50:10 +01003046 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron18659932020-12-08 16:32:23 +01003047}
3048
Gilles Peskine449bd832023-01-11 14:50:10 +01003049psa_status_t psa_verify_hash(mbedtls_svc_key_id_t key,
3050 psa_algorithm_t alg,
3051 const uint8_t *hash,
3052 size_t hash_length,
3053 const uint8_t *signature,
3054 size_t signature_length)
itayzafrir5c753392018-05-08 11:18:38 +03003055{
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003056 return psa_verify_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02003057 key, 0, alg, hash, hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003058 signature, signature_length);
Gilles Peskinee59236f2018-01-27 23:32:46 +01003059}
3060
Gilles Peskine449bd832023-01-11 14:50:10 +01003061psa_status_t psa_asymmetric_encrypt(mbedtls_svc_key_id_t key,
3062 psa_algorithm_t alg,
3063 const uint8_t *input,
3064 size_t input_length,
3065 const uint8_t *salt,
3066 size_t salt_length,
3067 uint8_t *output,
3068 size_t output_size,
3069 size_t *output_length)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003070{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003071 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003072 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003073 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003074 psa_key_attributes_t attributes;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003075
Darryl Green5cc689a2018-07-24 15:34:10 +01003076 (void) input;
3077 (void) input_length;
3078 (void) salt;
3079 (void) output;
3080 (void) output_size;
3081
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003082 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003083
Gilles Peskine449bd832023-01-11 14:50:10 +01003084 if (!PSA_ALG_IS_RSA_OAEP(alg) && salt_length != 0) {
3085 return PSA_ERROR_INVALID_ARGUMENT;
3086 }
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003087
Ronald Cron5c522922020-11-14 16:35:34 +01003088 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01003089 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg);
3090 if (status != PSA_SUCCESS) {
3091 return status;
3092 }
3093 if (!(PSA_KEY_TYPE_IS_PUBLIC_KEY(slot->attr.type) ||
3094 PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type))) {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003095 status = PSA_ERROR_INVALID_ARGUMENT;
3096 goto exit;
3097 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003098
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003099 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01003100 .core = slot->attr
Przemyslaw Stekiel19e61422021-12-09 11:09:11 +01003101 };
Steven Cooremana2371e52020-07-28 14:30:39 +02003102
Przemyslaw Stekiel19e61422021-12-09 11:09:11 +01003103 status = psa_driver_wrapper_asymmetric_encrypt(
3104 &attributes, slot->key.data, slot->key.bytes,
3105 alg, input, input_length, salt, salt_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003106 output, output_size, output_length);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003107exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01003108 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003109
Gilles Peskine449bd832023-01-11 14:50:10 +01003110 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003111}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003112
Gilles Peskine449bd832023-01-11 14:50:10 +01003113psa_status_t psa_asymmetric_decrypt(mbedtls_svc_key_id_t key,
3114 psa_algorithm_t alg,
3115 const uint8_t *input,
3116 size_t input_length,
3117 const uint8_t *salt,
3118 size_t salt_length,
3119 uint8_t *output,
3120 size_t output_size,
3121 size_t *output_length)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003122{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003123 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003124 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003125 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003126 psa_key_attributes_t attributes;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003127
Darryl Green5cc689a2018-07-24 15:34:10 +01003128 (void) input;
3129 (void) input_length;
3130 (void) salt;
3131 (void) output;
3132 (void) output_size;
3133
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003134 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003135
Gilles Peskine449bd832023-01-11 14:50:10 +01003136 if (!PSA_ALG_IS_RSA_OAEP(alg) && salt_length != 0) {
3137 return PSA_ERROR_INVALID_ARGUMENT;
3138 }
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003139
Ronald Cron5c522922020-11-14 16:35:34 +01003140 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01003141 key, &slot, PSA_KEY_USAGE_DECRYPT, alg);
3142 if (status != PSA_SUCCESS) {
3143 return status;
3144 }
3145 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003146 status = PSA_ERROR_INVALID_ARGUMENT;
3147 goto exit;
3148 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003149
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003150 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01003151 .core = slot->attr
Przemyslaw Stekiel8d45c002021-12-13 08:58:19 +01003152 };
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003153
Przemyslaw Stekiel8d45c002021-12-13 08:58:19 +01003154 status = psa_driver_wrapper_asymmetric_decrypt(
3155 &attributes, slot->key.data, slot->key.bytes,
3156 alg, input, input_length, salt, salt_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003157 output, output_size, output_length);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003158
3159exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01003160 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003161
Gilles Peskine449bd832023-01-11 14:50:10 +01003162 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003163}
Gilles Peskinee59236f2018-01-27 23:32:46 +01003164
Paul Elliott9fe12f62022-11-30 19:16:02 +00003165/****************************************************************/
3166/* Asymmetric interruptible cryptography */
3167/****************************************************************/
3168
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003169static uint32_t psa_interruptible_max_ops = PSA_INTERRUPTIBLE_MAX_OPS_UNLIMITED;
3170
Paul Elliott9fe12f62022-11-30 19:16:02 +00003171void psa_interruptible_set_max_ops(uint32_t max_ops)
3172{
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003173 psa_interruptible_max_ops = max_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003174}
3175
3176uint32_t psa_interruptible_get_max_ops(void)
3177{
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003178 return psa_interruptible_max_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003179}
3180
Paul Elliott9fe12f62022-11-30 19:16:02 +00003181uint32_t psa_sign_hash_get_num_ops(
3182 const psa_sign_hash_interruptible_operation_t *operation)
3183{
Paul Elliott296ede92022-12-15 17:00:30 +00003184 return operation->num_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003185}
3186
3187uint32_t psa_verify_hash_get_num_ops(
3188 const psa_verify_hash_interruptible_operation_t *operation)
3189{
Paul Elliott296ede92022-12-15 17:00:30 +00003190 return operation->num_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003191}
3192
Paul Elliott59ad9452022-12-18 15:09:02 +00003193static psa_status_t psa_sign_hash_abort_internal(
3194 psa_sign_hash_interruptible_operation_t *operation)
3195{
3196 if (operation->id == 0) {
3197 /* The object has (apparently) been initialized but it is not (yet)
3198 * in use. It's ok to call abort on such an object, and there's
3199 * nothing to do. */
3200 return PSA_SUCCESS;
3201 }
3202
3203 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3204
3205 status = psa_driver_wrapper_sign_hash_abort(operation);
3206
3207 operation->id = 0;
3208
Paul Elliotte6145dc2023-02-07 12:51:21 +00003209 /* Do not clear either the error_occurred or num_ops elements here as they
3210 * only want to be cleared by the application calling abort, not by abort
3211 * being called at completion of an operation. */
3212
Paul Elliott59ad9452022-12-18 15:09:02 +00003213 return status;
3214}
3215
Paul Elliott9fe12f62022-11-30 19:16:02 +00003216psa_status_t psa_sign_hash_start(
3217 psa_sign_hash_interruptible_operation_t *operation,
3218 mbedtls_svc_key_id_t key, psa_algorithm_t alg,
3219 const uint8_t *hash, size_t hash_length)
3220{
3221 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3222 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3223 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003224 psa_key_attributes_t attributes;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003225
Paul Elliottc9774412023-02-06 15:14:07 +00003226 /* Check that start has not been previously called, or operation has not
3227 * previously errored. */
3228 if (operation->id != 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003229 return PSA_ERROR_BAD_STATE;
3230 }
3231
Paul Elliott9fe12f62022-11-30 19:16:02 +00003232 status = psa_sign_verify_check_alg(0, alg);
3233 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003234 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003235 return status;
3236 }
3237
3238 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
3239 PSA_KEY_USAGE_SIGN_HASH,
3240 alg);
3241
3242 if (status != PSA_SUCCESS) {
3243 goto exit;
3244 }
3245
3246 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
3247 status = PSA_ERROR_INVALID_ARGUMENT;
3248 goto exit;
3249 }
3250
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003251 attributes = (psa_key_attributes_t) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003252 .core = slot->attr
3253 };
3254
Paul Elliott296ede92022-12-15 17:00:30 +00003255 /* Ensure ops count gets reset, in case of operation re-use. */
3256 operation->num_ops = 0;
3257
Paul Elliott9fe12f62022-11-30 19:16:02 +00003258 status = psa_driver_wrapper_sign_hash_start(operation, &attributes,
3259 slot->key.data,
3260 slot->key.bytes, alg,
3261 hash, hash_length);
3262exit:
3263
3264 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003265 operation->error_occurred = 1;
Paul Elliott59ad9452022-12-18 15:09:02 +00003266 psa_sign_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003267 }
3268
3269 unlock_status = psa_unlock_key_slot(slot);
3270
Paul Elliottc9774412023-02-06 15:14:07 +00003271 if (unlock_status != PSA_SUCCESS) {
3272 operation->error_occurred = 1;
3273 }
Paul Elliott9fe12f62022-11-30 19:16:02 +00003274
Paul Elliottc9774412023-02-06 15:14:07 +00003275 return (status == PSA_SUCCESS) ? unlock_status : status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003276}
3277
3278
3279psa_status_t psa_sign_hash_complete(
3280 psa_sign_hash_interruptible_operation_t *operation,
3281 uint8_t *signature, size_t signature_size,
3282 size_t *signature_length)
3283{
3284 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3285
3286 *signature_length = 0;
3287
Paul Elliottc9774412023-02-06 15:14:07 +00003288 /* Check that start has been called first, and that operation has not
3289 * previously errored. */
3290 if (operation->id == 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003291 status = PSA_ERROR_BAD_STATE;
3292 goto exit;
3293 }
3294
Paul Elliott096abc42023-02-03 18:33:23 +00003295 /* Immediately reject a zero-length signature buffer. This guarantees that
3296 * signature must be a valid pointer. */
Paul Elliott9fe12f62022-11-30 19:16:02 +00003297 if (signature_size == 0) {
3298 status = PSA_ERROR_BUFFER_TOO_SMALL;
3299 goto exit;
3300 }
3301
3302 status = psa_driver_wrapper_sign_hash_complete(operation, signature,
3303 signature_size,
3304 signature_length);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003305
Paul Elliott296ede92022-12-15 17:00:30 +00003306 /* Update ops count with work done. */
Paul Elliottde1114c2023-02-07 12:43:11 +00003307 operation->num_ops = psa_driver_wrapper_sign_hash_get_num_ops(operation);
Paul Elliott296ede92022-12-15 17:00:30 +00003308
Paul Elliottebe225c2023-02-10 14:32:53 +00003309exit:
3310
Paul Elliott59200a22023-02-21 15:07:40 +00003311 psa_wipe_tag_output_buffer(signature, status, signature_size,
3312 *signature_length);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003313
Paul Elliott53bb3122023-02-10 14:22:22 +00003314 if (status != PSA_OPERATION_INCOMPLETE) {
Paul Elliottc9774412023-02-06 15:14:07 +00003315 if (status != PSA_SUCCESS) {
3316 operation->error_occurred = 1;
3317 }
3318
Paul Elliott59ad9452022-12-18 15:09:02 +00003319 psa_sign_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003320 }
3321
3322 return status;
3323}
3324
3325psa_status_t psa_sign_hash_abort(
3326 psa_sign_hash_interruptible_operation_t *operation)
3327{
Paul Elliott59ad9452022-12-18 15:09:02 +00003328 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3329
3330 status = psa_sign_hash_abort_internal(operation);
3331
3332 /* We clear the number of ops done here, so that it is not cleared when
3333 * the operation fails or succeeds, only on manual abort. */
3334 operation->num_ops = 0;
3335
Paul Elliottc9774412023-02-06 15:14:07 +00003336 /* Likewise, failure state. */
3337 operation->error_occurred = 0;
3338
Paul Elliott59ad9452022-12-18 15:09:02 +00003339 return status;
3340}
3341
3342static psa_status_t psa_verify_hash_abort_internal(
3343 psa_verify_hash_interruptible_operation_t *operation)
3344{
Paul Elliott9fe12f62022-11-30 19:16:02 +00003345 if (operation->id == 0) {
3346 /* The object has (apparently) been initialized but it is not (yet)
3347 * in use. It's ok to call abort on such an object, and there's
3348 * nothing to do. */
3349 return PSA_SUCCESS;
3350 }
3351
Paul Elliott59ad9452022-12-18 15:09:02 +00003352 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3353
3354 status = psa_driver_wrapper_verify_hash_abort(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003355
3356 operation->id = 0;
3357
Paul Elliotte6145dc2023-02-07 12:51:21 +00003358 /* Do not clear either the error_occurred or num_ops elements here as they
3359 * only want to be cleared by the application calling abort, not by abort
3360 * being called at completion of an operation. */
3361
Paul Elliott59ad9452022-12-18 15:09:02 +00003362 return status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003363}
3364
3365psa_status_t psa_verify_hash_start(
3366 psa_verify_hash_interruptible_operation_t *operation,
3367 mbedtls_svc_key_id_t key, psa_algorithm_t alg,
3368 const uint8_t *hash, size_t hash_length,
3369 const uint8_t *signature, size_t signature_length)
3370{
3371 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3372 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3373 psa_key_slot_t *slot;
3374
Paul Elliottc9774412023-02-06 15:14:07 +00003375 /* Check that start has not been previously called, or operation has not
3376 * previously errored. */
3377 if (operation->id != 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003378 return PSA_ERROR_BAD_STATE;
3379 }
3380
3381 status = psa_sign_verify_check_alg(0, alg);
3382 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003383 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003384 return status;
3385 }
3386
3387 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
3388 PSA_KEY_USAGE_VERIFY_HASH,
3389 alg);
3390
3391 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003392 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003393 return status;
3394 }
3395
3396 psa_key_attributes_t attributes = {
3397 .core = slot->attr
3398 };
3399
Paul Elliott296ede92022-12-15 17:00:30 +00003400 /* Ensure ops count gets reset, in case of operation re-use. */
3401 operation->num_ops = 0;
3402
Paul Elliott9fe12f62022-11-30 19:16:02 +00003403 status = psa_driver_wrapper_verify_hash_start(operation, &attributes,
3404 slot->key.data,
3405 slot->key.bytes,
3406 alg, hash, hash_length,
3407 signature, signature_length);
3408
3409 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003410 operation->error_occurred = 1;
Paul Elliott59ad9452022-12-18 15:09:02 +00003411 psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003412 }
3413
3414 unlock_status = psa_unlock_key_slot(slot);
3415
Paul Elliottc9774412023-02-06 15:14:07 +00003416 if (unlock_status != PSA_SUCCESS) {
3417 operation->error_occurred = 1;
3418 }
Paul Elliott9fe12f62022-11-30 19:16:02 +00003419
Paul Elliottc9774412023-02-06 15:14:07 +00003420 return (status == PSA_SUCCESS) ? unlock_status : status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003421}
3422
3423psa_status_t psa_verify_hash_complete(
3424 psa_verify_hash_interruptible_operation_t *operation)
3425{
3426 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3427
Paul Elliottc9774412023-02-06 15:14:07 +00003428 /* Check that start has been called first, and that operation has not
3429 * previously errored. */
3430 if (operation->id == 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003431 status = PSA_ERROR_BAD_STATE;
3432 goto exit;
3433 }
3434
3435 status = psa_driver_wrapper_verify_hash_complete(operation);
3436
Paul Elliott296ede92022-12-15 17:00:30 +00003437 /* Update ops count with work done. */
Paul Elliottde1114c2023-02-07 12:43:11 +00003438 operation->num_ops = psa_driver_wrapper_verify_hash_get_num_ops(
Paul Elliott296ede92022-12-15 17:00:30 +00003439 operation);
3440
Paul Elliottebe225c2023-02-10 14:32:53 +00003441exit:
3442
Paul Elliott9fe12f62022-11-30 19:16:02 +00003443 if (status != PSA_OPERATION_INCOMPLETE) {
Paul Elliottc9774412023-02-06 15:14:07 +00003444 if (status != PSA_SUCCESS) {
3445 operation->error_occurred = 1;
3446 }
3447
Paul Elliott59ad9452022-12-18 15:09:02 +00003448 psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003449 }
3450
3451 return status;
3452}
3453
3454psa_status_t psa_verify_hash_abort(
3455 psa_verify_hash_interruptible_operation_t *operation)
3456{
Paul Elliott59ad9452022-12-18 15:09:02 +00003457 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003458
Paul Elliott59ad9452022-12-18 15:09:02 +00003459 status = psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003460
Paul Elliott59ad9452022-12-18 15:09:02 +00003461 /* We clear the number of ops done here, so that it is not cleared when
3462 * the operation fails or succeeds, only on manual abort. */
3463 operation->num_ops = 0;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003464
Paul Elliottc9774412023-02-06 15:14:07 +00003465 /* Likewise, failure state. */
3466 operation->error_occurred = 0;
3467
Paul Elliott59ad9452022-12-18 15:09:02 +00003468 return status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003469}
3470
Paul Elliott588f8ed2022-12-02 18:10:26 +00003471/****************************************************************/
3472/* Asymmetric interruptible cryptography internal */
3473/* implementations */
3474/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003475
Paul Elliott588f8ed2022-12-02 18:10:26 +00003476void mbedtls_psa_interruptible_set_max_ops(uint32_t max_ops)
3477{
Paul Elliott7cc4e812023-01-10 17:14:11 +00003478
Paul Elliott588f8ed2022-12-02 18:10:26 +00003479#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3480 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3481 defined(MBEDTLS_ECP_RESTARTABLE)
3482
3483 /* Internal implementation uses zero to indicate infinite number max ops,
3484 * therefore avoid this value, and set to minimum possible. */
3485 if (max_ops == 0) {
3486 max_ops = 1;
3487 }
3488
Paul Elliott588f8ed2022-12-02 18:10:26 +00003489 mbedtls_ecp_set_max_ops(max_ops);
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003490#else
3491 (void) max_ops;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003492#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3493 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3494 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3495}
3496
Paul Elliott588f8ed2022-12-02 18:10:26 +00003497uint32_t mbedtls_psa_sign_hash_get_num_ops(
Paul Elliottf8e5b562023-02-19 18:43:45 +00003498 const mbedtls_psa_sign_hash_interruptible_operation_t *operation)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003499{
3500#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3501 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3502 defined(MBEDTLS_ECP_RESTARTABLE)
3503
Paul Elliott93d9ca82023-02-15 18:14:21 +00003504 return operation->num_ops;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003505#else
3506 (void) operation;
3507 return 0;
3508#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3509 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3510 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3511}
3512
3513uint32_t mbedtls_psa_verify_hash_get_num_ops(
Paul Elliottf8e5b562023-02-19 18:43:45 +00003514 const mbedtls_psa_verify_hash_interruptible_operation_t *operation)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003515{
3516 #if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3517 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3518 defined(MBEDTLS_ECP_RESTARTABLE)
3519
Paul Elliott93d9ca82023-02-15 18:14:21 +00003520 return operation->num_ops;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003521#else
3522 (void) operation;
3523 return 0;
3524#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3525 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3526 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3527}
3528
3529psa_status_t mbedtls_psa_sign_hash_start(
3530 mbedtls_psa_sign_hash_interruptible_operation_t *operation,
3531 const psa_key_attributes_t *attributes, const uint8_t *key_buffer,
3532 size_t key_buffer_size, psa_algorithm_t alg,
3533 const uint8_t *hash, size_t hash_length)
3534{
3535 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott0290a762023-02-09 14:30:24 +00003536 size_t required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003537
Paul Elliott068fe072023-01-16 13:59:15 +00003538 if (!PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3539 return PSA_ERROR_NOT_SUPPORTED;
3540 }
3541
3542 if (!PSA_ALG_IS_ECDSA(alg)) {
Paul Elliott813f9cd2023-02-05 15:28:46 +00003543 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott068fe072023-01-16 13:59:15 +00003544 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003545
3546#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Paul Elliott068fe072023-01-16 13:59:15 +00003547 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3548 defined(MBEDTLS_ECP_RESTARTABLE)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003549
Paul Elliotta1c94092023-02-15 16:38:04 +00003550 mbedtls_ecdsa_restart_init(&operation->restart_ctx);
3551
Paul Elliott93d9ca82023-02-15 18:14:21 +00003552 /* Ensure num_ops is zero'ed in case of context re-use. */
3553 operation->num_ops = 0;
3554
Paul Elliott068fe072023-01-16 13:59:15 +00003555 status = mbedtls_psa_ecp_load_representation(attributes->core.type,
3556 attributes->core.bits,
3557 key_buffer,
3558 key_buffer_size,
3559 &operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003560
Paul Elliott068fe072023-01-16 13:59:15 +00003561 if (status != PSA_SUCCESS) {
3562 return status;
3563 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003564
Paul Elliott1bc59df2023-02-05 13:41:57 +00003565 operation->coordinate_bytes = PSA_BITS_TO_BYTES(
Paul Elliottc569fc22023-02-10 13:02:54 +00003566 operation->ctx->grp.nbits);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003567
Paul Elliott068fe072023-01-16 13:59:15 +00003568 psa_algorithm_t hash_alg = PSA_ALG_SIGN_GET_HASH(alg);
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02003569 operation->md_alg = mbedtls_md_type_from_psa_alg(hash_alg);
Paul Elliott068fe072023-01-16 13:59:15 +00003570 operation->alg = alg;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003571
Paul Elliott0290a762023-02-09 14:30:24 +00003572 /* We only need to store the same length of hash as the private key size
3573 * here, it would be truncated by the internal implementation anyway. */
3574 required_hash_length = (hash_length < operation->coordinate_bytes ?
3575 hash_length : operation->coordinate_bytes);
3576
Paul Elliottba70ad42023-02-15 18:23:53 +00003577 if (required_hash_length > sizeof(operation->hash)) {
3578 /* Shouldn't happen, but better safe than sorry. */
3579 return PSA_ERROR_CORRUPTION_DETECTED;
3580 }
3581
Paul Elliott0290a762023-02-09 14:30:24 +00003582 memcpy(operation->hash, hash, required_hash_length);
3583 operation->hash_length = required_hash_length;
Paul Elliott068fe072023-01-16 13:59:15 +00003584
3585 return PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003586
3587#else
Paul Elliott068fe072023-01-16 13:59:15 +00003588 (void) operation;
3589 (void) key_buffer;
3590 (void) key_buffer_size;
3591 (void) alg;
3592 (void) hash;
3593 (void) hash_length;
3594 (void) status;
Paul Elliott0290a762023-02-09 14:30:24 +00003595 (void) required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003596
Paul Elliott068fe072023-01-16 13:59:15 +00003597 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003598#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3599 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3600 * defined( MBEDTLS_ECP_RESTARTABLE ) */
Paul Elliott588f8ed2022-12-02 18:10:26 +00003601}
3602
3603psa_status_t mbedtls_psa_sign_hash_complete(
3604 mbedtls_psa_sign_hash_interruptible_operation_t *operation,
3605 uint8_t *signature, size_t signature_size,
3606 size_t *signature_length)
3607{
Paul Elliott588f8ed2022-12-02 18:10:26 +00003608#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3609 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3610 defined(MBEDTLS_ECP_RESTARTABLE)
3611
Paul Elliotta1c94092023-02-15 16:38:04 +00003612 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott1243f932023-02-07 11:21:10 +00003613 mbedtls_mpi r;
3614 mbedtls_mpi s;
3615
Paul Elliott46845252023-02-03 14:59:11 +00003616 mbedtls_mpi_init(&r);
3617 mbedtls_mpi_init(&s);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003618
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003619 /* Ensure max_ops is set to the current value (or default). */
3620 mbedtls_psa_interruptible_set_max_ops(psa_interruptible_get_max_ops());
3621
Paul Elliotta1c94092023-02-15 16:38:04 +00003622 if (signature_size < 2 * operation->coordinate_bytes) {
3623 status = PSA_ERROR_BUFFER_TOO_SMALL;
3624 goto exit;
3625 }
3626
Paul Elliott588f8ed2022-12-02 18:10:26 +00003627 if (PSA_ALG_ECDSA_IS_DETERMINISTIC(operation->alg)) {
Paul Elliott46845252023-02-03 14:59:11 +00003628
Paul Elliott588f8ed2022-12-02 18:10:26 +00003629#if defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3630 status = mbedtls_to_psa_error(
3631 mbedtls_ecdsa_sign_det_restartable(&operation->ctx->grp,
Paul Elliott46845252023-02-03 14:59:11 +00003632 &r,
3633 &s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003634 &operation->ctx->d,
3635 operation->hash,
3636 operation->hash_length,
3637 operation->md_alg,
3638 mbedtls_psa_get_random,
3639 MBEDTLS_PSA_RANDOM_STATE,
3640 &operation->restart_ctx));
3641#else /* defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Paul Elliott724bd252023-02-08 12:35:08 +00003642 status = PSA_ERROR_NOT_SUPPORTED;
3643 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003644#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
3645 } else {
Paul Elliott588f8ed2022-12-02 18:10:26 +00003646 status = mbedtls_to_psa_error(
3647 mbedtls_ecdsa_sign_restartable(&operation->ctx->grp,
Paul Elliott46845252023-02-03 14:59:11 +00003648 &r,
3649 &s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003650 &operation->ctx->d,
3651 operation->hash,
3652 operation->hash_length,
3653 mbedtls_psa_get_random,
3654 MBEDTLS_PSA_RANDOM_STATE,
3655 mbedtls_psa_get_random,
3656 MBEDTLS_PSA_RANDOM_STATE,
3657 &operation->restart_ctx));
3658 }
3659
Paul Elliottf8e5b562023-02-19 18:43:45 +00003660 /* Hide the fact that the restart context only holds a delta of number of
3661 * ops done during the last operation, not an absolute value. */
3662 operation->num_ops += operation->restart_ctx.ecp.ops_done;
3663
Paul Elliott724bd252023-02-08 12:35:08 +00003664 if (status == PSA_SUCCESS) {
Paul Elliott588f8ed2022-12-02 18:10:26 +00003665 status = mbedtls_to_psa_error(
Paul Elliott46845252023-02-03 14:59:11 +00003666 mbedtls_mpi_write_binary(&r,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003667 signature,
Paul Elliott1bc59df2023-02-05 13:41:57 +00003668 operation->coordinate_bytes)
3669 );
Paul Elliott588f8ed2022-12-02 18:10:26 +00003670
3671 if (status != PSA_SUCCESS) {
Paul Elliott724bd252023-02-08 12:35:08 +00003672 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003673 }
3674
3675 status = mbedtls_to_psa_error(
Paul Elliott46845252023-02-03 14:59:11 +00003676 mbedtls_mpi_write_binary(&s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003677 signature +
Paul Elliott1bc59df2023-02-05 13:41:57 +00003678 operation->coordinate_bytes,
3679 operation->coordinate_bytes)
3680 );
Paul Elliott588f8ed2022-12-02 18:10:26 +00003681
3682 if (status != PSA_SUCCESS) {
Paul Elliott724bd252023-02-08 12:35:08 +00003683 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003684 }
3685
Paul Elliott1bc59df2023-02-05 13:41:57 +00003686 *signature_length = operation->coordinate_bytes * 2;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003687
Paul Elliott724bd252023-02-08 12:35:08 +00003688 status = PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003689 }
Paul Elliott724bd252023-02-08 12:35:08 +00003690
3691exit:
3692
3693 mbedtls_mpi_free(&r);
3694 mbedtls_mpi_free(&s);
3695 return status;
3696
Paul Elliott588f8ed2022-12-02 18:10:26 +00003697 #else
3698
3699 (void) operation;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003700 (void) signature;
3701 (void) signature_size;
3702 (void) signature_length;
3703
3704 return PSA_ERROR_NOT_SUPPORTED;
3705
3706#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3707 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3708 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3709}
3710
3711psa_status_t mbedtls_psa_sign_hash_abort(
3712 mbedtls_psa_sign_hash_interruptible_operation_t *operation)
3713{
3714
3715#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3716 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3717 defined(MBEDTLS_ECP_RESTARTABLE)
3718
3719 if (operation->ctx) {
3720 mbedtls_ecdsa_free(operation->ctx);
3721 mbedtls_free(operation->ctx);
Paul Elliottf9c91a72023-02-05 18:06:38 +00003722 operation->ctx = NULL;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003723 }
3724
3725 mbedtls_ecdsa_restart_free(&operation->restart_ctx);
3726
Paul Elliott93d9ca82023-02-15 18:14:21 +00003727 operation->num_ops = 0;
3728
Paul Elliott588f8ed2022-12-02 18:10:26 +00003729 return PSA_SUCCESS;
3730
3731#else
3732
3733 (void) operation;
3734
3735 return PSA_ERROR_NOT_SUPPORTED;
3736
3737#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3738 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3739 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3740}
3741
3742psa_status_t mbedtls_psa_verify_hash_start(
3743 mbedtls_psa_verify_hash_interruptible_operation_t *operation,
3744 const psa_key_attributes_t *attributes,
3745 const uint8_t *key_buffer, size_t key_buffer_size,
3746 psa_algorithm_t alg,
3747 const uint8_t *hash, size_t hash_length,
3748 const uint8_t *signature, size_t signature_length)
3749{
3750 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott1bc59df2023-02-05 13:41:57 +00003751 size_t coordinate_bytes = 0;
Paul Elliott0290a762023-02-09 14:30:24 +00003752 size_t required_hash_length = 0;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003753
Paul Elliott068fe072023-01-16 13:59:15 +00003754 if (!PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3755 return PSA_ERROR_NOT_SUPPORTED;
3756 }
3757
3758 if (!PSA_ALG_IS_ECDSA(alg)) {
Paul Elliott813f9cd2023-02-05 15:28:46 +00003759 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott068fe072023-01-16 13:59:15 +00003760 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003761
3762#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Paul Elliott068fe072023-01-16 13:59:15 +00003763 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3764 defined(MBEDTLS_ECP_RESTARTABLE)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003765
Paul Elliotta1c94092023-02-15 16:38:04 +00003766 mbedtls_ecdsa_restart_init(&operation->restart_ctx);
3767 mbedtls_mpi_init(&operation->r);
3768 mbedtls_mpi_init(&operation->s);
3769
Paul Elliott93d9ca82023-02-15 18:14:21 +00003770 /* Ensure num_ops is zero'ed in case of context re-use. */
3771 operation->num_ops = 0;
3772
Paul Elliott068fe072023-01-16 13:59:15 +00003773 status = mbedtls_psa_ecp_load_representation(attributes->core.type,
3774 attributes->core.bits,
3775 key_buffer,
3776 key_buffer_size,
3777 &operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003778
Paul Elliott068fe072023-01-16 13:59:15 +00003779 if (status != PSA_SUCCESS) {
3780 return status;
3781 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003782
Paul Elliottc569fc22023-02-10 13:02:54 +00003783 coordinate_bytes = PSA_BITS_TO_BYTES(operation->ctx->grp.nbits);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003784
Paul Elliott1bc59df2023-02-05 13:41:57 +00003785 if (signature_length != 2 * coordinate_bytes) {
Paul Elliott068fe072023-01-16 13:59:15 +00003786 return PSA_ERROR_INVALID_SIGNATURE;
3787 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003788
Paul Elliott068fe072023-01-16 13:59:15 +00003789 status = mbedtls_to_psa_error(
3790 mbedtls_mpi_read_binary(&operation->r,
3791 signature,
Paul Elliott1bc59df2023-02-05 13:41:57 +00003792 coordinate_bytes));
Paul Elliott588f8ed2022-12-02 18:10:26 +00003793
Paul Elliott068fe072023-01-16 13:59:15 +00003794 if (status != PSA_SUCCESS) {
3795 return status;
3796 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003797
Paul Elliott068fe072023-01-16 13:59:15 +00003798 status = mbedtls_to_psa_error(
3799 mbedtls_mpi_read_binary(&operation->s,
3800 signature +
Paul Elliott1bc59df2023-02-05 13:41:57 +00003801 coordinate_bytes,
3802 coordinate_bytes));
Paul Elliott588f8ed2022-12-02 18:10:26 +00003803
Paul Elliott068fe072023-01-16 13:59:15 +00003804 if (status != PSA_SUCCESS) {
3805 return status;
3806 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003807
Paul Elliott2c9843f2023-02-15 17:32:42 +00003808 status = mbedtls_psa_ecp_load_public_part(operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003809
Paul Elliott2c9843f2023-02-15 17:32:42 +00003810 if (status != PSA_SUCCESS) {
3811 return status;
Paul Elliott068fe072023-01-16 13:59:15 +00003812 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003813
Paul Elliott0290a762023-02-09 14:30:24 +00003814 /* We only need to store the same length of hash as the private key size
3815 * here, it would be truncated by the internal implementation anyway. */
3816 required_hash_length = (hash_length < coordinate_bytes ? hash_length :
3817 coordinate_bytes);
3818
Paul Elliottba70ad42023-02-15 18:23:53 +00003819 if (required_hash_length > sizeof(operation->hash)) {
3820 /* Shouldn't happen, but better safe than sorry. */
3821 return PSA_ERROR_CORRUPTION_DETECTED;
3822 }
3823
Paul Elliott0290a762023-02-09 14:30:24 +00003824 memcpy(operation->hash, hash, required_hash_length);
3825 operation->hash_length = required_hash_length;
Paul Elliott068fe072023-01-16 13:59:15 +00003826
3827 return PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003828#else
Paul Elliott068fe072023-01-16 13:59:15 +00003829 (void) operation;
3830 (void) key_buffer;
3831 (void) key_buffer_size;
3832 (void) alg;
3833 (void) hash;
3834 (void) hash_length;
3835 (void) signature;
3836 (void) signature_length;
3837 (void) status;
Paul Elliott1243f932023-02-07 11:21:10 +00003838 (void) coordinate_bytes;
Paul Elliott0290a762023-02-09 14:30:24 +00003839 (void) required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003840
Paul Elliott068fe072023-01-16 13:59:15 +00003841 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003842#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3843 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3844 * defined( MBEDTLS_ECP_RESTARTABLE ) */
Paul Elliott588f8ed2022-12-02 18:10:26 +00003845}
3846
3847psa_status_t mbedtls_psa_verify_hash_complete(
3848 mbedtls_psa_verify_hash_interruptible_operation_t *operation)
3849{
3850
3851#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3852 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3853 defined(MBEDTLS_ECP_RESTARTABLE)
3854
Paul Elliottf8e5b562023-02-19 18:43:45 +00003855 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3856
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003857 /* Ensure max_ops is set to the current value (or default). */
3858 mbedtls_psa_interruptible_set_max_ops(psa_interruptible_get_max_ops());
3859
Paul Elliottf8e5b562023-02-19 18:43:45 +00003860 status = mbedtls_to_psa_error(
Paul Elliott588f8ed2022-12-02 18:10:26 +00003861 mbedtls_ecdsa_verify_restartable(&operation->ctx->grp,
3862 operation->hash,
3863 operation->hash_length,
3864 &operation->ctx->Q,
3865 &operation->r,
3866 &operation->s,
3867 &operation->restart_ctx));
3868
Paul Elliottf8e5b562023-02-19 18:43:45 +00003869 /* Hide the fact that the restart context only holds a delta of number of
3870 * ops done during the last operation, not an absolute value. */
3871 operation->num_ops += operation->restart_ctx.ecp.ops_done;
3872
3873 return status;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003874#else
3875 (void) operation;
3876
3877 return PSA_ERROR_NOT_SUPPORTED;
3878
3879#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3880 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3881 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3882}
3883
3884psa_status_t mbedtls_psa_verify_hash_abort(
3885 mbedtls_psa_verify_hash_interruptible_operation_t *operation)
3886{
3887
3888#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3889 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3890 defined(MBEDTLS_ECP_RESTARTABLE)
3891
3892 if (operation->ctx) {
3893 mbedtls_ecdsa_free(operation->ctx);
3894 mbedtls_free(operation->ctx);
Paul Elliottf9c91a72023-02-05 18:06:38 +00003895 operation->ctx = NULL;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003896 }
3897
3898 mbedtls_ecdsa_restart_free(&operation->restart_ctx);
3899
Paul Elliott93d9ca82023-02-15 18:14:21 +00003900 operation->num_ops = 0;
3901
Paul Elliott588f8ed2022-12-02 18:10:26 +00003902 mbedtls_mpi_free(&operation->r);
3903 mbedtls_mpi_free(&operation->s);
3904
3905 return PSA_SUCCESS;
3906
3907#else
3908 (void) operation;
3909
3910 return PSA_ERROR_NOT_SUPPORTED;
3911
3912#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3913 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3914 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3915}
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003916
mohammad1603503973b2018-03-12 15:59:30 +02003917/****************************************************************/
3918/* Symmetric cryptography */
3919/****************************************************************/
3920
Gilles Peskine449bd832023-01-11 14:50:10 +01003921static psa_status_t psa_cipher_setup(psa_cipher_operation_t *operation,
3922 mbedtls_svc_key_id_t key,
3923 psa_algorithm_t alg,
3924 mbedtls_operation_t cipher_operation)
Ronald Cronab99ac22020-10-01 16:38:28 +02003925{
3926 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3927 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman54648242021-06-24 11:49:45 +01003928 psa_key_slot_t *slot = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01003929 psa_key_usage_t usage = (cipher_operation == MBEDTLS_ENCRYPT ?
3930 PSA_KEY_USAGE_ENCRYPT :
3931 PSA_KEY_USAGE_DECRYPT);
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003932 psa_key_attributes_t attributes;
Ronald Cronab99ac22020-10-01 16:38:28 +02003933
3934 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003935 if (operation->id != 0) {
Dave Rodgman54648242021-06-24 11:49:45 +01003936 status = PSA_ERROR_BAD_STATE;
3937 goto exit;
3938 }
Ronald Cronab99ac22020-10-01 16:38:28 +02003939
Gilles Peskine449bd832023-01-11 14:50:10 +01003940 if (!PSA_ALG_IS_CIPHER(alg)) {
Dave Rodgman54648242021-06-24 11:49:45 +01003941 status = PSA_ERROR_INVALID_ARGUMENT;
3942 goto exit;
3943 }
Ronald Cronab99ac22020-10-01 16:38:28 +02003944
Gilles Peskine449bd832023-01-11 14:50:10 +01003945 status = psa_get_and_lock_key_slot_with_policy(key, &slot, usage, alg);
3946 if (status != PSA_SUCCESS) {
Ronald Cronab99ac22020-10-01 16:38:28 +02003947 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01003948 }
Ronald Cronab99ac22020-10-01 16:38:28 +02003949
Ronald Cron49fafa92021-03-10 08:34:23 +01003950 /* Initialize the operation struct members, except for id. The id member
Ronald Cronab99ac22020-10-01 16:38:28 +02003951 * is used to indicate to psa_cipher_abort that there are resources to free,
Ronald Cron49fafa92021-03-10 08:34:23 +01003952 * so we only set it (in the driver wrapper) after resources have been
3953 * allocated/initialized. */
Ronald Cronab99ac22020-10-01 16:38:28 +02003954 operation->iv_set = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01003955 if (alg == PSA_ALG_ECB_NO_PADDING) {
Ronald Cronab99ac22020-10-01 16:38:28 +02003956 operation->iv_required = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01003957 } else {
Ronald Cronab99ac22020-10-01 16:38:28 +02003958 operation->iv_required = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003959 }
3960 operation->default_iv_length = PSA_CIPHER_IV_LENGTH(slot->attr.type, alg);
Ronald Cronab99ac22020-10-01 16:38:28 +02003961
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003962 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01003963 .core = slot->attr
Ronald Crona4af55f2020-12-14 14:36:06 +01003964 };
3965
Ronald Cronab99ac22020-10-01 16:38:28 +02003966 /* Try doing the operation through a driver before using software fallback. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003967 if (cipher_operation == MBEDTLS_ENCRYPT) {
3968 status = psa_driver_wrapper_cipher_encrypt_setup(operation,
3969 &attributes,
3970 slot->key.data,
3971 slot->key.bytes,
3972 alg);
3973 } else {
3974 status = psa_driver_wrapper_cipher_decrypt_setup(operation,
3975 &attributes,
3976 slot->key.data,
3977 slot->key.bytes,
3978 alg);
3979 }
Ronald Cronab99ac22020-10-01 16:38:28 +02003980
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003981exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01003982 if (status != PSA_SUCCESS) {
3983 psa_cipher_abort(operation);
3984 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003985
Gilles Peskine449bd832023-01-11 14:50:10 +01003986 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003987
Gilles Peskine449bd832023-01-11 14:50:10 +01003988 return (status == PSA_SUCCESS) ? unlock_status : status;
mohammad1603503973b2018-03-12 15:59:30 +02003989}
3990
Gilles Peskine449bd832023-01-11 14:50:10 +01003991psa_status_t psa_cipher_encrypt_setup(psa_cipher_operation_t *operation,
3992 mbedtls_svc_key_id_t key,
3993 psa_algorithm_t alg)
mohammad16038481e742018-03-18 13:57:31 +02003994{
Gilles Peskine449bd832023-01-11 14:50:10 +01003995 return psa_cipher_setup(operation, key, alg, MBEDTLS_ENCRYPT);
mohammad16038481e742018-03-18 13:57:31 +02003996}
3997
Gilles Peskine449bd832023-01-11 14:50:10 +01003998psa_status_t psa_cipher_decrypt_setup(psa_cipher_operation_t *operation,
3999 mbedtls_svc_key_id_t key,
4000 psa_algorithm_t alg)
mohammad16038481e742018-03-18 13:57:31 +02004001{
Gilles Peskine449bd832023-01-11 14:50:10 +01004002 return psa_cipher_setup(operation, key, alg, MBEDTLS_DECRYPT);
mohammad16038481e742018-03-18 13:57:31 +02004003}
4004
Gilles Peskine449bd832023-01-11 14:50:10 +01004005psa_status_t psa_cipher_generate_iv(psa_cipher_operation_t *operation,
4006 uint8_t *iv,
4007 size_t iv_size,
4008 size_t *iv_length)
mohammad1603503973b2018-03-12 15:59:30 +02004009{
Ronald Cron6d051732020-10-01 14:10:20 +02004010 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2fb90522021-07-05 12:31:44 +02004011 uint8_t local_iv[PSA_CIPHER_IV_MAX_SIZE];
Sergeybef1f632023-03-06 15:25:06 -07004012 size_t default_iv_length = 0;
Ronald Cron5618a392021-03-26 09:52:26 +01004013
Gilles Peskine449bd832023-01-11 14:50:10 +01004014 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004015 status = PSA_ERROR_BAD_STATE;
4016 goto exit;
Ronald Cronc45b4af2020-09-29 16:18:05 +02004017 }
4018
Gilles Peskine449bd832023-01-11 14:50:10 +01004019 if (operation->iv_set || !operation->iv_required) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004020 status = PSA_ERROR_BAD_STATE;
4021 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004022 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004023
Ronald Cron2fb90522021-07-05 12:31:44 +02004024 default_iv_length = operation->default_iv_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01004025 if (iv_size < default_iv_length) {
Ronald Cron5618a392021-03-26 09:52:26 +01004026 status = PSA_ERROR_BUFFER_TOO_SMALL;
4027 goto exit;
4028 }
Gilles Peskinee553c652018-06-04 16:22:46 +02004029
Gilles Peskine449bd832023-01-11 14:50:10 +01004030 if (default_iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Ronald Cron2fb90522021-07-05 12:31:44 +02004031 status = PSA_ERROR_GENERIC_ERROR;
4032 goto exit;
4033 }
4034
Gilles Peskine449bd832023-01-11 14:50:10 +01004035 status = psa_generate_random(local_iv, default_iv_length);
4036 if (status != PSA_SUCCESS) {
Ronald Cron5618a392021-03-26 09:52:26 +01004037 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004038 }
Ronald Cron5618a392021-03-26 09:52:26 +01004039
Gilles Peskine449bd832023-01-11 14:50:10 +01004040 status = psa_driver_wrapper_cipher_set_iv(operation,
4041 local_iv, default_iv_length);
Ronald Cron5618a392021-03-26 09:52:26 +01004042
4043exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004044 if (status == PSA_SUCCESS) {
4045 memcpy(iv, local_iv, default_iv_length);
Ronald Cron2fb90522021-07-05 12:31:44 +02004046 *iv_length = default_iv_length;
Steven Cooreman7df02922020-09-09 15:28:49 +02004047 operation->iv_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004048 } else {
Ronald Cron2fb90522021-07-05 12:31:44 +02004049 *iv_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004050 psa_cipher_abort(operation);
Ronald Cron2fb90522021-07-05 12:31:44 +02004051 }
Ronald Cron6d051732020-10-01 14:10:20 +02004052
Gilles Peskine449bd832023-01-11 14:50:10 +01004053 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004054}
4055
Gilles Peskine449bd832023-01-11 14:50:10 +01004056psa_status_t psa_cipher_set_iv(psa_cipher_operation_t *operation,
4057 const uint8_t *iv,
4058 size_t iv_length)
mohammad1603503973b2018-03-12 15:59:30 +02004059{
Ronald Cron6d051732020-10-01 14:10:20 +02004060 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronc45b4af2020-09-29 16:18:05 +02004061
Gilles Peskine449bd832023-01-11 14:50:10 +01004062 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004063 status = PSA_ERROR_BAD_STATE;
4064 goto exit;
4065 }
Ronald Cronc45b4af2020-09-29 16:18:05 +02004066
Gilles Peskine449bd832023-01-11 14:50:10 +01004067 if (operation->iv_set || !operation->iv_required) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004068 status = PSA_ERROR_BAD_STATE;
4069 goto exit;
4070 }
Ronald Crona0d68172021-03-26 10:15:08 +01004071
Gilles Peskine449bd832023-01-11 14:50:10 +01004072 if (iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004073 status = PSA_ERROR_INVALID_ARGUMENT;
4074 goto exit;
4075 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004076
Gilles Peskine449bd832023-01-11 14:50:10 +01004077 status = psa_driver_wrapper_cipher_set_iv(operation,
4078 iv,
4079 iv_length);
Steven Cooremand3feccd2020-09-01 15:56:14 +02004080
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004081exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004082 if (status == PSA_SUCCESS) {
itayzafrir534bd7c2018-08-02 13:56:32 +03004083 operation->iv_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004084 } else {
4085 psa_cipher_abort(operation);
4086 }
4087 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004088}
4089
Gilles Peskine449bd832023-01-11 14:50:10 +01004090psa_status_t psa_cipher_update(psa_cipher_operation_t *operation,
4091 const uint8_t *input,
4092 size_t input_length,
4093 uint8_t *output,
4094 size_t output_size,
4095 size_t *output_length)
mohammad1603503973b2018-03-12 15:59:30 +02004096{
Steven Cooremanffecb7b2020-08-25 15:13:13 +02004097 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron6d051732020-10-01 14:10:20 +02004098
Gilles Peskine449bd832023-01-11 14:50:10 +01004099 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004100 status = PSA_ERROR_BAD_STATE;
4101 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004102 }
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004103
Gilles Peskine449bd832023-01-11 14:50:10 +01004104 if (operation->iv_required && !operation->iv_set) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004105 status = PSA_ERROR_BAD_STATE;
4106 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004107 }
Jaeden Ameroab439972019-02-15 14:12:05 +00004108
Gilles Peskine449bd832023-01-11 14:50:10 +01004109 status = psa_driver_wrapper_cipher_update(operation,
4110 input,
4111 input_length,
4112 output,
4113 output_size,
4114 output_length);
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004115
4116exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004117 if (status != PSA_SUCCESS) {
4118 psa_cipher_abort(operation);
4119 }
Ronald Cron6d051732020-10-01 14:10:20 +02004120
Gilles Peskine449bd832023-01-11 14:50:10 +01004121 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004122}
4123
Gilles Peskine449bd832023-01-11 14:50:10 +01004124psa_status_t psa_cipher_finish(psa_cipher_operation_t *operation,
4125 uint8_t *output,
4126 size_t output_size,
4127 size_t *output_length)
mohammad1603503973b2018-03-12 15:59:30 +02004128{
David Saadab4ecc272019-02-14 13:48:10 +02004129 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Ronald Cron6d051732020-10-01 14:10:20 +02004130
Gilles Peskine449bd832023-01-11 14:50:10 +01004131 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004132 status = PSA_ERROR_BAD_STATE;
4133 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004134 }
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004135
Gilles Peskine449bd832023-01-11 14:50:10 +01004136 if (operation->iv_required && !operation->iv_set) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004137 status = PSA_ERROR_BAD_STATE;
4138 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004139 }
Moran Pekerbed71a22018-04-22 20:19:20 +03004140
Gilles Peskine449bd832023-01-11 14:50:10 +01004141 status = psa_driver_wrapper_cipher_finish(operation,
4142 output,
4143 output_size,
4144 output_length);
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004145
4146exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004147 if (status == PSA_SUCCESS) {
4148 return psa_cipher_abort(operation);
4149 } else {
Steven Cooremanef8575e2020-09-11 11:44:50 +02004150 *output_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004151 (void) psa_cipher_abort(operation);
Janos Follath315b51c2018-07-09 16:04:51 +01004152
Gilles Peskine449bd832023-01-11 14:50:10 +01004153 return status;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004154 }
mohammad1603503973b2018-03-12 15:59:30 +02004155}
4156
Gilles Peskine449bd832023-01-11 14:50:10 +01004157psa_status_t psa_cipher_abort(psa_cipher_operation_t *operation)
Gilles Peskinee553c652018-06-04 16:22:46 +02004158{
Gilles Peskine449bd832023-01-11 14:50:10 +01004159 if (operation->id == 0) {
Steven Cooremana07b9972020-09-10 14:54:14 +02004160 /* The object has (apparently) been initialized but it is not (yet)
Gilles Peskine81736312018-06-26 15:04:31 +02004161 * in use. It's ok to call abort on such an object, and there's
4162 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004163 return PSA_SUCCESS;
Gilles Peskine81736312018-06-26 15:04:31 +02004164 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004165
Gilles Peskine449bd832023-01-11 14:50:10 +01004166 psa_driver_wrapper_cipher_abort(operation);
Gilles Peskinee553c652018-06-04 16:22:46 +02004167
Ronald Cron49fafa92021-03-10 08:34:23 +01004168 operation->id = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004169 operation->iv_set = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004170 operation->iv_required = 0;
Moran Peker41deec42018-04-04 15:43:05 +03004171
Gilles Peskine449bd832023-01-11 14:50:10 +01004172 return PSA_SUCCESS;
mohammad1603503973b2018-03-12 15:59:30 +02004173}
4174
Gilles Peskine449bd832023-01-11 14:50:10 +01004175psa_status_t psa_cipher_encrypt(mbedtls_svc_key_id_t key,
4176 psa_algorithm_t alg,
4177 const uint8_t *input,
4178 size_t input_length,
4179 uint8_t *output,
4180 size_t output_size,
4181 size_t *output_length)
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004182{
4183 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004184 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron23919522021-07-08 19:00:07 +02004185 psa_key_slot_t *slot = NULL;
Ronald Cronc6e6f502021-07-09 18:44:58 +02004186 uint8_t local_iv[PSA_CIPHER_IV_MAX_SIZE];
4187 size_t default_iv_length = 0;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004188 psa_key_attributes_t attributes;
gabor-mezei-arm6f4e5bb2021-06-25 15:21:11 +02004189
Gilles Peskine449bd832023-01-11 14:50:10 +01004190 if (!PSA_ALG_IS_CIPHER(alg)) {
Ronald Cron23919522021-07-08 19:00:07 +02004191 status = PSA_ERROR_INVALID_ARGUMENT;
4192 goto exit;
4193 }
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004194
Gilles Peskine449bd832023-01-11 14:50:10 +01004195 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
4196 PSA_KEY_USAGE_ENCRYPT,
4197 alg);
4198 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004199 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004200 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004201
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004202 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004203 .core = slot->attr
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004204 };
4205
Gilles Peskine449bd832023-01-11 14:50:10 +01004206 default_iv_length = PSA_CIPHER_IV_LENGTH(slot->attr.type, alg);
4207 if (default_iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Ronald Cronc6e6f502021-07-09 18:44:58 +02004208 status = PSA_ERROR_GENERIC_ERROR;
4209 goto exit;
4210 }
4211
Gilles Peskine449bd832023-01-11 14:50:10 +01004212 if (default_iv_length > 0) {
4213 if (output_size < default_iv_length) {
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004214 status = PSA_ERROR_BUFFER_TOO_SMALL;
4215 goto exit;
4216 }
4217
Gilles Peskine449bd832023-01-11 14:50:10 +01004218 status = psa_generate_random(local_iv, default_iv_length);
4219 if (status != PSA_SUCCESS) {
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004220 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004221 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004222 }
4223
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004224 status = psa_driver_wrapper_cipher_encrypt(
4225 &attributes, slot->key.data, slot->key.bytes,
Ronald Cronc6e6f502021-07-09 18:44:58 +02004226 alg, local_iv, default_iv_length, input, input_length,
Ronald Cronafbc7ed2023-01-24 16:02:04 +01004227 psa_crypto_buffer_offset(output, default_iv_length),
Gilles Peskine449bd832023-01-11 14:50:10 +01004228 output_size - default_iv_length, output_length);
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004229
4230exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004231 unlock_status = psa_unlock_key_slot(slot);
4232 if (status == PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004233 status = unlock_status;
Ronald Cronc6e6f502021-07-09 18:44:58 +02004234 }
Ronald Cron23919522021-07-08 19:00:07 +02004235
Gilles Peskine449bd832023-01-11 14:50:10 +01004236 if (status == PSA_SUCCESS) {
4237 if (default_iv_length > 0) {
4238 memcpy(output, local_iv, default_iv_length);
4239 }
4240 *output_length += default_iv_length;
4241 } else {
4242 *output_length = 0;
4243 }
4244
4245 return status;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004246}
4247
Gilles Peskine449bd832023-01-11 14:50:10 +01004248psa_status_t psa_cipher_decrypt(mbedtls_svc_key_id_t key,
4249 psa_algorithm_t alg,
4250 const uint8_t *input,
4251 size_t input_length,
4252 uint8_t *output,
4253 size_t output_size,
4254 size_t *output_length)
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004255{
4256 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004257 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron23919522021-07-08 19:00:07 +02004258 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004259 psa_key_attributes_t attributes;
gabor-mezei-arm6f4e5bb2021-06-25 15:21:11 +02004260
Gilles Peskine449bd832023-01-11 14:50:10 +01004261 if (!PSA_ALG_IS_CIPHER(alg)) {
Ronald Cron23919522021-07-08 19:00:07 +02004262 status = PSA_ERROR_INVALID_ARGUMENT;
4263 goto exit;
4264 }
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004265
Gilles Peskine449bd832023-01-11 14:50:10 +01004266 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
4267 PSA_KEY_USAGE_DECRYPT,
4268 alg);
4269 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004270 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004271 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004272
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004273 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004274 .core = slot->attr
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004275 };
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004276
Gilles Peskine449bd832023-01-11 14:50:10 +01004277 if (alg == PSA_ALG_CCM_STAR_NO_TAG &&
4278 input_length < PSA_BLOCK_CIPHER_BLOCK_LENGTH(slot->attr.type)) {
Mateusz Starzyk594215b2021-10-14 12:23:06 +02004279 status = PSA_ERROR_INVALID_ARGUMENT;
4280 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004281 } else if (input_length < PSA_CIPHER_IV_LENGTH(slot->attr.type, alg)) {
gabor-mezei-arm258ae072021-06-25 15:25:38 +02004282 status = PSA_ERROR_INVALID_ARGUMENT;
4283 goto exit;
4284 }
4285
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004286 status = psa_driver_wrapper_cipher_decrypt(
4287 &attributes, slot->key.data, slot->key.bytes,
4288 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004289 output, output_size, output_length);
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004290
gabor-mezei-arm258ae072021-06-25 15:25:38 +02004291exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004292 unlock_status = psa_unlock_key_slot(slot);
4293 if (status == PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004294 status = unlock_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01004295 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004296
Gilles Peskine449bd832023-01-11 14:50:10 +01004297 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004298 *output_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004299 }
Ronald Cron23919522021-07-08 19:00:07 +02004300
Gilles Peskine449bd832023-01-11 14:50:10 +01004301 return status;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004302}
4303
4304
mohammad16035955c982018-04-26 00:53:03 +03004305/****************************************************************/
4306/* AEAD */
4307/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004308
Paul Elliottbaff51c2021-09-28 17:44:45 +01004309/* Helper function to get the base algorithm from its variants. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004310static psa_algorithm_t psa_aead_get_base_algorithm(psa_algorithm_t alg)
Paul Elliottbaff51c2021-09-28 17:44:45 +01004311{
Gilles Peskine449bd832023-01-11 14:50:10 +01004312 return PSA_ALG_AEAD_WITH_DEFAULT_LENGTH_TAG(alg);
Paul Elliottbaff51c2021-09-28 17:44:45 +01004313}
4314
4315/* Helper function to perform common nonce length checks. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004316static psa_status_t psa_aead_check_nonce_length(psa_algorithm_t alg,
4317 size_t nonce_length)
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004318{
Gilles Peskine449bd832023-01-11 14:50:10 +01004319 psa_algorithm_t base_alg = psa_aead_get_base_algorithm(alg);
Paul Elliottbaff51c2021-09-28 17:44:45 +01004320
Gilles Peskine449bd832023-01-11 14:50:10 +01004321 switch (base_alg) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004322#if defined(PSA_WANT_ALG_GCM)
4323 case PSA_ALG_GCM:
4324 /* Not checking max nonce size here as GCM spec allows almost
Gilles Peskine449bd832023-01-11 14:50:10 +01004325 * arbitrarily large nonces. Please note that we do not generally
4326 * recommend the usage of nonces of greater length than
4327 * PSA_AEAD_NONCE_MAX_SIZE, as large nonces are hashed to a shorter
4328 * size, which can then lead to collisions if you encrypt a very
4329 * large number of messages.*/
4330 if (nonce_length != 0) {
4331 return PSA_SUCCESS;
4332 }
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004333 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004334#endif /* PSA_WANT_ALG_GCM */
4335#if defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004336 case PSA_ALG_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01004337 if (nonce_length >= 7 && nonce_length <= 13) {
4338 return PSA_SUCCESS;
4339 }
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004340 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004341#endif /* PSA_WANT_ALG_CCM */
4342#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004343 case PSA_ALG_CHACHA20_POLY1305:
Gilles Peskine449bd832023-01-11 14:50:10 +01004344 if (nonce_length == 12) {
4345 return PSA_SUCCESS;
4346 } else if (nonce_length == 8) {
4347 return PSA_ERROR_NOT_SUPPORTED;
4348 }
Bence Szépkúti6d48e202021-11-15 20:04:15 +01004349 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004350#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004351 default:
Przemek Stekiel4c499272022-09-27 13:55:37 +02004352 (void) nonce_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01004353 return PSA_ERROR_NOT_SUPPORTED;
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004354 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004355
Gilles Peskine449bd832023-01-11 14:50:10 +01004356 return PSA_ERROR_INVALID_ARGUMENT;
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004357}
4358
Gilles Peskine449bd832023-01-11 14:50:10 +01004359static psa_status_t psa_aead_check_algorithm(psa_algorithm_t alg)
Bence Szépkútiaa3a6e42022-01-13 16:26:03 +01004360{
Gilles Peskine449bd832023-01-11 14:50:10 +01004361 if (!PSA_ALG_IS_AEAD(alg) || PSA_ALG_IS_WILDCARD(alg)) {
4362 return PSA_ERROR_INVALID_ARGUMENT;
4363 }
Bence Szépkúti08f34652021-12-08 21:07:13 +01004364
Gilles Peskine449bd832023-01-11 14:50:10 +01004365 return PSA_SUCCESS;
Bence Szépkúti08f34652021-12-08 21:07:13 +01004366}
4367
Gilles Peskine449bd832023-01-11 14:50:10 +01004368psa_status_t psa_aead_encrypt(mbedtls_svc_key_id_t key,
4369 psa_algorithm_t alg,
4370 const uint8_t *nonce,
4371 size_t nonce_length,
4372 const uint8_t *additional_data,
4373 size_t additional_data_length,
4374 const uint8_t *plaintext,
4375 size_t plaintext_length,
4376 uint8_t *ciphertext,
4377 size_t ciphertext_size,
4378 size_t *ciphertext_length)
mohammad16035955c982018-04-26 00:53:03 +03004379{
Ronald Cron215633c2021-03-16 17:15:37 +01004380 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4381 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02004382
mohammad1603f08a5502018-06-03 15:05:47 +03004383 *ciphertext_length = 0;
mohammad1603e58e6842018-05-09 04:58:32 -07004384
Gilles Peskine449bd832023-01-11 14:50:10 +01004385 status = psa_aead_check_algorithm(alg);
4386 if (status != PSA_SUCCESS) {
4387 return status;
4388 }
Steven Cooremanea7ab132021-03-17 16:28:00 +01004389
Ronald Cron9a986162021-03-26 12:40:07 +01004390 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01004391 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg);
4392 if (status != PSA_SUCCESS) {
4393 return status;
4394 }
mohammad16035955c982018-04-26 00:53:03 +03004395
Ronald Cron215633c2021-03-16 17:15:37 +01004396 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01004397 .core = slot->attr
Ronald Cron215633c2021-03-16 17:15:37 +01004398 };
mohammad16035955c982018-04-26 00:53:03 +03004399
Gilles Peskine449bd832023-01-11 14:50:10 +01004400 status = psa_aead_check_nonce_length(alg, nonce_length);
4401 if (status != PSA_SUCCESS) {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004402 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004403 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004404
Ronald Cronde822812021-03-17 16:08:20 +01004405 status = psa_driver_wrapper_aead_encrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01004406 &attributes, slot->key.data, slot->key.bytes,
4407 alg,
4408 nonce, nonce_length,
4409 additional_data, additional_data_length,
4410 plaintext, plaintext_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004411 ciphertext, ciphertext_size, ciphertext_length);
Gilles Peskine2d277862018-06-18 15:41:12 +02004412
Gilles Peskine449bd832023-01-11 14:50:10 +01004413 if (status != PSA_SUCCESS && ciphertext_size != 0) {
4414 memset(ciphertext, 0, ciphertext_size);
4415 }
Gilles Peskine2d277862018-06-18 15:41:12 +02004416
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004417exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004418 psa_unlock_key_slot(slot);
mohammad16035955c982018-04-26 00:53:03 +03004419
Gilles Peskine449bd832023-01-11 14:50:10 +01004420 return status;
Gilles Peskineee652a32018-06-01 19:23:52 +02004421}
4422
Gilles Peskine449bd832023-01-11 14:50:10 +01004423psa_status_t psa_aead_decrypt(mbedtls_svc_key_id_t key,
4424 psa_algorithm_t alg,
4425 const uint8_t *nonce,
4426 size_t nonce_length,
4427 const uint8_t *additional_data,
4428 size_t additional_data_length,
4429 const uint8_t *ciphertext,
4430 size_t ciphertext_length,
4431 uint8_t *plaintext,
4432 size_t plaintext_size,
4433 size_t *plaintext_length)
mohammad16035955c982018-04-26 00:53:03 +03004434{
Ronald Cron215633c2021-03-16 17:15:37 +01004435 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4436 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02004437
Gilles Peskineee652a32018-06-01 19:23:52 +02004438 *plaintext_length = 0;
mohammad16039e5a5152018-04-26 12:07:35 +03004439
Gilles Peskine449bd832023-01-11 14:50:10 +01004440 status = psa_aead_check_algorithm(alg);
4441 if (status != PSA_SUCCESS) {
4442 return status;
4443 }
Steven Cooremanea7ab132021-03-17 16:28:00 +01004444
Ronald Cron9a986162021-03-26 12:40:07 +01004445 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01004446 key, &slot, PSA_KEY_USAGE_DECRYPT, alg);
4447 if (status != PSA_SUCCESS) {
4448 return status;
4449 }
mohammad16035955c982018-04-26 00:53:03 +03004450
Ronald Cron215633c2021-03-16 17:15:37 +01004451 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01004452 .core = slot->attr
Ronald Cron215633c2021-03-16 17:15:37 +01004453 };
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004454
Gilles Peskine449bd832023-01-11 14:50:10 +01004455 status = psa_aead_check_nonce_length(alg, nonce_length);
4456 if (status != PSA_SUCCESS) {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004457 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004458 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004459
Ronald Cronde822812021-03-17 16:08:20 +01004460 status = psa_driver_wrapper_aead_decrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01004461 &attributes, slot->key.data, slot->key.bytes,
4462 alg,
4463 nonce, nonce_length,
4464 additional_data, additional_data_length,
4465 ciphertext, ciphertext_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004466 plaintext, plaintext_size, plaintext_length);
Gilles Peskinea40d7742018-06-01 16:28:30 +02004467
Gilles Peskine449bd832023-01-11 14:50:10 +01004468 if (status != PSA_SUCCESS && plaintext_size != 0) {
4469 memset(plaintext, 0, plaintext_size);
4470 }
mohammad160360a64d02018-06-03 17:20:42 +03004471
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004472exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004473 psa_unlock_key_slot(slot);
Ronald Cron215633c2021-03-16 17:15:37 +01004474
Gilles Peskine449bd832023-01-11 14:50:10 +01004475 return status;
mohammad16035955c982018-04-26 00:53:03 +03004476}
4477
Gilles Peskine449bd832023-01-11 14:50:10 +01004478static psa_status_t psa_validate_tag_length(psa_algorithm_t alg)
4479{
4480 const uint8_t tag_len = PSA_ALG_AEAD_GET_TAG_LENGTH(alg);
Andrzej Kurekf8816012021-12-19 17:00:12 +01004481
Gilles Peskine449bd832023-01-11 14:50:10 +01004482 switch (PSA_ALG_AEAD_WITH_SHORTENED_TAG(alg, 0)) {
Przemek Stekiel86679c72022-10-06 17:06:56 +02004483#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004484 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004485 /* CCM allows the following tag lengths: 4, 6, 8, 10, 12, 14, 16.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004486 if (tag_len < 4 || tag_len > 16 || tag_len % 2) {
4487 return PSA_ERROR_INVALID_ARGUMENT;
4488 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01004489 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02004490#endif /* PSA_WANT_ALG_CCM */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004491
Przemek Stekiel86679c72022-10-06 17:06:56 +02004492#if defined(PSA_WANT_ALG_GCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004493 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_GCM, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004494 /* GCM allows the following tag lengths: 4, 8, 12, 13, 14, 15, 16. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004495 if (tag_len != 4 && tag_len != 8 && (tag_len < 12 || tag_len > 16)) {
4496 return PSA_ERROR_INVALID_ARGUMENT;
4497 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01004498 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02004499#endif /* PSA_WANT_ALG_GCM */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004500
Przemek Stekiel86679c72022-10-06 17:06:56 +02004501#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Gilles Peskine449bd832023-01-11 14:50:10 +01004502 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CHACHA20_POLY1305, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004503 /* We only support the default tag length. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004504 if (tag_len != 16) {
4505 return PSA_ERROR_INVALID_ARGUMENT;
4506 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01004507 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02004508#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004509
4510 default:
4511 (void) tag_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004512 return PSA_ERROR_NOT_SUPPORTED;
Andrzej Kurekf8816012021-12-19 17:00:12 +01004513 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004514 return PSA_SUCCESS;
Andrzej Kurekf8816012021-12-19 17:00:12 +01004515}
4516
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004517/* Set the key for a multipart authenticated operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004518static psa_status_t psa_aead_setup(psa_aead_operation_t *operation,
4519 int is_encrypt,
4520 mbedtls_svc_key_id_t key,
4521 psa_algorithm_t alg)
Paul Elliottc2b71442021-06-24 18:17:52 +01004522{
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004523 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4524 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
4525 psa_key_slot_t *slot = NULL;
4526 psa_key_usage_t key_usage = 0;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004527 psa_key_attributes_t attributes;
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004528
Gilles Peskine449bd832023-01-11 14:50:10 +01004529 status = psa_aead_check_algorithm(alg);
4530 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004531 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004532 }
Paul Elliottc2b71442021-06-24 18:17:52 +01004533
Gilles Peskine449bd832023-01-11 14:50:10 +01004534 if (operation->id != 0) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004535 status = PSA_ERROR_BAD_STATE;
4536 goto exit;
Paul Elliottc2b71442021-06-24 18:17:52 +01004537 }
4538
Gilles Peskine449bd832023-01-11 14:50:10 +01004539 if (operation->nonce_set || operation->lengths_set ||
4540 operation->ad_started || operation->body_started) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004541 status = PSA_ERROR_BAD_STATE;
4542 goto exit;
Paul Elliottc2b71442021-06-24 18:17:52 +01004543 }
4544
Gilles Peskine449bd832023-01-11 14:50:10 +01004545 if (is_encrypt) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004546 key_usage = PSA_KEY_USAGE_ENCRYPT;
Gilles Peskine449bd832023-01-11 14:50:10 +01004547 } else {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004548 key_usage = PSA_KEY_USAGE_DECRYPT;
Gilles Peskine449bd832023-01-11 14:50:10 +01004549 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004550
Gilles Peskine449bd832023-01-11 14:50:10 +01004551 status = psa_get_and_lock_key_slot_with_policy(key, &slot, key_usage,
4552 alg);
4553 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004554 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004555 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004556
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004557 attributes = (psa_key_attributes_t) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004558 .core = slot->attr
4559 };
4560
Gilles Peskine449bd832023-01-11 14:50:10 +01004561 if ((status = psa_validate_tag_length(alg)) != PSA_SUCCESS) {
Przemek Stekiel6ab50762022-10-08 17:54:30 +02004562 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004563 }
Przemek Stekiel6ab50762022-10-08 17:54:30 +02004564
Gilles Peskine449bd832023-01-11 14:50:10 +01004565 if (is_encrypt) {
4566 status = psa_driver_wrapper_aead_encrypt_setup(operation,
4567 &attributes,
4568 slot->key.data,
4569 slot->key.bytes,
4570 alg);
4571 } else {
4572 status = psa_driver_wrapper_aead_decrypt_setup(operation,
4573 &attributes,
4574 slot->key.data,
4575 slot->key.bytes,
4576 alg);
4577 }
4578 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004579 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004580 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004581
Gilles Peskine449bd832023-01-11 14:50:10 +01004582 operation->key_type = psa_get_key_type(&attributes);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004583
4584exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004585 unlock_status = psa_unlock_key_slot(slot);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004586
Gilles Peskine449bd832023-01-11 14:50:10 +01004587 if (status == PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004588 status = unlock_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01004589 operation->alg = psa_aead_get_base_algorithm(alg);
Paul Elliottd9343f22021-08-23 18:59:49 +01004590 operation->is_encrypt = is_encrypt;
Gilles Peskine449bd832023-01-11 14:50:10 +01004591 } else {
4592 psa_aead_abort(operation);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004593 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004594
Gilles Peskine449bd832023-01-11 14:50:10 +01004595 return status;
Paul Elliottc2b71442021-06-24 18:17:52 +01004596}
4597
Paul Elliott302ff6b2021-04-20 18:10:30 +01004598/* Set the key for a multipart authenticated encryption operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004599psa_status_t psa_aead_encrypt_setup(psa_aead_operation_t *operation,
4600 mbedtls_svc_key_id_t key,
4601 psa_algorithm_t alg)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004602{
Gilles Peskine449bd832023-01-11 14:50:10 +01004603 return psa_aead_setup(operation, 1, key, alg);
Paul Elliott302ff6b2021-04-20 18:10:30 +01004604}
4605
4606/* Set the key for a multipart authenticated decryption operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004607psa_status_t psa_aead_decrypt_setup(psa_aead_operation_t *operation,
4608 mbedtls_svc_key_id_t key,
4609 psa_algorithm_t alg)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004610{
Gilles Peskine449bd832023-01-11 14:50:10 +01004611 return psa_aead_setup(operation, 0, key, alg);
Paul Elliott302ff6b2021-04-20 18:10:30 +01004612}
4613
4614/* Generate a random nonce / IV for multipart AEAD operation */
Gilles Peskine449bd832023-01-11 14:50:10 +01004615psa_status_t psa_aead_generate_nonce(psa_aead_operation_t *operation,
4616 uint8_t *nonce,
4617 size_t nonce_size,
4618 size_t *nonce_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004619{
4620 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Croncae59092021-11-26 18:53:58 +01004621 uint8_t local_nonce[PSA_AEAD_NONCE_MAX_SIZE];
Sergeybef1f632023-03-06 15:25:06 -07004622 size_t required_nonce_size = 0;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004623
Paul Elliott8eb9daf2021-06-04 16:42:21 +01004624 *nonce_length = 0;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004625
Gilles Peskine449bd832023-01-11 14:50:10 +01004626 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004627 status = PSA_ERROR_BAD_STATE;
4628 goto exit;
4629 }
4630
Gilles Peskine449bd832023-01-11 14:50:10 +01004631 if (operation->nonce_set || !operation->is_encrypt) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004632 status = PSA_ERROR_BAD_STATE;
4633 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004634 }
4635
Paul Elliotte193ea82021-10-01 13:00:16 +01004636 /* For CCM, this size may not be correct according to the PSA
4637 * specification. The PSA Crypto 1.0.1 specification states:
4638 *
4639 * CCM encodes the plaintext length pLen in L octets, with L the smallest
4640 * integer >= 2 where pLen < 2^(8L). The nonce length is then 15 - L bytes.
4641 *
4642 * However this restriction that L has to be the smallest integer is not
4643 * applied in practice, and it is not implementable here since the
4644 * plaintext length may or may not be known at this time. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004645 required_nonce_size = PSA_AEAD_NONCE_LENGTH(operation->key_type,
4646 operation->alg);
4647 if (nonce_size < required_nonce_size) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004648 status = PSA_ERROR_BUFFER_TOO_SMALL;
4649 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004650 }
4651
Gilles Peskine449bd832023-01-11 14:50:10 +01004652 status = psa_generate_random(local_nonce, required_nonce_size);
4653 if (status != PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004654 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004655 }
Paul Elliott302ff6b2021-04-20 18:10:30 +01004656
Gilles Peskine449bd832023-01-11 14:50:10 +01004657 status = psa_aead_set_nonce(operation, local_nonce, required_nonce_size);
Paul Elliott302ff6b2021-04-20 18:10:30 +01004658
Paul Elliott39dc6b82021-05-11 19:16:09 +01004659exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004660 if (status == PSA_SUCCESS) {
4661 memcpy(nonce, local_nonce, required_nonce_size);
Paul Elliott39dc6b82021-05-11 19:16:09 +01004662 *nonce_length = required_nonce_size;
Gilles Peskine449bd832023-01-11 14:50:10 +01004663 } else {
4664 psa_aead_abort(operation);
Ronald Croncae59092021-11-26 18:53:58 +01004665 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01004666
Gilles Peskine449bd832023-01-11 14:50:10 +01004667 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004668}
4669
4670/* Set the nonce for a multipart authenticated encryption or decryption
4671 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004672psa_status_t psa_aead_set_nonce(psa_aead_operation_t *operation,
4673 const uint8_t *nonce,
4674 size_t nonce_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004675{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004676 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4677
Gilles Peskine449bd832023-01-11 14:50:10 +01004678 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004679 status = PSA_ERROR_BAD_STATE;
4680 goto exit;
4681 }
4682
Gilles Peskine449bd832023-01-11 14:50:10 +01004683 if (operation->nonce_set) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004684 status = PSA_ERROR_BAD_STATE;
4685 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004686 }
4687
Gilles Peskine449bd832023-01-11 14:50:10 +01004688 status = psa_aead_check_nonce_length(operation->alg, nonce_length);
4689 if (status != PSA_SUCCESS) {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004690 status = PSA_ERROR_INVALID_ARGUMENT;
4691 goto exit;
Paul Elliott4ed1ed12021-09-27 18:09:28 +01004692 }
Paul Elliott1a98aca2021-05-20 18:24:07 +01004693
Gilles Peskine449bd832023-01-11 14:50:10 +01004694 status = psa_driver_wrapper_aead_set_nonce(operation, nonce,
4695 nonce_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004696
Paul Elliott39dc6b82021-05-11 19:16:09 +01004697exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004698 if (status == PSA_SUCCESS) {
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004699 operation->nonce_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004700 } else {
4701 psa_aead_abort(operation);
4702 }
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004703
Gilles Peskine449bd832023-01-11 14:50:10 +01004704 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004705}
4706
4707/* Declare the lengths of the message and additional data for multipart AEAD. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004708psa_status_t psa_aead_set_lengths(psa_aead_operation_t *operation,
4709 size_t ad_length,
4710 size_t plaintext_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004711{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004712 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4713
Gilles Peskine449bd832023-01-11 14:50:10 +01004714 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004715 status = PSA_ERROR_BAD_STATE;
4716 goto exit;
4717 }
4718
Gilles Peskine449bd832023-01-11 14:50:10 +01004719 if (operation->lengths_set || operation->ad_started ||
4720 operation->body_started) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004721 status = PSA_ERROR_BAD_STATE;
4722 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004723 }
4724
Gilles Peskine449bd832023-01-11 14:50:10 +01004725 switch (operation->alg) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004726#if defined(PSA_WANT_ALG_GCM)
4727 case PSA_ALG_GCM:
4728 /* Lengths can only be too large for GCM if size_t is bigger than 32
Gilles Peskine449bd832023-01-11 14:50:10 +01004729 * bits. Without the guard this code will generate warnings on 32bit
4730 * builds. */
Paul Elliott325d3742021-09-27 17:56:28 +01004731#if SIZE_MAX > UINT32_MAX
Gilles Peskine449bd832023-01-11 14:50:10 +01004732 if (((uint64_t) ad_length) >> 61 != 0 ||
4733 ((uint64_t) plaintext_length) > 0xFFFFFFFE0ull) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004734 status = PSA_ERROR_INVALID_ARGUMENT;
4735 goto exit;
4736 }
Paul Elliott325d3742021-09-27 17:56:28 +01004737#endif
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004738 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004739#endif /* PSA_WANT_ALG_GCM */
4740#if defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004741 case PSA_ALG_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01004742 if (ad_length > 0xFF00) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004743 status = PSA_ERROR_INVALID_ARGUMENT;
4744 goto exit;
4745 }
4746 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004747#endif /* PSA_WANT_ALG_CCM */
4748#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004749 case PSA_ALG_CHACHA20_POLY1305:
4750 /* No length restrictions for ChaChaPoly. */
4751 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004752#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004753 default:
4754 break;
4755 }
Paul Elliott325d3742021-09-27 17:56:28 +01004756
Gilles Peskine449bd832023-01-11 14:50:10 +01004757 status = psa_driver_wrapper_aead_set_lengths(operation, ad_length,
4758 plaintext_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004759
Paul Elliott39dc6b82021-05-11 19:16:09 +01004760exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004761 if (status == PSA_SUCCESS) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01004762 operation->ad_remaining = ad_length;
4763 operation->body_remaining = plaintext_length;
Paul Elliott39dc6b82021-05-11 19:16:09 +01004764 operation->lengths_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004765 } else {
4766 psa_aead_abort(operation);
Paul Elliottee4ffe02021-05-20 17:25:06 +01004767 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01004768
Gilles Peskine449bd832023-01-11 14:50:10 +01004769 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004770}
Paul Elliott3d7d52c2021-09-01 10:33:14 +01004771
4772/* Pass additional data to an active multipart AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004773psa_status_t psa_aead_update_ad(psa_aead_operation_t *operation,
4774 const uint8_t *input,
4775 size_t input_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004776{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004777 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4778
Gilles Peskine449bd832023-01-11 14:50:10 +01004779 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004780 status = PSA_ERROR_BAD_STATE;
4781 goto exit;
4782 }
4783
Gilles Peskine449bd832023-01-11 14:50:10 +01004784 if (!operation->nonce_set || operation->body_started) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004785 status = PSA_ERROR_BAD_STATE;
4786 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004787 }
4788
Gilles Peskine449bd832023-01-11 14:50:10 +01004789 if (operation->lengths_set) {
4790 if (operation->ad_remaining < input_length) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01004791 status = PSA_ERROR_INVALID_ARGUMENT;
4792 goto exit;
4793 }
4794
4795 operation->ad_remaining -= input_length;
4796 }
Paul Elliotte193ea82021-10-01 13:00:16 +01004797#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004798 else if (operation->alg == PSA_ALG_CCM) {
Paul Elliotte193ea82021-10-01 13:00:16 +01004799 status = PSA_ERROR_BAD_STATE;
4800 goto exit;
4801 }
4802#endif /* PSA_WANT_ALG_CCM */
Paul Elliottee4ffe02021-05-20 17:25:06 +01004803
Gilles Peskine449bd832023-01-11 14:50:10 +01004804 status = psa_driver_wrapper_aead_update_ad(operation, input,
4805 input_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004806
Paul Elliott39dc6b82021-05-11 19:16:09 +01004807exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004808 if (status == PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004809 operation->ad_started = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004810 } else {
4811 psa_aead_abort(operation);
4812 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01004813
Gilles Peskine449bd832023-01-11 14:50:10 +01004814 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004815}
4816
4817/* Encrypt or decrypt a message fragment in an active multipart AEAD
4818 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004819psa_status_t psa_aead_update(psa_aead_operation_t *operation,
4820 const uint8_t *input,
4821 size_t input_length,
4822 uint8_t *output,
4823 size_t output_size,
4824 size_t *output_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004825{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004826 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004827
4828 *output_length = 0;
4829
Gilles Peskine449bd832023-01-11 14:50:10 +01004830 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004831 status = PSA_ERROR_BAD_STATE;
4832 goto exit;
4833 }
4834
Gilles Peskine449bd832023-01-11 14:50:10 +01004835 if (!operation->nonce_set) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004836 status = PSA_ERROR_BAD_STATE;
4837 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004838 }
4839
Gilles Peskine449bd832023-01-11 14:50:10 +01004840 if (operation->lengths_set) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01004841 /* Additional data length was supplied, but not all the additional
4842 data was supplied.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004843 if (operation->ad_remaining != 0) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01004844 status = PSA_ERROR_INVALID_ARGUMENT;
4845 goto exit;
4846 }
4847
4848 /* Too much data provided. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004849 if (operation->body_remaining < input_length) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01004850 status = PSA_ERROR_INVALID_ARGUMENT;
4851 goto exit;
4852 }
4853
4854 operation->body_remaining -= input_length;
4855 }
Paul Elliotte193ea82021-10-01 13:00:16 +01004856#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004857 else if (operation->alg == PSA_ALG_CCM) {
Paul Elliotte193ea82021-10-01 13:00:16 +01004858 status = PSA_ERROR_BAD_STATE;
4859 goto exit;
4860 }
4861#endif /* PSA_WANT_ALG_CCM */
Paul Elliottee4ffe02021-05-20 17:25:06 +01004862
Gilles Peskine449bd832023-01-11 14:50:10 +01004863 status = psa_driver_wrapper_aead_update(operation, input, input_length,
4864 output, output_size,
4865 output_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004866
Paul Elliott39dc6b82021-05-11 19:16:09 +01004867exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004868 if (status == PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004869 operation->body_started = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004870 } else {
4871 psa_aead_abort(operation);
4872 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01004873
Gilles Peskine449bd832023-01-11 14:50:10 +01004874 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004875}
4876
Gilles Peskine449bd832023-01-11 14:50:10 +01004877static psa_status_t psa_aead_final_checks(const psa_aead_operation_t *operation)
Paul Elliottad53dcc2021-06-23 08:50:14 +01004878{
Gilles Peskine449bd832023-01-11 14:50:10 +01004879 if (operation->id == 0 || !operation->nonce_set) {
4880 return PSA_ERROR_BAD_STATE;
4881 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01004882
Gilles Peskine449bd832023-01-11 14:50:10 +01004883 if (operation->lengths_set && (operation->ad_remaining != 0 ||
4884 operation->body_remaining != 0)) {
4885 return PSA_ERROR_INVALID_ARGUMENT;
4886 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01004887
Gilles Peskine449bd832023-01-11 14:50:10 +01004888 return PSA_SUCCESS;
Paul Elliottad53dcc2021-06-23 08:50:14 +01004889}
4890
Paul Elliott302ff6b2021-04-20 18:10:30 +01004891/* Finish encrypting a message in a multipart AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004892psa_status_t psa_aead_finish(psa_aead_operation_t *operation,
4893 uint8_t *ciphertext,
4894 size_t ciphertext_size,
4895 size_t *ciphertext_length,
4896 uint8_t *tag,
4897 size_t tag_size,
4898 size_t *tag_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004899{
Paul Elliott39dc6b82021-05-11 19:16:09 +01004900 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4901
Paul Elliott302ff6b2021-04-20 18:10:30 +01004902 *ciphertext_length = 0;
Paul Elliottf88a5652021-06-22 17:53:45 +01004903 *tag_length = tag_size;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004904
Gilles Peskine449bd832023-01-11 14:50:10 +01004905 status = psa_aead_final_checks(operation);
4906 if (status != PSA_SUCCESS) {
Paul Elliottad53dcc2021-06-23 08:50:14 +01004907 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004908 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01004909
Gilles Peskine449bd832023-01-11 14:50:10 +01004910 if (!operation->is_encrypt) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004911 status = PSA_ERROR_BAD_STATE;
4912 goto exit;
4913 }
4914
Gilles Peskine449bd832023-01-11 14:50:10 +01004915 status = psa_driver_wrapper_aead_finish(operation, ciphertext,
4916 ciphertext_size,
4917 ciphertext_length,
4918 tag, tag_size, tag_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004919
Paul Elliott39dc6b82021-05-11 19:16:09 +01004920exit:
Paul Elliottdc42ca82023-02-24 18:11:59 +00004921
4922
Paul Elliottf47b0952021-05-21 18:02:33 +01004923 /* In case the operation fails and the user fails to check for failure or
Paul Elliott4c916e82021-09-19 18:34:50 +01004924 * the zero tag size, make sure the tag is set to something implausible.
4925 * Even if the operation succeeds, make sure we clear the rest of the
4926 * buffer to prevent potential leakage of anything previously placed in
4927 * the same buffer.*/
Paul Elliottdc42ca82023-02-24 18:11:59 +00004928 psa_wipe_tag_output_buffer(tag, status, tag_size, *tag_length);
Paul Elliottf47b0952021-05-21 18:02:33 +01004929
Gilles Peskine449bd832023-01-11 14:50:10 +01004930 psa_aead_abort(operation);
Paul Elliott39dc6b82021-05-11 19:16:09 +01004931
Gilles Peskine449bd832023-01-11 14:50:10 +01004932 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004933}
4934
4935/* Finish authenticating and decrypting a message in a multipart AEAD
4936 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004937psa_status_t psa_aead_verify(psa_aead_operation_t *operation,
4938 uint8_t *plaintext,
4939 size_t plaintext_size,
4940 size_t *plaintext_length,
4941 const uint8_t *tag,
4942 size_t tag_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004943{
Paul Elliott39dc6b82021-05-11 19:16:09 +01004944 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4945
Paul Elliott302ff6b2021-04-20 18:10:30 +01004946 *plaintext_length = 0;
4947
Gilles Peskine449bd832023-01-11 14:50:10 +01004948 status = psa_aead_final_checks(operation);
4949 if (status != PSA_SUCCESS) {
Paul Elliottad53dcc2021-06-23 08:50:14 +01004950 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004951 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01004952
Gilles Peskine449bd832023-01-11 14:50:10 +01004953 if (operation->is_encrypt) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004954 status = PSA_ERROR_BAD_STATE;
4955 goto exit;
4956 }
4957
Gilles Peskine449bd832023-01-11 14:50:10 +01004958 status = psa_driver_wrapper_aead_verify(operation, plaintext,
4959 plaintext_size,
4960 plaintext_length,
4961 tag, tag_length);
Paul Elliott39dc6b82021-05-11 19:16:09 +01004962
4963exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004964 psa_aead_abort(operation);
Paul Elliott39dc6b82021-05-11 19:16:09 +01004965
Gilles Peskine449bd832023-01-11 14:50:10 +01004966 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004967}
4968
4969/* Abort an AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004970psa_status_t psa_aead_abort(psa_aead_operation_t *operation)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004971{
4972 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4973
Gilles Peskine449bd832023-01-11 14:50:10 +01004974 if (operation->id == 0) {
Paul Elliott302ff6b2021-04-20 18:10:30 +01004975 /* The object has (apparently) been initialized but it is not (yet)
4976 * in use. It's ok to call abort on such an object, and there's
4977 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004978 return PSA_SUCCESS;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004979 }
4980
Gilles Peskine449bd832023-01-11 14:50:10 +01004981 status = psa_driver_wrapper_aead_abort(operation);
Paul Elliott302ff6b2021-04-20 18:10:30 +01004982
Gilles Peskine449bd832023-01-11 14:50:10 +01004983 memset(operation, 0, sizeof(*operation));
Paul Elliott302ff6b2021-04-20 18:10:30 +01004984
Gilles Peskine449bd832023-01-11 14:50:10 +01004985 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004986}
4987
Gilles Peskinee59236f2018-01-27 23:32:46 +01004988/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02004989/* Generators */
4990/****************************************************************/
4991
Przemek Stekiel69c46792022-06-10 12:59:51 +02004992#if defined(BUILTIN_ALG_ANY_HKDF) || \
John Durkop07cc04a2020-11-16 22:08:34 -08004993 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
Andrzej Kurek08d34b82022-07-29 10:00:16 -04004994 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) || \
Kusumit Ghoderaoaf0b5342023-05-03 11:58:46 +05304995 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS) || \
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05304996 defined(PSA_HAVE_SOFT_PBKDF2)
John Durkop07cc04a2020-11-16 22:08:34 -08004997#define AT_LEAST_ONE_BUILTIN_KDF
Steven Cooreman094a77e2021-05-06 17:58:36 +02004998#endif /* At least one builtin KDF */
4999
Przemek Stekiel69c46792022-06-10 12:59:51 +02005000#if defined(BUILTIN_ALG_ANY_HKDF) || \
Steven Cooreman094a77e2021-05-06 17:58:36 +02005001 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5002 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
5003static psa_status_t psa_key_derivation_start_hmac(
5004 psa_mac_operation_t *operation,
5005 psa_algorithm_t hash_alg,
5006 const uint8_t *hmac_key,
Gilles Peskine449bd832023-01-11 14:50:10 +01005007 size_t hmac_key_length)
Steven Cooreman094a77e2021-05-06 17:58:36 +02005008{
5009 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5010 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01005011 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
5012 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(hmac_key_length));
5013 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_HASH);
Steven Cooreman094a77e2021-05-06 17:58:36 +02005014
Steven Cooreman72f736a2021-05-07 14:14:37 +02005015 operation->is_sign = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005016 operation->mac_size = PSA_HASH_LENGTH(hash_alg);
Steven Cooreman72f736a2021-05-07 14:14:37 +02005017
Gilles Peskine449bd832023-01-11 14:50:10 +01005018 status = psa_driver_wrapper_mac_sign_setup(operation,
5019 &attributes,
5020 hmac_key, hmac_key_length,
5021 PSA_ALG_HMAC(hash_alg));
Steven Cooreman094a77e2021-05-06 17:58:36 +02005022
Gilles Peskine449bd832023-01-11 14:50:10 +01005023 psa_reset_key_attributes(&attributes);
5024 return status;
Steven Cooreman094a77e2021-05-06 17:58:36 +02005025}
5026#endif /* KDF algorithms reliant on HMAC */
John Durkop07cc04a2020-11-16 22:08:34 -08005027
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005028#define HKDF_STATE_INIT 0 /* no input yet */
5029#define HKDF_STATE_STARTED 1 /* got salt */
5030#define HKDF_STATE_KEYED 2 /* got key */
5031#define HKDF_STATE_OUTPUT 3 /* output started */
5032
Gilles Peskinecbe66502019-05-16 16:59:18 +02005033static psa_algorithm_t psa_key_derivation_get_kdf_alg(
Gilles Peskine449bd832023-01-11 14:50:10 +01005034 const psa_key_derivation_operation_t *operation)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005035{
Gilles Peskine449bd832023-01-11 14:50:10 +01005036 if (PSA_ALG_IS_KEY_AGREEMENT(operation->alg)) {
5037 return PSA_ALG_KEY_AGREEMENT_GET_KDF(operation->alg);
5038 } else {
5039 return operation->alg;
5040 }
Gilles Peskine969c5d62019-01-16 15:53:06 +01005041}
5042
Gilles Peskine449bd832023-01-11 14:50:10 +01005043psa_status_t psa_key_derivation_abort(psa_key_derivation_operation_t *operation)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005044{
5045 psa_status_t status = PSA_SUCCESS;
Gilles Peskine449bd832023-01-11 14:50:10 +01005046 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
5047 if (kdf_alg == 0) {
Gilles Peskineeab56e42018-07-12 17:12:33 +02005048 /* The object has (apparently) been initialized but it is not
5049 * in use. It's ok to call abort on such an object, and there's
5050 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005051 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02005052#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01005053 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
5054 mbedtls_free(operation->ctx.hkdf.info);
5055 status = psa_mac_abort(&operation->ctx.hkdf.hmac);
5056 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02005057#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08005058#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5059 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005060 if (PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
5061 /* TLS-1.2 PSK-to-MS KDF uses the same core as TLS-1.2 PRF */
5062 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
5063 if (operation->ctx.tls12_prf.secret != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005064 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.secret,
Gilles Peskine449bd832023-01-11 14:50:10 +01005065 operation->ctx.tls12_prf.secret_length);
Steven Cooremana6df6042021-04-29 19:32:25 +02005066 }
5067
Gilles Peskine449bd832023-01-11 14:50:10 +01005068 if (operation->ctx.tls12_prf.seed != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005069 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.seed,
Gilles Peskine449bd832023-01-11 14:50:10 +01005070 operation->ctx.tls12_prf.seed_length);
Janos Follath6a1d2622019-06-11 10:37:28 +01005071 }
5072
Gilles Peskine449bd832023-01-11 14:50:10 +01005073 if (operation->ctx.tls12_prf.label != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005074 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.label,
Gilles Peskine449bd832023-01-11 14:50:10 +01005075 operation->ctx.tls12_prf.label_length);
Janos Follath6a1d2622019-06-11 10:37:28 +01005076 }
Przemek Stekiel6c764412022-11-22 14:05:12 +01005077#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005078 if (operation->ctx.tls12_prf.other_secret != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005079 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.other_secret,
Gilles Peskine449bd832023-01-11 14:50:10 +01005080 operation->ctx.tls12_prf.other_secret_length);
Przemek Stekiele3ee2212022-04-07 14:29:56 +02005081 }
Przemek Stekiel6c764412022-11-22 14:05:12 +01005082#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Steven Cooremana6df6042021-04-29 19:32:25 +02005083 status = PSA_SUCCESS;
Janos Follath6a1d2622019-06-11 10:37:28 +01005084
5085 /* We leave the fields Ai and output_block to be erased safely by the
5086 * mbedtls_platform_zeroize() in the end of this function. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005087 } else
John Durkop07cc04a2020-11-16 22:08:34 -08005088#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
5089 * defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005090#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005091 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
5092 mbedtls_platform_zeroize(operation->ctx.tls12_ecjpake_to_pms.data,
5093 sizeof(operation->ctx.tls12_ecjpake_to_pms.data));
5094 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005095#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS) */
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305096#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05305097 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305098 if (operation->ctx.pbkdf2.salt != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005099 mbedtls_zeroize_and_free(operation->ctx.pbkdf2.salt,
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305100 operation->ctx.pbkdf2.salt_length);
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305101 }
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305102
5103 status = PSA_SUCCESS;
5104 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305105#endif /* defined(PSA_HAVE_SOFT_PBKDF2) */
Gilles Peskineeab56e42018-07-12 17:12:33 +02005106 {
5107 status = PSA_ERROR_BAD_STATE;
5108 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005109 mbedtls_platform_zeroize(operation, sizeof(*operation));
5110 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005111}
5112
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005113psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskine449bd832023-01-11 14:50:10 +01005114 size_t *capacity)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005115{
Gilles Peskine449bd832023-01-11 14:50:10 +01005116 if (operation->alg == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005117 /* This is a blank key derivation operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005118 return PSA_ERROR_BAD_STATE;
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005119 }
5120
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005121 *capacity = operation->capacity;
Gilles Peskine449bd832023-01-11 14:50:10 +01005122 return PSA_SUCCESS;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005123}
5124
Gilles Peskine449bd832023-01-11 14:50:10 +01005125psa_status_t psa_key_derivation_set_capacity(psa_key_derivation_operation_t *operation,
5126 size_t capacity)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005127{
Gilles Peskine449bd832023-01-11 14:50:10 +01005128 if (operation->alg == 0) {
5129 return PSA_ERROR_BAD_STATE;
5130 }
5131 if (capacity > operation->capacity) {
5132 return PSA_ERROR_INVALID_ARGUMENT;
5133 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005134 operation->capacity = capacity;
Gilles Peskine449bd832023-01-11 14:50:10 +01005135 return PSA_SUCCESS;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005136}
5137
Przemek Stekiel69c46792022-06-10 12:59:51 +02005138#if defined(BUILTIN_ALG_ANY_HKDF)
Przemek Stekiel03d948c2022-05-19 11:45:20 +02005139/* Read some bytes from an HKDF-based operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005140static psa_status_t psa_key_derivation_hkdf_read(psa_hkdf_key_derivation_t *hkdf,
5141 psa_algorithm_t kdf_alg,
5142 uint8_t *output,
5143 size_t output_length)
Gilles Peskinebef7f142018-07-12 17:22:21 +02005144{
Gilles Peskine449bd832023-01-11 14:50:10 +01005145 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
5146 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Steven Cooremand1ed1d92021-04-29 19:11:25 +02005147 size_t hmac_output_length;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005148 psa_status_t status;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005149#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01005150 const uint8_t last_block = PSA_ALG_IS_HKDF_EXTRACT(kdf_alg) ? 0 : 0xff;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005151#else
5152 const uint8_t last_block = 0xff;
5153#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskinebef7f142018-07-12 17:22:21 +02005154
Gilles Peskine449bd832023-01-11 14:50:10 +01005155 if (hkdf->state < HKDF_STATE_KEYED ||
5156 (!hkdf->info_set
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005157#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01005158 && !PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005159#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01005160 )) {
5161 return PSA_ERROR_BAD_STATE;
5162 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005163 hkdf->state = HKDF_STATE_OUTPUT;
5164
Gilles Peskine449bd832023-01-11 14:50:10 +01005165 while (output_length != 0) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005166 /* Copy what remains of the current block */
5167 uint8_t n = hash_length - hkdf->offset_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005168 if (n > output_length) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005169 n = (uint8_t) output_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01005170 }
5171 memcpy(output, hkdf->output_block + hkdf->offset_in_block, n);
Gilles Peskinebef7f142018-07-12 17:22:21 +02005172 output += n;
5173 output_length -= n;
5174 hkdf->offset_in_block += n;
Gilles Peskine449bd832023-01-11 14:50:10 +01005175 if (output_length == 0) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005176 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01005177 }
Przemek Stekiel03d948c2022-05-19 11:45:20 +02005178 /* We can't be wanting more output after the last block, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005179 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005180 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02005181 * object was corrupted or if this function is called directly
5182 * inside the library. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005183 if (hkdf->block_number == last_block) {
5184 return PSA_ERROR_BAD_STATE;
5185 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02005186
5187 /* We need a new block */
5188 ++hkdf->block_number;
5189 hkdf->offset_in_block = 0;
Steven Cooremand1ed1d92021-04-29 19:11:25 +02005190
Gilles Peskine449bd832023-01-11 14:50:10 +01005191 status = psa_key_derivation_start_hmac(&hkdf->hmac,
5192 hash_alg,
5193 hkdf->prk,
5194 hash_length);
5195 if (status != PSA_SUCCESS) {
5196 return status;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005197 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005198
5199 if (hkdf->block_number != 1) {
5200 status = psa_mac_update(&hkdf->hmac,
5201 hkdf->output_block,
5202 hash_length);
5203 if (status != PSA_SUCCESS) {
5204 return status;
5205 }
5206 }
5207 status = psa_mac_update(&hkdf->hmac,
5208 hkdf->info,
5209 hkdf->info_length);
5210 if (status != PSA_SUCCESS) {
5211 return status;
5212 }
5213 status = psa_mac_update(&hkdf->hmac,
5214 &hkdf->block_number, 1);
5215 if (status != PSA_SUCCESS) {
5216 return status;
5217 }
5218 status = psa_mac_sign_finish(&hkdf->hmac,
5219 hkdf->output_block,
5220 sizeof(hkdf->output_block),
5221 &hmac_output_length);
5222 if (status != PSA_SUCCESS) {
5223 return status;
5224 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02005225 }
5226
Gilles Peskine449bd832023-01-11 14:50:10 +01005227 return PSA_SUCCESS;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005228}
Przemek Stekiel69c46792022-06-10 12:59:51 +02005229#endif /* BUILTIN_ALG_ANY_HKDF */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005230
John Durkop07cc04a2020-11-16 22:08:34 -08005231#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5232 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follath7742fee2019-06-17 12:58:10 +01005233static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
5234 psa_tls12_prf_key_derivation_t *tls12_prf,
Gilles Peskine449bd832023-01-11 14:50:10 +01005235 psa_algorithm_t alg)
Janos Follath7742fee2019-06-17 12:58:10 +01005236{
Gilles Peskine449bd832023-01-11 14:50:10 +01005237 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(alg);
5238 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Steven Cooremana6df6042021-04-29 19:32:25 +02005239 psa_mac_operation_t hmac = PSA_MAC_OPERATION_INIT;
5240 size_t hmac_output_length;
Janos Follathea29bfb2019-06-19 12:21:20 +01005241 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005242
Janos Follath7742fee2019-06-17 12:58:10 +01005243 /* We can't be wanting more output after block 0xff, otherwise
5244 * the capacity check in psa_key_derivation_output_bytes() would have
5245 * prevented this call. It could happen only if the operation
5246 * object was corrupted or if this function is called directly
5247 * inside the library. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005248 if (tls12_prf->block_number == 0xff) {
5249 return PSA_ERROR_CORRUPTION_DETECTED;
5250 }
Janos Follath7742fee2019-06-17 12:58:10 +01005251
5252 /* We need a new block */
5253 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01005254 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01005255
5256 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
5257 *
5258 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
5259 *
5260 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
5261 * HMAC_hash(secret, A(2) + seed) +
5262 * HMAC_hash(secret, A(3) + seed) + ...
5263 *
5264 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01005265 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01005266 *
Janos Follathea29bfb2019-06-19 12:21:20 +01005267 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01005268 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01005269 * is currently extracted as `output_block` and where i is
5270 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01005271 */
5272
Gilles Peskine449bd832023-01-11 14:50:10 +01005273 status = psa_key_derivation_start_hmac(&hmac,
5274 hash_alg,
5275 tls12_prf->secret,
5276 tls12_prf->secret_length);
5277 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005278 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005279 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005280
5281 /* Calculate A(i) where i = tls12_prf->block_number. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005282 if (tls12_prf->block_number == 1) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005283 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
5284 * the variable seed and in this instance means it in the context of the
5285 * P_hash function, where seed = label + seed.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01005286 status = psa_mac_update(&hmac,
5287 tls12_prf->label,
5288 tls12_prf->label_length);
5289 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005290 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005291 }
5292 status = psa_mac_update(&hmac,
5293 tls12_prf->seed,
5294 tls12_prf->seed_length);
5295 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005296 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005297 }
5298 } else {
Janos Follathea29bfb2019-06-19 12:21:20 +01005299 /* A(i) = HMAC_hash(secret, A(i-1)) */
Gilles Peskine449bd832023-01-11 14:50:10 +01005300 status = psa_mac_update(&hmac, tls12_prf->Ai, hash_length);
5301 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005302 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005303 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005304 }
5305
Gilles Peskine449bd832023-01-11 14:50:10 +01005306 status = psa_mac_sign_finish(&hmac,
5307 tls12_prf->Ai, hash_length,
5308 &hmac_output_length);
5309 if (hmac_output_length != hash_length) {
Steven Cooremana6df6042021-04-29 19:32:25 +02005310 status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01005311 }
5312 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005313 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005314 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005315
5316 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
Gilles Peskine449bd832023-01-11 14:50:10 +01005317 status = psa_key_derivation_start_hmac(&hmac,
5318 hash_alg,
5319 tls12_prf->secret,
5320 tls12_prf->secret_length);
5321 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005322 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005323 }
5324 status = psa_mac_update(&hmac, tls12_prf->Ai, hash_length);
5325 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005326 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005327 }
5328 status = psa_mac_update(&hmac, tls12_prf->label, tls12_prf->label_length);
5329 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005330 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005331 }
5332 status = psa_mac_update(&hmac, tls12_prf->seed, tls12_prf->seed_length);
5333 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005334 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005335 }
5336 status = psa_mac_sign_finish(&hmac,
5337 tls12_prf->output_block, hash_length,
5338 &hmac_output_length);
5339 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005340 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005341 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005342
Janos Follath7742fee2019-06-17 12:58:10 +01005343
5344cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01005345 cleanup_status = psa_mac_abort(&hmac);
5346 if (status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005347 status = cleanup_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01005348 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005349
Gilles Peskine449bd832023-01-11 14:50:10 +01005350 return status;
Janos Follath7742fee2019-06-17 12:58:10 +01005351}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005352
Janos Follath844eb0e2019-06-19 12:10:49 +01005353static psa_status_t psa_key_derivation_tls12_prf_read(
5354 psa_tls12_prf_key_derivation_t *tls12_prf,
5355 psa_algorithm_t alg,
5356 uint8_t *output,
Gilles Peskine449bd832023-01-11 14:50:10 +01005357 size_t output_length)
Janos Follath844eb0e2019-06-19 12:10:49 +01005358{
Gilles Peskine449bd832023-01-11 14:50:10 +01005359 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH(alg);
5360 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Janos Follath844eb0e2019-06-19 12:10:49 +01005361 psa_status_t status;
5362 uint8_t offset, length;
5363
Gilles Peskine449bd832023-01-11 14:50:10 +01005364 switch (tls12_prf->state) {
Gilles Peskineb1edaec2021-06-11 22:41:46 +02005365 case PSA_TLS12_PRF_STATE_LABEL_SET:
5366 tls12_prf->state = PSA_TLS12_PRF_STATE_OUTPUT;
5367 break;
5368 case PSA_TLS12_PRF_STATE_OUTPUT:
5369 break;
5370 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005371 return PSA_ERROR_BAD_STATE;
Gilles Peskineb1edaec2021-06-11 22:41:46 +02005372 }
5373
Gilles Peskine449bd832023-01-11 14:50:10 +01005374 while (output_length != 0) {
Janos Follath844eb0e2019-06-19 12:10:49 +01005375 /* Check if we have fully processed the current block. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005376 if (tls12_prf->left_in_block == 0) {
5377 status = psa_key_derivation_tls12_prf_generate_next_block(tls12_prf,
5378 alg);
5379 if (status != PSA_SUCCESS) {
5380 return status;
5381 }
Janos Follath844eb0e2019-06-19 12:10:49 +01005382
5383 continue;
5384 }
5385
Gilles Peskine449bd832023-01-11 14:50:10 +01005386 if (tls12_prf->left_in_block > output_length) {
Janos Follath844eb0e2019-06-19 12:10:49 +01005387 length = (uint8_t) output_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01005388 } else {
Janos Follath844eb0e2019-06-19 12:10:49 +01005389 length = tls12_prf->left_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005390 }
Janos Follath844eb0e2019-06-19 12:10:49 +01005391
5392 offset = hash_length - tls12_prf->left_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005393 memcpy(output, tls12_prf->output_block + offset, length);
Janos Follath844eb0e2019-06-19 12:10:49 +01005394 output += length;
5395 output_length -= length;
5396 tls12_prf->left_in_block -= length;
5397 }
5398
Gilles Peskine449bd832023-01-11 14:50:10 +01005399 return PSA_SUCCESS;
Janos Follath844eb0e2019-06-19 12:10:49 +01005400}
John Durkop07cc04a2020-11-16 22:08:34 -08005401#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
5402 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskinebef7f142018-07-12 17:22:21 +02005403
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005404#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
5405static psa_status_t psa_key_derivation_tls12_ecjpake_to_pms_read(
5406 psa_tls12_ecjpake_to_pms_t *ecjpake,
5407 uint8_t *output,
Gilles Peskine449bd832023-01-11 14:50:10 +01005408 size_t output_length)
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005409{
5410 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Andrzej Kurek5603efd2022-09-26 10:49:16 -04005411 size_t output_size = 0;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005412
Gilles Peskine449bd832023-01-11 14:50:10 +01005413 if (output_length != 32) {
5414 return PSA_ERROR_INVALID_ARGUMENT;
5415 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005416
Gilles Peskine449bd832023-01-11 14:50:10 +01005417 status = psa_hash_compute(PSA_ALG_SHA_256, ecjpake->data,
5418 PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE, output, output_length,
5419 &output_size);
5420 if (status != PSA_SUCCESS) {
5421 return status;
5422 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005423
Gilles Peskine449bd832023-01-11 14:50:10 +01005424 if (output_size != output_length) {
5425 return PSA_ERROR_GENERIC_ERROR;
5426 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005427
Gilles Peskine449bd832023-01-11 14:50:10 +01005428 return PSA_SUCCESS;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005429}
5430#endif
5431
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305432#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305433static psa_status_t psa_key_derivation_pbkdf2_generate_block(
5434 psa_pbkdf2_key_derivation_t *pbkdf2,
5435 psa_algorithm_t prf_alg,
5436 uint8_t prf_output_length,
5437 psa_key_attributes_t *attributes)
5438{
5439 psa_status_t status;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305440 psa_mac_operation_t mac_operation = PSA_MAC_OPERATION_INIT;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305441 size_t mac_output_length;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305442 uint8_t U_i[PSA_MAC_MAX_SIZE];
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305443 uint8_t *U_accumulator = pbkdf2->output_block;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305444 uint64_t i;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305445 uint8_t block_counter[4];
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305446
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305447 mac_operation.is_sign = 1;
5448 mac_operation.mac_size = prf_output_length;
5449 MBEDTLS_PUT_UINT32_BE(pbkdf2->block_number, block_counter, 0);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305450
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305451 status = psa_driver_wrapper_mac_sign_setup(&mac_operation,
5452 attributes,
5453 pbkdf2->password,
5454 pbkdf2->password_length,
5455 prf_alg);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305456 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305457 goto cleanup;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305458 }
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305459 status = psa_mac_update(&mac_operation, pbkdf2->salt, pbkdf2->salt_length);
5460 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305461 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305462 }
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305463 status = psa_mac_update(&mac_operation, block_counter, sizeof(block_counter));
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305464 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305465 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305466 }
5467 status = psa_mac_sign_finish(&mac_operation, U_i, sizeof(U_i),
5468 &mac_output_length);
5469 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305470 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305471 }
5472
5473 if (mac_output_length != prf_output_length) {
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305474 status = PSA_ERROR_CORRUPTION_DETECTED;
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305475 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305476 }
5477
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305478 memcpy(U_accumulator, U_i, prf_output_length);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305479
5480 for (i = 1; i < pbkdf2->input_cost; i++) {
Kusumit Ghoderao4536bb62023-06-22 15:42:59 +05305481 /* We are passing prf_output_length as mac_size because the driver
5482 * function directly sets mac_output_length as mac_size upon success.
Kusumit Ghoderao5f3345a2023-07-27 21:21:38 +05305483 * See https://github.com/Mbed-TLS/mbedtls/issues/7801 */
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305484 status = psa_driver_wrapper_mac_compute(attributes,
5485 pbkdf2->password,
5486 pbkdf2->password_length,
5487 prf_alg, U_i, prf_output_length,
Kusumit Ghoderao4536bb62023-06-22 15:42:59 +05305488 U_i, prf_output_length,
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305489 &mac_output_length);
5490 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305491 goto cleanup;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305492 }
5493
Kusumit Ghoderao109ee3d2023-06-08 16:36:45 +05305494 mbedtls_xor(U_accumulator, U_accumulator, U_i, prf_output_length);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305495 }
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305496
5497cleanup:
5498 /* Zeroise buffers to clear sensitive data from memory. */
5499 mbedtls_platform_zeroize(U_i, PSA_MAC_MAX_SIZE);
5500 return status;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305501}
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05305502
5503static psa_status_t psa_key_derivation_pbkdf2_read(
5504 psa_pbkdf2_key_derivation_t *pbkdf2,
5505 psa_algorithm_t kdf_alg,
5506 uint8_t *output,
5507 size_t output_length)
5508{
5509 psa_status_t status;
5510 psa_algorithm_t prf_alg;
5511 uint8_t prf_output_length;
5512 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
5513 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(pbkdf2->password_length));
5514 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
5515
5516 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
5517 prf_alg = PSA_ALG_HMAC(PSA_ALG_PBKDF2_HMAC_GET_HASH(kdf_alg));
5518 prf_output_length = PSA_HASH_LENGTH(prf_alg);
5519 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
Kusumit Ghoderaoa2520a52023-06-22 15:42:19 +05305520 } else if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
5521 prf_alg = PSA_ALG_CMAC;
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05305522 prf_output_length = PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC);
Kusumit Ghoderaoa2520a52023-06-22 15:42:19 +05305523 psa_set_key_type(&attributes, PSA_KEY_TYPE_AES);
Kusumit Ghoderaod9ec1af2023-06-08 20:19:51 +05305524 } else {
5525 return PSA_ERROR_INVALID_ARGUMENT;
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05305526 }
5527
5528 switch (pbkdf2->state) {
5529 case PSA_PBKDF2_STATE_PASSWORD_SET:
5530 /* Initially we need a new block so bytes_used is equal to block size*/
5531 pbkdf2->bytes_used = prf_output_length;
5532 pbkdf2->state = PSA_PBKDF2_STATE_OUTPUT;
5533 break;
5534 case PSA_PBKDF2_STATE_OUTPUT:
5535 break;
5536 default:
5537 return PSA_ERROR_BAD_STATE;
5538 }
5539
5540 while (output_length != 0) {
5541 uint8_t n = prf_output_length - pbkdf2->bytes_used;
5542 if (n > output_length) {
5543 n = (uint8_t) output_length;
5544 }
5545 memcpy(output, pbkdf2->output_block + pbkdf2->bytes_used, n);
5546 output += n;
5547 output_length -= n;
5548 pbkdf2->bytes_used += n;
5549
5550 if (output_length == 0) {
5551 break;
5552 }
5553
5554 /* We need a new block */
5555 pbkdf2->bytes_used = 0;
5556 pbkdf2->block_number++;
5557
5558 status = psa_key_derivation_pbkdf2_generate_block(pbkdf2, prf_alg,
5559 prf_output_length,
5560 &attributes);
5561 if (status != PSA_SUCCESS) {
5562 return status;
5563 }
5564 }
5565
5566 return PSA_SUCCESS;
5567}
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305568#endif /* PSA_HAVE_SOFT_PBKDF2 */
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305569
Janos Follath6c6c8fc2019-06-17 12:38:20 +01005570psa_status_t psa_key_derivation_output_bytes(
5571 psa_key_derivation_operation_t *operation,
5572 uint8_t *output,
Gilles Peskine449bd832023-01-11 14:50:10 +01005573 size_t output_length)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005574{
5575 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01005576 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
Gilles Peskineeab56e42018-07-12 17:12:33 +02005577
Gilles Peskine449bd832023-01-11 14:50:10 +01005578 if (operation->alg == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005579 /* This is a blank operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005580 return PSA_ERROR_BAD_STATE;
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005581 }
5582
Gilles Peskine449bd832023-01-11 14:50:10 +01005583 if (output_length > operation->capacity) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005584 operation->capacity = 0;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005585 /* Go through the error path to wipe all confidential data now
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005586 * that the operation object is useless. */
David Saadab4ecc272019-02-14 13:48:10 +02005587 status = PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005588 goto exit;
5589 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005590 if (output_length == 0 && operation->capacity == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005591 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005592 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02005593 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
5594 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005595 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02005596 * output_length > 0. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005597 return PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005598 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005599 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005600
Przemek Stekiel69c46792022-06-10 12:59:51 +02005601#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01005602 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
5603 status = psa_key_derivation_hkdf_read(&operation->ctx.hkdf, kdf_alg,
5604 output, output_length);
5605 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02005606#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08005607#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5608 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005609 if (PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
5610 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
5611 status = psa_key_derivation_tls12_prf_read(&operation->ctx.tls12_prf,
5612 kdf_alg, output,
5613 output_length);
5614 } else
John Durkop07cc04a2020-11-16 22:08:34 -08005615#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
5616 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005617#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005618 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005619 status = psa_key_derivation_tls12_ecjpake_to_pms_read(
Gilles Peskine449bd832023-01-11 14:50:10 +01005620 &operation->ctx.tls12_ecjpake_to_pms, output, output_length);
5621 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005622#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305623#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05305624 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05305625 status = psa_key_derivation_pbkdf2_read(&operation->ctx.pbkdf2, kdf_alg,
5626 output, output_length);
Kusumit Ghoderao056f0c52023-05-03 15:58:34 +05305627 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305628#endif /* PSA_HAVE_SOFT_PBKDF2 */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005629
Gilles Peskineeab56e42018-07-12 17:12:33 +02005630 {
Steven Cooreman74afe472021-02-10 17:19:22 +01005631 (void) kdf_alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01005632 return PSA_ERROR_BAD_STATE;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005633 }
5634
5635exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005636 if (status != PSA_SUCCESS) {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005637 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005638 * This allows us to differentiate between exhausted operations and
5639 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
5640 * operations. */
5641 psa_algorithm_t alg = operation->alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01005642 psa_key_derivation_abort(operation);
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005643 operation->alg = alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01005644 memset(output, '!', output_length);
Gilles Peskineeab56e42018-07-12 17:12:33 +02005645 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005646 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005647}
5648
David Brown7807bf72021-02-09 16:28:23 -07005649#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01005650static void psa_des_set_key_parity(uint8_t *data, size_t data_size)
Gilles Peskine08542d82018-07-19 17:05:42 +02005651{
Gilles Peskine449bd832023-01-11 14:50:10 +01005652 if (data_size >= 8) {
5653 mbedtls_des_key_set_parity(data);
5654 }
5655 if (data_size >= 16) {
5656 mbedtls_des_key_set_parity(data + 8);
5657 }
5658 if (data_size >= 24) {
5659 mbedtls_des_key_set_parity(data + 16);
5660 }
Gilles Peskine08542d82018-07-19 17:05:42 +02005661}
David Brown7807bf72021-02-09 16:28:23 -07005662#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine08542d82018-07-19 17:05:42 +02005663
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005664/*
Gilles Peskine449bd832023-01-11 14:50:10 +01005665 * ECC keys on a Weierstrass elliptic curve require the generation
5666 * of a private key which is an integer
5667 * in the range [1, N - 1], where N is the boundary of the private key domain:
5668 * N is the prime p for Diffie-Hellman, or the order of the
5669 * curve’s base point for ECC.
5670 *
5671 * Let m be the bit size of N, such that 2^m > N >= 2^(m-1).
5672 * This function generates the private key using the following process:
5673 *
5674 * 1. Draw a byte string of length ceiling(m/8) bytes.
5675 * 2. If m is not a multiple of 8, set the most significant
5676 * (8 * ceiling(m/8) - m) bits of the first byte in the string to zero.
5677 * 3. Convert the string to integer k by decoding it as a big-endian byte string.
5678 * 4. If k > N - 2, discard the result and return to step 1.
5679 * 5. Output k + 1 as the private key.
5680 *
5681 * This method allows compliance to NIST standards, specifically the methods titled
5682 * Key-Pair Generation by Testing Candidates in the following publications:
5683 * - NIST Special Publication 800-56A: Recommendation for Pair-Wise Key-Establishment
5684 * Schemes Using Discrete Logarithm Cryptography [SP800-56A] §5.6.1.1.4 for
5685 * Diffie-Hellman keys.
5686 *
5687 * - [SP800-56A] §5.6.1.2.2 or FIPS Publication 186-4: Digital Signature
5688 * Standard (DSS) [FIPS186-4] §B.4.2 for elliptic curve keys.
5689 *
5690 * Note: Function allocates memory for *data buffer, so given *data should be
5691 * always NULL.
5692 */
Valerio Setti86587ab2023-06-27 13:09:30 +02005693#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE)
5694#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE)
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01005695static psa_status_t psa_generate_derived_ecc_key_weierstrass_helper(
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005696 psa_key_slot_t *slot,
5697 size_t bits,
5698 psa_key_derivation_operation_t *operation,
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005699 uint8_t **data
5700 )
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005701{
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005702 unsigned key_out_of_range = 1;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005703 mbedtls_mpi k;
5704 mbedtls_mpi diff_N_2;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005705 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Przemek Stekiela81aed22022-03-01 15:13:30 +01005706 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01005707 size_t m;
5708 size_t m_bytes;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005709
Gilles Peskine449bd832023-01-11 14:50:10 +01005710 mbedtls_mpi_init(&k);
5711 mbedtls_mpi_init(&diff_N_2);
Przemyslaw Stekiel1dfd1222021-11-18 13:35:00 +01005712
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005713 psa_ecc_family_t curve = PSA_KEY_TYPE_ECC_GET_FAMILY(
Gilles Peskine449bd832023-01-11 14:50:10 +01005714 slot->attr.type);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005715 mbedtls_ecp_group_id grp_id =
Gilles Peskine449bd832023-01-11 14:50:10 +01005716 mbedtls_ecc_group_of_psa(curve, bits, 0);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005717
Gilles Peskine449bd832023-01-11 14:50:10 +01005718 if (grp_id == MBEDTLS_ECP_DP_NONE) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005719 ret = MBEDTLS_ERR_ASN1_INVALID_DATA;
Przemyslaw Stekiel871a3362021-12-02 08:46:39 +01005720 goto cleanup;
5721 }
5722
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005723 mbedtls_ecp_group ecp_group;
Gilles Peskine449bd832023-01-11 14:50:10 +01005724 mbedtls_ecp_group_init(&ecp_group);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005725
Gilles Peskine449bd832023-01-11 14:50:10 +01005726 MBEDTLS_MPI_CHK(mbedtls_ecp_group_load(&ecp_group, grp_id));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005727
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005728 /* N is the boundary of the private key domain (ecp_group.N). */
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005729 /* Let m be the bit size of N. */
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01005730 m = ecp_group.nbits;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005731
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01005732 m_bytes = PSA_BITS_TO_BYTES(m);
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005733
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005734 /* Calculate N - 2 - it will be needed later. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005735 MBEDTLS_MPI_CHK(mbedtls_mpi_sub_int(&diff_N_2, &ecp_group.N, 2));
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005736
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005737 /* Note: This function is always called with *data == NULL and it
5738 * allocates memory for the data buffer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005739 *data = mbedtls_calloc(1, m_bytes);
5740 if (*data == NULL) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005741 ret = MBEDTLS_ERR_ASN1_ALLOC_FAILED;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005742 goto cleanup;
5743 }
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005744
Gilles Peskine449bd832023-01-11 14:50:10 +01005745 while (key_out_of_range) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005746 /* 1. Draw a byte string of length ceiling(m/8) bytes. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005747 if ((status = psa_key_derivation_output_bytes(operation, *data, m_bytes)) != 0) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005748 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005749 }
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005750
5751 /* 2. If m is not a multiple of 8 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005752 if (m % 8 != 0) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005753 /* Set the most significant
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005754 * (8 * ceiling(m/8) - m) bits of the first byte in
5755 * the string to zero.
5756 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005757 uint8_t clear_bit_mask = (1 << (m % 8)) - 1;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005758 (*data)[0] &= clear_bit_mask;
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005759 }
5760
5761 /* 3. Convert the string to integer k by decoding it as a
Gilles Peskine449bd832023-01-11 14:50:10 +01005762 * big-endian byte string.
5763 */
5764 MBEDTLS_MPI_CHK(mbedtls_mpi_read_binary(&k, *data, m_bytes));
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005765
5766 /* 4. If k > N - 2, discard the result and return to step 1.
Gilles Peskine449bd832023-01-11 14:50:10 +01005767 * Result of comparison is returned. When it indicates error
5768 * then this function is called again.
5769 */
5770 MBEDTLS_MPI_CHK(mbedtls_mpi_lt_mpi_ct(&diff_N_2, &k, &key_out_of_range));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005771 }
5772
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005773 /* 5. Output k + 1 as the private key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005774 MBEDTLS_MPI_CHK(mbedtls_mpi_add_int(&k, &k, 1));
5775 MBEDTLS_MPI_CHK(mbedtls_mpi_write_binary(&k, *data, m_bytes));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005776cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01005777 if (ret != 0) {
5778 status = mbedtls_to_psa_error(ret);
5779 }
5780 if (status != PSA_SUCCESS) {
5781 mbedtls_free(*data);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005782 *data = NULL;
5783 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005784 mbedtls_mpi_free(&k);
5785 mbedtls_mpi_free(&diff_N_2);
5786 return status;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005787}
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005788
5789/* ECC keys on a Montgomery elliptic curve draws a byte string whose length
5790 * is determined by the curve, and sets the mandatory bits accordingly. That is:
5791 *
5792 * - Curve25519 (PSA_ECC_FAMILY_MONTGOMERY, 255 bits):
5793 * draw a 32-byte string and process it as specified in
5794 * Elliptic Curves for Security [RFC7748] §5.
5795 *
5796 * - Curve448 (PSA_ECC_FAMILY_MONTGOMERY, 448 bits):
5797 * draw a 56-byte string and process it as specified in [RFC7748] §5.
5798 *
5799 * Note: Function allocates memory for *data buffer, so given *data should be
5800 * always NULL.
5801 */
5802
5803static psa_status_t psa_generate_derived_ecc_key_montgomery_helper(
5804 size_t bits,
5805 psa_key_derivation_operation_t *operation,
5806 uint8_t **data
5807 )
5808{
5809 size_t output_length;
Przemek Stekiela81aed22022-03-01 15:13:30 +01005810 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005811
Gilles Peskine449bd832023-01-11 14:50:10 +01005812 switch (bits) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005813 case 255:
5814 output_length = 32;
5815 break;
5816 case 448:
5817 output_length = 56;
5818 break;
5819 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005820 return PSA_ERROR_INVALID_ARGUMENT;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005821 break;
5822 }
5823
Gilles Peskine449bd832023-01-11 14:50:10 +01005824 *data = mbedtls_calloc(1, output_length);
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005825
Gilles Peskine449bd832023-01-11 14:50:10 +01005826 if (*data == NULL) {
5827 return PSA_ERROR_INSUFFICIENT_MEMORY;
5828 }
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005829
Gilles Peskine449bd832023-01-11 14:50:10 +01005830 status = psa_key_derivation_output_bytes(operation, *data, output_length);
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005831
Gilles Peskine449bd832023-01-11 14:50:10 +01005832 if (status != PSA_SUCCESS) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005833 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01005834 }
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005835
Gilles Peskine449bd832023-01-11 14:50:10 +01005836 switch (bits) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005837 case 255:
5838 (*data)[0] &= 248;
5839 (*data)[31] &= 127;
5840 (*data)[31] |= 64;
5841 break;
5842 case 448:
5843 (*data)[0] &= 252;
5844 (*data)[55] |= 128;
5845 break;
5846 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005847 return PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005848 break;
5849 }
5850
5851 return status;
5852}
Valerio Setti86587ab2023-06-27 13:09:30 +02005853#else /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE */
5854static psa_status_t psa_generate_derived_ecc_key_weierstrass_helper(
5855 psa_key_slot_t *slot, size_t bits,
5856 psa_key_derivation_operation_t *operation, uint8_t **data)
5857{
5858 (void) slot;
5859 (void) bits;
5860 (void) operation;
5861 (void) data;
5862 return PSA_ERROR_NOT_SUPPORTED;
5863}
5864
5865static psa_status_t psa_generate_derived_ecc_key_montgomery_helper(
5866 size_t bits, psa_key_derivation_operation_t *operation, uint8_t **data)
5867{
5868 (void) bits;
5869 (void) operation;
5870 (void) data;
5871 return PSA_ERROR_NOT_SUPPORTED;
5872}
5873#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE */
5874#endif /* PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE */
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005875
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01005876static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005877 psa_key_slot_t *slot,
5878 size_t bits,
Gilles Peskine449bd832023-01-11 14:50:10 +01005879 psa_key_derivation_operation_t *operation)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005880{
5881 uint8_t *data = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01005882 size_t bytes = PSA_BITS_TO_BYTES(bits);
Archanad8a83dc2021-06-14 10:04:16 +05305883 size_t storage_size = bytes;
Przemek Stekiela81aed22022-03-01 15:13:30 +01005884 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01005885 psa_key_attributes_t attributes;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005886
Gilles Peskine449bd832023-01-11 14:50:10 +01005887 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(slot->attr.type)) {
5888 return PSA_ERROR_INVALID_ARGUMENT;
5889 }
Gilles Peskineeab56e42018-07-12 17:12:33 +02005890
Valerio Setti8ffdb5d2023-06-20 13:14:08 +02005891#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE) || \
Valerio Settidd24f292023-06-26 12:21:17 +02005892 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE)
Gilles Peskine449bd832023-01-11 14:50:10 +01005893 if (PSA_KEY_TYPE_IS_ECC(slot->attr.type)) {
5894 psa_ecc_family_t curve = PSA_KEY_TYPE_ECC_GET_FAMILY(slot->attr.type);
5895 if (PSA_ECC_FAMILY_IS_WEIERSTRASS(curve)) {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01005896 /* Weierstrass elliptic curve */
Gilles Peskine449bd832023-01-11 14:50:10 +01005897 status = psa_generate_derived_ecc_key_weierstrass_helper(slot, bits, operation, &data);
5898 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005899 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005900 }
5901 } else {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01005902 /* Montgomery elliptic curve */
Gilles Peskine449bd832023-01-11 14:50:10 +01005903 status = psa_generate_derived_ecc_key_montgomery_helper(bits, operation, &data);
5904 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01005905 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005906 }
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01005907 }
Przemyslaw Stekiel1dfd1222021-11-18 13:35:00 +01005908 } else
Valerio Setti8ffdb5d2023-06-20 13:14:08 +02005909#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE) ||
Valerio Settidd24f292023-06-26 12:21:17 +02005910 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE) */
Gilles Peskine449bd832023-01-11 14:50:10 +01005911 if (key_type_is_raw_bytes(slot->attr.type)) {
5912 if (bits % 8 != 0) {
5913 return PSA_ERROR_INVALID_ARGUMENT;
5914 }
5915 data = mbedtls_calloc(1, bytes);
5916 if (data == NULL) {
5917 return PSA_ERROR_INSUFFICIENT_MEMORY;
5918 }
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01005919
Gilles Peskine449bd832023-01-11 14:50:10 +01005920 status = psa_key_derivation_output_bytes(operation, data, bytes);
5921 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01005922 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005923 }
David Brown12ca5032021-02-11 11:02:00 -07005924#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01005925 if (slot->attr.type == PSA_KEY_TYPE_DES) {
5926 psa_des_set_key_parity(data, bytes);
5927 }
Przemek Stekielf110dc02022-03-01 14:48:05 +01005928#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES) */
Gilles Peskine449bd832023-01-11 14:50:10 +01005929 } else {
5930 return PSA_ERROR_NOT_SUPPORTED;
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01005931 }
Ronald Crondd04d422020-11-28 15:14:42 +01005932
Ronald Cronbf33c932020-11-28 18:06:53 +01005933 slot->attr.bits = (psa_key_bits_t) bits;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01005934 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01005935 .core = slot->attr
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01005936 };
5937
Gilles Peskine449bd832023-01-11 14:50:10 +01005938 if (psa_key_lifetime_is_external(attributes.core.lifetime)) {
5939 status = psa_driver_wrapper_get_key_buffer_size(&attributes,
5940 &storage_size);
5941 if (status != PSA_SUCCESS) {
Archanad8a83dc2021-06-14 10:04:16 +05305942 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005943 }
Archanad8a83dc2021-06-14 10:04:16 +05305944 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005945 status = psa_allocate_buffer_to_slot(slot, storage_size);
5946 if (status != PSA_SUCCESS) {
Archanad8a83dc2021-06-14 10:04:16 +05305947 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005948 }
Archanad8a83dc2021-06-14 10:04:16 +05305949
Gilles Peskine449bd832023-01-11 14:50:10 +01005950 status = psa_driver_wrapper_import_key(&attributes,
5951 data, bytes,
5952 slot->key.data,
5953 slot->key.bytes,
5954 &slot->key.bytes, &bits);
5955 if (bits != slot->attr.bits) {
Ronald Cronbf33c932020-11-28 18:06:53 +01005956 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine449bd832023-01-11 14:50:10 +01005957 }
Gilles Peskineeab56e42018-07-12 17:12:33 +02005958
5959exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005960 mbedtls_free(data);
5961 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005962}
5963
Gilles Peskine449bd832023-01-11 14:50:10 +01005964psa_status_t psa_key_derivation_output_key(const psa_key_attributes_t *attributes,
5965 psa_key_derivation_operation_t *operation,
5966 mbedtls_svc_key_id_t *key)
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005967{
5968 psa_status_t status;
5969 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02005970 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine0f84d622019-09-12 19:03:13 +02005971
Ronald Cron81709fc2020-11-14 12:10:32 +01005972 *key = MBEDTLS_SVC_KEY_ID_INIT;
5973
Gilles Peskine0f84d622019-09-12 19:03:13 +02005974 /* Reject any attempt to create a zero-length key so that we don't
5975 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005976 if (psa_get_key_bits(attributes) == 0) {
5977 return PSA_ERROR_INVALID_ARGUMENT;
5978 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02005979
Gilles Peskine449bd832023-01-11 14:50:10 +01005980 if (operation->alg == PSA_ALG_NONE) {
5981 return PSA_ERROR_BAD_STATE;
5982 }
Dave Rodgmand69da6c2021-11-16 10:32:48 +00005983
Gilles Peskine449bd832023-01-11 14:50:10 +01005984 if (!operation->can_output_key) {
5985 return PSA_ERROR_NOT_PERMITTED;
5986 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02005987
Gilles Peskine449bd832023-01-11 14:50:10 +01005988 status = psa_start_key_creation(PSA_KEY_CREATION_DERIVE, attributes,
5989 &slot, &driver);
Gilles Peskinef4ee6622019-07-24 13:44:30 +02005990#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005991 if (driver != NULL) {
Gilles Peskinef4ee6622019-07-24 13:44:30 +02005992 /* Deriving a key in a secure element is not implemented yet. */
5993 status = PSA_ERROR_NOT_SUPPORTED;
5994 }
5995#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine449bd832023-01-11 14:50:10 +01005996 if (status == PSA_SUCCESS) {
5997 status = psa_generate_derived_key_internal(slot,
5998 attributes->core.bits,
5999 operation);
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006000 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006001 if (status == PSA_SUCCESS) {
6002 status = psa_finish_key_creation(slot, driver, key);
6003 }
6004 if (status != PSA_SUCCESS) {
6005 psa_fail_key_creation(slot, driver);
6006 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02006007
Gilles Peskine449bd832023-01-11 14:50:10 +01006008 return status;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006009}
6010
Gilles Peskineeab56e42018-07-12 17:12:33 +02006011
6012
6013/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02006014/* Key derivation */
6015/****************************************************************/
6016
Steven Cooreman932ffb72021-02-15 12:14:32 +01006017#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006018static int is_kdf_alg_supported(psa_algorithm_t kdf_alg)
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006019{
6020#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006021 if (PSA_ALG_IS_HKDF(kdf_alg)) {
6022 return 1;
6023 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006024#endif
Przemek Stekielb57a44b2022-06-06 08:33:45 +02006025#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006026 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6027 return 1;
6028 }
Przemek Stekielb57a44b2022-06-06 08:33:45 +02006029#endif
6030#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006031 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
6032 return 1;
6033 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006034#endif
6035#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006036 if (PSA_ALG_IS_TLS12_PRF(kdf_alg)) {
6037 return 1;
6038 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006039#endif
6040#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006041 if (PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
6042 return 1;
6043 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006044#endif
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006045#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006046 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
6047 return 1;
6048 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006049#endif
Kusumit Ghoderaod132cac2023-05-03 12:00:27 +05306050#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
6051 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
6052 return 1;
6053 }
6054#endif
Kusumit Ghoderao2cd64962023-06-22 15:38:57 +05306055#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128)
6056 if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
6057 return 1;
6058 }
6059#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006060 return 0;
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006061}
6062
Gilles Peskine449bd832023-01-11 14:50:10 +01006063static psa_status_t psa_hash_try_support(psa_algorithm_t alg)
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006064{
6065 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01006066 psa_status_t status = psa_hash_setup(&operation, alg);
6067 psa_hash_abort(&operation);
6068 return status;
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006069}
6070
Gilles Peskine969c5d62019-01-16 15:53:06 +01006071static psa_status_t psa_key_derivation_setup_kdf(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006072 psa_key_derivation_operation_t *operation,
Gilles Peskine449bd832023-01-11 14:50:10 +01006073 psa_algorithm_t kdf_alg)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006074{
Janos Follath5fe19732019-06-20 15:09:30 +01006075 /* Make sure that operation->ctx is properly zero-initialised. (Macro
6076 * initialisers for this union leave some bytes unspecified.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01006077 memset(&operation->ctx, 0, sizeof(operation->ctx));
Janos Follath5fe19732019-06-20 15:09:30 +01006078
Gilles Peskine969c5d62019-01-16 15:53:06 +01006079 /* Make sure that kdf_alg is a supported key derivation algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006080 if (!is_kdf_alg_supported(kdf_alg)) {
6081 return PSA_ERROR_NOT_SUPPORTED;
6082 }
John Durkop07cc04a2020-11-16 22:08:34 -08006083
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006084 /* All currently supported key derivation algorithms (apart from
Kusumit Ghoderao2cd64962023-06-22 15:38:57 +05306085 * ecjpake to pms and pbkdf2_aes_cmac_128) are based on a hash algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006086 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
6087 size_t hash_size = PSA_HASH_LENGTH(hash_alg);
Kusumit Ghoderao2cd64962023-06-22 15:38:57 +05306088 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
6089 hash_size = PSA_HASH_LENGTH(PSA_ALG_SHA_256);
6090 } else if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306091 hash_size = PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC);
Kusumit Ghoderao2cd64962023-06-22 15:38:57 +05306092 } else {
Gilles Peskine449bd832023-01-11 14:50:10 +01006093 if (hash_size == 0) {
6094 return PSA_ERROR_NOT_SUPPORTED;
6095 }
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006096
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006097 /* Make sure that hash_alg is a supported hash algorithm. Otherwise
6098 * we might fail later, which is somewhat unfriendly and potentially
6099 * risk-prone. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006100 psa_status_t status = psa_hash_try_support(hash_alg);
6101 if (status != PSA_SUCCESS) {
6102 return status;
6103 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006104 }
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006105
Gilles Peskine449bd832023-01-11 14:50:10 +01006106 if ((PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
6107 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) &&
6108 !(hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384)) {
6109 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006110 }
Andrzej Kurek77638292022-09-16 12:24:52 -04006111#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT) || \
Andrzej Kurekb510cd22022-09-26 10:50:22 -04006112 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006113 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg) ||
6114 (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS)) {
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006115 operation->capacity = hash_size;
Gilles Peskine449bd832023-01-11 14:50:10 +01006116 } else
Andrzej Kurekb510cd22022-09-26 10:50:22 -04006117#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT ||
6118 MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Gilles Peskine449bd832023-01-11 14:50:10 +01006119 operation->capacity = 255 * hash_size;
6120 return PSA_SUCCESS;
Gilles Peskine969c5d62019-01-16 15:53:06 +01006121}
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006122
Gilles Peskine449bd832023-01-11 14:50:10 +01006123static psa_status_t psa_key_agreement_try_support(psa_algorithm_t alg)
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006124{
6125#if defined(PSA_WANT_ALG_ECDH)
Gilles Peskine449bd832023-01-11 14:50:10 +01006126 if (alg == PSA_ALG_ECDH) {
6127 return PSA_SUCCESS;
6128 }
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006129#endif
Przemek Stekielfb3dd542022-12-01 14:59:15 +01006130#if defined(PSA_WANT_ALG_FFDH)
6131 if (alg == PSA_ALG_FFDH) {
6132 return PSA_SUCCESS;
6133 }
6134#endif
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006135 (void) alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01006136 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006137}
Gilles Peskinebb3814c2022-12-16 01:12:12 +01006138
6139static int psa_key_derivation_allows_free_form_secret_input(
6140 psa_algorithm_t kdf_alg)
6141{
6142#if defined(PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS)
6143 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
6144 return 0;
6145 }
6146#endif
6147 (void) kdf_alg;
6148 return 1;
6149}
John Durkop07cc04a2020-11-16 22:08:34 -08006150#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01006151
Gilles Peskine449bd832023-01-11 14:50:10 +01006152psa_status_t psa_key_derivation_setup(psa_key_derivation_operation_t *operation,
6153 psa_algorithm_t alg)
Gilles Peskine969c5d62019-01-16 15:53:06 +01006154{
6155 psa_status_t status;
6156
Gilles Peskine449bd832023-01-11 14:50:10 +01006157 if (operation->alg != 0) {
6158 return PSA_ERROR_BAD_STATE;
Gilles Peskine969c5d62019-01-16 15:53:06 +01006159 }
Gilles Peskine969c5d62019-01-16 15:53:06 +01006160
Gilles Peskine449bd832023-01-11 14:50:10 +01006161 if (PSA_ALG_IS_RAW_KEY_AGREEMENT(alg)) {
6162 return PSA_ERROR_INVALID_ARGUMENT;
6163 } else if (PSA_ALG_IS_KEY_AGREEMENT(alg)) {
6164#if defined(AT_LEAST_ONE_BUILTIN_KDF)
6165 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF(alg);
6166 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE(alg);
6167 status = psa_key_agreement_try_support(ka_alg);
6168 if (status != PSA_SUCCESS) {
6169 return status;
6170 }
Gilles Peskinebb3814c2022-12-16 01:12:12 +01006171 if (!psa_key_derivation_allows_free_form_secret_input(kdf_alg)) {
6172 return PSA_ERROR_INVALID_ARGUMENT;
6173 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006174 status = psa_key_derivation_setup_kdf(operation, kdf_alg);
6175#else
6176 return PSA_ERROR_NOT_SUPPORTED;
6177#endif /* AT_LEAST_ONE_BUILTIN_KDF */
6178 } else if (PSA_ALG_IS_KEY_DERIVATION(alg)) {
6179#if defined(AT_LEAST_ONE_BUILTIN_KDF)
6180 status = psa_key_derivation_setup_kdf(operation, alg);
6181#else
6182 return PSA_ERROR_NOT_SUPPORTED;
6183#endif /* AT_LEAST_ONE_BUILTIN_KDF */
6184 } else {
6185 return PSA_ERROR_INVALID_ARGUMENT;
6186 }
6187
6188 if (status == PSA_SUCCESS) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006189 operation->alg = alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01006190 }
6191 return status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006192}
6193
Przemek Stekiel69c46792022-06-10 12:59:51 +02006194#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006195static psa_status_t psa_hkdf_input(psa_hkdf_key_derivation_t *hkdf,
6196 psa_algorithm_t kdf_alg,
6197 psa_key_derivation_step_t step,
6198 const uint8_t *data,
6199 size_t data_length)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006200{
Gilles Peskine449bd832023-01-11 14:50:10 +01006201 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006202 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006203 switch (step) {
Gilles Peskine03410b52019-05-16 16:05:19 +02006204 case PSA_KEY_DERIVATION_INPUT_SALT:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006205#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006206 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
6207 return PSA_ERROR_INVALID_ARGUMENT;
6208 }
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006209#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND */
Gilles Peskine449bd832023-01-11 14:50:10 +01006210 if (hkdf->state != HKDF_STATE_INIT) {
6211 return PSA_ERROR_BAD_STATE;
6212 } else {
6213 status = psa_key_derivation_start_hmac(&hkdf->hmac,
6214 hash_alg,
6215 data, data_length);
6216 if (status != PSA_SUCCESS) {
6217 return status;
6218 }
Steven Cooremand1ed1d92021-04-29 19:11:25 +02006219 hkdf->state = HKDF_STATE_STARTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01006220 return PSA_SUCCESS;
Steven Cooremand1ed1d92021-04-29 19:11:25 +02006221 }
Gilles Peskine03410b52019-05-16 16:05:19 +02006222 case PSA_KEY_DERIVATION_INPUT_SECRET:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006223#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006224 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
Przemek Stekiel2fb0dcd2022-05-19 10:34:37 +02006225 /* We shouldn't be in different state as HKDF_EXPAND only allows
6226 * two inputs: SECRET (this case) and INFO which does not modify
6227 * the state. It could happen only if the hkdf
6228 * object was corrupted. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006229 if (hkdf->state != HKDF_STATE_INIT) {
6230 return PSA_ERROR_BAD_STATE;
6231 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006232
Przemek Stekiel2fb0dcd2022-05-19 10:34:37 +02006233 /* Allow only input that fits expected prk size */
Gilles Peskine449bd832023-01-11 14:50:10 +01006234 if (data_length != PSA_HASH_LENGTH(hash_alg)) {
6235 return PSA_ERROR_INVALID_ARGUMENT;
6236 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006237
Gilles Peskine449bd832023-01-11 14:50:10 +01006238 memcpy(hkdf->prk, data, data_length);
6239 } else
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006240#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND */
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006241 {
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006242 /* HKDF: If no salt was provided, use an empty salt.
6243 * HKDF-EXTRACT: salt is mandatory. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006244 if (hkdf->state == HKDF_STATE_INIT) {
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006245#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006246 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6247 return PSA_ERROR_BAD_STATE;
6248 }
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006249#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01006250 status = psa_key_derivation_start_hmac(&hkdf->hmac,
6251 hash_alg,
6252 NULL, 0);
6253 if (status != PSA_SUCCESS) {
6254 return status;
6255 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006256 hkdf->state = HKDF_STATE_STARTED;
6257 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006258 if (hkdf->state != HKDF_STATE_STARTED) {
6259 return PSA_ERROR_BAD_STATE;
6260 }
6261 status = psa_mac_update(&hkdf->hmac,
6262 data, data_length);
6263 if (status != PSA_SUCCESS) {
6264 return status;
6265 }
6266 status = psa_mac_sign_finish(&hkdf->hmac,
6267 hkdf->prk,
6268 sizeof(hkdf->prk),
6269 &data_length);
6270 if (status != PSA_SUCCESS) {
6271 return status;
6272 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006273 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006274
Gilles Peskine2b522db2019-04-12 15:11:49 +02006275 hkdf->state = HKDF_STATE_KEYED;
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006276 hkdf->block_number = 0;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006277#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006278 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006279 /* The only block of output is the PRK. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006280 memcpy(hkdf->output_block, hkdf->prk, PSA_HASH_LENGTH(hash_alg));
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006281 hkdf->offset_in_block = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01006282 } else
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006283#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006284 {
6285 /* Block 0 is empty, and the next block will be
6286 * generated by psa_key_derivation_hkdf_read(). */
Gilles Peskine449bd832023-01-11 14:50:10 +01006287 hkdf->offset_in_block = PSA_HASH_LENGTH(hash_alg);
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006288 }
6289
Gilles Peskine449bd832023-01-11 14:50:10 +01006290 return PSA_SUCCESS;
Gilles Peskine03410b52019-05-16 16:05:19 +02006291 case PSA_KEY_DERIVATION_INPUT_INFO:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006292#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006293 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6294 return PSA_ERROR_INVALID_ARGUMENT;
6295 }
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006296#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Przemek Stekielcde3f782022-06-03 16:12:27 +02006297#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006298 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg) &&
6299 hkdf->state == HKDF_STATE_INIT) {
6300 return PSA_ERROR_BAD_STATE;
6301 }
Przemek Stekielcde3f782022-06-03 16:12:27 +02006302#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01006303 if (hkdf->state == HKDF_STATE_OUTPUT) {
6304 return PSA_ERROR_BAD_STATE;
6305 }
6306 if (hkdf->info_set) {
6307 return PSA_ERROR_BAD_STATE;
6308 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006309 hkdf->info_length = data_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01006310 if (data_length != 0) {
6311 hkdf->info = mbedtls_calloc(1, data_length);
6312 if (hkdf->info == NULL) {
6313 return PSA_ERROR_INSUFFICIENT_MEMORY;
6314 }
6315 memcpy(hkdf->info, data, data_length);
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006316 }
6317 hkdf->info_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01006318 return PSA_SUCCESS;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006319 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006320 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006321 }
6322}
Przemek Stekiel69c46792022-06-10 12:59:51 +02006323#endif /* BUILTIN_ALG_ANY_HKDF */
Janos Follathb03233e2019-06-11 15:30:30 +01006324
John Durkop07cc04a2020-11-16 22:08:34 -08006325#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
6326 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006327static psa_status_t psa_tls12_prf_set_seed(psa_tls12_prf_key_derivation_t *prf,
6328 const uint8_t *data,
6329 size_t data_length)
Janos Follathf08e2652019-06-13 09:05:41 +01006330{
Gilles Peskine449bd832023-01-11 14:50:10 +01006331 if (prf->state != PSA_TLS12_PRF_STATE_INIT) {
6332 return PSA_ERROR_BAD_STATE;
6333 }
Janos Follathf08e2652019-06-13 09:05:41 +01006334
Gilles Peskine449bd832023-01-11 14:50:10 +01006335 if (data_length != 0) {
6336 prf->seed = mbedtls_calloc(1, data_length);
6337 if (prf->seed == NULL) {
6338 return PSA_ERROR_INSUFFICIENT_MEMORY;
6339 }
Janos Follathf08e2652019-06-13 09:05:41 +01006340
Gilles Peskine449bd832023-01-11 14:50:10 +01006341 memcpy(prf->seed, data, data_length);
Janos Follathd6dce9f2019-07-04 09:11:38 +01006342 prf->seed_length = data_length;
6343 }
Janos Follathf08e2652019-06-13 09:05:41 +01006344
Gilles Peskine43f958b2020-12-13 14:55:14 +01006345 prf->state = PSA_TLS12_PRF_STATE_SEED_SET;
Janos Follathf08e2652019-06-13 09:05:41 +01006346
Gilles Peskine449bd832023-01-11 14:50:10 +01006347 return PSA_SUCCESS;
Janos Follathf08e2652019-06-13 09:05:41 +01006348}
6349
Gilles Peskine449bd832023-01-11 14:50:10 +01006350static psa_status_t psa_tls12_prf_set_key(psa_tls12_prf_key_derivation_t *prf,
6351 const uint8_t *data,
6352 size_t data_length)
Janos Follath81550542019-06-13 14:26:34 +01006353{
Gilles Peskine449bd832023-01-11 14:50:10 +01006354 if (prf->state != PSA_TLS12_PRF_STATE_SEED_SET &&
6355 prf->state != PSA_TLS12_PRF_STATE_OTHER_KEY_SET) {
6356 return PSA_ERROR_BAD_STATE;
6357 }
Janos Follath81550542019-06-13 14:26:34 +01006358
Gilles Peskine449bd832023-01-11 14:50:10 +01006359 if (data_length != 0) {
6360 prf->secret = mbedtls_calloc(1, data_length);
6361 if (prf->secret == NULL) {
6362 return PSA_ERROR_INSUFFICIENT_MEMORY;
6363 }
Steven Cooremana6df6042021-04-29 19:32:25 +02006364
Gilles Peskine449bd832023-01-11 14:50:10 +01006365 memcpy(prf->secret, data, data_length);
Steven Cooremana6df6042021-04-29 19:32:25 +02006366 prf->secret_length = data_length;
6367 }
Janos Follath81550542019-06-13 14:26:34 +01006368
Gilles Peskine43f958b2020-12-13 14:55:14 +01006369 prf->state = PSA_TLS12_PRF_STATE_KEY_SET;
Janos Follath81550542019-06-13 14:26:34 +01006370
Gilles Peskine449bd832023-01-11 14:50:10 +01006371 return PSA_SUCCESS;
Janos Follath81550542019-06-13 14:26:34 +01006372}
6373
Gilles Peskine449bd832023-01-11 14:50:10 +01006374static psa_status_t psa_tls12_prf_set_label(psa_tls12_prf_key_derivation_t *prf,
6375 const uint8_t *data,
6376 size_t data_length)
Janos Follath63028dd2019-06-13 09:15:47 +01006377{
Gilles Peskine449bd832023-01-11 14:50:10 +01006378 if (prf->state != PSA_TLS12_PRF_STATE_KEY_SET) {
6379 return PSA_ERROR_BAD_STATE;
6380 }
Janos Follath63028dd2019-06-13 09:15:47 +01006381
Gilles Peskine449bd832023-01-11 14:50:10 +01006382 if (data_length != 0) {
6383 prf->label = mbedtls_calloc(1, data_length);
6384 if (prf->label == NULL) {
6385 return PSA_ERROR_INSUFFICIENT_MEMORY;
6386 }
Janos Follath63028dd2019-06-13 09:15:47 +01006387
Gilles Peskine449bd832023-01-11 14:50:10 +01006388 memcpy(prf->label, data, data_length);
Janos Follathd6dce9f2019-07-04 09:11:38 +01006389 prf->label_length = data_length;
6390 }
Janos Follath63028dd2019-06-13 09:15:47 +01006391
Gilles Peskine43f958b2020-12-13 14:55:14 +01006392 prf->state = PSA_TLS12_PRF_STATE_LABEL_SET;
Janos Follath63028dd2019-06-13 09:15:47 +01006393
Gilles Peskine449bd832023-01-11 14:50:10 +01006394 return PSA_SUCCESS;
Janos Follath63028dd2019-06-13 09:15:47 +01006395}
6396
Gilles Peskine449bd832023-01-11 14:50:10 +01006397static psa_status_t psa_tls12_prf_input(psa_tls12_prf_key_derivation_t *prf,
6398 psa_key_derivation_step_t step,
6399 const uint8_t *data,
6400 size_t data_length)
Janos Follathb03233e2019-06-11 15:30:30 +01006401{
Gilles Peskine449bd832023-01-11 14:50:10 +01006402 switch (step) {
Janos Follathf08e2652019-06-13 09:05:41 +01006403 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskine449bd832023-01-11 14:50:10 +01006404 return psa_tls12_prf_set_seed(prf, data, data_length);
Janos Follath81550542019-06-13 14:26:34 +01006405 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006406 return psa_tls12_prf_set_key(prf, data, data_length);
Janos Follath63028dd2019-06-13 09:15:47 +01006407 case PSA_KEY_DERIVATION_INPUT_LABEL:
Gilles Peskine449bd832023-01-11 14:50:10 +01006408 return psa_tls12_prf_set_label(prf, data, data_length);
Janos Follathb03233e2019-06-11 15:30:30 +01006409 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006410 return PSA_ERROR_INVALID_ARGUMENT;
Janos Follathb03233e2019-06-11 15:30:30 +01006411 }
6412}
John Durkop07cc04a2020-11-16 22:08:34 -08006413#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
6414 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
6415
6416#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
6417static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
6418 psa_tls12_prf_key_derivation_t *prf,
John Durkop07cc04a2020-11-16 22:08:34 -08006419 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006420 size_t data_length)
John Durkop07cc04a2020-11-16 22:08:34 -08006421{
6422 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006423 const size_t pms_len = (prf->state == PSA_TLS12_PRF_STATE_OTHER_KEY_SET ?
6424 4 + data_length + prf->other_secret_length :
6425 4 + 2 * data_length);
John Durkop07cc04a2020-11-16 22:08:34 -08006426
Gilles Peskine449bd832023-01-11 14:50:10 +01006427 if (data_length > PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE) {
6428 return PSA_ERROR_INVALID_ARGUMENT;
6429 }
John Durkop07cc04a2020-11-16 22:08:34 -08006430
Gilles Peskine449bd832023-01-11 14:50:10 +01006431 uint8_t *pms = mbedtls_calloc(1, pms_len);
6432 if (pms == NULL) {
6433 return PSA_ERROR_INSUFFICIENT_MEMORY;
6434 }
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02006435 uint8_t *cur = pms;
6436
6437 /* pure-PSK:
6438 * Quoting RFC 4279, Section 2:
John Durkop07cc04a2020-11-16 22:08:34 -08006439 *
6440 * The premaster secret is formed as follows: if the PSK is N octets
6441 * long, concatenate a uint16 with the value N, N zero octets, a second
6442 * uint16 with the value N, and the PSK itself.
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02006443 *
6444 * mixed-PSK:
6445 * In a DHE-PSK, RSA-PSK, ECDHE-PSK the premaster secret is formed as
6446 * follows: concatenate a uint16 with the length of the other secret,
6447 * the other secret itself, uint16 with the length of PSK, and the
6448 * PSK itself.
6449 * For details please check:
6450 * - RFC 4279, Section 4 for the definition of RSA-PSK,
6451 * - RFC 4279, Section 3 for the definition of DHE-PSK,
6452 * - RFC 5489 for the definition of ECDHE-PSK.
John Durkop07cc04a2020-11-16 22:08:34 -08006453 */
6454
Gilles Peskine449bd832023-01-11 14:50:10 +01006455 if (prf->state == PSA_TLS12_PRF_STATE_OTHER_KEY_SET) {
6456 *cur++ = MBEDTLS_BYTE_1(prf->other_secret_length);
6457 *cur++ = MBEDTLS_BYTE_0(prf->other_secret_length);
6458 if (prf->other_secret_length != 0) {
6459 memcpy(cur, prf->other_secret, prf->other_secret_length);
6460 mbedtls_platform_zeroize(prf->other_secret, prf->other_secret_length);
Przemek Stekiel2503f7e2022-04-12 12:08:01 +02006461 cur += prf->other_secret_length;
6462 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006463 } else {
6464 *cur++ = MBEDTLS_BYTE_1(data_length);
6465 *cur++ = MBEDTLS_BYTE_0(data_length);
6466 memset(cur, 0, data_length);
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02006467 cur += data_length;
6468 }
6469
Gilles Peskine449bd832023-01-11 14:50:10 +01006470 *cur++ = MBEDTLS_BYTE_1(data_length);
6471 *cur++ = MBEDTLS_BYTE_0(data_length);
6472 memcpy(cur, data, data_length);
John Durkop07cc04a2020-11-16 22:08:34 -08006473 cur += data_length;
6474
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00006475 status = psa_tls12_prf_set_key(prf, pms, (size_t) (cur - pms));
John Durkop07cc04a2020-11-16 22:08:34 -08006476
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01006477 mbedtls_zeroize_and_free(pms, pms_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01006478 return status;
John Durkop07cc04a2020-11-16 22:08:34 -08006479}
Janos Follath6660f0e2019-06-17 08:44:03 +01006480
Przemek Stekiele47201b2022-04-19 13:53:28 +02006481static psa_status_t psa_tls12_prf_psk_to_ms_set_other_key(
6482 psa_tls12_prf_key_derivation_t *prf,
6483 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006484 size_t data_length)
Przemek Stekiele47201b2022-04-19 13:53:28 +02006485{
Gilles Peskine449bd832023-01-11 14:50:10 +01006486 if (prf->state != PSA_TLS12_PRF_STATE_SEED_SET) {
6487 return PSA_ERROR_BAD_STATE;
Przemek Stekiele47201b2022-04-19 13:53:28 +02006488 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006489
6490 if (data_length != 0) {
6491 prf->other_secret = mbedtls_calloc(1, data_length);
6492 if (prf->other_secret == NULL) {
6493 return PSA_ERROR_INSUFFICIENT_MEMORY;
6494 }
6495
6496 memcpy(prf->other_secret, data, data_length);
6497 prf->other_secret_length = data_length;
6498 } else {
Przemek Stekiele47201b2022-04-19 13:53:28 +02006499 prf->other_secret_length = 0;
6500 }
6501
6502 prf->state = PSA_TLS12_PRF_STATE_OTHER_KEY_SET;
6503
Gilles Peskine449bd832023-01-11 14:50:10 +01006504 return PSA_SUCCESS;
Przemek Stekiele47201b2022-04-19 13:53:28 +02006505}
6506
Janos Follath6660f0e2019-06-17 08:44:03 +01006507static psa_status_t psa_tls12_prf_psk_to_ms_input(
6508 psa_tls12_prf_key_derivation_t *prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01006509 psa_key_derivation_step_t step,
6510 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006511 size_t data_length)
Janos Follath6660f0e2019-06-17 08:44:03 +01006512{
Gilles Peskine449bd832023-01-11 14:50:10 +01006513 switch (step) {
Przemek Stekiele47201b2022-04-19 13:53:28 +02006514 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006515 return psa_tls12_prf_psk_to_ms_set_key(prf,
6516 data, data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02006517 break;
6518 case PSA_KEY_DERIVATION_INPUT_OTHER_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006519 return psa_tls12_prf_psk_to_ms_set_other_key(prf,
6520 data,
6521 data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02006522 break;
6523 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006524 return psa_tls12_prf_input(prf, step, data, data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02006525 break;
Janos Follath6660f0e2019-06-17 08:44:03 +01006526
Przemek Stekiele47201b2022-04-19 13:53:28 +02006527 }
Janos Follath6660f0e2019-06-17 08:44:03 +01006528}
John Durkop07cc04a2020-11-16 22:08:34 -08006529#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006530
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006531#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
6532static psa_status_t psa_tls12_ecjpake_to_pms_input(
6533 psa_tls12_ecjpake_to_pms_t *ecjpake,
Andrzej Kurek702776f2022-09-16 06:22:44 -04006534 psa_key_derivation_step_t step,
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006535 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006536 size_t data_length)
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006537{
Gilles Peskine449bd832023-01-11 14:50:10 +01006538 if (data_length != PSA_TLS12_ECJPAKE_TO_PMS_INPUT_SIZE ||
6539 step != PSA_KEY_DERIVATION_INPUT_SECRET) {
6540 return PSA_ERROR_INVALID_ARGUMENT;
Andrzej Kurek5603efd2022-09-26 10:49:16 -04006541 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006542
6543 /* Check if the passed point is in an uncompressed form */
Gilles Peskine449bd832023-01-11 14:50:10 +01006544 if (data[0] != 0x04) {
6545 return PSA_ERROR_INVALID_ARGUMENT;
6546 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006547
6548 /* Only K.X has to be extracted - bytes 1 to 32 inclusive. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006549 memcpy(ecjpake->data, data + 1, PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE);
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006550
Gilles Peskine449bd832023-01-11 14:50:10 +01006551 return PSA_SUCCESS;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006552}
6553#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306554
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306555#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306556static psa_status_t psa_pbkdf2_set_input_cost(
6557 psa_pbkdf2_key_derivation_t *pbkdf2,
6558 psa_key_derivation_step_t step,
6559 uint64_t data)
6560{
6561 if (step != PSA_KEY_DERIVATION_INPUT_COST) {
6562 return PSA_ERROR_INVALID_ARGUMENT;
6563 }
6564
6565 if (pbkdf2->state != PSA_PBKDF2_STATE_INIT) {
6566 return PSA_ERROR_BAD_STATE;
6567 }
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05306568
Kusumit Ghoderaoe66a8ad2023-05-24 12:30:43 +05306569 if (data > PSA_VENDOR_PBKDF2_MAX_ITERATIONS) {
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05306570 return PSA_ERROR_NOT_SUPPORTED;
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306571 }
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05306572
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306573 if (data == 0) {
6574 return PSA_ERROR_INVALID_ARGUMENT;
6575 }
Kusumit Ghoderaoe66a8ad2023-05-24 12:30:43 +05306576
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306577 pbkdf2->input_cost = data;
6578 pbkdf2->state = PSA_PBKDF2_STATE_INPUT_COST_SET;
6579
6580 return PSA_SUCCESS;
6581}
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306582
6583static psa_status_t psa_pbkdf2_set_salt(psa_pbkdf2_key_derivation_t *pbkdf2,
6584 const uint8_t *data,
6585 size_t data_length)
6586{
Gilles Peskineead17662023-08-20 22:02:51 +02006587 if (pbkdf2->state == PSA_PBKDF2_STATE_INPUT_COST_SET) {
6588 pbkdf2->state = PSA_PBKDF2_STATE_SALT_SET;
6589 } else if (pbkdf2->state == PSA_PBKDF2_STATE_SALT_SET) {
6590 /* Appending to existing salt. No state change. */
6591 } else {
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306592 return PSA_ERROR_BAD_STATE;
6593 }
6594
Gilles Peskineca57d782023-07-20 19:08:06 +02006595 if (data_length == 0) {
Gilles Peskineead17662023-08-20 22:02:51 +02006596 /* Appending an empty string, nothing to do. */
6597 } else {
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306598 uint8_t *next_salt;
Kusumit Ghoderaob538bb72023-05-24 12:32:14 +05306599
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306600 next_salt = mbedtls_calloc(1, data_length + pbkdf2->salt_length);
6601 if (next_salt == NULL) {
Kusumit Ghoderaod0422f32023-05-08 15:56:19 +05306602 return PSA_ERROR_INSUFFICIENT_MEMORY;
6603 }
6604
Gilles Peskineead17662023-08-20 22:02:51 +02006605 if (pbkdf2->salt_length != 0) {
6606 memcpy(next_salt, pbkdf2->salt, pbkdf2->salt_length);
6607 }
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306608 memcpy(next_salt + pbkdf2->salt_length, data, data_length);
Kusumit Ghoderaod0422f32023-05-08 15:56:19 +05306609 pbkdf2->salt_length += data_length;
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306610 mbedtls_free(pbkdf2->salt);
6611 pbkdf2->salt = next_salt;
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306612 }
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306613 return PSA_SUCCESS;
6614}
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306615
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05306616#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306617static psa_status_t psa_pbkdf2_hmac_set_password(psa_algorithm_t hash_alg,
Kusumit Ghoderaoaac9a582023-05-24 14:19:17 +05306618 const uint8_t *input,
6619 size_t input_len,
6620 uint8_t *output,
Kusumit Ghoderao91f99f52023-05-24 22:21:48 +05306621 size_t *output_len)
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306622{
6623 psa_status_t status = PSA_SUCCESS;
6624 if (input_len > PSA_HASH_BLOCK_LENGTH(hash_alg)) {
6625 status = psa_hash_compute(hash_alg, input, input_len, output,
Kusumit Ghoderao91f99f52023-05-24 22:21:48 +05306626 PSA_HMAC_MAX_HASH_BLOCK_SIZE, output_len);
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306627 } else {
6628 memcpy(output, input, input_len);
Kusumit Ghoderao91f99f52023-05-24 22:21:48 +05306629 *output_len = PSA_HASH_BLOCK_LENGTH(hash_alg);
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306630 }
6631 return status;
6632}
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05306633#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC */
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306634
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05306635#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128)
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306636static psa_status_t psa_pbkdf2_cmac_set_password(const uint8_t *input,
6637 size_t input_len,
6638 uint8_t *output,
6639 size_t *output_len)
6640{
6641 psa_status_t status = PSA_SUCCESS;
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306642 if (input_len != PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC)) {
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306643 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Kusumit Ghoderao3fde8fe2023-06-27 10:41:43 +05306644 uint8_t zeros[16] = { 0 };
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306645 psa_set_key_type(&attributes, PSA_KEY_TYPE_AES);
6646 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(sizeof(zeros)));
6647 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306648 /* Passing PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC) as
Kusumit Ghoderao5f3345a2023-07-27 21:21:38 +05306649 * mac_size as the driver function sets mac_output_length = mac_size
6650 * on success. See https://github.com/Mbed-TLS/mbedtls/issues/7801 */
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306651 status = psa_driver_wrapper_mac_compute(&attributes,
6652 zeros, sizeof(zeros),
6653 PSA_ALG_CMAC, input, input_len,
6654 output,
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306655 PSA_MAC_LENGTH(PSA_KEY_TYPE_AES,
6656 128U,
6657 PSA_ALG_CMAC),
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306658 output_len);
6659 } else {
6660 memcpy(output, input, input_len);
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306661 *output_len = PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC);
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306662 }
6663 return status;
6664}
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05306665#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128 */
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306666
6667static psa_status_t psa_pbkdf2_set_password(psa_pbkdf2_key_derivation_t *pbkdf2,
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306668 psa_algorithm_t kdf_alg,
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306669 const uint8_t *data,
6670 size_t data_length)
6671{
Kusumit Ghoderaoaac9a582023-05-24 14:19:17 +05306672 psa_status_t status = PSA_SUCCESS;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306673 if (pbkdf2->state != PSA_PBKDF2_STATE_SALT_SET) {
6674 return PSA_ERROR_BAD_STATE;
6675 }
6676
Kusumit Ghoderaof3e696d2023-07-28 13:30:50 +05306677#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306678 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
6679 psa_algorithm_t hash_alg = PSA_ALG_PBKDF2_HMAC_GET_HASH(kdf_alg);
6680 status = psa_pbkdf2_hmac_set_password(hash_alg, data, data_length,
6681 pbkdf2->password,
6682 &pbkdf2->password_length);
Kusumit Ghoderaof3e696d2023-07-28 13:30:50 +05306683 } else
6684#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC */
6685#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128)
6686 if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306687 status = psa_pbkdf2_cmac_set_password(data, data_length,
6688 pbkdf2->password,
6689 &pbkdf2->password_length);
Kusumit Ghoderaof3e696d2023-07-28 13:30:50 +05306690 } else
6691#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128 */
6692 {
6693 return PSA_ERROR_INVALID_ARGUMENT;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306694 }
6695
6696 pbkdf2->state = PSA_PBKDF2_STATE_PASSWORD_SET;
6697
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306698 return status;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306699}
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05306700
6701static psa_status_t psa_pbkdf2_input(psa_pbkdf2_key_derivation_t *pbkdf2,
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306702 psa_algorithm_t kdf_alg,
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05306703 psa_key_derivation_step_t step,
6704 const uint8_t *data,
6705 size_t data_length)
6706{
6707 switch (step) {
6708 case PSA_KEY_DERIVATION_INPUT_SALT:
6709 return psa_pbkdf2_set_salt(pbkdf2, data, data_length);
6710 case PSA_KEY_DERIVATION_INPUT_PASSWORD:
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306711 return psa_pbkdf2_set_password(pbkdf2, kdf_alg, data, data_length);
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05306712 default:
6713 return PSA_ERROR_INVALID_ARGUMENT;
6714 }
6715}
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306716#endif /* PSA_HAVE_SOFT_PBKDF2 */
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306717
Gilles Peskineb8965192019-09-24 16:21:10 +02006718/** Check whether the given key type is acceptable for the given
6719 * input step of a key derivation.
6720 *
6721 * Secret inputs must have the type #PSA_KEY_TYPE_DERIVE.
6722 * Non-secret inputs must have the type #PSA_KEY_TYPE_RAW_DATA.
6723 * Both secret and non-secret inputs can alternatively have the type
6724 * #PSA_KEY_TYPE_NONE, which is never the type of a key object, meaning
6725 * that the input was passed as a buffer rather than via a key object.
6726 */
Gilles Peskine224b0d62019-09-23 18:13:17 +02006727static int psa_key_derivation_check_input_type(
6728 psa_key_derivation_step_t step,
Gilles Peskine449bd832023-01-11 14:50:10 +01006729 psa_key_type_t key_type)
Gilles Peskine224b0d62019-09-23 18:13:17 +02006730{
Gilles Peskine449bd832023-01-11 14:50:10 +01006731 switch (step) {
Gilles Peskine224b0d62019-09-23 18:13:17 +02006732 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006733 if (key_type == PSA_KEY_TYPE_DERIVE) {
6734 return PSA_SUCCESS;
6735 }
6736 if (key_type == PSA_KEY_TYPE_NONE) {
6737 return PSA_SUCCESS;
6738 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02006739 break;
Przemek Stekiela7695a22022-04-07 15:39:01 +02006740 case PSA_KEY_DERIVATION_INPUT_OTHER_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006741 if (key_type == PSA_KEY_TYPE_DERIVE) {
6742 return PSA_SUCCESS;
6743 }
6744 if (key_type == PSA_KEY_TYPE_NONE) {
6745 return PSA_SUCCESS;
6746 }
Przemek Stekiela7695a22022-04-07 15:39:01 +02006747 break;
Gilles Peskine224b0d62019-09-23 18:13:17 +02006748 case PSA_KEY_DERIVATION_INPUT_LABEL:
6749 case PSA_KEY_DERIVATION_INPUT_SALT:
6750 case PSA_KEY_DERIVATION_INPUT_INFO:
6751 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskine449bd832023-01-11 14:50:10 +01006752 if (key_type == PSA_KEY_TYPE_RAW_DATA) {
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;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306759 case PSA_KEY_DERIVATION_INPUT_PASSWORD:
6760 if (key_type == PSA_KEY_TYPE_PASSWORD) {
6761 return PSA_SUCCESS;
6762 }
6763 if (key_type == PSA_KEY_TYPE_DERIVE) {
6764 return PSA_SUCCESS;
6765 }
6766 if (key_type == PSA_KEY_TYPE_NONE) {
6767 return PSA_SUCCESS;
6768 }
6769 break;
Gilles Peskine224b0d62019-09-23 18:13:17 +02006770 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006771 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine224b0d62019-09-23 18:13:17 +02006772}
6773
Janos Follathb80a94e2019-06-12 15:54:46 +01006774static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006775 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01006776 psa_key_derivation_step_t step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02006777 psa_key_type_t key_type,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01006778 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006779 size_t data_length)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006780{
Gilles Peskine46d7faf2019-09-23 19:22:55 +02006781 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006782 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
Gilles Peskine46d7faf2019-09-23 19:22:55 +02006783
Gilles Peskine449bd832023-01-11 14:50:10 +01006784 status = psa_key_derivation_check_input_type(step, key_type);
6785 if (status != PSA_SUCCESS) {
Gilles Peskine224b0d62019-09-23 18:13:17 +02006786 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006787 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02006788
Przemek Stekiel69c46792022-06-10 12:59:51 +02006789#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006790 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
6791 status = psa_hkdf_input(&operation->ctx.hkdf, kdf_alg,
6792 step, data, data_length);
6793 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02006794#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08006795#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006796 if (PSA_ALG_IS_TLS12_PRF(kdf_alg)) {
6797 status = psa_tls12_prf_input(&operation->ctx.tls12_prf,
6798 step, data, data_length);
6799 } else
John Durkop07cc04a2020-11-16 22:08:34 -08006800#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF */
6801#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006802 if (PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
6803 status = psa_tls12_prf_psk_to_ms_input(&operation->ctx.tls12_prf,
6804 step, data, data_length);
6805 } else
John Durkop07cc04a2020-11-16 22:08:34 -08006806#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006807#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006808 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006809 status = psa_tls12_ecjpake_to_pms_input(
Gilles Peskine449bd832023-01-11 14:50:10 +01006810 &operation->ctx.tls12_ecjpake_to_pms, step, data, data_length);
6811 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006812#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306813#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05306814 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306815 status = psa_pbkdf2_input(&operation->ctx.pbkdf2, kdf_alg,
6816 step, data, data_length);
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05306817 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306818#endif /* PSA_HAVE_SOFT_PBKDF2 */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006819 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006820 /* This can't happen unless the operation object was not initialized */
Steven Cooreman74afe472021-02-10 17:19:22 +01006821 (void) data;
6822 (void) data_length;
6823 (void) kdf_alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01006824 return PSA_ERROR_BAD_STATE;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006825 }
6826
Gilles Peskine224b0d62019-09-23 18:13:17 +02006827exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01006828 if (status != PSA_SUCCESS) {
6829 psa_key_derivation_abort(operation);
6830 }
6831 return status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006832}
6833
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05306834static psa_status_t psa_key_derivation_input_integer_internal(
6835 psa_key_derivation_operation_t *operation,
6836 psa_key_derivation_step_t step,
6837 uint64_t value)
6838{
6839 psa_status_t status;
6840 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
6841
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306842#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05306843 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306844 status = psa_pbkdf2_set_input_cost(
6845 &operation->ctx.pbkdf2, step, value);
6846 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306847#endif /* PSA_HAVE_SOFT_PBKDF2 */
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05306848 {
Kusumit Ghoderao3a18dee2023-04-07 16:16:27 +05306849 (void) step;
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05306850 (void) value;
6851 (void) kdf_alg;
Kusumit Ghoderaoa14ae5a2023-04-19 14:16:26 +05306852 status = PSA_ERROR_INVALID_ARGUMENT;
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05306853 }
6854
6855 if (status != PSA_SUCCESS) {
6856 psa_key_derivation_abort(operation);
6857 }
6858 return status;
6859}
6860
Janos Follath51f4a0f2019-06-14 11:35:55 +01006861psa_status_t psa_key_derivation_input_bytes(
6862 psa_key_derivation_operation_t *operation,
6863 psa_key_derivation_step_t step,
6864 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006865 size_t data_length)
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01006866{
Gilles Peskine449bd832023-01-11 14:50:10 +01006867 return psa_key_derivation_input_internal(operation, step,
6868 PSA_KEY_TYPE_NONE,
6869 data, data_length);
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01006870}
6871
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05306872psa_status_t psa_key_derivation_input_integer(
6873 psa_key_derivation_operation_t *operation,
6874 psa_key_derivation_step_t step,
6875 uint64_t value)
6876{
6877 return psa_key_derivation_input_integer_internal(operation, step, value);
6878}
6879
Janos Follath51f4a0f2019-06-14 11:35:55 +01006880psa_status_t psa_key_derivation_input_key(
6881 psa_key_derivation_operation_t *operation,
6882 psa_key_derivation_step_t step,
Gilles Peskine449bd832023-01-11 14:50:10 +01006883 mbedtls_svc_key_id_t key)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006884{
Ronald Cronf95a2b12020-10-22 15:24:49 +02006885 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01006886 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006887 psa_key_slot_t *slot;
Gilles Peskine178c9aa2019-09-24 18:21:06 +02006888
Ronald Cron5c522922020-11-14 16:35:34 +01006889 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01006890 key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg);
6891 if (status != PSA_SUCCESS) {
6892 psa_key_derivation_abort(operation);
6893 return status;
Gilles Peskine593773d2019-09-23 18:17:40 +02006894 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02006895
Kusumit Ghoderao3128c5d2023-05-03 12:27:57 +05306896 /* Passing a key object as a SECRET or PASSWORD input unlocks the
6897 * permission to output to a key object. */
6898 if (step == PSA_KEY_DERIVATION_INPUT_SECRET ||
6899 step == PSA_KEY_DERIVATION_INPUT_PASSWORD) {
Gilles Peskine178c9aa2019-09-24 18:21:06 +02006900 operation->can_output_key = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01006901 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02006902
Gilles Peskine449bd832023-01-11 14:50:10 +01006903 status = psa_key_derivation_input_internal(operation,
6904 step, slot->attr.type,
6905 slot->key.data,
6906 slot->key.bytes);
Ronald Cronf95a2b12020-10-22 15:24:49 +02006907
Gilles Peskine449bd832023-01-11 14:50:10 +01006908 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02006909
Gilles Peskine449bd832023-01-11 14:50:10 +01006910 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006911}
Gilles Peskineea0fb492018-07-12 17:17:20 +02006912
6913
6914
6915/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02006916/* Key agreement */
6917/****************************************************************/
6918
Gilles Peskine449bd832023-01-11 14:50:10 +01006919psa_status_t psa_key_agreement_raw_builtin(const psa_key_attributes_t *attributes,
6920 const uint8_t *key_buffer,
6921 size_t key_buffer_size,
6922 psa_algorithm_t alg,
6923 const uint8_t *peer_key,
6924 size_t peer_key_length,
6925 uint8_t *shared_secret,
6926 size_t shared_secret_size,
6927 size_t *shared_secret_length)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02006928{
Gilles Peskine449bd832023-01-11 14:50:10 +01006929 switch (alg) {
John Durkop6ba40d12020-11-10 08:50:04 -08006930#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskine0216fe12019-04-11 21:23:21 +02006931 case PSA_ALG_ECDH:
Gilles Peskine449bd832023-01-11 14:50:10 +01006932 return mbedtls_psa_key_agreement_ecdh(attributes, key_buffer,
6933 key_buffer_size, alg,
6934 peer_key, peer_key_length,
6935 shared_secret,
6936 shared_secret_size,
6937 shared_secret_length);
Gilles Peskine01d718c2018-09-18 12:01:02 +02006938#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Przemek Stekielfb3dd542022-12-01 14:59:15 +01006939
6940#if defined(MBEDTLS_PSA_BUILTIN_ALG_FFDH)
6941 case PSA_ALG_FFDH:
Przemek Stekiel152bb462023-06-01 11:52:39 +02006942 return mbedtls_psa_ffdh_key_agreement(attributes,
Przemek Stekiel359f4622022-12-05 14:11:55 +01006943 peer_key,
6944 peer_key_length,
6945 key_buffer,
6946 key_buffer_size,
6947 shared_secret,
6948 shared_secret_size,
6949 shared_secret_length);
Przemek Stekielfb3dd542022-12-01 14:59:15 +01006950#endif /* MBEDTLS_PSA_BUILTIN_ALG_FFDH */
6951
Gilles Peskine01d718c2018-09-18 12:01:02 +02006952 default:
Aditya Deshpande17845b82022-10-13 17:21:01 +01006953 (void) attributes;
6954 (void) key_buffer;
6955 (void) key_buffer_size;
Gilles Peskine93f85002018-11-16 16:43:31 +01006956 (void) peer_key;
6957 (void) peer_key_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02006958 (void) shared_secret;
6959 (void) shared_secret_size;
6960 (void) shared_secret_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01006961 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine01d718c2018-09-18 12:01:02 +02006962 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02006963}
Gilles Peskine01d718c2018-09-18 12:01:02 +02006964
Aditya Deshpande17845b82022-10-13 17:21:01 +01006965/** Internal function for raw key agreement
6966 * Calls the driver wrapper which will hand off key agreement task
Aditya Deshpande40c05cc2022-10-14 16:41:40 +01006967 * to the driver's implementation if a driver is present.
6968 * Fallback specified in the driver wrapper is built-in raw key agreement
Aditya Deshpande17845b82022-10-13 17:21:01 +01006969 * (psa_key_agreement_raw_builtin).
6970 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006971static psa_status_t psa_key_agreement_raw_internal(psa_algorithm_t alg,
6972 psa_key_slot_t *private_key,
6973 const uint8_t *peer_key,
6974 size_t peer_key_length,
6975 uint8_t *shared_secret,
6976 size_t shared_secret_size,
6977 size_t *shared_secret_length)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006978{
Gilles Peskine449bd832023-01-11 14:50:10 +01006979 if (!PSA_ALG_IS_RAW_KEY_AGREEMENT(alg)) {
6980 return PSA_ERROR_NOT_SUPPORTED;
6981 }
Aditya Deshpande17845b82022-10-13 17:21:01 +01006982
6983 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01006984 .core = private_key->attr
Aditya Deshpande17845b82022-10-13 17:21:01 +01006985 };
6986
Gilles Peskine449bd832023-01-11 14:50:10 +01006987 return psa_driver_wrapper_key_agreement(&attributes,
6988 private_key->key.data,
6989 private_key->key.bytes, alg,
6990 peer_key, peer_key_length,
6991 shared_secret,
6992 shared_secret_size,
6993 shared_secret_length);
Gilles Peskine0216fe12019-04-11 21:23:21 +02006994}
6995
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02006996/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine01d718c2018-09-18 12:01:02 +02006997 * to potentially free embedded data structures and wipe confidential data.
6998 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006999static psa_status_t psa_key_agreement_internal(psa_key_derivation_operation_t *operation,
7000 psa_key_derivation_step_t step,
7001 psa_key_slot_t *private_key,
7002 const uint8_t *peer_key,
7003 size_t peer_key_length)
Gilles Peskine01d718c2018-09-18 12:01:02 +02007004{
7005 psa_status_t status;
Aditya Deshpande2f7fd762022-11-22 11:10:34 +00007006 uint8_t shared_secret[PSA_RAW_KEY_AGREEMENT_OUTPUT_MAX_SIZE];
Gilles Peskine01d718c2018-09-18 12:01:02 +02007007 size_t shared_secret_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007008 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE(operation->alg);
Gilles Peskine01d718c2018-09-18 12:01:02 +02007009
7010 /* Step 1: run the secret agreement algorithm to generate the shared
7011 * secret. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007012 status = psa_key_agreement_raw_internal(ka_alg,
7013 private_key,
7014 peer_key, peer_key_length,
7015 shared_secret,
7016 sizeof(shared_secret),
7017 &shared_secret_length);
7018 if (status != PSA_SUCCESS) {
Gilles Peskine12313cd2018-06-20 00:20:32 +02007019 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007020 }
Gilles Peskine12313cd2018-06-20 00:20:32 +02007021
Gilles Peskineb0b255c2018-07-06 17:01:38 +02007022 /* Step 2: set up the key derivation to generate key material from
Gilles Peskine224b0d62019-09-23 18:13:17 +02007023 * the shared secret. A shared secret is permitted wherever a key
7024 * of type DERIVE is permitted. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007025 status = psa_key_derivation_input_internal(operation, step,
7026 PSA_KEY_TYPE_DERIVE,
7027 shared_secret,
7028 shared_secret_length);
Gilles Peskine12313cd2018-06-20 00:20:32 +02007029exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007030 mbedtls_platform_zeroize(shared_secret, shared_secret_length);
7031 return status;
Gilles Peskine12313cd2018-06-20 00:20:32 +02007032}
7033
Gilles Peskine449bd832023-01-11 14:50:10 +01007034psa_status_t psa_key_derivation_key_agreement(psa_key_derivation_operation_t *operation,
7035 psa_key_derivation_step_t step,
7036 mbedtls_svc_key_id_t private_key,
7037 const uint8_t *peer_key,
7038 size_t peer_key_length)
Gilles Peskine12313cd2018-06-20 00:20:32 +02007039{
Ronald Cronf95a2b12020-10-22 15:24:49 +02007040 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01007041 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01007042 psa_key_slot_t *slot;
Ronald Cronf95a2b12020-10-22 15:24:49 +02007043
Gilles Peskine449bd832023-01-11 14:50:10 +01007044 if (!PSA_ALG_IS_KEY_AGREEMENT(operation->alg)) {
7045 return PSA_ERROR_INVALID_ARGUMENT;
7046 }
Ronald Cron5c522922020-11-14 16:35:34 +01007047 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01007048 private_key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg);
7049 if (status != PSA_SUCCESS) {
7050 return status;
7051 }
7052 status = psa_key_agreement_internal(operation, step,
7053 slot,
7054 peer_key, peer_key_length);
7055 if (status != PSA_SUCCESS) {
7056 psa_key_derivation_abort(operation);
7057 } else {
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007058 /* If a private key has been added as SECRET, we allow the derived
7059 * key material to be used as a key in PSA Crypto. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007060 if (step == PSA_KEY_DERIVATION_INPUT_SECRET) {
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007061 operation->can_output_key = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01007062 }
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007063 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007064
Gilles Peskine449bd832023-01-11 14:50:10 +01007065 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007066
Gilles Peskine449bd832023-01-11 14:50:10 +01007067 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskineaf3baab2018-06-27 22:55:52 +02007068}
7069
Gilles Peskine449bd832023-01-11 14:50:10 +01007070psa_status_t psa_raw_key_agreement(psa_algorithm_t alg,
7071 mbedtls_svc_key_id_t private_key,
7072 const uint8_t *peer_key,
7073 size_t peer_key_length,
7074 uint8_t *output,
7075 size_t output_size,
7076 size_t *output_length)
Gilles Peskine0216fe12019-04-11 21:23:21 +02007077{
Ronald Cronf95a2b12020-10-22 15:24:49 +02007078 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01007079 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +02007080 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007081 size_t expected_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02007082
Gilles Peskine449bd832023-01-11 14:50:10 +01007083 if (!PSA_ALG_IS_KEY_AGREEMENT(alg)) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007084 status = PSA_ERROR_INVALID_ARGUMENT;
7085 goto exit;
7086 }
Ronald Cron5c522922020-11-14 16:35:34 +01007087 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01007088 private_key, &slot, PSA_KEY_USAGE_DERIVE, alg);
7089 if (status != PSA_SUCCESS) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007090 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007091 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02007092
Gilles Peskine3e561302022-04-14 00:17:15 +02007093 /* PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() is in general an upper bound
7094 * for the output size. The PSA specification only guarantees that this
7095 * function works if output_size >= PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE(...),
7096 * but it might be nice to allow smaller buffers if the output fits.
7097 * At the time of writing this comment, with only ECDH implemented,
7098 * PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() is exact so the point is moot.
7099 * If FFDH is implemented, PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() can easily
7100 * be exact for it as well. */
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007101 expected_length =
Gilles Peskine449bd832023-01-11 14:50:10 +01007102 PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE(slot->attr.type, slot->attr.bits);
7103 if (output_size < expected_length) {
Gilles Peskine3e561302022-04-14 00:17:15 +02007104 status = PSA_ERROR_BUFFER_TOO_SMALL;
7105 goto exit;
7106 }
7107
Gilles Peskine449bd832023-01-11 14:50:10 +01007108 status = psa_key_agreement_raw_internal(alg, slot,
7109 peer_key, peer_key_length,
7110 output, output_size,
7111 output_length);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007112
7113exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007114 if (status != PSA_SUCCESS) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007115 /* If an error happens and is not handled properly, the output
7116 * may be used as a key to protect sensitive data. Arrange for such
7117 * a key to be random, which is likely to result in decryption or
7118 * verification errors. This is better than filling the buffer with
7119 * some constant data such as zeros, which would result in the data
7120 * being protected with a reproducible, easily knowable key.
7121 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007122 psa_generate_random(output, output_size);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007123 *output_length = output_size;
7124 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007125
Gilles Peskine449bd832023-01-11 14:50:10 +01007126 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007127
Gilles Peskine449bd832023-01-11 14:50:10 +01007128 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine0216fe12019-04-11 21:23:21 +02007129}
Gilles Peskine86a440b2018-11-12 18:39:40 +01007130
7131
Gilles Peskine30524eb2020-11-13 17:02:26 +01007132
Gilles Peskine86a440b2018-11-12 18:39:40 +01007133/****************************************************************/
7134/* Random generation */
Gilles Peskine53d991e2018-07-12 01:14:59 +02007135/****************************************************************/
Gilles Peskine12313cd2018-06-20 00:20:32 +02007136
Gilles Peskine672a7712023-04-28 21:00:28 +02007137#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
7138#include "entropy_poll.h"
7139#endif
7140
Gilles Peskine30524eb2020-11-13 17:02:26 +01007141/** Initialize the PSA random generator.
7142 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007143static void mbedtls_psa_random_init(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01007144{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007145#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine449bd832023-01-11 14:50:10 +01007146 memset(rng, 0, sizeof(*rng));
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007147#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
7148
Gilles Peskine30524eb2020-11-13 17:02:26 +01007149 /* Set default configuration if
7150 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007151 if (rng->entropy_init == NULL) {
Gilles Peskine30524eb2020-11-13 17:02:26 +01007152 rng->entropy_init = mbedtls_entropy_init;
Gilles Peskine449bd832023-01-11 14:50:10 +01007153 }
7154 if (rng->entropy_free == NULL) {
Gilles Peskine30524eb2020-11-13 17:02:26 +01007155 rng->entropy_free = mbedtls_entropy_free;
Gilles Peskine449bd832023-01-11 14:50:10 +01007156 }
Gilles Peskine30524eb2020-11-13 17:02:26 +01007157
Gilles Peskine449bd832023-01-11 14:50:10 +01007158 rng->entropy_init(&rng->entropy);
Gilles Peskine30524eb2020-11-13 17:02:26 +01007159#if defined(MBEDTLS_PSA_INJECT_ENTROPY) && \
7160 defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
7161 /* The PSA entropy injection feature depends on using NV seed as an entropy
7162 * source. Add NV seed as an entropy source for PSA entropy injection. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007163 mbedtls_entropy_add_source(&rng->entropy,
7164 mbedtls_nv_seed_poll, NULL,
7165 MBEDTLS_ENTROPY_BLOCK_SIZE,
7166 MBEDTLS_ENTROPY_SOURCE_STRONG);
Gilles Peskine30524eb2020-11-13 17:02:26 +01007167#endif
7168
Gilles Peskine449bd832023-01-11 14:50:10 +01007169 mbedtls_psa_drbg_init(MBEDTLS_PSA_RANDOM_STATE);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007170#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007171}
7172
7173/** Deinitialize the PSA random generator.
7174 */
Valerio Setti83e0de82023-11-24 12:13:05 +01007175static void mbedtls_psa_random_free(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01007176{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007177#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Valerio Setti83e0de82023-11-24 12:13:05 +01007178 memset(rng, 0, sizeof(*rng));
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007179#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Valerio Setti83e0de82023-11-24 12:13:05 +01007180 mbedtls_psa_drbg_free(MBEDTLS_PSA_RANDOM_STATE);
7181 rng->entropy_free(&rng->entropy);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007182#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007183}
7184
7185/** Seed the PSA random generator.
7186 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007187static psa_status_t mbedtls_psa_random_seed(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01007188{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007189#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
7190 /* Do nothing: the external RNG seeds itself. */
7191 (void) rng;
Gilles Peskine449bd832023-01-11 14:50:10 +01007192 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007193#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007194 const unsigned char drbg_seed[] = "PSA";
Gilles Peskine449bd832023-01-11 14:50:10 +01007195 int ret = mbedtls_psa_drbg_seed(&rng->entropy,
7196 drbg_seed, sizeof(drbg_seed) - 1);
7197 return mbedtls_to_psa_error(ret);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007198#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007199}
7200
Gilles Peskine449bd832023-01-11 14:50:10 +01007201psa_status_t psa_generate_random(uint8_t *output,
7202 size_t output_size)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007203{
Gilles Peskinee59236f2018-01-27 23:32:46 +01007204 GUARD_MODULE_INITIALIZED;
7205
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007206#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
7207
7208 size_t output_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007209 psa_status_t status = mbedtls_psa_external_get_random(&global_data.rng,
7210 output, output_size,
7211 &output_length);
7212 if (status != PSA_SUCCESS) {
7213 return status;
7214 }
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007215 /* Breaking up a request into smaller chunks is currently not supported
Tom Cosgrove1797b052022-12-04 17:19:59 +00007216 * for the external RNG interface. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007217 if (output_length != output_size) {
7218 return PSA_ERROR_INSUFFICIENT_ENTROPY;
7219 }
7220 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007221
7222#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
7223
Gilles Peskine449bd832023-01-11 14:50:10 +01007224 while (output_size > 0) {
Gilles Peskine71ddab92021-01-04 21:01:07 +01007225 size_t request_size =
Gilles Peskine449bd832023-01-11 14:50:10 +01007226 (output_size > MBEDTLS_PSA_RANDOM_MAX_REQUEST ?
7227 MBEDTLS_PSA_RANDOM_MAX_REQUEST :
7228 output_size);
7229 int ret = mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE,
7230 output, request_size);
7231 if (ret != 0) {
7232 return mbedtls_to_psa_error(ret);
7233 }
Gilles Peskine71ddab92021-01-04 21:01:07 +01007234 output_size -= request_size;
7235 output += request_size;
Gilles Peskinef181eca2019-08-07 13:49:00 +02007236 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007237 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007238#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskinee59236f2018-01-27 23:32:46 +01007239}
7240
Gilles Peskine8814fc42020-12-14 15:33:44 +01007241/* Wrapper function allowing the classic API to use the PSA RNG.
Gilles Peskine9c3e0602021-01-05 16:03:55 +01007242 *
7243 * `mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE, ...)` calls
7244 * `psa_generate_random(...)`. The state parameter is ignored since the
7245 * PSA API doesn't support passing an explicit state.
7246 *
7247 * In the non-external case, psa_generate_random() calls an
7248 * `mbedtls_xxx_drbg_random` function which has exactly the same signature
7249 * and semantics as mbedtls_psa_get_random(). As an optimization,
7250 * instead of doing this back-and-forth between the PSA API and the
7251 * classic API, psa_crypto_random_impl.h defines `mbedtls_psa_get_random`
7252 * as a constant function pointer to `mbedtls_xxx_drbg_random`.
Gilles Peskine8814fc42020-12-14 15:33:44 +01007253 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007254#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
7255int mbedtls_psa_get_random(void *p_rng,
7256 unsigned char *output,
7257 size_t output_size)
Gilles Peskine8814fc42020-12-14 15:33:44 +01007258{
Gilles Peskine9c3e0602021-01-05 16:03:55 +01007259 /* This function takes a pointer to the RNG state because that's what
7260 * classic mbedtls functions using an RNG expect. The PSA RNG manages
7261 * its own state internally and doesn't let the caller access that state.
7262 * So we just ignore the state parameter, and in practice we'll pass
7263 * NULL. */
Gilles Peskine8814fc42020-12-14 15:33:44 +01007264 (void) p_rng;
Gilles Peskine449bd832023-01-11 14:50:10 +01007265 psa_status_t status = psa_generate_random(output, output_size);
7266 if (status == PSA_SUCCESS) {
7267 return 0;
7268 } else {
7269 return MBEDTLS_ERR_ENTROPY_SOURCE_FAILED;
7270 }
Gilles Peskine8814fc42020-12-14 15:33:44 +01007271}
7272#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
7273
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01007274#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
Gilles Peskine449bd832023-01-11 14:50:10 +01007275psa_status_t mbedtls_psa_inject_entropy(const uint8_t *seed,
7276 size_t seed_size)
Netanel Gonen2bcd3122018-11-19 11:53:02 +02007277{
Gilles Peskine449bd832023-01-11 14:50:10 +01007278 if (global_data.initialized) {
7279 return PSA_ERROR_NOT_PERMITTED;
7280 }
Netanel Gonen21f37cb2018-11-19 11:53:55 +02007281
Gilles Peskine449bd832023-01-11 14:50:10 +01007282 if (((seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM) ||
7283 (seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE)) ||
7284 (seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE)) {
7285 return PSA_ERROR_INVALID_ARGUMENT;
7286 }
Netanel Gonen21f37cb2018-11-19 11:53:55 +02007287
Gilles Peskine449bd832023-01-11 14:50:10 +01007288 return mbedtls_psa_storage_inject_entropy(seed, seed_size);
Netanel Gonen2bcd3122018-11-19 11:53:02 +02007289}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01007290#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02007291
Ronald Cron3772afe2021-02-08 16:10:05 +01007292/** Validate the key type and size for key generation
Ronald Cron01b2aba2020-10-05 09:42:02 +02007293 *
Ronald Cron3772afe2021-02-08 16:10:05 +01007294 * \param type The key type
7295 * \param bits The number of bits of the key
Ronald Cron01b2aba2020-10-05 09:42:02 +02007296 *
7297 * \retval #PSA_SUCCESS
Ronald Cron3772afe2021-02-08 16:10:05 +01007298 * The key type and size are valid.
Ronald Cron01b2aba2020-10-05 09:42:02 +02007299 * \retval #PSA_ERROR_INVALID_ARGUMENT
7300 * The size in bits of the key is not valid.
7301 * \retval #PSA_ERROR_NOT_SUPPORTED
7302 * The type and/or the size in bits of the key or the combination of
7303 * the two is not supported.
7304 */
Ronald Cron3772afe2021-02-08 16:10:05 +01007305static psa_status_t psa_validate_key_type_and_size_for_key_generation(
Gilles Peskine449bd832023-01-11 14:50:10 +01007306 psa_key_type_t type, size_t bits)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007307{
Ronald Cronf3bb7612020-10-02 20:11:59 +02007308 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007309
Gilles Peskine449bd832023-01-11 14:50:10 +01007310 if (key_type_is_raw_bytes(type)) {
7311 status = psa_validate_unstructured_key_bit_size(type, bits);
7312 if (status != PSA_SUCCESS) {
7313 return status;
7314 }
7315 } else
Valerio Settif6d4dfb2023-07-10 10:55:12 +02007316#if defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007317 if (PSA_KEY_TYPE_IS_RSA(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
7318 if (bits > PSA_VENDOR_RSA_MAX_KEY_BITS) {
7319 return PSA_ERROR_NOT_SUPPORTED;
7320 }
Waleed Elmelegyd7bdbbe2023-07-20 16:26:58 +00007321 if (bits < PSA_VENDOR_RSA_GENERATE_MIN_KEY_BITS) {
Waleed Elmelegyab570712023-07-05 16:40:58 +00007322 return PSA_ERROR_NOT_SUPPORTED;
7323 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +02007324
Ronald Cron01b2aba2020-10-05 09:42:02 +02007325 /* Accept only byte-aligned keys, for the same reasons as
7326 * in psa_import_rsa_key(). */
Gilles Peskine449bd832023-01-11 14:50:10 +01007327 if (bits % 8 != 0) {
7328 return PSA_ERROR_NOT_SUPPORTED;
7329 }
7330 } else
Valerio Settif6d4dfb2023-07-10 10:55:12 +02007331#endif /* defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02007332
Valerio Setti6a9d0ee2023-06-21 10:07:21 +02007333#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007334 if (PSA_KEY_TYPE_IS_ECC(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
Ronald Crond81ab562021-02-16 09:01:16 +01007335 /* To avoid empty block, return successfully here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007336 return PSA_SUCCESS;
7337 } else
Valerio Setti6a9d0ee2023-06-21 10:07:21 +02007338#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_GENERATE) */
Przemek Stekielfedd1342022-12-01 15:00:02 +01007339
Valerio Settia55f0422023-07-10 15:34:41 +02007340#if defined(PSA_WANT_KEY_TYPE_DH_KEY_PAIR_GENERATE)
Przemek Stekielfedd1342022-12-01 15:00:02 +01007341 if (PSA_KEY_TYPE_IS_DH(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
Przemek Stekield1cf1ba2023-04-27 12:04:21 +02007342 if (psa_is_dh_key_size_valid(bits) == 0) {
Przemek Stekielfedd1342022-12-01 15:00:02 +01007343 return PSA_ERROR_NOT_SUPPORTED;
7344 }
7345 } else
Valerio Settia55f0422023-07-10 15:34:41 +02007346#endif /* defined(PSA_WANT_KEY_TYPE_DH_KEY_PAIR_GENERATE) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02007347 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007348 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007349 }
7350
Gilles Peskine449bd832023-01-11 14:50:10 +01007351 return PSA_SUCCESS;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007352}
7353
Ronald Cron55ed0592020-10-05 10:30:40 +02007354psa_status_t psa_generate_key_internal(
Ronald Cron2a38a6b2020-10-02 20:02:04 +02007355 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01007356 uint8_t *key_buffer, size_t key_buffer_size, size_t *key_buffer_length)
Ronald Cron01b2aba2020-10-05 09:42:02 +02007357{
7358 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2a38a6b2020-10-02 20:02:04 +02007359 psa_key_type_t type = attributes->core.type;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007360
Gilles Peskine449bd832023-01-11 14:50:10 +01007361 if ((attributes->domain_parameters == NULL) &&
7362 (attributes->domain_parameters_size != 0)) {
7363 return PSA_ERROR_INVALID_ARGUMENT;
7364 }
Ronald Cron01b2aba2020-10-05 09:42:02 +02007365
Gilles Peskine449bd832023-01-11 14:50:10 +01007366 if (key_type_is_raw_bytes(type)) {
7367 status = psa_generate_random(key_buffer, key_buffer_size);
7368 if (status != PSA_SUCCESS) {
7369 return status;
7370 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +02007371
David Brown12ca5032021-02-11 11:02:00 -07007372#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01007373 if (type == PSA_KEY_TYPE_DES) {
7374 psa_des_set_key_parity(key_buffer, key_buffer_size);
7375 }
David Brown8107e312021-02-12 08:08:46 -07007376#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine449bd832023-01-11 14:50:10 +01007377 } else
Gilles Peskinee59236f2018-01-27 23:32:46 +01007378
Valerio Setti76df8c12023-07-11 14:11:28 +02007379#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007380 if (type == PSA_KEY_TYPE_RSA_KEY_PAIR) {
7381 return mbedtls_psa_rsa_generate_key(attributes,
7382 key_buffer,
7383 key_buffer_size,
7384 key_buffer_length);
7385 } else
Valerio Setti76df8c12023-07-11 14:11:28 +02007386#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_GENERATE) */
Gilles Peskinee59236f2018-01-27 23:32:46 +01007387
Valerio Settibfeaf5b2023-06-20 13:27:46 +02007388#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007389 if (PSA_KEY_TYPE_IS_ECC(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
7390 return mbedtls_psa_ecp_generate_key(attributes,
7391 key_buffer,
7392 key_buffer_size,
7393 key_buffer_length);
7394 } else
Valerio Settibfeaf5b2023-06-20 13:27:46 +02007395#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_GENERATE) */
Przemek Stekielfedd1342022-12-01 15:00:02 +01007396
Valerio Settia55f0422023-07-10 15:34:41 +02007397#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_GENERATE)
Przemek Stekielfedd1342022-12-01 15:00:02 +01007398 if (PSA_KEY_TYPE_IS_DH(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
7399 return mbedtls_psa_ffdh_generate_key(attributes,
7400 key_buffer,
7401 key_buffer_size,
7402 key_buffer_length);
7403 } else
Valerio Settia55f0422023-07-10 15:34:41 +02007404#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_GENERATE) */
Steven Cooreman29149862020-08-05 15:43:42 +02007405 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007406 (void) key_buffer_length;
7407 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman29149862020-08-05 15:43:42 +02007408 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01007409
Gilles Peskine449bd832023-01-11 14:50:10 +01007410 return PSA_SUCCESS;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02007411}
Darryl Green0c6575a2018-11-07 16:05:30 +00007412
Gilles Peskine449bd832023-01-11 14:50:10 +01007413psa_status_t psa_generate_key(const psa_key_attributes_t *attributes,
7414 mbedtls_svc_key_id_t *key)
Gilles Peskineff5f0e72019-04-18 12:53:30 +02007415{
7416 psa_status_t status;
7417 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02007418 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cron2b56bc82020-10-05 10:02:26 +02007419 size_t key_buffer_size;
Gilles Peskine11792082019-08-06 18:36:36 +02007420
Ronald Cron81709fc2020-11-14 12:10:32 +01007421 *key = MBEDTLS_SVC_KEY_ID_INIT;
7422
Gilles Peskine0f84d622019-09-12 19:03:13 +02007423 /* Reject any attempt to create a zero-length key so that we don't
7424 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007425 if (psa_get_key_bits(attributes) == 0) {
7426 return PSA_ERROR_INVALID_ARGUMENT;
7427 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02007428
Przemyslaw Stekielc0fe8202021-10-07 11:08:56 +02007429 /* Reject any attempt to create a public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007430 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(attributes->core.type)) {
7431 return PSA_ERROR_INVALID_ARGUMENT;
7432 }
Przemyslaw Stekielc0fe8202021-10-07 11:08:56 +02007433
Gilles Peskine449bd832023-01-11 14:50:10 +01007434 status = psa_start_key_creation(PSA_KEY_CREATION_GENERATE, attributes,
7435 &slot, &driver);
7436 if (status != PSA_SUCCESS) {
Gilles Peskine11792082019-08-06 18:36:36 +02007437 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007438 }
Gilles Peskine11792082019-08-06 18:36:36 +02007439
Ronald Cron977c2472020-10-13 08:32:21 +02007440 /* In the case of a transparent key or an opaque key stored in local
Archana449608b2021-09-08 15:36:05 +05307441 * storage ( thus not in the case of generating a key in a secure element
7442 * with storage ( MBEDTLS_PSA_CRYPTO_SE_C ) ),we have to allocate a
7443 * buffer to hold the generated key material. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007444 if (slot->key.data == NULL) {
7445 if (PSA_KEY_LIFETIME_GET_LOCATION(attributes->core.lifetime) ==
7446 PSA_KEY_LOCATION_LOCAL_STORAGE) {
Ronald Cron3772afe2021-02-08 16:10:05 +01007447 status = psa_validate_key_type_and_size_for_key_generation(
Gilles Peskine449bd832023-01-11 14:50:10 +01007448 attributes->core.type, attributes->core.bits);
7449 if (status != PSA_SUCCESS) {
Ronald Cron3772afe2021-02-08 16:10:05 +01007450 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007451 }
Ronald Cron3772afe2021-02-08 16:10:05 +01007452
7453 key_buffer_size = PSA_EXPORT_KEY_OUTPUT_SIZE(
Gilles Peskine449bd832023-01-11 14:50:10 +01007454 attributes->core.type,
7455 attributes->core.bits);
7456 } else {
Ronald Cron977c2472020-10-13 08:32:21 +02007457 status = psa_driver_wrapper_get_key_buffer_size(
Gilles Peskine449bd832023-01-11 14:50:10 +01007458 attributes, &key_buffer_size);
7459 if (status != PSA_SUCCESS) {
Ronald Cron3772afe2021-02-08 16:10:05 +01007460 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007461 }
Ronald Cron977c2472020-10-13 08:32:21 +02007462 }
Ronald Cron977c2472020-10-13 08:32:21 +02007463
Gilles Peskine449bd832023-01-11 14:50:10 +01007464 status = psa_allocate_buffer_to_slot(slot, key_buffer_size);
7465 if (status != PSA_SUCCESS) {
Ronald Cron977c2472020-10-13 08:32:21 +02007466 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007467 }
Ronald Cron977c2472020-10-13 08:32:21 +02007468 }
7469
Gilles Peskine449bd832023-01-11 14:50:10 +01007470 status = psa_driver_wrapper_generate_key(attributes,
7471 slot->key.data, slot->key.bytes, &slot->key.bytes);
Gilles Peskine11792082019-08-06 18:36:36 +02007472
Gilles Peskine449bd832023-01-11 14:50:10 +01007473 if (status != PSA_SUCCESS) {
7474 psa_remove_key_data_from_memory(slot);
7475 }
Ronald Cron2b56bc82020-10-05 10:02:26 +02007476
Gilles Peskine11792082019-08-06 18:36:36 +02007477exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007478 if (status == PSA_SUCCESS) {
7479 status = psa_finish_key_creation(slot, driver, key);
7480 }
7481 if (status != PSA_SUCCESS) {
7482 psa_fail_key_creation(slot, driver);
7483 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007484
Gilles Peskine449bd832023-01-11 14:50:10 +01007485 return status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007486}
7487
Gilles Peskinee59236f2018-01-27 23:32:46 +01007488/****************************************************************/
7489/* Module setup */
7490/****************************************************************/
7491
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007492#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine5e769522018-11-20 21:59:56 +01007493psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
Gilles Peskine449bd832023-01-11 14:50:10 +01007494 void (* entropy_init)(mbedtls_entropy_context *ctx),
7495 void (* entropy_free)(mbedtls_entropy_context *ctx))
Gilles Peskine5e769522018-11-20 21:59:56 +01007496{
Gilles Peskine449bd832023-01-11 14:50:10 +01007497 if (global_data.rng_state != RNG_NOT_INITIALIZED) {
7498 return PSA_ERROR_BAD_STATE;
7499 }
Gilles Peskine30524eb2020-11-13 17:02:26 +01007500 global_data.rng.entropy_init = entropy_init;
7501 global_data.rng.entropy_free = entropy_free;
Gilles Peskine449bd832023-01-11 14:50:10 +01007502 return PSA_SUCCESS;
Gilles Peskine5e769522018-11-20 21:59:56 +01007503}
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007504#endif /* !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) */
Gilles Peskine5e769522018-11-20 21:59:56 +01007505
Gilles Peskine449bd832023-01-11 14:50:10 +01007506void mbedtls_psa_crypto_free(void)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007507{
Gilles Peskine449bd832023-01-11 14:50:10 +01007508 psa_wipe_all_key_slots();
Valerio Setti83e0de82023-11-24 12:13:05 +01007509 if (global_data.rng_state != RNG_NOT_INITIALIZED) {
7510 mbedtls_psa_random_free(&global_data.rng);
7511 }
Gilles Peskinec6b69072018-11-20 21:42:52 +01007512 /* Wipe all remaining data, including configuration.
7513 * In particular, this sets all state indicator to the value
7514 * indicating "uninitialized". */
Gilles Peskine449bd832023-01-11 14:50:10 +01007515 mbedtls_platform_zeroize(&global_data, sizeof(global_data));
Ronald Cron9ba76912021-04-10 16:57:30 +02007516
7517 /* Terminate drivers */
Gilles Peskine449bd832023-01-11 14:50:10 +01007518 psa_driver_wrapper_free();
Gilles Peskinee59236f2018-01-27 23:32:46 +01007519}
7520
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007521#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
7522/** Recover a transaction that was interrupted by a power failure.
7523 *
7524 * This function is called during initialization, before psa_crypto_init()
7525 * returns. If this function returns a failure status, the initialization
7526 * fails.
7527 */
7528static psa_status_t psa_crypto_recover_transaction(
Gilles Peskine449bd832023-01-11 14:50:10 +01007529 const psa_crypto_transaction_t *transaction)
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007530{
Gilles Peskine449bd832023-01-11 14:50:10 +01007531 switch (transaction->unknown.type) {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007532 case PSA_CRYPTO_TRANSACTION_CREATE_KEY:
7533 case PSA_CRYPTO_TRANSACTION_DESTROY_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01007534 /* TODO - fall through to the failure case until this
7535 * is implemented.
7536 * https://github.com/ARMmbed/mbed-crypto/issues/218
7537 */
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007538 default:
7539 /* We found an unsupported transaction in the storage.
7540 * We don't know what state the storage is in. Give up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007541 return PSA_ERROR_DATA_INVALID;
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007542 }
7543}
7544#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
7545
Gilles Peskine449bd832023-01-11 14:50:10 +01007546psa_status_t psa_crypto_init(void)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007547{
Gilles Peskine66fb1262018-12-10 16:29:04 +01007548 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007549
Gilles Peskinec6b69072018-11-20 21:42:52 +01007550 /* Double initialization is explicitly allowed. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007551 if (global_data.initialized != 0) {
7552 return PSA_SUCCESS;
7553 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01007554
Manuel Pégourié-Gonnard7abdf7e2023-03-09 11:17:43 +01007555 /* Init drivers */
7556 status = psa_driver_wrapper_init();
7557 if (status != PSA_SUCCESS) {
7558 goto exit;
7559 }
7560 global_data.drivers_initialized = 1;
7561
Valerio Setti402cfba2023-11-13 10:24:32 +01007562 status = psa_initialize_key_slots();
7563 if (status != PSA_SUCCESS) {
7564 goto exit;
7565 }
7566
Gilles Peskine30524eb2020-11-13 17:02:26 +01007567 /* Initialize and seed the random generator. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007568 mbedtls_psa_random_init(&global_data.rng);
Gilles Peskinec6b69072018-11-20 21:42:52 +01007569 global_data.rng_state = RNG_INITIALIZED;
Gilles Peskine449bd832023-01-11 14:50:10 +01007570 status = mbedtls_psa_random_seed(&global_data.rng);
7571 if (status != PSA_SUCCESS) {
Gilles Peskinee59236f2018-01-27 23:32:46 +01007572 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007573 }
Gilles Peskinec6b69072018-11-20 21:42:52 +01007574 global_data.rng_state = RNG_SEEDED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007575
Gilles Peskine4b734222019-07-24 15:56:31 +02007576#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007577 status = psa_crypto_load_transaction();
7578 if (status == PSA_SUCCESS) {
7579 status = psa_crypto_recover_transaction(&psa_crypto_transaction);
7580 if (status != PSA_SUCCESS) {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007581 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007582 }
7583 status = psa_crypto_stop_transaction();
7584 } else if (status == PSA_ERROR_DOES_NOT_EXIST) {
Gilles Peskinefc762652019-07-22 19:30:34 +02007585 /* There's no transaction to complete. It's all good. */
7586 status = PSA_SUCCESS;
7587 }
Gilles Peskine4b734222019-07-24 15:56:31 +02007588#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
Gilles Peskinefc762652019-07-22 19:30:34 +02007589
Gilles Peskinec6b69072018-11-20 21:42:52 +01007590 /* All done. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01007591 global_data.initialized = 1;
7592
7593exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007594 if (status != PSA_SUCCESS) {
7595 mbedtls_psa_crypto_free();
7596 }
7597 return status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007598}
7599
Yanray Wangffc3c482023-07-11 12:01:04 +08007600#if defined(PSA_WANT_ALG_SOME_PAKE)
Przemek Stekielca8d2b22023-01-17 16:21:33 +01007601psa_status_t psa_crypto_driver_pake_get_password_len(
7602 const psa_crypto_driver_pake_inputs_t *inputs,
7603 size_t *password_len)
7604{
7605 if (inputs->password_len == 0) {
7606 return PSA_ERROR_BAD_STATE;
7607 }
7608
7609 *password_len = inputs->password_len;
7610
7611 return PSA_SUCCESS;
7612}
7613
7614psa_status_t psa_crypto_driver_pake_get_password(
7615 const psa_crypto_driver_pake_inputs_t *inputs,
7616 uint8_t *buffer, size_t buffer_size, size_t *buffer_length)
7617{
7618 if (inputs->password_len == 0) {
7619 return PSA_ERROR_BAD_STATE;
7620 }
7621
7622 if (buffer_size < inputs->password_len) {
7623 return PSA_ERROR_BUFFER_TOO_SMALL;
7624 }
7625
7626 memcpy(buffer, inputs->password, inputs->password_len);
7627 *buffer_length = inputs->password_len;
7628
7629 return PSA_SUCCESS;
7630}
7631
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007632psa_status_t psa_crypto_driver_pake_get_user_len(
7633 const psa_crypto_driver_pake_inputs_t *inputs,
7634 size_t *user_len)
7635{
7636 if (inputs->user_len == 0) {
7637 return PSA_ERROR_BAD_STATE;
7638 }
7639
7640 *user_len = inputs->user_len;
7641
7642 return PSA_SUCCESS;
7643}
7644
7645psa_status_t psa_crypto_driver_pake_get_user(
7646 const psa_crypto_driver_pake_inputs_t *inputs,
Przemek Stekielc0e62502023-03-14 11:49:36 +01007647 uint8_t *user_id, size_t user_id_size, size_t *user_id_len)
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007648{
7649 if (inputs->user_len == 0) {
7650 return PSA_ERROR_BAD_STATE;
7651 }
7652
Przemek Stekielc0e62502023-03-14 11:49:36 +01007653 if (user_id_size < inputs->user_len) {
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007654 return PSA_ERROR_BUFFER_TOO_SMALL;
7655 }
7656
Przemek Stekielc0e62502023-03-14 11:49:36 +01007657 memcpy(user_id, inputs->user, inputs->user_len);
7658 *user_id_len = inputs->user_len;
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007659
7660 return PSA_SUCCESS;
7661}
7662
7663psa_status_t psa_crypto_driver_pake_get_peer_len(
7664 const psa_crypto_driver_pake_inputs_t *inputs,
7665 size_t *peer_len)
7666{
7667 if (inputs->peer_len == 0) {
7668 return PSA_ERROR_BAD_STATE;
7669 }
7670
7671 *peer_len = inputs->peer_len;
7672
7673 return PSA_SUCCESS;
7674}
7675
7676psa_status_t psa_crypto_driver_pake_get_peer(
7677 const psa_crypto_driver_pake_inputs_t *inputs,
Przemek Stekielc0e62502023-03-14 11:49:36 +01007678 uint8_t *peer_id, size_t peer_id_size, size_t *peer_id_length)
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007679{
7680 if (inputs->peer_len == 0) {
7681 return PSA_ERROR_BAD_STATE;
7682 }
7683
Przemek Stekielc0e62502023-03-14 11:49:36 +01007684 if (peer_id_size < inputs->peer_len) {
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007685 return PSA_ERROR_BUFFER_TOO_SMALL;
7686 }
7687
Przemek Stekielc0e62502023-03-14 11:49:36 +01007688 memcpy(peer_id, inputs->peer, inputs->peer_len);
7689 *peer_id_length = inputs->peer_len;
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007690
7691 return PSA_SUCCESS;
7692}
7693
Przemek Stekielca8d2b22023-01-17 16:21:33 +01007694psa_status_t psa_crypto_driver_pake_get_cipher_suite(
7695 const psa_crypto_driver_pake_inputs_t *inputs,
7696 psa_pake_cipher_suite_t *cipher_suite)
7697{
7698 if (inputs->cipher_suite.algorithm == PSA_ALG_NONE) {
7699 return PSA_ERROR_BAD_STATE;
7700 }
7701
7702 *cipher_suite = inputs->cipher_suite;
7703
7704 return PSA_SUCCESS;
7705}
7706
Neil Armstronga7d08c32022-06-01 18:21:20 +02007707psa_status_t psa_pake_setup(
7708 psa_pake_operation_t *operation,
7709 const psa_pake_cipher_suite_t *cipher_suite)
7710{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007711 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007712
Przemek Stekiel1c3cfb42023-01-26 10:35:02 +01007713 if (operation->stage != PSA_PAKE_OPERATION_STAGE_SETUP) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007714 status = PSA_ERROR_BAD_STATE;
7715 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007716 }
7717
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01007718 if (PSA_ALG_IS_PAKE(cipher_suite->algorithm) == 0 ||
Przemek Stekiel51eac532022-12-07 11:04:51 +01007719 PSA_ALG_IS_HASH(cipher_suite->hash) == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007720 status = PSA_ERROR_INVALID_ARGUMENT;
7721 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007722 }
7723
Przemek Stekiel51eac532022-12-07 11:04:51 +01007724 memset(&operation->data.inputs, 0, sizeof(operation->data.inputs));
7725
Przemek Stekiele12ed362022-12-21 12:54:46 +01007726 operation->alg = cipher_suite->algorithm;
Przemek Stekiel656b2592023-03-22 13:15:33 +01007727 operation->primitive = PSA_PAKE_PRIMITIVE(cipher_suite->type,
7728 cipher_suite->family, cipher_suite->bits);
Przemek Stekiel51eac532022-12-07 11:04:51 +01007729 operation->data.inputs.cipher_suite = *cipher_suite;
7730
Przemek Stekiel4aa99402023-02-27 13:00:57 +01007731#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01007732 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01007733 psa_jpake_computation_stage_t *computation_stage =
Przemek Stekieldde6a912023-01-26 08:46:37 +01007734 &operation->computation_stage.jpake;
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01007735
David Horstmann16f01512023-06-14 17:21:07 +01007736 memset(computation_stage, 0, sizeof(*computation_stage));
David Horstmanne7f21e62023-05-12 18:17:21 +01007737 computation_stage->step = PSA_PAKE_STEP_KEY_SHARE;
Przemek Stekiel80a88492023-02-20 13:32:22 +01007738 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007739#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01007740 {
7741 status = PSA_ERROR_NOT_SUPPORTED;
7742 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01007743 }
7744
Przemek Stekiel1c3cfb42023-01-26 10:35:02 +01007745 operation->stage = PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS;
7746
Przemek Stekiel51eac532022-12-07 11:04:51 +01007747 return PSA_SUCCESS;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007748exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007749 psa_pake_abort(operation);
7750 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02007751}
7752
7753psa_status_t psa_pake_set_password_key(
7754 psa_pake_operation_t *operation,
7755 mbedtls_svc_key_id_t password)
7756{
Neil Armstrong5ae60962022-09-15 11:29:46 +02007757 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel6c764412022-11-22 14:05:12 +01007758 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
7759 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007760 psa_key_attributes_t attributes;
7761 psa_key_type_t type;
Neil Armstrong5ae60962022-09-15 11:29:46 +02007762
Przemek Stekiel51eac532022-12-07 11:04:51 +01007763 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007764 status = PSA_ERROR_BAD_STATE;
7765 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007766 }
7767
Przemek Stekiel6c764412022-11-22 14:05:12 +01007768 status = psa_get_and_lock_key_slot_with_policy(password, &slot,
7769 PSA_KEY_USAGE_DERIVE,
Przemek Stekield5d28a22023-01-26 10:46:05 +01007770 operation->alg);
Neil Armstrong5ae60962022-09-15 11:29:46 +02007771 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007772 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02007773 }
7774
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007775 attributes = (psa_key_attributes_t) {
Przemek Stekiel6c764412022-11-22 14:05:12 +01007776 .core = slot->attr
7777 };
Neil Armstrong5ae60962022-09-15 11:29:46 +02007778
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007779 type = psa_get_key_type(&attributes);
Neil Armstrong5ae60962022-09-15 11:29:46 +02007780
Przemek Stekiel51eac532022-12-07 11:04:51 +01007781 if (type != PSA_KEY_TYPE_PASSWORD &&
7782 type != PSA_KEY_TYPE_PASSWORD_HASH) {
7783 status = PSA_ERROR_INVALID_ARGUMENT;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007784 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007785 }
7786
Przemek Stekiel51eac532022-12-07 11:04:51 +01007787 operation->data.inputs.password = mbedtls_calloc(1, slot->key.bytes);
7788 if (operation->data.inputs.password == NULL) {
Przemek Stekiele12ed362022-12-21 12:54:46 +01007789 status = PSA_ERROR_INSUFFICIENT_MEMORY;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007790 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007791 }
7792
7793 memcpy(operation->data.inputs.password, slot->key.data, slot->key.bytes);
7794 operation->data.inputs.password_len = slot->key.bytes;
Przemek Stekiel9dd24402023-01-26 15:06:09 +01007795 operation->data.inputs.attributes = attributes;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007796exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007797 if (status != PSA_SUCCESS) {
7798 psa_pake_abort(operation);
7799 }
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007800 unlock_status = psa_unlock_key_slot(slot);
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007801 return (status == PSA_SUCCESS) ? unlock_status : status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02007802}
7803
7804psa_status_t psa_pake_set_user(
7805 psa_pake_operation_t *operation,
7806 const uint8_t *user_id,
7807 size_t user_id_len)
7808{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007809 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007810
7811 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007812 status = PSA_ERROR_BAD_STATE;
7813 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02007814 }
7815
Przemek Stekiel51eac532022-12-07 11:04:51 +01007816 if (user_id_len == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007817 status = PSA_ERROR_INVALID_ARGUMENT;
7818 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02007819 }
7820
Przemek Stekielf309d6b2023-03-10 09:54:45 +01007821 if (operation->data.inputs.user_len != 0) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007822 status = PSA_ERROR_BAD_STATE;
7823 goto exit;
7824 }
7825
Przemek Stekielf309d6b2023-03-10 09:54:45 +01007826 operation->data.inputs.user = mbedtls_calloc(1, user_id_len);
7827 if (operation->data.inputs.user == NULL) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007828 status = PSA_ERROR_INSUFFICIENT_MEMORY;
7829 goto exit;
7830 }
7831
Przemek Stekielf309d6b2023-03-10 09:54:45 +01007832 memcpy(operation->data.inputs.user, user_id, user_id_len);
7833 operation->data.inputs.user_len = user_id_len;
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007834
7835 return PSA_SUCCESS;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007836exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007837 psa_pake_abort(operation);
7838 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02007839}
7840
7841psa_status_t psa_pake_set_peer(
7842 psa_pake_operation_t *operation,
7843 const uint8_t *peer_id,
7844 size_t peer_id_len)
7845{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007846 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007847
7848 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007849 status = PSA_ERROR_BAD_STATE;
7850 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02007851 }
7852
Przemek Stekiel51eac532022-12-07 11:04:51 +01007853 if (peer_id_len == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007854 status = PSA_ERROR_INVALID_ARGUMENT;
7855 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02007856 }
7857
Przemek Stekielf309d6b2023-03-10 09:54:45 +01007858 if (operation->data.inputs.peer_len != 0) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007859 status = PSA_ERROR_BAD_STATE;
7860 goto exit;
7861 }
7862
Przemek Stekielf309d6b2023-03-10 09:54:45 +01007863 operation->data.inputs.peer = mbedtls_calloc(1, peer_id_len);
7864 if (operation->data.inputs.peer == NULL) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007865 status = PSA_ERROR_INSUFFICIENT_MEMORY;
7866 goto exit;
7867 }
7868
Przemek Stekielf309d6b2023-03-10 09:54:45 +01007869 memcpy(operation->data.inputs.peer, peer_id, peer_id_len);
7870 operation->data.inputs.peer_len = peer_id_len;
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007871
7872 return PSA_SUCCESS;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007873exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007874 psa_pake_abort(operation);
7875 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02007876}
7877
7878psa_status_t psa_pake_set_role(
7879 psa_pake_operation_t *operation,
7880 psa_pake_role_t role)
7881{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007882 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007883
Przemek Stekiel51eac532022-12-07 11:04:51 +01007884 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007885 status = PSA_ERROR_BAD_STATE;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007886 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007887 }
7888
Przemek Stekiel09104b82023-03-06 14:11:51 +01007889 switch (operation->alg) {
7890#if defined(PSA_WANT_ALG_JPAKE)
7891 case PSA_ALG_JPAKE:
7892 if (role == PSA_PAKE_ROLE_NONE) {
7893 return PSA_SUCCESS;
7894 }
7895 status = PSA_ERROR_INVALID_ARGUMENT;
7896 break;
7897#endif
7898 default:
7899 (void) role;
7900 status = PSA_ERROR_NOT_SUPPORTED;
7901 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02007902 }
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007903exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007904 psa_pake_abort(operation);
7905 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02007906}
7907
David Horstmanne7f21e62023-05-12 18:17:21 +01007908/* Auxiliary function to convert core computation stage to single driver step. */
Przemek Stekiel4aa99402023-02-27 13:00:57 +01007909#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiel251e86a2023-02-17 14:30:50 +01007910static psa_crypto_driver_pake_step_t convert_jpake_computation_stage_to_driver_step(
Przemek Stekieldde6a912023-01-26 08:46:37 +01007911 psa_jpake_computation_stage_t *stage)
Przemek Stekielb09c4872023-01-17 12:05:38 +01007912{
David Horstmann74a3d8c2023-06-14 18:28:19 +01007913 psa_crypto_driver_pake_step_t key_share_step;
David Horstmann5da95602023-06-08 15:37:12 +01007914 if (stage->round == PSA_JPAKE_FIRST) {
David Horstmanne7f21e62023-05-12 18:17:21 +01007915 int is_x1;
David Horstmann74a3d8c2023-06-14 18:28:19 +01007916
David Horstmann024e5c52023-06-14 15:48:21 +01007917 if (stage->io_mode == PSA_JPAKE_OUTPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01007918 is_x1 = (stage->outputs < 1);
7919 } else {
7920 is_x1 = (stage->inputs < 1);
7921 }
7922
David Horstmann74a3d8c2023-06-14 18:28:19 +01007923 key_share_step = is_x1 ?
7924 PSA_JPAKE_X1_STEP_KEY_SHARE :
7925 PSA_JPAKE_X2_STEP_KEY_SHARE;
David Horstmann5da95602023-06-08 15:37:12 +01007926 } else if (stage->round == PSA_JPAKE_SECOND) {
David Horstmann74a3d8c2023-06-14 18:28:19 +01007927 key_share_step = (stage->io_mode == PSA_JPAKE_OUTPUT) ?
7928 PSA_JPAKE_X2S_STEP_KEY_SHARE :
7929 PSA_JPAKE_X4S_STEP_KEY_SHARE;
7930 } else {
7931 return PSA_JPAKE_STEP_INVALID;
Przemek Stekielb09c4872023-01-17 12:05:38 +01007932 }
Agathiyan Bragadeesh387bfa52023-07-17 17:01:33 +01007933 return (psa_crypto_driver_pake_step_t) (key_share_step + stage->step - PSA_PAKE_STEP_KEY_SHARE);
Przemek Stekielb09c4872023-01-17 12:05:38 +01007934}
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007935#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekielb09c4872023-01-17 12:05:38 +01007936
Przemek Stekiel2797d372022-12-22 11:19:22 +01007937static psa_status_t psa_pake_complete_inputs(
7938 psa_pake_operation_t *operation)
7939{
Przemek Stekiel2797d372022-12-22 11:19:22 +01007940 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel18620a32023-01-17 16:34:52 +01007941 /* Create copy of the inputs on stack as inputs share memory
7942 with the driver context which will be setup by the driver. */
7943 psa_crypto_driver_pake_inputs_t inputs = operation->data.inputs;
Przemek Stekiel2797d372022-12-22 11:19:22 +01007944
Przemek Stekielfde11282023-03-13 16:06:09 +01007945 if (inputs.password_len == 0) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01007946 return PSA_ERROR_BAD_STATE;
7947 }
7948
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007949 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekielfde11282023-03-13 16:06:09 +01007950 if (inputs.user_len == 0 || inputs.peer_len == 0) {
7951 return PSA_ERROR_BAD_STATE;
7952 }
Przemek Stekieldff21d32023-02-14 20:09:10 +01007953 }
7954
Przemek Stekiel18620a32023-01-17 16:34:52 +01007955 /* Clear driver context */
7956 mbedtls_platform_zeroize(&operation->data, sizeof(operation->data));
7957
7958 status = psa_driver_wrapper_pake_setup(operation, &inputs);
Przemek Stekiel2797d372022-12-22 11:19:22 +01007959
7960 /* Driver is responsible for creating its own copy of the password. */
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01007961 mbedtls_zeroize_and_free(inputs.password, inputs.password_len);
Przemek Stekiel2797d372022-12-22 11:19:22 +01007962
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007963 /* User and peer are translated to role. */
7964 mbedtls_free(inputs.user);
7965 mbedtls_free(inputs.peer);
7966
Przemek Stekiel2797d372022-12-22 11:19:22 +01007967 if (status == PSA_SUCCESS) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01007968#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiel2797d372022-12-22 11:19:22 +01007969 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekield93de322023-02-24 08:39:04 +01007970 operation->stage = PSA_PAKE_OPERATION_STAGE_COMPUTATION;
Przemek Stekiel80a88492023-02-20 13:32:22 +01007971 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007972#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01007973 {
7974 status = PSA_ERROR_NOT_SUPPORTED;
Przemek Stekiel2797d372022-12-22 11:19:22 +01007975 }
Przemek Stekiel2797d372022-12-22 11:19:22 +01007976 }
Przemek Stekiel2797d372022-12-22 11:19:22 +01007977 return status;
7978}
7979
Przemek Stekiel4aa99402023-02-27 13:00:57 +01007980#if defined(PSA_WANT_ALG_JPAKE)
David Horstmanne7f21e62023-05-12 18:17:21 +01007981static psa_status_t psa_jpake_prologue(
Przemek Stekiele12ed362022-12-21 12:54:46 +01007982 psa_pake_operation_t *operation,
David Horstmanne7f21e62023-05-12 18:17:21 +01007983 psa_pake_step_t step,
David Horstmann00ad6bf2023-06-14 15:44:24 +01007984 psa_jpake_io_mode_t io_mode)
Przemek Stekiele12ed362022-12-21 12:54:46 +01007985{
Przemek Stekiele12ed362022-12-21 12:54:46 +01007986 if (step != PSA_PAKE_STEP_KEY_SHARE &&
7987 step != PSA_PAKE_STEP_ZK_PUBLIC &&
7988 step != PSA_PAKE_STEP_ZK_PROOF) {
7989 return PSA_ERROR_INVALID_ARGUMENT;
7990 }
7991
Przemek Stekiel5eff1032023-02-21 19:10:36 +01007992 psa_jpake_computation_stage_t *computation_stage =
7993 &operation->computation_stage.jpake;
Przemek Stekiele12ed362022-12-21 12:54:46 +01007994
David Horstmann5da95602023-06-08 15:37:12 +01007995 if (computation_stage->round != PSA_JPAKE_FIRST &&
7996 computation_stage->round != PSA_JPAKE_SECOND) {
Przemek Stekiel5eff1032023-02-21 19:10:36 +01007997 return PSA_ERROR_BAD_STATE;
7998 }
7999
David Horstmanne7f21e62023-05-12 18:17:21 +01008000 /* Check that the step we are given is the one we were expecting */
8001 if (step != computation_stage->step) {
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008002 return PSA_ERROR_BAD_STATE;
8003 }
8004
David Horstmanne7f21e62023-05-12 18:17:21 +01008005 if (step == PSA_PAKE_STEP_KEY_SHARE &&
8006 computation_stage->inputs == 0 &&
8007 computation_stage->outputs == 0) {
8008 /* Start of the round, so function decides whether we are inputting
8009 * or outputting */
David Horstmann024e5c52023-06-14 15:48:21 +01008010 computation_stage->io_mode = io_mode;
8011 } else if (computation_stage->io_mode != io_mode) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008012 /* Middle of the round so the mode we are in must match the function
8013 * called by the user */
8014 return PSA_ERROR_BAD_STATE;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008015 }
8016
8017 return PSA_SUCCESS;
8018}
8019
David Horstmanne7f21e62023-05-12 18:17:21 +01008020static psa_status_t psa_jpake_epilogue(
8021 psa_pake_operation_t *operation,
David Horstmann00ad6bf2023-06-14 15:44:24 +01008022 psa_jpake_io_mode_t io_mode)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008023{
David Horstmanne7f21e62023-05-12 18:17:21 +01008024 psa_jpake_computation_stage_t *stage =
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008025 &operation->computation_stage.jpake;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008026
David Horstmanne7f21e62023-05-12 18:17:21 +01008027 if (stage->step == PSA_PAKE_STEP_ZK_PROOF) {
8028 /* End of an input/output */
David Horstmann00ad6bf2023-06-14 15:44:24 +01008029 if (io_mode == PSA_JPAKE_INPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008030 stage->inputs++;
David Horstmann246ec5a2023-06-27 10:33:06 +01008031 if (stage->inputs == PSA_JPAKE_EXPECTED_INPUTS(stage->round)) {
David Horstmann024e5c52023-06-14 15:48:21 +01008032 stage->io_mode = PSA_JPAKE_OUTPUT;
David Horstmanne7f21e62023-05-12 18:17:21 +01008033 }
8034 }
David Horstmann00ad6bf2023-06-14 15:44:24 +01008035 if (io_mode == PSA_JPAKE_OUTPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008036 stage->outputs++;
David Horstmann246ec5a2023-06-27 10:33:06 +01008037 if (stage->outputs == PSA_JPAKE_EXPECTED_OUTPUTS(stage->round)) {
David Horstmann024e5c52023-06-14 15:48:21 +01008038 stage->io_mode = PSA_JPAKE_INPUT;
David Horstmanne7f21e62023-05-12 18:17:21 +01008039 }
8040 }
David Horstmann246ec5a2023-06-27 10:33:06 +01008041 if (stage->inputs == PSA_JPAKE_EXPECTED_INPUTS(stage->round) &&
8042 stage->outputs == PSA_JPAKE_EXPECTED_OUTPUTS(stage->round)) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008043 /* End of a round, move to the next round */
8044 stage->inputs = 0;
8045 stage->outputs = 0;
8046 stage->round++;
8047 }
8048 stage->step = PSA_PAKE_STEP_KEY_SHARE;
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008049 } else {
David Horstmanne7f21e62023-05-12 18:17:21 +01008050 stage->step++;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008051 }
Przemek Stekiele12ed362022-12-21 12:54:46 +01008052 return PSA_SUCCESS;
8053}
David Horstmanne7f21e62023-05-12 18:17:21 +01008054
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008055#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008056
Neil Armstronga7d08c32022-06-01 18:21:20 +02008057psa_status_t psa_pake_output(
8058 psa_pake_operation_t *operation,
8059 psa_pake_step_t step,
8060 uint8_t *output,
8061 size_t output_size,
8062 size_t *output_length)
8063{
Przemek Stekiel51eac532022-12-07 11:04:51 +01008064 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008065 psa_crypto_driver_pake_step_t driver_step = PSA_JPAKE_STEP_INVALID;
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008066 *output_length = 0;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008067
8068 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01008069 status = psa_pake_complete_inputs(operation);
8070 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008071 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008072 }
8073 }
8074
8075 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008076 status = PSA_ERROR_BAD_STATE;
8077 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008078 }
8079
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008080 if (output_size == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008081 status = PSA_ERROR_INVALID_ARGUMENT;
8082 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008083 }
8084
Przemek Stekiele12ed362022-12-21 12:54:46 +01008085 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008086#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008087 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008088 status = psa_jpake_prologue(operation, step, PSA_JPAKE_OUTPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008089 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008090 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008091 }
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008092 driver_step = convert_jpake_computation_stage_to_driver_step(
8093 &operation->computation_stage.jpake);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008094 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008095#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008096 default:
Przemek Stekiel80a88492023-02-20 13:32:22 +01008097 (void) step;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008098 status = PSA_ERROR_NOT_SUPPORTED;
8099 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008100 }
8101
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008102 status = psa_driver_wrapper_pake_output(operation, driver_step,
8103 output, output_size, output_length);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008104
8105 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008106 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008107 }
8108
8109 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008110#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008111 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008112 status = psa_jpake_epilogue(operation, PSA_JPAKE_OUTPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008113 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008114 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008115 }
8116 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008117#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008118 default:
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008119 status = PSA_ERROR_NOT_SUPPORTED;
8120 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008121 }
8122
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008123 return PSA_SUCCESS;
8124exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008125 psa_pake_abort(operation);
8126 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008127}
8128
8129psa_status_t psa_pake_input(
8130 psa_pake_operation_t *operation,
8131 psa_pake_step_t step,
8132 const uint8_t *input,
8133 size_t input_length)
8134{
Przemek Stekiel51eac532022-12-07 11:04:51 +01008135 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008136 psa_crypto_driver_pake_step_t driver_step = PSA_JPAKE_STEP_INVALID;
Przemek Stekiel256c75d2023-03-23 14:09:34 +01008137 const size_t max_input_length = (size_t) PSA_PAKE_INPUT_SIZE(operation->alg,
8138 operation->primitive,
8139 step);
Przemek Stekiel51eac532022-12-07 11:04:51 +01008140
8141 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01008142 status = psa_pake_complete_inputs(operation);
8143 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008144 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008145 }
8146 }
8147
8148 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008149 status = PSA_ERROR_BAD_STATE;
8150 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008151 }
8152
Przemek Stekiel256c75d2023-03-23 14:09:34 +01008153 if (input_length == 0 || input_length > max_input_length) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008154 status = PSA_ERROR_INVALID_ARGUMENT;
8155 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008156 }
8157
Przemek Stekiele12ed362022-12-21 12:54:46 +01008158 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008159#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008160 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008161 status = psa_jpake_prologue(operation, step, PSA_JPAKE_INPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008162 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008163 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008164 }
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008165 driver_step = convert_jpake_computation_stage_to_driver_step(
8166 &operation->computation_stage.jpake);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008167 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008168#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008169 default:
Przemek Stekiel80a88492023-02-20 13:32:22 +01008170 (void) step;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008171 status = PSA_ERROR_NOT_SUPPORTED;
8172 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008173 }
8174
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008175 status = psa_driver_wrapper_pake_input(operation, driver_step,
8176 input, input_length);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008177
8178 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008179 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008180 }
8181
8182 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008183#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008184 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008185 status = psa_jpake_epilogue(operation, PSA_JPAKE_INPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008186 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008187 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008188 }
8189 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008190#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008191 default:
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008192 status = PSA_ERROR_NOT_SUPPORTED;
8193 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008194 }
8195
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008196 return PSA_SUCCESS;
8197exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008198 psa_pake_abort(operation);
8199 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008200}
8201
8202psa_status_t psa_pake_get_implicit_key(
8203 psa_pake_operation_t *operation,
8204 psa_key_derivation_operation_t *output)
8205{
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008206 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008207 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel251e86a2023-02-17 14:30:50 +01008208 uint8_t shared_key[MBEDTLS_PSA_JPAKE_BUFFER_SIZE];
Przemek Stekiel0c781802022-11-29 14:53:13 +01008209 size_t shared_key_len = 0;
8210
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008211 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008212 status = PSA_ERROR_BAD_STATE;
8213 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008214 }
8215
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008216#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008217 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008218 psa_jpake_computation_stage_t *computation_stage =
Przemek Stekiel083745e2023-02-23 17:28:23 +01008219 &operation->computation_stage.jpake;
David Horstmann5da95602023-06-08 15:37:12 +01008220 if (computation_stage->round != PSA_JPAKE_FINISHED) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008221 status = PSA_ERROR_BAD_STATE;
8222 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008223 }
Przemek Stekiel80a88492023-02-20 13:32:22 +01008224 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008225#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01008226 {
8227 status = PSA_ERROR_NOT_SUPPORTED;
8228 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008229 }
8230
Przemek Stekiel0c781802022-11-29 14:53:13 +01008231 status = psa_driver_wrapper_pake_get_implicit_key(operation,
8232 shared_key,
Przemek Stekiel6b648622023-02-19 22:55:33 +01008233 sizeof(shared_key),
Przemek Stekiel0c781802022-11-29 14:53:13 +01008234 &shared_key_len);
8235
8236 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008237 goto exit;
Przemek Stekiel0c781802022-11-29 14:53:13 +01008238 }
8239
8240 status = psa_key_derivation_input_bytes(output,
8241 PSA_KEY_DERIVATION_INPUT_SECRET,
8242 shared_key,
8243 shared_key_len);
8244
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008245 mbedtls_platform_zeroize(shared_key, sizeof(shared_key));
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008246exit:
8247 abort_status = psa_pake_abort(operation);
8248 return status == PSA_SUCCESS ? abort_status : status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008249}
8250
8251psa_status_t psa_pake_abort(
8252 psa_pake_operation_t *operation)
8253{
Przemek Stekield69dca92023-01-31 19:59:20 +01008254 psa_status_t status = PSA_SUCCESS;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008255
Przemek Stekield69dca92023-01-31 19:59:20 +01008256 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008257 status = psa_driver_wrapper_pake_abort(operation);
Neil Armstrong5ae60962022-09-15 11:29:46 +02008258 }
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008259
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008260 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
8261 if (operation->data.inputs.password != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01008262 mbedtls_zeroize_and_free(operation->data.inputs.password,
Przemek Stekielaa183422023-03-06 14:21:44 +01008263 operation->data.inputs.password_len);
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008264 }
8265 if (operation->data.inputs.user != NULL) {
8266 mbedtls_free(operation->data.inputs.user);
8267 }
8268 if (operation->data.inputs.peer != NULL) {
8269 mbedtls_free(operation->data.inputs.peer);
8270 }
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008271 }
Przemek Stekield69dca92023-01-31 19:59:20 +01008272 memset(operation, 0, sizeof(psa_pake_operation_t));
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008273
Przemek Stekield69dca92023-01-31 19:59:20 +01008274 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008275}
Tom Cosgrove6d62fac2023-05-10 14:40:05 +01008276#endif /* PSA_WANT_ALG_SOME_PAKE */
Neil Armstronga7d08c32022-06-01 18:21:20 +02008277
Gilles Peskinee59236f2018-01-27 23:32:46 +01008278#endif /* MBEDTLS_PSA_CRYPTO_C */