blob: 3c5bbbdf6e10463e83d1d243c1143e25ccfc8e05 [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 *
884 * On success, the returned key slot is locked. It is the responsibility of
885 * the caller to unlock the key slot when it does not access it anymore.
886 */
887static psa_status_t psa_get_and_lock_key_slot_with_policy(
Ronald Cron5c522922020-11-14 16:35:34 +0100888 mbedtls_svc_key_id_t key,
889 psa_key_slot_t **p_slot,
890 psa_key_usage_t usage,
Gilles Peskine449bd832023-01-11 14:50:10 +0100891 psa_algorithm_t alg)
Darryl Green06fd18d2018-07-16 11:21:11 +0100892{
Ronald Cronf95a2b12020-10-22 15:24:49 +0200893 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel9a5b8122022-12-22 13:34:47 +0100894 psa_key_slot_t *slot = NULL;
Darryl Green06fd18d2018-07-16 11:21:11 +0100895
Gilles Peskine449bd832023-01-11 14:50:10 +0100896 status = psa_get_and_lock_key_slot(key, p_slot);
897 if (status != PSA_SUCCESS) {
898 return status;
899 }
Ronald Cronf95a2b12020-10-22 15:24:49 +0200900 slot = *p_slot;
Darryl Green06fd18d2018-07-16 11:21:11 +0100901
902 /* Enforce that usage policy for the key slot contains all the flags
903 * required by the usage parameter. There is one exception: public
904 * keys can always be exported, so we treat public key objects as
905 * if they had the export flag. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100906 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(slot->attr.type)) {
Darryl Green06fd18d2018-07-16 11:21:11 +0100907 usage &= ~PSA_KEY_USAGE_EXPORT;
Gilles Peskine449bd832023-01-11 14:50:10 +0100908 }
Ronald Cronf95a2b12020-10-22 15:24:49 +0200909
Gilles Peskine449bd832023-01-11 14:50:10 +0100910 if ((slot->attr.policy.usage & usage) != usage) {
Steven Cooreman328f11c2021-03-02 11:44:51 +0100911 status = PSA_ERROR_NOT_PERMITTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +0200912 goto error;
Steven Cooreman328f11c2021-03-02 11:44:51 +0100913 }
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100914
Shaun Case8b0ecbc2021-12-20 21:14:10 -0800915 /* Enforce that the usage policy permits the requested algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100916 if (alg != 0) {
917 status = psa_key_policy_permits(&slot->attr.policy,
918 slot->attr.type,
919 alg);
920 if (status != PSA_SUCCESS) {
Steven Cooreman7e39f052021-02-23 14:18:32 +0100921 goto error;
Gilles Peskine449bd832023-01-11 14:50:10 +0100922 }
Steven Cooreman7e39f052021-02-23 14:18:32 +0100923 }
Darryl Green06fd18d2018-07-16 11:21:11 +0100924
Gilles Peskine449bd832023-01-11 14:50:10 +0100925 return PSA_SUCCESS;
Ronald Cronf95a2b12020-10-22 15:24:49 +0200926
927error:
928 *p_slot = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +0100929 psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +0200930
Gilles Peskine449bd832023-01-11 14:50:10 +0100931 return status;
Darryl Green06fd18d2018-07-16 11:21:11 +0100932}
Darryl Green940d72c2018-07-13 13:18:51 +0100933
Ronald Cron5c522922020-11-14 16:35:34 +0100934/** Get a key slot containing a transparent key and lock it.
Gilles Peskine28f8f302019-07-24 13:30:31 +0200935 *
936 * A transparent key is a key for which the key material is directly
Ronald Cronddae0f52021-08-24 15:39:44 +0200937 * available, as opposed to a key in a secure element and/or to be used
938 * by a secure element.
Gilles Peskine28f8f302019-07-24 13:30:31 +0200939 *
Ronald Cronddae0f52021-08-24 15:39:44 +0200940 * This is a temporary function that may be used instead of
941 * psa_get_and_lock_key_slot_with_policy() when there is no opaque key support
942 * for a cryptographic operation.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200943 *
Ronald Cron5c522922020-11-14 16:35:34 +0100944 * On success, the returned key slot is locked. It is the responsibility of the
945 * caller to unlock the key slot when it does not access it anymore.
Gilles Peskine28f8f302019-07-24 13:30:31 +0200946 */
Ronald Cron5c522922020-11-14 16:35:34 +0100947static psa_status_t psa_get_and_lock_transparent_key_slot_with_policy(
948 mbedtls_svc_key_id_t key,
949 psa_key_slot_t **p_slot,
950 psa_key_usage_t usage,
Gilles Peskine449bd832023-01-11 14:50:10 +0100951 psa_algorithm_t alg)
Gilles Peskine28f8f302019-07-24 13:30:31 +0200952{
Gilles Peskine449bd832023-01-11 14:50:10 +0100953 psa_status_t status = psa_get_and_lock_key_slot_with_policy(key, p_slot,
954 usage, alg);
955 if (status != PSA_SUCCESS) {
956 return status;
Gilles Peskine28f8f302019-07-24 13:30:31 +0200957 }
Ronald Cronf95a2b12020-10-22 15:24:49 +0200958
Gilles Peskine449bd832023-01-11 14:50:10 +0100959 if (psa_key_lifetime_is_external((*p_slot)->attr.lifetime)) {
960 psa_unlock_key_slot(*p_slot);
961 *p_slot = NULL;
962 return PSA_ERROR_NOT_SUPPORTED;
963 }
964
965 return PSA_SUCCESS;
Gilles Peskine28f8f302019-07-24 13:30:31 +0200966}
Gilles Peskine28f8f302019-07-24 13:30:31 +0200967
Gilles Peskine449bd832023-01-11 14:50:10 +0100968psa_status_t psa_remove_key_data_from_memory(psa_key_slot_t *slot)
Darryl Green40225ba2018-11-15 14:48:15 +0000969{
Gilles Peskine449bd832023-01-11 14:50:10 +0100970 if (slot->key.data != NULL) {
Tom Cosgrove52f7e182023-08-01 09:08:48 +0100971 mbedtls_zeroize_and_free(slot->key.data, slot->key.bytes);
Gilles Peskine449bd832023-01-11 14:50:10 +0100972 }
Ronald Cronea0f8a62020-11-25 17:52:23 +0100973
Ronald Cronea0f8a62020-11-25 17:52:23 +0100974 slot->key.data = NULL;
975 slot->key.bytes = 0;
Darryl Green40225ba2018-11-15 14:48:15 +0000976
Gilles Peskine449bd832023-01-11 14:50:10 +0100977 return PSA_SUCCESS;
Darryl Green40225ba2018-11-15 14:48:15 +0000978}
979
Gilles Peskinef77ed1f2018-12-03 11:58:46 +0100980/** Completely wipe a slot in memory, including its policy.
981 * Persistent storage is not affected. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100982psa_status_t psa_wipe_key_slot(psa_key_slot_t *slot)
Gilles Peskinef77ed1f2018-12-03 11:58:46 +0100983{
Ryan Everettaa33c512023-12-21 17:32:07 +0000984 if (slot->state != PSA_SLOT_PENDING_DELETION) {
985 return PSA_ERROR_BAD_STATE;
986 }
987
Gilles Peskine449bd832023-01-11 14:50:10 +0100988 psa_status_t status = psa_remove_key_data_from_memory(slot);
Ronald Cronddd3d052020-10-30 14:07:07 +0100989
Gilles Peskine449bd832023-01-11 14:50:10 +0100990 /*
991 * As the return error code may not be handled in case of multiple errors,
Ryan Everettaa33c512023-12-21 17:32:07 +0000992 * do our best to report an unexpected amount of registered readers.
993 * Assert with MBEDTLS_TEST_HOOK_TEST_ASSERT that registered_readers is
994 * equal to one:
Gilles Peskine449bd832023-01-11 14:50:10 +0100995 * if the MBEDTLS_TEST_HOOKS configuration option is enabled and the
996 * function is called as part of the execution of a test suite, the
997 * execution of the test suite is stopped in error if the assertion fails.
998 */
Ryan Everettaa33c512023-12-21 17:32:07 +0000999 if (slot->registered_readers != 1) {
1000 MBEDTLS_TEST_HOOK_TEST_ASSERT(slot->registered_readers == 1);
Ronald Cronddd3d052020-10-30 14:07:07 +01001001 status = PSA_ERROR_CORRUPTION_DETECTED;
1002 }
1003
Gilles Peskine3f7cd622019-08-13 15:01:08 +02001004 /* Multipart operations may still be using the key. This is safe
1005 * because all multipart operation objects are independent from
1006 * the key slot: if they need to access the key after the setup
1007 * phase, they have a copy of the key. Note that this means that
1008 * key material can linger until all operations are completed. */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001009 /* At this point, key material and other type-specific content has
1010 * been wiped. Clear remaining metadata. We can call memset and not
Ryan Everettaa33c512023-12-21 17:32:07 +00001011 * zeroize because the metadata is not particularly sensitive.
1012 * This memset also sets the slot's state to PSA_SLOT_EMPTY. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001013 memset(slot, 0, sizeof(*slot));
1014 return status;
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001015}
1016
Gilles Peskine449bd832023-01-11 14:50:10 +01001017psa_status_t psa_destroy_key(mbedtls_svc_key_id_t key)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001018{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001019 psa_key_slot_t *slot;
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001020 psa_status_t status; /* status of the last operation */
1021 psa_status_t overall_status = PSA_SUCCESS;
Gilles Peskine354f7672019-07-12 23:46:38 +02001022#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1023 psa_se_drv_table_entry_t *driver;
1024#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001025
Gilles Peskine449bd832023-01-11 14:50:10 +01001026 if (mbedtls_svc_key_id_is_null(key)) {
1027 return PSA_SUCCESS;
1028 }
Gilles Peskine1841cf42019-10-08 15:48:25 +02001029
Ronald Cronf2911112020-10-29 17:51:10 +01001030 /*
Ronald Cron19daca92020-11-10 18:08:03 +01001031 * Get the description of the key in a key slot. In case of a persistent
Ronald Cronf2911112020-10-29 17:51:10 +01001032 * key, this will load the key description from persistent memory if not
1033 * done yet. We cannot avoid this loading as without it we don't know if
1034 * the key is operated by an SE or not and this information is needed by
1035 * the current implementation.
1036 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001037 status = psa_get_and_lock_key_slot(key, &slot);
1038 if (status != PSA_SUCCESS) {
1039 return status;
1040 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001041
Ronald Cronf2911112020-10-29 17:51:10 +01001042 /*
1043 * If the key slot containing the key description is under access by the
1044 * library (apart from the present access), the key cannot be destroyed
1045 * yet. For the time being, just return in error. Eventually (to be
1046 * implemented), the key should be destroyed when all accesses have
1047 * stopped.
1048 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001049 if (slot->lock_count > 1) {
1050 psa_unlock_key_slot(slot);
1051 return PSA_ERROR_GENERIC_ERROR;
Ronald Cronf2911112020-10-29 17:51:10 +01001052 }
1053
Gilles Peskine449bd832023-01-11 14:50:10 +01001054 if (PSA_KEY_LIFETIME_IS_READ_ONLY(slot->attr.lifetime)) {
Gilles Peskine6687cd02021-04-21 22:32:05 +02001055 /* Refuse the destruction of a read-only key (which may or may not work
1056 * if we attempt it, depending on whether the key is merely read-only
1057 * by policy or actually physically read-only).
Gilles Peskinef9a046e2021-06-07 23:27:54 +02001058 * Just do the best we can, which is to wipe the copy in memory
1059 * (done in this function's cleanup code). */
1060 overall_status = PSA_ERROR_NOT_PERMITTED;
1061 goto exit;
Gilles Peskine6687cd02021-04-21 22:32:05 +02001062 }
1063
Gilles Peskine354f7672019-07-12 23:46:38 +02001064#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001065 driver = psa_get_se_driver_entry(slot->attr.lifetime);
1066 if (driver != NULL) {
Gilles Peskine60450a42019-07-25 11:32:45 +02001067 /* For a key in a secure element, we need to do three things:
1068 * remove the key file in internal storage, destroy the
1069 * key inside the secure element, and update the driver's
1070 * persistent data. Start a transaction that will encompass these
1071 * three actions. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001072 psa_crypto_prepare_transaction(PSA_CRYPTO_TRANSACTION_DESTROY_KEY);
Gilles Peskine8e338702019-07-30 20:06:31 +02001073 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Gilles Peskine449bd832023-01-11 14:50:10 +01001074 psa_crypto_transaction.key.slot = psa_key_slot_get_slot_number(slot);
Gilles Peskine8e338702019-07-30 20:06:31 +02001075 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskine449bd832023-01-11 14:50:10 +01001076 status = psa_crypto_save_transaction();
1077 if (status != PSA_SUCCESS) {
1078 (void) psa_crypto_stop_transaction();
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001079 /* We should still try to destroy the key in the secure
1080 * element and the key metadata in storage. This is especially
1081 * important if the error is that the storage is full.
1082 * But how to do it exactly without risking an inconsistent
1083 * state after a reset?
1084 * https://github.com/ARMmbed/mbed-crypto/issues/215
1085 */
1086 overall_status = status;
1087 goto exit;
Gilles Peskinefc762652019-07-22 19:30:34 +02001088 }
1089
Gilles Peskine449bd832023-01-11 14:50:10 +01001090 status = psa_destroy_se_key(driver,
1091 psa_key_slot_get_slot_number(slot));
1092 if (overall_status == PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001093 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001094 }
Gilles Peskinefc762652019-07-22 19:30:34 +02001095 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001096#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1097
Darryl Greend49a4992018-06-18 17:27:26 +01001098#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001099 if (!PSA_KEY_LIFETIME_IS_VOLATILE(slot->attr.lifetime)) {
1100 status = psa_destroy_persistent_key(slot->attr.id);
1101 if (overall_status == PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001102 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001103 }
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001104
Gilles Peskine9ce31c42019-08-13 15:14:20 +02001105 /* TODO: other slots may have a copy of the same key. We should
1106 * invalidate them.
1107 * https://github.com/ARMmbed/mbed-crypto/issues/214
1108 */
Darryl Greend49a4992018-06-18 17:27:26 +01001109 }
1110#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
Gilles Peskine354f7672019-07-12 23:46:38 +02001111
Gilles Peskinefc762652019-07-22 19:30:34 +02001112#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001113 if (driver != NULL) {
1114 status = psa_save_se_persistent_data(driver);
1115 if (overall_status == PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001116 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001117 }
1118 status = psa_crypto_stop_transaction();
1119 if (overall_status == PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001120 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001121 }
Gilles Peskinefc762652019-07-22 19:30:34 +02001122 }
1123#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1124
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001125exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01001126 status = psa_wipe_key_slot(slot);
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001127 /* Prioritize CORRUPTION_DETECTED from wiping over a storage error */
Gilles Peskine449bd832023-01-11 14:50:10 +01001128 if (status != PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001129 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001130 }
1131 return overall_status;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001132}
1133
Valerio Settib2bcedb2023-07-10 11:24:00 +02001134#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT) || \
John Durkop0e005192020-10-31 22:06:54 -07001135 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskineb699f072019-04-26 16:06:02 +02001136static psa_status_t psa_get_rsa_public_exponent(
1137 const mbedtls_rsa_context *rsa,
Gilles Peskine449bd832023-01-11 14:50:10 +01001138 psa_key_attributes_t *attributes)
Gilles Peskineb699f072019-04-26 16:06:02 +02001139{
1140 mbedtls_mpi mpi;
Janos Follath24eed8d2019-11-22 13:21:35 +00001141 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb699f072019-04-26 16:06:02 +02001142 uint8_t *buffer = NULL;
1143 size_t buflen;
Gilles Peskine449bd832023-01-11 14:50:10 +01001144 mbedtls_mpi_init(&mpi);
Gilles Peskineb699f072019-04-26 16:06:02 +02001145
Gilles Peskine449bd832023-01-11 14:50:10 +01001146 ret = mbedtls_rsa_export(rsa, NULL, NULL, NULL, NULL, &mpi);
1147 if (ret != 0) {
Gilles Peskineb699f072019-04-26 16:06:02 +02001148 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001149 }
1150 if (mbedtls_mpi_cmp_int(&mpi, 65537) == 0) {
Gilles Peskine772c8b12019-04-26 17:37:21 +02001151 /* It's the default value, which is reported as an empty string,
1152 * so there's nothing to do. */
1153 goto exit;
1154 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001155
Gilles Peskine449bd832023-01-11 14:50:10 +01001156 buflen = mbedtls_mpi_size(&mpi);
1157 buffer = mbedtls_calloc(1, buflen);
1158 if (buffer == NULL) {
Gilles Peskineb699f072019-04-26 16:06:02 +02001159 ret = MBEDTLS_ERR_MPI_ALLOC_FAILED;
1160 goto exit;
1161 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001162 ret = mbedtls_mpi_write_binary(&mpi, buffer, buflen);
1163 if (ret != 0) {
Gilles Peskineb699f072019-04-26 16:06:02 +02001164 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001165 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001166 attributes->domain_parameters = buffer;
1167 attributes->domain_parameters_size = buflen;
1168
1169exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01001170 mbedtls_mpi_free(&mpi);
1171 if (ret != 0) {
1172 mbedtls_free(buffer);
1173 }
1174 return mbedtls_to_psa_error(ret);
Gilles Peskineb699f072019-04-26 16:06:02 +02001175}
Valerio Settib2bcedb2023-07-10 11:24:00 +02001176#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT) ||
John Durkop9814fa22020-11-04 12:28:15 -08001177 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001178
Gilles Peskinebfd322f2019-07-23 11:58:03 +02001179/** Retrieve all the publicly-accessible attributes of a key.
1180 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001181psa_status_t psa_get_key_attributes(mbedtls_svc_key_id_t key,
1182 psa_key_attributes_t *attributes)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001183{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001184 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001185 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001186 psa_key_slot_t *slot;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001187
Gilles Peskine449bd832023-01-11 14:50:10 +01001188 psa_reset_key_attributes(attributes);
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001189
Gilles Peskine449bd832023-01-11 14:50:10 +01001190 status = psa_get_and_lock_key_slot_with_policy(key, &slot, 0, 0);
1191 if (status != PSA_SUCCESS) {
1192 return status;
1193 }
Gilles Peskineb870b182018-07-06 16:02:09 +02001194
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001195 attributes->core = slot->attr;
Gilles Peskine449bd832023-01-11 14:50:10 +01001196 attributes->core.flags &= (MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1197 MBEDTLS_PSA_KA_MASK_DUAL_USE);
Gilles Peskinec8000c02019-08-02 20:15:51 +02001198
1199#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001200 if (psa_get_se_driver_entry(slot->attr.lifetime) != NULL) {
1201 psa_set_key_slot_number(attributes,
1202 psa_key_slot_get_slot_number(slot));
1203 }
Gilles Peskinec8000c02019-08-02 20:15:51 +02001204#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineb699f072019-04-26 16:06:02 +02001205
Gilles Peskine449bd832023-01-11 14:50:10 +01001206 switch (slot->attr.type) {
Valerio Settib2bcedb2023-07-10 11:24:00 +02001207#if (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) && \
1208 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) || \
John Durkop0e005192020-10-31 22:06:54 -07001209 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02001210 case PSA_KEY_TYPE_RSA_KEY_PAIR:
Gilles Peskineb699f072019-04-26 16:06:02 +02001211 case PSA_KEY_TYPE_RSA_PUBLIC_KEY:
Pengyu Lvf75893b2023-12-08 17:21:39 +08001212 /* TODO: This is a temporary situation where domain parameters are deprecated,
1213 * but we need it for namely generating an RSA key with a non-default exponent.
1214 * This would be improved after https://github.com/Mbed-TLS/mbedtls/issues/6494.
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001215 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001216 if (!psa_key_lifetime_is_external(slot->attr.lifetime)) {
Steven Cooremana2371e52020-07-28 14:30:39 +02001217 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02001218
Ronald Cron90857082020-11-25 14:58:33 +01001219 status = mbedtls_psa_rsa_load_representation(
Gilles Peskine449bd832023-01-11 14:50:10 +01001220 slot->attr.type,
1221 slot->key.data,
1222 slot->key.bytes,
1223 &rsa);
1224 if (status != PSA_SUCCESS) {
Steven Cooremana01795d2020-07-24 22:48:15 +02001225 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01001226 }
Steven Cooremana01795d2020-07-24 22:48:15 +02001227
Gilles Peskine449bd832023-01-11 14:50:10 +01001228 status = psa_get_rsa_public_exponent(rsa,
1229 attributes);
1230 mbedtls_rsa_free(rsa);
1231 mbedtls_free(rsa);
Steven Cooremana01795d2020-07-24 22:48:15 +02001232 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001233 break;
Pengyu Lve9efbc22023-12-08 16:59:08 +08001234#else
1235 case PSA_KEY_TYPE_RSA_KEY_PAIR:
1236 case PSA_KEY_TYPE_RSA_PUBLIC_KEY:
1237 attributes->domain_parameters = NULL;
1238 attributes->domain_parameters_size = SIZE_MAX;
1239 break;
Valerio Settib2bcedb2023-07-10 11:24:00 +02001240#endif /* (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) && \
1241 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) ||
John Durkop9814fa22020-11-04 12:28:15 -08001242 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001243 default:
1244 /* Nothing else to do. */
1245 break;
1246 }
1247
Gilles Peskine449bd832023-01-11 14:50:10 +01001248 if (status != PSA_SUCCESS) {
1249 psa_reset_key_attributes(attributes);
1250 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001251
Gilles Peskine449bd832023-01-11 14:50:10 +01001252 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02001253
Gilles Peskine449bd832023-01-11 14:50:10 +01001254 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001255}
1256
Gilles Peskinec8000c02019-08-02 20:15:51 +02001257#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1258psa_status_t psa_get_key_slot_number(
1259 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01001260 psa_key_slot_number_t *slot_number)
Gilles Peskinec8000c02019-08-02 20:15:51 +02001261{
Gilles Peskine449bd832023-01-11 14:50:10 +01001262 if (attributes->core.flags & MBEDTLS_PSA_KA_FLAG_HAS_SLOT_NUMBER) {
Gilles Peskinec8000c02019-08-02 20:15:51 +02001263 *slot_number = attributes->slot_number;
Gilles Peskine449bd832023-01-11 14:50:10 +01001264 return PSA_SUCCESS;
1265 } else {
1266 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinec8000c02019-08-02 20:15:51 +02001267 }
Gilles Peskinec8000c02019-08-02 20:15:51 +02001268}
1269#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1270
Gilles Peskine449bd832023-01-11 14:50:10 +01001271static psa_status_t psa_export_key_buffer_internal(const uint8_t *key_buffer,
1272 size_t key_buffer_size,
1273 uint8_t *data,
1274 size_t data_size,
1275 size_t *data_length)
Steven Cooremana01795d2020-07-24 22:48:15 +02001276{
Gilles Peskine449bd832023-01-11 14:50:10 +01001277 if (key_buffer_size > data_size) {
1278 return PSA_ERROR_BUFFER_TOO_SMALL;
1279 }
1280 memcpy(data, key_buffer, key_buffer_size);
1281 memset(data + key_buffer_size, 0,
1282 data_size - key_buffer_size);
Ronald Crond18b5f82020-11-25 16:46:05 +01001283 *data_length = key_buffer_size;
Gilles Peskine449bd832023-01-11 14:50:10 +01001284 return PSA_SUCCESS;
Steven Cooremana01795d2020-07-24 22:48:15 +02001285}
1286
Ronald Cron7285cda2020-11-26 14:46:37 +01001287psa_status_t psa_export_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001288 const psa_key_attributes_t *attributes,
1289 const uint8_t *key_buffer, size_t key_buffer_size,
Gilles Peskine449bd832023-01-11 14:50:10 +01001290 uint8_t *data, size_t data_size, size_t *data_length)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001291{
Ronald Crond18b5f82020-11-25 16:46:05 +01001292 psa_key_type_t type = attributes->core.type;
1293
Gilles Peskine449bd832023-01-11 14:50:10 +01001294 if (key_type_is_raw_bytes(type) ||
1295 PSA_KEY_TYPE_IS_RSA(type) ||
Przemek Stekiel472b3f32022-12-01 14:38:49 +01001296 PSA_KEY_TYPE_IS_ECC(type) ||
1297 PSA_KEY_TYPE_IS_DH(type)) {
Gilles Peskine449bd832023-01-11 14:50:10 +01001298 return psa_export_key_buffer_internal(
1299 key_buffer, key_buffer_size,
1300 data, data_size, data_length);
1301 } else {
Ronald Cron9486f9d2020-11-26 13:36:23 +01001302 /* This shouldn't happen in the reference implementation, but
1303 it is valid for a special-purpose implementation to omit
1304 support for exporting certain key types. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001305 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron9486f9d2020-11-26 13:36:23 +01001306 }
1307}
1308
Gilles Peskine449bd832023-01-11 14:50:10 +01001309psa_status_t psa_export_key(mbedtls_svc_key_id_t key,
1310 uint8_t *data,
1311 size_t data_size,
1312 size_t *data_length)
Ronald Cron9486f9d2020-11-26 13:36:23 +01001313{
1314 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
1315 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
1316 psa_key_slot_t *slot;
1317
Ronald Crone907e552021-01-18 13:22:38 +01001318 /* Reject a zero-length output buffer now, since this can never be a
1319 * valid key representation. This way we know that data must be a valid
1320 * pointer and we can do things like memset(data, ..., data_size). */
Gilles Peskine449bd832023-01-11 14:50:10 +01001321 if (data_size == 0) {
1322 return PSA_ERROR_BUFFER_TOO_SMALL;
1323 }
Ronald Crone907e552021-01-18 13:22:38 +01001324
Ronald Cron9486f9d2020-11-26 13:36:23 +01001325 /* Set the key to empty now, so that even when there are errors, we always
1326 * set data_length to a value between 0 and data_size. On error, setting
1327 * the key to empty is a good choice because an empty key representation is
1328 * unlikely to be accepted anywhere. */
Jaeden Amerof24c7f82018-06-27 17:20:43 +01001329 *data_length = 0;
1330
Ronald Cron9486f9d2020-11-26 13:36:23 +01001331 /* Export requires the EXPORT flag. There is an exception for public keys,
1332 * which don't require any flag, but
1333 * psa_get_and_lock_key_slot_with_policy() takes care of this.
1334 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001335 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
1336 PSA_KEY_USAGE_EXPORT, 0);
1337 if (status != PSA_SUCCESS) {
1338 return status;
1339 }
mohammad160306e79202018-03-28 13:17:44 +03001340
Ronald Crond18b5f82020-11-25 16:46:05 +01001341 psa_key_attributes_t attributes = {
1342 .core = slot->attr
1343 };
Gilles Peskine449bd832023-01-11 14:50:10 +01001344 status = psa_driver_wrapper_export_key(&attributes,
1345 slot->key.data, slot->key.bytes,
1346 data, data_size, data_length);
Ronald Cron9486f9d2020-11-26 13:36:23 +01001347
Gilles Peskine449bd832023-01-11 14:50:10 +01001348 unlock_status = psa_unlock_key_slot(slot);
Ronald Cron9486f9d2020-11-26 13:36:23 +01001349
Gilles Peskine449bd832023-01-11 14:50:10 +01001350 return (status == PSA_SUCCESS) ? unlock_status : status;
Ronald Cron9486f9d2020-11-26 13:36:23 +01001351}
1352
Ronald Cron7285cda2020-11-26 14:46:37 +01001353psa_status_t psa_export_public_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001354 const psa_key_attributes_t *attributes,
1355 const uint8_t *key_buffer,
1356 size_t key_buffer_size,
1357 uint8_t *data,
1358 size_t data_size,
Gilles Peskine449bd832023-01-11 14:50:10 +01001359 size_t *data_length)
Ronald Cron9486f9d2020-11-26 13:36:23 +01001360{
Ronald Crond18b5f82020-11-25 16:46:05 +01001361 psa_key_type_t type = attributes->core.type;
Ronald Crond18b5f82020-11-25 16:46:05 +01001362
Przemek Stekiel6fd72b62023-04-27 10:20:56 +02001363 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(type) &&
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001364 (PSA_KEY_TYPE_IS_RSA(type) || PSA_KEY_TYPE_IS_ECC(type) ||
1365 PSA_KEY_TYPE_IS_DH(type))) {
Przemek Stekiel6fd72b62023-04-27 10:20:56 +02001366 /* Exporting public -> public */
1367 return psa_export_key_buffer_internal(
1368 key_buffer, key_buffer_size,
1369 data, data_size, data_length);
1370 } else if (PSA_KEY_TYPE_IS_RSA(type)) {
Valerio Settib2bcedb2023-07-10 11:24:00 +02001371#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT) || \
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001372 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
1373 return mbedtls_psa_rsa_export_public_key(attributes,
1374 key_buffer,
1375 key_buffer_size,
1376 data,
1377 data_size,
1378 data_length);
Darryl Green9e2d7a02018-07-24 16:33:30 +01001379#else
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001380 /* We don't know how to convert a private RSA key to public. */
1381 return PSA_ERROR_NOT_SUPPORTED;
Valerio Settib2bcedb2023-07-10 11:24:00 +02001382#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT) ||
John Durkop9814fa22020-11-04 12:28:15 -08001383 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Przemek Stekiel6fd72b62023-04-27 10:20:56 +02001384 } else if (PSA_KEY_TYPE_IS_ECC(type)) {
Valerio Setti27c501a2023-06-27 16:58:52 +02001385#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_EXPORT) || \
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001386 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
1387 return mbedtls_psa_ecp_export_public_key(attributes,
1388 key_buffer,
1389 key_buffer_size,
1390 data,
1391 data_size,
1392 data_length);
Steven Cooreman560c28a2020-07-24 23:20:24 +02001393#else
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001394 /* We don't know how to convert a private ECC key to public */
1395 return PSA_ERROR_NOT_SUPPORTED;
Valerio Setti27c501a2023-06-27 16:58:52 +02001396#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_EXPORT) ||
John Durkop9814fa22020-11-04 12:28:15 -08001397 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
Przemek Stekiel6fd72b62023-04-27 10:20:56 +02001398 } else if (PSA_KEY_TYPE_IS_DH(type)) {
Valerio Settia55f0422023-07-10 15:34:41 +02001399#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_EXPORT) || \
Przemek Stekiel6d85afa2023-04-28 11:42:17 +02001400 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY)
Przemek Stekiel152bb462023-06-01 11:52:39 +02001401 return mbedtls_psa_ffdh_export_public_key(attributes,
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001402 key_buffer,
1403 key_buffer_size,
1404 data, data_size,
1405 data_length);
Przemek Stekiel472b3f32022-12-01 14:38:49 +01001406#else
Przemek Stekiel472b3f32022-12-01 14:38:49 +01001407 return PSA_ERROR_NOT_SUPPORTED;
Valerio Settia55f0422023-07-10 15:34:41 +02001408#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_EXPORT) ||
Przemek Stekiel6d85afa2023-04-28 11:42:17 +02001409 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY) */
Gilles Peskine449bd832023-01-11 14:50:10 +01001410 } else {
Przemek Stekiel0b11ee02023-05-16 13:26:06 +02001411 (void) key_buffer;
1412 (void) key_buffer_size;
1413 (void) data;
1414 (void) data_size;
1415 (void) data_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01001416 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman560c28a2020-07-24 23:20:24 +02001417 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001418}
Ronald Crond18b5f82020-11-25 16:46:05 +01001419
Gilles Peskine449bd832023-01-11 14:50:10 +01001420psa_status_t psa_export_public_key(mbedtls_svc_key_id_t key,
1421 uint8_t *data,
1422 size_t data_size,
1423 size_t *data_length)
Moran Pekerdd4ea382018-04-03 15:30:03 +03001424{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001425 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001426 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001427 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01001428 psa_key_attributes_t attributes;
Darryl Greendd8fb772018-11-07 16:00:44 +00001429
Ronald Crone907e552021-01-18 13:22:38 +01001430 /* Reject a zero-length output buffer now, since this can never be a
1431 * valid key representation. This way we know that data must be a valid
1432 * pointer and we can do things like memset(data, ..., data_size). */
Gilles Peskine449bd832023-01-11 14:50:10 +01001433 if (data_size == 0) {
1434 return PSA_ERROR_BUFFER_TOO_SMALL;
1435 }
Ronald Crone907e552021-01-18 13:22:38 +01001436
Darryl Greendd8fb772018-11-07 16:00:44 +00001437 /* Set the key to empty now, so that even when there are errors, we always
1438 * set data_length to a value between 0 and data_size. On error, setting
1439 * the key to empty is a good choice because an empty key representation is
1440 * unlikely to be accepted anywhere. */
1441 *data_length = 0;
1442
1443 /* Exporting a public key doesn't require a usage flag. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001444 status = psa_get_and_lock_key_slot_with_policy(key, &slot, 0, 0);
1445 if (status != PSA_SUCCESS) {
1446 return status;
1447 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001448
Gilles Peskine449bd832023-01-11 14:50:10 +01001449 if (!PSA_KEY_TYPE_IS_ASYMMETRIC(slot->attr.type)) {
1450 status = PSA_ERROR_INVALID_ARGUMENT;
1451 goto exit;
Ronald Cron9486f9d2020-11-26 13:36:23 +01001452 }
1453
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01001454 attributes = (psa_key_attributes_t) {
Ronald Crond18b5f82020-11-25 16:46:05 +01001455 .core = slot->attr
1456 };
Ronald Cron67227982020-11-26 15:16:05 +01001457 status = psa_driver_wrapper_export_public_key(
Ronald Crond18b5f82020-11-25 16:46:05 +01001458 &attributes, slot->key.data, slot->key.bytes,
Gilles Peskine449bd832023-01-11 14:50:10 +01001459 data, data_size, data_length);
Ronald Cron9486f9d2020-11-26 13:36:23 +01001460
1461exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01001462 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02001463
Gilles Peskine449bd832023-01-11 14:50:10 +01001464 return (status == PSA_SUCCESS) ? unlock_status : status;
Moran Pekerdd4ea382018-04-03 15:30:03 +03001465}
1466
Tom Cosgrove6ef9bb32023-03-08 14:19:51 +00001467MBEDTLS_STATIC_ASSERT(
1468 (MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE) == 0,
1469 "One or more key attribute flag is listed as both external-only and dual-use")
1470MBEDTLS_STATIC_ASSERT(
1471 (PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE) == 0,
1472 "One or more key attribute flag is listed as both internal-only and dual-use")
1473MBEDTLS_STATIC_ASSERT(
1474 (PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY) == 0,
1475 "One or more key attribute flag is listed as both internal-only and external-only")
Gilles Peskine91e8c332019-08-02 19:19:39 +02001476
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001477/** Validate that a key policy is internally well-formed.
1478 *
1479 * This function only rejects invalid policies. It does not validate the
1480 * consistency of the policy with respect to other attributes of the key
1481 * such as the key type.
1482 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001483static psa_status_t psa_validate_key_policy(const psa_key_policy_t *policy)
Gilles Peskine4747d192019-04-17 15:05:45 +02001484{
Gilles Peskine449bd832023-01-11 14:50:10 +01001485 if ((policy->usage & ~(PSA_KEY_USAGE_EXPORT |
1486 PSA_KEY_USAGE_COPY |
1487 PSA_KEY_USAGE_ENCRYPT |
1488 PSA_KEY_USAGE_DECRYPT |
1489 PSA_KEY_USAGE_SIGN_MESSAGE |
1490 PSA_KEY_USAGE_VERIFY_MESSAGE |
1491 PSA_KEY_USAGE_SIGN_HASH |
1492 PSA_KEY_USAGE_VERIFY_HASH |
1493 PSA_KEY_USAGE_VERIFY_DERIVATION |
1494 PSA_KEY_USAGE_DERIVE)) != 0) {
1495 return PSA_ERROR_INVALID_ARGUMENT;
1496 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001497
Gilles Peskine449bd832023-01-11 14:50:10 +01001498 return PSA_SUCCESS;
Gilles Peskine4747d192019-04-17 15:05:45 +02001499}
1500
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001501/** Validate the internal consistency of key attributes.
1502 *
1503 * This function only rejects invalid attribute values. If does not
1504 * validate the consistency of the attributes with any key data that may
1505 * be involved in the creation of the key.
1506 *
1507 * Call this function early in the key creation process.
1508 *
1509 * \param[in] attributes Key attributes for the new key.
1510 * \param[out] p_drv On any return, the driver for the key, if any.
1511 * NULL for a transparent key.
1512 *
1513 */
1514static psa_status_t psa_validate_key_attributes(
1515 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01001516 psa_se_drv_table_entry_t **p_drv)
Darryl Green0c6575a2018-11-07 16:05:30 +00001517{
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001518 psa_status_t status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine449bd832023-01-11 14:50:10 +01001519 psa_key_lifetime_t lifetime = psa_get_key_lifetime(attributes);
1520 mbedtls_svc_key_id_t key = psa_get_key_id(attributes);
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001521
Gilles Peskine449bd832023-01-11 14:50:10 +01001522 status = psa_validate_key_location(lifetime, p_drv);
1523 if (status != PSA_SUCCESS) {
1524 return status;
Ronald Crond2ed4812020-07-17 16:11:30 +02001525 }
1526
Gilles Peskine449bd832023-01-11 14:50:10 +01001527 status = psa_validate_key_persistence(lifetime);
1528 if (status != PSA_SUCCESS) {
1529 return status;
1530 }
1531
1532 if (PSA_KEY_LIFETIME_IS_VOLATILE(lifetime)) {
1533 if (MBEDTLS_SVC_KEY_ID_GET_KEY_ID(key) != 0) {
1534 return PSA_ERROR_INVALID_ARGUMENT;
1535 }
1536 } else {
1537 if (!psa_is_valid_key_id(psa_get_key_id(attributes), 0)) {
1538 return PSA_ERROR_INVALID_ARGUMENT;
1539 }
1540 }
1541
1542 status = psa_validate_key_policy(&attributes->core.policy);
1543 if (status != PSA_SUCCESS) {
1544 return status;
1545 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001546
1547 /* Refuse to create overly large keys.
1548 * Note that this doesn't trigger on import if the attributes don't
1549 * explicitly specify a size (so psa_get_key_bits returns 0), so
1550 * psa_import_key() needs its own checks. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001551 if (psa_get_key_bits(attributes) > PSA_MAX_KEY_BITS) {
1552 return PSA_ERROR_NOT_SUPPORTED;
1553 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001554
Gilles Peskine91e8c332019-08-02 19:19:39 +02001555 /* Reject invalid flags. These should not be reachable through the API. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001556 if (attributes->core.flags & ~(MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1557 MBEDTLS_PSA_KA_MASK_DUAL_USE)) {
1558 return PSA_ERROR_INVALID_ARGUMENT;
1559 }
Gilles Peskine91e8c332019-08-02 19:19:39 +02001560
Gilles Peskine449bd832023-01-11 14:50:10 +01001561 return PSA_SUCCESS;
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001562}
1563
Gilles Peskine4747d192019-04-17 15:05:45 +02001564/** Prepare a key slot to receive key material.
1565 *
1566 * This function allocates a key slot and sets its metadata.
1567 *
1568 * If this function fails, call psa_fail_key_creation().
1569 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001570 * This function is intended to be used as follows:
1571 * -# Call psa_start_key_creation() to allocate a key slot, prepare
Ronald Croncf56a0a2020-08-04 09:51:30 +02001572 * it with the specified attributes, and in case of a volatile key assign it
1573 * a volatile key identifier.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001574 * -# Populate the slot with the key material.
1575 * -# Call psa_finish_key_creation() to finalize the creation of the slot.
1576 * In case of failure at any step, stop the sequence and call
1577 * psa_fail_key_creation().
1578 *
Ryan Everettb69118e2024-01-02 15:54:32 +00001579 * On success, the key slot's state is PSA_SLOT_FILLING.
1580 * It is the responsibility of the caller to change the slot's state to
1581 * PSA_SLOT_EMPTY/FULL once key creation has finished.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001582 *
Gilles Peskinedf179142019-07-15 22:02:14 +02001583 * \param method An identification of the calling function.
Gilles Peskine011e4282019-06-26 18:34:38 +02001584 * \param[in] attributes Key attributes for the new key.
Gilles Peskine011e4282019-06-26 18:34:38 +02001585 * \param[out] p_slot On success, a pointer to the prepared slot.
1586 * \param[out] p_drv On any return, the driver for the key, if any.
1587 * NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001588 *
1589 * \retval #PSA_SUCCESS
1590 * The key slot is ready to receive key material.
1591 * \return If this function fails, the key slot is an invalid state.
1592 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001593 */
1594static psa_status_t psa_start_key_creation(
Gilles Peskinedf179142019-07-15 22:02:14 +02001595 psa_key_creation_method_t method,
Gilles Peskine4747d192019-04-17 15:05:45 +02001596 const psa_key_attributes_t *attributes,
Gilles Peskine011e4282019-06-26 18:34:38 +02001597 psa_key_slot_t **p_slot,
Gilles Peskine449bd832023-01-11 14:50:10 +01001598 psa_se_drv_table_entry_t **p_drv)
Gilles Peskine4747d192019-04-17 15:05:45 +02001599{
1600 psa_status_t status;
Ronald Cron2a993152020-07-17 14:13:26 +02001601 psa_key_id_t volatile_key_id;
Gilles Peskine4747d192019-04-17 15:05:45 +02001602 psa_key_slot_t *slot;
1603
Gilles Peskinedf179142019-07-15 22:02:14 +02001604 (void) method;
Gilles Peskine011e4282019-06-26 18:34:38 +02001605 *p_drv = NULL;
1606
Gilles Peskine449bd832023-01-11 14:50:10 +01001607 status = psa_validate_key_attributes(attributes, p_drv);
1608 if (status != PSA_SUCCESS) {
1609 return status;
1610 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001611
Ryan Everettb69118e2024-01-02 15:54:32 +00001612 status = psa_reserve_free_key_slot(&volatile_key_id, p_slot);
Gilles Peskine449bd832023-01-11 14:50:10 +01001613 if (status != PSA_SUCCESS) {
1614 return status;
1615 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001616 slot = *p_slot;
1617
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001618 /* We're storing the declared bit-size of the key. It's up to each
1619 * creation mechanism to verify that this information is correct.
1620 * It's automatically correct for mechanisms that use the bit-size as
Gilles Peskineb46bef22019-07-30 21:32:04 +02001621 * an input (generate, device) but not for those where the bit-size
Ronald Cronc4d1b512020-07-31 11:26:37 +02001622 * is optional (import, copy). In case of a volatile key, assign it the
1623 * volatile key identifier associated to the slot returned to contain its
1624 * definition. */
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001625
1626 slot->attr = attributes->core;
Gilles Peskine449bd832023-01-11 14:50:10 +01001627 if (PSA_KEY_LIFETIME_IS_VOLATILE(slot->attr.lifetime)) {
Ronald Cronc4d1b512020-07-31 11:26:37 +02001628#if !defined(MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER)
1629 slot->attr.id = volatile_key_id;
1630#else
1631 slot->attr.id.key_id = volatile_key_id;
1632#endif
1633 }
Gilles Peskinec744d992019-07-30 17:26:54 +02001634
Gilles Peskine91e8c332019-08-02 19:19:39 +02001635 /* Erase external-only flags from the internal copy. To access
Gilles Peskine013f5472019-08-07 15:42:14 +02001636 * external-only flags, query `attributes`. Thanks to the check
1637 * in psa_validate_key_attributes(), this leaves the dual-use
Ryan Everettb69118e2024-01-02 15:54:32 +00001638 * flags and any internal flag that psa_reserve_free_key_slot()
Gilles Peskine013f5472019-08-07 15:42:14 +02001639 * may have set. */
1640 slot->attr.flags &= ~MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY;
Gilles Peskine91e8c332019-08-02 19:19:39 +02001641
Gilles Peskinecbaff462019-07-12 23:46:04 +02001642#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001643 /* For a key in a secure element, we need to do three things
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001644 * when creating or registering a persistent key:
Gilles Peskine60450a42019-07-25 11:32:45 +02001645 * create the key file in internal storage, create the
1646 * key inside the secure element, and update the driver's
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001647 * persistent data. This is done by starting a transaction that will
1648 * encompass these three actions.
1649 * For registering a volatile key, we just need to find an appropriate
1650 * slot number inside the SE. Since the key is designated volatile, creating
1651 * a transaction is not required. */
Gilles Peskine60450a42019-07-25 11:32:45 +02001652 /* The first thing to do is to find a slot number for the new key.
1653 * We save the slot number in persistent storage as part of the
1654 * transaction data. It will be needed to recover if the power
1655 * fails during the key creation process, to clean up on the secure
1656 * element side after restarting. Obtaining a slot number from the
1657 * secure element driver updates its persistent state, but we do not yet
1658 * save the driver's persistent state, so that if the power fails,
Gilles Peskinefc762652019-07-22 19:30:34 +02001659 * we can roll back to a state where the key doesn't exist. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001660 if (*p_drv != NULL) {
Ronald Cronea0f8a62020-11-25 17:52:23 +01001661 psa_key_slot_number_t slot_number;
Gilles Peskine449bd832023-01-11 14:50:10 +01001662 status = psa_find_se_slot_for_key(attributes, method, *p_drv,
1663 &slot_number);
1664 if (status != PSA_SUCCESS) {
1665 return status;
1666 }
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001667
Gilles Peskine449bd832023-01-11 14:50:10 +01001668 if (!PSA_KEY_LIFETIME_IS_VOLATILE(attributes->core.lifetime)) {
1669 psa_crypto_prepare_transaction(PSA_CRYPTO_TRANSACTION_CREATE_KEY);
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001670 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001671 psa_crypto_transaction.key.slot = slot_number;
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001672 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskine449bd832023-01-11 14:50:10 +01001673 status = psa_crypto_save_transaction();
1674 if (status != PSA_SUCCESS) {
1675 (void) psa_crypto_stop_transaction();
1676 return status;
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001677 }
Gilles Peskine66be51c2019-07-25 18:02:52 +02001678 }
Ronald Cronea0f8a62020-11-25 17:52:23 +01001679
1680 status = psa_copy_key_material_into_slot(
Gilles Peskine449bd832023-01-11 14:50:10 +01001681 slot, (uint8_t *) (&slot_number), sizeof(slot_number));
Darryl Green0c6575a2018-11-07 16:05:30 +00001682 }
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001683
Gilles Peskine449bd832023-01-11 14:50:10 +01001684 if (*p_drv == NULL && method == PSA_KEY_CREATION_REGISTER) {
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001685 /* Key registration only makes sense with a secure element. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001686 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001687 }
Gilles Peskinecbaff462019-07-12 23:46:04 +02001688#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1689
Gilles Peskine449bd832023-01-11 14:50:10 +01001690 return PSA_SUCCESS;
Darryl Green0c6575a2018-11-07 16:05:30 +00001691}
Gilles Peskine4747d192019-04-17 15:05:45 +02001692
1693/** Finalize the creation of a key once its key material has been set.
1694 *
1695 * This entails writing the key to persistent storage.
1696 *
1697 * If this function fails, call psa_fail_key_creation().
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001698 * See the documentation of psa_start_key_creation() for the intended use
1699 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001700 *
Ryan Everettb69118e2024-01-02 15:54:32 +00001701 * If the finalization succeeds, the function sets the key slot's state to
1702 * PSA_SLOT_FULL, and the key slot can no longer be accessed as part of the
1703 * key creation process.
Ronald Cron50972942020-11-14 11:28:25 +01001704 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001705 * \param[in,out] slot Pointer to the slot with key material.
1706 * \param[in] driver The secure element driver for the key,
1707 * or NULL for a transparent key.
Ronald Cron81709fc2020-11-14 12:10:32 +01001708 * \param[out] key On success, identifier of the key. Note that the
1709 * key identifier is also stored in the key slot.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001710 *
1711 * \retval #PSA_SUCCESS
Ronald Croncf56a0a2020-08-04 09:51:30 +02001712 * The key was successfully created.
Gilles Peskineed733552023-02-14 19:21:09 +01001713 * \retval #PSA_ERROR_INSUFFICIENT_MEMORY \emptydescription
1714 * \retval #PSA_ERROR_INSUFFICIENT_STORAGE \emptydescription
1715 * \retval #PSA_ERROR_ALREADY_EXISTS \emptydescription
1716 * \retval #PSA_ERROR_DATA_INVALID \emptydescription
1717 * \retval #PSA_ERROR_DATA_CORRUPT \emptydescription
1718 * \retval #PSA_ERROR_STORAGE_FAILURE \emptydescription
Ryan Everettb69118e2024-01-02 15:54:32 +00001719 * \retval #PSA_ERROR_BAD_STATE \emptydescription
gabor-mezei-arm452b0a32020-11-09 17:42:55 +01001720 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001721 * \return If this function fails, the key slot is an invalid state.
1722 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001723 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001724static psa_status_t psa_finish_key_creation(
1725 psa_key_slot_t *slot,
Ronald Cron81709fc2020-11-14 12:10:32 +01001726 psa_se_drv_table_entry_t *driver,
1727 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02001728{
1729 psa_status_t status = PSA_SUCCESS;
Gilles Peskine30afafd2019-04-25 13:47:40 +02001730 (void) slot;
Gilles Peskine011e4282019-06-26 18:34:38 +02001731 (void) driver;
Gilles Peskine4747d192019-04-17 15:05:45 +02001732
1733#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001734 if (!PSA_KEY_LIFETIME_IS_VOLATILE(slot->attr.lifetime)) {
Gilles Peskine1df83d42019-07-23 16:13:14 +02001735#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001736 if (driver != NULL) {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001737 psa_se_key_data_storage_t data;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001738 psa_key_slot_number_t slot_number =
Gilles Peskine449bd832023-01-11 14:50:10 +01001739 psa_key_slot_get_slot_number(slot);
Ronald Cronea0f8a62020-11-25 17:52:23 +01001740
Tom Cosgrove6ef9bb32023-03-08 14:19:51 +00001741 MBEDTLS_STATIC_ASSERT(sizeof(slot_number) ==
1742 sizeof(data.slot_number),
1743 "Slot number size does not match psa_se_key_data_storage_t");
1744
Gilles Peskine449bd832023-01-11 14:50:10 +01001745 memcpy(&data.slot_number, &slot_number, sizeof(slot_number));
1746 status = psa_save_persistent_key(&slot->attr,
1747 (uint8_t *) &data,
1748 sizeof(data));
1749 } else
Gilles Peskine1df83d42019-07-23 16:13:14 +02001750#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1751 {
Steven Cooreman40120f62020-10-29 11:42:22 +01001752 /* Key material is saved in export representation in the slot, so
1753 * just pass the slot buffer for storage. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001754 status = psa_save_persistent_key(&slot->attr,
1755 slot->key.data,
1756 slot->key.bytes);
Gilles Peskine1df83d42019-07-23 16:13:14 +02001757 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001758 }
Darryl Green0c6575a2018-11-07 16:05:30 +00001759#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
1760
Gilles Peskinecbaff462019-07-12 23:46:04 +02001761#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001762 /* Finish the transaction for a key creation. This does not
1763 * happen when registering an existing key. Detect this case
1764 * by checking whether a transaction is in progress (actual
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001765 * creation of a persistent key in a secure element requires a transaction,
1766 * but registration or volatile key creation doesn't use one). */
Gilles Peskine449bd832023-01-11 14:50:10 +01001767 if (driver != NULL &&
1768 psa_crypto_transaction.unknown.type == PSA_CRYPTO_TRANSACTION_CREATE_KEY) {
1769 status = psa_save_se_persistent_data(driver);
1770 if (status != PSA_SUCCESS) {
1771 psa_destroy_persistent_key(slot->attr.id);
1772 return status;
Gilles Peskinecbaff462019-07-12 23:46:04 +02001773 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001774 status = psa_crypto_stop_transaction();
Gilles Peskinecbaff462019-07-12 23:46:04 +02001775 }
1776#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1777
Gilles Peskine449bd832023-01-11 14:50:10 +01001778 if (status == PSA_SUCCESS) {
Ronald Cron81709fc2020-11-14 12:10:32 +01001779 *key = slot->attr.id;
Ryan Everettb69118e2024-01-02 15:54:32 +00001780 status = psa_key_slot_state_transition(slot, PSA_SLOT_FILLING,
1781 PSA_SLOT_FULL);
Gilles Peskine449bd832023-01-11 14:50:10 +01001782 if (status != PSA_SUCCESS) {
Ronald Cron81709fc2020-11-14 12:10:32 +01001783 *key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01001784 }
Ronald Cron81709fc2020-11-14 12:10:32 +01001785 }
Ronald Cron50972942020-11-14 11:28:25 +01001786
Gilles Peskine449bd832023-01-11 14:50:10 +01001787 return status;
Gilles Peskine4747d192019-04-17 15:05:45 +02001788}
1789
1790/** Abort the creation of a key.
1791 *
1792 * You may call this function after calling psa_start_key_creation(),
1793 * or after psa_finish_key_creation() fails. In other circumstances, this
1794 * function may not clean up persistent storage.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001795 * See the documentation of psa_start_key_creation() for the intended use
Ryan Everettb69118e2024-01-02 15:54:32 +00001796 * of this function. Sets the slot's state to PSA_SLOT_EMPTY.
Gilles Peskine4747d192019-04-17 15:05:45 +02001797 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001798 * \param[in,out] slot Pointer to the slot with key material.
1799 * \param[in] driver The secure element driver for the key,
1800 * or NULL for a transparent key.
Gilles Peskine4747d192019-04-17 15:05:45 +02001801 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001802static void psa_fail_key_creation(psa_key_slot_t *slot,
1803 psa_se_drv_table_entry_t *driver)
Gilles Peskine4747d192019-04-17 15:05:45 +02001804{
Gilles Peskine011e4282019-06-26 18:34:38 +02001805 (void) driver;
1806
Gilles Peskine449bd832023-01-11 14:50:10 +01001807 if (slot == NULL) {
Gilles Peskine4747d192019-04-17 15:05:45 +02001808 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01001809 }
Gilles Peskine011e4282019-06-26 18:34:38 +02001810
1811#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001812 /* TODO: If the key has already been created in the secure
Gilles Peskine011e4282019-06-26 18:34:38 +02001813 * element, and the failure happened later (when saving metadata
1814 * to internal storage), we need to destroy the key in the secure
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001815 * element.
1816 * https://github.com/ARMmbed/mbed-crypto/issues/217
1817 */
Gilles Peskinefc762652019-07-22 19:30:34 +02001818
Gilles Peskined7729582019-08-05 15:55:54 +02001819 /* Abort the ongoing transaction if any (there may not be one if
1820 * the creation process failed before starting one, or if the
1821 * key creation is a registration of a key in a secure element).
1822 * Earlier functions must already have done what it takes to undo any
1823 * partial creation. All that's left is to update the transaction data
1824 * itself. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001825 (void) psa_crypto_stop_transaction();
Gilles Peskine011e4282019-06-26 18:34:38 +02001826#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1827
Ryan Everettb69118e2024-01-02 15:54:32 +00001828 /* Prepare the key slot to be wiped, and then wipe it. */
1829 slot->registered_readers = 1;
1830 psa_key_slot_state_transition(slot, PSA_SLOT_FILLING,
1831 PSA_SLOT_PENDING_DELETION);
1832
Gilles Peskine449bd832023-01-11 14:50:10 +01001833 psa_wipe_key_slot(slot);
Gilles Peskine4747d192019-04-17 15:05:45 +02001834}
1835
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001836/** Validate optional attributes during key creation.
1837 *
1838 * Some key attributes are optional during key creation. If they are
1839 * specified in the attributes structure, check that they are consistent
1840 * with the data in the slot.
1841 *
1842 * This function should be called near the end of key creation, after
1843 * the slot in memory is fully populated but before saving persistent data.
1844 */
1845static psa_status_t psa_validate_optional_attributes(
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001846 const psa_key_slot_t *slot,
Gilles Peskine449bd832023-01-11 14:50:10 +01001847 const psa_key_attributes_t *attributes)
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001848{
Gilles Peskine449bd832023-01-11 14:50:10 +01001849 if (attributes->core.type != 0) {
1850 if (attributes->core.type != slot->attr.type) {
1851 return PSA_ERROR_INVALID_ARGUMENT;
1852 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001853 }
1854
Gilles Peskine449bd832023-01-11 14:50:10 +01001855 if (attributes->domain_parameters_size != 0) {
Valerio Settib2bcedb2023-07-10 11:24:00 +02001856#if (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) && \
1857 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01001858 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
1859 if (PSA_KEY_TYPE_IS_RSA(slot->attr.type)) {
Steven Cooremana2371e52020-07-28 14:30:39 +02001860 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman75b74362020-07-28 14:30:13 +02001861 mbedtls_mpi actual, required;
Steven Cooreman6d839f02020-07-30 11:36:45 +02001862 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooremana01795d2020-07-24 22:48:15 +02001863
Ronald Cron90857082020-11-25 14:58:33 +01001864 psa_status_t status = mbedtls_psa_rsa_load_representation(
Gilles Peskine449bd832023-01-11 14:50:10 +01001865 slot->attr.type,
1866 slot->key.data,
1867 slot->key.bytes,
1868 &rsa);
1869 if (status != PSA_SUCCESS) {
1870 return status;
1871 }
Steven Cooreman75b74362020-07-28 14:30:13 +02001872
Gilles Peskine449bd832023-01-11 14:50:10 +01001873 mbedtls_mpi_init(&actual);
1874 mbedtls_mpi_init(&required);
1875 ret = mbedtls_rsa_export(rsa,
1876 NULL, NULL, NULL, NULL, &actual);
1877 mbedtls_rsa_free(rsa);
1878 mbedtls_free(rsa);
1879 if (ret != 0) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001880 goto rsa_exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001881 }
1882 ret = mbedtls_mpi_read_binary(&required,
1883 attributes->domain_parameters,
1884 attributes->domain_parameters_size);
1885 if (ret != 0) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001886 goto rsa_exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001887 }
1888 if (mbedtls_mpi_cmp_mpi(&actual, &required) != 0) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001889 ret = MBEDTLS_ERR_RSA_BAD_INPUT_DATA;
Gilles Peskine449bd832023-01-11 14:50:10 +01001890 }
1891rsa_exit:
1892 mbedtls_mpi_free(&actual);
1893 mbedtls_mpi_free(&required);
1894 if (ret != 0) {
1895 return mbedtls_to_psa_error(ret);
1896 }
1897 } else
Valerio Settib2bcedb2023-07-10 11:24:00 +02001898#endif /* (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) &&
1899 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) ||
John Durkop9814fa22020-11-04 12:28:15 -08001900 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001901 {
Gilles Peskine449bd832023-01-11 14:50:10 +01001902 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001903 }
1904 }
1905
Gilles Peskine449bd832023-01-11 14:50:10 +01001906 if (attributes->core.bits != 0) {
1907 if (attributes->core.bits != slot->attr.bits) {
1908 return PSA_ERROR_INVALID_ARGUMENT;
1909 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001910 }
1911
Gilles Peskine449bd832023-01-11 14:50:10 +01001912 return PSA_SUCCESS;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001913}
1914
Gilles Peskine449bd832023-01-11 14:50:10 +01001915psa_status_t psa_import_key(const psa_key_attributes_t *attributes,
1916 const uint8_t *data,
1917 size_t data_length,
1918 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02001919{
1920 psa_status_t status;
1921 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001922 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001923 size_t bits;
Archanad8a83dc2021-06-14 10:04:16 +05301924 size_t storage_size = data_length;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001925
Ronald Cron81709fc2020-11-14 12:10:32 +01001926 *key = MBEDTLS_SVC_KEY_ID_INIT;
1927
Gilles Peskine0f84d622019-09-12 19:03:13 +02001928 /* Reject zero-length symmetric keys (including raw data key objects).
1929 * This also rejects any key which might be encoded as an empty string,
1930 * which is never valid. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001931 if (data_length == 0) {
1932 return PSA_ERROR_INVALID_ARGUMENT;
1933 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02001934
Archana449608b2021-09-08 15:36:05 +05301935 /* Ensure that the bytes-to-bits conversion cannot overflow. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001936 if (data_length > SIZE_MAX / 8) {
1937 return PSA_ERROR_NOT_SUPPORTED;
1938 }
Archana6ed4bda2021-08-04 10:47:15 +05301939
Gilles Peskine449bd832023-01-11 14:50:10 +01001940 status = psa_start_key_creation(PSA_KEY_CREATION_IMPORT, attributes,
1941 &slot, &driver);
1942 if (status != PSA_SUCCESS) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001943 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001944 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001945
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001946 /* In the case of a transparent key or an opaque key stored in local
Archana449608b2021-09-08 15:36:05 +05301947 * storage ( thus not in the case of importing a key in a secure element
1948 * with storage ( MBEDTLS_PSA_CRYPTO_SE_C ) ),we have to allocate a
1949 * buffer to hold the imported key material. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001950 if (slot->key.data == NULL) {
1951 if (psa_key_lifetime_is_external(attributes->core.lifetime)) {
Archana449608b2021-09-08 15:36:05 +05301952 status = psa_driver_wrapper_get_key_buffer_size_from_key_data(
Gilles Peskine449bd832023-01-11 14:50:10 +01001953 attributes, data, data_length, &storage_size);
1954 if (status != PSA_SUCCESS) {
Archanad8a83dc2021-06-14 10:04:16 +05301955 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001956 }
Archanad8a83dc2021-06-14 10:04:16 +05301957 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001958 status = psa_allocate_buffer_to_slot(slot, storage_size);
1959 if (status != PSA_SUCCESS) {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001960 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001961 }
Gilles Peskine5d309672019-07-12 23:47:28 +02001962 }
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001963
1964 bits = slot->attr.bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01001965 status = psa_driver_wrapper_import_key(attributes,
1966 data, data_length,
1967 slot->key.data,
1968 slot->key.bytes,
1969 &slot->key.bytes, &bits);
1970 if (status != PSA_SUCCESS) {
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001971 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001972 }
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001973
Gilles Peskine449bd832023-01-11 14:50:10 +01001974 if (slot->attr.bits == 0) {
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001975 slot->attr.bits = (psa_key_bits_t) bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01001976 } else if (bits != slot->attr.bits) {
Steven Cooremanac3434f2021-01-15 17:36:02 +01001977 status = PSA_ERROR_INVALID_ARGUMENT;
1978 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02001979 }
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01001980
Archana6ed4bda2021-08-04 10:47:15 +05301981 /* Enforce a size limit, and in particular ensure that the bit
1982 * size fits in its representation type.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01001983 if (bits > PSA_MAX_KEY_BITS) {
Archana6ed4bda2021-08-04 10:47:15 +05301984 status = PSA_ERROR_NOT_SUPPORTED;
1985 goto exit;
1986 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001987 status = psa_validate_optional_attributes(slot, attributes);
1988 if (status != PSA_SUCCESS) {
Gilles Peskine18017402019-07-24 20:25:59 +02001989 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001990 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001991
Gilles Peskine449bd832023-01-11 14:50:10 +01001992 status = psa_finish_key_creation(slot, driver, key);
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001993exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01001994 if (status != PSA_SUCCESS) {
1995 psa_fail_key_creation(slot, driver);
1996 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001997
Gilles Peskine449bd832023-01-11 14:50:10 +01001998 return status;
Gilles Peskine4747d192019-04-17 15:05:45 +02001999}
2000
Gilles Peskined7729582019-08-05 15:55:54 +02002001#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2002psa_status_t mbedtls_psa_register_se_key(
Gilles Peskine449bd832023-01-11 14:50:10 +01002003 const psa_key_attributes_t *attributes)
Gilles Peskined7729582019-08-05 15:55:54 +02002004{
2005 psa_status_t status;
2006 psa_key_slot_t *slot = NULL;
2007 psa_se_drv_table_entry_t *driver = NULL;
Ronald Croncf56a0a2020-08-04 09:51:30 +02002008 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskined7729582019-08-05 15:55:54 +02002009
2010 /* Leaving attributes unspecified is not currently supported.
2011 * It could make sense to query the key type and size from the
2012 * secure element, but not all secure elements support this
2013 * and the driver HAL doesn't currently support it. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002014 if (psa_get_key_type(attributes) == PSA_KEY_TYPE_NONE) {
2015 return PSA_ERROR_NOT_SUPPORTED;
2016 }
2017 if (psa_get_key_bits(attributes) == 0) {
2018 return PSA_ERROR_NOT_SUPPORTED;
2019 }
Gilles Peskined7729582019-08-05 15:55:54 +02002020
Gilles Peskine449bd832023-01-11 14:50:10 +01002021 status = psa_start_key_creation(PSA_KEY_CREATION_REGISTER, attributes,
2022 &slot, &driver);
2023 if (status != PSA_SUCCESS) {
Gilles Peskined7729582019-08-05 15:55:54 +02002024 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002025 }
Gilles Peskined7729582019-08-05 15:55:54 +02002026
Gilles Peskine449bd832023-01-11 14:50:10 +01002027 status = psa_finish_key_creation(slot, driver, &key);
Gilles Peskined7729582019-08-05 15:55:54 +02002028
2029exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002030 if (status != PSA_SUCCESS) {
2031 psa_fail_key_creation(slot, driver);
2032 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002033
Gilles Peskined7729582019-08-05 15:55:54 +02002034 /* Registration doesn't keep the key in RAM. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002035 psa_close_key(key);
2036 return status;
Gilles Peskined7729582019-08-05 15:55:54 +02002037}
2038#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2039
Gilles Peskine449bd832023-01-11 14:50:10 +01002040psa_status_t psa_copy_key(mbedtls_svc_key_id_t source_key,
2041 const psa_key_attributes_t *specified_attributes,
2042 mbedtls_svc_key_id_t *target_key)
Gilles Peskinef603c712019-01-19 13:40:11 +01002043{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002044 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01002045 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinef603c712019-01-19 13:40:11 +01002046 psa_key_slot_t *source_slot = NULL;
2047 psa_key_slot_t *target_slot = NULL;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002048 psa_key_attributes_t actual_attributes = *specified_attributes;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002049 psa_se_drv_table_entry_t *driver = NULL;
Archana8a180362021-07-05 02:18:48 +05302050 size_t storage_size = 0;
Gilles Peskinef603c712019-01-19 13:40:11 +01002051
Ronald Cron81709fc2020-11-14 12:10:32 +01002052 *target_key = MBEDTLS_SVC_KEY_ID_INIT;
2053
Archana8a180362021-07-05 02:18:48 +05302054 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002055 source_key, &source_slot, PSA_KEY_USAGE_COPY, 0);
2056 if (status != PSA_SUCCESS) {
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002057 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002058 }
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002059
Gilles Peskine449bd832023-01-11 14:50:10 +01002060 status = psa_validate_optional_attributes(source_slot,
2061 specified_attributes);
2062 if (status != PSA_SUCCESS) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002063 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002064 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002065
Archana9d17bf42021-09-10 06:22:44 +05302066 /* The target key type and number of bits have been validated by
2067 * psa_validate_optional_attributes() to be either equal to zero or
2068 * equal to the ones of the source key. So it is safe to inherit
2069 * them from the source key now."
Archana374fe5b2021-09-08 15:50:28 +05302070 * */
Archana9d17bf42021-09-10 06:22:44 +05302071 actual_attributes.core.bits = source_slot->attr.bits;
2072 actual_attributes.core.type = source_slot->attr.type;
Archana374fe5b2021-09-08 15:50:28 +05302073
2074
Gilles Peskine449bd832023-01-11 14:50:10 +01002075 status = psa_restrict_key_policy(source_slot->attr.type,
2076 &actual_attributes.core.policy,
2077 &source_slot->attr.policy);
2078 if (status != PSA_SUCCESS) {
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002079 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002080 }
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002081
Gilles Peskine449bd832023-01-11 14:50:10 +01002082 status = psa_start_key_creation(PSA_KEY_CREATION_COPY, &actual_attributes,
2083 &target_slot, &driver);
2084 if (status != PSA_SUCCESS) {
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002085 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002086 }
2087 if (PSA_KEY_LIFETIME_GET_LOCATION(target_slot->attr.lifetime) !=
2088 PSA_KEY_LIFETIME_GET_LOCATION(source_slot->attr.lifetime)) {
Archana8a180362021-07-05 02:18:48 +05302089 /*
Archana9d17bf42021-09-10 06:22:44 +05302090 * If the source and target keys are stored in different locations,
Archana8a180362021-07-05 02:18:48 +05302091 * the source key would need to be exported as plaintext and re-imported
2092 * in the other location. This has security implications which have not
Archana449608b2021-09-08 15:36:05 +05302093 * been fully mapped. For now, this can be achieved through
Archana8a180362021-07-05 02:18:48 +05302094 * appropriate API invocations from the application, if needed.
2095 * */
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002096 status = PSA_ERROR_NOT_SUPPORTED;
2097 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002098 }
Archana8a180362021-07-05 02:18:48 +05302099 /*
2100 * When the source and target keys are within the same location,
Archana449608b2021-09-08 15:36:05 +05302101 * - For transparent keys it is a blind copy without any driver invocation,
Archana8a180362021-07-05 02:18:48 +05302102 * - For opaque keys this translates to an invocation of the drivers'
2103 * copy_key entry point through the dispatch layer.
2104 * */
Gilles Peskine449bd832023-01-11 14:50:10 +01002105 if (psa_key_lifetime_is_external(actual_attributes.core.lifetime)) {
2106 status = psa_driver_wrapper_get_key_buffer_size(&actual_attributes,
2107 &storage_size);
2108 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302109 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002110 }
Archana374fe5b2021-09-08 15:50:28 +05302111
Gilles Peskine449bd832023-01-11 14:50:10 +01002112 status = psa_allocate_buffer_to_slot(target_slot, storage_size);
2113 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302114 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002115 }
Archana374fe5b2021-09-08 15:50:28 +05302116
Gilles Peskine449bd832023-01-11 14:50:10 +01002117 status = psa_driver_wrapper_copy_key(&actual_attributes,
2118 source_slot->key.data,
2119 source_slot->key.bytes,
2120 target_slot->key.data,
2121 target_slot->key.bytes,
2122 &target_slot->key.bytes);
2123 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302124 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002125 }
2126 } else {
2127 status = psa_copy_key_material_into_slot(target_slot,
Archana9d17bf42021-09-10 06:22:44 +05302128 source_slot->key.data,
Gilles Peskine449bd832023-01-11 14:50:10 +01002129 source_slot->key.bytes);
2130 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302131 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002132 }
Archana8a180362021-07-05 02:18:48 +05302133 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002134 status = psa_finish_key_creation(target_slot, driver, target_key);
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002135exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002136 if (status != PSA_SUCCESS) {
2137 psa_fail_key_creation(target_slot, driver);
2138 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002139
Gilles Peskine449bd832023-01-11 14:50:10 +01002140 unlock_status = psa_unlock_key_slot(source_slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02002141
Gilles Peskine449bd832023-01-11 14:50:10 +01002142 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskinef603c712019-01-19 13:40:11 +01002143}
2144
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02002145
2146
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01002147/****************************************************************/
Gilles Peskine20035e32018-02-03 22:44:14 +01002148/* Message digests */
2149/****************************************************************/
2150
Gilles Peskine449bd832023-01-11 14:50:10 +01002151psa_status_t psa_hash_abort(psa_hash_operation_t *operation)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002152{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002153 /* Aborting a non-active operation is allowed */
Gilles Peskine449bd832023-01-11 14:50:10 +01002154 if (operation->id == 0) {
2155 return PSA_SUCCESS;
2156 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002157
Gilles Peskine449bd832023-01-11 14:50:10 +01002158 psa_status_t status = psa_driver_wrapper_hash_abort(operation);
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002159 operation->id = 0;
2160
Gilles Peskine449bd832023-01-11 14:50:10 +01002161 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002162}
2163
Gilles Peskine449bd832023-01-11 14:50:10 +01002164psa_status_t psa_hash_setup(psa_hash_operation_t *operation,
2165 psa_algorithm_t alg)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002166{
Dave Rodgman685b6a72021-06-24 11:49:14 +01002167 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002168
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002169 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002170 if (operation->id != 0) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002171 status = PSA_ERROR_BAD_STATE;
2172 goto exit;
2173 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002174
Gilles Peskine449bd832023-01-11 14:50:10 +01002175 if (!PSA_ALG_IS_HASH(alg)) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002176 status = PSA_ERROR_INVALID_ARGUMENT;
2177 goto exit;
2178 }
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002179
Steven Cooremanb6bf4bb2021-03-15 19:00:14 +01002180 /* Ensure all of the context is zeroized, since PSA_HASH_OPERATION_INIT only
2181 * directly zeroes the int-sized dummy member of the context union. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002182 memset(&operation->ctx, 0, sizeof(operation->ctx));
Steven Cooreman893232f2021-03-15 12:23:37 +01002183
Gilles Peskine449bd832023-01-11 14:50:10 +01002184 status = psa_driver_wrapper_hash_setup(operation, alg);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002185
2186exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002187 if (status != PSA_SUCCESS) {
2188 psa_hash_abort(operation);
2189 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002190
2191 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002192}
2193
Gilles Peskine449bd832023-01-11 14:50:10 +01002194psa_status_t psa_hash_update(psa_hash_operation_t *operation,
2195 const uint8_t *input,
2196 size_t input_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002197{
Dave Rodgman685b6a72021-06-24 11:49:14 +01002198 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2199
Gilles Peskine449bd832023-01-11 14:50:10 +01002200 if (operation->id == 0) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002201 status = PSA_ERROR_BAD_STATE;
2202 goto exit;
2203 }
Gilles Peskine94e44542018-07-12 16:58:43 +02002204
Steven Cooremanc8288352021-03-04 14:02:19 +01002205 /* Don't require hash implementations to behave correctly on a
2206 * zero-length input, which may have an invalid pointer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002207 if (input_length == 0) {
2208 return PSA_SUCCESS;
2209 }
Steven Cooremanc8288352021-03-04 14:02:19 +01002210
Gilles Peskine449bd832023-01-11 14:50:10 +01002211 status = psa_driver_wrapper_hash_update(operation, input, input_length);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002212
2213exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002214 if (status != PSA_SUCCESS) {
2215 psa_hash_abort(operation);
2216 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002217
Gilles Peskine449bd832023-01-11 14:50:10 +01002218 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002219}
2220
Gilles Peskine449bd832023-01-11 14:50:10 +01002221psa_status_t psa_hash_finish(psa_hash_operation_t *operation,
2222 uint8_t *hash,
2223 size_t hash_size,
2224 size_t *hash_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002225{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002226 *hash_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002227 if (operation->id == 0) {
2228 return PSA_ERROR_BAD_STATE;
2229 }
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002230
Steven Cooreman1e582352021-02-18 17:24:37 +01002231 psa_status_t status = psa_driver_wrapper_hash_finish(
Gilles Peskine449bd832023-01-11 14:50:10 +01002232 operation, hash, hash_size, hash_length);
2233 psa_hash_abort(operation);
2234 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002235}
2236
Gilles Peskine449bd832023-01-11 14:50:10 +01002237psa_status_t psa_hash_verify(psa_hash_operation_t *operation,
2238 const uint8_t *hash,
2239 size_t hash_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002240{
Ronald Cron69a63422021-10-18 09:47:58 +02002241 uint8_t actual_hash[PSA_HASH_MAX_SIZE];
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002242 size_t actual_hash_length;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002243 psa_status_t status = psa_hash_finish(
Gilles Peskine449bd832023-01-11 14:50:10 +01002244 operation,
2245 actual_hash, sizeof(actual_hash),
2246 &actual_hash_length);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002247
Gilles Peskine449bd832023-01-11 14:50:10 +01002248 if (status != PSA_SUCCESS) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002249 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002250 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002251
Gilles Peskine449bd832023-01-11 14:50:10 +01002252 if (actual_hash_length != hash_length) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002253 status = PSA_ERROR_INVALID_SIGNATURE;
2254 goto exit;
2255 }
2256
Dave Rodgman78701152023-08-29 14:20:18 +01002257 if (mbedtls_ct_memcmp(hash, actual_hash, actual_hash_length) != 0) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002258 status = PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01002259 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002260
2261exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002262 mbedtls_platform_zeroize(actual_hash, sizeof(actual_hash));
2263 if (status != PSA_SUCCESS) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002264 psa_hash_abort(operation);
Gilles Peskine449bd832023-01-11 14:50:10 +01002265 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002266
Gilles Peskine449bd832023-01-11 14:50:10 +01002267 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002268}
2269
Gilles Peskine449bd832023-01-11 14:50:10 +01002270psa_status_t psa_hash_compute(psa_algorithm_t alg,
2271 const uint8_t *input, size_t input_length,
2272 uint8_t *hash, size_t hash_size,
2273 size_t *hash_length)
Gilles Peskine0a749c82019-11-28 19:33:58 +01002274{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002275 *hash_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002276 if (!PSA_ALG_IS_HASH(alg)) {
2277 return PSA_ERROR_INVALID_ARGUMENT;
2278 }
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002279
Gilles Peskine449bd832023-01-11 14:50:10 +01002280 return psa_driver_wrapper_hash_compute(alg, input, input_length,
2281 hash, hash_size, hash_length);
Gilles Peskine0a749c82019-11-28 19:33:58 +01002282}
2283
Gilles Peskine449bd832023-01-11 14:50:10 +01002284psa_status_t psa_hash_compare(psa_algorithm_t alg,
2285 const uint8_t *input, size_t input_length,
2286 const uint8_t *hash, size_t hash_length)
Gilles Peskine0a749c82019-11-28 19:33:58 +01002287{
Ronald Cron69a63422021-10-18 09:47:58 +02002288 uint8_t actual_hash[PSA_HASH_MAX_SIZE];
Steven Cooreman84d670d2021-02-18 16:22:53 +01002289 size_t actual_hash_length;
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002290
Gilles Peskine449bd832023-01-11 14:50:10 +01002291 if (!PSA_ALG_IS_HASH(alg)) {
2292 return PSA_ERROR_INVALID_ARGUMENT;
2293 }
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002294
Steven Cooreman1e582352021-02-18 17:24:37 +01002295 psa_status_t status = psa_driver_wrapper_hash_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01002296 alg, input, input_length,
2297 actual_hash, sizeof(actual_hash),
2298 &actual_hash_length);
2299 if (status != PSA_SUCCESS) {
Gilles Peskine60aebec2021-12-13 12:33:18 +01002300 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002301 }
2302 if (actual_hash_length != hash_length) {
Gilles Peskine60aebec2021-12-13 12:33:18 +01002303 status = PSA_ERROR_INVALID_SIGNATURE;
2304 goto exit;
2305 }
Dave Rodgman78701152023-08-29 14:20:18 +01002306 if (mbedtls_ct_memcmp(hash, actual_hash, actual_hash_length) != 0) {
Gilles Peskine60aebec2021-12-13 12:33:18 +01002307 status = PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01002308 }
Gilles Peskine60aebec2021-12-13 12:33:18 +01002309
2310exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002311 mbedtls_platform_zeroize(actual_hash, sizeof(actual_hash));
2312 return status;
Gilles Peskine0a749c82019-11-28 19:33:58 +01002313}
2314
Gilles Peskine449bd832023-01-11 14:50:10 +01002315psa_status_t psa_hash_clone(const psa_hash_operation_t *source_operation,
2316 psa_hash_operation_t *target_operation)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002317{
Gilles Peskine449bd832023-01-11 14:50:10 +01002318 if (source_operation->id == 0 ||
2319 target_operation->id != 0) {
2320 return PSA_ERROR_BAD_STATE;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002321 }
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002322
Gilles Peskine449bd832023-01-11 14:50:10 +01002323 psa_status_t status = psa_driver_wrapper_hash_clone(source_operation,
2324 target_operation);
2325 if (status != PSA_SUCCESS) {
2326 psa_hash_abort(target_operation);
2327 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002328
Gilles Peskine449bd832023-01-11 14:50:10 +01002329 return status;
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002330}
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002331
2332
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002333/****************************************************************/
Gilles Peskine8c9def32018-02-08 10:02:12 +01002334/* MAC */
2335/****************************************************************/
2336
Gilles Peskine449bd832023-01-11 14:50:10 +01002337psa_status_t psa_mac_abort(psa_mac_operation_t *operation)
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002338{
Steven Cooremane6804192021-03-19 18:28:56 +01002339 /* Aborting a non-active operation is allowed */
Gilles Peskine449bd832023-01-11 14:50:10 +01002340 if (operation->id == 0) {
2341 return PSA_SUCCESS;
2342 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002343
Gilles Peskine449bd832023-01-11 14:50:10 +01002344 psa_status_t status = psa_driver_wrapper_mac_abort(operation);
Steven Cooreman72f736a2021-05-07 14:14:37 +02002345 operation->mac_size = 0;
2346 operation->is_sign = 0;
Steven Cooremane6804192021-03-19 18:28:56 +01002347 operation->id = 0;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002348
Gilles Peskine449bd832023-01-11 14:50:10 +01002349 return status;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002350}
2351
Ronald Cron2dff3b22021-06-17 16:33:22 +02002352static psa_status_t psa_mac_finalize_alg_and_key_validation(
2353 psa_algorithm_t alg,
Ronald Cron79bdd822021-06-17 16:46:44 +02002354 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01002355 uint8_t *mac_size)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002356{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002357 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002358 psa_key_type_t key_type = psa_get_key_type(attributes);
2359 size_t key_bits = psa_get_key_bits(attributes);
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002360
Gilles Peskine449bd832023-01-11 14:50:10 +01002361 if (!PSA_ALG_IS_MAC(alg)) {
2362 return PSA_ERROR_INVALID_ARGUMENT;
2363 }
Steven Cooremane6804192021-03-19 18:28:56 +01002364
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002365 /* Validate the combination of key type and algorithm */
Gilles Peskine449bd832023-01-11 14:50:10 +01002366 status = psa_mac_key_can_do(alg, key_type);
2367 if (status != PSA_SUCCESS) {
2368 return status;
2369 }
Steven Cooreman15472f82021-03-02 16:16:22 +01002370
Steven Cooremand1a68f12021-05-10 11:13:41 +02002371 /* Get the output length for the algorithm and key combination */
Gilles Peskine449bd832023-01-11 14:50:10 +01002372 *mac_size = PSA_MAC_LENGTH(key_type, key_bits, alg);
Steven Cooreman15472f82021-03-02 16:16:22 +01002373
Gilles Peskine449bd832023-01-11 14:50:10 +01002374 if (*mac_size < 4) {
Steven Cooreman15472f82021-03-02 16:16:22 +01002375 /* A very short MAC is too short for security since it can be
2376 * brute-forced. Ancient protocols with 32-bit MACs do exist,
2377 * so we make this our minimum, even though 32 bits is still
2378 * too small for security. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002379 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman15472f82021-03-02 16:16:22 +01002380 }
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02002381
Gilles Peskine449bd832023-01-11 14:50:10 +01002382 if (*mac_size > PSA_MAC_LENGTH(key_type, key_bits,
2383 PSA_ALG_FULL_LENGTH_MAC(alg))) {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002384 /* It's impossible to "truncate" to a larger length than the full length
2385 * of the algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002386 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002387 }
2388
Gilles Peskine449bd832023-01-11 14:50:10 +01002389 if (*mac_size > PSA_MAC_MAX_SIZE) {
Gilles Peskinea9b6c802022-03-16 13:54:49 +01002390 /* PSA_MAC_LENGTH returns the correct length even for a MAC algorithm
2391 * that is disabled in the compile-time configuration. The result can
2392 * therefore be larger than PSA_MAC_MAX_SIZE, which does take the
2393 * configuration into account. In this case, force a return of
2394 * PSA_ERROR_NOT_SUPPORTED here. Otherwise psa_mac_verify(), or
2395 * psa_mac_compute(mac_size=PSA_MAC_MAX_SIZE), would return
2396 * PSA_ERROR_BUFFER_TOO_SMALL for an unsupported algorithm whose MAC size
2397 * is larger than PSA_MAC_MAX_SIZE, which is misleading and which breaks
2398 * systematically generated tests. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002399 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea9b6c802022-03-16 13:54:49 +01002400 }
2401
Gilles Peskine449bd832023-01-11 14:50:10 +01002402 return PSA_SUCCESS;
Ronald Cron2dff3b22021-06-17 16:33:22 +02002403}
2404
Gilles Peskine449bd832023-01-11 14:50:10 +01002405static psa_status_t psa_mac_setup(psa_mac_operation_t *operation,
2406 mbedtls_svc_key_id_t key,
2407 psa_algorithm_t alg,
2408 int is_sign)
Gilles Peskinee59236f2018-01-27 23:32:46 +01002409{
2410 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2411 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman54648242021-06-24 11:49:45 +01002412 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002413 psa_key_attributes_t attributes;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002414
2415 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002416 if (operation->id != 0) {
Dave Rodgman54648242021-06-24 11:49:45 +01002417 status = PSA_ERROR_BAD_STATE;
2418 goto exit;
2419 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002420
2421 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002422 key,
2423 &slot,
2424 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
2425 alg);
2426 if (status != PSA_SUCCESS) {
Dave Rodgman54648242021-06-24 11:49:45 +01002427 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002428 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002429
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002430 attributes = (psa_key_attributes_t) {
Gilles Peskine8c9def32018-02-08 10:02:12 +01002431 .core = slot->attr
2432 };
2433
Gilles Peskine449bd832023-01-11 14:50:10 +01002434 status = psa_mac_finalize_alg_and_key_validation(alg, &attributes,
2435 &operation->mac_size);
2436 if (status != PSA_SUCCESS) {
Gilles Peskine8c9def32018-02-08 10:02:12 +01002437 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002438 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002439
2440 operation->is_sign = is_sign;
Steven Cooremane6804192021-03-19 18:28:56 +01002441 /* Dispatch the MAC setup call with validated input */
Gilles Peskine449bd832023-01-11 14:50:10 +01002442 if (is_sign) {
2443 status = psa_driver_wrapper_mac_sign_setup(operation,
2444 &attributes,
2445 slot->key.data,
2446 slot->key.bytes,
2447 alg);
2448 } else {
2449 status = psa_driver_wrapper_mac_verify_setup(operation,
2450 &attributes,
2451 slot->key.data,
2452 slot->key.bytes,
2453 alg);
Gilles Peskine8c9def32018-02-08 10:02:12 +01002454 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002455
Gilles Peskinefbfac682018-07-08 20:51:54 +02002456exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002457 if (status != PSA_SUCCESS) {
2458 psa_mac_abort(operation);
2459 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002460
Gilles Peskine449bd832023-01-11 14:50:10 +01002461 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02002462
Gilles Peskine449bd832023-01-11 14:50:10 +01002463 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002464}
2465
Gilles Peskine449bd832023-01-11 14:50:10 +01002466psa_status_t psa_mac_sign_setup(psa_mac_operation_t *operation,
2467 mbedtls_svc_key_id_t key,
2468 psa_algorithm_t alg)
Gilles Peskine89167cb2018-07-08 20:12:23 +02002469{
Gilles Peskine449bd832023-01-11 14:50:10 +01002470 return psa_mac_setup(operation, key, alg, 1);
Gilles Peskine89167cb2018-07-08 20:12:23 +02002471}
2472
Gilles Peskine449bd832023-01-11 14:50:10 +01002473psa_status_t psa_mac_verify_setup(psa_mac_operation_t *operation,
2474 mbedtls_svc_key_id_t key,
2475 psa_algorithm_t alg)
Gilles Peskine89167cb2018-07-08 20:12:23 +02002476{
Gilles Peskine449bd832023-01-11 14:50:10 +01002477 return psa_mac_setup(operation, key, alg, 0);
Gilles Peskine89167cb2018-07-08 20:12:23 +02002478}
2479
Gilles Peskine449bd832023-01-11 14:50:10 +01002480psa_status_t psa_mac_update(psa_mac_operation_t *operation,
2481 const uint8_t *input,
2482 size_t input_length)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002483{
Gilles Peskine449bd832023-01-11 14:50:10 +01002484 if (operation->id == 0) {
2485 return PSA_ERROR_BAD_STATE;
2486 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002487
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002488 /* Don't require hash implementations to behave correctly on a
2489 * zero-length input, which may have an invalid pointer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002490 if (input_length == 0) {
2491 return PSA_SUCCESS;
2492 }
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03002493
Gilles Peskine449bd832023-01-11 14:50:10 +01002494 psa_status_t status = psa_driver_wrapper_mac_update(operation,
2495 input, input_length);
2496 if (status != PSA_SUCCESS) {
2497 psa_mac_abort(operation);
2498 }
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002499
Gilles Peskine449bd832023-01-11 14:50:10 +01002500 return status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002501}
2502
Gilles Peskine449bd832023-01-11 14:50:10 +01002503psa_status_t psa_mac_sign_finish(psa_mac_operation_t *operation,
2504 uint8_t *mac,
2505 size_t mac_size,
2506 size_t *mac_length)
mohammad16036df908f2018-04-02 08:34:15 -07002507{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002508 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2509 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002510
Gilles Peskine449bd832023-01-11 14:50:10 +01002511 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002512 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002513 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002514 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002515
Gilles Peskine449bd832023-01-11 14:50:10 +01002516 if (!operation->is_sign) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002517 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002518 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002519 }
Steven Cooreman72f736a2021-05-07 14:14:37 +02002520
Steven Cooreman8af5c5c2021-05-11 11:09:13 +02002521 /* Sanity check. This will guarantee that mac_size != 0 (and so mac != NULL)
2522 * once all the error checks are done. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002523 if (operation->mac_size == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002524 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002525 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002526 }
Steven Cooreman8af5c5c2021-05-11 11:09:13 +02002527
Gilles Peskine449bd832023-01-11 14:50:10 +01002528 if (mac_size < operation->mac_size) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002529 status = PSA_ERROR_BUFFER_TOO_SMALL;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002530 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002531 }
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002532
Gilles Peskine449bd832023-01-11 14:50:10 +01002533 status = psa_driver_wrapper_mac_sign_finish(operation,
2534 mac, operation->mac_size,
2535 mac_length);
Steven Cooreman72f736a2021-05-07 14:14:37 +02002536
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002537exit:
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002538 /* In case of success, set the potential excess room in the output buffer
2539 * to an invalid value, to avoid potentially leaking a longer MAC.
2540 * In case of error, set the output length and content to a safe default,
2541 * such that in case the caller misses an error check, the output would be
2542 * an unachievable MAC.
2543 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002544 if (status != PSA_SUCCESS) {
Steven Cooreman72f736a2021-05-07 14:14:37 +02002545 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002546 operation->mac_size = 0;
Steven Cooreman72f736a2021-05-07 14:14:37 +02002547 }
mohammad16036df908f2018-04-02 08:34:15 -07002548
Paul Elliottdc42ca82023-02-24 18:11:59 +00002549 psa_wipe_tag_output_buffer(mac, status, mac_size, *mac_length);
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002550
Gilles Peskine449bd832023-01-11 14:50:10 +01002551 abort_status = psa_mac_abort(operation);
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002552
Gilles Peskine449bd832023-01-11 14:50:10 +01002553 return status == PSA_SUCCESS ? abort_status : status;
mohammad16036df908f2018-04-02 08:34:15 -07002554}
2555
Gilles Peskine449bd832023-01-11 14:50:10 +01002556psa_status_t psa_mac_verify_finish(psa_mac_operation_t *operation,
2557 const uint8_t *mac,
2558 size_t mac_length)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002559{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002560 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2561 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002562
Gilles Peskine449bd832023-01-11 14:50:10 +01002563 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002564 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002565 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002566 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002567
Gilles Peskine449bd832023-01-11 14:50:10 +01002568 if (operation->is_sign) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002569 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002570 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002571 }
Steven Cooreman72f736a2021-05-07 14:14:37 +02002572
Gilles Peskine449bd832023-01-11 14:50:10 +01002573 if (operation->mac_size != mac_length) {
Steven Cooreman72f736a2021-05-07 14:14:37 +02002574 status = PSA_ERROR_INVALID_SIGNATURE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002575 goto exit;
Steven Cooreman72f736a2021-05-07 14:14:37 +02002576 }
2577
Gilles Peskine449bd832023-01-11 14:50:10 +01002578 status = psa_driver_wrapper_mac_verify_finish(operation,
2579 mac, mac_length);
Steven Cooreman72f736a2021-05-07 14:14:37 +02002580
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002581exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002582 abort_status = psa_mac_abort(operation);
mohammad16036df908f2018-04-02 08:34:15 -07002583
Gilles Peskine449bd832023-01-11 14:50:10 +01002584 return status == PSA_SUCCESS ? abort_status : status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002585}
2586
Gilles Peskine449bd832023-01-11 14:50:10 +01002587static psa_status_t psa_mac_compute_internal(mbedtls_svc_key_id_t key,
2588 psa_algorithm_t alg,
2589 const uint8_t *input,
2590 size_t input_length,
2591 uint8_t *mac,
2592 size_t mac_size,
2593 size_t *mac_length,
2594 int is_sign)
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002595{
2596 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron51131b52021-06-17 17:17:20 +02002597 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2598 psa_key_slot_t *slot;
2599 uint8_t operation_mac_size = 0;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002600 psa_key_attributes_t attributes;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002601
Ronald Cron51131b52021-06-17 17:17:20 +02002602 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002603 key,
2604 &slot,
2605 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
2606 alg);
2607 if (status != PSA_SUCCESS) {
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002608 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002609 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002610
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002611 attributes = (psa_key_attributes_t) {
Ronald Cron51131b52021-06-17 17:17:20 +02002612 .core = slot->attr
2613 };
2614
Gilles Peskine449bd832023-01-11 14:50:10 +01002615 status = psa_mac_finalize_alg_and_key_validation(alg, &attributes,
2616 &operation_mac_size);
2617 if (status != PSA_SUCCESS) {
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002618 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002619 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002620
Gilles Peskine449bd832023-01-11 14:50:10 +01002621 if (mac_size < operation_mac_size) {
Ronald Cron51131b52021-06-17 17:17:20 +02002622 status = PSA_ERROR_BUFFER_TOO_SMALL;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002623 goto exit;
Ronald Cron51131b52021-06-17 17:17:20 +02002624 }
2625
2626 status = psa_driver_wrapper_mac_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01002627 &attributes,
2628 slot->key.data, slot->key.bytes,
2629 alg,
2630 input, input_length,
2631 mac, operation_mac_size, mac_length);
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002632
2633exit:
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002634 /* In case of success, set the potential excess room in the output buffer
2635 * to an invalid value, to avoid potentially leaking a longer MAC.
2636 * In case of error, set the output length and content to a safe default,
2637 * such that in case the caller misses an error check, the output would be
2638 * an unachievable MAC.
2639 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002640 if (status != PSA_SUCCESS) {
Ronald Cron51131b52021-06-17 17:17:20 +02002641 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002642 operation_mac_size = 0;
Ronald Cron51131b52021-06-17 17:17:20 +02002643 }
Paul Elliottdc42ca82023-02-24 18:11:59 +00002644
2645 psa_wipe_tag_output_buffer(mac, status, mac_size, *mac_length);
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002646
Gilles Peskine449bd832023-01-11 14:50:10 +01002647 unlock_status = psa_unlock_key_slot(slot);
Ronald Cron51131b52021-06-17 17:17:20 +02002648
Gilles Peskine449bd832023-01-11 14:50:10 +01002649 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002650}
2651
Gilles Peskine449bd832023-01-11 14:50:10 +01002652psa_status_t psa_mac_compute(mbedtls_svc_key_id_t key,
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002653 psa_algorithm_t alg,
2654 const uint8_t *input,
2655 size_t input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002656 uint8_t *mac,
2657 size_t mac_size,
2658 size_t *mac_length)
2659{
2660 return psa_mac_compute_internal(key, alg,
2661 input, input_length,
2662 mac, mac_size, mac_length, 1);
2663}
2664
2665psa_status_t psa_mac_verify(mbedtls_svc_key_id_t key,
2666 psa_algorithm_t alg,
2667 const uint8_t *input,
2668 size_t input_length,
2669 const uint8_t *mac,
2670 size_t mac_length)
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002671{
2672 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Crona587cbc2021-06-18 14:51:29 +02002673 uint8_t actual_mac[PSA_MAC_MAX_SIZE];
2674 size_t actual_mac_length;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002675
Gilles Peskine449bd832023-01-11 14:50:10 +01002676 status = psa_mac_compute_internal(key, alg,
2677 input, input_length,
2678 actual_mac, sizeof(actual_mac),
2679 &actual_mac_length, 0);
2680 if (status != PSA_SUCCESS) {
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002681 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002682 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002683
Gilles Peskine449bd832023-01-11 14:50:10 +01002684 if (mac_length != actual_mac_length) {
Ronald Crona587cbc2021-06-18 14:51:29 +02002685 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002686 goto exit;
Ronald Crona587cbc2021-06-18 14:51:29 +02002687 }
Dave Rodgman78701152023-08-29 14:20:18 +01002688 if (mbedtls_ct_memcmp(mac, actual_mac, actual_mac_length) != 0) {
Ronald Crona587cbc2021-06-18 14:51:29 +02002689 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002690 goto exit;
Ronald Crona587cbc2021-06-18 14:51:29 +02002691 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002692
2693exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002694 mbedtls_platform_zeroize(actual_mac, sizeof(actual_mac));
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002695
Gilles Peskine449bd832023-01-11 14:50:10 +01002696 return status;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002697}
Gilles Peskinee59236f2018-01-27 23:32:46 +01002698
Gilles Peskinee59236f2018-01-27 23:32:46 +01002699/****************************************************************/
2700/* Asymmetric cryptography */
2701/****************************************************************/
2702
Gilles Peskine449bd832023-01-11 14:50:10 +01002703static psa_status_t psa_sign_verify_check_alg(int input_is_message,
2704 psa_algorithm_t alg)
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002705{
Gilles Peskine449bd832023-01-11 14:50:10 +01002706 if (input_is_message) {
2707 if (!PSA_ALG_IS_SIGN_MESSAGE(alg)) {
2708 return PSA_ERROR_INVALID_ARGUMENT;
2709 }
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002710
Gilles Peskine449bd832023-01-11 14:50:10 +01002711 if (PSA_ALG_IS_SIGN_HASH(alg)) {
2712 if (!PSA_ALG_IS_HASH(PSA_ALG_SIGN_GET_HASH(alg))) {
2713 return PSA_ERROR_INVALID_ARGUMENT;
2714 }
2715 }
2716 } else {
2717 if (!PSA_ALG_IS_SIGN_HASH(alg)) {
2718 return PSA_ERROR_INVALID_ARGUMENT;
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002719 }
2720 }
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002721
Gilles Peskine449bd832023-01-11 14:50:10 +01002722 return PSA_SUCCESS;
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002723}
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002724
Gilles Peskine449bd832023-01-11 14:50:10 +01002725static psa_status_t psa_sign_internal(mbedtls_svc_key_id_t key,
2726 int input_is_message,
2727 psa_algorithm_t alg,
2728 const uint8_t *input,
2729 size_t input_length,
2730 uint8_t *signature,
2731 size_t signature_size,
2732 size_t *signature_length)
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002733{
2734 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2735 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2736 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002737 psa_key_attributes_t attributes;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002738
2739 *signature_length = 0;
2740
Gilles Peskine449bd832023-01-11 14:50:10 +01002741 status = psa_sign_verify_check_alg(input_is_message, alg);
2742 if (status != PSA_SUCCESS) {
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002743 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002744 }
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002745
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002746 /* Immediately reject a zero-length signature buffer. This guarantees
gabor-mezei-arm12b4f342021-05-05 13:54:55 +02002747 * that signature must be a valid pointer. (On the other hand, the input
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002748 * buffer can in principle be empty since it doesn't actually have
2749 * to be a hash.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01002750 if (signature_size == 0) {
2751 return PSA_ERROR_BUFFER_TOO_SMALL;
2752 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002753
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002754 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002755 key, &slot,
2756 input_is_message ? PSA_KEY_USAGE_SIGN_MESSAGE :
2757 PSA_KEY_USAGE_SIGN_HASH,
2758 alg);
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002759
Gilles Peskine449bd832023-01-11 14:50:10 +01002760 if (status != PSA_SUCCESS) {
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002761 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002762 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002763
Gilles Peskine449bd832023-01-11 14:50:10 +01002764 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002765 status = PSA_ERROR_INVALID_ARGUMENT;
2766 goto exit;
2767 }
2768
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002769 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01002770 .core = slot->attr
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002771 };
2772
Gilles Peskine449bd832023-01-11 14:50:10 +01002773 if (input_is_message) {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002774 status = psa_driver_wrapper_sign_message(
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002775 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002776 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002777 signature, signature_size, signature_length);
2778 } else {
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002779
2780 status = psa_driver_wrapper_sign_hash(
2781 &attributes, slot->key.data, slot->key.bytes,
2782 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002783 signature, signature_size, signature_length);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002784 }
2785
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002786
2787exit:
Paul Elliott59200a22023-02-21 15:07:40 +00002788 psa_wipe_tag_output_buffer(signature, status, signature_size,
2789 *signature_length);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002790
Gilles Peskine449bd832023-01-11 14:50:10 +01002791 unlock_status = psa_unlock_key_slot(slot);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002792
Gilles Peskine449bd832023-01-11 14:50:10 +01002793 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002794}
2795
Gilles Peskine449bd832023-01-11 14:50:10 +01002796static psa_status_t psa_verify_internal(mbedtls_svc_key_id_t key,
2797 int input_is_message,
2798 psa_algorithm_t alg,
2799 const uint8_t *input,
2800 size_t input_length,
2801 const uint8_t *signature,
2802 size_t signature_length)
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002803{
2804 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2805 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2806 psa_key_slot_t *slot;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002807
Gilles Peskine449bd832023-01-11 14:50:10 +01002808 status = psa_sign_verify_check_alg(input_is_message, alg);
2809 if (status != PSA_SUCCESS) {
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002810 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002811 }
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002812
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002813 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002814 key, &slot,
2815 input_is_message ? PSA_KEY_USAGE_VERIFY_MESSAGE :
2816 PSA_KEY_USAGE_VERIFY_HASH,
2817 alg);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002818
Gilles Peskine449bd832023-01-11 14:50:10 +01002819 if (status != PSA_SUCCESS) {
2820 return status;
2821 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002822
2823 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01002824 .core = slot->attr
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002825 };
2826
Gilles Peskine449bd832023-01-11 14:50:10 +01002827 if (input_is_message) {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002828 status = psa_driver_wrapper_verify_message(
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002829 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002830 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002831 signature, signature_length);
2832 } else {
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002833 status = psa_driver_wrapper_verify_hash(
2834 &attributes, slot->key.data, slot->key.bytes,
2835 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002836 signature, signature_length);
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002837 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002838
Gilles Peskine449bd832023-01-11 14:50:10 +01002839 unlock_status = psa_unlock_key_slot(slot);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002840
Gilles Peskine449bd832023-01-11 14:50:10 +01002841 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002842
2843}
2844
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002845psa_status_t psa_sign_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002846 const psa_key_attributes_t *attributes,
2847 const uint8_t *key_buffer,
2848 size_t key_buffer_size,
2849 psa_algorithm_t alg,
2850 const uint8_t *input,
2851 size_t input_length,
2852 uint8_t *signature,
2853 size_t signature_size,
Gilles Peskine449bd832023-01-11 14:50:10 +01002854 size_t *signature_length)
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002855{
2856 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002857
Gilles Peskine449bd832023-01-11 14:50:10 +01002858 if (PSA_ALG_IS_SIGN_HASH(alg)) {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002859 size_t hash_length;
2860 uint8_t hash[PSA_HASH_MAX_SIZE];
2861
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002862 status = psa_driver_wrapper_hash_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01002863 PSA_ALG_SIGN_GET_HASH(alg),
2864 input, input_length,
2865 hash, sizeof(hash), &hash_length);
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002866
Gilles Peskine449bd832023-01-11 14:50:10 +01002867 if (status != PSA_SUCCESS) {
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002868 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002869 }
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002870
2871 return psa_driver_wrapper_sign_hash(
Gilles Peskine449bd832023-01-11 14:50:10 +01002872 attributes, key_buffer, key_buffer_size,
2873 alg, hash, hash_length,
2874 signature, signature_size, signature_length);
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002875 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002876
Gilles Peskine449bd832023-01-11 14:50:10 +01002877 return PSA_ERROR_NOT_SUPPORTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002878}
2879
Gilles Peskine449bd832023-01-11 14:50:10 +01002880psa_status_t psa_sign_message(mbedtls_svc_key_id_t key,
2881 psa_algorithm_t alg,
2882 const uint8_t *input,
2883 size_t input_length,
2884 uint8_t *signature,
2885 size_t signature_size,
2886 size_t *signature_length)
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002887{
2888 return psa_sign_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002889 key, 1, alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002890 signature, signature_size, signature_length);
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002891}
2892
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002893psa_status_t psa_verify_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002894 const psa_key_attributes_t *attributes,
2895 const uint8_t *key_buffer,
2896 size_t key_buffer_size,
2897 psa_algorithm_t alg,
2898 const uint8_t *input,
2899 size_t input_length,
2900 const uint8_t *signature,
Gilles Peskine449bd832023-01-11 14:50:10 +01002901 size_t signature_length)
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002902{
2903 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002904
Gilles Peskine449bd832023-01-11 14:50:10 +01002905 if (PSA_ALG_IS_SIGN_HASH(alg)) {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002906 size_t hash_length;
2907 uint8_t hash[PSA_HASH_MAX_SIZE];
2908
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002909 status = psa_driver_wrapper_hash_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01002910 PSA_ALG_SIGN_GET_HASH(alg),
2911 input, input_length,
2912 hash, sizeof(hash), &hash_length);
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002913
Gilles Peskine449bd832023-01-11 14:50:10 +01002914 if (status != PSA_SUCCESS) {
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002915 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002916 }
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002917
2918 return psa_driver_wrapper_verify_hash(
Gilles Peskine449bd832023-01-11 14:50:10 +01002919 attributes, key_buffer, key_buffer_size,
2920 alg, hash, hash_length,
2921 signature, signature_length);
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002922 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002923
Gilles Peskine449bd832023-01-11 14:50:10 +01002924 return PSA_ERROR_NOT_SUPPORTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002925}
2926
Gilles Peskine449bd832023-01-11 14:50:10 +01002927psa_status_t psa_verify_message(mbedtls_svc_key_id_t key,
2928 psa_algorithm_t alg,
2929 const uint8_t *input,
2930 size_t input_length,
2931 const uint8_t *signature,
2932 size_t signature_length)
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002933{
2934 return psa_verify_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002935 key, 1, alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002936 signature, signature_length);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002937}
2938
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002939psa_status_t psa_sign_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01002940 const psa_key_attributes_t *attributes,
2941 const uint8_t *key_buffer, size_t key_buffer_size,
2942 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002943 uint8_t *signature, size_t signature_size, size_t *signature_length)
Gilles Peskinee59236f2018-01-27 23:32:46 +01002944{
Gilles Peskine449bd832023-01-11 14:50:10 +01002945 if (attributes->core.type == PSA_KEY_TYPE_RSA_KEY_PAIR) {
2946 if (PSA_ALG_IS_RSA_PKCS1V15_SIGN(alg) ||
2947 PSA_ALG_IS_RSA_PSS(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01002948#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01002949 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
2950 return mbedtls_psa_rsa_sign_hash(
2951 attributes,
2952 key_buffer, key_buffer_size,
2953 alg, hash, hash_length,
2954 signature, signature_size, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01002955#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
2956 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine449bd832023-01-11 14:50:10 +01002957 } else {
2958 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanacda8342020-07-24 23:09:52 +02002959 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002960 } else if (PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
2961 if (PSA_ALG_IS_ECDSA(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01002962#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01002963 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
2964 return mbedtls_psa_ecdsa_sign_hash(
2965 attributes,
2966 key_buffer, key_buffer_size,
2967 alg, hash, hash_length,
2968 signature, signature_size, signature_length);
Gilles Peskinee59236f2018-01-27 23:32:46 +01002969#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
2970 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskine449bd832023-01-11 14:50:10 +01002971 } else {
2972 return PSA_ERROR_INVALID_ARGUMENT;
Ronald Cron4501c982021-03-19 20:09:32 +01002973 }
Ronald Cron8a494f32021-02-17 09:49:51 +01002974 }
Ronald Cron4501c982021-03-19 20:09:32 +01002975
Gilles Peskine449bd832023-01-11 14:50:10 +01002976 (void) key_buffer;
2977 (void) key_buffer_size;
2978 (void) hash;
2979 (void) hash_length;
2980 (void) signature;
2981 (void) signature_size;
2982 (void) signature_length;
Ronald Cron4501c982021-03-19 20:09:32 +01002983
Gilles Peskine449bd832023-01-11 14:50:10 +01002984 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron18659932020-12-08 16:32:23 +01002985}
Gilles Peskinee59236f2018-01-27 23:32:46 +01002986
Gilles Peskine449bd832023-01-11 14:50:10 +01002987psa_status_t psa_sign_hash(mbedtls_svc_key_id_t key,
2988 psa_algorithm_t alg,
2989 const uint8_t *hash,
2990 size_t hash_length,
2991 uint8_t *signature,
2992 size_t signature_size,
2993 size_t *signature_length)
Gilles Peskinee59236f2018-01-27 23:32:46 +01002994{
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002995 return psa_sign_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002996 key, 0, alg, hash, hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002997 signature, signature_size, signature_length);
itayzafrir5c753392018-05-08 11:18:38 +03002998}
2999
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02003000psa_status_t psa_verify_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01003001 const psa_key_attributes_t *attributes,
3002 const uint8_t *key_buffer, size_t key_buffer_size,
3003 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003004 const uint8_t *signature, size_t signature_length)
itayzafrir5c753392018-05-08 11:18:38 +03003005{
Gilles Peskine449bd832023-01-11 14:50:10 +01003006 if (PSA_KEY_TYPE_IS_RSA(attributes->core.type)) {
3007 if (PSA_ALG_IS_RSA_PKCS1V15_SIGN(alg) ||
3008 PSA_ALG_IS_RSA_PSS(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003009#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003010 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
3011 return mbedtls_psa_rsa_verify_hash(
3012 attributes,
3013 key_buffer, key_buffer_size,
3014 alg, hash, hash_length,
3015 signature, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01003016#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
3017 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003018 } else {
3019 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanacda8342020-07-24 23:09:52 +02003020 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003021 } else if (PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3022 if (PSA_ALG_IS_ECDSA(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003023#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003024 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3025 return mbedtls_psa_ecdsa_verify_hash(
3026 attributes,
3027 key_buffer, key_buffer_size,
3028 alg, hash, hash_length,
3029 signature, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01003030#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3031 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003032 } else {
3033 return PSA_ERROR_INVALID_ARGUMENT;
Ronald Cron4501c982021-03-19 20:09:32 +01003034 }
Ronald Cron8a494f32021-02-17 09:49:51 +01003035 }
Ronald Cron4501c982021-03-19 20:09:32 +01003036
Gilles Peskine449bd832023-01-11 14:50:10 +01003037 (void) key_buffer;
3038 (void) key_buffer_size;
3039 (void) hash;
3040 (void) hash_length;
3041 (void) signature;
3042 (void) signature_length;
Ronald Cron4501c982021-03-19 20:09:32 +01003043
Gilles Peskine449bd832023-01-11 14:50:10 +01003044 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron18659932020-12-08 16:32:23 +01003045}
3046
Gilles Peskine449bd832023-01-11 14:50:10 +01003047psa_status_t psa_verify_hash(mbedtls_svc_key_id_t key,
3048 psa_algorithm_t alg,
3049 const uint8_t *hash,
3050 size_t hash_length,
3051 const uint8_t *signature,
3052 size_t signature_length)
itayzafrir5c753392018-05-08 11:18:38 +03003053{
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003054 return psa_verify_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02003055 key, 0, alg, hash, hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003056 signature, signature_length);
Gilles Peskinee59236f2018-01-27 23:32:46 +01003057}
3058
Gilles Peskine449bd832023-01-11 14:50:10 +01003059psa_status_t psa_asymmetric_encrypt(mbedtls_svc_key_id_t key,
3060 psa_algorithm_t alg,
3061 const uint8_t *input,
3062 size_t input_length,
3063 const uint8_t *salt,
3064 size_t salt_length,
3065 uint8_t *output,
3066 size_t output_size,
3067 size_t *output_length)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003068{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003069 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003070 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003071 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003072 psa_key_attributes_t attributes;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003073
Darryl Green5cc689a2018-07-24 15:34:10 +01003074 (void) input;
3075 (void) input_length;
3076 (void) salt;
3077 (void) output;
3078 (void) output_size;
3079
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003080 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003081
Gilles Peskine449bd832023-01-11 14:50:10 +01003082 if (!PSA_ALG_IS_RSA_OAEP(alg) && salt_length != 0) {
3083 return PSA_ERROR_INVALID_ARGUMENT;
3084 }
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003085
Ronald Cron5c522922020-11-14 16:35:34 +01003086 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01003087 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg);
3088 if (status != PSA_SUCCESS) {
3089 return status;
3090 }
3091 if (!(PSA_KEY_TYPE_IS_PUBLIC_KEY(slot->attr.type) ||
3092 PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type))) {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003093 status = PSA_ERROR_INVALID_ARGUMENT;
3094 goto exit;
3095 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003096
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003097 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01003098 .core = slot->attr
Przemyslaw Stekiel19e61422021-12-09 11:09:11 +01003099 };
Steven Cooremana2371e52020-07-28 14:30:39 +02003100
Przemyslaw Stekiel19e61422021-12-09 11:09:11 +01003101 status = psa_driver_wrapper_asymmetric_encrypt(
3102 &attributes, slot->key.data, slot->key.bytes,
3103 alg, input, input_length, salt, salt_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003104 output, output_size, output_length);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003105exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01003106 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003107
Gilles Peskine449bd832023-01-11 14:50:10 +01003108 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003109}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003110
Gilles Peskine449bd832023-01-11 14:50:10 +01003111psa_status_t psa_asymmetric_decrypt(mbedtls_svc_key_id_t key,
3112 psa_algorithm_t alg,
3113 const uint8_t *input,
3114 size_t input_length,
3115 const uint8_t *salt,
3116 size_t salt_length,
3117 uint8_t *output,
3118 size_t output_size,
3119 size_t *output_length)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003120{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003121 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003122 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003123 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003124 psa_key_attributes_t attributes;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003125
Darryl Green5cc689a2018-07-24 15:34:10 +01003126 (void) input;
3127 (void) input_length;
3128 (void) salt;
3129 (void) output;
3130 (void) output_size;
3131
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003132 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003133
Gilles Peskine449bd832023-01-11 14:50:10 +01003134 if (!PSA_ALG_IS_RSA_OAEP(alg) && salt_length != 0) {
3135 return PSA_ERROR_INVALID_ARGUMENT;
3136 }
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003137
Ronald Cron5c522922020-11-14 16:35:34 +01003138 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01003139 key, &slot, PSA_KEY_USAGE_DECRYPT, alg);
3140 if (status != PSA_SUCCESS) {
3141 return status;
3142 }
3143 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003144 status = PSA_ERROR_INVALID_ARGUMENT;
3145 goto exit;
3146 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003147
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003148 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01003149 .core = slot->attr
Przemyslaw Stekiel8d45c002021-12-13 08:58:19 +01003150 };
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003151
Przemyslaw Stekiel8d45c002021-12-13 08:58:19 +01003152 status = psa_driver_wrapper_asymmetric_decrypt(
3153 &attributes, slot->key.data, slot->key.bytes,
3154 alg, input, input_length, salt, salt_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003155 output, output_size, output_length);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003156
3157exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01003158 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003159
Gilles Peskine449bd832023-01-11 14:50:10 +01003160 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003161}
Gilles Peskinee59236f2018-01-27 23:32:46 +01003162
Paul Elliott9fe12f62022-11-30 19:16:02 +00003163/****************************************************************/
3164/* Asymmetric interruptible cryptography */
3165/****************************************************************/
3166
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003167static uint32_t psa_interruptible_max_ops = PSA_INTERRUPTIBLE_MAX_OPS_UNLIMITED;
3168
Paul Elliott9fe12f62022-11-30 19:16:02 +00003169void psa_interruptible_set_max_ops(uint32_t max_ops)
3170{
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003171 psa_interruptible_max_ops = max_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003172}
3173
3174uint32_t psa_interruptible_get_max_ops(void)
3175{
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003176 return psa_interruptible_max_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003177}
3178
Paul Elliott9fe12f62022-11-30 19:16:02 +00003179uint32_t psa_sign_hash_get_num_ops(
3180 const psa_sign_hash_interruptible_operation_t *operation)
3181{
Paul Elliott296ede92022-12-15 17:00:30 +00003182 return operation->num_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003183}
3184
3185uint32_t psa_verify_hash_get_num_ops(
3186 const psa_verify_hash_interruptible_operation_t *operation)
3187{
Paul Elliott296ede92022-12-15 17:00:30 +00003188 return operation->num_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003189}
3190
Paul Elliott59ad9452022-12-18 15:09:02 +00003191static psa_status_t psa_sign_hash_abort_internal(
3192 psa_sign_hash_interruptible_operation_t *operation)
3193{
3194 if (operation->id == 0) {
3195 /* The object has (apparently) been initialized but it is not (yet)
3196 * in use. It's ok to call abort on such an object, and there's
3197 * nothing to do. */
3198 return PSA_SUCCESS;
3199 }
3200
3201 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3202
3203 status = psa_driver_wrapper_sign_hash_abort(operation);
3204
3205 operation->id = 0;
3206
Paul Elliotte6145dc2023-02-07 12:51:21 +00003207 /* Do not clear either the error_occurred or num_ops elements here as they
3208 * only want to be cleared by the application calling abort, not by abort
3209 * being called at completion of an operation. */
3210
Paul Elliott59ad9452022-12-18 15:09:02 +00003211 return status;
3212}
3213
Paul Elliott9fe12f62022-11-30 19:16:02 +00003214psa_status_t psa_sign_hash_start(
3215 psa_sign_hash_interruptible_operation_t *operation,
3216 mbedtls_svc_key_id_t key, psa_algorithm_t alg,
3217 const uint8_t *hash, size_t hash_length)
3218{
3219 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3220 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3221 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003222 psa_key_attributes_t attributes;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003223
Paul Elliottc9774412023-02-06 15:14:07 +00003224 /* Check that start has not been previously called, or operation has not
3225 * previously errored. */
3226 if (operation->id != 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003227 return PSA_ERROR_BAD_STATE;
3228 }
3229
Paul Elliott9fe12f62022-11-30 19:16:02 +00003230 status = psa_sign_verify_check_alg(0, alg);
3231 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003232 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003233 return status;
3234 }
3235
3236 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
3237 PSA_KEY_USAGE_SIGN_HASH,
3238 alg);
3239
3240 if (status != PSA_SUCCESS) {
3241 goto exit;
3242 }
3243
3244 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
3245 status = PSA_ERROR_INVALID_ARGUMENT;
3246 goto exit;
3247 }
3248
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003249 attributes = (psa_key_attributes_t) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003250 .core = slot->attr
3251 };
3252
Paul Elliott296ede92022-12-15 17:00:30 +00003253 /* Ensure ops count gets reset, in case of operation re-use. */
3254 operation->num_ops = 0;
3255
Paul Elliott9fe12f62022-11-30 19:16:02 +00003256 status = psa_driver_wrapper_sign_hash_start(operation, &attributes,
3257 slot->key.data,
3258 slot->key.bytes, alg,
3259 hash, hash_length);
3260exit:
3261
3262 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003263 operation->error_occurred = 1;
Paul Elliott59ad9452022-12-18 15:09:02 +00003264 psa_sign_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003265 }
3266
3267 unlock_status = psa_unlock_key_slot(slot);
3268
Paul Elliottc9774412023-02-06 15:14:07 +00003269 if (unlock_status != PSA_SUCCESS) {
3270 operation->error_occurred = 1;
3271 }
Paul Elliott9fe12f62022-11-30 19:16:02 +00003272
Paul Elliottc9774412023-02-06 15:14:07 +00003273 return (status == PSA_SUCCESS) ? unlock_status : status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003274}
3275
3276
3277psa_status_t psa_sign_hash_complete(
3278 psa_sign_hash_interruptible_operation_t *operation,
3279 uint8_t *signature, size_t signature_size,
3280 size_t *signature_length)
3281{
3282 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3283
3284 *signature_length = 0;
3285
Paul Elliottc9774412023-02-06 15:14:07 +00003286 /* Check that start has been called first, and that operation has not
3287 * previously errored. */
3288 if (operation->id == 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003289 status = PSA_ERROR_BAD_STATE;
3290 goto exit;
3291 }
3292
Paul Elliott096abc42023-02-03 18:33:23 +00003293 /* Immediately reject a zero-length signature buffer. This guarantees that
3294 * signature must be a valid pointer. */
Paul Elliott9fe12f62022-11-30 19:16:02 +00003295 if (signature_size == 0) {
3296 status = PSA_ERROR_BUFFER_TOO_SMALL;
3297 goto exit;
3298 }
3299
3300 status = psa_driver_wrapper_sign_hash_complete(operation, signature,
3301 signature_size,
3302 signature_length);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003303
Paul Elliott296ede92022-12-15 17:00:30 +00003304 /* Update ops count with work done. */
Paul Elliottde1114c2023-02-07 12:43:11 +00003305 operation->num_ops = psa_driver_wrapper_sign_hash_get_num_ops(operation);
Paul Elliott296ede92022-12-15 17:00:30 +00003306
Paul Elliottebe225c2023-02-10 14:32:53 +00003307exit:
3308
Paul Elliott59200a22023-02-21 15:07:40 +00003309 psa_wipe_tag_output_buffer(signature, status, signature_size,
3310 *signature_length);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003311
Paul Elliott53bb3122023-02-10 14:22:22 +00003312 if (status != PSA_OPERATION_INCOMPLETE) {
Paul Elliottc9774412023-02-06 15:14:07 +00003313 if (status != PSA_SUCCESS) {
3314 operation->error_occurred = 1;
3315 }
3316
Paul Elliott59ad9452022-12-18 15:09:02 +00003317 psa_sign_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003318 }
3319
3320 return status;
3321}
3322
3323psa_status_t psa_sign_hash_abort(
3324 psa_sign_hash_interruptible_operation_t *operation)
3325{
Paul Elliott59ad9452022-12-18 15:09:02 +00003326 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3327
3328 status = psa_sign_hash_abort_internal(operation);
3329
3330 /* We clear the number of ops done here, so that it is not cleared when
3331 * the operation fails or succeeds, only on manual abort. */
3332 operation->num_ops = 0;
3333
Paul Elliottc9774412023-02-06 15:14:07 +00003334 /* Likewise, failure state. */
3335 operation->error_occurred = 0;
3336
Paul Elliott59ad9452022-12-18 15:09:02 +00003337 return status;
3338}
3339
3340static psa_status_t psa_verify_hash_abort_internal(
3341 psa_verify_hash_interruptible_operation_t *operation)
3342{
Paul Elliott9fe12f62022-11-30 19:16:02 +00003343 if (operation->id == 0) {
3344 /* The object has (apparently) been initialized but it is not (yet)
3345 * in use. It's ok to call abort on such an object, and there's
3346 * nothing to do. */
3347 return PSA_SUCCESS;
3348 }
3349
Paul Elliott59ad9452022-12-18 15:09:02 +00003350 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3351
3352 status = psa_driver_wrapper_verify_hash_abort(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003353
3354 operation->id = 0;
3355
Paul Elliotte6145dc2023-02-07 12:51:21 +00003356 /* Do not clear either the error_occurred or num_ops elements here as they
3357 * only want to be cleared by the application calling abort, not by abort
3358 * being called at completion of an operation. */
3359
Paul Elliott59ad9452022-12-18 15:09:02 +00003360 return status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003361}
3362
3363psa_status_t psa_verify_hash_start(
3364 psa_verify_hash_interruptible_operation_t *operation,
3365 mbedtls_svc_key_id_t key, psa_algorithm_t alg,
3366 const uint8_t *hash, size_t hash_length,
3367 const uint8_t *signature, size_t signature_length)
3368{
3369 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3370 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3371 psa_key_slot_t *slot;
3372
Paul Elliottc9774412023-02-06 15:14:07 +00003373 /* Check that start has not been previously called, or operation has not
3374 * previously errored. */
3375 if (operation->id != 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003376 return PSA_ERROR_BAD_STATE;
3377 }
3378
3379 status = psa_sign_verify_check_alg(0, alg);
3380 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003381 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003382 return status;
3383 }
3384
3385 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
3386 PSA_KEY_USAGE_VERIFY_HASH,
3387 alg);
3388
3389 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003390 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003391 return status;
3392 }
3393
3394 psa_key_attributes_t attributes = {
3395 .core = slot->attr
3396 };
3397
Paul Elliott296ede92022-12-15 17:00:30 +00003398 /* Ensure ops count gets reset, in case of operation re-use. */
3399 operation->num_ops = 0;
3400
Paul Elliott9fe12f62022-11-30 19:16:02 +00003401 status = psa_driver_wrapper_verify_hash_start(operation, &attributes,
3402 slot->key.data,
3403 slot->key.bytes,
3404 alg, hash, hash_length,
3405 signature, signature_length);
3406
3407 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003408 operation->error_occurred = 1;
Paul Elliott59ad9452022-12-18 15:09:02 +00003409 psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003410 }
3411
3412 unlock_status = psa_unlock_key_slot(slot);
3413
Paul Elliottc9774412023-02-06 15:14:07 +00003414 if (unlock_status != PSA_SUCCESS) {
3415 operation->error_occurred = 1;
3416 }
Paul Elliott9fe12f62022-11-30 19:16:02 +00003417
Paul Elliottc9774412023-02-06 15:14:07 +00003418 return (status == PSA_SUCCESS) ? unlock_status : status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003419}
3420
3421psa_status_t psa_verify_hash_complete(
3422 psa_verify_hash_interruptible_operation_t *operation)
3423{
3424 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3425
Paul Elliottc9774412023-02-06 15:14:07 +00003426 /* Check that start has been called first, and that operation has not
3427 * previously errored. */
3428 if (operation->id == 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003429 status = PSA_ERROR_BAD_STATE;
3430 goto exit;
3431 }
3432
3433 status = psa_driver_wrapper_verify_hash_complete(operation);
3434
Paul Elliott296ede92022-12-15 17:00:30 +00003435 /* Update ops count with work done. */
Paul Elliottde1114c2023-02-07 12:43:11 +00003436 operation->num_ops = psa_driver_wrapper_verify_hash_get_num_ops(
Paul Elliott296ede92022-12-15 17:00:30 +00003437 operation);
3438
Paul Elliottebe225c2023-02-10 14:32:53 +00003439exit:
3440
Paul Elliott9fe12f62022-11-30 19:16:02 +00003441 if (status != PSA_OPERATION_INCOMPLETE) {
Paul Elliottc9774412023-02-06 15:14:07 +00003442 if (status != PSA_SUCCESS) {
3443 operation->error_occurred = 1;
3444 }
3445
Paul Elliott59ad9452022-12-18 15:09:02 +00003446 psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003447 }
3448
3449 return status;
3450}
3451
3452psa_status_t psa_verify_hash_abort(
3453 psa_verify_hash_interruptible_operation_t *operation)
3454{
Paul Elliott59ad9452022-12-18 15:09:02 +00003455 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003456
Paul Elliott59ad9452022-12-18 15:09:02 +00003457 status = psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003458
Paul Elliott59ad9452022-12-18 15:09:02 +00003459 /* We clear the number of ops done here, so that it is not cleared when
3460 * the operation fails or succeeds, only on manual abort. */
3461 operation->num_ops = 0;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003462
Paul Elliottc9774412023-02-06 15:14:07 +00003463 /* Likewise, failure state. */
3464 operation->error_occurred = 0;
3465
Paul Elliott59ad9452022-12-18 15:09:02 +00003466 return status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003467}
3468
Paul Elliott588f8ed2022-12-02 18:10:26 +00003469/****************************************************************/
3470/* Asymmetric interruptible cryptography internal */
3471/* implementations */
3472/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003473
Paul Elliott588f8ed2022-12-02 18:10:26 +00003474void mbedtls_psa_interruptible_set_max_ops(uint32_t max_ops)
3475{
Paul Elliott7cc4e812023-01-10 17:14:11 +00003476
Paul Elliott588f8ed2022-12-02 18:10:26 +00003477#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3478 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3479 defined(MBEDTLS_ECP_RESTARTABLE)
3480
3481 /* Internal implementation uses zero to indicate infinite number max ops,
3482 * therefore avoid this value, and set to minimum possible. */
3483 if (max_ops == 0) {
3484 max_ops = 1;
3485 }
3486
Paul Elliott588f8ed2022-12-02 18:10:26 +00003487 mbedtls_ecp_set_max_ops(max_ops);
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003488#else
3489 (void) max_ops;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003490#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3491 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3492 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3493}
3494
Paul Elliott588f8ed2022-12-02 18:10:26 +00003495uint32_t mbedtls_psa_sign_hash_get_num_ops(
Paul Elliottf8e5b562023-02-19 18:43:45 +00003496 const mbedtls_psa_sign_hash_interruptible_operation_t *operation)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003497{
3498#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3499 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3500 defined(MBEDTLS_ECP_RESTARTABLE)
3501
Paul Elliott93d9ca82023-02-15 18:14:21 +00003502 return operation->num_ops;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003503#else
3504 (void) operation;
3505 return 0;
3506#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3507 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3508 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3509}
3510
3511uint32_t mbedtls_psa_verify_hash_get_num_ops(
Paul Elliottf8e5b562023-02-19 18:43:45 +00003512 const mbedtls_psa_verify_hash_interruptible_operation_t *operation)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003513{
3514 #if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3515 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3516 defined(MBEDTLS_ECP_RESTARTABLE)
3517
Paul Elliott93d9ca82023-02-15 18:14:21 +00003518 return operation->num_ops;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003519#else
3520 (void) operation;
3521 return 0;
3522#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3523 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3524 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3525}
3526
3527psa_status_t mbedtls_psa_sign_hash_start(
3528 mbedtls_psa_sign_hash_interruptible_operation_t *operation,
3529 const psa_key_attributes_t *attributes, const uint8_t *key_buffer,
3530 size_t key_buffer_size, psa_algorithm_t alg,
3531 const uint8_t *hash, size_t hash_length)
3532{
3533 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott0290a762023-02-09 14:30:24 +00003534 size_t required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003535
Paul Elliott068fe072023-01-16 13:59:15 +00003536 if (!PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3537 return PSA_ERROR_NOT_SUPPORTED;
3538 }
3539
3540 if (!PSA_ALG_IS_ECDSA(alg)) {
Paul Elliott813f9cd2023-02-05 15:28:46 +00003541 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott068fe072023-01-16 13:59:15 +00003542 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003543
3544#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Paul Elliott068fe072023-01-16 13:59:15 +00003545 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3546 defined(MBEDTLS_ECP_RESTARTABLE)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003547
Paul Elliotta1c94092023-02-15 16:38:04 +00003548 mbedtls_ecdsa_restart_init(&operation->restart_ctx);
3549
Paul Elliott93d9ca82023-02-15 18:14:21 +00003550 /* Ensure num_ops is zero'ed in case of context re-use. */
3551 operation->num_ops = 0;
3552
Paul Elliott068fe072023-01-16 13:59:15 +00003553 status = mbedtls_psa_ecp_load_representation(attributes->core.type,
3554 attributes->core.bits,
3555 key_buffer,
3556 key_buffer_size,
3557 &operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003558
Paul Elliott068fe072023-01-16 13:59:15 +00003559 if (status != PSA_SUCCESS) {
3560 return status;
3561 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003562
Paul Elliott1bc59df2023-02-05 13:41:57 +00003563 operation->coordinate_bytes = PSA_BITS_TO_BYTES(
Paul Elliottc569fc22023-02-10 13:02:54 +00003564 operation->ctx->grp.nbits);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003565
Paul Elliott068fe072023-01-16 13:59:15 +00003566 psa_algorithm_t hash_alg = PSA_ALG_SIGN_GET_HASH(alg);
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02003567 operation->md_alg = mbedtls_md_type_from_psa_alg(hash_alg);
Paul Elliott068fe072023-01-16 13:59:15 +00003568 operation->alg = alg;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003569
Paul Elliott0290a762023-02-09 14:30:24 +00003570 /* We only need to store the same length of hash as the private key size
3571 * here, it would be truncated by the internal implementation anyway. */
3572 required_hash_length = (hash_length < operation->coordinate_bytes ?
3573 hash_length : operation->coordinate_bytes);
3574
Paul Elliottba70ad42023-02-15 18:23:53 +00003575 if (required_hash_length > sizeof(operation->hash)) {
3576 /* Shouldn't happen, but better safe than sorry. */
3577 return PSA_ERROR_CORRUPTION_DETECTED;
3578 }
3579
Paul Elliott0290a762023-02-09 14:30:24 +00003580 memcpy(operation->hash, hash, required_hash_length);
3581 operation->hash_length = required_hash_length;
Paul Elliott068fe072023-01-16 13:59:15 +00003582
3583 return PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003584
3585#else
Paul Elliott068fe072023-01-16 13:59:15 +00003586 (void) operation;
3587 (void) key_buffer;
3588 (void) key_buffer_size;
3589 (void) alg;
3590 (void) hash;
3591 (void) hash_length;
3592 (void) status;
Paul Elliott0290a762023-02-09 14:30:24 +00003593 (void) required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003594
Paul Elliott068fe072023-01-16 13:59:15 +00003595 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003596#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3597 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3598 * defined( MBEDTLS_ECP_RESTARTABLE ) */
Paul Elliott588f8ed2022-12-02 18:10:26 +00003599}
3600
3601psa_status_t mbedtls_psa_sign_hash_complete(
3602 mbedtls_psa_sign_hash_interruptible_operation_t *operation,
3603 uint8_t *signature, size_t signature_size,
3604 size_t *signature_length)
3605{
Paul Elliott588f8ed2022-12-02 18:10:26 +00003606#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3607 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3608 defined(MBEDTLS_ECP_RESTARTABLE)
3609
Paul Elliotta1c94092023-02-15 16:38:04 +00003610 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott1243f932023-02-07 11:21:10 +00003611 mbedtls_mpi r;
3612 mbedtls_mpi s;
3613
Paul Elliott46845252023-02-03 14:59:11 +00003614 mbedtls_mpi_init(&r);
3615 mbedtls_mpi_init(&s);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003616
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003617 /* Ensure max_ops is set to the current value (or default). */
3618 mbedtls_psa_interruptible_set_max_ops(psa_interruptible_get_max_ops());
3619
Paul Elliotta1c94092023-02-15 16:38:04 +00003620 if (signature_size < 2 * operation->coordinate_bytes) {
3621 status = PSA_ERROR_BUFFER_TOO_SMALL;
3622 goto exit;
3623 }
3624
Paul Elliott588f8ed2022-12-02 18:10:26 +00003625 if (PSA_ALG_ECDSA_IS_DETERMINISTIC(operation->alg)) {
Paul Elliott46845252023-02-03 14:59:11 +00003626
Paul Elliott588f8ed2022-12-02 18:10:26 +00003627#if defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3628 status = mbedtls_to_psa_error(
3629 mbedtls_ecdsa_sign_det_restartable(&operation->ctx->grp,
Paul Elliott46845252023-02-03 14:59:11 +00003630 &r,
3631 &s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003632 &operation->ctx->d,
3633 operation->hash,
3634 operation->hash_length,
3635 operation->md_alg,
3636 mbedtls_psa_get_random,
3637 MBEDTLS_PSA_RANDOM_STATE,
3638 &operation->restart_ctx));
3639#else /* defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Paul Elliott724bd252023-02-08 12:35:08 +00003640 status = PSA_ERROR_NOT_SUPPORTED;
3641 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003642#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
3643 } else {
Paul Elliott588f8ed2022-12-02 18:10:26 +00003644 status = mbedtls_to_psa_error(
3645 mbedtls_ecdsa_sign_restartable(&operation->ctx->grp,
Paul Elliott46845252023-02-03 14:59:11 +00003646 &r,
3647 &s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003648 &operation->ctx->d,
3649 operation->hash,
3650 operation->hash_length,
3651 mbedtls_psa_get_random,
3652 MBEDTLS_PSA_RANDOM_STATE,
3653 mbedtls_psa_get_random,
3654 MBEDTLS_PSA_RANDOM_STATE,
3655 &operation->restart_ctx));
3656 }
3657
Paul Elliottf8e5b562023-02-19 18:43:45 +00003658 /* Hide the fact that the restart context only holds a delta of number of
3659 * ops done during the last operation, not an absolute value. */
3660 operation->num_ops += operation->restart_ctx.ecp.ops_done;
3661
Paul Elliott724bd252023-02-08 12:35:08 +00003662 if (status == PSA_SUCCESS) {
Paul Elliott588f8ed2022-12-02 18:10:26 +00003663 status = mbedtls_to_psa_error(
Paul Elliott46845252023-02-03 14:59:11 +00003664 mbedtls_mpi_write_binary(&r,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003665 signature,
Paul Elliott1bc59df2023-02-05 13:41:57 +00003666 operation->coordinate_bytes)
3667 );
Paul Elliott588f8ed2022-12-02 18:10:26 +00003668
3669 if (status != PSA_SUCCESS) {
Paul Elliott724bd252023-02-08 12:35:08 +00003670 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003671 }
3672
3673 status = mbedtls_to_psa_error(
Paul Elliott46845252023-02-03 14:59:11 +00003674 mbedtls_mpi_write_binary(&s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003675 signature +
Paul Elliott1bc59df2023-02-05 13:41:57 +00003676 operation->coordinate_bytes,
3677 operation->coordinate_bytes)
3678 );
Paul Elliott588f8ed2022-12-02 18:10:26 +00003679
3680 if (status != PSA_SUCCESS) {
Paul Elliott724bd252023-02-08 12:35:08 +00003681 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003682 }
3683
Paul Elliott1bc59df2023-02-05 13:41:57 +00003684 *signature_length = operation->coordinate_bytes * 2;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003685
Paul Elliott724bd252023-02-08 12:35:08 +00003686 status = PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003687 }
Paul Elliott724bd252023-02-08 12:35:08 +00003688
3689exit:
3690
3691 mbedtls_mpi_free(&r);
3692 mbedtls_mpi_free(&s);
3693 return status;
3694
Paul Elliott588f8ed2022-12-02 18:10:26 +00003695 #else
3696
3697 (void) operation;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003698 (void) signature;
3699 (void) signature_size;
3700 (void) signature_length;
3701
3702 return PSA_ERROR_NOT_SUPPORTED;
3703
3704#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3705 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3706 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3707}
3708
3709psa_status_t mbedtls_psa_sign_hash_abort(
3710 mbedtls_psa_sign_hash_interruptible_operation_t *operation)
3711{
3712
3713#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3714 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3715 defined(MBEDTLS_ECP_RESTARTABLE)
3716
3717 if (operation->ctx) {
3718 mbedtls_ecdsa_free(operation->ctx);
3719 mbedtls_free(operation->ctx);
Paul Elliottf9c91a72023-02-05 18:06:38 +00003720 operation->ctx = NULL;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003721 }
3722
3723 mbedtls_ecdsa_restart_free(&operation->restart_ctx);
3724
Paul Elliott93d9ca82023-02-15 18:14:21 +00003725 operation->num_ops = 0;
3726
Paul Elliott588f8ed2022-12-02 18:10:26 +00003727 return PSA_SUCCESS;
3728
3729#else
3730
3731 (void) operation;
3732
3733 return PSA_ERROR_NOT_SUPPORTED;
3734
3735#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3736 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3737 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3738}
3739
3740psa_status_t mbedtls_psa_verify_hash_start(
3741 mbedtls_psa_verify_hash_interruptible_operation_t *operation,
3742 const psa_key_attributes_t *attributes,
3743 const uint8_t *key_buffer, size_t key_buffer_size,
3744 psa_algorithm_t alg,
3745 const uint8_t *hash, size_t hash_length,
3746 const uint8_t *signature, size_t signature_length)
3747{
3748 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott1bc59df2023-02-05 13:41:57 +00003749 size_t coordinate_bytes = 0;
Paul Elliott0290a762023-02-09 14:30:24 +00003750 size_t required_hash_length = 0;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003751
Paul Elliott068fe072023-01-16 13:59:15 +00003752 if (!PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3753 return PSA_ERROR_NOT_SUPPORTED;
3754 }
3755
3756 if (!PSA_ALG_IS_ECDSA(alg)) {
Paul Elliott813f9cd2023-02-05 15:28:46 +00003757 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott068fe072023-01-16 13:59:15 +00003758 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003759
3760#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Paul Elliott068fe072023-01-16 13:59:15 +00003761 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3762 defined(MBEDTLS_ECP_RESTARTABLE)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003763
Paul Elliotta1c94092023-02-15 16:38:04 +00003764 mbedtls_ecdsa_restart_init(&operation->restart_ctx);
3765 mbedtls_mpi_init(&operation->r);
3766 mbedtls_mpi_init(&operation->s);
3767
Paul Elliott93d9ca82023-02-15 18:14:21 +00003768 /* Ensure num_ops is zero'ed in case of context re-use. */
3769 operation->num_ops = 0;
3770
Paul Elliott068fe072023-01-16 13:59:15 +00003771 status = mbedtls_psa_ecp_load_representation(attributes->core.type,
3772 attributes->core.bits,
3773 key_buffer,
3774 key_buffer_size,
3775 &operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003776
Paul Elliott068fe072023-01-16 13:59:15 +00003777 if (status != PSA_SUCCESS) {
3778 return status;
3779 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003780
Paul Elliottc569fc22023-02-10 13:02:54 +00003781 coordinate_bytes = PSA_BITS_TO_BYTES(operation->ctx->grp.nbits);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003782
Paul Elliott1bc59df2023-02-05 13:41:57 +00003783 if (signature_length != 2 * coordinate_bytes) {
Paul Elliott068fe072023-01-16 13:59:15 +00003784 return PSA_ERROR_INVALID_SIGNATURE;
3785 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003786
Paul Elliott068fe072023-01-16 13:59:15 +00003787 status = mbedtls_to_psa_error(
3788 mbedtls_mpi_read_binary(&operation->r,
3789 signature,
Paul Elliott1bc59df2023-02-05 13:41:57 +00003790 coordinate_bytes));
Paul Elliott588f8ed2022-12-02 18:10:26 +00003791
Paul Elliott068fe072023-01-16 13:59:15 +00003792 if (status != PSA_SUCCESS) {
3793 return status;
3794 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003795
Paul Elliott068fe072023-01-16 13:59:15 +00003796 status = mbedtls_to_psa_error(
3797 mbedtls_mpi_read_binary(&operation->s,
3798 signature +
Paul Elliott1bc59df2023-02-05 13:41:57 +00003799 coordinate_bytes,
3800 coordinate_bytes));
Paul Elliott588f8ed2022-12-02 18:10:26 +00003801
Paul Elliott068fe072023-01-16 13:59:15 +00003802 if (status != PSA_SUCCESS) {
3803 return status;
3804 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003805
Paul Elliott2c9843f2023-02-15 17:32:42 +00003806 status = mbedtls_psa_ecp_load_public_part(operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003807
Paul Elliott2c9843f2023-02-15 17:32:42 +00003808 if (status != PSA_SUCCESS) {
3809 return status;
Paul Elliott068fe072023-01-16 13:59:15 +00003810 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003811
Paul Elliott0290a762023-02-09 14:30:24 +00003812 /* We only need to store the same length of hash as the private key size
3813 * here, it would be truncated by the internal implementation anyway. */
3814 required_hash_length = (hash_length < coordinate_bytes ? hash_length :
3815 coordinate_bytes);
3816
Paul Elliottba70ad42023-02-15 18:23:53 +00003817 if (required_hash_length > sizeof(operation->hash)) {
3818 /* Shouldn't happen, but better safe than sorry. */
3819 return PSA_ERROR_CORRUPTION_DETECTED;
3820 }
3821
Paul Elliott0290a762023-02-09 14:30:24 +00003822 memcpy(operation->hash, hash, required_hash_length);
3823 operation->hash_length = required_hash_length;
Paul Elliott068fe072023-01-16 13:59:15 +00003824
3825 return PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003826#else
Paul Elliott068fe072023-01-16 13:59:15 +00003827 (void) operation;
3828 (void) key_buffer;
3829 (void) key_buffer_size;
3830 (void) alg;
3831 (void) hash;
3832 (void) hash_length;
3833 (void) signature;
3834 (void) signature_length;
3835 (void) status;
Paul Elliott1243f932023-02-07 11:21:10 +00003836 (void) coordinate_bytes;
Paul Elliott0290a762023-02-09 14:30:24 +00003837 (void) required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003838
Paul Elliott068fe072023-01-16 13:59:15 +00003839 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003840#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3841 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3842 * defined( MBEDTLS_ECP_RESTARTABLE ) */
Paul Elliott588f8ed2022-12-02 18:10:26 +00003843}
3844
3845psa_status_t mbedtls_psa_verify_hash_complete(
3846 mbedtls_psa_verify_hash_interruptible_operation_t *operation)
3847{
3848
3849#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3850 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3851 defined(MBEDTLS_ECP_RESTARTABLE)
3852
Paul Elliottf8e5b562023-02-19 18:43:45 +00003853 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3854
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003855 /* Ensure max_ops is set to the current value (or default). */
3856 mbedtls_psa_interruptible_set_max_ops(psa_interruptible_get_max_ops());
3857
Paul Elliottf8e5b562023-02-19 18:43:45 +00003858 status = mbedtls_to_psa_error(
Paul Elliott588f8ed2022-12-02 18:10:26 +00003859 mbedtls_ecdsa_verify_restartable(&operation->ctx->grp,
3860 operation->hash,
3861 operation->hash_length,
3862 &operation->ctx->Q,
3863 &operation->r,
3864 &operation->s,
3865 &operation->restart_ctx));
3866
Paul Elliottf8e5b562023-02-19 18:43:45 +00003867 /* Hide the fact that the restart context only holds a delta of number of
3868 * ops done during the last operation, not an absolute value. */
3869 operation->num_ops += operation->restart_ctx.ecp.ops_done;
3870
3871 return status;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003872#else
3873 (void) operation;
3874
3875 return PSA_ERROR_NOT_SUPPORTED;
3876
3877#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3878 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3879 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3880}
3881
3882psa_status_t mbedtls_psa_verify_hash_abort(
3883 mbedtls_psa_verify_hash_interruptible_operation_t *operation)
3884{
3885
3886#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3887 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3888 defined(MBEDTLS_ECP_RESTARTABLE)
3889
3890 if (operation->ctx) {
3891 mbedtls_ecdsa_free(operation->ctx);
3892 mbedtls_free(operation->ctx);
Paul Elliottf9c91a72023-02-05 18:06:38 +00003893 operation->ctx = NULL;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003894 }
3895
3896 mbedtls_ecdsa_restart_free(&operation->restart_ctx);
3897
Paul Elliott93d9ca82023-02-15 18:14:21 +00003898 operation->num_ops = 0;
3899
Paul Elliott588f8ed2022-12-02 18:10:26 +00003900 mbedtls_mpi_free(&operation->r);
3901 mbedtls_mpi_free(&operation->s);
3902
3903 return PSA_SUCCESS;
3904
3905#else
3906 (void) operation;
3907
3908 return PSA_ERROR_NOT_SUPPORTED;
3909
3910#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3911 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3912 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3913}
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003914
mohammad1603503973b2018-03-12 15:59:30 +02003915/****************************************************************/
3916/* Symmetric cryptography */
3917/****************************************************************/
3918
Gilles Peskine449bd832023-01-11 14:50:10 +01003919static psa_status_t psa_cipher_setup(psa_cipher_operation_t *operation,
3920 mbedtls_svc_key_id_t key,
3921 psa_algorithm_t alg,
3922 mbedtls_operation_t cipher_operation)
Ronald Cronab99ac22020-10-01 16:38:28 +02003923{
3924 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3925 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman54648242021-06-24 11:49:45 +01003926 psa_key_slot_t *slot = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01003927 psa_key_usage_t usage = (cipher_operation == MBEDTLS_ENCRYPT ?
3928 PSA_KEY_USAGE_ENCRYPT :
3929 PSA_KEY_USAGE_DECRYPT);
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003930 psa_key_attributes_t attributes;
Ronald Cronab99ac22020-10-01 16:38:28 +02003931
3932 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003933 if (operation->id != 0) {
Dave Rodgman54648242021-06-24 11:49:45 +01003934 status = PSA_ERROR_BAD_STATE;
3935 goto exit;
3936 }
Ronald Cronab99ac22020-10-01 16:38:28 +02003937
Gilles Peskine449bd832023-01-11 14:50:10 +01003938 if (!PSA_ALG_IS_CIPHER(alg)) {
Dave Rodgman54648242021-06-24 11:49:45 +01003939 status = PSA_ERROR_INVALID_ARGUMENT;
3940 goto exit;
3941 }
Ronald Cronab99ac22020-10-01 16:38:28 +02003942
Gilles Peskine449bd832023-01-11 14:50:10 +01003943 status = psa_get_and_lock_key_slot_with_policy(key, &slot, usage, alg);
3944 if (status != PSA_SUCCESS) {
Ronald Cronab99ac22020-10-01 16:38:28 +02003945 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01003946 }
Ronald Cronab99ac22020-10-01 16:38:28 +02003947
Ronald Cron49fafa92021-03-10 08:34:23 +01003948 /* Initialize the operation struct members, except for id. The id member
Ronald Cronab99ac22020-10-01 16:38:28 +02003949 * is used to indicate to psa_cipher_abort that there are resources to free,
Ronald Cron49fafa92021-03-10 08:34:23 +01003950 * so we only set it (in the driver wrapper) after resources have been
3951 * allocated/initialized. */
Ronald Cronab99ac22020-10-01 16:38:28 +02003952 operation->iv_set = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01003953 if (alg == PSA_ALG_ECB_NO_PADDING) {
Ronald Cronab99ac22020-10-01 16:38:28 +02003954 operation->iv_required = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01003955 } else {
Ronald Cronab99ac22020-10-01 16:38:28 +02003956 operation->iv_required = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003957 }
3958 operation->default_iv_length = PSA_CIPHER_IV_LENGTH(slot->attr.type, alg);
Ronald Cronab99ac22020-10-01 16:38:28 +02003959
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003960 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01003961 .core = slot->attr
Ronald Crona4af55f2020-12-14 14:36:06 +01003962 };
3963
Ronald Cronab99ac22020-10-01 16:38:28 +02003964 /* Try doing the operation through a driver before using software fallback. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003965 if (cipher_operation == MBEDTLS_ENCRYPT) {
3966 status = psa_driver_wrapper_cipher_encrypt_setup(operation,
3967 &attributes,
3968 slot->key.data,
3969 slot->key.bytes,
3970 alg);
3971 } else {
3972 status = psa_driver_wrapper_cipher_decrypt_setup(operation,
3973 &attributes,
3974 slot->key.data,
3975 slot->key.bytes,
3976 alg);
3977 }
Ronald Cronab99ac22020-10-01 16:38:28 +02003978
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003979exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01003980 if (status != PSA_SUCCESS) {
3981 psa_cipher_abort(operation);
3982 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003983
Gilles Peskine449bd832023-01-11 14:50:10 +01003984 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003985
Gilles Peskine449bd832023-01-11 14:50:10 +01003986 return (status == PSA_SUCCESS) ? unlock_status : status;
mohammad1603503973b2018-03-12 15:59:30 +02003987}
3988
Gilles Peskine449bd832023-01-11 14:50:10 +01003989psa_status_t psa_cipher_encrypt_setup(psa_cipher_operation_t *operation,
3990 mbedtls_svc_key_id_t key,
3991 psa_algorithm_t alg)
mohammad16038481e742018-03-18 13:57:31 +02003992{
Gilles Peskine449bd832023-01-11 14:50:10 +01003993 return psa_cipher_setup(operation, key, alg, MBEDTLS_ENCRYPT);
mohammad16038481e742018-03-18 13:57:31 +02003994}
3995
Gilles Peskine449bd832023-01-11 14:50:10 +01003996psa_status_t psa_cipher_decrypt_setup(psa_cipher_operation_t *operation,
3997 mbedtls_svc_key_id_t key,
3998 psa_algorithm_t alg)
mohammad16038481e742018-03-18 13:57:31 +02003999{
Gilles Peskine449bd832023-01-11 14:50:10 +01004000 return psa_cipher_setup(operation, key, alg, MBEDTLS_DECRYPT);
mohammad16038481e742018-03-18 13:57:31 +02004001}
4002
Gilles Peskine449bd832023-01-11 14:50:10 +01004003psa_status_t psa_cipher_generate_iv(psa_cipher_operation_t *operation,
4004 uint8_t *iv,
4005 size_t iv_size,
4006 size_t *iv_length)
mohammad1603503973b2018-03-12 15:59:30 +02004007{
Ronald Cron6d051732020-10-01 14:10:20 +02004008 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2fb90522021-07-05 12:31:44 +02004009 uint8_t local_iv[PSA_CIPHER_IV_MAX_SIZE];
Sergeybef1f632023-03-06 15:25:06 -07004010 size_t default_iv_length = 0;
Ronald Cron5618a392021-03-26 09:52:26 +01004011
Gilles Peskine449bd832023-01-11 14:50:10 +01004012 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004013 status = PSA_ERROR_BAD_STATE;
4014 goto exit;
Ronald Cronc45b4af2020-09-29 16:18:05 +02004015 }
4016
Gilles Peskine449bd832023-01-11 14:50:10 +01004017 if (operation->iv_set || !operation->iv_required) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004018 status = PSA_ERROR_BAD_STATE;
4019 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004020 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004021
Ronald Cron2fb90522021-07-05 12:31:44 +02004022 default_iv_length = operation->default_iv_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01004023 if (iv_size < default_iv_length) {
Ronald Cron5618a392021-03-26 09:52:26 +01004024 status = PSA_ERROR_BUFFER_TOO_SMALL;
4025 goto exit;
4026 }
Gilles Peskinee553c652018-06-04 16:22:46 +02004027
Gilles Peskine449bd832023-01-11 14:50:10 +01004028 if (default_iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Ronald Cron2fb90522021-07-05 12:31:44 +02004029 status = PSA_ERROR_GENERIC_ERROR;
4030 goto exit;
4031 }
4032
Gilles Peskine449bd832023-01-11 14:50:10 +01004033 status = psa_generate_random(local_iv, default_iv_length);
4034 if (status != PSA_SUCCESS) {
Ronald Cron5618a392021-03-26 09:52:26 +01004035 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004036 }
Ronald Cron5618a392021-03-26 09:52:26 +01004037
Gilles Peskine449bd832023-01-11 14:50:10 +01004038 status = psa_driver_wrapper_cipher_set_iv(operation,
4039 local_iv, default_iv_length);
Ronald Cron5618a392021-03-26 09:52:26 +01004040
4041exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004042 if (status == PSA_SUCCESS) {
4043 memcpy(iv, local_iv, default_iv_length);
Ronald Cron2fb90522021-07-05 12:31:44 +02004044 *iv_length = default_iv_length;
Steven Cooreman7df02922020-09-09 15:28:49 +02004045 operation->iv_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004046 } else {
Ronald Cron2fb90522021-07-05 12:31:44 +02004047 *iv_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004048 psa_cipher_abort(operation);
Ronald Cron2fb90522021-07-05 12:31:44 +02004049 }
Ronald Cron6d051732020-10-01 14:10:20 +02004050
Gilles Peskine449bd832023-01-11 14:50:10 +01004051 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004052}
4053
Gilles Peskine449bd832023-01-11 14:50:10 +01004054psa_status_t psa_cipher_set_iv(psa_cipher_operation_t *operation,
4055 const uint8_t *iv,
4056 size_t iv_length)
mohammad1603503973b2018-03-12 15:59:30 +02004057{
Ronald Cron6d051732020-10-01 14:10:20 +02004058 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronc45b4af2020-09-29 16:18:05 +02004059
Gilles Peskine449bd832023-01-11 14:50:10 +01004060 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004061 status = PSA_ERROR_BAD_STATE;
4062 goto exit;
4063 }
Ronald Cronc45b4af2020-09-29 16:18:05 +02004064
Gilles Peskine449bd832023-01-11 14:50:10 +01004065 if (operation->iv_set || !operation->iv_required) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004066 status = PSA_ERROR_BAD_STATE;
4067 goto exit;
4068 }
Ronald Crona0d68172021-03-26 10:15:08 +01004069
Gilles Peskine449bd832023-01-11 14:50:10 +01004070 if (iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004071 status = PSA_ERROR_INVALID_ARGUMENT;
4072 goto exit;
4073 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004074
Gilles Peskine449bd832023-01-11 14:50:10 +01004075 status = psa_driver_wrapper_cipher_set_iv(operation,
4076 iv,
4077 iv_length);
Steven Cooremand3feccd2020-09-01 15:56:14 +02004078
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004079exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004080 if (status == PSA_SUCCESS) {
itayzafrir534bd7c2018-08-02 13:56:32 +03004081 operation->iv_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004082 } else {
4083 psa_cipher_abort(operation);
4084 }
4085 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004086}
4087
Gilles Peskine449bd832023-01-11 14:50:10 +01004088psa_status_t psa_cipher_update(psa_cipher_operation_t *operation,
4089 const uint8_t *input,
4090 size_t input_length,
4091 uint8_t *output,
4092 size_t output_size,
4093 size_t *output_length)
mohammad1603503973b2018-03-12 15:59:30 +02004094{
Steven Cooremanffecb7b2020-08-25 15:13:13 +02004095 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron6d051732020-10-01 14:10:20 +02004096
Gilles Peskine449bd832023-01-11 14:50:10 +01004097 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004098 status = PSA_ERROR_BAD_STATE;
4099 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004100 }
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004101
Gilles Peskine449bd832023-01-11 14:50:10 +01004102 if (operation->iv_required && !operation->iv_set) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004103 status = PSA_ERROR_BAD_STATE;
4104 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004105 }
Jaeden Ameroab439972019-02-15 14:12:05 +00004106
Gilles Peskine449bd832023-01-11 14:50:10 +01004107 status = psa_driver_wrapper_cipher_update(operation,
4108 input,
4109 input_length,
4110 output,
4111 output_size,
4112 output_length);
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004113
4114exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004115 if (status != PSA_SUCCESS) {
4116 psa_cipher_abort(operation);
4117 }
Ronald Cron6d051732020-10-01 14:10:20 +02004118
Gilles Peskine449bd832023-01-11 14:50:10 +01004119 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004120}
4121
Gilles Peskine449bd832023-01-11 14:50:10 +01004122psa_status_t psa_cipher_finish(psa_cipher_operation_t *operation,
4123 uint8_t *output,
4124 size_t output_size,
4125 size_t *output_length)
mohammad1603503973b2018-03-12 15:59:30 +02004126{
David Saadab4ecc272019-02-14 13:48:10 +02004127 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Ronald Cron6d051732020-10-01 14:10:20 +02004128
Gilles Peskine449bd832023-01-11 14:50:10 +01004129 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004130 status = PSA_ERROR_BAD_STATE;
4131 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004132 }
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004133
Gilles Peskine449bd832023-01-11 14:50:10 +01004134 if (operation->iv_required && !operation->iv_set) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004135 status = PSA_ERROR_BAD_STATE;
4136 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004137 }
Moran Pekerbed71a22018-04-22 20:19:20 +03004138
Gilles Peskine449bd832023-01-11 14:50:10 +01004139 status = psa_driver_wrapper_cipher_finish(operation,
4140 output,
4141 output_size,
4142 output_length);
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004143
4144exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004145 if (status == PSA_SUCCESS) {
4146 return psa_cipher_abort(operation);
4147 } else {
Steven Cooremanef8575e2020-09-11 11:44:50 +02004148 *output_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004149 (void) psa_cipher_abort(operation);
Janos Follath315b51c2018-07-09 16:04:51 +01004150
Gilles Peskine449bd832023-01-11 14:50:10 +01004151 return status;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004152 }
mohammad1603503973b2018-03-12 15:59:30 +02004153}
4154
Gilles Peskine449bd832023-01-11 14:50:10 +01004155psa_status_t psa_cipher_abort(psa_cipher_operation_t *operation)
Gilles Peskinee553c652018-06-04 16:22:46 +02004156{
Gilles Peskine449bd832023-01-11 14:50:10 +01004157 if (operation->id == 0) {
Steven Cooremana07b9972020-09-10 14:54:14 +02004158 /* The object has (apparently) been initialized but it is not (yet)
Gilles Peskine81736312018-06-26 15:04:31 +02004159 * in use. It's ok to call abort on such an object, and there's
4160 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004161 return PSA_SUCCESS;
Gilles Peskine81736312018-06-26 15:04:31 +02004162 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004163
Gilles Peskine449bd832023-01-11 14:50:10 +01004164 psa_driver_wrapper_cipher_abort(operation);
Gilles Peskinee553c652018-06-04 16:22:46 +02004165
Ronald Cron49fafa92021-03-10 08:34:23 +01004166 operation->id = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004167 operation->iv_set = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004168 operation->iv_required = 0;
Moran Peker41deec42018-04-04 15:43:05 +03004169
Gilles Peskine449bd832023-01-11 14:50:10 +01004170 return PSA_SUCCESS;
mohammad1603503973b2018-03-12 15:59:30 +02004171}
4172
Gilles Peskine449bd832023-01-11 14:50:10 +01004173psa_status_t psa_cipher_encrypt(mbedtls_svc_key_id_t key,
4174 psa_algorithm_t alg,
4175 const uint8_t *input,
4176 size_t input_length,
4177 uint8_t *output,
4178 size_t output_size,
4179 size_t *output_length)
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004180{
4181 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004182 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron23919522021-07-08 19:00:07 +02004183 psa_key_slot_t *slot = NULL;
Ronald Cronc6e6f502021-07-09 18:44:58 +02004184 uint8_t local_iv[PSA_CIPHER_IV_MAX_SIZE];
4185 size_t default_iv_length = 0;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004186 psa_key_attributes_t attributes;
gabor-mezei-arm6f4e5bb2021-06-25 15:21:11 +02004187
Gilles Peskine449bd832023-01-11 14:50:10 +01004188 if (!PSA_ALG_IS_CIPHER(alg)) {
Ronald Cron23919522021-07-08 19:00:07 +02004189 status = PSA_ERROR_INVALID_ARGUMENT;
4190 goto exit;
4191 }
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004192
Gilles Peskine449bd832023-01-11 14:50:10 +01004193 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
4194 PSA_KEY_USAGE_ENCRYPT,
4195 alg);
4196 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004197 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004198 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004199
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004200 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004201 .core = slot->attr
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004202 };
4203
Gilles Peskine449bd832023-01-11 14:50:10 +01004204 default_iv_length = PSA_CIPHER_IV_LENGTH(slot->attr.type, alg);
4205 if (default_iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Ronald Cronc6e6f502021-07-09 18:44:58 +02004206 status = PSA_ERROR_GENERIC_ERROR;
4207 goto exit;
4208 }
4209
Gilles Peskine449bd832023-01-11 14:50:10 +01004210 if (default_iv_length > 0) {
4211 if (output_size < default_iv_length) {
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004212 status = PSA_ERROR_BUFFER_TOO_SMALL;
4213 goto exit;
4214 }
4215
Gilles Peskine449bd832023-01-11 14:50:10 +01004216 status = psa_generate_random(local_iv, default_iv_length);
4217 if (status != PSA_SUCCESS) {
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004218 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004219 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004220 }
4221
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004222 status = psa_driver_wrapper_cipher_encrypt(
4223 &attributes, slot->key.data, slot->key.bytes,
Ronald Cronc6e6f502021-07-09 18:44:58 +02004224 alg, local_iv, default_iv_length, input, input_length,
Ronald Cronafbc7ed2023-01-24 16:02:04 +01004225 psa_crypto_buffer_offset(output, default_iv_length),
Gilles Peskine449bd832023-01-11 14:50:10 +01004226 output_size - default_iv_length, output_length);
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004227
4228exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004229 unlock_status = psa_unlock_key_slot(slot);
4230 if (status == PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004231 status = unlock_status;
Ronald Cronc6e6f502021-07-09 18:44:58 +02004232 }
Ronald Cron23919522021-07-08 19:00:07 +02004233
Gilles Peskine449bd832023-01-11 14:50:10 +01004234 if (status == PSA_SUCCESS) {
4235 if (default_iv_length > 0) {
4236 memcpy(output, local_iv, default_iv_length);
4237 }
4238 *output_length += default_iv_length;
4239 } else {
4240 *output_length = 0;
4241 }
4242
4243 return status;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004244}
4245
Gilles Peskine449bd832023-01-11 14:50:10 +01004246psa_status_t psa_cipher_decrypt(mbedtls_svc_key_id_t key,
4247 psa_algorithm_t alg,
4248 const uint8_t *input,
4249 size_t input_length,
4250 uint8_t *output,
4251 size_t output_size,
4252 size_t *output_length)
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004253{
4254 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004255 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron23919522021-07-08 19:00:07 +02004256 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004257 psa_key_attributes_t attributes;
gabor-mezei-arm6f4e5bb2021-06-25 15:21:11 +02004258
Gilles Peskine449bd832023-01-11 14:50:10 +01004259 if (!PSA_ALG_IS_CIPHER(alg)) {
Ronald Cron23919522021-07-08 19:00:07 +02004260 status = PSA_ERROR_INVALID_ARGUMENT;
4261 goto exit;
4262 }
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004263
Gilles Peskine449bd832023-01-11 14:50:10 +01004264 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
4265 PSA_KEY_USAGE_DECRYPT,
4266 alg);
4267 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004268 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004269 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004270
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004271 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004272 .core = slot->attr
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004273 };
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004274
Gilles Peskine449bd832023-01-11 14:50:10 +01004275 if (alg == PSA_ALG_CCM_STAR_NO_TAG &&
4276 input_length < PSA_BLOCK_CIPHER_BLOCK_LENGTH(slot->attr.type)) {
Mateusz Starzyk594215b2021-10-14 12:23:06 +02004277 status = PSA_ERROR_INVALID_ARGUMENT;
4278 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004279 } else if (input_length < PSA_CIPHER_IV_LENGTH(slot->attr.type, alg)) {
gabor-mezei-arm258ae072021-06-25 15:25:38 +02004280 status = PSA_ERROR_INVALID_ARGUMENT;
4281 goto exit;
4282 }
4283
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004284 status = psa_driver_wrapper_cipher_decrypt(
4285 &attributes, slot->key.data, slot->key.bytes,
4286 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004287 output, output_size, output_length);
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004288
gabor-mezei-arm258ae072021-06-25 15:25:38 +02004289exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004290 unlock_status = psa_unlock_key_slot(slot);
4291 if (status == PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004292 status = unlock_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01004293 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004294
Gilles Peskine449bd832023-01-11 14:50:10 +01004295 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004296 *output_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004297 }
Ronald Cron23919522021-07-08 19:00:07 +02004298
Gilles Peskine449bd832023-01-11 14:50:10 +01004299 return status;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004300}
4301
4302
mohammad16035955c982018-04-26 00:53:03 +03004303/****************************************************************/
4304/* AEAD */
4305/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004306
Paul Elliottbaff51c2021-09-28 17:44:45 +01004307/* Helper function to get the base algorithm from its variants. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004308static psa_algorithm_t psa_aead_get_base_algorithm(psa_algorithm_t alg)
Paul Elliottbaff51c2021-09-28 17:44:45 +01004309{
Gilles Peskine449bd832023-01-11 14:50:10 +01004310 return PSA_ALG_AEAD_WITH_DEFAULT_LENGTH_TAG(alg);
Paul Elliottbaff51c2021-09-28 17:44:45 +01004311}
4312
4313/* Helper function to perform common nonce length checks. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004314static psa_status_t psa_aead_check_nonce_length(psa_algorithm_t alg,
4315 size_t nonce_length)
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004316{
Gilles Peskine449bd832023-01-11 14:50:10 +01004317 psa_algorithm_t base_alg = psa_aead_get_base_algorithm(alg);
Paul Elliottbaff51c2021-09-28 17:44:45 +01004318
Gilles Peskine449bd832023-01-11 14:50:10 +01004319 switch (base_alg) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004320#if defined(PSA_WANT_ALG_GCM)
4321 case PSA_ALG_GCM:
4322 /* Not checking max nonce size here as GCM spec allows almost
Gilles Peskine449bd832023-01-11 14:50:10 +01004323 * arbitrarily large nonces. Please note that we do not generally
4324 * recommend the usage of nonces of greater length than
4325 * PSA_AEAD_NONCE_MAX_SIZE, as large nonces are hashed to a shorter
4326 * size, which can then lead to collisions if you encrypt a very
4327 * large number of messages.*/
4328 if (nonce_length != 0) {
4329 return PSA_SUCCESS;
4330 }
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004331 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004332#endif /* PSA_WANT_ALG_GCM */
4333#if defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004334 case PSA_ALG_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01004335 if (nonce_length >= 7 && nonce_length <= 13) {
4336 return PSA_SUCCESS;
4337 }
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004338 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004339#endif /* PSA_WANT_ALG_CCM */
4340#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004341 case PSA_ALG_CHACHA20_POLY1305:
Gilles Peskine449bd832023-01-11 14:50:10 +01004342 if (nonce_length == 12) {
4343 return PSA_SUCCESS;
4344 } else if (nonce_length == 8) {
4345 return PSA_ERROR_NOT_SUPPORTED;
4346 }
Bence Szépkúti6d48e202021-11-15 20:04:15 +01004347 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004348#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004349 default:
Przemek Stekiel4c499272022-09-27 13:55:37 +02004350 (void) nonce_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01004351 return PSA_ERROR_NOT_SUPPORTED;
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004352 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004353
Gilles Peskine449bd832023-01-11 14:50:10 +01004354 return PSA_ERROR_INVALID_ARGUMENT;
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004355}
4356
Gilles Peskine449bd832023-01-11 14:50:10 +01004357static psa_status_t psa_aead_check_algorithm(psa_algorithm_t alg)
Bence Szépkútiaa3a6e42022-01-13 16:26:03 +01004358{
Gilles Peskine449bd832023-01-11 14:50:10 +01004359 if (!PSA_ALG_IS_AEAD(alg) || PSA_ALG_IS_WILDCARD(alg)) {
4360 return PSA_ERROR_INVALID_ARGUMENT;
4361 }
Bence Szépkúti08f34652021-12-08 21:07:13 +01004362
Gilles Peskine449bd832023-01-11 14:50:10 +01004363 return PSA_SUCCESS;
Bence Szépkúti08f34652021-12-08 21:07:13 +01004364}
4365
Gilles Peskine449bd832023-01-11 14:50:10 +01004366psa_status_t psa_aead_encrypt(mbedtls_svc_key_id_t key,
4367 psa_algorithm_t alg,
4368 const uint8_t *nonce,
4369 size_t nonce_length,
4370 const uint8_t *additional_data,
4371 size_t additional_data_length,
4372 const uint8_t *plaintext,
4373 size_t plaintext_length,
4374 uint8_t *ciphertext,
4375 size_t ciphertext_size,
4376 size_t *ciphertext_length)
mohammad16035955c982018-04-26 00:53:03 +03004377{
Ronald Cron215633c2021-03-16 17:15:37 +01004378 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4379 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02004380
mohammad1603f08a5502018-06-03 15:05:47 +03004381 *ciphertext_length = 0;
mohammad1603e58e6842018-05-09 04:58:32 -07004382
Gilles Peskine449bd832023-01-11 14:50:10 +01004383 status = psa_aead_check_algorithm(alg);
4384 if (status != PSA_SUCCESS) {
4385 return status;
4386 }
Steven Cooremanea7ab132021-03-17 16:28:00 +01004387
Ronald Cron9a986162021-03-26 12:40:07 +01004388 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01004389 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg);
4390 if (status != PSA_SUCCESS) {
4391 return status;
4392 }
mohammad16035955c982018-04-26 00:53:03 +03004393
Ronald Cron215633c2021-03-16 17:15:37 +01004394 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01004395 .core = slot->attr
Ronald Cron215633c2021-03-16 17:15:37 +01004396 };
mohammad16035955c982018-04-26 00:53:03 +03004397
Gilles Peskine449bd832023-01-11 14:50:10 +01004398 status = psa_aead_check_nonce_length(alg, nonce_length);
4399 if (status != PSA_SUCCESS) {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004400 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004401 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004402
Ronald Cronde822812021-03-17 16:08:20 +01004403 status = psa_driver_wrapper_aead_encrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01004404 &attributes, slot->key.data, slot->key.bytes,
4405 alg,
4406 nonce, nonce_length,
4407 additional_data, additional_data_length,
4408 plaintext, plaintext_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004409 ciphertext, ciphertext_size, ciphertext_length);
Gilles Peskine2d277862018-06-18 15:41:12 +02004410
Gilles Peskine449bd832023-01-11 14:50:10 +01004411 if (status != PSA_SUCCESS && ciphertext_size != 0) {
4412 memset(ciphertext, 0, ciphertext_size);
4413 }
Gilles Peskine2d277862018-06-18 15:41:12 +02004414
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004415exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004416 psa_unlock_key_slot(slot);
mohammad16035955c982018-04-26 00:53:03 +03004417
Gilles Peskine449bd832023-01-11 14:50:10 +01004418 return status;
Gilles Peskineee652a32018-06-01 19:23:52 +02004419}
4420
Gilles Peskine449bd832023-01-11 14:50:10 +01004421psa_status_t psa_aead_decrypt(mbedtls_svc_key_id_t key,
4422 psa_algorithm_t alg,
4423 const uint8_t *nonce,
4424 size_t nonce_length,
4425 const uint8_t *additional_data,
4426 size_t additional_data_length,
4427 const uint8_t *ciphertext,
4428 size_t ciphertext_length,
4429 uint8_t *plaintext,
4430 size_t plaintext_size,
4431 size_t *plaintext_length)
mohammad16035955c982018-04-26 00:53:03 +03004432{
Ronald Cron215633c2021-03-16 17:15:37 +01004433 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4434 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02004435
Gilles Peskineee652a32018-06-01 19:23:52 +02004436 *plaintext_length = 0;
mohammad16039e5a5152018-04-26 12:07:35 +03004437
Gilles Peskine449bd832023-01-11 14:50:10 +01004438 status = psa_aead_check_algorithm(alg);
4439 if (status != PSA_SUCCESS) {
4440 return status;
4441 }
Steven Cooremanea7ab132021-03-17 16:28:00 +01004442
Ronald Cron9a986162021-03-26 12:40:07 +01004443 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01004444 key, &slot, PSA_KEY_USAGE_DECRYPT, alg);
4445 if (status != PSA_SUCCESS) {
4446 return status;
4447 }
mohammad16035955c982018-04-26 00:53:03 +03004448
Ronald Cron215633c2021-03-16 17:15:37 +01004449 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01004450 .core = slot->attr
Ronald Cron215633c2021-03-16 17:15:37 +01004451 };
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004452
Gilles Peskine449bd832023-01-11 14:50:10 +01004453 status = psa_aead_check_nonce_length(alg, nonce_length);
4454 if (status != PSA_SUCCESS) {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004455 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004456 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004457
Ronald Cronde822812021-03-17 16:08:20 +01004458 status = psa_driver_wrapper_aead_decrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01004459 &attributes, slot->key.data, slot->key.bytes,
4460 alg,
4461 nonce, nonce_length,
4462 additional_data, additional_data_length,
4463 ciphertext, ciphertext_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004464 plaintext, plaintext_size, plaintext_length);
Gilles Peskinea40d7742018-06-01 16:28:30 +02004465
Gilles Peskine449bd832023-01-11 14:50:10 +01004466 if (status != PSA_SUCCESS && plaintext_size != 0) {
4467 memset(plaintext, 0, plaintext_size);
4468 }
mohammad160360a64d02018-06-03 17:20:42 +03004469
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004470exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004471 psa_unlock_key_slot(slot);
Ronald Cron215633c2021-03-16 17:15:37 +01004472
Gilles Peskine449bd832023-01-11 14:50:10 +01004473 return status;
mohammad16035955c982018-04-26 00:53:03 +03004474}
4475
Gilles Peskine449bd832023-01-11 14:50:10 +01004476static psa_status_t psa_validate_tag_length(psa_algorithm_t alg)
4477{
4478 const uint8_t tag_len = PSA_ALG_AEAD_GET_TAG_LENGTH(alg);
Andrzej Kurekf8816012021-12-19 17:00:12 +01004479
Gilles Peskine449bd832023-01-11 14:50:10 +01004480 switch (PSA_ALG_AEAD_WITH_SHORTENED_TAG(alg, 0)) {
Przemek Stekiel86679c72022-10-06 17:06:56 +02004481#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004482 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004483 /* CCM allows the following tag lengths: 4, 6, 8, 10, 12, 14, 16.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004484 if (tag_len < 4 || tag_len > 16 || tag_len % 2) {
4485 return PSA_ERROR_INVALID_ARGUMENT;
4486 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01004487 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02004488#endif /* PSA_WANT_ALG_CCM */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004489
Przemek Stekiel86679c72022-10-06 17:06:56 +02004490#if defined(PSA_WANT_ALG_GCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004491 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_GCM, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004492 /* GCM allows the following tag lengths: 4, 8, 12, 13, 14, 15, 16. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004493 if (tag_len != 4 && tag_len != 8 && (tag_len < 12 || tag_len > 16)) {
4494 return PSA_ERROR_INVALID_ARGUMENT;
4495 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01004496 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02004497#endif /* PSA_WANT_ALG_GCM */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004498
Przemek Stekiel86679c72022-10-06 17:06:56 +02004499#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Gilles Peskine449bd832023-01-11 14:50:10 +01004500 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CHACHA20_POLY1305, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004501 /* We only support the default tag length. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004502 if (tag_len != 16) {
4503 return PSA_ERROR_INVALID_ARGUMENT;
4504 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01004505 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02004506#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004507
4508 default:
4509 (void) tag_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004510 return PSA_ERROR_NOT_SUPPORTED;
Andrzej Kurekf8816012021-12-19 17:00:12 +01004511 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004512 return PSA_SUCCESS;
Andrzej Kurekf8816012021-12-19 17:00:12 +01004513}
4514
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004515/* Set the key for a multipart authenticated operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004516static psa_status_t psa_aead_setup(psa_aead_operation_t *operation,
4517 int is_encrypt,
4518 mbedtls_svc_key_id_t key,
4519 psa_algorithm_t alg)
Paul Elliottc2b71442021-06-24 18:17:52 +01004520{
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004521 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4522 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
4523 psa_key_slot_t *slot = NULL;
4524 psa_key_usage_t key_usage = 0;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004525 psa_key_attributes_t attributes;
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004526
Gilles Peskine449bd832023-01-11 14:50:10 +01004527 status = psa_aead_check_algorithm(alg);
4528 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004529 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004530 }
Paul Elliottc2b71442021-06-24 18:17:52 +01004531
Gilles Peskine449bd832023-01-11 14:50:10 +01004532 if (operation->id != 0) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004533 status = PSA_ERROR_BAD_STATE;
4534 goto exit;
Paul Elliottc2b71442021-06-24 18:17:52 +01004535 }
4536
Gilles Peskine449bd832023-01-11 14:50:10 +01004537 if (operation->nonce_set || operation->lengths_set ||
4538 operation->ad_started || operation->body_started) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004539 status = PSA_ERROR_BAD_STATE;
4540 goto exit;
Paul Elliottc2b71442021-06-24 18:17:52 +01004541 }
4542
Gilles Peskine449bd832023-01-11 14:50:10 +01004543 if (is_encrypt) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004544 key_usage = PSA_KEY_USAGE_ENCRYPT;
Gilles Peskine449bd832023-01-11 14:50:10 +01004545 } else {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004546 key_usage = PSA_KEY_USAGE_DECRYPT;
Gilles Peskine449bd832023-01-11 14:50:10 +01004547 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004548
Gilles Peskine449bd832023-01-11 14:50:10 +01004549 status = psa_get_and_lock_key_slot_with_policy(key, &slot, key_usage,
4550 alg);
4551 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004552 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004553 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004554
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004555 attributes = (psa_key_attributes_t) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004556 .core = slot->attr
4557 };
4558
Gilles Peskine449bd832023-01-11 14:50:10 +01004559 if ((status = psa_validate_tag_length(alg)) != PSA_SUCCESS) {
Przemek Stekiel6ab50762022-10-08 17:54:30 +02004560 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004561 }
Przemek Stekiel6ab50762022-10-08 17:54:30 +02004562
Gilles Peskine449bd832023-01-11 14:50:10 +01004563 if (is_encrypt) {
4564 status = psa_driver_wrapper_aead_encrypt_setup(operation,
4565 &attributes,
4566 slot->key.data,
4567 slot->key.bytes,
4568 alg);
4569 } else {
4570 status = psa_driver_wrapper_aead_decrypt_setup(operation,
4571 &attributes,
4572 slot->key.data,
4573 slot->key.bytes,
4574 alg);
4575 }
4576 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004577 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004578 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004579
Gilles Peskine449bd832023-01-11 14:50:10 +01004580 operation->key_type = psa_get_key_type(&attributes);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004581
4582exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004583 unlock_status = psa_unlock_key_slot(slot);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004584
Gilles Peskine449bd832023-01-11 14:50:10 +01004585 if (status == PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004586 status = unlock_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01004587 operation->alg = psa_aead_get_base_algorithm(alg);
Paul Elliottd9343f22021-08-23 18:59:49 +01004588 operation->is_encrypt = is_encrypt;
Gilles Peskine449bd832023-01-11 14:50:10 +01004589 } else {
4590 psa_aead_abort(operation);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004591 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004592
Gilles Peskine449bd832023-01-11 14:50:10 +01004593 return status;
Paul Elliottc2b71442021-06-24 18:17:52 +01004594}
4595
Paul Elliott302ff6b2021-04-20 18:10:30 +01004596/* Set the key for a multipart authenticated encryption operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004597psa_status_t psa_aead_encrypt_setup(psa_aead_operation_t *operation,
4598 mbedtls_svc_key_id_t key,
4599 psa_algorithm_t alg)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004600{
Gilles Peskine449bd832023-01-11 14:50:10 +01004601 return psa_aead_setup(operation, 1, key, alg);
Paul Elliott302ff6b2021-04-20 18:10:30 +01004602}
4603
4604/* Set the key for a multipart authenticated decryption operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004605psa_status_t psa_aead_decrypt_setup(psa_aead_operation_t *operation,
4606 mbedtls_svc_key_id_t key,
4607 psa_algorithm_t alg)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004608{
Gilles Peskine449bd832023-01-11 14:50:10 +01004609 return psa_aead_setup(operation, 0, key, alg);
Paul Elliott302ff6b2021-04-20 18:10:30 +01004610}
4611
4612/* Generate a random nonce / IV for multipart AEAD operation */
Gilles Peskine449bd832023-01-11 14:50:10 +01004613psa_status_t psa_aead_generate_nonce(psa_aead_operation_t *operation,
4614 uint8_t *nonce,
4615 size_t nonce_size,
4616 size_t *nonce_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004617{
4618 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Croncae59092021-11-26 18:53:58 +01004619 uint8_t local_nonce[PSA_AEAD_NONCE_MAX_SIZE];
Sergeybef1f632023-03-06 15:25:06 -07004620 size_t required_nonce_size = 0;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004621
Paul Elliott8eb9daf2021-06-04 16:42:21 +01004622 *nonce_length = 0;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004623
Gilles Peskine449bd832023-01-11 14:50:10 +01004624 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004625 status = PSA_ERROR_BAD_STATE;
4626 goto exit;
4627 }
4628
Gilles Peskine449bd832023-01-11 14:50:10 +01004629 if (operation->nonce_set || !operation->is_encrypt) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004630 status = PSA_ERROR_BAD_STATE;
4631 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004632 }
4633
Paul Elliotte193ea82021-10-01 13:00:16 +01004634 /* For CCM, this size may not be correct according to the PSA
4635 * specification. The PSA Crypto 1.0.1 specification states:
4636 *
4637 * CCM encodes the plaintext length pLen in L octets, with L the smallest
4638 * integer >= 2 where pLen < 2^(8L). The nonce length is then 15 - L bytes.
4639 *
4640 * However this restriction that L has to be the smallest integer is not
4641 * applied in practice, and it is not implementable here since the
4642 * plaintext length may or may not be known at this time. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004643 required_nonce_size = PSA_AEAD_NONCE_LENGTH(operation->key_type,
4644 operation->alg);
4645 if (nonce_size < required_nonce_size) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004646 status = PSA_ERROR_BUFFER_TOO_SMALL;
4647 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004648 }
4649
Gilles Peskine449bd832023-01-11 14:50:10 +01004650 status = psa_generate_random(local_nonce, required_nonce_size);
4651 if (status != PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004652 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004653 }
Paul Elliott302ff6b2021-04-20 18:10:30 +01004654
Gilles Peskine449bd832023-01-11 14:50:10 +01004655 status = psa_aead_set_nonce(operation, local_nonce, required_nonce_size);
Paul Elliott302ff6b2021-04-20 18:10:30 +01004656
Paul Elliott39dc6b82021-05-11 19:16:09 +01004657exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004658 if (status == PSA_SUCCESS) {
4659 memcpy(nonce, local_nonce, required_nonce_size);
Paul Elliott39dc6b82021-05-11 19:16:09 +01004660 *nonce_length = required_nonce_size;
Gilles Peskine449bd832023-01-11 14:50:10 +01004661 } else {
4662 psa_aead_abort(operation);
Ronald Croncae59092021-11-26 18:53:58 +01004663 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01004664
Gilles Peskine449bd832023-01-11 14:50:10 +01004665 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004666}
4667
4668/* Set the nonce for a multipart authenticated encryption or decryption
4669 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004670psa_status_t psa_aead_set_nonce(psa_aead_operation_t *operation,
4671 const uint8_t *nonce,
4672 size_t nonce_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004673{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004674 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4675
Gilles Peskine449bd832023-01-11 14:50:10 +01004676 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004677 status = PSA_ERROR_BAD_STATE;
4678 goto exit;
4679 }
4680
Gilles Peskine449bd832023-01-11 14:50:10 +01004681 if (operation->nonce_set) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004682 status = PSA_ERROR_BAD_STATE;
4683 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004684 }
4685
Gilles Peskine449bd832023-01-11 14:50:10 +01004686 status = psa_aead_check_nonce_length(operation->alg, nonce_length);
4687 if (status != PSA_SUCCESS) {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004688 status = PSA_ERROR_INVALID_ARGUMENT;
4689 goto exit;
Paul Elliott4ed1ed12021-09-27 18:09:28 +01004690 }
Paul Elliott1a98aca2021-05-20 18:24:07 +01004691
Gilles Peskine449bd832023-01-11 14:50:10 +01004692 status = psa_driver_wrapper_aead_set_nonce(operation, nonce,
4693 nonce_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004694
Paul Elliott39dc6b82021-05-11 19:16:09 +01004695exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004696 if (status == PSA_SUCCESS) {
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004697 operation->nonce_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004698 } else {
4699 psa_aead_abort(operation);
4700 }
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004701
Gilles Peskine449bd832023-01-11 14:50:10 +01004702 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004703}
4704
4705/* Declare the lengths of the message and additional data for multipart AEAD. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004706psa_status_t psa_aead_set_lengths(psa_aead_operation_t *operation,
4707 size_t ad_length,
4708 size_t plaintext_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004709{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004710 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4711
Gilles Peskine449bd832023-01-11 14:50:10 +01004712 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004713 status = PSA_ERROR_BAD_STATE;
4714 goto exit;
4715 }
4716
Gilles Peskine449bd832023-01-11 14:50:10 +01004717 if (operation->lengths_set || operation->ad_started ||
4718 operation->body_started) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004719 status = PSA_ERROR_BAD_STATE;
4720 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004721 }
4722
Gilles Peskine449bd832023-01-11 14:50:10 +01004723 switch (operation->alg) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004724#if defined(PSA_WANT_ALG_GCM)
4725 case PSA_ALG_GCM:
4726 /* Lengths can only be too large for GCM if size_t is bigger than 32
Gilles Peskine449bd832023-01-11 14:50:10 +01004727 * bits. Without the guard this code will generate warnings on 32bit
4728 * builds. */
Paul Elliott325d3742021-09-27 17:56:28 +01004729#if SIZE_MAX > UINT32_MAX
Gilles Peskine449bd832023-01-11 14:50:10 +01004730 if (((uint64_t) ad_length) >> 61 != 0 ||
4731 ((uint64_t) plaintext_length) > 0xFFFFFFFE0ull) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004732 status = PSA_ERROR_INVALID_ARGUMENT;
4733 goto exit;
4734 }
Paul Elliott325d3742021-09-27 17:56:28 +01004735#endif
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004736 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004737#endif /* PSA_WANT_ALG_GCM */
4738#if defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004739 case PSA_ALG_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01004740 if (ad_length > 0xFF00) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004741 status = PSA_ERROR_INVALID_ARGUMENT;
4742 goto exit;
4743 }
4744 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004745#endif /* PSA_WANT_ALG_CCM */
4746#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004747 case PSA_ALG_CHACHA20_POLY1305:
4748 /* No length restrictions for ChaChaPoly. */
4749 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004750#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004751 default:
4752 break;
4753 }
Paul Elliott325d3742021-09-27 17:56:28 +01004754
Gilles Peskine449bd832023-01-11 14:50:10 +01004755 status = psa_driver_wrapper_aead_set_lengths(operation, ad_length,
4756 plaintext_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004757
Paul Elliott39dc6b82021-05-11 19:16:09 +01004758exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004759 if (status == PSA_SUCCESS) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01004760 operation->ad_remaining = ad_length;
4761 operation->body_remaining = plaintext_length;
Paul Elliott39dc6b82021-05-11 19:16:09 +01004762 operation->lengths_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004763 } else {
4764 psa_aead_abort(operation);
Paul Elliottee4ffe02021-05-20 17:25:06 +01004765 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01004766
Gilles Peskine449bd832023-01-11 14:50:10 +01004767 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004768}
Paul Elliott3d7d52c2021-09-01 10:33:14 +01004769
4770/* Pass additional data to an active multipart AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004771psa_status_t psa_aead_update_ad(psa_aead_operation_t *operation,
4772 const uint8_t *input,
4773 size_t input_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004774{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004775 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4776
Gilles Peskine449bd832023-01-11 14:50:10 +01004777 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004778 status = PSA_ERROR_BAD_STATE;
4779 goto exit;
4780 }
4781
Gilles Peskine449bd832023-01-11 14:50:10 +01004782 if (!operation->nonce_set || operation->body_started) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004783 status = PSA_ERROR_BAD_STATE;
4784 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004785 }
4786
Gilles Peskine449bd832023-01-11 14:50:10 +01004787 if (operation->lengths_set) {
4788 if (operation->ad_remaining < input_length) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01004789 status = PSA_ERROR_INVALID_ARGUMENT;
4790 goto exit;
4791 }
4792
4793 operation->ad_remaining -= input_length;
4794 }
Paul Elliotte193ea82021-10-01 13:00:16 +01004795#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004796 else if (operation->alg == PSA_ALG_CCM) {
Paul Elliotte193ea82021-10-01 13:00:16 +01004797 status = PSA_ERROR_BAD_STATE;
4798 goto exit;
4799 }
4800#endif /* PSA_WANT_ALG_CCM */
Paul Elliottee4ffe02021-05-20 17:25:06 +01004801
Gilles Peskine449bd832023-01-11 14:50:10 +01004802 status = psa_driver_wrapper_aead_update_ad(operation, input,
4803 input_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004804
Paul Elliott39dc6b82021-05-11 19:16:09 +01004805exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004806 if (status == PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004807 operation->ad_started = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004808 } else {
4809 psa_aead_abort(operation);
4810 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01004811
Gilles Peskine449bd832023-01-11 14:50:10 +01004812 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004813}
4814
4815/* Encrypt or decrypt a message fragment in an active multipart AEAD
4816 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004817psa_status_t psa_aead_update(psa_aead_operation_t *operation,
4818 const uint8_t *input,
4819 size_t input_length,
4820 uint8_t *output,
4821 size_t output_size,
4822 size_t *output_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004823{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004824 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004825
4826 *output_length = 0;
4827
Gilles Peskine449bd832023-01-11 14:50:10 +01004828 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004829 status = PSA_ERROR_BAD_STATE;
4830 goto exit;
4831 }
4832
Gilles Peskine449bd832023-01-11 14:50:10 +01004833 if (!operation->nonce_set) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004834 status = PSA_ERROR_BAD_STATE;
4835 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004836 }
4837
Gilles Peskine449bd832023-01-11 14:50:10 +01004838 if (operation->lengths_set) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01004839 /* Additional data length was supplied, but not all the additional
4840 data was supplied.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004841 if (operation->ad_remaining != 0) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01004842 status = PSA_ERROR_INVALID_ARGUMENT;
4843 goto exit;
4844 }
4845
4846 /* Too much data provided. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004847 if (operation->body_remaining < input_length) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01004848 status = PSA_ERROR_INVALID_ARGUMENT;
4849 goto exit;
4850 }
4851
4852 operation->body_remaining -= input_length;
4853 }
Paul Elliotte193ea82021-10-01 13:00:16 +01004854#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004855 else if (operation->alg == PSA_ALG_CCM) {
Paul Elliotte193ea82021-10-01 13:00:16 +01004856 status = PSA_ERROR_BAD_STATE;
4857 goto exit;
4858 }
4859#endif /* PSA_WANT_ALG_CCM */
Paul Elliottee4ffe02021-05-20 17:25:06 +01004860
Gilles Peskine449bd832023-01-11 14:50:10 +01004861 status = psa_driver_wrapper_aead_update(operation, input, input_length,
4862 output, output_size,
4863 output_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004864
Paul Elliott39dc6b82021-05-11 19:16:09 +01004865exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004866 if (status == PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004867 operation->body_started = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004868 } else {
4869 psa_aead_abort(operation);
4870 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01004871
Gilles Peskine449bd832023-01-11 14:50:10 +01004872 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004873}
4874
Gilles Peskine449bd832023-01-11 14:50:10 +01004875static psa_status_t psa_aead_final_checks(const psa_aead_operation_t *operation)
Paul Elliottad53dcc2021-06-23 08:50:14 +01004876{
Gilles Peskine449bd832023-01-11 14:50:10 +01004877 if (operation->id == 0 || !operation->nonce_set) {
4878 return PSA_ERROR_BAD_STATE;
4879 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01004880
Gilles Peskine449bd832023-01-11 14:50:10 +01004881 if (operation->lengths_set && (operation->ad_remaining != 0 ||
4882 operation->body_remaining != 0)) {
4883 return PSA_ERROR_INVALID_ARGUMENT;
4884 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01004885
Gilles Peskine449bd832023-01-11 14:50:10 +01004886 return PSA_SUCCESS;
Paul Elliottad53dcc2021-06-23 08:50:14 +01004887}
4888
Paul Elliott302ff6b2021-04-20 18:10:30 +01004889/* Finish encrypting a message in a multipart AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004890psa_status_t psa_aead_finish(psa_aead_operation_t *operation,
4891 uint8_t *ciphertext,
4892 size_t ciphertext_size,
4893 size_t *ciphertext_length,
4894 uint8_t *tag,
4895 size_t tag_size,
4896 size_t *tag_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004897{
Paul Elliott39dc6b82021-05-11 19:16:09 +01004898 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4899
Paul Elliott302ff6b2021-04-20 18:10:30 +01004900 *ciphertext_length = 0;
Paul Elliottf88a5652021-06-22 17:53:45 +01004901 *tag_length = tag_size;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004902
Gilles Peskine449bd832023-01-11 14:50:10 +01004903 status = psa_aead_final_checks(operation);
4904 if (status != PSA_SUCCESS) {
Paul Elliottad53dcc2021-06-23 08:50:14 +01004905 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004906 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01004907
Gilles Peskine449bd832023-01-11 14:50:10 +01004908 if (!operation->is_encrypt) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004909 status = PSA_ERROR_BAD_STATE;
4910 goto exit;
4911 }
4912
Gilles Peskine449bd832023-01-11 14:50:10 +01004913 status = psa_driver_wrapper_aead_finish(operation, ciphertext,
4914 ciphertext_size,
4915 ciphertext_length,
4916 tag, tag_size, tag_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004917
Paul Elliott39dc6b82021-05-11 19:16:09 +01004918exit:
Paul Elliottdc42ca82023-02-24 18:11:59 +00004919
4920
Paul Elliottf47b0952021-05-21 18:02:33 +01004921 /* In case the operation fails and the user fails to check for failure or
Paul Elliott4c916e82021-09-19 18:34:50 +01004922 * the zero tag size, make sure the tag is set to something implausible.
4923 * Even if the operation succeeds, make sure we clear the rest of the
4924 * buffer to prevent potential leakage of anything previously placed in
4925 * the same buffer.*/
Paul Elliottdc42ca82023-02-24 18:11:59 +00004926 psa_wipe_tag_output_buffer(tag, status, tag_size, *tag_length);
Paul Elliottf47b0952021-05-21 18:02:33 +01004927
Gilles Peskine449bd832023-01-11 14:50:10 +01004928 psa_aead_abort(operation);
Paul Elliott39dc6b82021-05-11 19:16:09 +01004929
Gilles Peskine449bd832023-01-11 14:50:10 +01004930 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004931}
4932
4933/* Finish authenticating and decrypting a message in a multipart AEAD
4934 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004935psa_status_t psa_aead_verify(psa_aead_operation_t *operation,
4936 uint8_t *plaintext,
4937 size_t plaintext_size,
4938 size_t *plaintext_length,
4939 const uint8_t *tag,
4940 size_t tag_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004941{
Paul Elliott39dc6b82021-05-11 19:16:09 +01004942 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4943
Paul Elliott302ff6b2021-04-20 18:10:30 +01004944 *plaintext_length = 0;
4945
Gilles Peskine449bd832023-01-11 14:50:10 +01004946 status = psa_aead_final_checks(operation);
4947 if (status != PSA_SUCCESS) {
Paul Elliottad53dcc2021-06-23 08:50:14 +01004948 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004949 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01004950
Gilles Peskine449bd832023-01-11 14:50:10 +01004951 if (operation->is_encrypt) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004952 status = PSA_ERROR_BAD_STATE;
4953 goto exit;
4954 }
4955
Gilles Peskine449bd832023-01-11 14:50:10 +01004956 status = psa_driver_wrapper_aead_verify(operation, plaintext,
4957 plaintext_size,
4958 plaintext_length,
4959 tag, tag_length);
Paul Elliott39dc6b82021-05-11 19:16:09 +01004960
4961exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004962 psa_aead_abort(operation);
Paul Elliott39dc6b82021-05-11 19:16:09 +01004963
Gilles Peskine449bd832023-01-11 14:50:10 +01004964 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004965}
4966
4967/* Abort an AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004968psa_status_t psa_aead_abort(psa_aead_operation_t *operation)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004969{
4970 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4971
Gilles Peskine449bd832023-01-11 14:50:10 +01004972 if (operation->id == 0) {
Paul Elliott302ff6b2021-04-20 18:10:30 +01004973 /* The object has (apparently) been initialized but it is not (yet)
4974 * in use. It's ok to call abort on such an object, and there's
4975 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004976 return PSA_SUCCESS;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004977 }
4978
Gilles Peskine449bd832023-01-11 14:50:10 +01004979 status = psa_driver_wrapper_aead_abort(operation);
Paul Elliott302ff6b2021-04-20 18:10:30 +01004980
Gilles Peskine449bd832023-01-11 14:50:10 +01004981 memset(operation, 0, sizeof(*operation));
Paul Elliott302ff6b2021-04-20 18:10:30 +01004982
Gilles Peskine449bd832023-01-11 14:50:10 +01004983 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004984}
4985
Gilles Peskinee59236f2018-01-27 23:32:46 +01004986/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02004987/* Generators */
4988/****************************************************************/
4989
Przemek Stekiel69c46792022-06-10 12:59:51 +02004990#if defined(BUILTIN_ALG_ANY_HKDF) || \
John Durkop07cc04a2020-11-16 22:08:34 -08004991 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
Andrzej Kurek08d34b82022-07-29 10:00:16 -04004992 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) || \
Kusumit Ghoderaoaf0b5342023-05-03 11:58:46 +05304993 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS) || \
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05304994 defined(PSA_HAVE_SOFT_PBKDF2)
John Durkop07cc04a2020-11-16 22:08:34 -08004995#define AT_LEAST_ONE_BUILTIN_KDF
Steven Cooreman094a77e2021-05-06 17:58:36 +02004996#endif /* At least one builtin KDF */
4997
Przemek Stekiel69c46792022-06-10 12:59:51 +02004998#if defined(BUILTIN_ALG_ANY_HKDF) || \
Steven Cooreman094a77e2021-05-06 17:58:36 +02004999 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5000 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
5001static psa_status_t psa_key_derivation_start_hmac(
5002 psa_mac_operation_t *operation,
5003 psa_algorithm_t hash_alg,
5004 const uint8_t *hmac_key,
Gilles Peskine449bd832023-01-11 14:50:10 +01005005 size_t hmac_key_length)
Steven Cooreman094a77e2021-05-06 17:58:36 +02005006{
5007 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5008 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01005009 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
5010 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(hmac_key_length));
5011 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_HASH);
Steven Cooreman094a77e2021-05-06 17:58:36 +02005012
Steven Cooreman72f736a2021-05-07 14:14:37 +02005013 operation->is_sign = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005014 operation->mac_size = PSA_HASH_LENGTH(hash_alg);
Steven Cooreman72f736a2021-05-07 14:14:37 +02005015
Gilles Peskine449bd832023-01-11 14:50:10 +01005016 status = psa_driver_wrapper_mac_sign_setup(operation,
5017 &attributes,
5018 hmac_key, hmac_key_length,
5019 PSA_ALG_HMAC(hash_alg));
Steven Cooreman094a77e2021-05-06 17:58:36 +02005020
Gilles Peskine449bd832023-01-11 14:50:10 +01005021 psa_reset_key_attributes(&attributes);
5022 return status;
Steven Cooreman094a77e2021-05-06 17:58:36 +02005023}
5024#endif /* KDF algorithms reliant on HMAC */
John Durkop07cc04a2020-11-16 22:08:34 -08005025
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005026#define HKDF_STATE_INIT 0 /* no input yet */
5027#define HKDF_STATE_STARTED 1 /* got salt */
5028#define HKDF_STATE_KEYED 2 /* got key */
5029#define HKDF_STATE_OUTPUT 3 /* output started */
5030
Gilles Peskinecbe66502019-05-16 16:59:18 +02005031static psa_algorithm_t psa_key_derivation_get_kdf_alg(
Gilles Peskine449bd832023-01-11 14:50:10 +01005032 const psa_key_derivation_operation_t *operation)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005033{
Gilles Peskine449bd832023-01-11 14:50:10 +01005034 if (PSA_ALG_IS_KEY_AGREEMENT(operation->alg)) {
5035 return PSA_ALG_KEY_AGREEMENT_GET_KDF(operation->alg);
5036 } else {
5037 return operation->alg;
5038 }
Gilles Peskine969c5d62019-01-16 15:53:06 +01005039}
5040
Gilles Peskine449bd832023-01-11 14:50:10 +01005041psa_status_t psa_key_derivation_abort(psa_key_derivation_operation_t *operation)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005042{
5043 psa_status_t status = PSA_SUCCESS;
Gilles Peskine449bd832023-01-11 14:50:10 +01005044 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
5045 if (kdf_alg == 0) {
Gilles Peskineeab56e42018-07-12 17:12:33 +02005046 /* The object has (apparently) been initialized but it is not
5047 * in use. It's ok to call abort on such an object, and there's
5048 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005049 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02005050#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01005051 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
5052 mbedtls_free(operation->ctx.hkdf.info);
5053 status = psa_mac_abort(&operation->ctx.hkdf.hmac);
5054 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02005055#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08005056#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5057 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005058 if (PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
5059 /* TLS-1.2 PSK-to-MS KDF uses the same core as TLS-1.2 PRF */
5060 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
5061 if (operation->ctx.tls12_prf.secret != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005062 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.secret,
Gilles Peskine449bd832023-01-11 14:50:10 +01005063 operation->ctx.tls12_prf.secret_length);
Steven Cooremana6df6042021-04-29 19:32:25 +02005064 }
5065
Gilles Peskine449bd832023-01-11 14:50:10 +01005066 if (operation->ctx.tls12_prf.seed != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005067 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.seed,
Gilles Peskine449bd832023-01-11 14:50:10 +01005068 operation->ctx.tls12_prf.seed_length);
Janos Follath6a1d2622019-06-11 10:37:28 +01005069 }
5070
Gilles Peskine449bd832023-01-11 14:50:10 +01005071 if (operation->ctx.tls12_prf.label != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005072 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.label,
Gilles Peskine449bd832023-01-11 14:50:10 +01005073 operation->ctx.tls12_prf.label_length);
Janos Follath6a1d2622019-06-11 10:37:28 +01005074 }
Przemek Stekiel6c764412022-11-22 14:05:12 +01005075#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005076 if (operation->ctx.tls12_prf.other_secret != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005077 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.other_secret,
Gilles Peskine449bd832023-01-11 14:50:10 +01005078 operation->ctx.tls12_prf.other_secret_length);
Przemek Stekiele3ee2212022-04-07 14:29:56 +02005079 }
Przemek Stekiel6c764412022-11-22 14:05:12 +01005080#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Steven Cooremana6df6042021-04-29 19:32:25 +02005081 status = PSA_SUCCESS;
Janos Follath6a1d2622019-06-11 10:37:28 +01005082
5083 /* We leave the fields Ai and output_block to be erased safely by the
5084 * mbedtls_platform_zeroize() in the end of this function. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005085 } else
John Durkop07cc04a2020-11-16 22:08:34 -08005086#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
5087 * defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005088#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005089 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
5090 mbedtls_platform_zeroize(operation->ctx.tls12_ecjpake_to_pms.data,
5091 sizeof(operation->ctx.tls12_ecjpake_to_pms.data));
5092 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005093#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS) */
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305094#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05305095 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305096 if (operation->ctx.pbkdf2.salt != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005097 mbedtls_zeroize_and_free(operation->ctx.pbkdf2.salt,
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305098 operation->ctx.pbkdf2.salt_length);
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305099 }
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305100
5101 status = PSA_SUCCESS;
5102 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305103#endif /* defined(PSA_HAVE_SOFT_PBKDF2) */
Gilles Peskineeab56e42018-07-12 17:12:33 +02005104 {
5105 status = PSA_ERROR_BAD_STATE;
5106 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005107 mbedtls_platform_zeroize(operation, sizeof(*operation));
5108 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005109}
5110
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005111psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskine449bd832023-01-11 14:50:10 +01005112 size_t *capacity)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005113{
Gilles Peskine449bd832023-01-11 14:50:10 +01005114 if (operation->alg == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005115 /* This is a blank key derivation operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005116 return PSA_ERROR_BAD_STATE;
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005117 }
5118
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005119 *capacity = operation->capacity;
Gilles Peskine449bd832023-01-11 14:50:10 +01005120 return PSA_SUCCESS;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005121}
5122
Gilles Peskine449bd832023-01-11 14:50:10 +01005123psa_status_t psa_key_derivation_set_capacity(psa_key_derivation_operation_t *operation,
5124 size_t capacity)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005125{
Gilles Peskine449bd832023-01-11 14:50:10 +01005126 if (operation->alg == 0) {
5127 return PSA_ERROR_BAD_STATE;
5128 }
5129 if (capacity > operation->capacity) {
5130 return PSA_ERROR_INVALID_ARGUMENT;
5131 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005132 operation->capacity = capacity;
Gilles Peskine449bd832023-01-11 14:50:10 +01005133 return PSA_SUCCESS;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005134}
5135
Przemek Stekiel69c46792022-06-10 12:59:51 +02005136#if defined(BUILTIN_ALG_ANY_HKDF)
Przemek Stekiel03d948c2022-05-19 11:45:20 +02005137/* Read some bytes from an HKDF-based operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005138static psa_status_t psa_key_derivation_hkdf_read(psa_hkdf_key_derivation_t *hkdf,
5139 psa_algorithm_t kdf_alg,
5140 uint8_t *output,
5141 size_t output_length)
Gilles Peskinebef7f142018-07-12 17:22:21 +02005142{
Gilles Peskine449bd832023-01-11 14:50:10 +01005143 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
5144 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Steven Cooremand1ed1d92021-04-29 19:11:25 +02005145 size_t hmac_output_length;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005146 psa_status_t status;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005147#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01005148 const uint8_t last_block = PSA_ALG_IS_HKDF_EXTRACT(kdf_alg) ? 0 : 0xff;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005149#else
5150 const uint8_t last_block = 0xff;
5151#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskinebef7f142018-07-12 17:22:21 +02005152
Gilles Peskine449bd832023-01-11 14:50:10 +01005153 if (hkdf->state < HKDF_STATE_KEYED ||
5154 (!hkdf->info_set
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005155#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01005156 && !PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005157#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01005158 )) {
5159 return PSA_ERROR_BAD_STATE;
5160 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005161 hkdf->state = HKDF_STATE_OUTPUT;
5162
Gilles Peskine449bd832023-01-11 14:50:10 +01005163 while (output_length != 0) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005164 /* Copy what remains of the current block */
5165 uint8_t n = hash_length - hkdf->offset_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005166 if (n > output_length) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005167 n = (uint8_t) output_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01005168 }
5169 memcpy(output, hkdf->output_block + hkdf->offset_in_block, n);
Gilles Peskinebef7f142018-07-12 17:22:21 +02005170 output += n;
5171 output_length -= n;
5172 hkdf->offset_in_block += n;
Gilles Peskine449bd832023-01-11 14:50:10 +01005173 if (output_length == 0) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005174 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01005175 }
Przemek Stekiel03d948c2022-05-19 11:45:20 +02005176 /* We can't be wanting more output after the last block, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005177 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005178 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02005179 * object was corrupted or if this function is called directly
5180 * inside the library. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005181 if (hkdf->block_number == last_block) {
5182 return PSA_ERROR_BAD_STATE;
5183 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02005184
5185 /* We need a new block */
5186 ++hkdf->block_number;
5187 hkdf->offset_in_block = 0;
Steven Cooremand1ed1d92021-04-29 19:11:25 +02005188
Gilles Peskine449bd832023-01-11 14:50:10 +01005189 status = psa_key_derivation_start_hmac(&hkdf->hmac,
5190 hash_alg,
5191 hkdf->prk,
5192 hash_length);
5193 if (status != PSA_SUCCESS) {
5194 return status;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005195 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005196
5197 if (hkdf->block_number != 1) {
5198 status = psa_mac_update(&hkdf->hmac,
5199 hkdf->output_block,
5200 hash_length);
5201 if (status != PSA_SUCCESS) {
5202 return status;
5203 }
5204 }
5205 status = psa_mac_update(&hkdf->hmac,
5206 hkdf->info,
5207 hkdf->info_length);
5208 if (status != PSA_SUCCESS) {
5209 return status;
5210 }
5211 status = psa_mac_update(&hkdf->hmac,
5212 &hkdf->block_number, 1);
5213 if (status != PSA_SUCCESS) {
5214 return status;
5215 }
5216 status = psa_mac_sign_finish(&hkdf->hmac,
5217 hkdf->output_block,
5218 sizeof(hkdf->output_block),
5219 &hmac_output_length);
5220 if (status != PSA_SUCCESS) {
5221 return status;
5222 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02005223 }
5224
Gilles Peskine449bd832023-01-11 14:50:10 +01005225 return PSA_SUCCESS;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005226}
Przemek Stekiel69c46792022-06-10 12:59:51 +02005227#endif /* BUILTIN_ALG_ANY_HKDF */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005228
John Durkop07cc04a2020-11-16 22:08:34 -08005229#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5230 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follath7742fee2019-06-17 12:58:10 +01005231static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
5232 psa_tls12_prf_key_derivation_t *tls12_prf,
Gilles Peskine449bd832023-01-11 14:50:10 +01005233 psa_algorithm_t alg)
Janos Follath7742fee2019-06-17 12:58:10 +01005234{
Gilles Peskine449bd832023-01-11 14:50:10 +01005235 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(alg);
5236 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Steven Cooremana6df6042021-04-29 19:32:25 +02005237 psa_mac_operation_t hmac = PSA_MAC_OPERATION_INIT;
5238 size_t hmac_output_length;
Janos Follathea29bfb2019-06-19 12:21:20 +01005239 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005240
Janos Follath7742fee2019-06-17 12:58:10 +01005241 /* We can't be wanting more output after block 0xff, otherwise
5242 * the capacity check in psa_key_derivation_output_bytes() would have
5243 * prevented this call. It could happen only if the operation
5244 * object was corrupted or if this function is called directly
5245 * inside the library. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005246 if (tls12_prf->block_number == 0xff) {
5247 return PSA_ERROR_CORRUPTION_DETECTED;
5248 }
Janos Follath7742fee2019-06-17 12:58:10 +01005249
5250 /* We need a new block */
5251 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01005252 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01005253
5254 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
5255 *
5256 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
5257 *
5258 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
5259 * HMAC_hash(secret, A(2) + seed) +
5260 * HMAC_hash(secret, A(3) + seed) + ...
5261 *
5262 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01005263 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01005264 *
Janos Follathea29bfb2019-06-19 12:21:20 +01005265 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01005266 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01005267 * is currently extracted as `output_block` and where i is
5268 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01005269 */
5270
Gilles Peskine449bd832023-01-11 14:50:10 +01005271 status = psa_key_derivation_start_hmac(&hmac,
5272 hash_alg,
5273 tls12_prf->secret,
5274 tls12_prf->secret_length);
5275 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005276 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005277 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005278
5279 /* Calculate A(i) where i = tls12_prf->block_number. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005280 if (tls12_prf->block_number == 1) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005281 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
5282 * the variable seed and in this instance means it in the context of the
5283 * P_hash function, where seed = label + seed.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01005284 status = psa_mac_update(&hmac,
5285 tls12_prf->label,
5286 tls12_prf->label_length);
5287 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005288 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005289 }
5290 status = psa_mac_update(&hmac,
5291 tls12_prf->seed,
5292 tls12_prf->seed_length);
5293 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005294 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005295 }
5296 } else {
Janos Follathea29bfb2019-06-19 12:21:20 +01005297 /* A(i) = HMAC_hash(secret, A(i-1)) */
Gilles Peskine449bd832023-01-11 14:50:10 +01005298 status = psa_mac_update(&hmac, tls12_prf->Ai, hash_length);
5299 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005300 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005301 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005302 }
5303
Gilles Peskine449bd832023-01-11 14:50:10 +01005304 status = psa_mac_sign_finish(&hmac,
5305 tls12_prf->Ai, hash_length,
5306 &hmac_output_length);
5307 if (hmac_output_length != hash_length) {
Steven Cooremana6df6042021-04-29 19:32:25 +02005308 status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01005309 }
5310 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005311 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005312 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005313
5314 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
Gilles Peskine449bd832023-01-11 14:50:10 +01005315 status = psa_key_derivation_start_hmac(&hmac,
5316 hash_alg,
5317 tls12_prf->secret,
5318 tls12_prf->secret_length);
5319 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005320 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005321 }
5322 status = psa_mac_update(&hmac, tls12_prf->Ai, hash_length);
5323 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005324 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005325 }
5326 status = psa_mac_update(&hmac, tls12_prf->label, tls12_prf->label_length);
5327 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005328 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005329 }
5330 status = psa_mac_update(&hmac, tls12_prf->seed, tls12_prf->seed_length);
5331 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005332 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005333 }
5334 status = psa_mac_sign_finish(&hmac,
5335 tls12_prf->output_block, hash_length,
5336 &hmac_output_length);
5337 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005338 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005339 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005340
Janos Follath7742fee2019-06-17 12:58:10 +01005341
5342cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01005343 cleanup_status = psa_mac_abort(&hmac);
5344 if (status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005345 status = cleanup_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01005346 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005347
Gilles Peskine449bd832023-01-11 14:50:10 +01005348 return status;
Janos Follath7742fee2019-06-17 12:58:10 +01005349}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005350
Janos Follath844eb0e2019-06-19 12:10:49 +01005351static psa_status_t psa_key_derivation_tls12_prf_read(
5352 psa_tls12_prf_key_derivation_t *tls12_prf,
5353 psa_algorithm_t alg,
5354 uint8_t *output,
Gilles Peskine449bd832023-01-11 14:50:10 +01005355 size_t output_length)
Janos Follath844eb0e2019-06-19 12:10:49 +01005356{
Gilles Peskine449bd832023-01-11 14:50:10 +01005357 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH(alg);
5358 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Janos Follath844eb0e2019-06-19 12:10:49 +01005359 psa_status_t status;
5360 uint8_t offset, length;
5361
Gilles Peskine449bd832023-01-11 14:50:10 +01005362 switch (tls12_prf->state) {
Gilles Peskineb1edaec2021-06-11 22:41:46 +02005363 case PSA_TLS12_PRF_STATE_LABEL_SET:
5364 tls12_prf->state = PSA_TLS12_PRF_STATE_OUTPUT;
5365 break;
5366 case PSA_TLS12_PRF_STATE_OUTPUT:
5367 break;
5368 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005369 return PSA_ERROR_BAD_STATE;
Gilles Peskineb1edaec2021-06-11 22:41:46 +02005370 }
5371
Gilles Peskine449bd832023-01-11 14:50:10 +01005372 while (output_length != 0) {
Janos Follath844eb0e2019-06-19 12:10:49 +01005373 /* Check if we have fully processed the current block. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005374 if (tls12_prf->left_in_block == 0) {
5375 status = psa_key_derivation_tls12_prf_generate_next_block(tls12_prf,
5376 alg);
5377 if (status != PSA_SUCCESS) {
5378 return status;
5379 }
Janos Follath844eb0e2019-06-19 12:10:49 +01005380
5381 continue;
5382 }
5383
Gilles Peskine449bd832023-01-11 14:50:10 +01005384 if (tls12_prf->left_in_block > output_length) {
Janos Follath844eb0e2019-06-19 12:10:49 +01005385 length = (uint8_t) output_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01005386 } else {
Janos Follath844eb0e2019-06-19 12:10:49 +01005387 length = tls12_prf->left_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005388 }
Janos Follath844eb0e2019-06-19 12:10:49 +01005389
5390 offset = hash_length - tls12_prf->left_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005391 memcpy(output, tls12_prf->output_block + offset, length);
Janos Follath844eb0e2019-06-19 12:10:49 +01005392 output += length;
5393 output_length -= length;
5394 tls12_prf->left_in_block -= length;
5395 }
5396
Gilles Peskine449bd832023-01-11 14:50:10 +01005397 return PSA_SUCCESS;
Janos Follath844eb0e2019-06-19 12:10:49 +01005398}
John Durkop07cc04a2020-11-16 22:08:34 -08005399#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
5400 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskinebef7f142018-07-12 17:22:21 +02005401
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005402#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
5403static psa_status_t psa_key_derivation_tls12_ecjpake_to_pms_read(
5404 psa_tls12_ecjpake_to_pms_t *ecjpake,
5405 uint8_t *output,
Gilles Peskine449bd832023-01-11 14:50:10 +01005406 size_t output_length)
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005407{
5408 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Andrzej Kurek5603efd2022-09-26 10:49:16 -04005409 size_t output_size = 0;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005410
Gilles Peskine449bd832023-01-11 14:50:10 +01005411 if (output_length != 32) {
5412 return PSA_ERROR_INVALID_ARGUMENT;
5413 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005414
Gilles Peskine449bd832023-01-11 14:50:10 +01005415 status = psa_hash_compute(PSA_ALG_SHA_256, ecjpake->data,
5416 PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE, output, output_length,
5417 &output_size);
5418 if (status != PSA_SUCCESS) {
5419 return status;
5420 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005421
Gilles Peskine449bd832023-01-11 14:50:10 +01005422 if (output_size != output_length) {
5423 return PSA_ERROR_GENERIC_ERROR;
5424 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005425
Gilles Peskine449bd832023-01-11 14:50:10 +01005426 return PSA_SUCCESS;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005427}
5428#endif
5429
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305430#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305431static psa_status_t psa_key_derivation_pbkdf2_generate_block(
5432 psa_pbkdf2_key_derivation_t *pbkdf2,
5433 psa_algorithm_t prf_alg,
5434 uint8_t prf_output_length,
5435 psa_key_attributes_t *attributes)
5436{
5437 psa_status_t status;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305438 psa_mac_operation_t mac_operation = PSA_MAC_OPERATION_INIT;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305439 size_t mac_output_length;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305440 uint8_t U_i[PSA_MAC_MAX_SIZE];
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305441 uint8_t *U_accumulator = pbkdf2->output_block;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305442 uint64_t i;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305443 uint8_t block_counter[4];
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305444
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305445 mac_operation.is_sign = 1;
5446 mac_operation.mac_size = prf_output_length;
5447 MBEDTLS_PUT_UINT32_BE(pbkdf2->block_number, block_counter, 0);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305448
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305449 status = psa_driver_wrapper_mac_sign_setup(&mac_operation,
5450 attributes,
5451 pbkdf2->password,
5452 pbkdf2->password_length,
5453 prf_alg);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305454 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305455 goto cleanup;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305456 }
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305457 status = psa_mac_update(&mac_operation, pbkdf2->salt, pbkdf2->salt_length);
5458 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305459 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305460 }
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305461 status = psa_mac_update(&mac_operation, block_counter, sizeof(block_counter));
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305462 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305463 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305464 }
5465 status = psa_mac_sign_finish(&mac_operation, U_i, sizeof(U_i),
5466 &mac_output_length);
5467 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305468 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305469 }
5470
5471 if (mac_output_length != prf_output_length) {
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305472 status = PSA_ERROR_CORRUPTION_DETECTED;
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305473 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305474 }
5475
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305476 memcpy(U_accumulator, U_i, prf_output_length);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305477
5478 for (i = 1; i < pbkdf2->input_cost; i++) {
Kusumit Ghoderao4536bb62023-06-22 15:42:59 +05305479 /* We are passing prf_output_length as mac_size because the driver
5480 * function directly sets mac_output_length as mac_size upon success.
Kusumit Ghoderao5f3345a2023-07-27 21:21:38 +05305481 * See https://github.com/Mbed-TLS/mbedtls/issues/7801 */
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305482 status = psa_driver_wrapper_mac_compute(attributes,
5483 pbkdf2->password,
5484 pbkdf2->password_length,
5485 prf_alg, U_i, prf_output_length,
Kusumit Ghoderao4536bb62023-06-22 15:42:59 +05305486 U_i, prf_output_length,
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305487 &mac_output_length);
5488 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305489 goto cleanup;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305490 }
5491
Kusumit Ghoderao109ee3d2023-06-08 16:36:45 +05305492 mbedtls_xor(U_accumulator, U_accumulator, U_i, prf_output_length);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305493 }
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305494
5495cleanup:
5496 /* Zeroise buffers to clear sensitive data from memory. */
5497 mbedtls_platform_zeroize(U_i, PSA_MAC_MAX_SIZE);
5498 return status;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305499}
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05305500
5501static psa_status_t psa_key_derivation_pbkdf2_read(
5502 psa_pbkdf2_key_derivation_t *pbkdf2,
5503 psa_algorithm_t kdf_alg,
5504 uint8_t *output,
5505 size_t output_length)
5506{
5507 psa_status_t status;
5508 psa_algorithm_t prf_alg;
5509 uint8_t prf_output_length;
5510 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
5511 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(pbkdf2->password_length));
5512 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
5513
5514 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
5515 prf_alg = PSA_ALG_HMAC(PSA_ALG_PBKDF2_HMAC_GET_HASH(kdf_alg));
5516 prf_output_length = PSA_HASH_LENGTH(prf_alg);
5517 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
Kusumit Ghoderaoa2520a52023-06-22 15:42:19 +05305518 } else if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
5519 prf_alg = PSA_ALG_CMAC;
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05305520 prf_output_length = PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC);
Kusumit Ghoderaoa2520a52023-06-22 15:42:19 +05305521 psa_set_key_type(&attributes, PSA_KEY_TYPE_AES);
Kusumit Ghoderaod9ec1af2023-06-08 20:19:51 +05305522 } else {
5523 return PSA_ERROR_INVALID_ARGUMENT;
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05305524 }
5525
5526 switch (pbkdf2->state) {
5527 case PSA_PBKDF2_STATE_PASSWORD_SET:
5528 /* Initially we need a new block so bytes_used is equal to block size*/
5529 pbkdf2->bytes_used = prf_output_length;
5530 pbkdf2->state = PSA_PBKDF2_STATE_OUTPUT;
5531 break;
5532 case PSA_PBKDF2_STATE_OUTPUT:
5533 break;
5534 default:
5535 return PSA_ERROR_BAD_STATE;
5536 }
5537
5538 while (output_length != 0) {
5539 uint8_t n = prf_output_length - pbkdf2->bytes_used;
5540 if (n > output_length) {
5541 n = (uint8_t) output_length;
5542 }
5543 memcpy(output, pbkdf2->output_block + pbkdf2->bytes_used, n);
5544 output += n;
5545 output_length -= n;
5546 pbkdf2->bytes_used += n;
5547
5548 if (output_length == 0) {
5549 break;
5550 }
5551
5552 /* We need a new block */
5553 pbkdf2->bytes_used = 0;
5554 pbkdf2->block_number++;
5555
5556 status = psa_key_derivation_pbkdf2_generate_block(pbkdf2, prf_alg,
5557 prf_output_length,
5558 &attributes);
5559 if (status != PSA_SUCCESS) {
5560 return status;
5561 }
5562 }
5563
5564 return PSA_SUCCESS;
5565}
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305566#endif /* PSA_HAVE_SOFT_PBKDF2 */
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305567
Janos Follath6c6c8fc2019-06-17 12:38:20 +01005568psa_status_t psa_key_derivation_output_bytes(
5569 psa_key_derivation_operation_t *operation,
5570 uint8_t *output,
Gilles Peskine449bd832023-01-11 14:50:10 +01005571 size_t output_length)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005572{
5573 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01005574 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
Gilles Peskineeab56e42018-07-12 17:12:33 +02005575
Gilles Peskine449bd832023-01-11 14:50:10 +01005576 if (operation->alg == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005577 /* This is a blank operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005578 return PSA_ERROR_BAD_STATE;
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005579 }
5580
Gilles Peskine449bd832023-01-11 14:50:10 +01005581 if (output_length > operation->capacity) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005582 operation->capacity = 0;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005583 /* Go through the error path to wipe all confidential data now
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005584 * that the operation object is useless. */
David Saadab4ecc272019-02-14 13:48:10 +02005585 status = PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005586 goto exit;
5587 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005588 if (output_length == 0 && operation->capacity == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005589 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005590 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02005591 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
5592 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005593 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02005594 * output_length > 0. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005595 return PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005596 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005597 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005598
Przemek Stekiel69c46792022-06-10 12:59:51 +02005599#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01005600 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
5601 status = psa_key_derivation_hkdf_read(&operation->ctx.hkdf, kdf_alg,
5602 output, output_length);
5603 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02005604#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08005605#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5606 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005607 if (PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
5608 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
5609 status = psa_key_derivation_tls12_prf_read(&operation->ctx.tls12_prf,
5610 kdf_alg, output,
5611 output_length);
5612 } else
John Durkop07cc04a2020-11-16 22:08:34 -08005613#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
5614 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005615#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005616 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005617 status = psa_key_derivation_tls12_ecjpake_to_pms_read(
Gilles Peskine449bd832023-01-11 14:50:10 +01005618 &operation->ctx.tls12_ecjpake_to_pms, output, output_length);
5619 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005620#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305621#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05305622 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05305623 status = psa_key_derivation_pbkdf2_read(&operation->ctx.pbkdf2, kdf_alg,
5624 output, output_length);
Kusumit Ghoderao056f0c52023-05-03 15:58:34 +05305625 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305626#endif /* PSA_HAVE_SOFT_PBKDF2 */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005627
Gilles Peskineeab56e42018-07-12 17:12:33 +02005628 {
Steven Cooreman74afe472021-02-10 17:19:22 +01005629 (void) kdf_alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01005630 return PSA_ERROR_BAD_STATE;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005631 }
5632
5633exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005634 if (status != PSA_SUCCESS) {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005635 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005636 * This allows us to differentiate between exhausted operations and
5637 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
5638 * operations. */
5639 psa_algorithm_t alg = operation->alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01005640 psa_key_derivation_abort(operation);
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005641 operation->alg = alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01005642 memset(output, '!', output_length);
Gilles Peskineeab56e42018-07-12 17:12:33 +02005643 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005644 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005645}
5646
David Brown7807bf72021-02-09 16:28:23 -07005647#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01005648static void psa_des_set_key_parity(uint8_t *data, size_t data_size)
Gilles Peskine08542d82018-07-19 17:05:42 +02005649{
Gilles Peskine449bd832023-01-11 14:50:10 +01005650 if (data_size >= 8) {
5651 mbedtls_des_key_set_parity(data);
5652 }
5653 if (data_size >= 16) {
5654 mbedtls_des_key_set_parity(data + 8);
5655 }
5656 if (data_size >= 24) {
5657 mbedtls_des_key_set_parity(data + 16);
5658 }
Gilles Peskine08542d82018-07-19 17:05:42 +02005659}
David Brown7807bf72021-02-09 16:28:23 -07005660#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine08542d82018-07-19 17:05:42 +02005661
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005662/*
Gilles Peskine449bd832023-01-11 14:50:10 +01005663 * ECC keys on a Weierstrass elliptic curve require the generation
5664 * of a private key which is an integer
5665 * in the range [1, N - 1], where N is the boundary of the private key domain:
5666 * N is the prime p for Diffie-Hellman, or the order of the
5667 * curve’s base point for ECC.
5668 *
5669 * Let m be the bit size of N, such that 2^m > N >= 2^(m-1).
5670 * This function generates the private key using the following process:
5671 *
5672 * 1. Draw a byte string of length ceiling(m/8) bytes.
5673 * 2. If m is not a multiple of 8, set the most significant
5674 * (8 * ceiling(m/8) - m) bits of the first byte in the string to zero.
5675 * 3. Convert the string to integer k by decoding it as a big-endian byte string.
5676 * 4. If k > N - 2, discard the result and return to step 1.
5677 * 5. Output k + 1 as the private key.
5678 *
5679 * This method allows compliance to NIST standards, specifically the methods titled
5680 * Key-Pair Generation by Testing Candidates in the following publications:
5681 * - NIST Special Publication 800-56A: Recommendation for Pair-Wise Key-Establishment
5682 * Schemes Using Discrete Logarithm Cryptography [SP800-56A] §5.6.1.1.4 for
5683 * Diffie-Hellman keys.
5684 *
5685 * - [SP800-56A] §5.6.1.2.2 or FIPS Publication 186-4: Digital Signature
5686 * Standard (DSS) [FIPS186-4] §B.4.2 for elliptic curve keys.
5687 *
5688 * Note: Function allocates memory for *data buffer, so given *data should be
5689 * always NULL.
5690 */
Valerio Setti86587ab2023-06-27 13:09:30 +02005691#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE)
5692#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE)
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01005693static psa_status_t psa_generate_derived_ecc_key_weierstrass_helper(
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005694 psa_key_slot_t *slot,
5695 size_t bits,
5696 psa_key_derivation_operation_t *operation,
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005697 uint8_t **data
5698 )
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005699{
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005700 unsigned key_out_of_range = 1;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005701 mbedtls_mpi k;
5702 mbedtls_mpi diff_N_2;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005703 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Przemek Stekiela81aed22022-03-01 15:13:30 +01005704 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01005705 size_t m;
5706 size_t m_bytes;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005707
Gilles Peskine449bd832023-01-11 14:50:10 +01005708 mbedtls_mpi_init(&k);
5709 mbedtls_mpi_init(&diff_N_2);
Przemyslaw Stekiel1dfd1222021-11-18 13:35:00 +01005710
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005711 psa_ecc_family_t curve = PSA_KEY_TYPE_ECC_GET_FAMILY(
Gilles Peskine449bd832023-01-11 14:50:10 +01005712 slot->attr.type);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005713 mbedtls_ecp_group_id grp_id =
Gilles Peskine449bd832023-01-11 14:50:10 +01005714 mbedtls_ecc_group_of_psa(curve, bits, 0);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005715
Gilles Peskine449bd832023-01-11 14:50:10 +01005716 if (grp_id == MBEDTLS_ECP_DP_NONE) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005717 ret = MBEDTLS_ERR_ASN1_INVALID_DATA;
Przemyslaw Stekiel871a3362021-12-02 08:46:39 +01005718 goto cleanup;
5719 }
5720
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005721 mbedtls_ecp_group ecp_group;
Gilles Peskine449bd832023-01-11 14:50:10 +01005722 mbedtls_ecp_group_init(&ecp_group);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005723
Gilles Peskine449bd832023-01-11 14:50:10 +01005724 MBEDTLS_MPI_CHK(mbedtls_ecp_group_load(&ecp_group, grp_id));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005725
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005726 /* N is the boundary of the private key domain (ecp_group.N). */
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005727 /* Let m be the bit size of N. */
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01005728 m = ecp_group.nbits;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005729
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01005730 m_bytes = PSA_BITS_TO_BYTES(m);
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005731
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005732 /* Calculate N - 2 - it will be needed later. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005733 MBEDTLS_MPI_CHK(mbedtls_mpi_sub_int(&diff_N_2, &ecp_group.N, 2));
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005734
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005735 /* Note: This function is always called with *data == NULL and it
5736 * allocates memory for the data buffer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005737 *data = mbedtls_calloc(1, m_bytes);
5738 if (*data == NULL) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005739 ret = MBEDTLS_ERR_ASN1_ALLOC_FAILED;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005740 goto cleanup;
5741 }
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005742
Gilles Peskine449bd832023-01-11 14:50:10 +01005743 while (key_out_of_range) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005744 /* 1. Draw a byte string of length ceiling(m/8) bytes. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005745 if ((status = psa_key_derivation_output_bytes(operation, *data, m_bytes)) != 0) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005746 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005747 }
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005748
5749 /* 2. If m is not a multiple of 8 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005750 if (m % 8 != 0) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005751 /* Set the most significant
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005752 * (8 * ceiling(m/8) - m) bits of the first byte in
5753 * the string to zero.
5754 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005755 uint8_t clear_bit_mask = (1 << (m % 8)) - 1;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005756 (*data)[0] &= clear_bit_mask;
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005757 }
5758
5759 /* 3. Convert the string to integer k by decoding it as a
Gilles Peskine449bd832023-01-11 14:50:10 +01005760 * big-endian byte string.
5761 */
5762 MBEDTLS_MPI_CHK(mbedtls_mpi_read_binary(&k, *data, m_bytes));
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005763
5764 /* 4. If k > N - 2, discard the result and return to step 1.
Gilles Peskine449bd832023-01-11 14:50:10 +01005765 * Result of comparison is returned. When it indicates error
5766 * then this function is called again.
5767 */
5768 MBEDTLS_MPI_CHK(mbedtls_mpi_lt_mpi_ct(&diff_N_2, &k, &key_out_of_range));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005769 }
5770
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005771 /* 5. Output k + 1 as the private key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005772 MBEDTLS_MPI_CHK(mbedtls_mpi_add_int(&k, &k, 1));
5773 MBEDTLS_MPI_CHK(mbedtls_mpi_write_binary(&k, *data, m_bytes));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005774cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01005775 if (ret != 0) {
5776 status = mbedtls_to_psa_error(ret);
5777 }
5778 if (status != PSA_SUCCESS) {
5779 mbedtls_free(*data);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005780 *data = NULL;
5781 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005782 mbedtls_mpi_free(&k);
5783 mbedtls_mpi_free(&diff_N_2);
5784 return status;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005785}
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005786
5787/* ECC keys on a Montgomery elliptic curve draws a byte string whose length
5788 * is determined by the curve, and sets the mandatory bits accordingly. That is:
5789 *
5790 * - Curve25519 (PSA_ECC_FAMILY_MONTGOMERY, 255 bits):
5791 * draw a 32-byte string and process it as specified in
5792 * Elliptic Curves for Security [RFC7748] §5.
5793 *
5794 * - Curve448 (PSA_ECC_FAMILY_MONTGOMERY, 448 bits):
5795 * draw a 56-byte string and process it as specified in [RFC7748] §5.
5796 *
5797 * Note: Function allocates memory for *data buffer, so given *data should be
5798 * always NULL.
5799 */
5800
5801static psa_status_t psa_generate_derived_ecc_key_montgomery_helper(
5802 size_t bits,
5803 psa_key_derivation_operation_t *operation,
5804 uint8_t **data
5805 )
5806{
5807 size_t output_length;
Przemek Stekiela81aed22022-03-01 15:13:30 +01005808 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005809
Gilles Peskine449bd832023-01-11 14:50:10 +01005810 switch (bits) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005811 case 255:
5812 output_length = 32;
5813 break;
5814 case 448:
5815 output_length = 56;
5816 break;
5817 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005818 return PSA_ERROR_INVALID_ARGUMENT;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005819 break;
5820 }
5821
Gilles Peskine449bd832023-01-11 14:50:10 +01005822 *data = mbedtls_calloc(1, output_length);
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005823
Gilles Peskine449bd832023-01-11 14:50:10 +01005824 if (*data == NULL) {
5825 return PSA_ERROR_INSUFFICIENT_MEMORY;
5826 }
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005827
Gilles Peskine449bd832023-01-11 14:50:10 +01005828 status = psa_key_derivation_output_bytes(operation, *data, output_length);
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005829
Gilles Peskine449bd832023-01-11 14:50:10 +01005830 if (status != PSA_SUCCESS) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005831 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01005832 }
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005833
Gilles Peskine449bd832023-01-11 14:50:10 +01005834 switch (bits) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005835 case 255:
5836 (*data)[0] &= 248;
5837 (*data)[31] &= 127;
5838 (*data)[31] |= 64;
5839 break;
5840 case 448:
5841 (*data)[0] &= 252;
5842 (*data)[55] |= 128;
5843 break;
5844 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005845 return PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005846 break;
5847 }
5848
5849 return status;
5850}
Valerio Setti86587ab2023-06-27 13:09:30 +02005851#else /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE */
5852static psa_status_t psa_generate_derived_ecc_key_weierstrass_helper(
5853 psa_key_slot_t *slot, size_t bits,
5854 psa_key_derivation_operation_t *operation, uint8_t **data)
5855{
5856 (void) slot;
5857 (void) bits;
5858 (void) operation;
5859 (void) data;
5860 return PSA_ERROR_NOT_SUPPORTED;
5861}
5862
5863static psa_status_t psa_generate_derived_ecc_key_montgomery_helper(
5864 size_t bits, psa_key_derivation_operation_t *operation, uint8_t **data)
5865{
5866 (void) bits;
5867 (void) operation;
5868 (void) data;
5869 return PSA_ERROR_NOT_SUPPORTED;
5870}
5871#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE */
5872#endif /* PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE */
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005873
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01005874static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005875 psa_key_slot_t *slot,
5876 size_t bits,
Gilles Peskine449bd832023-01-11 14:50:10 +01005877 psa_key_derivation_operation_t *operation)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005878{
5879 uint8_t *data = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01005880 size_t bytes = PSA_BITS_TO_BYTES(bits);
Archanad8a83dc2021-06-14 10:04:16 +05305881 size_t storage_size = bytes;
Przemek Stekiela81aed22022-03-01 15:13:30 +01005882 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01005883 psa_key_attributes_t attributes;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005884
Gilles Peskine449bd832023-01-11 14:50:10 +01005885 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(slot->attr.type)) {
5886 return PSA_ERROR_INVALID_ARGUMENT;
5887 }
Gilles Peskineeab56e42018-07-12 17:12:33 +02005888
Valerio Setti8ffdb5d2023-06-20 13:14:08 +02005889#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE) || \
Valerio Settidd24f292023-06-26 12:21:17 +02005890 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE)
Gilles Peskine449bd832023-01-11 14:50:10 +01005891 if (PSA_KEY_TYPE_IS_ECC(slot->attr.type)) {
5892 psa_ecc_family_t curve = PSA_KEY_TYPE_ECC_GET_FAMILY(slot->attr.type);
5893 if (PSA_ECC_FAMILY_IS_WEIERSTRASS(curve)) {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01005894 /* Weierstrass elliptic curve */
Gilles Peskine449bd832023-01-11 14:50:10 +01005895 status = psa_generate_derived_ecc_key_weierstrass_helper(slot, bits, operation, &data);
5896 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005897 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005898 }
5899 } else {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01005900 /* Montgomery elliptic curve */
Gilles Peskine449bd832023-01-11 14:50:10 +01005901 status = psa_generate_derived_ecc_key_montgomery_helper(bits, operation, &data);
5902 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01005903 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005904 }
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01005905 }
Przemyslaw Stekiel1dfd1222021-11-18 13:35:00 +01005906 } else
Valerio Setti8ffdb5d2023-06-20 13:14:08 +02005907#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE) ||
Valerio Settidd24f292023-06-26 12:21:17 +02005908 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE) */
Gilles Peskine449bd832023-01-11 14:50:10 +01005909 if (key_type_is_raw_bytes(slot->attr.type)) {
5910 if (bits % 8 != 0) {
5911 return PSA_ERROR_INVALID_ARGUMENT;
5912 }
5913 data = mbedtls_calloc(1, bytes);
5914 if (data == NULL) {
5915 return PSA_ERROR_INSUFFICIENT_MEMORY;
5916 }
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01005917
Gilles Peskine449bd832023-01-11 14:50:10 +01005918 status = psa_key_derivation_output_bytes(operation, data, bytes);
5919 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01005920 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005921 }
David Brown12ca5032021-02-11 11:02:00 -07005922#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01005923 if (slot->attr.type == PSA_KEY_TYPE_DES) {
5924 psa_des_set_key_parity(data, bytes);
5925 }
Przemek Stekielf110dc02022-03-01 14:48:05 +01005926#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES) */
Gilles Peskine449bd832023-01-11 14:50:10 +01005927 } else {
5928 return PSA_ERROR_NOT_SUPPORTED;
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01005929 }
Ronald Crondd04d422020-11-28 15:14:42 +01005930
Ronald Cronbf33c932020-11-28 18:06:53 +01005931 slot->attr.bits = (psa_key_bits_t) bits;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01005932 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01005933 .core = slot->attr
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01005934 };
5935
Gilles Peskine449bd832023-01-11 14:50:10 +01005936 if (psa_key_lifetime_is_external(attributes.core.lifetime)) {
5937 status = psa_driver_wrapper_get_key_buffer_size(&attributes,
5938 &storage_size);
5939 if (status != PSA_SUCCESS) {
Archanad8a83dc2021-06-14 10:04:16 +05305940 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005941 }
Archanad8a83dc2021-06-14 10:04:16 +05305942 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005943 status = psa_allocate_buffer_to_slot(slot, storage_size);
5944 if (status != PSA_SUCCESS) {
Archanad8a83dc2021-06-14 10:04:16 +05305945 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005946 }
Archanad8a83dc2021-06-14 10:04:16 +05305947
Gilles Peskine449bd832023-01-11 14:50:10 +01005948 status = psa_driver_wrapper_import_key(&attributes,
5949 data, bytes,
5950 slot->key.data,
5951 slot->key.bytes,
5952 &slot->key.bytes, &bits);
5953 if (bits != slot->attr.bits) {
Ronald Cronbf33c932020-11-28 18:06:53 +01005954 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine449bd832023-01-11 14:50:10 +01005955 }
Gilles Peskineeab56e42018-07-12 17:12:33 +02005956
5957exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005958 mbedtls_free(data);
5959 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005960}
5961
Gilles Peskine449bd832023-01-11 14:50:10 +01005962psa_status_t psa_key_derivation_output_key(const psa_key_attributes_t *attributes,
5963 psa_key_derivation_operation_t *operation,
5964 mbedtls_svc_key_id_t *key)
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005965{
5966 psa_status_t status;
5967 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02005968 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine0f84d622019-09-12 19:03:13 +02005969
Ronald Cron81709fc2020-11-14 12:10:32 +01005970 *key = MBEDTLS_SVC_KEY_ID_INIT;
5971
Gilles Peskine0f84d622019-09-12 19:03:13 +02005972 /* Reject any attempt to create a zero-length key so that we don't
5973 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005974 if (psa_get_key_bits(attributes) == 0) {
5975 return PSA_ERROR_INVALID_ARGUMENT;
5976 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02005977
Gilles Peskine449bd832023-01-11 14:50:10 +01005978 if (operation->alg == PSA_ALG_NONE) {
5979 return PSA_ERROR_BAD_STATE;
5980 }
Dave Rodgmand69da6c2021-11-16 10:32:48 +00005981
Gilles Peskine449bd832023-01-11 14:50:10 +01005982 if (!operation->can_output_key) {
5983 return PSA_ERROR_NOT_PERMITTED;
5984 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02005985
Gilles Peskine449bd832023-01-11 14:50:10 +01005986 status = psa_start_key_creation(PSA_KEY_CREATION_DERIVE, attributes,
5987 &slot, &driver);
Gilles Peskinef4ee6622019-07-24 13:44:30 +02005988#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005989 if (driver != NULL) {
Gilles Peskinef4ee6622019-07-24 13:44:30 +02005990 /* Deriving a key in a secure element is not implemented yet. */
5991 status = PSA_ERROR_NOT_SUPPORTED;
5992 }
5993#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine449bd832023-01-11 14:50:10 +01005994 if (status == PSA_SUCCESS) {
5995 status = psa_generate_derived_key_internal(slot,
5996 attributes->core.bits,
5997 operation);
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005998 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005999 if (status == PSA_SUCCESS) {
6000 status = psa_finish_key_creation(slot, driver, key);
6001 }
6002 if (status != PSA_SUCCESS) {
6003 psa_fail_key_creation(slot, driver);
6004 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02006005
Gilles Peskine449bd832023-01-11 14:50:10 +01006006 return status;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006007}
6008
Gilles Peskineeab56e42018-07-12 17:12:33 +02006009
6010
6011/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02006012/* Key derivation */
6013/****************************************************************/
6014
Steven Cooreman932ffb72021-02-15 12:14:32 +01006015#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006016static int is_kdf_alg_supported(psa_algorithm_t kdf_alg)
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006017{
6018#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006019 if (PSA_ALG_IS_HKDF(kdf_alg)) {
6020 return 1;
6021 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006022#endif
Przemek Stekielb57a44b2022-06-06 08:33:45 +02006023#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006024 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6025 return 1;
6026 }
Przemek Stekielb57a44b2022-06-06 08:33:45 +02006027#endif
6028#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006029 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
6030 return 1;
6031 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006032#endif
6033#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006034 if (PSA_ALG_IS_TLS12_PRF(kdf_alg)) {
6035 return 1;
6036 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006037#endif
6038#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006039 if (PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
6040 return 1;
6041 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006042#endif
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006043#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006044 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
6045 return 1;
6046 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006047#endif
Kusumit Ghoderaod132cac2023-05-03 12:00:27 +05306048#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
6049 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
6050 return 1;
6051 }
6052#endif
Kusumit Ghoderao2cd64962023-06-22 15:38:57 +05306053#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128)
6054 if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
6055 return 1;
6056 }
6057#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006058 return 0;
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006059}
6060
Gilles Peskine449bd832023-01-11 14:50:10 +01006061static psa_status_t psa_hash_try_support(psa_algorithm_t alg)
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006062{
6063 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01006064 psa_status_t status = psa_hash_setup(&operation, alg);
6065 psa_hash_abort(&operation);
6066 return status;
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006067}
6068
Gilles Peskine969c5d62019-01-16 15:53:06 +01006069static psa_status_t psa_key_derivation_setup_kdf(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006070 psa_key_derivation_operation_t *operation,
Gilles Peskine449bd832023-01-11 14:50:10 +01006071 psa_algorithm_t kdf_alg)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006072{
Janos Follath5fe19732019-06-20 15:09:30 +01006073 /* Make sure that operation->ctx is properly zero-initialised. (Macro
6074 * initialisers for this union leave some bytes unspecified.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01006075 memset(&operation->ctx, 0, sizeof(operation->ctx));
Janos Follath5fe19732019-06-20 15:09:30 +01006076
Gilles Peskine969c5d62019-01-16 15:53:06 +01006077 /* Make sure that kdf_alg is a supported key derivation algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006078 if (!is_kdf_alg_supported(kdf_alg)) {
6079 return PSA_ERROR_NOT_SUPPORTED;
6080 }
John Durkop07cc04a2020-11-16 22:08:34 -08006081
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006082 /* All currently supported key derivation algorithms (apart from
Kusumit Ghoderao2cd64962023-06-22 15:38:57 +05306083 * ecjpake to pms and pbkdf2_aes_cmac_128) are based on a hash algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006084 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
6085 size_t hash_size = PSA_HASH_LENGTH(hash_alg);
Kusumit Ghoderao2cd64962023-06-22 15:38:57 +05306086 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
6087 hash_size = PSA_HASH_LENGTH(PSA_ALG_SHA_256);
6088 } else if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306089 hash_size = PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC);
Kusumit Ghoderao2cd64962023-06-22 15:38:57 +05306090 } else {
Gilles Peskine449bd832023-01-11 14:50:10 +01006091 if (hash_size == 0) {
6092 return PSA_ERROR_NOT_SUPPORTED;
6093 }
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006094
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006095 /* Make sure that hash_alg is a supported hash algorithm. Otherwise
6096 * we might fail later, which is somewhat unfriendly and potentially
6097 * risk-prone. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006098 psa_status_t status = psa_hash_try_support(hash_alg);
6099 if (status != PSA_SUCCESS) {
6100 return status;
6101 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006102 }
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006103
Gilles Peskine449bd832023-01-11 14:50:10 +01006104 if ((PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
6105 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) &&
6106 !(hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384)) {
6107 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006108 }
Andrzej Kurek77638292022-09-16 12:24:52 -04006109#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT) || \
Andrzej Kurekb510cd22022-09-26 10:50:22 -04006110 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006111 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg) ||
6112 (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS)) {
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006113 operation->capacity = hash_size;
Gilles Peskine449bd832023-01-11 14:50:10 +01006114 } else
Andrzej Kurekb510cd22022-09-26 10:50:22 -04006115#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT ||
6116 MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Gilles Peskine449bd832023-01-11 14:50:10 +01006117 operation->capacity = 255 * hash_size;
6118 return PSA_SUCCESS;
Gilles Peskine969c5d62019-01-16 15:53:06 +01006119}
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006120
Gilles Peskine449bd832023-01-11 14:50:10 +01006121static psa_status_t psa_key_agreement_try_support(psa_algorithm_t alg)
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006122{
6123#if defined(PSA_WANT_ALG_ECDH)
Gilles Peskine449bd832023-01-11 14:50:10 +01006124 if (alg == PSA_ALG_ECDH) {
6125 return PSA_SUCCESS;
6126 }
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006127#endif
Przemek Stekielfb3dd542022-12-01 14:59:15 +01006128#if defined(PSA_WANT_ALG_FFDH)
6129 if (alg == PSA_ALG_FFDH) {
6130 return PSA_SUCCESS;
6131 }
6132#endif
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006133 (void) alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01006134 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006135}
Gilles Peskinebb3814c2022-12-16 01:12:12 +01006136
6137static int psa_key_derivation_allows_free_form_secret_input(
6138 psa_algorithm_t kdf_alg)
6139{
6140#if defined(PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS)
6141 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
6142 return 0;
6143 }
6144#endif
6145 (void) kdf_alg;
6146 return 1;
6147}
John Durkop07cc04a2020-11-16 22:08:34 -08006148#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01006149
Gilles Peskine449bd832023-01-11 14:50:10 +01006150psa_status_t psa_key_derivation_setup(psa_key_derivation_operation_t *operation,
6151 psa_algorithm_t alg)
Gilles Peskine969c5d62019-01-16 15:53:06 +01006152{
6153 psa_status_t status;
6154
Gilles Peskine449bd832023-01-11 14:50:10 +01006155 if (operation->alg != 0) {
6156 return PSA_ERROR_BAD_STATE;
Gilles Peskine969c5d62019-01-16 15:53:06 +01006157 }
Gilles Peskine969c5d62019-01-16 15:53:06 +01006158
Gilles Peskine449bd832023-01-11 14:50:10 +01006159 if (PSA_ALG_IS_RAW_KEY_AGREEMENT(alg)) {
6160 return PSA_ERROR_INVALID_ARGUMENT;
6161 } else if (PSA_ALG_IS_KEY_AGREEMENT(alg)) {
6162#if defined(AT_LEAST_ONE_BUILTIN_KDF)
6163 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF(alg);
6164 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE(alg);
6165 status = psa_key_agreement_try_support(ka_alg);
6166 if (status != PSA_SUCCESS) {
6167 return status;
6168 }
Gilles Peskinebb3814c2022-12-16 01:12:12 +01006169 if (!psa_key_derivation_allows_free_form_secret_input(kdf_alg)) {
6170 return PSA_ERROR_INVALID_ARGUMENT;
6171 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006172 status = psa_key_derivation_setup_kdf(operation, kdf_alg);
6173#else
6174 return PSA_ERROR_NOT_SUPPORTED;
6175#endif /* AT_LEAST_ONE_BUILTIN_KDF */
6176 } else if (PSA_ALG_IS_KEY_DERIVATION(alg)) {
6177#if defined(AT_LEAST_ONE_BUILTIN_KDF)
6178 status = psa_key_derivation_setup_kdf(operation, alg);
6179#else
6180 return PSA_ERROR_NOT_SUPPORTED;
6181#endif /* AT_LEAST_ONE_BUILTIN_KDF */
6182 } else {
6183 return PSA_ERROR_INVALID_ARGUMENT;
6184 }
6185
6186 if (status == PSA_SUCCESS) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006187 operation->alg = alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01006188 }
6189 return status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006190}
6191
Przemek Stekiel69c46792022-06-10 12:59:51 +02006192#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006193static psa_status_t psa_hkdf_input(psa_hkdf_key_derivation_t *hkdf,
6194 psa_algorithm_t kdf_alg,
6195 psa_key_derivation_step_t step,
6196 const uint8_t *data,
6197 size_t data_length)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006198{
Gilles Peskine449bd832023-01-11 14:50:10 +01006199 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006200 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006201 switch (step) {
Gilles Peskine03410b52019-05-16 16:05:19 +02006202 case PSA_KEY_DERIVATION_INPUT_SALT:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006203#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006204 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
6205 return PSA_ERROR_INVALID_ARGUMENT;
6206 }
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006207#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND */
Gilles Peskine449bd832023-01-11 14:50:10 +01006208 if (hkdf->state != HKDF_STATE_INIT) {
6209 return PSA_ERROR_BAD_STATE;
6210 } else {
6211 status = psa_key_derivation_start_hmac(&hkdf->hmac,
6212 hash_alg,
6213 data, data_length);
6214 if (status != PSA_SUCCESS) {
6215 return status;
6216 }
Steven Cooremand1ed1d92021-04-29 19:11:25 +02006217 hkdf->state = HKDF_STATE_STARTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01006218 return PSA_SUCCESS;
Steven Cooremand1ed1d92021-04-29 19:11:25 +02006219 }
Gilles Peskine03410b52019-05-16 16:05:19 +02006220 case PSA_KEY_DERIVATION_INPUT_SECRET:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006221#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006222 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
Przemek Stekiel2fb0dcd2022-05-19 10:34:37 +02006223 /* We shouldn't be in different state as HKDF_EXPAND only allows
6224 * two inputs: SECRET (this case) and INFO which does not modify
6225 * the state. It could happen only if the hkdf
6226 * object was corrupted. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006227 if (hkdf->state != HKDF_STATE_INIT) {
6228 return PSA_ERROR_BAD_STATE;
6229 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006230
Przemek Stekiel2fb0dcd2022-05-19 10:34:37 +02006231 /* Allow only input that fits expected prk size */
Gilles Peskine449bd832023-01-11 14:50:10 +01006232 if (data_length != PSA_HASH_LENGTH(hash_alg)) {
6233 return PSA_ERROR_INVALID_ARGUMENT;
6234 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006235
Gilles Peskine449bd832023-01-11 14:50:10 +01006236 memcpy(hkdf->prk, data, data_length);
6237 } else
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006238#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND */
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006239 {
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006240 /* HKDF: If no salt was provided, use an empty salt.
6241 * HKDF-EXTRACT: salt is mandatory. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006242 if (hkdf->state == HKDF_STATE_INIT) {
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006243#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006244 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6245 return PSA_ERROR_BAD_STATE;
6246 }
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006247#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01006248 status = psa_key_derivation_start_hmac(&hkdf->hmac,
6249 hash_alg,
6250 NULL, 0);
6251 if (status != PSA_SUCCESS) {
6252 return status;
6253 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006254 hkdf->state = HKDF_STATE_STARTED;
6255 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006256 if (hkdf->state != HKDF_STATE_STARTED) {
6257 return PSA_ERROR_BAD_STATE;
6258 }
6259 status = psa_mac_update(&hkdf->hmac,
6260 data, data_length);
6261 if (status != PSA_SUCCESS) {
6262 return status;
6263 }
6264 status = psa_mac_sign_finish(&hkdf->hmac,
6265 hkdf->prk,
6266 sizeof(hkdf->prk),
6267 &data_length);
6268 if (status != PSA_SUCCESS) {
6269 return status;
6270 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006271 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006272
Gilles Peskine2b522db2019-04-12 15:11:49 +02006273 hkdf->state = HKDF_STATE_KEYED;
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006274 hkdf->block_number = 0;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006275#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006276 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006277 /* The only block of output is the PRK. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006278 memcpy(hkdf->output_block, hkdf->prk, PSA_HASH_LENGTH(hash_alg));
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006279 hkdf->offset_in_block = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01006280 } else
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006281#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006282 {
6283 /* Block 0 is empty, and the next block will be
6284 * generated by psa_key_derivation_hkdf_read(). */
Gilles Peskine449bd832023-01-11 14:50:10 +01006285 hkdf->offset_in_block = PSA_HASH_LENGTH(hash_alg);
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006286 }
6287
Gilles Peskine449bd832023-01-11 14:50:10 +01006288 return PSA_SUCCESS;
Gilles Peskine03410b52019-05-16 16:05:19 +02006289 case PSA_KEY_DERIVATION_INPUT_INFO:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006290#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006291 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6292 return PSA_ERROR_INVALID_ARGUMENT;
6293 }
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006294#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Przemek Stekielcde3f782022-06-03 16:12:27 +02006295#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006296 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg) &&
6297 hkdf->state == HKDF_STATE_INIT) {
6298 return PSA_ERROR_BAD_STATE;
6299 }
Przemek Stekielcde3f782022-06-03 16:12:27 +02006300#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01006301 if (hkdf->state == HKDF_STATE_OUTPUT) {
6302 return PSA_ERROR_BAD_STATE;
6303 }
6304 if (hkdf->info_set) {
6305 return PSA_ERROR_BAD_STATE;
6306 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006307 hkdf->info_length = data_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01006308 if (data_length != 0) {
6309 hkdf->info = mbedtls_calloc(1, data_length);
6310 if (hkdf->info == NULL) {
6311 return PSA_ERROR_INSUFFICIENT_MEMORY;
6312 }
6313 memcpy(hkdf->info, data, data_length);
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006314 }
6315 hkdf->info_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01006316 return PSA_SUCCESS;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006317 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006318 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006319 }
6320}
Przemek Stekiel69c46792022-06-10 12:59:51 +02006321#endif /* BUILTIN_ALG_ANY_HKDF */
Janos Follathb03233e2019-06-11 15:30:30 +01006322
John Durkop07cc04a2020-11-16 22:08:34 -08006323#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
6324 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006325static psa_status_t psa_tls12_prf_set_seed(psa_tls12_prf_key_derivation_t *prf,
6326 const uint8_t *data,
6327 size_t data_length)
Janos Follathf08e2652019-06-13 09:05:41 +01006328{
Gilles Peskine449bd832023-01-11 14:50:10 +01006329 if (prf->state != PSA_TLS12_PRF_STATE_INIT) {
6330 return PSA_ERROR_BAD_STATE;
6331 }
Janos Follathf08e2652019-06-13 09:05:41 +01006332
Gilles Peskine449bd832023-01-11 14:50:10 +01006333 if (data_length != 0) {
6334 prf->seed = mbedtls_calloc(1, data_length);
6335 if (prf->seed == NULL) {
6336 return PSA_ERROR_INSUFFICIENT_MEMORY;
6337 }
Janos Follathf08e2652019-06-13 09:05:41 +01006338
Gilles Peskine449bd832023-01-11 14:50:10 +01006339 memcpy(prf->seed, data, data_length);
Janos Follathd6dce9f2019-07-04 09:11:38 +01006340 prf->seed_length = data_length;
6341 }
Janos Follathf08e2652019-06-13 09:05:41 +01006342
Gilles Peskine43f958b2020-12-13 14:55:14 +01006343 prf->state = PSA_TLS12_PRF_STATE_SEED_SET;
Janos Follathf08e2652019-06-13 09:05:41 +01006344
Gilles Peskine449bd832023-01-11 14:50:10 +01006345 return PSA_SUCCESS;
Janos Follathf08e2652019-06-13 09:05:41 +01006346}
6347
Gilles Peskine449bd832023-01-11 14:50:10 +01006348static psa_status_t psa_tls12_prf_set_key(psa_tls12_prf_key_derivation_t *prf,
6349 const uint8_t *data,
6350 size_t data_length)
Janos Follath81550542019-06-13 14:26:34 +01006351{
Gilles Peskine449bd832023-01-11 14:50:10 +01006352 if (prf->state != PSA_TLS12_PRF_STATE_SEED_SET &&
6353 prf->state != PSA_TLS12_PRF_STATE_OTHER_KEY_SET) {
6354 return PSA_ERROR_BAD_STATE;
6355 }
Janos Follath81550542019-06-13 14:26:34 +01006356
Gilles Peskine449bd832023-01-11 14:50:10 +01006357 if (data_length != 0) {
6358 prf->secret = mbedtls_calloc(1, data_length);
6359 if (prf->secret == NULL) {
6360 return PSA_ERROR_INSUFFICIENT_MEMORY;
6361 }
Steven Cooremana6df6042021-04-29 19:32:25 +02006362
Gilles Peskine449bd832023-01-11 14:50:10 +01006363 memcpy(prf->secret, data, data_length);
Steven Cooremana6df6042021-04-29 19:32:25 +02006364 prf->secret_length = data_length;
6365 }
Janos Follath81550542019-06-13 14:26:34 +01006366
Gilles Peskine43f958b2020-12-13 14:55:14 +01006367 prf->state = PSA_TLS12_PRF_STATE_KEY_SET;
Janos Follath81550542019-06-13 14:26:34 +01006368
Gilles Peskine449bd832023-01-11 14:50:10 +01006369 return PSA_SUCCESS;
Janos Follath81550542019-06-13 14:26:34 +01006370}
6371
Gilles Peskine449bd832023-01-11 14:50:10 +01006372static psa_status_t psa_tls12_prf_set_label(psa_tls12_prf_key_derivation_t *prf,
6373 const uint8_t *data,
6374 size_t data_length)
Janos Follath63028dd2019-06-13 09:15:47 +01006375{
Gilles Peskine449bd832023-01-11 14:50:10 +01006376 if (prf->state != PSA_TLS12_PRF_STATE_KEY_SET) {
6377 return PSA_ERROR_BAD_STATE;
6378 }
Janos Follath63028dd2019-06-13 09:15:47 +01006379
Gilles Peskine449bd832023-01-11 14:50:10 +01006380 if (data_length != 0) {
6381 prf->label = mbedtls_calloc(1, data_length);
6382 if (prf->label == NULL) {
6383 return PSA_ERROR_INSUFFICIENT_MEMORY;
6384 }
Janos Follath63028dd2019-06-13 09:15:47 +01006385
Gilles Peskine449bd832023-01-11 14:50:10 +01006386 memcpy(prf->label, data, data_length);
Janos Follathd6dce9f2019-07-04 09:11:38 +01006387 prf->label_length = data_length;
6388 }
Janos Follath63028dd2019-06-13 09:15:47 +01006389
Gilles Peskine43f958b2020-12-13 14:55:14 +01006390 prf->state = PSA_TLS12_PRF_STATE_LABEL_SET;
Janos Follath63028dd2019-06-13 09:15:47 +01006391
Gilles Peskine449bd832023-01-11 14:50:10 +01006392 return PSA_SUCCESS;
Janos Follath63028dd2019-06-13 09:15:47 +01006393}
6394
Gilles Peskine449bd832023-01-11 14:50:10 +01006395static psa_status_t psa_tls12_prf_input(psa_tls12_prf_key_derivation_t *prf,
6396 psa_key_derivation_step_t step,
6397 const uint8_t *data,
6398 size_t data_length)
Janos Follathb03233e2019-06-11 15:30:30 +01006399{
Gilles Peskine449bd832023-01-11 14:50:10 +01006400 switch (step) {
Janos Follathf08e2652019-06-13 09:05:41 +01006401 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskine449bd832023-01-11 14:50:10 +01006402 return psa_tls12_prf_set_seed(prf, data, data_length);
Janos Follath81550542019-06-13 14:26:34 +01006403 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006404 return psa_tls12_prf_set_key(prf, data, data_length);
Janos Follath63028dd2019-06-13 09:15:47 +01006405 case PSA_KEY_DERIVATION_INPUT_LABEL:
Gilles Peskine449bd832023-01-11 14:50:10 +01006406 return psa_tls12_prf_set_label(prf, data, data_length);
Janos Follathb03233e2019-06-11 15:30:30 +01006407 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006408 return PSA_ERROR_INVALID_ARGUMENT;
Janos Follathb03233e2019-06-11 15:30:30 +01006409 }
6410}
John Durkop07cc04a2020-11-16 22:08:34 -08006411#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
6412 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
6413
6414#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
6415static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
6416 psa_tls12_prf_key_derivation_t *prf,
John Durkop07cc04a2020-11-16 22:08:34 -08006417 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006418 size_t data_length)
John Durkop07cc04a2020-11-16 22:08:34 -08006419{
6420 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006421 const size_t pms_len = (prf->state == PSA_TLS12_PRF_STATE_OTHER_KEY_SET ?
6422 4 + data_length + prf->other_secret_length :
6423 4 + 2 * data_length);
John Durkop07cc04a2020-11-16 22:08:34 -08006424
Gilles Peskine449bd832023-01-11 14:50:10 +01006425 if (data_length > PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE) {
6426 return PSA_ERROR_INVALID_ARGUMENT;
6427 }
John Durkop07cc04a2020-11-16 22:08:34 -08006428
Gilles Peskine449bd832023-01-11 14:50:10 +01006429 uint8_t *pms = mbedtls_calloc(1, pms_len);
6430 if (pms == NULL) {
6431 return PSA_ERROR_INSUFFICIENT_MEMORY;
6432 }
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02006433 uint8_t *cur = pms;
6434
6435 /* pure-PSK:
6436 * Quoting RFC 4279, Section 2:
John Durkop07cc04a2020-11-16 22:08:34 -08006437 *
6438 * The premaster secret is formed as follows: if the PSK is N octets
6439 * long, concatenate a uint16 with the value N, N zero octets, a second
6440 * uint16 with the value N, and the PSK itself.
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02006441 *
6442 * mixed-PSK:
6443 * In a DHE-PSK, RSA-PSK, ECDHE-PSK the premaster secret is formed as
6444 * follows: concatenate a uint16 with the length of the other secret,
6445 * the other secret itself, uint16 with the length of PSK, and the
6446 * PSK itself.
6447 * For details please check:
6448 * - RFC 4279, Section 4 for the definition of RSA-PSK,
6449 * - RFC 4279, Section 3 for the definition of DHE-PSK,
6450 * - RFC 5489 for the definition of ECDHE-PSK.
John Durkop07cc04a2020-11-16 22:08:34 -08006451 */
6452
Gilles Peskine449bd832023-01-11 14:50:10 +01006453 if (prf->state == PSA_TLS12_PRF_STATE_OTHER_KEY_SET) {
6454 *cur++ = MBEDTLS_BYTE_1(prf->other_secret_length);
6455 *cur++ = MBEDTLS_BYTE_0(prf->other_secret_length);
6456 if (prf->other_secret_length != 0) {
6457 memcpy(cur, prf->other_secret, prf->other_secret_length);
6458 mbedtls_platform_zeroize(prf->other_secret, prf->other_secret_length);
Przemek Stekiel2503f7e2022-04-12 12:08:01 +02006459 cur += prf->other_secret_length;
6460 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006461 } else {
6462 *cur++ = MBEDTLS_BYTE_1(data_length);
6463 *cur++ = MBEDTLS_BYTE_0(data_length);
6464 memset(cur, 0, data_length);
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02006465 cur += data_length;
6466 }
6467
Gilles Peskine449bd832023-01-11 14:50:10 +01006468 *cur++ = MBEDTLS_BYTE_1(data_length);
6469 *cur++ = MBEDTLS_BYTE_0(data_length);
6470 memcpy(cur, data, data_length);
John Durkop07cc04a2020-11-16 22:08:34 -08006471 cur += data_length;
6472
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00006473 status = psa_tls12_prf_set_key(prf, pms, (size_t) (cur - pms));
John Durkop07cc04a2020-11-16 22:08:34 -08006474
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01006475 mbedtls_zeroize_and_free(pms, pms_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01006476 return status;
John Durkop07cc04a2020-11-16 22:08:34 -08006477}
Janos Follath6660f0e2019-06-17 08:44:03 +01006478
Przemek Stekiele47201b2022-04-19 13:53:28 +02006479static psa_status_t psa_tls12_prf_psk_to_ms_set_other_key(
6480 psa_tls12_prf_key_derivation_t *prf,
6481 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006482 size_t data_length)
Przemek Stekiele47201b2022-04-19 13:53:28 +02006483{
Gilles Peskine449bd832023-01-11 14:50:10 +01006484 if (prf->state != PSA_TLS12_PRF_STATE_SEED_SET) {
6485 return PSA_ERROR_BAD_STATE;
Przemek Stekiele47201b2022-04-19 13:53:28 +02006486 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006487
6488 if (data_length != 0) {
6489 prf->other_secret = mbedtls_calloc(1, data_length);
6490 if (prf->other_secret == NULL) {
6491 return PSA_ERROR_INSUFFICIENT_MEMORY;
6492 }
6493
6494 memcpy(prf->other_secret, data, data_length);
6495 prf->other_secret_length = data_length;
6496 } else {
Przemek Stekiele47201b2022-04-19 13:53:28 +02006497 prf->other_secret_length = 0;
6498 }
6499
6500 prf->state = PSA_TLS12_PRF_STATE_OTHER_KEY_SET;
6501
Gilles Peskine449bd832023-01-11 14:50:10 +01006502 return PSA_SUCCESS;
Przemek Stekiele47201b2022-04-19 13:53:28 +02006503}
6504
Janos Follath6660f0e2019-06-17 08:44:03 +01006505static psa_status_t psa_tls12_prf_psk_to_ms_input(
6506 psa_tls12_prf_key_derivation_t *prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01006507 psa_key_derivation_step_t step,
6508 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006509 size_t data_length)
Janos Follath6660f0e2019-06-17 08:44:03 +01006510{
Gilles Peskine449bd832023-01-11 14:50:10 +01006511 switch (step) {
Przemek Stekiele47201b2022-04-19 13:53:28 +02006512 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006513 return psa_tls12_prf_psk_to_ms_set_key(prf,
6514 data, data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02006515 break;
6516 case PSA_KEY_DERIVATION_INPUT_OTHER_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006517 return psa_tls12_prf_psk_to_ms_set_other_key(prf,
6518 data,
6519 data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02006520 break;
6521 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006522 return psa_tls12_prf_input(prf, step, data, data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02006523 break;
Janos Follath6660f0e2019-06-17 08:44:03 +01006524
Przemek Stekiele47201b2022-04-19 13:53:28 +02006525 }
Janos Follath6660f0e2019-06-17 08:44:03 +01006526}
John Durkop07cc04a2020-11-16 22:08:34 -08006527#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006528
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006529#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
6530static psa_status_t psa_tls12_ecjpake_to_pms_input(
6531 psa_tls12_ecjpake_to_pms_t *ecjpake,
Andrzej Kurek702776f2022-09-16 06:22:44 -04006532 psa_key_derivation_step_t step,
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006533 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006534 size_t data_length)
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006535{
Gilles Peskine449bd832023-01-11 14:50:10 +01006536 if (data_length != PSA_TLS12_ECJPAKE_TO_PMS_INPUT_SIZE ||
6537 step != PSA_KEY_DERIVATION_INPUT_SECRET) {
6538 return PSA_ERROR_INVALID_ARGUMENT;
Andrzej Kurek5603efd2022-09-26 10:49:16 -04006539 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006540
6541 /* Check if the passed point is in an uncompressed form */
Gilles Peskine449bd832023-01-11 14:50:10 +01006542 if (data[0] != 0x04) {
6543 return PSA_ERROR_INVALID_ARGUMENT;
6544 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006545
6546 /* Only K.X has to be extracted - bytes 1 to 32 inclusive. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006547 memcpy(ecjpake->data, data + 1, PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE);
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006548
Gilles Peskine449bd832023-01-11 14:50:10 +01006549 return PSA_SUCCESS;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006550}
6551#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306552
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306553#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306554static psa_status_t psa_pbkdf2_set_input_cost(
6555 psa_pbkdf2_key_derivation_t *pbkdf2,
6556 psa_key_derivation_step_t step,
6557 uint64_t data)
6558{
6559 if (step != PSA_KEY_DERIVATION_INPUT_COST) {
6560 return PSA_ERROR_INVALID_ARGUMENT;
6561 }
6562
6563 if (pbkdf2->state != PSA_PBKDF2_STATE_INIT) {
6564 return PSA_ERROR_BAD_STATE;
6565 }
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05306566
Kusumit Ghoderaoe66a8ad2023-05-24 12:30:43 +05306567 if (data > PSA_VENDOR_PBKDF2_MAX_ITERATIONS) {
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05306568 return PSA_ERROR_NOT_SUPPORTED;
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306569 }
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05306570
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306571 if (data == 0) {
6572 return PSA_ERROR_INVALID_ARGUMENT;
6573 }
Kusumit Ghoderaoe66a8ad2023-05-24 12:30:43 +05306574
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306575 pbkdf2->input_cost = data;
6576 pbkdf2->state = PSA_PBKDF2_STATE_INPUT_COST_SET;
6577
6578 return PSA_SUCCESS;
6579}
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306580
6581static psa_status_t psa_pbkdf2_set_salt(psa_pbkdf2_key_derivation_t *pbkdf2,
6582 const uint8_t *data,
6583 size_t data_length)
6584{
Gilles Peskineead17662023-08-20 22:02:51 +02006585 if (pbkdf2->state == PSA_PBKDF2_STATE_INPUT_COST_SET) {
6586 pbkdf2->state = PSA_PBKDF2_STATE_SALT_SET;
6587 } else if (pbkdf2->state == PSA_PBKDF2_STATE_SALT_SET) {
6588 /* Appending to existing salt. No state change. */
6589 } else {
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306590 return PSA_ERROR_BAD_STATE;
6591 }
6592
Gilles Peskineca57d782023-07-20 19:08:06 +02006593 if (data_length == 0) {
Gilles Peskineead17662023-08-20 22:02:51 +02006594 /* Appending an empty string, nothing to do. */
6595 } else {
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306596 uint8_t *next_salt;
Kusumit Ghoderaob538bb72023-05-24 12:32:14 +05306597
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306598 next_salt = mbedtls_calloc(1, data_length + pbkdf2->salt_length);
6599 if (next_salt == NULL) {
Kusumit Ghoderaod0422f32023-05-08 15:56:19 +05306600 return PSA_ERROR_INSUFFICIENT_MEMORY;
6601 }
6602
Gilles Peskineead17662023-08-20 22:02:51 +02006603 if (pbkdf2->salt_length != 0) {
6604 memcpy(next_salt, pbkdf2->salt, pbkdf2->salt_length);
6605 }
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306606 memcpy(next_salt + pbkdf2->salt_length, data, data_length);
Kusumit Ghoderaod0422f32023-05-08 15:56:19 +05306607 pbkdf2->salt_length += data_length;
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306608 mbedtls_free(pbkdf2->salt);
6609 pbkdf2->salt = next_salt;
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306610 }
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306611 return PSA_SUCCESS;
6612}
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306613
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05306614#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306615static psa_status_t psa_pbkdf2_hmac_set_password(psa_algorithm_t hash_alg,
Kusumit Ghoderaoaac9a582023-05-24 14:19:17 +05306616 const uint8_t *input,
6617 size_t input_len,
6618 uint8_t *output,
Kusumit Ghoderao91f99f52023-05-24 22:21:48 +05306619 size_t *output_len)
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306620{
6621 psa_status_t status = PSA_SUCCESS;
6622 if (input_len > PSA_HASH_BLOCK_LENGTH(hash_alg)) {
6623 status = psa_hash_compute(hash_alg, input, input_len, output,
Kusumit Ghoderao91f99f52023-05-24 22:21:48 +05306624 PSA_HMAC_MAX_HASH_BLOCK_SIZE, output_len);
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306625 } else {
6626 memcpy(output, input, input_len);
Kusumit Ghoderao91f99f52023-05-24 22:21:48 +05306627 *output_len = PSA_HASH_BLOCK_LENGTH(hash_alg);
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306628 }
6629 return status;
6630}
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05306631#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC */
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306632
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05306633#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128)
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306634static psa_status_t psa_pbkdf2_cmac_set_password(const uint8_t *input,
6635 size_t input_len,
6636 uint8_t *output,
6637 size_t *output_len)
6638{
6639 psa_status_t status = PSA_SUCCESS;
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306640 if (input_len != PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC)) {
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306641 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Kusumit Ghoderao3fde8fe2023-06-27 10:41:43 +05306642 uint8_t zeros[16] = { 0 };
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306643 psa_set_key_type(&attributes, PSA_KEY_TYPE_AES);
6644 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(sizeof(zeros)));
6645 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306646 /* Passing PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC) as
Kusumit Ghoderao5f3345a2023-07-27 21:21:38 +05306647 * mac_size as the driver function sets mac_output_length = mac_size
6648 * on success. See https://github.com/Mbed-TLS/mbedtls/issues/7801 */
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306649 status = psa_driver_wrapper_mac_compute(&attributes,
6650 zeros, sizeof(zeros),
6651 PSA_ALG_CMAC, input, input_len,
6652 output,
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306653 PSA_MAC_LENGTH(PSA_KEY_TYPE_AES,
6654 128U,
6655 PSA_ALG_CMAC),
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306656 output_len);
6657 } else {
6658 memcpy(output, input, input_len);
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306659 *output_len = PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC);
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306660 }
6661 return status;
6662}
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05306663#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128 */
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306664
6665static psa_status_t psa_pbkdf2_set_password(psa_pbkdf2_key_derivation_t *pbkdf2,
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306666 psa_algorithm_t kdf_alg,
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306667 const uint8_t *data,
6668 size_t data_length)
6669{
Kusumit Ghoderaoaac9a582023-05-24 14:19:17 +05306670 psa_status_t status = PSA_SUCCESS;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306671 if (pbkdf2->state != PSA_PBKDF2_STATE_SALT_SET) {
6672 return PSA_ERROR_BAD_STATE;
6673 }
6674
Kusumit Ghoderaof3e696d2023-07-28 13:30:50 +05306675#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306676 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
6677 psa_algorithm_t hash_alg = PSA_ALG_PBKDF2_HMAC_GET_HASH(kdf_alg);
6678 status = psa_pbkdf2_hmac_set_password(hash_alg, data, data_length,
6679 pbkdf2->password,
6680 &pbkdf2->password_length);
Kusumit Ghoderaof3e696d2023-07-28 13:30:50 +05306681 } else
6682#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC */
6683#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128)
6684 if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306685 status = psa_pbkdf2_cmac_set_password(data, data_length,
6686 pbkdf2->password,
6687 &pbkdf2->password_length);
Kusumit Ghoderaof3e696d2023-07-28 13:30:50 +05306688 } else
6689#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128 */
6690 {
6691 return PSA_ERROR_INVALID_ARGUMENT;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306692 }
6693
6694 pbkdf2->state = PSA_PBKDF2_STATE_PASSWORD_SET;
6695
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306696 return status;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306697}
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05306698
6699static psa_status_t psa_pbkdf2_input(psa_pbkdf2_key_derivation_t *pbkdf2,
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306700 psa_algorithm_t kdf_alg,
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05306701 psa_key_derivation_step_t step,
6702 const uint8_t *data,
6703 size_t data_length)
6704{
6705 switch (step) {
6706 case PSA_KEY_DERIVATION_INPUT_SALT:
6707 return psa_pbkdf2_set_salt(pbkdf2, data, data_length);
6708 case PSA_KEY_DERIVATION_INPUT_PASSWORD:
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306709 return psa_pbkdf2_set_password(pbkdf2, kdf_alg, data, data_length);
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05306710 default:
6711 return PSA_ERROR_INVALID_ARGUMENT;
6712 }
6713}
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306714#endif /* PSA_HAVE_SOFT_PBKDF2 */
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306715
Gilles Peskineb8965192019-09-24 16:21:10 +02006716/** Check whether the given key type is acceptable for the given
6717 * input step of a key derivation.
6718 *
6719 * Secret inputs must have the type #PSA_KEY_TYPE_DERIVE.
6720 * Non-secret inputs must have the type #PSA_KEY_TYPE_RAW_DATA.
6721 * Both secret and non-secret inputs can alternatively have the type
6722 * #PSA_KEY_TYPE_NONE, which is never the type of a key object, meaning
6723 * that the input was passed as a buffer rather than via a key object.
6724 */
Gilles Peskine224b0d62019-09-23 18:13:17 +02006725static int psa_key_derivation_check_input_type(
6726 psa_key_derivation_step_t step,
Gilles Peskine449bd832023-01-11 14:50:10 +01006727 psa_key_type_t key_type)
Gilles Peskine224b0d62019-09-23 18:13:17 +02006728{
Gilles Peskine449bd832023-01-11 14:50:10 +01006729 switch (step) {
Gilles Peskine224b0d62019-09-23 18:13:17 +02006730 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006731 if (key_type == PSA_KEY_TYPE_DERIVE) {
6732 return PSA_SUCCESS;
6733 }
6734 if (key_type == PSA_KEY_TYPE_NONE) {
6735 return PSA_SUCCESS;
6736 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02006737 break;
Przemek Stekiela7695a22022-04-07 15:39:01 +02006738 case PSA_KEY_DERIVATION_INPUT_OTHER_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006739 if (key_type == PSA_KEY_TYPE_DERIVE) {
6740 return PSA_SUCCESS;
6741 }
6742 if (key_type == PSA_KEY_TYPE_NONE) {
6743 return PSA_SUCCESS;
6744 }
Przemek Stekiela7695a22022-04-07 15:39:01 +02006745 break;
Gilles Peskine224b0d62019-09-23 18:13:17 +02006746 case PSA_KEY_DERIVATION_INPUT_LABEL:
6747 case PSA_KEY_DERIVATION_INPUT_SALT:
6748 case PSA_KEY_DERIVATION_INPUT_INFO:
6749 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskine449bd832023-01-11 14:50:10 +01006750 if (key_type == PSA_KEY_TYPE_RAW_DATA) {
6751 return PSA_SUCCESS;
6752 }
6753 if (key_type == PSA_KEY_TYPE_NONE) {
6754 return PSA_SUCCESS;
6755 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02006756 break;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306757 case PSA_KEY_DERIVATION_INPUT_PASSWORD:
6758 if (key_type == PSA_KEY_TYPE_PASSWORD) {
6759 return PSA_SUCCESS;
6760 }
6761 if (key_type == PSA_KEY_TYPE_DERIVE) {
6762 return PSA_SUCCESS;
6763 }
6764 if (key_type == PSA_KEY_TYPE_NONE) {
6765 return PSA_SUCCESS;
6766 }
6767 break;
Gilles Peskine224b0d62019-09-23 18:13:17 +02006768 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006769 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine224b0d62019-09-23 18:13:17 +02006770}
6771
Janos Follathb80a94e2019-06-12 15:54:46 +01006772static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006773 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01006774 psa_key_derivation_step_t step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02006775 psa_key_type_t key_type,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01006776 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006777 size_t data_length)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006778{
Gilles Peskine46d7faf2019-09-23 19:22:55 +02006779 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006780 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
Gilles Peskine46d7faf2019-09-23 19:22:55 +02006781
Gilles Peskine449bd832023-01-11 14:50:10 +01006782 status = psa_key_derivation_check_input_type(step, key_type);
6783 if (status != PSA_SUCCESS) {
Gilles Peskine224b0d62019-09-23 18:13:17 +02006784 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006785 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02006786
Przemek Stekiel69c46792022-06-10 12:59:51 +02006787#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006788 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
6789 status = psa_hkdf_input(&operation->ctx.hkdf, kdf_alg,
6790 step, data, data_length);
6791 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02006792#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08006793#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006794 if (PSA_ALG_IS_TLS12_PRF(kdf_alg)) {
6795 status = psa_tls12_prf_input(&operation->ctx.tls12_prf,
6796 step, data, data_length);
6797 } else
John Durkop07cc04a2020-11-16 22:08:34 -08006798#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF */
6799#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006800 if (PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
6801 status = psa_tls12_prf_psk_to_ms_input(&operation->ctx.tls12_prf,
6802 step, data, data_length);
6803 } else
John Durkop07cc04a2020-11-16 22:08:34 -08006804#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006805#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006806 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006807 status = psa_tls12_ecjpake_to_pms_input(
Gilles Peskine449bd832023-01-11 14:50:10 +01006808 &operation->ctx.tls12_ecjpake_to_pms, step, data, data_length);
6809 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006810#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306811#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05306812 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306813 status = psa_pbkdf2_input(&operation->ctx.pbkdf2, kdf_alg,
6814 step, data, data_length);
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05306815 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306816#endif /* PSA_HAVE_SOFT_PBKDF2 */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006817 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006818 /* This can't happen unless the operation object was not initialized */
Steven Cooreman74afe472021-02-10 17:19:22 +01006819 (void) data;
6820 (void) data_length;
6821 (void) kdf_alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01006822 return PSA_ERROR_BAD_STATE;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006823 }
6824
Gilles Peskine224b0d62019-09-23 18:13:17 +02006825exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01006826 if (status != PSA_SUCCESS) {
6827 psa_key_derivation_abort(operation);
6828 }
6829 return status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006830}
6831
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05306832static psa_status_t psa_key_derivation_input_integer_internal(
6833 psa_key_derivation_operation_t *operation,
6834 psa_key_derivation_step_t step,
6835 uint64_t value)
6836{
6837 psa_status_t status;
6838 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
6839
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306840#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05306841 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306842 status = psa_pbkdf2_set_input_cost(
6843 &operation->ctx.pbkdf2, step, value);
6844 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306845#endif /* PSA_HAVE_SOFT_PBKDF2 */
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05306846 {
Kusumit Ghoderao3a18dee2023-04-07 16:16:27 +05306847 (void) step;
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05306848 (void) value;
6849 (void) kdf_alg;
Kusumit Ghoderaoa14ae5a2023-04-19 14:16:26 +05306850 status = PSA_ERROR_INVALID_ARGUMENT;
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05306851 }
6852
6853 if (status != PSA_SUCCESS) {
6854 psa_key_derivation_abort(operation);
6855 }
6856 return status;
6857}
6858
Janos Follath51f4a0f2019-06-14 11:35:55 +01006859psa_status_t psa_key_derivation_input_bytes(
6860 psa_key_derivation_operation_t *operation,
6861 psa_key_derivation_step_t step,
6862 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006863 size_t data_length)
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01006864{
Gilles Peskine449bd832023-01-11 14:50:10 +01006865 return psa_key_derivation_input_internal(operation, step,
6866 PSA_KEY_TYPE_NONE,
6867 data, data_length);
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01006868}
6869
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05306870psa_status_t psa_key_derivation_input_integer(
6871 psa_key_derivation_operation_t *operation,
6872 psa_key_derivation_step_t step,
6873 uint64_t value)
6874{
6875 return psa_key_derivation_input_integer_internal(operation, step, value);
6876}
6877
Janos Follath51f4a0f2019-06-14 11:35:55 +01006878psa_status_t psa_key_derivation_input_key(
6879 psa_key_derivation_operation_t *operation,
6880 psa_key_derivation_step_t step,
Gilles Peskine449bd832023-01-11 14:50:10 +01006881 mbedtls_svc_key_id_t key)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006882{
Ronald Cronf95a2b12020-10-22 15:24:49 +02006883 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01006884 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006885 psa_key_slot_t *slot;
Gilles Peskine178c9aa2019-09-24 18:21:06 +02006886
Ronald Cron5c522922020-11-14 16:35:34 +01006887 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01006888 key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg);
6889 if (status != PSA_SUCCESS) {
6890 psa_key_derivation_abort(operation);
6891 return status;
Gilles Peskine593773d2019-09-23 18:17:40 +02006892 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02006893
Kusumit Ghoderao3128c5d2023-05-03 12:27:57 +05306894 /* Passing a key object as a SECRET or PASSWORD input unlocks the
6895 * permission to output to a key object. */
6896 if (step == PSA_KEY_DERIVATION_INPUT_SECRET ||
6897 step == PSA_KEY_DERIVATION_INPUT_PASSWORD) {
Gilles Peskine178c9aa2019-09-24 18:21:06 +02006898 operation->can_output_key = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01006899 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02006900
Gilles Peskine449bd832023-01-11 14:50:10 +01006901 status = psa_key_derivation_input_internal(operation,
6902 step, slot->attr.type,
6903 slot->key.data,
6904 slot->key.bytes);
Ronald Cronf95a2b12020-10-22 15:24:49 +02006905
Gilles Peskine449bd832023-01-11 14:50:10 +01006906 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02006907
Gilles Peskine449bd832023-01-11 14:50:10 +01006908 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006909}
Gilles Peskineea0fb492018-07-12 17:17:20 +02006910
6911
6912
6913/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02006914/* Key agreement */
6915/****************************************************************/
6916
Gilles Peskine449bd832023-01-11 14:50:10 +01006917psa_status_t psa_key_agreement_raw_builtin(const psa_key_attributes_t *attributes,
6918 const uint8_t *key_buffer,
6919 size_t key_buffer_size,
6920 psa_algorithm_t alg,
6921 const uint8_t *peer_key,
6922 size_t peer_key_length,
6923 uint8_t *shared_secret,
6924 size_t shared_secret_size,
6925 size_t *shared_secret_length)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02006926{
Gilles Peskine449bd832023-01-11 14:50:10 +01006927 switch (alg) {
John Durkop6ba40d12020-11-10 08:50:04 -08006928#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskine0216fe12019-04-11 21:23:21 +02006929 case PSA_ALG_ECDH:
Gilles Peskine449bd832023-01-11 14:50:10 +01006930 return mbedtls_psa_key_agreement_ecdh(attributes, key_buffer,
6931 key_buffer_size, alg,
6932 peer_key, peer_key_length,
6933 shared_secret,
6934 shared_secret_size,
6935 shared_secret_length);
Gilles Peskine01d718c2018-09-18 12:01:02 +02006936#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Przemek Stekielfb3dd542022-12-01 14:59:15 +01006937
6938#if defined(MBEDTLS_PSA_BUILTIN_ALG_FFDH)
6939 case PSA_ALG_FFDH:
Przemek Stekiel152bb462023-06-01 11:52:39 +02006940 return mbedtls_psa_ffdh_key_agreement(attributes,
Przemek Stekiel359f4622022-12-05 14:11:55 +01006941 peer_key,
6942 peer_key_length,
6943 key_buffer,
6944 key_buffer_size,
6945 shared_secret,
6946 shared_secret_size,
6947 shared_secret_length);
Przemek Stekielfb3dd542022-12-01 14:59:15 +01006948#endif /* MBEDTLS_PSA_BUILTIN_ALG_FFDH */
6949
Gilles Peskine01d718c2018-09-18 12:01:02 +02006950 default:
Aditya Deshpande17845b82022-10-13 17:21:01 +01006951 (void) attributes;
6952 (void) key_buffer;
6953 (void) key_buffer_size;
Gilles Peskine93f85002018-11-16 16:43:31 +01006954 (void) peer_key;
6955 (void) peer_key_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02006956 (void) shared_secret;
6957 (void) shared_secret_size;
6958 (void) shared_secret_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01006959 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine01d718c2018-09-18 12:01:02 +02006960 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02006961}
Gilles Peskine01d718c2018-09-18 12:01:02 +02006962
Aditya Deshpande17845b82022-10-13 17:21:01 +01006963/** Internal function for raw key agreement
6964 * Calls the driver wrapper which will hand off key agreement task
Aditya Deshpande40c05cc2022-10-14 16:41:40 +01006965 * to the driver's implementation if a driver is present.
6966 * Fallback specified in the driver wrapper is built-in raw key agreement
Aditya Deshpande17845b82022-10-13 17:21:01 +01006967 * (psa_key_agreement_raw_builtin).
6968 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006969static psa_status_t psa_key_agreement_raw_internal(psa_algorithm_t alg,
6970 psa_key_slot_t *private_key,
6971 const uint8_t *peer_key,
6972 size_t peer_key_length,
6973 uint8_t *shared_secret,
6974 size_t shared_secret_size,
6975 size_t *shared_secret_length)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006976{
Gilles Peskine449bd832023-01-11 14:50:10 +01006977 if (!PSA_ALG_IS_RAW_KEY_AGREEMENT(alg)) {
6978 return PSA_ERROR_NOT_SUPPORTED;
6979 }
Aditya Deshpande17845b82022-10-13 17:21:01 +01006980
6981 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01006982 .core = private_key->attr
Aditya Deshpande17845b82022-10-13 17:21:01 +01006983 };
6984
Gilles Peskine449bd832023-01-11 14:50:10 +01006985 return psa_driver_wrapper_key_agreement(&attributes,
6986 private_key->key.data,
6987 private_key->key.bytes, alg,
6988 peer_key, peer_key_length,
6989 shared_secret,
6990 shared_secret_size,
6991 shared_secret_length);
Gilles Peskine0216fe12019-04-11 21:23:21 +02006992}
6993
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02006994/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine01d718c2018-09-18 12:01:02 +02006995 * to potentially free embedded data structures and wipe confidential data.
6996 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006997static psa_status_t psa_key_agreement_internal(psa_key_derivation_operation_t *operation,
6998 psa_key_derivation_step_t step,
6999 psa_key_slot_t *private_key,
7000 const uint8_t *peer_key,
7001 size_t peer_key_length)
Gilles Peskine01d718c2018-09-18 12:01:02 +02007002{
7003 psa_status_t status;
Aditya Deshpande2f7fd762022-11-22 11:10:34 +00007004 uint8_t shared_secret[PSA_RAW_KEY_AGREEMENT_OUTPUT_MAX_SIZE];
Gilles Peskine01d718c2018-09-18 12:01:02 +02007005 size_t shared_secret_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007006 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE(operation->alg);
Gilles Peskine01d718c2018-09-18 12:01:02 +02007007
7008 /* Step 1: run the secret agreement algorithm to generate the shared
7009 * secret. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007010 status = psa_key_agreement_raw_internal(ka_alg,
7011 private_key,
7012 peer_key, peer_key_length,
7013 shared_secret,
7014 sizeof(shared_secret),
7015 &shared_secret_length);
7016 if (status != PSA_SUCCESS) {
Gilles Peskine12313cd2018-06-20 00:20:32 +02007017 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007018 }
Gilles Peskine12313cd2018-06-20 00:20:32 +02007019
Gilles Peskineb0b255c2018-07-06 17:01:38 +02007020 /* Step 2: set up the key derivation to generate key material from
Gilles Peskine224b0d62019-09-23 18:13:17 +02007021 * the shared secret. A shared secret is permitted wherever a key
7022 * of type DERIVE is permitted. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007023 status = psa_key_derivation_input_internal(operation, step,
7024 PSA_KEY_TYPE_DERIVE,
7025 shared_secret,
7026 shared_secret_length);
Gilles Peskine12313cd2018-06-20 00:20:32 +02007027exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007028 mbedtls_platform_zeroize(shared_secret, shared_secret_length);
7029 return status;
Gilles Peskine12313cd2018-06-20 00:20:32 +02007030}
7031
Gilles Peskine449bd832023-01-11 14:50:10 +01007032psa_status_t psa_key_derivation_key_agreement(psa_key_derivation_operation_t *operation,
7033 psa_key_derivation_step_t step,
7034 mbedtls_svc_key_id_t private_key,
7035 const uint8_t *peer_key,
7036 size_t peer_key_length)
Gilles Peskine12313cd2018-06-20 00:20:32 +02007037{
Ronald Cronf95a2b12020-10-22 15:24:49 +02007038 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01007039 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01007040 psa_key_slot_t *slot;
Ronald Cronf95a2b12020-10-22 15:24:49 +02007041
Gilles Peskine449bd832023-01-11 14:50:10 +01007042 if (!PSA_ALG_IS_KEY_AGREEMENT(operation->alg)) {
7043 return PSA_ERROR_INVALID_ARGUMENT;
7044 }
Ronald Cron5c522922020-11-14 16:35:34 +01007045 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01007046 private_key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg);
7047 if (status != PSA_SUCCESS) {
7048 return status;
7049 }
7050 status = psa_key_agreement_internal(operation, step,
7051 slot,
7052 peer_key, peer_key_length);
7053 if (status != PSA_SUCCESS) {
7054 psa_key_derivation_abort(operation);
7055 } else {
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007056 /* If a private key has been added as SECRET, we allow the derived
7057 * key material to be used as a key in PSA Crypto. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007058 if (step == PSA_KEY_DERIVATION_INPUT_SECRET) {
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007059 operation->can_output_key = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01007060 }
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007061 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007062
Gilles Peskine449bd832023-01-11 14:50:10 +01007063 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007064
Gilles Peskine449bd832023-01-11 14:50:10 +01007065 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskineaf3baab2018-06-27 22:55:52 +02007066}
7067
Gilles Peskine449bd832023-01-11 14:50:10 +01007068psa_status_t psa_raw_key_agreement(psa_algorithm_t alg,
7069 mbedtls_svc_key_id_t private_key,
7070 const uint8_t *peer_key,
7071 size_t peer_key_length,
7072 uint8_t *output,
7073 size_t output_size,
7074 size_t *output_length)
Gilles Peskine0216fe12019-04-11 21:23:21 +02007075{
Ronald Cronf95a2b12020-10-22 15:24:49 +02007076 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01007077 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +02007078 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007079 size_t expected_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02007080
Gilles Peskine449bd832023-01-11 14:50:10 +01007081 if (!PSA_ALG_IS_KEY_AGREEMENT(alg)) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007082 status = PSA_ERROR_INVALID_ARGUMENT;
7083 goto exit;
7084 }
Ronald Cron5c522922020-11-14 16:35:34 +01007085 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01007086 private_key, &slot, PSA_KEY_USAGE_DERIVE, alg);
7087 if (status != PSA_SUCCESS) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007088 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007089 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02007090
Gilles Peskine3e561302022-04-14 00:17:15 +02007091 /* PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() is in general an upper bound
7092 * for the output size. The PSA specification only guarantees that this
7093 * function works if output_size >= PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE(...),
7094 * but it might be nice to allow smaller buffers if the output fits.
7095 * At the time of writing this comment, with only ECDH implemented,
7096 * PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() is exact so the point is moot.
7097 * If FFDH is implemented, PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() can easily
7098 * be exact for it as well. */
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007099 expected_length =
Gilles Peskine449bd832023-01-11 14:50:10 +01007100 PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE(slot->attr.type, slot->attr.bits);
7101 if (output_size < expected_length) {
Gilles Peskine3e561302022-04-14 00:17:15 +02007102 status = PSA_ERROR_BUFFER_TOO_SMALL;
7103 goto exit;
7104 }
7105
Gilles Peskine449bd832023-01-11 14:50:10 +01007106 status = psa_key_agreement_raw_internal(alg, slot,
7107 peer_key, peer_key_length,
7108 output, output_size,
7109 output_length);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007110
7111exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007112 if (status != PSA_SUCCESS) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007113 /* If an error happens and is not handled properly, the output
7114 * may be used as a key to protect sensitive data. Arrange for such
7115 * a key to be random, which is likely to result in decryption or
7116 * verification errors. This is better than filling the buffer with
7117 * some constant data such as zeros, which would result in the data
7118 * being protected with a reproducible, easily knowable key.
7119 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007120 psa_generate_random(output, output_size);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007121 *output_length = output_size;
7122 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007123
Gilles Peskine449bd832023-01-11 14:50:10 +01007124 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007125
Gilles Peskine449bd832023-01-11 14:50:10 +01007126 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine0216fe12019-04-11 21:23:21 +02007127}
Gilles Peskine86a440b2018-11-12 18:39:40 +01007128
7129
Gilles Peskine30524eb2020-11-13 17:02:26 +01007130
Gilles Peskine86a440b2018-11-12 18:39:40 +01007131/****************************************************************/
7132/* Random generation */
Gilles Peskine53d991e2018-07-12 01:14:59 +02007133/****************************************************************/
Gilles Peskine12313cd2018-06-20 00:20:32 +02007134
Gilles Peskine672a7712023-04-28 21:00:28 +02007135#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
7136#include "entropy_poll.h"
7137#endif
7138
Gilles Peskine30524eb2020-11-13 17:02:26 +01007139/** Initialize the PSA random generator.
7140 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007141static void mbedtls_psa_random_init(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01007142{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007143#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine449bd832023-01-11 14:50:10 +01007144 memset(rng, 0, sizeof(*rng));
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007145#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
7146
Gilles Peskine30524eb2020-11-13 17:02:26 +01007147 /* Set default configuration if
7148 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007149 if (rng->entropy_init == NULL) {
Gilles Peskine30524eb2020-11-13 17:02:26 +01007150 rng->entropy_init = mbedtls_entropy_init;
Gilles Peskine449bd832023-01-11 14:50:10 +01007151 }
7152 if (rng->entropy_free == NULL) {
Gilles Peskine30524eb2020-11-13 17:02:26 +01007153 rng->entropy_free = mbedtls_entropy_free;
Gilles Peskine449bd832023-01-11 14:50:10 +01007154 }
Gilles Peskine30524eb2020-11-13 17:02:26 +01007155
Gilles Peskine449bd832023-01-11 14:50:10 +01007156 rng->entropy_init(&rng->entropy);
Gilles Peskine30524eb2020-11-13 17:02:26 +01007157#if defined(MBEDTLS_PSA_INJECT_ENTROPY) && \
7158 defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
7159 /* The PSA entropy injection feature depends on using NV seed as an entropy
7160 * source. Add NV seed as an entropy source for PSA entropy injection. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007161 mbedtls_entropy_add_source(&rng->entropy,
7162 mbedtls_nv_seed_poll, NULL,
7163 MBEDTLS_ENTROPY_BLOCK_SIZE,
7164 MBEDTLS_ENTROPY_SOURCE_STRONG);
Gilles Peskine30524eb2020-11-13 17:02:26 +01007165#endif
7166
Gilles Peskine449bd832023-01-11 14:50:10 +01007167 mbedtls_psa_drbg_init(MBEDTLS_PSA_RANDOM_STATE);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007168#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007169}
7170
7171/** Deinitialize the PSA random generator.
7172 */
Valerio Setti83e0de82023-11-24 12:13:05 +01007173static void mbedtls_psa_random_free(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01007174{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007175#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Valerio Setti83e0de82023-11-24 12:13:05 +01007176 memset(rng, 0, sizeof(*rng));
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007177#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Valerio Setti83e0de82023-11-24 12:13:05 +01007178 mbedtls_psa_drbg_free(MBEDTLS_PSA_RANDOM_STATE);
7179 rng->entropy_free(&rng->entropy);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007180#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007181}
7182
7183/** Seed the PSA random generator.
7184 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007185static psa_status_t mbedtls_psa_random_seed(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01007186{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007187#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
7188 /* Do nothing: the external RNG seeds itself. */
7189 (void) rng;
Gilles Peskine449bd832023-01-11 14:50:10 +01007190 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007191#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007192 const unsigned char drbg_seed[] = "PSA";
Gilles Peskine449bd832023-01-11 14:50:10 +01007193 int ret = mbedtls_psa_drbg_seed(&rng->entropy,
7194 drbg_seed, sizeof(drbg_seed) - 1);
7195 return mbedtls_to_psa_error(ret);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007196#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007197}
7198
Gilles Peskine449bd832023-01-11 14:50:10 +01007199psa_status_t psa_generate_random(uint8_t *output,
7200 size_t output_size)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007201{
Gilles Peskinee59236f2018-01-27 23:32:46 +01007202 GUARD_MODULE_INITIALIZED;
7203
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007204#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
7205
7206 size_t output_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007207 psa_status_t status = mbedtls_psa_external_get_random(&global_data.rng,
7208 output, output_size,
7209 &output_length);
7210 if (status != PSA_SUCCESS) {
7211 return status;
7212 }
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007213 /* Breaking up a request into smaller chunks is currently not supported
Tom Cosgrove1797b052022-12-04 17:19:59 +00007214 * for the external RNG interface. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007215 if (output_length != output_size) {
7216 return PSA_ERROR_INSUFFICIENT_ENTROPY;
7217 }
7218 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007219
7220#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
7221
Gilles Peskine449bd832023-01-11 14:50:10 +01007222 while (output_size > 0) {
Gilles Peskine71ddab92021-01-04 21:01:07 +01007223 size_t request_size =
Gilles Peskine449bd832023-01-11 14:50:10 +01007224 (output_size > MBEDTLS_PSA_RANDOM_MAX_REQUEST ?
7225 MBEDTLS_PSA_RANDOM_MAX_REQUEST :
7226 output_size);
7227 int ret = mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE,
7228 output, request_size);
7229 if (ret != 0) {
7230 return mbedtls_to_psa_error(ret);
7231 }
Gilles Peskine71ddab92021-01-04 21:01:07 +01007232 output_size -= request_size;
7233 output += request_size;
Gilles Peskinef181eca2019-08-07 13:49:00 +02007234 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007235 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007236#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskinee59236f2018-01-27 23:32:46 +01007237}
7238
Gilles Peskine8814fc42020-12-14 15:33:44 +01007239/* Wrapper function allowing the classic API to use the PSA RNG.
Gilles Peskine9c3e0602021-01-05 16:03:55 +01007240 *
7241 * `mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE, ...)` calls
7242 * `psa_generate_random(...)`. The state parameter is ignored since the
7243 * PSA API doesn't support passing an explicit state.
7244 *
7245 * In the non-external case, psa_generate_random() calls an
7246 * `mbedtls_xxx_drbg_random` function which has exactly the same signature
7247 * and semantics as mbedtls_psa_get_random(). As an optimization,
7248 * instead of doing this back-and-forth between the PSA API and the
7249 * classic API, psa_crypto_random_impl.h defines `mbedtls_psa_get_random`
7250 * as a constant function pointer to `mbedtls_xxx_drbg_random`.
Gilles Peskine8814fc42020-12-14 15:33:44 +01007251 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007252#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
7253int mbedtls_psa_get_random(void *p_rng,
7254 unsigned char *output,
7255 size_t output_size)
Gilles Peskine8814fc42020-12-14 15:33:44 +01007256{
Gilles Peskine9c3e0602021-01-05 16:03:55 +01007257 /* This function takes a pointer to the RNG state because that's what
7258 * classic mbedtls functions using an RNG expect. The PSA RNG manages
7259 * its own state internally and doesn't let the caller access that state.
7260 * So we just ignore the state parameter, and in practice we'll pass
7261 * NULL. */
Gilles Peskine8814fc42020-12-14 15:33:44 +01007262 (void) p_rng;
Gilles Peskine449bd832023-01-11 14:50:10 +01007263 psa_status_t status = psa_generate_random(output, output_size);
7264 if (status == PSA_SUCCESS) {
7265 return 0;
7266 } else {
7267 return MBEDTLS_ERR_ENTROPY_SOURCE_FAILED;
7268 }
Gilles Peskine8814fc42020-12-14 15:33:44 +01007269}
7270#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
7271
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01007272#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
Gilles Peskine449bd832023-01-11 14:50:10 +01007273psa_status_t mbedtls_psa_inject_entropy(const uint8_t *seed,
7274 size_t seed_size)
Netanel Gonen2bcd3122018-11-19 11:53:02 +02007275{
Gilles Peskine449bd832023-01-11 14:50:10 +01007276 if (global_data.initialized) {
7277 return PSA_ERROR_NOT_PERMITTED;
7278 }
Netanel Gonen21f37cb2018-11-19 11:53:55 +02007279
Gilles Peskine449bd832023-01-11 14:50:10 +01007280 if (((seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM) ||
7281 (seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE)) ||
7282 (seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE)) {
7283 return PSA_ERROR_INVALID_ARGUMENT;
7284 }
Netanel Gonen21f37cb2018-11-19 11:53:55 +02007285
Gilles Peskine449bd832023-01-11 14:50:10 +01007286 return mbedtls_psa_storage_inject_entropy(seed, seed_size);
Netanel Gonen2bcd3122018-11-19 11:53:02 +02007287}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01007288#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02007289
Ronald Cron3772afe2021-02-08 16:10:05 +01007290/** Validate the key type and size for key generation
Ronald Cron01b2aba2020-10-05 09:42:02 +02007291 *
Ronald Cron3772afe2021-02-08 16:10:05 +01007292 * \param type The key type
7293 * \param bits The number of bits of the key
Ronald Cron01b2aba2020-10-05 09:42:02 +02007294 *
7295 * \retval #PSA_SUCCESS
Ronald Cron3772afe2021-02-08 16:10:05 +01007296 * The key type and size are valid.
Ronald Cron01b2aba2020-10-05 09:42:02 +02007297 * \retval #PSA_ERROR_INVALID_ARGUMENT
7298 * The size in bits of the key is not valid.
7299 * \retval #PSA_ERROR_NOT_SUPPORTED
7300 * The type and/or the size in bits of the key or the combination of
7301 * the two is not supported.
7302 */
Ronald Cron3772afe2021-02-08 16:10:05 +01007303static psa_status_t psa_validate_key_type_and_size_for_key_generation(
Gilles Peskine449bd832023-01-11 14:50:10 +01007304 psa_key_type_t type, size_t bits)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007305{
Ronald Cronf3bb7612020-10-02 20:11:59 +02007306 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007307
Gilles Peskine449bd832023-01-11 14:50:10 +01007308 if (key_type_is_raw_bytes(type)) {
7309 status = psa_validate_unstructured_key_bit_size(type, bits);
7310 if (status != PSA_SUCCESS) {
7311 return status;
7312 }
7313 } else
Valerio Settif6d4dfb2023-07-10 10:55:12 +02007314#if defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007315 if (PSA_KEY_TYPE_IS_RSA(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
7316 if (bits > PSA_VENDOR_RSA_MAX_KEY_BITS) {
7317 return PSA_ERROR_NOT_SUPPORTED;
7318 }
Waleed Elmelegyd7bdbbe2023-07-20 16:26:58 +00007319 if (bits < PSA_VENDOR_RSA_GENERATE_MIN_KEY_BITS) {
Waleed Elmelegyab570712023-07-05 16:40:58 +00007320 return PSA_ERROR_NOT_SUPPORTED;
7321 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +02007322
Ronald Cron01b2aba2020-10-05 09:42:02 +02007323 /* Accept only byte-aligned keys, for the same reasons as
7324 * in psa_import_rsa_key(). */
Gilles Peskine449bd832023-01-11 14:50:10 +01007325 if (bits % 8 != 0) {
7326 return PSA_ERROR_NOT_SUPPORTED;
7327 }
7328 } else
Valerio Settif6d4dfb2023-07-10 10:55:12 +02007329#endif /* defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02007330
Valerio Setti6a9d0ee2023-06-21 10:07:21 +02007331#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007332 if (PSA_KEY_TYPE_IS_ECC(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
Ronald Crond81ab562021-02-16 09:01:16 +01007333 /* To avoid empty block, return successfully here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007334 return PSA_SUCCESS;
7335 } else
Valerio Setti6a9d0ee2023-06-21 10:07:21 +02007336#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_GENERATE) */
Przemek Stekielfedd1342022-12-01 15:00:02 +01007337
Valerio Settia55f0422023-07-10 15:34:41 +02007338#if defined(PSA_WANT_KEY_TYPE_DH_KEY_PAIR_GENERATE)
Przemek Stekielfedd1342022-12-01 15:00:02 +01007339 if (PSA_KEY_TYPE_IS_DH(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
Przemek Stekield1cf1ba2023-04-27 12:04:21 +02007340 if (psa_is_dh_key_size_valid(bits) == 0) {
Przemek Stekielfedd1342022-12-01 15:00:02 +01007341 return PSA_ERROR_NOT_SUPPORTED;
7342 }
7343 } else
Valerio Settia55f0422023-07-10 15:34:41 +02007344#endif /* defined(PSA_WANT_KEY_TYPE_DH_KEY_PAIR_GENERATE) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02007345 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007346 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007347 }
7348
Gilles Peskine449bd832023-01-11 14:50:10 +01007349 return PSA_SUCCESS;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007350}
7351
Ronald Cron55ed0592020-10-05 10:30:40 +02007352psa_status_t psa_generate_key_internal(
Ronald Cron2a38a6b2020-10-02 20:02:04 +02007353 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01007354 uint8_t *key_buffer, size_t key_buffer_size, size_t *key_buffer_length)
Ronald Cron01b2aba2020-10-05 09:42:02 +02007355{
7356 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2a38a6b2020-10-02 20:02:04 +02007357 psa_key_type_t type = attributes->core.type;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007358
Gilles Peskine449bd832023-01-11 14:50:10 +01007359 if ((attributes->domain_parameters == NULL) &&
7360 (attributes->domain_parameters_size != 0)) {
7361 return PSA_ERROR_INVALID_ARGUMENT;
7362 }
Ronald Cron01b2aba2020-10-05 09:42:02 +02007363
Gilles Peskine449bd832023-01-11 14:50:10 +01007364 if (key_type_is_raw_bytes(type)) {
7365 status = psa_generate_random(key_buffer, key_buffer_size);
7366 if (status != PSA_SUCCESS) {
7367 return status;
7368 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +02007369
David Brown12ca5032021-02-11 11:02:00 -07007370#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01007371 if (type == PSA_KEY_TYPE_DES) {
7372 psa_des_set_key_parity(key_buffer, key_buffer_size);
7373 }
David Brown8107e312021-02-12 08:08:46 -07007374#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine449bd832023-01-11 14:50:10 +01007375 } else
Gilles Peskinee59236f2018-01-27 23:32:46 +01007376
Valerio Setti76df8c12023-07-11 14:11:28 +02007377#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007378 if (type == PSA_KEY_TYPE_RSA_KEY_PAIR) {
7379 return mbedtls_psa_rsa_generate_key(attributes,
7380 key_buffer,
7381 key_buffer_size,
7382 key_buffer_length);
7383 } else
Valerio Setti76df8c12023-07-11 14:11:28 +02007384#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_GENERATE) */
Gilles Peskinee59236f2018-01-27 23:32:46 +01007385
Valerio Settibfeaf5b2023-06-20 13:27:46 +02007386#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007387 if (PSA_KEY_TYPE_IS_ECC(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
7388 return mbedtls_psa_ecp_generate_key(attributes,
7389 key_buffer,
7390 key_buffer_size,
7391 key_buffer_length);
7392 } else
Valerio Settibfeaf5b2023-06-20 13:27:46 +02007393#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_GENERATE) */
Przemek Stekielfedd1342022-12-01 15:00:02 +01007394
Valerio Settia55f0422023-07-10 15:34:41 +02007395#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_GENERATE)
Przemek Stekielfedd1342022-12-01 15:00:02 +01007396 if (PSA_KEY_TYPE_IS_DH(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
7397 return mbedtls_psa_ffdh_generate_key(attributes,
7398 key_buffer,
7399 key_buffer_size,
7400 key_buffer_length);
7401 } else
Valerio Settia55f0422023-07-10 15:34:41 +02007402#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_GENERATE) */
Steven Cooreman29149862020-08-05 15:43:42 +02007403 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007404 (void) key_buffer_length;
7405 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman29149862020-08-05 15:43:42 +02007406 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01007407
Gilles Peskine449bd832023-01-11 14:50:10 +01007408 return PSA_SUCCESS;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02007409}
Darryl Green0c6575a2018-11-07 16:05:30 +00007410
Gilles Peskine449bd832023-01-11 14:50:10 +01007411psa_status_t psa_generate_key(const psa_key_attributes_t *attributes,
7412 mbedtls_svc_key_id_t *key)
Gilles Peskineff5f0e72019-04-18 12:53:30 +02007413{
7414 psa_status_t status;
7415 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02007416 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cron2b56bc82020-10-05 10:02:26 +02007417 size_t key_buffer_size;
Gilles Peskine11792082019-08-06 18:36:36 +02007418
Ronald Cron81709fc2020-11-14 12:10:32 +01007419 *key = MBEDTLS_SVC_KEY_ID_INIT;
7420
Gilles Peskine0f84d622019-09-12 19:03:13 +02007421 /* Reject any attempt to create a zero-length key so that we don't
7422 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007423 if (psa_get_key_bits(attributes) == 0) {
7424 return PSA_ERROR_INVALID_ARGUMENT;
7425 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02007426
Przemyslaw Stekielc0fe8202021-10-07 11:08:56 +02007427 /* Reject any attempt to create a public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007428 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(attributes->core.type)) {
7429 return PSA_ERROR_INVALID_ARGUMENT;
7430 }
Przemyslaw Stekielc0fe8202021-10-07 11:08:56 +02007431
Gilles Peskine449bd832023-01-11 14:50:10 +01007432 status = psa_start_key_creation(PSA_KEY_CREATION_GENERATE, attributes,
7433 &slot, &driver);
7434 if (status != PSA_SUCCESS) {
Gilles Peskine11792082019-08-06 18:36:36 +02007435 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007436 }
Gilles Peskine11792082019-08-06 18:36:36 +02007437
Ronald Cron977c2472020-10-13 08:32:21 +02007438 /* In the case of a transparent key or an opaque key stored in local
Archana449608b2021-09-08 15:36:05 +05307439 * storage ( thus not in the case of generating a key in a secure element
7440 * with storage ( MBEDTLS_PSA_CRYPTO_SE_C ) ),we have to allocate a
7441 * buffer to hold the generated key material. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007442 if (slot->key.data == NULL) {
7443 if (PSA_KEY_LIFETIME_GET_LOCATION(attributes->core.lifetime) ==
7444 PSA_KEY_LOCATION_LOCAL_STORAGE) {
Ronald Cron3772afe2021-02-08 16:10:05 +01007445 status = psa_validate_key_type_and_size_for_key_generation(
Gilles Peskine449bd832023-01-11 14:50:10 +01007446 attributes->core.type, attributes->core.bits);
7447 if (status != PSA_SUCCESS) {
Ronald Cron3772afe2021-02-08 16:10:05 +01007448 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007449 }
Ronald Cron3772afe2021-02-08 16:10:05 +01007450
7451 key_buffer_size = PSA_EXPORT_KEY_OUTPUT_SIZE(
Gilles Peskine449bd832023-01-11 14:50:10 +01007452 attributes->core.type,
7453 attributes->core.bits);
7454 } else {
Ronald Cron977c2472020-10-13 08:32:21 +02007455 status = psa_driver_wrapper_get_key_buffer_size(
Gilles Peskine449bd832023-01-11 14:50:10 +01007456 attributes, &key_buffer_size);
7457 if (status != PSA_SUCCESS) {
Ronald Cron3772afe2021-02-08 16:10:05 +01007458 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007459 }
Ronald Cron977c2472020-10-13 08:32:21 +02007460 }
Ronald Cron977c2472020-10-13 08:32:21 +02007461
Gilles Peskine449bd832023-01-11 14:50:10 +01007462 status = psa_allocate_buffer_to_slot(slot, key_buffer_size);
7463 if (status != PSA_SUCCESS) {
Ronald Cron977c2472020-10-13 08:32:21 +02007464 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007465 }
Ronald Cron977c2472020-10-13 08:32:21 +02007466 }
7467
Gilles Peskine449bd832023-01-11 14:50:10 +01007468 status = psa_driver_wrapper_generate_key(attributes,
7469 slot->key.data, slot->key.bytes, &slot->key.bytes);
Gilles Peskine11792082019-08-06 18:36:36 +02007470
Gilles Peskine449bd832023-01-11 14:50:10 +01007471 if (status != PSA_SUCCESS) {
7472 psa_remove_key_data_from_memory(slot);
7473 }
Ronald Cron2b56bc82020-10-05 10:02:26 +02007474
Gilles Peskine11792082019-08-06 18:36:36 +02007475exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007476 if (status == PSA_SUCCESS) {
7477 status = psa_finish_key_creation(slot, driver, key);
7478 }
7479 if (status != PSA_SUCCESS) {
7480 psa_fail_key_creation(slot, driver);
7481 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007482
Gilles Peskine449bd832023-01-11 14:50:10 +01007483 return status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007484}
7485
Gilles Peskinee59236f2018-01-27 23:32:46 +01007486/****************************************************************/
7487/* Module setup */
7488/****************************************************************/
7489
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007490#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine5e769522018-11-20 21:59:56 +01007491psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
Gilles Peskine449bd832023-01-11 14:50:10 +01007492 void (* entropy_init)(mbedtls_entropy_context *ctx),
7493 void (* entropy_free)(mbedtls_entropy_context *ctx))
Gilles Peskine5e769522018-11-20 21:59:56 +01007494{
Gilles Peskine449bd832023-01-11 14:50:10 +01007495 if (global_data.rng_state != RNG_NOT_INITIALIZED) {
7496 return PSA_ERROR_BAD_STATE;
7497 }
Gilles Peskine30524eb2020-11-13 17:02:26 +01007498 global_data.rng.entropy_init = entropy_init;
7499 global_data.rng.entropy_free = entropy_free;
Gilles Peskine449bd832023-01-11 14:50:10 +01007500 return PSA_SUCCESS;
Gilles Peskine5e769522018-11-20 21:59:56 +01007501}
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007502#endif /* !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) */
Gilles Peskine5e769522018-11-20 21:59:56 +01007503
Gilles Peskine449bd832023-01-11 14:50:10 +01007504void mbedtls_psa_crypto_free(void)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007505{
Gilles Peskine449bd832023-01-11 14:50:10 +01007506 psa_wipe_all_key_slots();
Valerio Setti83e0de82023-11-24 12:13:05 +01007507 if (global_data.rng_state != RNG_NOT_INITIALIZED) {
7508 mbedtls_psa_random_free(&global_data.rng);
7509 }
Gilles Peskinec6b69072018-11-20 21:42:52 +01007510 /* Wipe all remaining data, including configuration.
7511 * In particular, this sets all state indicator to the value
7512 * indicating "uninitialized". */
Gilles Peskine449bd832023-01-11 14:50:10 +01007513 mbedtls_platform_zeroize(&global_data, sizeof(global_data));
Ronald Cron9ba76912021-04-10 16:57:30 +02007514
7515 /* Terminate drivers */
Gilles Peskine449bd832023-01-11 14:50:10 +01007516 psa_driver_wrapper_free();
Gilles Peskinee59236f2018-01-27 23:32:46 +01007517}
7518
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007519#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
7520/** Recover a transaction that was interrupted by a power failure.
7521 *
7522 * This function is called during initialization, before psa_crypto_init()
7523 * returns. If this function returns a failure status, the initialization
7524 * fails.
7525 */
7526static psa_status_t psa_crypto_recover_transaction(
Gilles Peskine449bd832023-01-11 14:50:10 +01007527 const psa_crypto_transaction_t *transaction)
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007528{
Gilles Peskine449bd832023-01-11 14:50:10 +01007529 switch (transaction->unknown.type) {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007530 case PSA_CRYPTO_TRANSACTION_CREATE_KEY:
7531 case PSA_CRYPTO_TRANSACTION_DESTROY_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01007532 /* TODO - fall through to the failure case until this
7533 * is implemented.
7534 * https://github.com/ARMmbed/mbed-crypto/issues/218
7535 */
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007536 default:
7537 /* We found an unsupported transaction in the storage.
7538 * We don't know what state the storage is in. Give up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007539 return PSA_ERROR_DATA_INVALID;
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007540 }
7541}
7542#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
7543
Gilles Peskine449bd832023-01-11 14:50:10 +01007544psa_status_t psa_crypto_init(void)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007545{
Gilles Peskine66fb1262018-12-10 16:29:04 +01007546 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007547
Gilles Peskinec6b69072018-11-20 21:42:52 +01007548 /* Double initialization is explicitly allowed. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007549 if (global_data.initialized != 0) {
7550 return PSA_SUCCESS;
7551 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01007552
Manuel Pégourié-Gonnard7abdf7e2023-03-09 11:17:43 +01007553 /* Init drivers */
7554 status = psa_driver_wrapper_init();
7555 if (status != PSA_SUCCESS) {
7556 goto exit;
7557 }
7558 global_data.drivers_initialized = 1;
7559
Valerio Setti402cfba2023-11-13 10:24:32 +01007560 status = psa_initialize_key_slots();
7561 if (status != PSA_SUCCESS) {
7562 goto exit;
7563 }
7564
Gilles Peskine30524eb2020-11-13 17:02:26 +01007565 /* Initialize and seed the random generator. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007566 mbedtls_psa_random_init(&global_data.rng);
Gilles Peskinec6b69072018-11-20 21:42:52 +01007567 global_data.rng_state = RNG_INITIALIZED;
Gilles Peskine449bd832023-01-11 14:50:10 +01007568 status = mbedtls_psa_random_seed(&global_data.rng);
7569 if (status != PSA_SUCCESS) {
Gilles Peskinee59236f2018-01-27 23:32:46 +01007570 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007571 }
Gilles Peskinec6b69072018-11-20 21:42:52 +01007572 global_data.rng_state = RNG_SEEDED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007573
Gilles Peskine4b734222019-07-24 15:56:31 +02007574#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007575 status = psa_crypto_load_transaction();
7576 if (status == PSA_SUCCESS) {
7577 status = psa_crypto_recover_transaction(&psa_crypto_transaction);
7578 if (status != PSA_SUCCESS) {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007579 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007580 }
7581 status = psa_crypto_stop_transaction();
7582 } else if (status == PSA_ERROR_DOES_NOT_EXIST) {
Gilles Peskinefc762652019-07-22 19:30:34 +02007583 /* There's no transaction to complete. It's all good. */
7584 status = PSA_SUCCESS;
7585 }
Gilles Peskine4b734222019-07-24 15:56:31 +02007586#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
Gilles Peskinefc762652019-07-22 19:30:34 +02007587
Gilles Peskinec6b69072018-11-20 21:42:52 +01007588 /* All done. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01007589 global_data.initialized = 1;
7590
7591exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007592 if (status != PSA_SUCCESS) {
7593 mbedtls_psa_crypto_free();
7594 }
7595 return status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007596}
7597
Yanray Wangffc3c482023-07-11 12:01:04 +08007598#if defined(PSA_WANT_ALG_SOME_PAKE)
Przemek Stekielca8d2b22023-01-17 16:21:33 +01007599psa_status_t psa_crypto_driver_pake_get_password_len(
7600 const psa_crypto_driver_pake_inputs_t *inputs,
7601 size_t *password_len)
7602{
7603 if (inputs->password_len == 0) {
7604 return PSA_ERROR_BAD_STATE;
7605 }
7606
7607 *password_len = inputs->password_len;
7608
7609 return PSA_SUCCESS;
7610}
7611
7612psa_status_t psa_crypto_driver_pake_get_password(
7613 const psa_crypto_driver_pake_inputs_t *inputs,
7614 uint8_t *buffer, size_t buffer_size, size_t *buffer_length)
7615{
7616 if (inputs->password_len == 0) {
7617 return PSA_ERROR_BAD_STATE;
7618 }
7619
7620 if (buffer_size < inputs->password_len) {
7621 return PSA_ERROR_BUFFER_TOO_SMALL;
7622 }
7623
7624 memcpy(buffer, inputs->password, inputs->password_len);
7625 *buffer_length = inputs->password_len;
7626
7627 return PSA_SUCCESS;
7628}
7629
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007630psa_status_t psa_crypto_driver_pake_get_user_len(
7631 const psa_crypto_driver_pake_inputs_t *inputs,
7632 size_t *user_len)
7633{
7634 if (inputs->user_len == 0) {
7635 return PSA_ERROR_BAD_STATE;
7636 }
7637
7638 *user_len = inputs->user_len;
7639
7640 return PSA_SUCCESS;
7641}
7642
7643psa_status_t psa_crypto_driver_pake_get_user(
7644 const psa_crypto_driver_pake_inputs_t *inputs,
Przemek Stekielc0e62502023-03-14 11:49:36 +01007645 uint8_t *user_id, size_t user_id_size, size_t *user_id_len)
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007646{
7647 if (inputs->user_len == 0) {
7648 return PSA_ERROR_BAD_STATE;
7649 }
7650
Przemek Stekielc0e62502023-03-14 11:49:36 +01007651 if (user_id_size < inputs->user_len) {
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007652 return PSA_ERROR_BUFFER_TOO_SMALL;
7653 }
7654
Przemek Stekielc0e62502023-03-14 11:49:36 +01007655 memcpy(user_id, inputs->user, inputs->user_len);
7656 *user_id_len = inputs->user_len;
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007657
7658 return PSA_SUCCESS;
7659}
7660
7661psa_status_t psa_crypto_driver_pake_get_peer_len(
7662 const psa_crypto_driver_pake_inputs_t *inputs,
7663 size_t *peer_len)
7664{
7665 if (inputs->peer_len == 0) {
7666 return PSA_ERROR_BAD_STATE;
7667 }
7668
7669 *peer_len = inputs->peer_len;
7670
7671 return PSA_SUCCESS;
7672}
7673
7674psa_status_t psa_crypto_driver_pake_get_peer(
7675 const psa_crypto_driver_pake_inputs_t *inputs,
Przemek Stekielc0e62502023-03-14 11:49:36 +01007676 uint8_t *peer_id, size_t peer_id_size, size_t *peer_id_length)
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007677{
7678 if (inputs->peer_len == 0) {
7679 return PSA_ERROR_BAD_STATE;
7680 }
7681
Przemek Stekielc0e62502023-03-14 11:49:36 +01007682 if (peer_id_size < inputs->peer_len) {
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007683 return PSA_ERROR_BUFFER_TOO_SMALL;
7684 }
7685
Przemek Stekielc0e62502023-03-14 11:49:36 +01007686 memcpy(peer_id, inputs->peer, inputs->peer_len);
7687 *peer_id_length = inputs->peer_len;
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007688
7689 return PSA_SUCCESS;
7690}
7691
Przemek Stekielca8d2b22023-01-17 16:21:33 +01007692psa_status_t psa_crypto_driver_pake_get_cipher_suite(
7693 const psa_crypto_driver_pake_inputs_t *inputs,
7694 psa_pake_cipher_suite_t *cipher_suite)
7695{
7696 if (inputs->cipher_suite.algorithm == PSA_ALG_NONE) {
7697 return PSA_ERROR_BAD_STATE;
7698 }
7699
7700 *cipher_suite = inputs->cipher_suite;
7701
7702 return PSA_SUCCESS;
7703}
7704
Neil Armstronga7d08c32022-06-01 18:21:20 +02007705psa_status_t psa_pake_setup(
7706 psa_pake_operation_t *operation,
7707 const psa_pake_cipher_suite_t *cipher_suite)
7708{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007709 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007710
Przemek Stekiel1c3cfb42023-01-26 10:35:02 +01007711 if (operation->stage != PSA_PAKE_OPERATION_STAGE_SETUP) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007712 status = PSA_ERROR_BAD_STATE;
7713 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007714 }
7715
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01007716 if (PSA_ALG_IS_PAKE(cipher_suite->algorithm) == 0 ||
Przemek Stekiel51eac532022-12-07 11:04:51 +01007717 PSA_ALG_IS_HASH(cipher_suite->hash) == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007718 status = PSA_ERROR_INVALID_ARGUMENT;
7719 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007720 }
7721
Przemek Stekiel51eac532022-12-07 11:04:51 +01007722 memset(&operation->data.inputs, 0, sizeof(operation->data.inputs));
7723
Przemek Stekiele12ed362022-12-21 12:54:46 +01007724 operation->alg = cipher_suite->algorithm;
Przemek Stekiel656b2592023-03-22 13:15:33 +01007725 operation->primitive = PSA_PAKE_PRIMITIVE(cipher_suite->type,
7726 cipher_suite->family, cipher_suite->bits);
Przemek Stekiel51eac532022-12-07 11:04:51 +01007727 operation->data.inputs.cipher_suite = *cipher_suite;
7728
Przemek Stekiel4aa99402023-02-27 13:00:57 +01007729#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01007730 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01007731 psa_jpake_computation_stage_t *computation_stage =
Przemek Stekieldde6a912023-01-26 08:46:37 +01007732 &operation->computation_stage.jpake;
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01007733
David Horstmann16f01512023-06-14 17:21:07 +01007734 memset(computation_stage, 0, sizeof(*computation_stage));
David Horstmanne7f21e62023-05-12 18:17:21 +01007735 computation_stage->step = PSA_PAKE_STEP_KEY_SHARE;
Przemek Stekiel80a88492023-02-20 13:32:22 +01007736 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007737#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01007738 {
7739 status = PSA_ERROR_NOT_SUPPORTED;
7740 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01007741 }
7742
Przemek Stekiel1c3cfb42023-01-26 10:35:02 +01007743 operation->stage = PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS;
7744
Przemek Stekiel51eac532022-12-07 11:04:51 +01007745 return PSA_SUCCESS;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007746exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007747 psa_pake_abort(operation);
7748 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02007749}
7750
7751psa_status_t psa_pake_set_password_key(
7752 psa_pake_operation_t *operation,
7753 mbedtls_svc_key_id_t password)
7754{
Neil Armstrong5ae60962022-09-15 11:29:46 +02007755 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel6c764412022-11-22 14:05:12 +01007756 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
7757 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007758 psa_key_attributes_t attributes;
7759 psa_key_type_t type;
Neil Armstrong5ae60962022-09-15 11:29:46 +02007760
Przemek Stekiel51eac532022-12-07 11:04:51 +01007761 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007762 status = PSA_ERROR_BAD_STATE;
7763 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007764 }
7765
Przemek Stekiel6c764412022-11-22 14:05:12 +01007766 status = psa_get_and_lock_key_slot_with_policy(password, &slot,
7767 PSA_KEY_USAGE_DERIVE,
Przemek Stekield5d28a22023-01-26 10:46:05 +01007768 operation->alg);
Neil Armstrong5ae60962022-09-15 11:29:46 +02007769 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007770 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02007771 }
7772
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007773 attributes = (psa_key_attributes_t) {
Przemek Stekiel6c764412022-11-22 14:05:12 +01007774 .core = slot->attr
7775 };
Neil Armstrong5ae60962022-09-15 11:29:46 +02007776
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007777 type = psa_get_key_type(&attributes);
Neil Armstrong5ae60962022-09-15 11:29:46 +02007778
Przemek Stekiel51eac532022-12-07 11:04:51 +01007779 if (type != PSA_KEY_TYPE_PASSWORD &&
7780 type != PSA_KEY_TYPE_PASSWORD_HASH) {
7781 status = PSA_ERROR_INVALID_ARGUMENT;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007782 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007783 }
7784
Przemek Stekiel51eac532022-12-07 11:04:51 +01007785 operation->data.inputs.password = mbedtls_calloc(1, slot->key.bytes);
7786 if (operation->data.inputs.password == NULL) {
Przemek Stekiele12ed362022-12-21 12:54:46 +01007787 status = PSA_ERROR_INSUFFICIENT_MEMORY;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007788 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007789 }
7790
7791 memcpy(operation->data.inputs.password, slot->key.data, slot->key.bytes);
7792 operation->data.inputs.password_len = slot->key.bytes;
Przemek Stekiel9dd24402023-01-26 15:06:09 +01007793 operation->data.inputs.attributes = attributes;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007794exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007795 if (status != PSA_SUCCESS) {
7796 psa_pake_abort(operation);
7797 }
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007798 unlock_status = psa_unlock_key_slot(slot);
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007799 return (status == PSA_SUCCESS) ? unlock_status : status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02007800}
7801
7802psa_status_t psa_pake_set_user(
7803 psa_pake_operation_t *operation,
7804 const uint8_t *user_id,
7805 size_t user_id_len)
7806{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007807 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007808
7809 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007810 status = PSA_ERROR_BAD_STATE;
7811 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02007812 }
7813
Przemek Stekiel51eac532022-12-07 11:04:51 +01007814 if (user_id_len == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007815 status = PSA_ERROR_INVALID_ARGUMENT;
7816 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02007817 }
7818
Przemek Stekielf309d6b2023-03-10 09:54:45 +01007819 if (operation->data.inputs.user_len != 0) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007820 status = PSA_ERROR_BAD_STATE;
7821 goto exit;
7822 }
7823
Przemek Stekielf309d6b2023-03-10 09:54:45 +01007824 operation->data.inputs.user = mbedtls_calloc(1, user_id_len);
7825 if (operation->data.inputs.user == NULL) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007826 status = PSA_ERROR_INSUFFICIENT_MEMORY;
7827 goto exit;
7828 }
7829
Przemek Stekielf309d6b2023-03-10 09:54:45 +01007830 memcpy(operation->data.inputs.user, user_id, user_id_len);
7831 operation->data.inputs.user_len = user_id_len;
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007832
7833 return PSA_SUCCESS;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007834exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007835 psa_pake_abort(operation);
7836 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02007837}
7838
7839psa_status_t psa_pake_set_peer(
7840 psa_pake_operation_t *operation,
7841 const uint8_t *peer_id,
7842 size_t peer_id_len)
7843{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007844 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007845
7846 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007847 status = PSA_ERROR_BAD_STATE;
7848 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02007849 }
7850
Przemek Stekiel51eac532022-12-07 11:04:51 +01007851 if (peer_id_len == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007852 status = PSA_ERROR_INVALID_ARGUMENT;
7853 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02007854 }
7855
Przemek Stekielf309d6b2023-03-10 09:54:45 +01007856 if (operation->data.inputs.peer_len != 0) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007857 status = PSA_ERROR_BAD_STATE;
7858 goto exit;
7859 }
7860
Przemek Stekielf309d6b2023-03-10 09:54:45 +01007861 operation->data.inputs.peer = mbedtls_calloc(1, peer_id_len);
7862 if (operation->data.inputs.peer == NULL) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007863 status = PSA_ERROR_INSUFFICIENT_MEMORY;
7864 goto exit;
7865 }
7866
Przemek Stekielf309d6b2023-03-10 09:54:45 +01007867 memcpy(operation->data.inputs.peer, peer_id, peer_id_len);
7868 operation->data.inputs.peer_len = peer_id_len;
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007869
7870 return PSA_SUCCESS;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007871exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007872 psa_pake_abort(operation);
7873 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02007874}
7875
7876psa_status_t psa_pake_set_role(
7877 psa_pake_operation_t *operation,
7878 psa_pake_role_t role)
7879{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007880 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007881
Przemek Stekiel51eac532022-12-07 11:04:51 +01007882 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007883 status = PSA_ERROR_BAD_STATE;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007884 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007885 }
7886
Przemek Stekiel09104b82023-03-06 14:11:51 +01007887 switch (operation->alg) {
7888#if defined(PSA_WANT_ALG_JPAKE)
7889 case PSA_ALG_JPAKE:
7890 if (role == PSA_PAKE_ROLE_NONE) {
7891 return PSA_SUCCESS;
7892 }
7893 status = PSA_ERROR_INVALID_ARGUMENT;
7894 break;
7895#endif
7896 default:
7897 (void) role;
7898 status = PSA_ERROR_NOT_SUPPORTED;
7899 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02007900 }
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007901exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007902 psa_pake_abort(operation);
7903 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02007904}
7905
David Horstmanne7f21e62023-05-12 18:17:21 +01007906/* Auxiliary function to convert core computation stage to single driver step. */
Przemek Stekiel4aa99402023-02-27 13:00:57 +01007907#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiel251e86a2023-02-17 14:30:50 +01007908static psa_crypto_driver_pake_step_t convert_jpake_computation_stage_to_driver_step(
Przemek Stekieldde6a912023-01-26 08:46:37 +01007909 psa_jpake_computation_stage_t *stage)
Przemek Stekielb09c4872023-01-17 12:05:38 +01007910{
David Horstmann74a3d8c2023-06-14 18:28:19 +01007911 psa_crypto_driver_pake_step_t key_share_step;
David Horstmann5da95602023-06-08 15:37:12 +01007912 if (stage->round == PSA_JPAKE_FIRST) {
David Horstmanne7f21e62023-05-12 18:17:21 +01007913 int is_x1;
David Horstmann74a3d8c2023-06-14 18:28:19 +01007914
David Horstmann024e5c52023-06-14 15:48:21 +01007915 if (stage->io_mode == PSA_JPAKE_OUTPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01007916 is_x1 = (stage->outputs < 1);
7917 } else {
7918 is_x1 = (stage->inputs < 1);
7919 }
7920
David Horstmann74a3d8c2023-06-14 18:28:19 +01007921 key_share_step = is_x1 ?
7922 PSA_JPAKE_X1_STEP_KEY_SHARE :
7923 PSA_JPAKE_X2_STEP_KEY_SHARE;
David Horstmann5da95602023-06-08 15:37:12 +01007924 } else if (stage->round == PSA_JPAKE_SECOND) {
David Horstmann74a3d8c2023-06-14 18:28:19 +01007925 key_share_step = (stage->io_mode == PSA_JPAKE_OUTPUT) ?
7926 PSA_JPAKE_X2S_STEP_KEY_SHARE :
7927 PSA_JPAKE_X4S_STEP_KEY_SHARE;
7928 } else {
7929 return PSA_JPAKE_STEP_INVALID;
Przemek Stekielb09c4872023-01-17 12:05:38 +01007930 }
Agathiyan Bragadeesh387bfa52023-07-17 17:01:33 +01007931 return (psa_crypto_driver_pake_step_t) (key_share_step + stage->step - PSA_PAKE_STEP_KEY_SHARE);
Przemek Stekielb09c4872023-01-17 12:05:38 +01007932}
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007933#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekielb09c4872023-01-17 12:05:38 +01007934
Przemek Stekiel2797d372022-12-22 11:19:22 +01007935static psa_status_t psa_pake_complete_inputs(
7936 psa_pake_operation_t *operation)
7937{
Przemek Stekiel2797d372022-12-22 11:19:22 +01007938 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel18620a32023-01-17 16:34:52 +01007939 /* Create copy of the inputs on stack as inputs share memory
7940 with the driver context which will be setup by the driver. */
7941 psa_crypto_driver_pake_inputs_t inputs = operation->data.inputs;
Przemek Stekiel2797d372022-12-22 11:19:22 +01007942
Przemek Stekielfde11282023-03-13 16:06:09 +01007943 if (inputs.password_len == 0) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01007944 return PSA_ERROR_BAD_STATE;
7945 }
7946
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007947 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekielfde11282023-03-13 16:06:09 +01007948 if (inputs.user_len == 0 || inputs.peer_len == 0) {
7949 return PSA_ERROR_BAD_STATE;
7950 }
Przemek Stekieldff21d32023-02-14 20:09:10 +01007951 }
7952
Przemek Stekiel18620a32023-01-17 16:34:52 +01007953 /* Clear driver context */
7954 mbedtls_platform_zeroize(&operation->data, sizeof(operation->data));
7955
7956 status = psa_driver_wrapper_pake_setup(operation, &inputs);
Przemek Stekiel2797d372022-12-22 11:19:22 +01007957
7958 /* Driver is responsible for creating its own copy of the password. */
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01007959 mbedtls_zeroize_and_free(inputs.password, inputs.password_len);
Przemek Stekiel2797d372022-12-22 11:19:22 +01007960
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007961 /* User and peer are translated to role. */
7962 mbedtls_free(inputs.user);
7963 mbedtls_free(inputs.peer);
7964
Przemek Stekiel2797d372022-12-22 11:19:22 +01007965 if (status == PSA_SUCCESS) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01007966#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiel2797d372022-12-22 11:19:22 +01007967 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekield93de322023-02-24 08:39:04 +01007968 operation->stage = PSA_PAKE_OPERATION_STAGE_COMPUTATION;
Przemek Stekiel80a88492023-02-20 13:32:22 +01007969 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007970#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01007971 {
7972 status = PSA_ERROR_NOT_SUPPORTED;
Przemek Stekiel2797d372022-12-22 11:19:22 +01007973 }
Przemek Stekiel2797d372022-12-22 11:19:22 +01007974 }
Przemek Stekiel2797d372022-12-22 11:19:22 +01007975 return status;
7976}
7977
Przemek Stekiel4aa99402023-02-27 13:00:57 +01007978#if defined(PSA_WANT_ALG_JPAKE)
David Horstmanne7f21e62023-05-12 18:17:21 +01007979static psa_status_t psa_jpake_prologue(
Przemek Stekiele12ed362022-12-21 12:54:46 +01007980 psa_pake_operation_t *operation,
David Horstmanne7f21e62023-05-12 18:17:21 +01007981 psa_pake_step_t step,
David Horstmann00ad6bf2023-06-14 15:44:24 +01007982 psa_jpake_io_mode_t io_mode)
Przemek Stekiele12ed362022-12-21 12:54:46 +01007983{
Przemek Stekiele12ed362022-12-21 12:54:46 +01007984 if (step != PSA_PAKE_STEP_KEY_SHARE &&
7985 step != PSA_PAKE_STEP_ZK_PUBLIC &&
7986 step != PSA_PAKE_STEP_ZK_PROOF) {
7987 return PSA_ERROR_INVALID_ARGUMENT;
7988 }
7989
Przemek Stekiel5eff1032023-02-21 19:10:36 +01007990 psa_jpake_computation_stage_t *computation_stage =
7991 &operation->computation_stage.jpake;
Przemek Stekiele12ed362022-12-21 12:54:46 +01007992
David Horstmann5da95602023-06-08 15:37:12 +01007993 if (computation_stage->round != PSA_JPAKE_FIRST &&
7994 computation_stage->round != PSA_JPAKE_SECOND) {
Przemek Stekiel5eff1032023-02-21 19:10:36 +01007995 return PSA_ERROR_BAD_STATE;
7996 }
7997
David Horstmanne7f21e62023-05-12 18:17:21 +01007998 /* Check that the step we are given is the one we were expecting */
7999 if (step != computation_stage->step) {
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008000 return PSA_ERROR_BAD_STATE;
8001 }
8002
David Horstmanne7f21e62023-05-12 18:17:21 +01008003 if (step == PSA_PAKE_STEP_KEY_SHARE &&
8004 computation_stage->inputs == 0 &&
8005 computation_stage->outputs == 0) {
8006 /* Start of the round, so function decides whether we are inputting
8007 * or outputting */
David Horstmann024e5c52023-06-14 15:48:21 +01008008 computation_stage->io_mode = io_mode;
8009 } else if (computation_stage->io_mode != io_mode) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008010 /* Middle of the round so the mode we are in must match the function
8011 * called by the user */
8012 return PSA_ERROR_BAD_STATE;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008013 }
8014
8015 return PSA_SUCCESS;
8016}
8017
David Horstmanne7f21e62023-05-12 18:17:21 +01008018static psa_status_t psa_jpake_epilogue(
8019 psa_pake_operation_t *operation,
David Horstmann00ad6bf2023-06-14 15:44:24 +01008020 psa_jpake_io_mode_t io_mode)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008021{
David Horstmanne7f21e62023-05-12 18:17:21 +01008022 psa_jpake_computation_stage_t *stage =
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008023 &operation->computation_stage.jpake;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008024
David Horstmanne7f21e62023-05-12 18:17:21 +01008025 if (stage->step == PSA_PAKE_STEP_ZK_PROOF) {
8026 /* End of an input/output */
David Horstmann00ad6bf2023-06-14 15:44:24 +01008027 if (io_mode == PSA_JPAKE_INPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008028 stage->inputs++;
David Horstmann246ec5a2023-06-27 10:33:06 +01008029 if (stage->inputs == PSA_JPAKE_EXPECTED_INPUTS(stage->round)) {
David Horstmann024e5c52023-06-14 15:48:21 +01008030 stage->io_mode = PSA_JPAKE_OUTPUT;
David Horstmanne7f21e62023-05-12 18:17:21 +01008031 }
8032 }
David Horstmann00ad6bf2023-06-14 15:44:24 +01008033 if (io_mode == PSA_JPAKE_OUTPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008034 stage->outputs++;
David Horstmann246ec5a2023-06-27 10:33:06 +01008035 if (stage->outputs == PSA_JPAKE_EXPECTED_OUTPUTS(stage->round)) {
David Horstmann024e5c52023-06-14 15:48:21 +01008036 stage->io_mode = PSA_JPAKE_INPUT;
David Horstmanne7f21e62023-05-12 18:17:21 +01008037 }
8038 }
David Horstmann246ec5a2023-06-27 10:33:06 +01008039 if (stage->inputs == PSA_JPAKE_EXPECTED_INPUTS(stage->round) &&
8040 stage->outputs == PSA_JPAKE_EXPECTED_OUTPUTS(stage->round)) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008041 /* End of a round, move to the next round */
8042 stage->inputs = 0;
8043 stage->outputs = 0;
8044 stage->round++;
8045 }
8046 stage->step = PSA_PAKE_STEP_KEY_SHARE;
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008047 } else {
David Horstmanne7f21e62023-05-12 18:17:21 +01008048 stage->step++;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008049 }
Przemek Stekiele12ed362022-12-21 12:54:46 +01008050 return PSA_SUCCESS;
8051}
David Horstmanne7f21e62023-05-12 18:17:21 +01008052
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008053#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008054
Neil Armstronga7d08c32022-06-01 18:21:20 +02008055psa_status_t psa_pake_output(
8056 psa_pake_operation_t *operation,
8057 psa_pake_step_t step,
8058 uint8_t *output,
8059 size_t output_size,
8060 size_t *output_length)
8061{
Przemek Stekiel51eac532022-12-07 11:04:51 +01008062 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008063 psa_crypto_driver_pake_step_t driver_step = PSA_JPAKE_STEP_INVALID;
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008064 *output_length = 0;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008065
8066 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01008067 status = psa_pake_complete_inputs(operation);
8068 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008069 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008070 }
8071 }
8072
8073 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008074 status = PSA_ERROR_BAD_STATE;
8075 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008076 }
8077
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008078 if (output_size == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008079 status = PSA_ERROR_INVALID_ARGUMENT;
8080 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008081 }
8082
Przemek Stekiele12ed362022-12-21 12:54:46 +01008083 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008084#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008085 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008086 status = psa_jpake_prologue(operation, step, PSA_JPAKE_OUTPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008087 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008088 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008089 }
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008090 driver_step = convert_jpake_computation_stage_to_driver_step(
8091 &operation->computation_stage.jpake);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008092 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008093#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008094 default:
Przemek Stekiel80a88492023-02-20 13:32:22 +01008095 (void) step;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008096 status = PSA_ERROR_NOT_SUPPORTED;
8097 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008098 }
8099
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008100 status = psa_driver_wrapper_pake_output(operation, driver_step,
8101 output, output_size, output_length);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008102
8103 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008104 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008105 }
8106
8107 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008108#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008109 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008110 status = psa_jpake_epilogue(operation, PSA_JPAKE_OUTPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008111 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008112 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008113 }
8114 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008115#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008116 default:
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008117 status = PSA_ERROR_NOT_SUPPORTED;
8118 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008119 }
8120
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008121 return PSA_SUCCESS;
8122exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008123 psa_pake_abort(operation);
8124 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008125}
8126
8127psa_status_t psa_pake_input(
8128 psa_pake_operation_t *operation,
8129 psa_pake_step_t step,
8130 const uint8_t *input,
8131 size_t input_length)
8132{
Przemek Stekiel51eac532022-12-07 11:04:51 +01008133 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008134 psa_crypto_driver_pake_step_t driver_step = PSA_JPAKE_STEP_INVALID;
Przemek Stekiel256c75d2023-03-23 14:09:34 +01008135 const size_t max_input_length = (size_t) PSA_PAKE_INPUT_SIZE(operation->alg,
8136 operation->primitive,
8137 step);
Przemek Stekiel51eac532022-12-07 11:04:51 +01008138
8139 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01008140 status = psa_pake_complete_inputs(operation);
8141 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008142 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008143 }
8144 }
8145
8146 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008147 status = PSA_ERROR_BAD_STATE;
8148 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008149 }
8150
Przemek Stekiel256c75d2023-03-23 14:09:34 +01008151 if (input_length == 0 || input_length > max_input_length) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008152 status = PSA_ERROR_INVALID_ARGUMENT;
8153 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008154 }
8155
Przemek Stekiele12ed362022-12-21 12:54:46 +01008156 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008157#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008158 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008159 status = psa_jpake_prologue(operation, step, PSA_JPAKE_INPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008160 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008161 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008162 }
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008163 driver_step = convert_jpake_computation_stage_to_driver_step(
8164 &operation->computation_stage.jpake);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008165 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008166#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008167 default:
Przemek Stekiel80a88492023-02-20 13:32:22 +01008168 (void) step;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008169 status = PSA_ERROR_NOT_SUPPORTED;
8170 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008171 }
8172
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008173 status = psa_driver_wrapper_pake_input(operation, driver_step,
8174 input, input_length);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008175
8176 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008177 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008178 }
8179
8180 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008181#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008182 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008183 status = psa_jpake_epilogue(operation, PSA_JPAKE_INPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008184 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008185 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008186 }
8187 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008188#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008189 default:
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008190 status = PSA_ERROR_NOT_SUPPORTED;
8191 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008192 }
8193
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008194 return PSA_SUCCESS;
8195exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008196 psa_pake_abort(operation);
8197 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008198}
8199
8200psa_status_t psa_pake_get_implicit_key(
8201 psa_pake_operation_t *operation,
8202 psa_key_derivation_operation_t *output)
8203{
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008204 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008205 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel251e86a2023-02-17 14:30:50 +01008206 uint8_t shared_key[MBEDTLS_PSA_JPAKE_BUFFER_SIZE];
Przemek Stekiel0c781802022-11-29 14:53:13 +01008207 size_t shared_key_len = 0;
8208
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008209 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008210 status = PSA_ERROR_BAD_STATE;
8211 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008212 }
8213
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008214#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008215 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008216 psa_jpake_computation_stage_t *computation_stage =
Przemek Stekiel083745e2023-02-23 17:28:23 +01008217 &operation->computation_stage.jpake;
David Horstmann5da95602023-06-08 15:37:12 +01008218 if (computation_stage->round != PSA_JPAKE_FINISHED) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008219 status = PSA_ERROR_BAD_STATE;
8220 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008221 }
Przemek Stekiel80a88492023-02-20 13:32:22 +01008222 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008223#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01008224 {
8225 status = PSA_ERROR_NOT_SUPPORTED;
8226 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008227 }
8228
Przemek Stekiel0c781802022-11-29 14:53:13 +01008229 status = psa_driver_wrapper_pake_get_implicit_key(operation,
8230 shared_key,
Przemek Stekiel6b648622023-02-19 22:55:33 +01008231 sizeof(shared_key),
Przemek Stekiel0c781802022-11-29 14:53:13 +01008232 &shared_key_len);
8233
8234 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008235 goto exit;
Przemek Stekiel0c781802022-11-29 14:53:13 +01008236 }
8237
8238 status = psa_key_derivation_input_bytes(output,
8239 PSA_KEY_DERIVATION_INPUT_SECRET,
8240 shared_key,
8241 shared_key_len);
8242
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008243 mbedtls_platform_zeroize(shared_key, sizeof(shared_key));
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008244exit:
8245 abort_status = psa_pake_abort(operation);
8246 return status == PSA_SUCCESS ? abort_status : status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008247}
8248
8249psa_status_t psa_pake_abort(
8250 psa_pake_operation_t *operation)
8251{
Przemek Stekield69dca92023-01-31 19:59:20 +01008252 psa_status_t status = PSA_SUCCESS;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008253
Przemek Stekield69dca92023-01-31 19:59:20 +01008254 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008255 status = psa_driver_wrapper_pake_abort(operation);
Neil Armstrong5ae60962022-09-15 11:29:46 +02008256 }
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008257
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008258 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
8259 if (operation->data.inputs.password != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01008260 mbedtls_zeroize_and_free(operation->data.inputs.password,
Przemek Stekielaa183422023-03-06 14:21:44 +01008261 operation->data.inputs.password_len);
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008262 }
8263 if (operation->data.inputs.user != NULL) {
8264 mbedtls_free(operation->data.inputs.user);
8265 }
8266 if (operation->data.inputs.peer != NULL) {
8267 mbedtls_free(operation->data.inputs.peer);
8268 }
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008269 }
Przemek Stekield69dca92023-01-31 19:59:20 +01008270 memset(operation, 0, sizeof(psa_pake_operation_t));
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008271
Przemek Stekield69dca92023-01-31 19:59:20 +01008272 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008273}
Tom Cosgrove6d62fac2023-05-10 14:40:05 +01008274#endif /* PSA_WANT_ALG_SOME_PAKE */
Neil Armstronga7d08c32022-06-01 18:21:20 +02008275
Gilles Peskinee59236f2018-01-27 23:32:46 +01008276#endif /* MBEDTLS_PSA_CRYPTO_C */