blob: da5e5be778cf4e3e383d47eb426f64e4effb1be1 [file] [log] [blame]
Gilles Peskinee59236f2018-01-27 23:32:46 +01001/*
2 * PSA crypto layer on top of Mbed TLS crypto
3 */
Bence Szépkúti86974652020-06-15 11:59:37 +02004/*
Bence Szépkúti1e148272020-08-07 13:07:28 +02005 * Copyright The Mbed TLS Contributors
Dave Rodgman16799db2023-11-02 19:47:20 +00006 * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
Gilles Peskinee59236f2018-01-27 23:32:46 +01007 */
8
Gilles Peskinedb09ef62020-06-03 01:43:33 +02009#include "common.h"
Ronald Cronafbc7ed2023-01-24 16:02:04 +010010#include "psa_crypto_core_common.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010011
12#if defined(MBEDTLS_PSA_CRYPTO_C)
mohammad160327010052018-07-03 13:16:15 +030013
John Durkop07cc04a2020-11-16 22:08:34 -080014#if defined(MBEDTLS_PSA_CRYPTO_CONFIG)
15#include "check_crypto_config.h"
16#endif
17
Gilles Peskinee59236f2018-01-27 23:32:46 +010018#include "psa/crypto.h"
Przemyslaw Stekiel705fb0f2021-11-24 08:47:29 +010019#include "psa/crypto_values.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010020
Ronald Crond6d28882020-12-14 14:56:02 +010021#include "psa_crypto_cipher.h"
Gilles Peskine039b90c2018-12-07 18:24:41 +010022#include "psa_crypto_core.h"
Gilles Peskine5e769522018-11-20 21:59:56 +010023#include "psa_crypto_invasive.h"
Xiaokang Qiane9c39c42023-08-09 08:50:19 +000024#include "psa_crypto_driver_wrappers.h"
Xiaokang Qianfe9666b2023-09-11 10:36:20 +000025#include "psa_crypto_driver_wrappers_no_static.h"
Ronald Cron00b7bfc2020-11-25 15:25:26 +010026#include "psa_crypto_ecp.h"
Przemek Stekiel359f4622022-12-05 14:11:55 +010027#include "psa_crypto_ffdh.h"
Steven Cooreman5f88e772021-03-15 11:07:12 +010028#include "psa_crypto_hash.h"
Steven Cooreman82c66b62021-03-19 17:39:17 +010029#include "psa_crypto_mac.h"
Ronald Cron00b7bfc2020-11-25 15:25:26 +010030#include "psa_crypto_rsa.h"
Ronald Cron7023db52020-11-20 18:17:42 +010031#include "psa_crypto_ecp.h"
Gilles Peskinea8ade162019-06-26 11:24:49 +020032#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined0890212019-06-24 14:34:43 +020033#include "psa_crypto_se.h"
Gilles Peskinea8ade162019-06-26 11:24:49 +020034#endif
Gilles Peskine961849f2018-11-30 18:54:54 +010035#include "psa_crypto_slot_management.h"
Darryl Greend49a4992018-06-18 17:27:26 +010036/* Include internal declarations that are useful for implementing persistently
37 * stored keys. */
38#include "psa_crypto_storage.h"
39
Gilles Peskineb2b64d32020-12-14 16:43:58 +010040#include "psa_crypto_random_impl.h"
Gilles Peskine90edc992020-11-13 15:39:19 +010041
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010042#include <stdlib.h>
43#include <string.h>
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010044#include "mbedtls/platform.h"
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010045
Gilles Peskine1c49f1a2020-11-13 18:46:25 +010046#include "mbedtls/aes.h"
Gilles Peskine9a944802018-06-21 09:35:35 +020047#include "mbedtls/asn1.h"
Jaeden Amero25384a22019-01-10 10:23:21 +000048#include "mbedtls/asn1write.h"
Gilles Peskinea81d85b2018-06-26 16:10:23 +020049#include "mbedtls/bignum.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010050#include "mbedtls/camellia.h"
Gilles Peskine26869f22019-05-06 15:25:00 +020051#include "mbedtls/chacha20.h"
52#include "mbedtls/chachapoly.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010053#include "mbedtls/cipher.h"
54#include "mbedtls/ccm.h"
55#include "mbedtls/cmac.h"
Dave Rodgman78701152023-08-29 14:20:18 +010056#include "mbedtls/constant_time.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010057#include "mbedtls/des.h"
Gilles Peskineb7ecdf02018-09-18 12:11:27 +020058#include "mbedtls/ecdh.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010059#include "mbedtls/ecp.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010060#include "mbedtls/entropy.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010061#include "mbedtls/error.h"
62#include "mbedtls/gcm.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010063#include "mbedtls/md5.h"
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010064#include "mbedtls/pk.h"
Chris Jonesdaacb592021-03-09 17:03:29 +000065#include "pk_wrap.h"
Gilles Peskine3f108122018-12-07 18:14:53 +010066#include "mbedtls/platform_util.h"
Janos Follath24eed8d2019-11-22 13:21:35 +000067#include "mbedtls/error.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010068#include "mbedtls/ripemd160.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010069#include "mbedtls/rsa.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010070#include "mbedtls/sha1.h"
71#include "mbedtls/sha256.h"
72#include "mbedtls/sha512.h"
Manuel Pégourié-Gonnard02b10d82023-03-28 12:33:20 +020073#include "md_psa.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010074
Przemek Stekiel75fe3fb2022-06-09 14:44:55 +020075#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF) || \
76 defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT) || \
77 defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Przemek Stekiel69c46792022-06-10 12:59:51 +020078#define BUILTIN_ALG_ANY_HKDF 1
Przemek Stekiel75fe3fb2022-06-09 14:44:55 +020079#endif
80
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010081/****************************************************************/
82/* Global data, support functions and library management */
83/****************************************************************/
84
Gilles Peskine449bd832023-01-11 14:50:10 +010085static int key_type_is_raw_bytes(psa_key_type_t type)
Gilles Peskine48c0ea12018-06-21 14:15:31 +020086{
Gilles Peskine449bd832023-01-11 14:50:10 +010087 return PSA_KEY_TYPE_IS_UNSTRUCTURED(type);
Gilles Peskine48c0ea12018-06-21 14:15:31 +020088}
89
Gilles Peskine5a3c50e2018-12-04 12:27:09 +010090/* Values for psa_global_data_t::rng_state */
91#define RNG_NOT_INITIALIZED 0
92#define RNG_INITIALIZED 1
93#define RNG_SEEDED 2
Gilles Peskinec6b69072018-11-20 21:42:52 +010094
Gilles Peskine449bd832023-01-11 14:50:10 +010095typedef struct {
Dave Rodgman864f5942023-08-16 18:04:44 +010096 uint8_t initialized;
97 uint8_t rng_state;
98 uint8_t drivers_initialized;
Gilles Peskine2d8a1822021-11-08 22:20:03 +010099 mbedtls_psa_random_context_t rng;
Gilles Peskinee59236f2018-01-27 23:32:46 +0100100} psa_global_data_t;
101
102static psa_global_data_t global_data;
103
Gilles Peskine5894e8e2020-12-14 14:54:06 +0100104#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
105mbedtls_psa_drbg_context_t *const mbedtls_psa_random_state =
106 &global_data.rng.drbg;
107#endif
108
itayzafrir0adf0fc2018-09-06 16:24:41 +0300109#define GUARD_MODULE_INITIALIZED \
Gilles Peskine449bd832023-01-11 14:50:10 +0100110 if (global_data.initialized == 0) \
111 return PSA_ERROR_BAD_STATE;
itayzafrir0adf0fc2018-09-06 16:24:41 +0300112
Manuel Pégourié-Gonnard7abdf7e2023-03-09 11:17:43 +0100113int psa_can_do_hash(psa_algorithm_t hash_alg)
114{
115 (void) hash_alg;
116 return global_data.drivers_initialized;
117}
Valerio Settia55f0422023-07-10 15:34:41 +0200118#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_IMPORT) || \
Przemek Stekiel53410502023-04-28 13:18:43 +0200119 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY) || \
Valerio Settia55f0422023-07-10 15:34:41 +0200120 defined(PSA_WANT_KEY_TYPE_DH_KEY_PAIR_GENERATE)
Przemek Stekiel134cc2e2023-05-05 10:13:37 +0200121static int psa_is_dh_key_size_valid(size_t bits)
122{
Przemek Stekield1cf1ba2023-04-27 12:04:21 +0200123 if (bits != 2048 && bits != 3072 && bits != 4096 &&
124 bits != 6144 && bits != 8192) {
125 return 0;
126 }
127
128 return 1;
129}
Valerio Settia55f0422023-07-10 15:34:41 +0200130#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_IMPORT ||
Przemek Stekiel53410502023-04-28 13:18:43 +0200131 MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY ||
Valerio Settia55f0422023-07-10 15:34:41 +0200132 PSA_WANT_KEY_TYPE_DH_KEY_PAIR_GENERATE */
Manuel Pégourié-Gonnard7abdf7e2023-03-09 11:17:43 +0100133
Gilles Peskine449bd832023-01-11 14:50:10 +0100134psa_status_t mbedtls_to_psa_error(int ret)
Gilles Peskinee59236f2018-01-27 23:32:46 +0100135{
Gilles Peskinedbf68962021-01-06 20:04:23 +0100136 /* Mbed TLS error codes can combine a high-level error code and a
137 * low-level error code. The low-level error usually reflects the
138 * root cause better, so dispatch on that preferably. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100139 int low_level_ret = -(-ret & 0x007f);
140 switch (low_level_ret != 0 ? low_level_ret : ret) {
Gilles Peskinee59236f2018-01-27 23:32:46 +0100141 case 0:
Gilles Peskine449bd832023-01-11 14:50:10 +0100142 return PSA_SUCCESS;
Gilles Peskinea5905292018-02-07 20:59:33 +0100143
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100144#if defined(MBEDTLS_AES_C)
Gilles Peskinea5905292018-02-07 20:59:33 +0100145 case MBEDTLS_ERR_AES_INVALID_KEY_LENGTH:
146 case MBEDTLS_ERR_AES_INVALID_INPUT_LENGTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100147 return PSA_ERROR_NOT_SUPPORTED;
Dave Rodgman09a9e582023-08-31 11:05:22 +0100148 case MBEDTLS_ERR_AES_BAD_INPUT_DATA:
149 return PSA_ERROR_INVALID_ARGUMENT;
Dave Rodgman509b5672023-08-16 19:26:23 +0100150#endif
151
152#if defined(MBEDTLS_ASN1_PARSE_C) || defined(MBEDTLS_ASN1_WRITE_C)
Gilles Peskine9a944802018-06-21 09:35:35 +0200153 case MBEDTLS_ERR_ASN1_OUT_OF_DATA:
154 case MBEDTLS_ERR_ASN1_UNEXPECTED_TAG:
155 case MBEDTLS_ERR_ASN1_INVALID_LENGTH:
156 case MBEDTLS_ERR_ASN1_LENGTH_MISMATCH:
157 case MBEDTLS_ERR_ASN1_INVALID_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100158 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine9a944802018-06-21 09:35:35 +0200159 case MBEDTLS_ERR_ASN1_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100160 return PSA_ERROR_INSUFFICIENT_MEMORY;
Gilles Peskine9a944802018-06-21 09:35:35 +0200161 case MBEDTLS_ERR_ASN1_BUF_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +0100162 return PSA_ERROR_BUFFER_TOO_SMALL;
Dave Rodgman509b5672023-08-16 19:26:23 +0100163#endif
Gilles Peskine9a944802018-06-21 09:35:35 +0200164
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100165#if defined(MBEDTLS_CAMELLIA_C)
Jaeden Amero892cd6d2019-02-11 12:21:12 +0000166 case MBEDTLS_ERR_CAMELLIA_BAD_INPUT_DATA:
Gilles Peskinea5905292018-02-07 20:59:33 +0100167 case MBEDTLS_ERR_CAMELLIA_INVALID_INPUT_LENGTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100168 return PSA_ERROR_NOT_SUPPORTED;
Dave Rodgman509b5672023-08-16 19:26:23 +0100169#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100170
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100171#if defined(MBEDTLS_CCM_C)
Gilles Peskinea5905292018-02-07 20:59:33 +0100172 case MBEDTLS_ERR_CCM_BAD_INPUT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100173 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100174 case MBEDTLS_ERR_CCM_AUTH_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100175 return PSA_ERROR_INVALID_SIGNATURE;
Dave Rodgman509b5672023-08-16 19:26:23 +0100176#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100177
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100178#if defined(MBEDTLS_CHACHA20_C)
Gilles Peskine26869f22019-05-06 15:25:00 +0200179 case MBEDTLS_ERR_CHACHA20_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100180 return PSA_ERROR_INVALID_ARGUMENT;
Dave Rodgman509b5672023-08-16 19:26:23 +0100181#endif
Gilles Peskine26869f22019-05-06 15:25:00 +0200182
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100183#if defined(MBEDTLS_CHACHAPOLY_C)
Gilles Peskine26869f22019-05-06 15:25:00 +0200184 case MBEDTLS_ERR_CHACHAPOLY_BAD_STATE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100185 return PSA_ERROR_BAD_STATE;
Gilles Peskine26869f22019-05-06 15:25:00 +0200186 case MBEDTLS_ERR_CHACHAPOLY_AUTH_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100187 return PSA_ERROR_INVALID_SIGNATURE;
Dave Rodgman509b5672023-08-16 19:26:23 +0100188#endif
Gilles Peskine26869f22019-05-06 15:25:00 +0200189
Dave Rodgman509b5672023-08-16 19:26:23 +0100190#if defined(MBEDTLS_CIPHER_C)
Gilles Peskinea5905292018-02-07 20:59:33 +0100191 case MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100192 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea5905292018-02-07 20:59:33 +0100193 case MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100194 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100195 case MBEDTLS_ERR_CIPHER_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100196 return PSA_ERROR_INSUFFICIENT_MEMORY;
Gilles Peskinea5905292018-02-07 20:59:33 +0100197 case MBEDTLS_ERR_CIPHER_INVALID_PADDING:
Gilles Peskine449bd832023-01-11 14:50:10 +0100198 return PSA_ERROR_INVALID_PADDING;
Gilles Peskinea5905292018-02-07 20:59:33 +0100199 case MBEDTLS_ERR_CIPHER_FULL_BLOCK_EXPECTED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100200 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100201 case MBEDTLS_ERR_CIPHER_AUTH_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100202 return PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskinea5905292018-02-07 20:59:33 +0100203 case MBEDTLS_ERR_CIPHER_INVALID_CONTEXT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100204 return PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman509b5672023-08-16 19:26:23 +0100205#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100206
Gilles Peskine449bd832023-01-11 14:50:10 +0100207#if !(defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) || \
208 defined(MBEDTLS_PSA_HMAC_DRBG_MD_TYPE))
Gilles Peskinebee96c82020-11-23 21:00:09 +0100209 /* Only check CTR_DRBG error codes if underlying mbedtls_xxx
210 * functions are passed a CTR_DRBG instance. */
Gilles Peskinea5905292018-02-07 20:59:33 +0100211 case MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100212 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskinea5905292018-02-07 20:59:33 +0100213 case MBEDTLS_ERR_CTR_DRBG_REQUEST_TOO_BIG:
214 case MBEDTLS_ERR_CTR_DRBG_INPUT_TOO_BIG:
Gilles Peskine449bd832023-01-11 14:50:10 +0100215 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea5905292018-02-07 20:59:33 +0100216 case MBEDTLS_ERR_CTR_DRBG_FILE_IO_ERROR:
Gilles Peskine449bd832023-01-11 14:50:10 +0100217 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskine82e57d12020-11-13 21:31:17 +0100218#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100219
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100220#if defined(MBEDTLS_DES_C)
Gilles Peskinea5905292018-02-07 20:59:33 +0100221 case MBEDTLS_ERR_DES_INVALID_INPUT_LENGTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100222 return PSA_ERROR_NOT_SUPPORTED;
Dave Rodgman509b5672023-08-16 19:26:23 +0100223#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100224
Gilles Peskinee59236f2018-01-27 23:32:46 +0100225 case MBEDTLS_ERR_ENTROPY_NO_SOURCES_DEFINED:
226 case MBEDTLS_ERR_ENTROPY_NO_STRONG_SOURCE:
227 case MBEDTLS_ERR_ENTROPY_SOURCE_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100228 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskinea5905292018-02-07 20:59:33 +0100229
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100230#if defined(MBEDTLS_GCM_C)
Gilles Peskinea5905292018-02-07 20:59:33 +0100231 case MBEDTLS_ERR_GCM_AUTH_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100232 return PSA_ERROR_INVALID_SIGNATURE;
Mateusz Starzykf28261f2021-09-30 16:39:07 +0200233 case MBEDTLS_ERR_GCM_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +0100234 return PSA_ERROR_BUFFER_TOO_SMALL;
Gilles Peskinea5905292018-02-07 20:59:33 +0100235 case MBEDTLS_ERR_GCM_BAD_INPUT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100236 return PSA_ERROR_INVALID_ARGUMENT;
Dave Rodgman509b5672023-08-16 19:26:23 +0100237#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100238
Gilles Peskine82e57d12020-11-13 21:31:17 +0100239#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) && \
Gilles Peskine449bd832023-01-11 14:50:10 +0100240 defined(MBEDTLS_PSA_HMAC_DRBG_MD_TYPE)
Gilles Peskinebee96c82020-11-23 21:00:09 +0100241 /* Only check HMAC_DRBG error codes if underlying mbedtls_xxx
242 * functions are passed a HMAC_DRBG instance. */
Gilles Peskine82e57d12020-11-13 21:31:17 +0100243 case MBEDTLS_ERR_HMAC_DRBG_ENTROPY_SOURCE_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100244 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskine82e57d12020-11-13 21:31:17 +0100245 case MBEDTLS_ERR_HMAC_DRBG_REQUEST_TOO_BIG:
246 case MBEDTLS_ERR_HMAC_DRBG_INPUT_TOO_BIG:
Gilles Peskine449bd832023-01-11 14:50:10 +0100247 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine82e57d12020-11-13 21:31:17 +0100248 case MBEDTLS_ERR_HMAC_DRBG_FILE_IO_ERROR:
Gilles Peskine449bd832023-01-11 14:50:10 +0100249 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskine82e57d12020-11-13 21:31:17 +0100250#endif
251
Dave Rodgmandea266f2023-08-31 11:52:43 +0100252#if defined(MBEDTLS_MD_LIGHT)
Gilles Peskinea5905292018-02-07 20:59:33 +0100253 case MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100254 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea5905292018-02-07 20:59:33 +0100255 case MBEDTLS_ERR_MD_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100256 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100257 case MBEDTLS_ERR_MD_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100258 return PSA_ERROR_INSUFFICIENT_MEMORY;
Dave Rodgman509b5672023-08-16 19:26:23 +0100259#if defined(MBEDTLS_FS_IO)
Gilles Peskinea5905292018-02-07 20:59:33 +0100260 case MBEDTLS_ERR_MD_FILE_IO_ERROR:
Gilles Peskine449bd832023-01-11 14:50:10 +0100261 return PSA_ERROR_STORAGE_FAILURE;
Dave Rodgman509b5672023-08-16 19:26:23 +0100262#endif
263#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100264
Dave Rodgman509b5672023-08-16 19:26:23 +0100265#if defined(MBEDTLS_BIGNUM_C)
266#if defined(MBEDTLS_FS_IO)
Gilles Peskinef76aa772018-10-29 19:24:33 +0100267 case MBEDTLS_ERR_MPI_FILE_IO_ERROR:
Gilles Peskine449bd832023-01-11 14:50:10 +0100268 return PSA_ERROR_STORAGE_FAILURE;
Dave Rodgman509b5672023-08-16 19:26:23 +0100269#endif
Gilles Peskinef76aa772018-10-29 19:24:33 +0100270 case MBEDTLS_ERR_MPI_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100271 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100272 case MBEDTLS_ERR_MPI_INVALID_CHARACTER:
Gilles Peskine449bd832023-01-11 14:50:10 +0100273 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100274 case MBEDTLS_ERR_MPI_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +0100275 return PSA_ERROR_BUFFER_TOO_SMALL;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100276 case MBEDTLS_ERR_MPI_NEGATIVE_VALUE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100277 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100278 case MBEDTLS_ERR_MPI_DIVISION_BY_ZERO:
Gilles Peskine449bd832023-01-11 14:50:10 +0100279 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100280 case MBEDTLS_ERR_MPI_NOT_ACCEPTABLE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100281 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100282 case MBEDTLS_ERR_MPI_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100283 return PSA_ERROR_INSUFFICIENT_MEMORY;
Dave Rodgman509b5672023-08-16 19:26:23 +0100284#endif
Gilles Peskinef76aa772018-10-29 19:24:33 +0100285
Dave Rodgman509b5672023-08-16 19:26:23 +0100286#if defined(MBEDTLS_PK_C)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100287 case MBEDTLS_ERR_PK_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100288 return PSA_ERROR_INSUFFICIENT_MEMORY;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100289 case MBEDTLS_ERR_PK_TYPE_MISMATCH:
290 case MBEDTLS_ERR_PK_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100291 return PSA_ERROR_INVALID_ARGUMENT;
Dave Rodgman509b5672023-08-16 19:26:23 +0100292#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) || defined(MBEDTLS_FS_IO) || \
293 defined(MBEDTLS_PSA_ITS_FILE_C)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100294 case MBEDTLS_ERR_PK_FILE_IO_ERROR:
Gilles Peskine449bd832023-01-11 14:50:10 +0100295 return PSA_ERROR_STORAGE_FAILURE;
Dave Rodgman509b5672023-08-16 19:26:23 +0100296#endif
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100297 case MBEDTLS_ERR_PK_KEY_INVALID_VERSION:
298 case MBEDTLS_ERR_PK_KEY_INVALID_FORMAT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100299 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100300 case MBEDTLS_ERR_PK_UNKNOWN_PK_ALG:
Gilles Peskine449bd832023-01-11 14:50:10 +0100301 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100302 case MBEDTLS_ERR_PK_PASSWORD_REQUIRED:
303 case MBEDTLS_ERR_PK_PASSWORD_MISMATCH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100304 return PSA_ERROR_NOT_PERMITTED;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100305 case MBEDTLS_ERR_PK_INVALID_PUBKEY:
Gilles Peskine449bd832023-01-11 14:50:10 +0100306 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100307 case MBEDTLS_ERR_PK_INVALID_ALG:
308 case MBEDTLS_ERR_PK_UNKNOWN_NAMED_CURVE:
309 case MBEDTLS_ERR_PK_FEATURE_UNAVAILABLE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100310 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100311 case MBEDTLS_ERR_PK_SIG_LEN_MISMATCH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100312 return PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskinef9f1bdf2021-06-23 20:32:27 +0200313 case MBEDTLS_ERR_PK_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +0100314 return PSA_ERROR_BUFFER_TOO_SMALL;
Dave Rodgman509b5672023-08-16 19:26:23 +0100315#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100316
Gilles Peskineff2d2002019-05-06 15:26:23 +0200317 case MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100318 return PSA_ERROR_HARDWARE_FAILURE;
Gilles Peskineff2d2002019-05-06 15:26:23 +0200319 case MBEDTLS_ERR_PLATFORM_FEATURE_UNSUPPORTED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100320 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskineff2d2002019-05-06 15:26:23 +0200321
Dave Rodgman509b5672023-08-16 19:26:23 +0100322#if defined(MBEDTLS_RSA_C)
Gilles Peskinea5905292018-02-07 20:59:33 +0100323 case MBEDTLS_ERR_RSA_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100324 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100325 case MBEDTLS_ERR_RSA_INVALID_PADDING:
Gilles Peskine449bd832023-01-11 14:50:10 +0100326 return PSA_ERROR_INVALID_PADDING;
Gilles Peskinea5905292018-02-07 20:59:33 +0100327 case MBEDTLS_ERR_RSA_KEY_GEN_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100328 return PSA_ERROR_HARDWARE_FAILURE;
Gilles Peskinea5905292018-02-07 20:59:33 +0100329 case MBEDTLS_ERR_RSA_KEY_CHECK_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100330 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100331 case MBEDTLS_ERR_RSA_PUBLIC_FAILED:
332 case MBEDTLS_ERR_RSA_PRIVATE_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100333 return PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinea5905292018-02-07 20:59:33 +0100334 case MBEDTLS_ERR_RSA_VERIFY_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100335 return PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskinea5905292018-02-07 20:59:33 +0100336 case MBEDTLS_ERR_RSA_OUTPUT_TOO_LARGE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100337 return PSA_ERROR_BUFFER_TOO_SMALL;
Gilles Peskinea5905292018-02-07 20:59:33 +0100338 case MBEDTLS_ERR_RSA_RNG_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100339 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Dave Rodgman509b5672023-08-16 19:26:23 +0100340#endif
Manuel Pégourié-Gonnard93c08472021-04-15 12:23:55 +0200341
Dave Rodgman1dab4452023-09-01 09:59:51 +0100342#if defined(MBEDTLS_ECP_LIGHT)
itayzafrir5c753392018-05-08 11:18:38 +0300343 case MBEDTLS_ERR_ECP_BAD_INPUT_DATA:
itayzafrir7b30f8b2018-05-09 16:07:36 +0300344 case MBEDTLS_ERR_ECP_INVALID_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +0100345 return PSA_ERROR_INVALID_ARGUMENT;
itayzafrir7b30f8b2018-05-09 16:07:36 +0300346 case MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +0100347 return PSA_ERROR_BUFFER_TOO_SMALL;
itayzafrir7b30f8b2018-05-09 16:07:36 +0300348 case MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100349 return PSA_ERROR_NOT_SUPPORTED;
itayzafrir7b30f8b2018-05-09 16:07:36 +0300350 case MBEDTLS_ERR_ECP_SIG_LEN_MISMATCH:
351 case MBEDTLS_ERR_ECP_VERIFY_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100352 return PSA_ERROR_INVALID_SIGNATURE;
itayzafrir7b30f8b2018-05-09 16:07:36 +0300353 case MBEDTLS_ERR_ECP_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100354 return PSA_ERROR_INSUFFICIENT_MEMORY;
Gilles Peskine40d81602020-11-25 00:09:47 +0100355 case MBEDTLS_ERR_ECP_RANDOM_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100356 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskine40d81602020-11-25 00:09:47 +0100357
Dave Rodgman509b5672023-08-16 19:26:23 +0100358#if defined(MBEDTLS_ECP_RESTARTABLE)
Paul Elliott588f8ed2022-12-02 18:10:26 +0000359 case MBEDTLS_ERR_ECP_IN_PROGRESS:
360 return PSA_OPERATION_INCOMPLETE;
Dave Rodgman509b5672023-08-16 19:26:23 +0100361#endif
362#endif
Paul Elliott588f8ed2022-12-02 18:10:26 +0000363
Janos Follatha13b9052019-11-22 12:48:59 +0000364 case MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100365 return PSA_ERROR_CORRUPTION_DETECTED;
itayzafrir5c753392018-05-08 11:18:38 +0300366
Gilles Peskinee59236f2018-01-27 23:32:46 +0100367 default:
Gilles Peskine449bd832023-01-11 14:50:10 +0100368 return PSA_ERROR_GENERIC_ERROR;
Gilles Peskinee59236f2018-01-27 23:32:46 +0100369 }
370}
371
Paul Elliottdc42ca82023-02-24 18:11:59 +0000372/**
373 * \brief For output buffers which contain "tags"
374 * (outputs that may be checked for validity like
375 * hashes, MACs and signatures), fill the unused
376 * part of the output buffer (the whole buffer on
377 * error, the trailing part on success) with
378 * something that isn't a valid tag (barring an
379 * attack on the tag and deliberately-crafted
380 * input), in case the caller doesn't check the
381 * return status properly.
382 *
383 * \param output_buffer Pointer to buffer to wipe. May not be NULL
384 * unless \p output_buffer_size is zero.
385 * \param status Status of function called to generate
386 * output_buffer originally
387 * \param output_buffer_size Size of output buffer. If zero, \p output_buffer
388 * could be NULL.
389 * \param output_buffer_length Length of data written to output_buffer, must be
390 * less than \p output_buffer_size
391 */
392static void psa_wipe_tag_output_buffer(uint8_t *output_buffer, psa_status_t status,
Paul Elliott7118d172023-02-26 16:57:05 +0000393 size_t output_buffer_size, size_t output_buffer_length)
394{
Paul Elliottdc42ca82023-02-24 18:11:59 +0000395 size_t offset = 0;
396
397 if (output_buffer_size == 0) {
398 /* If output_buffer_size is 0 then we have nothing to do. We must not
399 call memset because output_buffer may be NULL in this case */
400 return;
401 }
402
403 if (status == PSA_SUCCESS) {
404 offset = output_buffer_length;
405 }
406
407 memset(output_buffer + offset, '!', output_buffer_size - offset);
408}
409
Gilles Peskineb0b255c2018-07-06 17:01:38 +0200410
Gilles Peskine449bd832023-01-11 14:50:10 +0100411psa_status_t psa_validate_unstructured_key_bit_size(psa_key_type_t type,
412 size_t bits)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200413{
414 /* Check that the bit size is acceptable for the key type */
Gilles Peskine449bd832023-01-11 14:50:10 +0100415 switch (type) {
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200416 case PSA_KEY_TYPE_RAW_DATA:
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200417 case PSA_KEY_TYPE_HMAC:
Gilles Peskineea0fb492018-07-12 17:17:20 +0200418 case PSA_KEY_TYPE_DERIVE:
Neil Armstrong4b5710f2022-05-25 11:30:27 +0200419 case PSA_KEY_TYPE_PASSWORD:
420 case PSA_KEY_TYPE_PASSWORD_HASH:
Gilles Peskineea0fb492018-07-12 17:17:20 +0200421 break;
Ronald Cron1f0db802021-03-12 09:59:30 +0100422#if defined(PSA_WANT_KEY_TYPE_AES)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200423 case PSA_KEY_TYPE_AES:
Gilles Peskine449bd832023-01-11 14:50:10 +0100424 if (bits != 128 && bits != 192 && bits != 256) {
425 return PSA_ERROR_INVALID_ARGUMENT;
426 }
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200427 break;
428#endif
Gilles Peskine6c12a1e2021-09-21 11:59:39 +0200429#if defined(PSA_WANT_KEY_TYPE_ARIA)
430 case PSA_KEY_TYPE_ARIA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100431 if (bits != 128 && bits != 192 && bits != 256) {
432 return PSA_ERROR_INVALID_ARGUMENT;
433 }
Gilles Peskine6c12a1e2021-09-21 11:59:39 +0200434 break;
435#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100436#if defined(PSA_WANT_KEY_TYPE_CAMELLIA)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200437 case PSA_KEY_TYPE_CAMELLIA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100438 if (bits != 128 && bits != 192 && bits != 256) {
439 return PSA_ERROR_INVALID_ARGUMENT;
440 }
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200441 break;
442#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100443#if defined(PSA_WANT_KEY_TYPE_DES)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200444 case PSA_KEY_TYPE_DES:
Gilles Peskine449bd832023-01-11 14:50:10 +0100445 if (bits != 64 && bits != 128 && bits != 192) {
446 return PSA_ERROR_INVALID_ARGUMENT;
447 }
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200448 break;
449#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100450#if defined(PSA_WANT_KEY_TYPE_CHACHA20)
Gilles Peskine26869f22019-05-06 15:25:00 +0200451 case PSA_KEY_TYPE_CHACHA20:
Gilles Peskine449bd832023-01-11 14:50:10 +0100452 if (bits != 256) {
453 return PSA_ERROR_INVALID_ARGUMENT;
454 }
Gilles Peskine26869f22019-05-06 15:25:00 +0200455 break;
456#endif
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200457 default:
Gilles Peskine449bd832023-01-11 14:50:10 +0100458 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200459 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100460 if (bits % 8 != 0) {
461 return PSA_ERROR_INVALID_ARGUMENT;
462 }
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200463
Gilles Peskine449bd832023-01-11 14:50:10 +0100464 return PSA_SUCCESS;
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200465}
466
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100467/** Check whether a given key type is valid for use with a given MAC algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100468 *
Steven Cooremancd640932021-03-08 12:00:27 +0100469 * Upon successful return of this function, the behavior of #PSA_MAC_LENGTH
470 * when called with the validated \p algorithm and \p key_type is well-defined.
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100471 *
472 * \param[in] algorithm The specific MAC algorithm (can be wildcard).
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100473 * \param[in] key_type The key type of the key to be used with the
474 * \p algorithm.
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100475 *
476 * \retval #PSA_SUCCESS
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100477 * The \p key_type is valid for use with the \p algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100478 * \retval #PSA_ERROR_INVALID_ARGUMENT
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100479 * The \p key_type is not valid for use with the \p algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100480 */
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100481MBEDTLS_STATIC_TESTABLE psa_status_t psa_mac_key_can_do(
Steven Cooreman58c94d32021-03-02 21:31:17 +0100482 psa_algorithm_t algorithm,
Gilles Peskine449bd832023-01-11 14:50:10 +0100483 psa_key_type_t key_type)
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100484{
Gilles Peskine449bd832023-01-11 14:50:10 +0100485 if (PSA_ALG_IS_HMAC(algorithm)) {
486 if (key_type == PSA_KEY_TYPE_HMAC) {
487 return PSA_SUCCESS;
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100488 }
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100489 }
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100490
Gilles Peskine449bd832023-01-11 14:50:10 +0100491 if (PSA_ALG_IS_BLOCK_CIPHER_MAC(algorithm)) {
492 /* Check that we're calling PSA_BLOCK_CIPHER_BLOCK_LENGTH with a cipher
493 * key. */
494 if ((key_type & PSA_KEY_TYPE_CATEGORY_MASK) ==
495 PSA_KEY_TYPE_CATEGORY_SYMMETRIC) {
496 /* PSA_BLOCK_CIPHER_BLOCK_LENGTH returns 1 for stream ciphers and
497 * the block length (larger than 1) for block ciphers. */
498 if (PSA_BLOCK_CIPHER_BLOCK_LENGTH(key_type) > 1) {
499 return PSA_SUCCESS;
500 }
501 }
502 }
503
504 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100505}
506
Gilles Peskine449bd832023-01-11 14:50:10 +0100507psa_status_t psa_allocate_buffer_to_slot(psa_key_slot_t *slot,
508 size_t buffer_length)
Steven Cooreman75b74362020-07-28 14:30:13 +0200509{
Gilles Peskine449bd832023-01-11 14:50:10 +0100510 if (slot->key.data != NULL) {
511 return PSA_ERROR_ALREADY_EXISTS;
512 }
Steven Cooreman75b74362020-07-28 14:30:13 +0200513
Gilles Peskine449bd832023-01-11 14:50:10 +0100514 slot->key.data = mbedtls_calloc(1, buffer_length);
515 if (slot->key.data == NULL) {
516 return PSA_ERROR_INSUFFICIENT_MEMORY;
517 }
Steven Cooreman75b74362020-07-28 14:30:13 +0200518
Ronald Cronea0f8a62020-11-25 17:52:23 +0100519 slot->key.bytes = buffer_length;
Gilles Peskine449bd832023-01-11 14:50:10 +0100520 return PSA_SUCCESS;
Steven Cooreman75b74362020-07-28 14:30:13 +0200521}
522
Gilles Peskine449bd832023-01-11 14:50:10 +0100523psa_status_t psa_copy_key_material_into_slot(psa_key_slot_t *slot,
524 const uint8_t *data,
525 size_t data_length)
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200526{
Gilles Peskine449bd832023-01-11 14:50:10 +0100527 psa_status_t status = psa_allocate_buffer_to_slot(slot,
528 data_length);
529 if (status != PSA_SUCCESS) {
530 return status;
531 }
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200532
Gilles Peskine449bd832023-01-11 14:50:10 +0100533 memcpy(slot->key.data, data, data_length);
534 return PSA_SUCCESS;
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200535}
536
Ronald Crona0fe59f2020-11-29 11:14:53 +0100537psa_status_t psa_import_key_into_slot(
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100538 const psa_key_attributes_t *attributes,
539 const uint8_t *data, size_t data_length,
540 uint8_t *key_buffer, size_t key_buffer_size,
Gilles Peskine449bd832023-01-11 14:50:10 +0100541 size_t *key_buffer_length, size_t *bits)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100542{
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100543 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
544 psa_key_type_t type = attributes->core.type;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100545
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200546 /* zero-length keys are never supported. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100547 if (data_length == 0) {
548 return PSA_ERROR_NOT_SUPPORTED;
549 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200550
Gilles Peskine449bd832023-01-11 14:50:10 +0100551 if (key_type_is_raw_bytes(type)) {
552 *bits = PSA_BYTES_TO_BITS(data_length);
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200553
Gilles Peskine449bd832023-01-11 14:50:10 +0100554 status = psa_validate_unstructured_key_bit_size(attributes->core.type,
555 *bits);
556 if (status != PSA_SUCCESS) {
557 return status;
558 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200559
Ronald Crondd04d422020-11-28 15:14:42 +0100560 /* Copy the key material. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100561 memcpy(key_buffer, data, data_length);
Ronald Crondd04d422020-11-28 15:14:42 +0100562 *key_buffer_length = data_length;
Gilles Peskine449bd832023-01-11 14:50:10 +0100563 (void) key_buffer_size;
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200564
Gilles Peskine449bd832023-01-11 14:50:10 +0100565 return PSA_SUCCESS;
566 } else if (PSA_KEY_TYPE_IS_ASYMMETRIC(type)) {
Valerio Settia55f0422023-07-10 15:34:41 +0200567#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_IMPORT) || \
Przemek Stekiel6d85afa2023-04-28 11:42:17 +0200568 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY)
Przemek Stekiel472b3f32022-12-01 14:38:49 +0100569 if (PSA_KEY_TYPE_IS_DH(type)) {
Przemek Stekield1cf1ba2023-04-27 12:04:21 +0200570 if (psa_is_dh_key_size_valid(PSA_BYTES_TO_BITS(data_length)) == 0) {
Przemek Stekiel472b3f32022-12-01 14:38:49 +0100571 return PSA_ERROR_INVALID_ARGUMENT;
572 }
Przemek Stekiel33c91eb2023-05-30 15:16:35 +0200573 return mbedtls_psa_ffdh_import_key(attributes,
574 data, data_length,
575 key_buffer, key_buffer_size,
576 key_buffer_length,
577 bits);
Przemek Stekiel472b3f32022-12-01 14:38:49 +0100578 }
Valerio Settia55f0422023-07-10 15:34:41 +0200579#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_IMPORT) ||
Przemek Stekiel6d85afa2023-04-28 11:42:17 +0200580 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY) */
Valerio Setti27c501a2023-06-27 16:58:52 +0200581#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_IMPORT) || \
Gilles Peskine449bd832023-01-11 14:50:10 +0100582 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
583 if (PSA_KEY_TYPE_IS_ECC(type)) {
584 return mbedtls_psa_ecp_import_key(attributes,
585 data, data_length,
586 key_buffer, key_buffer_size,
587 key_buffer_length,
588 bits);
Steven Cooreman40120f62020-10-29 11:42:22 +0100589 }
Valerio Setti27c501a2023-06-27 16:58:52 +0200590#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_IMPORT) ||
John Durkop9814fa22020-11-04 12:28:15 -0800591 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
Valerio Settife478902023-07-25 12:27:19 +0200592#if (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) && \
593 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) || \
Gilles Peskine449bd832023-01-11 14:50:10 +0100594 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
595 if (PSA_KEY_TYPE_IS_RSA(type)) {
596 return mbedtls_psa_rsa_import_key(attributes,
597 data, data_length,
598 key_buffer, key_buffer_size,
599 key_buffer_length,
600 bits);
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200601 }
Valerio Settife478902023-07-25 12:27:19 +0200602#endif /* (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) &&
603 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) ||
John Durkop9814fa22020-11-04 12:28:15 -0800604 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100605 }
Steven Cooreman40120f62020-10-29 11:42:22 +0100606
Gilles Peskine449bd832023-01-11 14:50:10 +0100607 return PSA_ERROR_NOT_SUPPORTED;
Darryl Green06fd18d2018-07-16 11:21:11 +0100608}
609
Gilles Peskinef603c712019-01-19 13:40:11 +0100610/** Calculate the intersection of two algorithm usage policies.
611 *
612 * Return 0 (which allows no operation) on incompatibility.
613 */
614static psa_algorithm_t psa_key_policy_algorithm_intersection(
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100615 psa_key_type_t key_type,
Gilles Peskinef603c712019-01-19 13:40:11 +0100616 psa_algorithm_t alg1,
Gilles Peskine449bd832023-01-11 14:50:10 +0100617 psa_algorithm_t alg2)
Gilles Peskinef603c712019-01-19 13:40:11 +0100618{
Gilles Peskine549ea862019-05-22 11:45:59 +0200619 /* Common case: both sides actually specify the same policy. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100620 if (alg1 == alg2) {
621 return alg1;
622 }
Steven Cooreman03488022021-02-18 12:07:20 +0100623 /* If the policies are from the same hash-and-sign family, check
624 * if one is a wildcard. If so the other has the specific algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100625 if (PSA_ALG_IS_SIGN_HASH(alg1) &&
626 PSA_ALG_IS_SIGN_HASH(alg2) &&
627 (alg1 & ~PSA_ALG_HASH_MASK) == (alg2 & ~PSA_ALG_HASH_MASK)) {
628 if (PSA_ALG_SIGN_GET_HASH(alg1) == PSA_ALG_ANY_HASH) {
629 return alg2;
630 }
631 if (PSA_ALG_SIGN_GET_HASH(alg2) == PSA_ALG_ANY_HASH) {
632 return alg1;
633 }
Steven Cooreman03488022021-02-18 12:07:20 +0100634 }
635 /* If the policies are from the same AEAD family, check whether
Steven Cooreman7de9e2d2021-02-22 17:05:56 +0100636 * one of them is a minimum-tag-length wildcard. Calculate the most
Steven Cooreman03488022021-02-18 12:07:20 +0100637 * restrictive tag length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100638 if (PSA_ALG_IS_AEAD(alg1) && PSA_ALG_IS_AEAD(alg2) &&
639 (PSA_ALG_AEAD_WITH_SHORTENED_TAG(alg1, 0) ==
640 PSA_ALG_AEAD_WITH_SHORTENED_TAG(alg2, 0))) {
641 size_t alg1_len = PSA_ALG_AEAD_GET_TAG_LENGTH(alg1);
642 size_t alg2_len = PSA_ALG_AEAD_GET_TAG_LENGTH(alg2);
Steven Cooremancd640932021-03-08 12:00:27 +0100643 size_t restricted_len = alg1_len > alg2_len ? alg1_len : alg2_len;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100644
Steven Cooreman7de9e2d2021-02-22 17:05:56 +0100645 /* If both are wildcards, return most restrictive wildcard */
Gilles Peskine449bd832023-01-11 14:50:10 +0100646 if (((alg1 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0) &&
647 ((alg2 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0)) {
648 return PSA_ALG_AEAD_WITH_AT_LEAST_THIS_LENGTH_TAG(
649 alg1, restricted_len);
Steven Cooreman03488022021-02-18 12:07:20 +0100650 }
651 /* If only one is a wildcard, return specific algorithm if compatible. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100652 if (((alg1 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0) &&
653 (alg1_len <= alg2_len)) {
654 return alg2;
Steven Cooreman03488022021-02-18 12:07:20 +0100655 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100656 if (((alg2 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0) &&
657 (alg2_len <= alg1_len)) {
658 return alg1;
Steven Cooreman03488022021-02-18 12:07:20 +0100659 }
660 }
661 /* If the policies are from the same MAC family, check whether one
662 * of them is a minimum-MAC-length policy. Calculate the most
663 * restrictive tag length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100664 if (PSA_ALG_IS_MAC(alg1) && PSA_ALG_IS_MAC(alg2) &&
665 (PSA_ALG_FULL_LENGTH_MAC(alg1) ==
666 PSA_ALG_FULL_LENGTH_MAC(alg2))) {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100667 /* Validate the combination of key type and algorithm. Since the base
668 * algorithm of alg1 and alg2 are the same, we only need this once. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100669 if (PSA_SUCCESS != psa_mac_key_can_do(alg1, key_type)) {
670 return 0;
671 }
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100672
Steven Cooreman31a876d2021-03-03 20:47:40 +0100673 /* Get the (exact or at-least) output lengths for both sides of the
674 * requested intersection. None of the currently supported algorithms
675 * have an output length dependent on the actual key size, so setting it
676 * to a bogus value of 0 is currently OK.
677 *
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100678 * Note that for at-least-this-length wildcard algorithms, the output
679 * length is set to the shortest allowed length, which allows us to
680 * calculate the most restrictive tag length for the intersection. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100681 size_t alg1_len = PSA_MAC_LENGTH(key_type, 0, alg1);
682 size_t alg2_len = PSA_MAC_LENGTH(key_type, 0, alg2);
Steven Cooremancd640932021-03-08 12:00:27 +0100683 size_t restricted_len = alg1_len > alg2_len ? alg1_len : alg2_len;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100684
Steven Cooremana1d83222021-02-25 10:20:29 +0100685 /* If both are wildcards, return most restrictive wildcard */
Gilles Peskine449bd832023-01-11 14:50:10 +0100686 if (((alg1 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0) &&
687 ((alg2 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0)) {
688 return PSA_ALG_AT_LEAST_THIS_LENGTH_MAC(alg1, restricted_len);
Steven Cooreman03488022021-02-18 12:07:20 +0100689 }
Steven Cooreman31a876d2021-03-03 20:47:40 +0100690
691 /* If only one is an at-least-this-length policy, the intersection would
692 * be the other (fixed-length) policy as long as said fixed length is
693 * equal to or larger than the shortest allowed length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100694 if ((alg1 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0) {
695 return (alg1_len <= alg2_len) ? alg2 : 0;
Steven Cooreman03488022021-02-18 12:07:20 +0100696 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100697 if ((alg2 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0) {
698 return (alg2_len <= alg1_len) ? alg1 : 0;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100699 }
Steven Cooreman31a876d2021-03-03 20:47:40 +0100700
Steven Cooremancd640932021-03-08 12:00:27 +0100701 /* If none of them are wildcards, check whether they define the same tag
702 * length. This is still possible here when one is default-length and
703 * the other specific-length. Ensure to always return the
704 * specific-length version for the intersection. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100705 if (alg1_len == alg2_len) {
706 return PSA_ALG_TRUNCATED_MAC(alg1, alg1_len);
707 }
Gilles Peskinef603c712019-01-19 13:40:11 +0100708 }
709 /* If the policies are incompatible, allow nothing. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100710 return 0;
Gilles Peskinef603c712019-01-19 13:40:11 +0100711}
712
Gilles Peskine449bd832023-01-11 14:50:10 +0100713static int psa_key_algorithm_permits(psa_key_type_t key_type,
714 psa_algorithm_t policy_alg,
715 psa_algorithm_t requested_alg)
Gilles Peskined6f371b2019-05-10 19:33:38 +0200716{
Gilles Peskine549ea862019-05-22 11:45:59 +0200717 /* Common case: the policy only allows requested_alg. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100718 if (requested_alg == policy_alg) {
719 return 1;
720 }
Steven Cooreman03488022021-02-18 12:07:20 +0100721 /* If policy_alg is a hash-and-sign with a wildcard for the hash,
722 * and requested_alg is the same hash-and-sign family with any hash,
723 * then requested_alg is compliant with policy_alg. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100724 if (PSA_ALG_IS_SIGN_HASH(requested_alg) &&
725 PSA_ALG_SIGN_GET_HASH(policy_alg) == PSA_ALG_ANY_HASH) {
726 return (policy_alg & ~PSA_ALG_HASH_MASK) ==
727 (requested_alg & ~PSA_ALG_HASH_MASK);
Steven Cooreman03488022021-02-18 12:07:20 +0100728 }
729 /* If policy_alg is a wildcard AEAD algorithm of the same base as
730 * the requested algorithm, check the requested tag length to be
731 * equal-length or longer than the wildcard-specified length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100732 if (PSA_ALG_IS_AEAD(policy_alg) &&
733 PSA_ALG_IS_AEAD(requested_alg) &&
734 (PSA_ALG_AEAD_WITH_SHORTENED_TAG(policy_alg, 0) ==
735 PSA_ALG_AEAD_WITH_SHORTENED_TAG(requested_alg, 0)) &&
736 ((policy_alg & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0)) {
737 return PSA_ALG_AEAD_GET_TAG_LENGTH(policy_alg) <=
738 PSA_ALG_AEAD_GET_TAG_LENGTH(requested_alg);
Steven Cooreman03488022021-02-18 12:07:20 +0100739 }
Steven Cooremancd640932021-03-08 12:00:27 +0100740 /* If policy_alg is a MAC algorithm of the same base as the requested
741 * algorithm, check whether their MAC lengths are compatible. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100742 if (PSA_ALG_IS_MAC(policy_alg) &&
743 PSA_ALG_IS_MAC(requested_alg) &&
744 (PSA_ALG_FULL_LENGTH_MAC(policy_alg) ==
745 PSA_ALG_FULL_LENGTH_MAC(requested_alg))) {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100746 /* Validate the combination of key type and algorithm. Since the policy
747 * and requested algorithms are the same, we only need this once. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100748 if (PSA_SUCCESS != psa_mac_key_can_do(policy_alg, key_type)) {
749 return 0;
750 }
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100751
Steven Cooreman31a876d2021-03-03 20:47:40 +0100752 /* Get both the requested output length for the algorithm which is to be
753 * verified, and the default output length for the base algorithm.
754 * Note that none of the currently supported algorithms have an output
755 * length dependent on actual key size, so setting it to a bogus value
756 * of 0 is currently OK. */
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100757 size_t requested_output_length = PSA_MAC_LENGTH(
Gilles Peskine449bd832023-01-11 14:50:10 +0100758 key_type, 0, requested_alg);
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100759 size_t default_output_length = PSA_MAC_LENGTH(
Gilles Peskine449bd832023-01-11 14:50:10 +0100760 key_type, 0,
761 PSA_ALG_FULL_LENGTH_MAC(requested_alg));
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100762
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100763 /* If the policy is default-length, only allow an algorithm with
764 * a declared exact-length matching the default. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100765 if (PSA_MAC_TRUNCATED_LENGTH(policy_alg) == 0) {
766 return requested_output_length == default_output_length;
767 }
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100768
769 /* If the requested algorithm is default-length, allow it if the policy
Steven Cooremancd640932021-03-08 12:00:27 +0100770 * length exactly matches the default length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100771 if (PSA_MAC_TRUNCATED_LENGTH(requested_alg) == 0 &&
772 PSA_MAC_TRUNCATED_LENGTH(policy_alg) == default_output_length) {
773 return 1;
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100774 }
775
Steven Cooremancd640932021-03-08 12:00:27 +0100776 /* If policy_alg is an at-least-this-length wildcard MAC algorithm,
777 * check for the requested MAC length to be equal to or longer than the
778 * minimum allowed length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100779 if ((policy_alg & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0) {
780 return PSA_MAC_TRUNCATED_LENGTH(policy_alg) <=
781 requested_output_length;
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100782 }
Gilles Peskined6f371b2019-05-10 19:33:38 +0200783 }
Steven Cooremance48e852020-10-05 16:02:45 +0200784 /* If policy_alg is a generic key agreement operation, then using it for
Steven Cooremanfa5e6312020-10-15 17:07:12 +0200785 * a key derivation with that key agreement should also be allowed. This
786 * behaviour is expected to be defined in a future specification version. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100787 if (PSA_ALG_IS_RAW_KEY_AGREEMENT(policy_alg) &&
788 PSA_ALG_IS_KEY_AGREEMENT(requested_alg)) {
789 return PSA_ALG_KEY_AGREEMENT_GET_BASE(requested_alg) ==
790 policy_alg;
Steven Cooremance48e852020-10-05 16:02:45 +0200791 }
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100792 /* If it isn't explicitly permitted, it's forbidden. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100793 return 0;
Gilles Peskined6f371b2019-05-10 19:33:38 +0200794}
795
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100796/** Test whether a policy permits an algorithm.
797 *
798 * The caller must test usage flags separately.
Steven Cooreman7e39f052021-02-23 14:18:32 +0100799 *
Steven Cooreman5a172672021-03-02 21:27:42 +0100800 * \note This function requires providing the key type for which the policy is
801 * being validated, since some algorithm policy definitions (e.g. MAC)
802 * have different properties depending on what kind of cipher it is
803 * combined with.
804 *
Steven Cooreman7e39f052021-02-23 14:18:32 +0100805 * \retval PSA_SUCCESS When \p alg is a specific algorithm
806 * allowed by the \p policy.
807 * \retval PSA_ERROR_INVALID_ARGUMENT When \p alg is not a specific algorithm
808 * \retval PSA_ERROR_NOT_PERMITTED When \p alg is a specific algorithm, but
809 * the \p policy does not allow it.
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100810 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100811static psa_status_t psa_key_policy_permits(const psa_key_policy_t *policy,
812 psa_key_type_t key_type,
813 psa_algorithm_t alg)
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100814{
Steven Cooremand788fab2021-02-25 11:29:17 +0100815 /* '0' is not a valid algorithm */
Gilles Peskine449bd832023-01-11 14:50:10 +0100816 if (alg == 0) {
817 return PSA_ERROR_INVALID_ARGUMENT;
818 }
Steven Cooremand788fab2021-02-25 11:29:17 +0100819
Steven Cooreman7e39f052021-02-23 14:18:32 +0100820 /* A requested algorithm cannot be a wildcard. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100821 if (PSA_ALG_IS_WILDCARD(alg)) {
822 return PSA_ERROR_INVALID_ARGUMENT;
823 }
Steven Cooreman7e39f052021-02-23 14:18:32 +0100824
Gilles Peskine449bd832023-01-11 14:50:10 +0100825 if (psa_key_algorithm_permits(key_type, policy->alg, alg) ||
826 psa_key_algorithm_permits(key_type, policy->alg2, alg)) {
827 return PSA_SUCCESS;
828 } else {
829 return PSA_ERROR_NOT_PERMITTED;
830 }
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100831}
832
Gilles Peskinef603c712019-01-19 13:40:11 +0100833/** Restrict a key policy based on a constraint.
834 *
Steven Cooreman5a172672021-03-02 21:27:42 +0100835 * \note This function requires providing the key type for which the policy is
836 * being restricted, since some algorithm policy definitions (e.g. MAC)
837 * have different properties depending on what kind of cipher it is
838 * combined with.
839 *
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100840 * \param[in] key_type The key type for which to restrict the policy
Gilles Peskinef603c712019-01-19 13:40:11 +0100841 * \param[in,out] policy The policy to restrict.
842 * \param[in] constraint The policy constraint to apply.
843 *
844 * \retval #PSA_SUCCESS
845 * \c *policy contains the intersection of the original value of
846 * \c *policy and \c *constraint.
847 * \retval #PSA_ERROR_INVALID_ARGUMENT
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100848 * \c key_type, \c *policy and \c *constraint are incompatible.
Gilles Peskinef603c712019-01-19 13:40:11 +0100849 * \c *policy is unchanged.
850 */
851static psa_status_t psa_restrict_key_policy(
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100852 psa_key_type_t key_type,
Gilles Peskinef603c712019-01-19 13:40:11 +0100853 psa_key_policy_t *policy,
Gilles Peskine449bd832023-01-11 14:50:10 +0100854 const psa_key_policy_t *constraint)
Gilles Peskinef603c712019-01-19 13:40:11 +0100855{
856 psa_algorithm_t intersection_alg =
Gilles Peskine449bd832023-01-11 14:50:10 +0100857 psa_key_policy_algorithm_intersection(key_type, policy->alg,
858 constraint->alg);
Gilles Peskined6f371b2019-05-10 19:33:38 +0200859 psa_algorithm_t intersection_alg2 =
Gilles Peskine449bd832023-01-11 14:50:10 +0100860 psa_key_policy_algorithm_intersection(key_type, policy->alg2,
861 constraint->alg2);
862 if (intersection_alg == 0 && policy->alg != 0 && constraint->alg != 0) {
863 return PSA_ERROR_INVALID_ARGUMENT;
864 }
865 if (intersection_alg2 == 0 && policy->alg2 != 0 && constraint->alg2 != 0) {
866 return PSA_ERROR_INVALID_ARGUMENT;
867 }
Gilles Peskinef603c712019-01-19 13:40:11 +0100868 policy->usage &= constraint->usage;
869 policy->alg = intersection_alg;
Gilles Peskined6f371b2019-05-10 19:33:38 +0200870 policy->alg2 = intersection_alg2;
Gilles Peskine449bd832023-01-11 14:50:10 +0100871 return PSA_SUCCESS;
Gilles Peskinef603c712019-01-19 13:40:11 +0100872}
873
Przemek Stekiel061f6942022-11-30 10:51:35 +0100874/** Get the description of a key given its identifier and policy constraints
875 * and lock it.
876 *
877 * The key must have allow all the usage flags set in \p usage. If \p alg is
878 * nonzero, the key must allow operations with this algorithm. If \p alg is
879 * zero, the algorithm is not checked.
880 *
881 * In case of a persistent key, the function loads the description of the key
882 * into a key slot if not already done.
883 *
Ryan Everett098c6652024-01-03 13:03:36 +0000884 * On success, the returned key slot has been registered for reading.
885 * It is the responsibility of the caller to call psa_unregister_read(slot)
886 * when they have finished reading the contents of the slot.
Przemek Stekiel061f6942022-11-30 10:51:35 +0100887 */
888static psa_status_t psa_get_and_lock_key_slot_with_policy(
Ronald Cron5c522922020-11-14 16:35:34 +0100889 mbedtls_svc_key_id_t key,
890 psa_key_slot_t **p_slot,
891 psa_key_usage_t usage,
Gilles Peskine449bd832023-01-11 14:50:10 +0100892 psa_algorithm_t alg)
Darryl Green06fd18d2018-07-16 11:21:11 +0100893{
Ronald Cronf95a2b12020-10-22 15:24:49 +0200894 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel9a5b8122022-12-22 13:34:47 +0100895 psa_key_slot_t *slot = NULL;
Darryl Green06fd18d2018-07-16 11:21:11 +0100896
Gilles Peskine449bd832023-01-11 14:50:10 +0100897 status = psa_get_and_lock_key_slot(key, p_slot);
898 if (status != PSA_SUCCESS) {
899 return status;
900 }
Ronald Cronf95a2b12020-10-22 15:24:49 +0200901 slot = *p_slot;
Darryl Green06fd18d2018-07-16 11:21:11 +0100902
903 /* Enforce that usage policy for the key slot contains all the flags
904 * required by the usage parameter. There is one exception: public
905 * keys can always be exported, so we treat public key objects as
906 * if they had the export flag. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100907 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(slot->attr.type)) {
Darryl Green06fd18d2018-07-16 11:21:11 +0100908 usage &= ~PSA_KEY_USAGE_EXPORT;
Gilles Peskine449bd832023-01-11 14:50:10 +0100909 }
Ronald Cronf95a2b12020-10-22 15:24:49 +0200910
Gilles Peskine449bd832023-01-11 14:50:10 +0100911 if ((slot->attr.policy.usage & usage) != usage) {
Steven Cooreman328f11c2021-03-02 11:44:51 +0100912 status = PSA_ERROR_NOT_PERMITTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +0200913 goto error;
Steven Cooreman328f11c2021-03-02 11:44:51 +0100914 }
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100915
Shaun Case8b0ecbc2021-12-20 21:14:10 -0800916 /* Enforce that the usage policy permits the requested algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100917 if (alg != 0) {
918 status = psa_key_policy_permits(&slot->attr.policy,
919 slot->attr.type,
920 alg);
921 if (status != PSA_SUCCESS) {
Steven Cooreman7e39f052021-02-23 14:18:32 +0100922 goto error;
Gilles Peskine449bd832023-01-11 14:50:10 +0100923 }
Steven Cooreman7e39f052021-02-23 14:18:32 +0100924 }
Darryl Green06fd18d2018-07-16 11:21:11 +0100925
Gilles Peskine449bd832023-01-11 14:50:10 +0100926 return PSA_SUCCESS;
Ronald Cronf95a2b12020-10-22 15:24:49 +0200927
928error:
929 *p_slot = NULL;
Ryan Everett098c6652024-01-03 13:03:36 +0000930 psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +0200931
Gilles Peskine449bd832023-01-11 14:50:10 +0100932 return status;
Darryl Green06fd18d2018-07-16 11:21:11 +0100933}
Darryl Green940d72c2018-07-13 13:18:51 +0100934
Ronald Cron5c522922020-11-14 16:35:34 +0100935/** Get a key slot containing a transparent key and lock it.
Gilles Peskine28f8f302019-07-24 13:30:31 +0200936 *
937 * A transparent key is a key for which the key material is directly
Ronald Cronddae0f52021-08-24 15:39:44 +0200938 * available, as opposed to a key in a secure element and/or to be used
939 * by a secure element.
Gilles Peskine28f8f302019-07-24 13:30:31 +0200940 *
Ronald Cronddae0f52021-08-24 15:39:44 +0200941 * This is a temporary function that may be used instead of
942 * psa_get_and_lock_key_slot_with_policy() when there is no opaque key support
943 * for a cryptographic operation.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200944 *
Ryan Everett098c6652024-01-03 13:03:36 +0000945 * On success, the returned key slot has been registered for reading.
946 * It is the responsibility of the caller to call psa_unregister_read(slot)
947 * when they have finished reading the contents of the slot.
Gilles Peskine28f8f302019-07-24 13:30:31 +0200948 */
Ronald Cron5c522922020-11-14 16:35:34 +0100949static psa_status_t psa_get_and_lock_transparent_key_slot_with_policy(
950 mbedtls_svc_key_id_t key,
951 psa_key_slot_t **p_slot,
952 psa_key_usage_t usage,
Gilles Peskine449bd832023-01-11 14:50:10 +0100953 psa_algorithm_t alg)
Gilles Peskine28f8f302019-07-24 13:30:31 +0200954{
Gilles Peskine449bd832023-01-11 14:50:10 +0100955 psa_status_t status = psa_get_and_lock_key_slot_with_policy(key, p_slot,
956 usage, alg);
957 if (status != PSA_SUCCESS) {
958 return status;
Gilles Peskine28f8f302019-07-24 13:30:31 +0200959 }
Ronald Cronf95a2b12020-10-22 15:24:49 +0200960
Gilles Peskine449bd832023-01-11 14:50:10 +0100961 if (psa_key_lifetime_is_external((*p_slot)->attr.lifetime)) {
Ryan Everett098c6652024-01-03 13:03:36 +0000962 psa_unregister_read(*p_slot);
Gilles Peskine449bd832023-01-11 14:50:10 +0100963 *p_slot = NULL;
964 return PSA_ERROR_NOT_SUPPORTED;
965 }
966
967 return PSA_SUCCESS;
Gilles Peskine28f8f302019-07-24 13:30:31 +0200968}
Gilles Peskine28f8f302019-07-24 13:30:31 +0200969
Gilles Peskine449bd832023-01-11 14:50:10 +0100970psa_status_t psa_remove_key_data_from_memory(psa_key_slot_t *slot)
Darryl Green40225ba2018-11-15 14:48:15 +0000971{
Gilles Peskine449bd832023-01-11 14:50:10 +0100972 if (slot->key.data != NULL) {
Tom Cosgrove52f7e182023-08-01 09:08:48 +0100973 mbedtls_zeroize_and_free(slot->key.data, slot->key.bytes);
Gilles Peskine449bd832023-01-11 14:50:10 +0100974 }
Ronald Cronea0f8a62020-11-25 17:52:23 +0100975
Ronald Cronea0f8a62020-11-25 17:52:23 +0100976 slot->key.data = NULL;
977 slot->key.bytes = 0;
Darryl Green40225ba2018-11-15 14:48:15 +0000978
Gilles Peskine449bd832023-01-11 14:50:10 +0100979 return PSA_SUCCESS;
Darryl Green40225ba2018-11-15 14:48:15 +0000980}
981
Gilles Peskinef77ed1f2018-12-03 11:58:46 +0100982/** Completely wipe a slot in memory, including its policy.
983 * Persistent storage is not affected. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100984psa_status_t psa_wipe_key_slot(psa_key_slot_t *slot)
Gilles Peskinef77ed1f2018-12-03 11:58:46 +0100985{
Ryan Everettaa33c512023-12-21 17:32:07 +0000986 if (slot->state != PSA_SLOT_PENDING_DELETION) {
987 return PSA_ERROR_BAD_STATE;
988 }
989
Gilles Peskine449bd832023-01-11 14:50:10 +0100990 psa_status_t status = psa_remove_key_data_from_memory(slot);
Ronald Cronddd3d052020-10-30 14:07:07 +0100991
Gilles Peskine449bd832023-01-11 14:50:10 +0100992 /*
993 * As the return error code may not be handled in case of multiple errors,
Ryan Everettaa33c512023-12-21 17:32:07 +0000994 * do our best to report an unexpected amount of registered readers.
995 * Assert with MBEDTLS_TEST_HOOK_TEST_ASSERT that registered_readers is
996 * equal to one:
Gilles Peskine449bd832023-01-11 14:50:10 +0100997 * if the MBEDTLS_TEST_HOOKS configuration option is enabled and the
998 * function is called as part of the execution of a test suite, the
999 * execution of the test suite is stopped in error if the assertion fails.
1000 */
Ryan Everettaa33c512023-12-21 17:32:07 +00001001 if (slot->registered_readers != 1) {
1002 MBEDTLS_TEST_HOOK_TEST_ASSERT(slot->registered_readers == 1);
Ronald Cronddd3d052020-10-30 14:07:07 +01001003 status = PSA_ERROR_CORRUPTION_DETECTED;
1004 }
1005
Gilles Peskine3f7cd622019-08-13 15:01:08 +02001006 /* Multipart operations may still be using the key. This is safe
1007 * because all multipart operation objects are independent from
1008 * the key slot: if they need to access the key after the setup
1009 * phase, they have a copy of the key. Note that this means that
1010 * key material can linger until all operations are completed. */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001011 /* At this point, key material and other type-specific content has
1012 * been wiped. Clear remaining metadata. We can call memset and not
Ryan Everettaa33c512023-12-21 17:32:07 +00001013 * zeroize because the metadata is not particularly sensitive.
1014 * This memset also sets the slot's state to PSA_SLOT_EMPTY. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001015 memset(slot, 0, sizeof(*slot));
1016 return status;
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001017}
1018
Gilles Peskine449bd832023-01-11 14:50:10 +01001019psa_status_t psa_destroy_key(mbedtls_svc_key_id_t key)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001020{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001021 psa_key_slot_t *slot;
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001022 psa_status_t status; /* status of the last operation */
1023 psa_status_t overall_status = PSA_SUCCESS;
Gilles Peskine354f7672019-07-12 23:46:38 +02001024#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1025 psa_se_drv_table_entry_t *driver;
1026#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001027
Gilles Peskine449bd832023-01-11 14:50:10 +01001028 if (mbedtls_svc_key_id_is_null(key)) {
1029 return PSA_SUCCESS;
1030 }
Gilles Peskine1841cf42019-10-08 15:48:25 +02001031
Ronald Cronf2911112020-10-29 17:51:10 +01001032 /*
Ronald Cron19daca92020-11-10 18:08:03 +01001033 * Get the description of the key in a key slot. In case of a persistent
Ronald Cronf2911112020-10-29 17:51:10 +01001034 * key, this will load the key description from persistent memory if not
1035 * done yet. We cannot avoid this loading as without it we don't know if
1036 * the key is operated by an SE or not and this information is needed by
1037 * the current implementation.
1038 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001039 status = psa_get_and_lock_key_slot(key, &slot);
1040 if (status != PSA_SUCCESS) {
1041 return status;
1042 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001043
Ronald Cronf2911112020-10-29 17:51:10 +01001044 /*
1045 * If the key slot containing the key description is under access by the
1046 * library (apart from the present access), the key cannot be destroyed
1047 * yet. For the time being, just return in error. Eventually (to be
1048 * implemented), the key should be destroyed when all accesses have
1049 * stopped.
1050 */
Ryan Everettc70ce572024-01-03 16:04:33 +00001051 if (slot->registered_readers > 1) {
1052 psa_unregister_read(slot);
Gilles Peskine449bd832023-01-11 14:50:10 +01001053 return PSA_ERROR_GENERIC_ERROR;
Ronald Cronf2911112020-10-29 17:51:10 +01001054 }
1055
Ryan Everettc70ce572024-01-03 16:04:33 +00001056 slot->state = PSA_SLOT_PENDING_DELETION;
1057
Gilles Peskine449bd832023-01-11 14:50:10 +01001058 if (PSA_KEY_LIFETIME_IS_READ_ONLY(slot->attr.lifetime)) {
Gilles Peskine6687cd02021-04-21 22:32:05 +02001059 /* Refuse the destruction of a read-only key (which may or may not work
1060 * if we attempt it, depending on whether the key is merely read-only
1061 * by policy or actually physically read-only).
Gilles Peskinef9a046e2021-06-07 23:27:54 +02001062 * Just do the best we can, which is to wipe the copy in memory
1063 * (done in this function's cleanup code). */
1064 overall_status = PSA_ERROR_NOT_PERMITTED;
1065 goto exit;
Gilles Peskine6687cd02021-04-21 22:32:05 +02001066 }
1067
Gilles Peskine354f7672019-07-12 23:46:38 +02001068#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001069 driver = psa_get_se_driver_entry(slot->attr.lifetime);
1070 if (driver != NULL) {
Gilles Peskine60450a42019-07-25 11:32:45 +02001071 /* For a key in a secure element, we need to do three things:
1072 * remove the key file in internal storage, destroy the
1073 * key inside the secure element, and update the driver's
1074 * persistent data. Start a transaction that will encompass these
1075 * three actions. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001076 psa_crypto_prepare_transaction(PSA_CRYPTO_TRANSACTION_DESTROY_KEY);
Gilles Peskine8e338702019-07-30 20:06:31 +02001077 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Gilles Peskine449bd832023-01-11 14:50:10 +01001078 psa_crypto_transaction.key.slot = psa_key_slot_get_slot_number(slot);
Gilles Peskine8e338702019-07-30 20:06:31 +02001079 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskine449bd832023-01-11 14:50:10 +01001080 status = psa_crypto_save_transaction();
1081 if (status != PSA_SUCCESS) {
1082 (void) psa_crypto_stop_transaction();
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001083 /* We should still try to destroy the key in the secure
1084 * element and the key metadata in storage. This is especially
1085 * important if the error is that the storage is full.
1086 * But how to do it exactly without risking an inconsistent
1087 * state after a reset?
1088 * https://github.com/ARMmbed/mbed-crypto/issues/215
1089 */
1090 overall_status = status;
1091 goto exit;
Gilles Peskinefc762652019-07-22 19:30:34 +02001092 }
1093
Gilles Peskine449bd832023-01-11 14:50:10 +01001094 status = psa_destroy_se_key(driver,
1095 psa_key_slot_get_slot_number(slot));
1096 if (overall_status == PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001097 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001098 }
Gilles Peskinefc762652019-07-22 19:30:34 +02001099 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001100#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1101
Darryl Greend49a4992018-06-18 17:27:26 +01001102#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001103 if (!PSA_KEY_LIFETIME_IS_VOLATILE(slot->attr.lifetime)) {
1104 status = psa_destroy_persistent_key(slot->attr.id);
1105 if (overall_status == PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001106 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001107 }
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001108
Gilles Peskine9ce31c42019-08-13 15:14:20 +02001109 /* TODO: other slots may have a copy of the same key. We should
1110 * invalidate them.
1111 * https://github.com/ARMmbed/mbed-crypto/issues/214
1112 */
Darryl Greend49a4992018-06-18 17:27:26 +01001113 }
1114#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
Gilles Peskine354f7672019-07-12 23:46:38 +02001115
Gilles Peskinefc762652019-07-22 19:30:34 +02001116#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001117 if (driver != NULL) {
1118 status = psa_save_se_persistent_data(driver);
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 }
1122 status = psa_crypto_stop_transaction();
1123 if (overall_status == PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001124 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001125 }
Gilles Peskinefc762652019-07-22 19:30:34 +02001126 }
1127#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1128
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001129exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01001130 status = psa_wipe_key_slot(slot);
Ryan Everettc70ce572024-01-03 16:04:33 +00001131 /* Prioritize an error from wiping over a storage error */
Gilles Peskine449bd832023-01-11 14:50:10 +01001132 if (status != PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001133 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001134 }
1135 return overall_status;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001136}
1137
Valerio Settib2bcedb2023-07-10 11:24:00 +02001138#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT) || \
John Durkop0e005192020-10-31 22:06:54 -07001139 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskineb699f072019-04-26 16:06:02 +02001140static psa_status_t psa_get_rsa_public_exponent(
1141 const mbedtls_rsa_context *rsa,
Gilles Peskine449bd832023-01-11 14:50:10 +01001142 psa_key_attributes_t *attributes)
Gilles Peskineb699f072019-04-26 16:06:02 +02001143{
1144 mbedtls_mpi mpi;
Janos Follath24eed8d2019-11-22 13:21:35 +00001145 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb699f072019-04-26 16:06:02 +02001146 uint8_t *buffer = NULL;
1147 size_t buflen;
Gilles Peskine449bd832023-01-11 14:50:10 +01001148 mbedtls_mpi_init(&mpi);
Gilles Peskineb699f072019-04-26 16:06:02 +02001149
Gilles Peskine449bd832023-01-11 14:50:10 +01001150 ret = mbedtls_rsa_export(rsa, NULL, NULL, NULL, NULL, &mpi);
1151 if (ret != 0) {
Gilles Peskineb699f072019-04-26 16:06:02 +02001152 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001153 }
1154 if (mbedtls_mpi_cmp_int(&mpi, 65537) == 0) {
Gilles Peskine772c8b12019-04-26 17:37:21 +02001155 /* It's the default value, which is reported as an empty string,
1156 * so there's nothing to do. */
1157 goto exit;
1158 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001159
Gilles Peskine449bd832023-01-11 14:50:10 +01001160 buflen = mbedtls_mpi_size(&mpi);
1161 buffer = mbedtls_calloc(1, buflen);
1162 if (buffer == NULL) {
Gilles Peskineb699f072019-04-26 16:06:02 +02001163 ret = MBEDTLS_ERR_MPI_ALLOC_FAILED;
1164 goto exit;
1165 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001166 ret = mbedtls_mpi_write_binary(&mpi, buffer, buflen);
1167 if (ret != 0) {
Gilles Peskineb699f072019-04-26 16:06:02 +02001168 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001169 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001170 attributes->domain_parameters = buffer;
1171 attributes->domain_parameters_size = buflen;
1172
1173exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01001174 mbedtls_mpi_free(&mpi);
1175 if (ret != 0) {
1176 mbedtls_free(buffer);
1177 }
1178 return mbedtls_to_psa_error(ret);
Gilles Peskineb699f072019-04-26 16:06:02 +02001179}
Valerio Settib2bcedb2023-07-10 11:24:00 +02001180#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT) ||
John Durkop9814fa22020-11-04 12:28:15 -08001181 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001182
Gilles Peskinebfd322f2019-07-23 11:58:03 +02001183/** Retrieve all the publicly-accessible attributes of a key.
1184 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001185psa_status_t psa_get_key_attributes(mbedtls_svc_key_id_t key,
1186 psa_key_attributes_t *attributes)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001187{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001188 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001189 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001190 psa_key_slot_t *slot;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001191
Gilles Peskine449bd832023-01-11 14:50:10 +01001192 psa_reset_key_attributes(attributes);
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001193
Gilles Peskine449bd832023-01-11 14:50:10 +01001194 status = psa_get_and_lock_key_slot_with_policy(key, &slot, 0, 0);
1195 if (status != PSA_SUCCESS) {
1196 return status;
1197 }
Gilles Peskineb870b182018-07-06 16:02:09 +02001198
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001199 attributes->core = slot->attr;
Gilles Peskine449bd832023-01-11 14:50:10 +01001200 attributes->core.flags &= (MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1201 MBEDTLS_PSA_KA_MASK_DUAL_USE);
Gilles Peskinec8000c02019-08-02 20:15:51 +02001202
1203#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001204 if (psa_get_se_driver_entry(slot->attr.lifetime) != NULL) {
1205 psa_set_key_slot_number(attributes,
1206 psa_key_slot_get_slot_number(slot));
1207 }
Gilles Peskinec8000c02019-08-02 20:15:51 +02001208#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineb699f072019-04-26 16:06:02 +02001209
Gilles Peskine449bd832023-01-11 14:50:10 +01001210 switch (slot->attr.type) {
Valerio Settib2bcedb2023-07-10 11:24:00 +02001211#if (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) && \
1212 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) || \
John Durkop0e005192020-10-31 22:06:54 -07001213 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02001214 case PSA_KEY_TYPE_RSA_KEY_PAIR:
Gilles Peskineb699f072019-04-26 16:06:02 +02001215 case PSA_KEY_TYPE_RSA_PUBLIC_KEY:
Pengyu Lvf75893b2023-12-08 17:21:39 +08001216 /* TODO: This is a temporary situation where domain parameters are deprecated,
1217 * but we need it for namely generating an RSA key with a non-default exponent.
1218 * This would be improved after https://github.com/Mbed-TLS/mbedtls/issues/6494.
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001219 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001220 if (!psa_key_lifetime_is_external(slot->attr.lifetime)) {
Steven Cooremana2371e52020-07-28 14:30:39 +02001221 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02001222
Ronald Cron90857082020-11-25 14:58:33 +01001223 status = mbedtls_psa_rsa_load_representation(
Gilles Peskine449bd832023-01-11 14:50:10 +01001224 slot->attr.type,
1225 slot->key.data,
1226 slot->key.bytes,
1227 &rsa);
1228 if (status != PSA_SUCCESS) {
Steven Cooremana01795d2020-07-24 22:48:15 +02001229 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01001230 }
Steven Cooremana01795d2020-07-24 22:48:15 +02001231
Gilles Peskine449bd832023-01-11 14:50:10 +01001232 status = psa_get_rsa_public_exponent(rsa,
1233 attributes);
1234 mbedtls_rsa_free(rsa);
1235 mbedtls_free(rsa);
Steven Cooremana01795d2020-07-24 22:48:15 +02001236 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001237 break;
Pengyu Lve9efbc22023-12-08 16:59:08 +08001238#else
1239 case PSA_KEY_TYPE_RSA_KEY_PAIR:
1240 case PSA_KEY_TYPE_RSA_PUBLIC_KEY:
1241 attributes->domain_parameters = NULL;
1242 attributes->domain_parameters_size = SIZE_MAX;
1243 break;
Valerio Settib2bcedb2023-07-10 11:24:00 +02001244#endif /* (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) && \
1245 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) ||
John Durkop9814fa22020-11-04 12:28:15 -08001246 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001247 default:
1248 /* Nothing else to do. */
1249 break;
1250 }
1251
Gilles Peskine449bd832023-01-11 14:50:10 +01001252 if (status != PSA_SUCCESS) {
1253 psa_reset_key_attributes(attributes);
1254 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001255
Ryan Everett1b70a072024-01-04 10:32:49 +00001256 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02001257
Gilles Peskine449bd832023-01-11 14:50:10 +01001258 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001259}
1260
Gilles Peskinec8000c02019-08-02 20:15:51 +02001261#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1262psa_status_t psa_get_key_slot_number(
1263 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01001264 psa_key_slot_number_t *slot_number)
Gilles Peskinec8000c02019-08-02 20:15:51 +02001265{
Gilles Peskine449bd832023-01-11 14:50:10 +01001266 if (attributes->core.flags & MBEDTLS_PSA_KA_FLAG_HAS_SLOT_NUMBER) {
Gilles Peskinec8000c02019-08-02 20:15:51 +02001267 *slot_number = attributes->slot_number;
Gilles Peskine449bd832023-01-11 14:50:10 +01001268 return PSA_SUCCESS;
1269 } else {
1270 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinec8000c02019-08-02 20:15:51 +02001271 }
Gilles Peskinec8000c02019-08-02 20:15:51 +02001272}
1273#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1274
Gilles Peskine449bd832023-01-11 14:50:10 +01001275static psa_status_t psa_export_key_buffer_internal(const uint8_t *key_buffer,
1276 size_t key_buffer_size,
1277 uint8_t *data,
1278 size_t data_size,
1279 size_t *data_length)
Steven Cooremana01795d2020-07-24 22:48:15 +02001280{
Gilles Peskine449bd832023-01-11 14:50:10 +01001281 if (key_buffer_size > data_size) {
1282 return PSA_ERROR_BUFFER_TOO_SMALL;
1283 }
1284 memcpy(data, key_buffer, key_buffer_size);
1285 memset(data + key_buffer_size, 0,
1286 data_size - key_buffer_size);
Ronald Crond18b5f82020-11-25 16:46:05 +01001287 *data_length = key_buffer_size;
Gilles Peskine449bd832023-01-11 14:50:10 +01001288 return PSA_SUCCESS;
Steven Cooremana01795d2020-07-24 22:48:15 +02001289}
1290
Ronald Cron7285cda2020-11-26 14:46:37 +01001291psa_status_t psa_export_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001292 const psa_key_attributes_t *attributes,
1293 const uint8_t *key_buffer, size_t key_buffer_size,
Gilles Peskine449bd832023-01-11 14:50:10 +01001294 uint8_t *data, size_t data_size, size_t *data_length)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001295{
Ronald Crond18b5f82020-11-25 16:46:05 +01001296 psa_key_type_t type = attributes->core.type;
1297
Gilles Peskine449bd832023-01-11 14:50:10 +01001298 if (key_type_is_raw_bytes(type) ||
1299 PSA_KEY_TYPE_IS_RSA(type) ||
Przemek Stekiel472b3f32022-12-01 14:38:49 +01001300 PSA_KEY_TYPE_IS_ECC(type) ||
1301 PSA_KEY_TYPE_IS_DH(type)) {
Gilles Peskine449bd832023-01-11 14:50:10 +01001302 return psa_export_key_buffer_internal(
1303 key_buffer, key_buffer_size,
1304 data, data_size, data_length);
1305 } else {
Ronald Cron9486f9d2020-11-26 13:36:23 +01001306 /* This shouldn't happen in the reference implementation, but
1307 it is valid for a special-purpose implementation to omit
1308 support for exporting certain key types. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001309 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron9486f9d2020-11-26 13:36:23 +01001310 }
1311}
1312
Gilles Peskine449bd832023-01-11 14:50:10 +01001313psa_status_t psa_export_key(mbedtls_svc_key_id_t key,
1314 uint8_t *data,
1315 size_t data_size,
1316 size_t *data_length)
Ronald Cron9486f9d2020-11-26 13:36:23 +01001317{
1318 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
1319 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
1320 psa_key_slot_t *slot;
1321
Ronald Crone907e552021-01-18 13:22:38 +01001322 /* Reject a zero-length output buffer now, since this can never be a
1323 * valid key representation. This way we know that data must be a valid
1324 * pointer and we can do things like memset(data, ..., data_size). */
Gilles Peskine449bd832023-01-11 14:50:10 +01001325 if (data_size == 0) {
1326 return PSA_ERROR_BUFFER_TOO_SMALL;
1327 }
Ronald Crone907e552021-01-18 13:22:38 +01001328
Ronald Cron9486f9d2020-11-26 13:36:23 +01001329 /* Set the key to empty now, so that even when there are errors, we always
1330 * set data_length to a value between 0 and data_size. On error, setting
1331 * the key to empty is a good choice because an empty key representation is
1332 * unlikely to be accepted anywhere. */
Jaeden Amerof24c7f82018-06-27 17:20:43 +01001333 *data_length = 0;
1334
Ronald Cron9486f9d2020-11-26 13:36:23 +01001335 /* Export requires the EXPORT flag. There is an exception for public keys,
1336 * which don't require any flag, but
1337 * psa_get_and_lock_key_slot_with_policy() takes care of this.
1338 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001339 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
1340 PSA_KEY_USAGE_EXPORT, 0);
1341 if (status != PSA_SUCCESS) {
1342 return status;
1343 }
mohammad160306e79202018-03-28 13:17:44 +03001344
Ronald Crond18b5f82020-11-25 16:46:05 +01001345 psa_key_attributes_t attributes = {
1346 .core = slot->attr
1347 };
Gilles Peskine449bd832023-01-11 14:50:10 +01001348 status = psa_driver_wrapper_export_key(&attributes,
1349 slot->key.data, slot->key.bytes,
1350 data, data_size, data_length);
Ronald Cron9486f9d2020-11-26 13:36:23 +01001351
Ryan Everett1b70a072024-01-04 10:32:49 +00001352 unlock_status = psa_unregister_read(slot);
Ronald Cron9486f9d2020-11-26 13:36:23 +01001353
Gilles Peskine449bd832023-01-11 14:50:10 +01001354 return (status == PSA_SUCCESS) ? unlock_status : status;
Ronald Cron9486f9d2020-11-26 13:36:23 +01001355}
1356
Ronald Cron7285cda2020-11-26 14:46:37 +01001357psa_status_t psa_export_public_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001358 const psa_key_attributes_t *attributes,
1359 const uint8_t *key_buffer,
1360 size_t key_buffer_size,
1361 uint8_t *data,
1362 size_t data_size,
Gilles Peskine449bd832023-01-11 14:50:10 +01001363 size_t *data_length)
Ronald Cron9486f9d2020-11-26 13:36:23 +01001364{
Ronald Crond18b5f82020-11-25 16:46:05 +01001365 psa_key_type_t type = attributes->core.type;
Ronald Crond18b5f82020-11-25 16:46:05 +01001366
Przemek Stekiel6fd72b62023-04-27 10:20:56 +02001367 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(type) &&
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001368 (PSA_KEY_TYPE_IS_RSA(type) || PSA_KEY_TYPE_IS_ECC(type) ||
1369 PSA_KEY_TYPE_IS_DH(type))) {
Przemek Stekiel6fd72b62023-04-27 10:20:56 +02001370 /* Exporting public -> public */
1371 return psa_export_key_buffer_internal(
1372 key_buffer, key_buffer_size,
1373 data, data_size, data_length);
1374 } else if (PSA_KEY_TYPE_IS_RSA(type)) {
Valerio Settib2bcedb2023-07-10 11:24:00 +02001375#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT) || \
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001376 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
1377 return mbedtls_psa_rsa_export_public_key(attributes,
1378 key_buffer,
1379 key_buffer_size,
1380 data,
1381 data_size,
1382 data_length);
Darryl Green9e2d7a02018-07-24 16:33:30 +01001383#else
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001384 /* We don't know how to convert a private RSA key to public. */
1385 return PSA_ERROR_NOT_SUPPORTED;
Valerio Settib2bcedb2023-07-10 11:24:00 +02001386#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT) ||
John Durkop9814fa22020-11-04 12:28:15 -08001387 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Przemek Stekiel6fd72b62023-04-27 10:20:56 +02001388 } else if (PSA_KEY_TYPE_IS_ECC(type)) {
Valerio Setti27c501a2023-06-27 16:58:52 +02001389#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_EXPORT) || \
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001390 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
1391 return mbedtls_psa_ecp_export_public_key(attributes,
1392 key_buffer,
1393 key_buffer_size,
1394 data,
1395 data_size,
1396 data_length);
Steven Cooreman560c28a2020-07-24 23:20:24 +02001397#else
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001398 /* We don't know how to convert a private ECC key to public */
1399 return PSA_ERROR_NOT_SUPPORTED;
Valerio Setti27c501a2023-06-27 16:58:52 +02001400#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_EXPORT) ||
John Durkop9814fa22020-11-04 12:28:15 -08001401 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
Przemek Stekiel6fd72b62023-04-27 10:20:56 +02001402 } else if (PSA_KEY_TYPE_IS_DH(type)) {
Valerio Settia55f0422023-07-10 15:34:41 +02001403#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_EXPORT) || \
Przemek Stekiel6d85afa2023-04-28 11:42:17 +02001404 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY)
Przemek Stekiel152bb462023-06-01 11:52:39 +02001405 return mbedtls_psa_ffdh_export_public_key(attributes,
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001406 key_buffer,
1407 key_buffer_size,
1408 data, data_size,
1409 data_length);
Przemek Stekiel472b3f32022-12-01 14:38:49 +01001410#else
Przemek Stekiel472b3f32022-12-01 14:38:49 +01001411 return PSA_ERROR_NOT_SUPPORTED;
Valerio Settia55f0422023-07-10 15:34:41 +02001412#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_EXPORT) ||
Przemek Stekiel6d85afa2023-04-28 11:42:17 +02001413 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY) */
Gilles Peskine449bd832023-01-11 14:50:10 +01001414 } else {
Przemek Stekiel0b11ee02023-05-16 13:26:06 +02001415 (void) key_buffer;
1416 (void) key_buffer_size;
1417 (void) data;
1418 (void) data_size;
1419 (void) data_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01001420 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman560c28a2020-07-24 23:20:24 +02001421 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001422}
Ronald Crond18b5f82020-11-25 16:46:05 +01001423
Gilles Peskine449bd832023-01-11 14:50:10 +01001424psa_status_t psa_export_public_key(mbedtls_svc_key_id_t key,
1425 uint8_t *data,
1426 size_t data_size,
1427 size_t *data_length)
Moran Pekerdd4ea382018-04-03 15:30:03 +03001428{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001429 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001430 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001431 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01001432 psa_key_attributes_t attributes;
Darryl Greendd8fb772018-11-07 16:00:44 +00001433
Ronald Crone907e552021-01-18 13:22:38 +01001434 /* Reject a zero-length output buffer now, since this can never be a
1435 * valid key representation. This way we know that data must be a valid
1436 * pointer and we can do things like memset(data, ..., data_size). */
Gilles Peskine449bd832023-01-11 14:50:10 +01001437 if (data_size == 0) {
1438 return PSA_ERROR_BUFFER_TOO_SMALL;
1439 }
Ronald Crone907e552021-01-18 13:22:38 +01001440
Darryl Greendd8fb772018-11-07 16:00:44 +00001441 /* Set the key to empty now, so that even when there are errors, we always
1442 * set data_length to a value between 0 and data_size. On error, setting
1443 * the key to empty is a good choice because an empty key representation is
1444 * unlikely to be accepted anywhere. */
1445 *data_length = 0;
1446
1447 /* Exporting a public key doesn't require a usage flag. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001448 status = psa_get_and_lock_key_slot_with_policy(key, &slot, 0, 0);
1449 if (status != PSA_SUCCESS) {
1450 return status;
1451 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001452
Gilles Peskine449bd832023-01-11 14:50:10 +01001453 if (!PSA_KEY_TYPE_IS_ASYMMETRIC(slot->attr.type)) {
1454 status = PSA_ERROR_INVALID_ARGUMENT;
1455 goto exit;
Ronald Cron9486f9d2020-11-26 13:36:23 +01001456 }
1457
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01001458 attributes = (psa_key_attributes_t) {
Ronald Crond18b5f82020-11-25 16:46:05 +01001459 .core = slot->attr
1460 };
Ronald Cron67227982020-11-26 15:16:05 +01001461 status = psa_driver_wrapper_export_public_key(
Ronald Crond18b5f82020-11-25 16:46:05 +01001462 &attributes, slot->key.data, slot->key.bytes,
Gilles Peskine449bd832023-01-11 14:50:10 +01001463 data, data_size, data_length);
Ronald Cron9486f9d2020-11-26 13:36:23 +01001464
1465exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00001466 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02001467
Gilles Peskine449bd832023-01-11 14:50:10 +01001468 return (status == PSA_SUCCESS) ? unlock_status : status;
Moran Pekerdd4ea382018-04-03 15:30:03 +03001469}
1470
Tom Cosgrove6ef9bb32023-03-08 14:19:51 +00001471MBEDTLS_STATIC_ASSERT(
1472 (MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE) == 0,
1473 "One or more key attribute flag is listed as both external-only and dual-use")
1474MBEDTLS_STATIC_ASSERT(
1475 (PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE) == 0,
1476 "One or more key attribute flag is listed as both internal-only and dual-use")
1477MBEDTLS_STATIC_ASSERT(
1478 (PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY) == 0,
1479 "One or more key attribute flag is listed as both internal-only and external-only")
Gilles Peskine91e8c332019-08-02 19:19:39 +02001480
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001481/** Validate that a key policy is internally well-formed.
1482 *
1483 * This function only rejects invalid policies. It does not validate the
1484 * consistency of the policy with respect to other attributes of the key
1485 * such as the key type.
1486 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001487static psa_status_t psa_validate_key_policy(const psa_key_policy_t *policy)
Gilles Peskine4747d192019-04-17 15:05:45 +02001488{
Gilles Peskine449bd832023-01-11 14:50:10 +01001489 if ((policy->usage & ~(PSA_KEY_USAGE_EXPORT |
1490 PSA_KEY_USAGE_COPY |
1491 PSA_KEY_USAGE_ENCRYPT |
1492 PSA_KEY_USAGE_DECRYPT |
1493 PSA_KEY_USAGE_SIGN_MESSAGE |
1494 PSA_KEY_USAGE_VERIFY_MESSAGE |
1495 PSA_KEY_USAGE_SIGN_HASH |
1496 PSA_KEY_USAGE_VERIFY_HASH |
1497 PSA_KEY_USAGE_VERIFY_DERIVATION |
1498 PSA_KEY_USAGE_DERIVE)) != 0) {
1499 return PSA_ERROR_INVALID_ARGUMENT;
1500 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001501
Gilles Peskine449bd832023-01-11 14:50:10 +01001502 return PSA_SUCCESS;
Gilles Peskine4747d192019-04-17 15:05:45 +02001503}
1504
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001505/** Validate the internal consistency of key attributes.
1506 *
1507 * This function only rejects invalid attribute values. If does not
1508 * validate the consistency of the attributes with any key data that may
1509 * be involved in the creation of the key.
1510 *
1511 * Call this function early in the key creation process.
1512 *
1513 * \param[in] attributes Key attributes for the new key.
1514 * \param[out] p_drv On any return, the driver for the key, if any.
1515 * NULL for a transparent key.
1516 *
1517 */
1518static psa_status_t psa_validate_key_attributes(
1519 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01001520 psa_se_drv_table_entry_t **p_drv)
Darryl Green0c6575a2018-11-07 16:05:30 +00001521{
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001522 psa_status_t status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine449bd832023-01-11 14:50:10 +01001523 psa_key_lifetime_t lifetime = psa_get_key_lifetime(attributes);
1524 mbedtls_svc_key_id_t key = psa_get_key_id(attributes);
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001525
Gilles Peskine449bd832023-01-11 14:50:10 +01001526 status = psa_validate_key_location(lifetime, p_drv);
1527 if (status != PSA_SUCCESS) {
1528 return status;
Ronald Crond2ed4812020-07-17 16:11:30 +02001529 }
1530
Gilles Peskine449bd832023-01-11 14:50:10 +01001531 status = psa_validate_key_persistence(lifetime);
1532 if (status != PSA_SUCCESS) {
1533 return status;
1534 }
1535
1536 if (PSA_KEY_LIFETIME_IS_VOLATILE(lifetime)) {
1537 if (MBEDTLS_SVC_KEY_ID_GET_KEY_ID(key) != 0) {
1538 return PSA_ERROR_INVALID_ARGUMENT;
1539 }
1540 } else {
1541 if (!psa_is_valid_key_id(psa_get_key_id(attributes), 0)) {
1542 return PSA_ERROR_INVALID_ARGUMENT;
1543 }
1544 }
1545
1546 status = psa_validate_key_policy(&attributes->core.policy);
1547 if (status != PSA_SUCCESS) {
1548 return status;
1549 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001550
1551 /* Refuse to create overly large keys.
1552 * Note that this doesn't trigger on import if the attributes don't
1553 * explicitly specify a size (so psa_get_key_bits returns 0), so
1554 * psa_import_key() needs its own checks. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001555 if (psa_get_key_bits(attributes) > PSA_MAX_KEY_BITS) {
1556 return PSA_ERROR_NOT_SUPPORTED;
1557 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001558
Gilles Peskine91e8c332019-08-02 19:19:39 +02001559 /* Reject invalid flags. These should not be reachable through the API. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001560 if (attributes->core.flags & ~(MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1561 MBEDTLS_PSA_KA_MASK_DUAL_USE)) {
1562 return PSA_ERROR_INVALID_ARGUMENT;
1563 }
Gilles Peskine91e8c332019-08-02 19:19:39 +02001564
Gilles Peskine449bd832023-01-11 14:50:10 +01001565 return PSA_SUCCESS;
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001566}
1567
Gilles Peskine4747d192019-04-17 15:05:45 +02001568/** Prepare a key slot to receive key material.
1569 *
1570 * This function allocates a key slot and sets its metadata.
1571 *
1572 * If this function fails, call psa_fail_key_creation().
1573 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001574 * This function is intended to be used as follows:
1575 * -# Call psa_start_key_creation() to allocate a key slot, prepare
Ronald Croncf56a0a2020-08-04 09:51:30 +02001576 * it with the specified attributes, and in case of a volatile key assign it
1577 * a volatile key identifier.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001578 * -# Populate the slot with the key material.
1579 * -# Call psa_finish_key_creation() to finalize the creation of the slot.
1580 * In case of failure at any step, stop the sequence and call
1581 * psa_fail_key_creation().
1582 *
Ryan Everettb69118e2024-01-02 15:54:32 +00001583 * On success, the key slot's state is PSA_SLOT_FILLING.
1584 * It is the responsibility of the caller to change the slot's state to
1585 * PSA_SLOT_EMPTY/FULL once key creation has finished.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001586 *
Gilles Peskinedf179142019-07-15 22:02:14 +02001587 * \param method An identification of the calling function.
Gilles Peskine011e4282019-06-26 18:34:38 +02001588 * \param[in] attributes Key attributes for the new key.
Gilles Peskine011e4282019-06-26 18:34:38 +02001589 * \param[out] p_slot On success, a pointer to the prepared slot.
1590 * \param[out] p_drv On any return, the driver for the key, if any.
1591 * NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001592 *
1593 * \retval #PSA_SUCCESS
1594 * The key slot is ready to receive key material.
1595 * \return If this function fails, the key slot is an invalid state.
1596 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001597 */
1598static psa_status_t psa_start_key_creation(
Gilles Peskinedf179142019-07-15 22:02:14 +02001599 psa_key_creation_method_t method,
Gilles Peskine4747d192019-04-17 15:05:45 +02001600 const psa_key_attributes_t *attributes,
Gilles Peskine011e4282019-06-26 18:34:38 +02001601 psa_key_slot_t **p_slot,
Gilles Peskine449bd832023-01-11 14:50:10 +01001602 psa_se_drv_table_entry_t **p_drv)
Gilles Peskine4747d192019-04-17 15:05:45 +02001603{
1604 psa_status_t status;
Ronald Cron2a993152020-07-17 14:13:26 +02001605 psa_key_id_t volatile_key_id;
Gilles Peskine4747d192019-04-17 15:05:45 +02001606 psa_key_slot_t *slot;
1607
Gilles Peskinedf179142019-07-15 22:02:14 +02001608 (void) method;
Gilles Peskine011e4282019-06-26 18:34:38 +02001609 *p_drv = NULL;
1610
Gilles Peskine449bd832023-01-11 14:50:10 +01001611 status = psa_validate_key_attributes(attributes, p_drv);
1612 if (status != PSA_SUCCESS) {
1613 return status;
1614 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001615
Ryan Everettb69118e2024-01-02 15:54:32 +00001616 status = psa_reserve_free_key_slot(&volatile_key_id, p_slot);
Gilles Peskine449bd832023-01-11 14:50:10 +01001617 if (status != PSA_SUCCESS) {
1618 return status;
1619 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001620 slot = *p_slot;
1621
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001622 /* We're storing the declared bit-size of the key. It's up to each
1623 * creation mechanism to verify that this information is correct.
1624 * It's automatically correct for mechanisms that use the bit-size as
Gilles Peskineb46bef22019-07-30 21:32:04 +02001625 * an input (generate, device) but not for those where the bit-size
Ronald Cronc4d1b512020-07-31 11:26:37 +02001626 * is optional (import, copy). In case of a volatile key, assign it the
1627 * volatile key identifier associated to the slot returned to contain its
1628 * definition. */
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001629
1630 slot->attr = attributes->core;
Gilles Peskine449bd832023-01-11 14:50:10 +01001631 if (PSA_KEY_LIFETIME_IS_VOLATILE(slot->attr.lifetime)) {
Ronald Cronc4d1b512020-07-31 11:26:37 +02001632#if !defined(MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER)
1633 slot->attr.id = volatile_key_id;
1634#else
1635 slot->attr.id.key_id = volatile_key_id;
1636#endif
1637 }
Gilles Peskinec744d992019-07-30 17:26:54 +02001638
Gilles Peskine91e8c332019-08-02 19:19:39 +02001639 /* Erase external-only flags from the internal copy. To access
Gilles Peskine013f5472019-08-07 15:42:14 +02001640 * external-only flags, query `attributes`. Thanks to the check
1641 * in psa_validate_key_attributes(), this leaves the dual-use
Ryan Everettb69118e2024-01-02 15:54:32 +00001642 * flags and any internal flag that psa_reserve_free_key_slot()
Gilles Peskine013f5472019-08-07 15:42:14 +02001643 * may have set. */
1644 slot->attr.flags &= ~MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY;
Gilles Peskine91e8c332019-08-02 19:19:39 +02001645
Gilles Peskinecbaff462019-07-12 23:46:04 +02001646#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001647 /* For a key in a secure element, we need to do three things
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001648 * when creating or registering a persistent key:
Gilles Peskine60450a42019-07-25 11:32:45 +02001649 * create the key file in internal storage, create the
1650 * key inside the secure element, and update the driver's
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001651 * persistent data. This is done by starting a transaction that will
1652 * encompass these three actions.
1653 * For registering a volatile key, we just need to find an appropriate
1654 * slot number inside the SE. Since the key is designated volatile, creating
1655 * a transaction is not required. */
Gilles Peskine60450a42019-07-25 11:32:45 +02001656 /* The first thing to do is to find a slot number for the new key.
1657 * We save the slot number in persistent storage as part of the
1658 * transaction data. It will be needed to recover if the power
1659 * fails during the key creation process, to clean up on the secure
1660 * element side after restarting. Obtaining a slot number from the
1661 * secure element driver updates its persistent state, but we do not yet
1662 * save the driver's persistent state, so that if the power fails,
Gilles Peskinefc762652019-07-22 19:30:34 +02001663 * we can roll back to a state where the key doesn't exist. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001664 if (*p_drv != NULL) {
Ronald Cronea0f8a62020-11-25 17:52:23 +01001665 psa_key_slot_number_t slot_number;
Gilles Peskine449bd832023-01-11 14:50:10 +01001666 status = psa_find_se_slot_for_key(attributes, method, *p_drv,
1667 &slot_number);
1668 if (status != PSA_SUCCESS) {
1669 return status;
1670 }
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001671
Gilles Peskine449bd832023-01-11 14:50:10 +01001672 if (!PSA_KEY_LIFETIME_IS_VOLATILE(attributes->core.lifetime)) {
1673 psa_crypto_prepare_transaction(PSA_CRYPTO_TRANSACTION_CREATE_KEY);
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001674 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001675 psa_crypto_transaction.key.slot = slot_number;
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001676 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskine449bd832023-01-11 14:50:10 +01001677 status = psa_crypto_save_transaction();
1678 if (status != PSA_SUCCESS) {
1679 (void) psa_crypto_stop_transaction();
1680 return status;
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001681 }
Gilles Peskine66be51c2019-07-25 18:02:52 +02001682 }
Ronald Cronea0f8a62020-11-25 17:52:23 +01001683
1684 status = psa_copy_key_material_into_slot(
Gilles Peskine449bd832023-01-11 14:50:10 +01001685 slot, (uint8_t *) (&slot_number), sizeof(slot_number));
Darryl Green0c6575a2018-11-07 16:05:30 +00001686 }
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001687
Gilles Peskine449bd832023-01-11 14:50:10 +01001688 if (*p_drv == NULL && method == PSA_KEY_CREATION_REGISTER) {
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001689 /* Key registration only makes sense with a secure element. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001690 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001691 }
Gilles Peskinecbaff462019-07-12 23:46:04 +02001692#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1693
Gilles Peskine449bd832023-01-11 14:50:10 +01001694 return PSA_SUCCESS;
Darryl Green0c6575a2018-11-07 16:05:30 +00001695}
Gilles Peskine4747d192019-04-17 15:05:45 +02001696
1697/** Finalize the creation of a key once its key material has been set.
1698 *
1699 * This entails writing the key to persistent storage.
1700 *
1701 * If this function fails, call psa_fail_key_creation().
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001702 * See the documentation of psa_start_key_creation() for the intended use
1703 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001704 *
Ryan Everettb69118e2024-01-02 15:54:32 +00001705 * If the finalization succeeds, the function sets the key slot's state to
1706 * PSA_SLOT_FULL, and the key slot can no longer be accessed as part of the
1707 * key creation process.
Ronald Cron50972942020-11-14 11:28:25 +01001708 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001709 * \param[in,out] slot Pointer to the slot with key material.
1710 * \param[in] driver The secure element driver for the key,
1711 * or NULL for a transparent key.
Ronald Cron81709fc2020-11-14 12:10:32 +01001712 * \param[out] key On success, identifier of the key. Note that the
1713 * key identifier is also stored in the key slot.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001714 *
1715 * \retval #PSA_SUCCESS
Ronald Croncf56a0a2020-08-04 09:51:30 +02001716 * The key was successfully created.
Gilles Peskineed733552023-02-14 19:21:09 +01001717 * \retval #PSA_ERROR_INSUFFICIENT_MEMORY \emptydescription
1718 * \retval #PSA_ERROR_INSUFFICIENT_STORAGE \emptydescription
1719 * \retval #PSA_ERROR_ALREADY_EXISTS \emptydescription
1720 * \retval #PSA_ERROR_DATA_INVALID \emptydescription
1721 * \retval #PSA_ERROR_DATA_CORRUPT \emptydescription
1722 * \retval #PSA_ERROR_STORAGE_FAILURE \emptydescription
Ryan Everettb69118e2024-01-02 15:54:32 +00001723 * \retval #PSA_ERROR_BAD_STATE \emptydescription
gabor-mezei-arm452b0a32020-11-09 17:42:55 +01001724 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001725 * \return If this function fails, the key slot is an invalid state.
1726 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001727 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001728static psa_status_t psa_finish_key_creation(
1729 psa_key_slot_t *slot,
Ronald Cron81709fc2020-11-14 12:10:32 +01001730 psa_se_drv_table_entry_t *driver,
1731 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02001732{
1733 psa_status_t status = PSA_SUCCESS;
Gilles Peskine30afafd2019-04-25 13:47:40 +02001734 (void) slot;
Gilles Peskine011e4282019-06-26 18:34:38 +02001735 (void) driver;
Gilles Peskine4747d192019-04-17 15:05:45 +02001736
1737#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001738 if (!PSA_KEY_LIFETIME_IS_VOLATILE(slot->attr.lifetime)) {
Gilles Peskine1df83d42019-07-23 16:13:14 +02001739#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001740 if (driver != NULL) {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001741 psa_se_key_data_storage_t data;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001742 psa_key_slot_number_t slot_number =
Gilles Peskine449bd832023-01-11 14:50:10 +01001743 psa_key_slot_get_slot_number(slot);
Ronald Cronea0f8a62020-11-25 17:52:23 +01001744
Tom Cosgrove6ef9bb32023-03-08 14:19:51 +00001745 MBEDTLS_STATIC_ASSERT(sizeof(slot_number) ==
1746 sizeof(data.slot_number),
1747 "Slot number size does not match psa_se_key_data_storage_t");
1748
Gilles Peskine449bd832023-01-11 14:50:10 +01001749 memcpy(&data.slot_number, &slot_number, sizeof(slot_number));
1750 status = psa_save_persistent_key(&slot->attr,
1751 (uint8_t *) &data,
1752 sizeof(data));
1753 } else
Gilles Peskine1df83d42019-07-23 16:13:14 +02001754#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1755 {
Steven Cooreman40120f62020-10-29 11:42:22 +01001756 /* Key material is saved in export representation in the slot, so
1757 * just pass the slot buffer for storage. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001758 status = psa_save_persistent_key(&slot->attr,
1759 slot->key.data,
1760 slot->key.bytes);
Gilles Peskine1df83d42019-07-23 16:13:14 +02001761 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001762 }
Darryl Green0c6575a2018-11-07 16:05:30 +00001763#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
1764
Gilles Peskinecbaff462019-07-12 23:46:04 +02001765#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001766 /* Finish the transaction for a key creation. This does not
1767 * happen when registering an existing key. Detect this case
1768 * by checking whether a transaction is in progress (actual
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001769 * creation of a persistent key in a secure element requires a transaction,
1770 * but registration or volatile key creation doesn't use one). */
Gilles Peskine449bd832023-01-11 14:50:10 +01001771 if (driver != NULL &&
1772 psa_crypto_transaction.unknown.type == PSA_CRYPTO_TRANSACTION_CREATE_KEY) {
1773 status = psa_save_se_persistent_data(driver);
1774 if (status != PSA_SUCCESS) {
1775 psa_destroy_persistent_key(slot->attr.id);
1776 return status;
Gilles Peskinecbaff462019-07-12 23:46:04 +02001777 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001778 status = psa_crypto_stop_transaction();
Gilles Peskinecbaff462019-07-12 23:46:04 +02001779 }
1780#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1781
Gilles Peskine449bd832023-01-11 14:50:10 +01001782 if (status == PSA_SUCCESS) {
Ronald Cron81709fc2020-11-14 12:10:32 +01001783 *key = slot->attr.id;
Ryan Everettb69118e2024-01-02 15:54:32 +00001784 status = psa_key_slot_state_transition(slot, PSA_SLOT_FILLING,
1785 PSA_SLOT_FULL);
Gilles Peskine449bd832023-01-11 14:50:10 +01001786 if (status != PSA_SUCCESS) {
Ronald Cron81709fc2020-11-14 12:10:32 +01001787 *key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01001788 }
Ronald Cron81709fc2020-11-14 12:10:32 +01001789 }
Ronald Cron50972942020-11-14 11:28:25 +01001790
Gilles Peskine449bd832023-01-11 14:50:10 +01001791 return status;
Gilles Peskine4747d192019-04-17 15:05:45 +02001792}
1793
1794/** Abort the creation of a key.
1795 *
1796 * You may call this function after calling psa_start_key_creation(),
1797 * or after psa_finish_key_creation() fails. In other circumstances, this
1798 * function may not clean up persistent storage.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001799 * See the documentation of psa_start_key_creation() for the intended use
Ryan Everettb69118e2024-01-02 15:54:32 +00001800 * of this function. Sets the slot's state to PSA_SLOT_EMPTY.
Gilles Peskine4747d192019-04-17 15:05:45 +02001801 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001802 * \param[in,out] slot Pointer to the slot with key material.
1803 * \param[in] driver The secure element driver for the key,
1804 * or NULL for a transparent key.
Gilles Peskine4747d192019-04-17 15:05:45 +02001805 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001806static void psa_fail_key_creation(psa_key_slot_t *slot,
1807 psa_se_drv_table_entry_t *driver)
Gilles Peskine4747d192019-04-17 15:05:45 +02001808{
Gilles Peskine011e4282019-06-26 18:34:38 +02001809 (void) driver;
1810
Gilles Peskine449bd832023-01-11 14:50:10 +01001811 if (slot == NULL) {
Gilles Peskine4747d192019-04-17 15:05:45 +02001812 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01001813 }
Gilles Peskine011e4282019-06-26 18:34:38 +02001814
1815#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001816 /* TODO: If the key has already been created in the secure
Gilles Peskine011e4282019-06-26 18:34:38 +02001817 * element, and the failure happened later (when saving metadata
1818 * to internal storage), we need to destroy the key in the secure
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001819 * element.
1820 * https://github.com/ARMmbed/mbed-crypto/issues/217
1821 */
Gilles Peskinefc762652019-07-22 19:30:34 +02001822
Gilles Peskined7729582019-08-05 15:55:54 +02001823 /* Abort the ongoing transaction if any (there may not be one if
1824 * the creation process failed before starting one, or if the
1825 * key creation is a registration of a key in a secure element).
1826 * Earlier functions must already have done what it takes to undo any
1827 * partial creation. All that's left is to update the transaction data
1828 * itself. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001829 (void) psa_crypto_stop_transaction();
Gilles Peskine011e4282019-06-26 18:34:38 +02001830#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1831
Ryan Everettb69118e2024-01-02 15:54:32 +00001832 /* Prepare the key slot to be wiped, and then wipe it. */
1833 slot->registered_readers = 1;
1834 psa_key_slot_state_transition(slot, PSA_SLOT_FILLING,
1835 PSA_SLOT_PENDING_DELETION);
1836
Gilles Peskine449bd832023-01-11 14:50:10 +01001837 psa_wipe_key_slot(slot);
Gilles Peskine4747d192019-04-17 15:05:45 +02001838}
1839
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001840/** Validate optional attributes during key creation.
1841 *
1842 * Some key attributes are optional during key creation. If they are
1843 * specified in the attributes structure, check that they are consistent
1844 * with the data in the slot.
1845 *
1846 * This function should be called near the end of key creation, after
1847 * the slot in memory is fully populated but before saving persistent data.
1848 */
1849static psa_status_t psa_validate_optional_attributes(
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001850 const psa_key_slot_t *slot,
Gilles Peskine449bd832023-01-11 14:50:10 +01001851 const psa_key_attributes_t *attributes)
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001852{
Gilles Peskine449bd832023-01-11 14:50:10 +01001853 if (attributes->core.type != 0) {
1854 if (attributes->core.type != slot->attr.type) {
1855 return PSA_ERROR_INVALID_ARGUMENT;
1856 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001857 }
1858
Gilles Peskine449bd832023-01-11 14:50:10 +01001859 if (attributes->domain_parameters_size != 0) {
Valerio Settib2bcedb2023-07-10 11:24:00 +02001860#if (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) && \
1861 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01001862 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
1863 if (PSA_KEY_TYPE_IS_RSA(slot->attr.type)) {
Steven Cooremana2371e52020-07-28 14:30:39 +02001864 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman75b74362020-07-28 14:30:13 +02001865 mbedtls_mpi actual, required;
Steven Cooreman6d839f02020-07-30 11:36:45 +02001866 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooremana01795d2020-07-24 22:48:15 +02001867
Ronald Cron90857082020-11-25 14:58:33 +01001868 psa_status_t status = mbedtls_psa_rsa_load_representation(
Gilles Peskine449bd832023-01-11 14:50:10 +01001869 slot->attr.type,
1870 slot->key.data,
1871 slot->key.bytes,
1872 &rsa);
1873 if (status != PSA_SUCCESS) {
1874 return status;
1875 }
Steven Cooreman75b74362020-07-28 14:30:13 +02001876
Gilles Peskine449bd832023-01-11 14:50:10 +01001877 mbedtls_mpi_init(&actual);
1878 mbedtls_mpi_init(&required);
1879 ret = mbedtls_rsa_export(rsa,
1880 NULL, NULL, NULL, NULL, &actual);
1881 mbedtls_rsa_free(rsa);
1882 mbedtls_free(rsa);
1883 if (ret != 0) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001884 goto rsa_exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001885 }
1886 ret = mbedtls_mpi_read_binary(&required,
1887 attributes->domain_parameters,
1888 attributes->domain_parameters_size);
1889 if (ret != 0) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001890 goto rsa_exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001891 }
1892 if (mbedtls_mpi_cmp_mpi(&actual, &required) != 0) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001893 ret = MBEDTLS_ERR_RSA_BAD_INPUT_DATA;
Gilles Peskine449bd832023-01-11 14:50:10 +01001894 }
1895rsa_exit:
1896 mbedtls_mpi_free(&actual);
1897 mbedtls_mpi_free(&required);
1898 if (ret != 0) {
1899 return mbedtls_to_psa_error(ret);
1900 }
1901 } else
Valerio Settib2bcedb2023-07-10 11:24:00 +02001902#endif /* (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) &&
1903 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) ||
John Durkop9814fa22020-11-04 12:28:15 -08001904 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001905 {
Gilles Peskine449bd832023-01-11 14:50:10 +01001906 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001907 }
1908 }
1909
Gilles Peskine449bd832023-01-11 14:50:10 +01001910 if (attributes->core.bits != 0) {
1911 if (attributes->core.bits != slot->attr.bits) {
1912 return PSA_ERROR_INVALID_ARGUMENT;
1913 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001914 }
1915
Gilles Peskine449bd832023-01-11 14:50:10 +01001916 return PSA_SUCCESS;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001917}
1918
Gilles Peskine449bd832023-01-11 14:50:10 +01001919psa_status_t psa_import_key(const psa_key_attributes_t *attributes,
1920 const uint8_t *data,
1921 size_t data_length,
1922 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02001923{
1924 psa_status_t status;
1925 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001926 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001927 size_t bits;
Archanad8a83dc2021-06-14 10:04:16 +05301928 size_t storage_size = data_length;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001929
Ronald Cron81709fc2020-11-14 12:10:32 +01001930 *key = MBEDTLS_SVC_KEY_ID_INIT;
1931
Gilles Peskine0f84d622019-09-12 19:03:13 +02001932 /* Reject zero-length symmetric keys (including raw data key objects).
1933 * This also rejects any key which might be encoded as an empty string,
1934 * which is never valid. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001935 if (data_length == 0) {
1936 return PSA_ERROR_INVALID_ARGUMENT;
1937 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02001938
Archana449608b2021-09-08 15:36:05 +05301939 /* Ensure that the bytes-to-bits conversion cannot overflow. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001940 if (data_length > SIZE_MAX / 8) {
1941 return PSA_ERROR_NOT_SUPPORTED;
1942 }
Archana6ed4bda2021-08-04 10:47:15 +05301943
Gilles Peskine449bd832023-01-11 14:50:10 +01001944 status = psa_start_key_creation(PSA_KEY_CREATION_IMPORT, attributes,
1945 &slot, &driver);
1946 if (status != PSA_SUCCESS) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001947 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001948 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001949
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001950 /* In the case of a transparent key or an opaque key stored in local
Archana449608b2021-09-08 15:36:05 +05301951 * storage ( thus not in the case of importing a key in a secure element
1952 * with storage ( MBEDTLS_PSA_CRYPTO_SE_C ) ),we have to allocate a
1953 * buffer to hold the imported key material. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001954 if (slot->key.data == NULL) {
1955 if (psa_key_lifetime_is_external(attributes->core.lifetime)) {
Archana449608b2021-09-08 15:36:05 +05301956 status = psa_driver_wrapper_get_key_buffer_size_from_key_data(
Gilles Peskine449bd832023-01-11 14:50:10 +01001957 attributes, data, data_length, &storage_size);
1958 if (status != PSA_SUCCESS) {
Archanad8a83dc2021-06-14 10:04:16 +05301959 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001960 }
Archanad8a83dc2021-06-14 10:04:16 +05301961 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001962 status = psa_allocate_buffer_to_slot(slot, storage_size);
1963 if (status != PSA_SUCCESS) {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001964 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001965 }
Gilles Peskine5d309672019-07-12 23:47:28 +02001966 }
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001967
1968 bits = slot->attr.bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01001969 status = psa_driver_wrapper_import_key(attributes,
1970 data, data_length,
1971 slot->key.data,
1972 slot->key.bytes,
1973 &slot->key.bytes, &bits);
1974 if (status != PSA_SUCCESS) {
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001975 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001976 }
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001977
Gilles Peskine449bd832023-01-11 14:50:10 +01001978 if (slot->attr.bits == 0) {
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001979 slot->attr.bits = (psa_key_bits_t) bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01001980 } else if (bits != slot->attr.bits) {
Steven Cooremanac3434f2021-01-15 17:36:02 +01001981 status = PSA_ERROR_INVALID_ARGUMENT;
1982 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02001983 }
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01001984
Archana6ed4bda2021-08-04 10:47:15 +05301985 /* Enforce a size limit, and in particular ensure that the bit
1986 * size fits in its representation type.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01001987 if (bits > PSA_MAX_KEY_BITS) {
Archana6ed4bda2021-08-04 10:47:15 +05301988 status = PSA_ERROR_NOT_SUPPORTED;
1989 goto exit;
1990 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001991 status = psa_validate_optional_attributes(slot, attributes);
1992 if (status != PSA_SUCCESS) {
Gilles Peskine18017402019-07-24 20:25:59 +02001993 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001994 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001995
Gilles Peskine449bd832023-01-11 14:50:10 +01001996 status = psa_finish_key_creation(slot, driver, key);
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001997exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01001998 if (status != PSA_SUCCESS) {
1999 psa_fail_key_creation(slot, driver);
2000 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002001
Gilles Peskine449bd832023-01-11 14:50:10 +01002002 return status;
Gilles Peskine4747d192019-04-17 15:05:45 +02002003}
2004
Gilles Peskined7729582019-08-05 15:55:54 +02002005#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2006psa_status_t mbedtls_psa_register_se_key(
Gilles Peskine449bd832023-01-11 14:50:10 +01002007 const psa_key_attributes_t *attributes)
Gilles Peskined7729582019-08-05 15:55:54 +02002008{
2009 psa_status_t status;
2010 psa_key_slot_t *slot = NULL;
2011 psa_se_drv_table_entry_t *driver = NULL;
Ronald Croncf56a0a2020-08-04 09:51:30 +02002012 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskined7729582019-08-05 15:55:54 +02002013
2014 /* Leaving attributes unspecified is not currently supported.
2015 * It could make sense to query the key type and size from the
2016 * secure element, but not all secure elements support this
2017 * and the driver HAL doesn't currently support it. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002018 if (psa_get_key_type(attributes) == PSA_KEY_TYPE_NONE) {
2019 return PSA_ERROR_NOT_SUPPORTED;
2020 }
2021 if (psa_get_key_bits(attributes) == 0) {
2022 return PSA_ERROR_NOT_SUPPORTED;
2023 }
Gilles Peskined7729582019-08-05 15:55:54 +02002024
Gilles Peskine449bd832023-01-11 14:50:10 +01002025 status = psa_start_key_creation(PSA_KEY_CREATION_REGISTER, attributes,
2026 &slot, &driver);
2027 if (status != PSA_SUCCESS) {
Gilles Peskined7729582019-08-05 15:55:54 +02002028 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002029 }
Gilles Peskined7729582019-08-05 15:55:54 +02002030
Gilles Peskine449bd832023-01-11 14:50:10 +01002031 status = psa_finish_key_creation(slot, driver, &key);
Gilles Peskined7729582019-08-05 15:55:54 +02002032
2033exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002034 if (status != PSA_SUCCESS) {
2035 psa_fail_key_creation(slot, driver);
2036 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002037
Gilles Peskined7729582019-08-05 15:55:54 +02002038 /* Registration doesn't keep the key in RAM. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002039 psa_close_key(key);
2040 return status;
Gilles Peskined7729582019-08-05 15:55:54 +02002041}
2042#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2043
Gilles Peskine449bd832023-01-11 14:50:10 +01002044psa_status_t psa_copy_key(mbedtls_svc_key_id_t source_key,
2045 const psa_key_attributes_t *specified_attributes,
2046 mbedtls_svc_key_id_t *target_key)
Gilles Peskinef603c712019-01-19 13:40:11 +01002047{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002048 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01002049 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinef603c712019-01-19 13:40:11 +01002050 psa_key_slot_t *source_slot = NULL;
2051 psa_key_slot_t *target_slot = NULL;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002052 psa_key_attributes_t actual_attributes = *specified_attributes;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002053 psa_se_drv_table_entry_t *driver = NULL;
Archana8a180362021-07-05 02:18:48 +05302054 size_t storage_size = 0;
Gilles Peskinef603c712019-01-19 13:40:11 +01002055
Ronald Cron81709fc2020-11-14 12:10:32 +01002056 *target_key = MBEDTLS_SVC_KEY_ID_INIT;
2057
Archana8a180362021-07-05 02:18:48 +05302058 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002059 source_key, &source_slot, PSA_KEY_USAGE_COPY, 0);
2060 if (status != PSA_SUCCESS) {
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002061 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002062 }
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002063
Gilles Peskine449bd832023-01-11 14:50:10 +01002064 status = psa_validate_optional_attributes(source_slot,
2065 specified_attributes);
2066 if (status != PSA_SUCCESS) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002067 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002068 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002069
Archana9d17bf42021-09-10 06:22:44 +05302070 /* The target key type and number of bits have been validated by
2071 * psa_validate_optional_attributes() to be either equal to zero or
2072 * equal to the ones of the source key. So it is safe to inherit
2073 * them from the source key now."
Archana374fe5b2021-09-08 15:50:28 +05302074 * */
Archana9d17bf42021-09-10 06:22:44 +05302075 actual_attributes.core.bits = source_slot->attr.bits;
2076 actual_attributes.core.type = source_slot->attr.type;
Archana374fe5b2021-09-08 15:50:28 +05302077
2078
Gilles Peskine449bd832023-01-11 14:50:10 +01002079 status = psa_restrict_key_policy(source_slot->attr.type,
2080 &actual_attributes.core.policy,
2081 &source_slot->attr.policy);
2082 if (status != PSA_SUCCESS) {
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002083 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002084 }
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002085
Gilles Peskine449bd832023-01-11 14:50:10 +01002086 status = psa_start_key_creation(PSA_KEY_CREATION_COPY, &actual_attributes,
2087 &target_slot, &driver);
2088 if (status != PSA_SUCCESS) {
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002089 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002090 }
2091 if (PSA_KEY_LIFETIME_GET_LOCATION(target_slot->attr.lifetime) !=
2092 PSA_KEY_LIFETIME_GET_LOCATION(source_slot->attr.lifetime)) {
Archana8a180362021-07-05 02:18:48 +05302093 /*
Archana9d17bf42021-09-10 06:22:44 +05302094 * If the source and target keys are stored in different locations,
Archana8a180362021-07-05 02:18:48 +05302095 * the source key would need to be exported as plaintext and re-imported
2096 * in the other location. This has security implications which have not
Archana449608b2021-09-08 15:36:05 +05302097 * been fully mapped. For now, this can be achieved through
Archana8a180362021-07-05 02:18:48 +05302098 * appropriate API invocations from the application, if needed.
2099 * */
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002100 status = PSA_ERROR_NOT_SUPPORTED;
2101 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002102 }
Archana8a180362021-07-05 02:18:48 +05302103 /*
2104 * When the source and target keys are within the same location,
Archana449608b2021-09-08 15:36:05 +05302105 * - For transparent keys it is a blind copy without any driver invocation,
Archana8a180362021-07-05 02:18:48 +05302106 * - For opaque keys this translates to an invocation of the drivers'
2107 * copy_key entry point through the dispatch layer.
2108 * */
Gilles Peskine449bd832023-01-11 14:50:10 +01002109 if (psa_key_lifetime_is_external(actual_attributes.core.lifetime)) {
2110 status = psa_driver_wrapper_get_key_buffer_size(&actual_attributes,
2111 &storage_size);
2112 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302113 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002114 }
Archana374fe5b2021-09-08 15:50:28 +05302115
Gilles Peskine449bd832023-01-11 14:50:10 +01002116 status = psa_allocate_buffer_to_slot(target_slot, storage_size);
2117 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302118 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002119 }
Archana374fe5b2021-09-08 15:50:28 +05302120
Gilles Peskine449bd832023-01-11 14:50:10 +01002121 status = psa_driver_wrapper_copy_key(&actual_attributes,
2122 source_slot->key.data,
2123 source_slot->key.bytes,
2124 target_slot->key.data,
2125 target_slot->key.bytes,
2126 &target_slot->key.bytes);
2127 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302128 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002129 }
2130 } else {
2131 status = psa_copy_key_material_into_slot(target_slot,
Archana9d17bf42021-09-10 06:22:44 +05302132 source_slot->key.data,
Gilles Peskine449bd832023-01-11 14:50:10 +01002133 source_slot->key.bytes);
2134 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302135 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002136 }
Archana8a180362021-07-05 02:18:48 +05302137 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002138 status = psa_finish_key_creation(target_slot, driver, target_key);
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002139exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002140 if (status != PSA_SUCCESS) {
2141 psa_fail_key_creation(target_slot, driver);
2142 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002143
Ryan Everett1b70a072024-01-04 10:32:49 +00002144 unlock_status = psa_unregister_read(source_slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02002145
Gilles Peskine449bd832023-01-11 14:50:10 +01002146 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskinef603c712019-01-19 13:40:11 +01002147}
2148
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02002149
2150
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01002151/****************************************************************/
Gilles Peskine20035e32018-02-03 22:44:14 +01002152/* Message digests */
2153/****************************************************************/
2154
Gilles Peskine449bd832023-01-11 14:50:10 +01002155psa_status_t psa_hash_abort(psa_hash_operation_t *operation)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002156{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002157 /* Aborting a non-active operation is allowed */
Gilles Peskine449bd832023-01-11 14:50:10 +01002158 if (operation->id == 0) {
2159 return PSA_SUCCESS;
2160 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002161
Gilles Peskine449bd832023-01-11 14:50:10 +01002162 psa_status_t status = psa_driver_wrapper_hash_abort(operation);
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002163 operation->id = 0;
2164
Gilles Peskine449bd832023-01-11 14:50:10 +01002165 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002166}
2167
Gilles Peskine449bd832023-01-11 14:50:10 +01002168psa_status_t psa_hash_setup(psa_hash_operation_t *operation,
2169 psa_algorithm_t alg)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002170{
Dave Rodgman685b6a72021-06-24 11:49:14 +01002171 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002172
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002173 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002174 if (operation->id != 0) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002175 status = PSA_ERROR_BAD_STATE;
2176 goto exit;
2177 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002178
Gilles Peskine449bd832023-01-11 14:50:10 +01002179 if (!PSA_ALG_IS_HASH(alg)) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002180 status = PSA_ERROR_INVALID_ARGUMENT;
2181 goto exit;
2182 }
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002183
Steven Cooremanb6bf4bb2021-03-15 19:00:14 +01002184 /* Ensure all of the context is zeroized, since PSA_HASH_OPERATION_INIT only
2185 * directly zeroes the int-sized dummy member of the context union. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002186 memset(&operation->ctx, 0, sizeof(operation->ctx));
Steven Cooreman893232f2021-03-15 12:23:37 +01002187
Gilles Peskine449bd832023-01-11 14:50:10 +01002188 status = psa_driver_wrapper_hash_setup(operation, alg);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002189
2190exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002191 if (status != PSA_SUCCESS) {
2192 psa_hash_abort(operation);
2193 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002194
2195 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002196}
2197
Gilles Peskine449bd832023-01-11 14:50:10 +01002198psa_status_t psa_hash_update(psa_hash_operation_t *operation,
2199 const uint8_t *input,
2200 size_t input_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002201{
Dave Rodgman685b6a72021-06-24 11:49:14 +01002202 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2203
Gilles Peskine449bd832023-01-11 14:50:10 +01002204 if (operation->id == 0) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002205 status = PSA_ERROR_BAD_STATE;
2206 goto exit;
2207 }
Gilles Peskine94e44542018-07-12 16:58:43 +02002208
Steven Cooremanc8288352021-03-04 14:02:19 +01002209 /* Don't require hash implementations to behave correctly on a
2210 * zero-length input, which may have an invalid pointer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002211 if (input_length == 0) {
2212 return PSA_SUCCESS;
2213 }
Steven Cooremanc8288352021-03-04 14:02:19 +01002214
Gilles Peskine449bd832023-01-11 14:50:10 +01002215 status = psa_driver_wrapper_hash_update(operation, input, input_length);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002216
2217exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002218 if (status != PSA_SUCCESS) {
2219 psa_hash_abort(operation);
2220 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002221
Gilles Peskine449bd832023-01-11 14:50:10 +01002222 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002223}
2224
Gilles Peskine449bd832023-01-11 14:50:10 +01002225psa_status_t psa_hash_finish(psa_hash_operation_t *operation,
2226 uint8_t *hash,
2227 size_t hash_size,
2228 size_t *hash_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002229{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002230 *hash_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002231 if (operation->id == 0) {
2232 return PSA_ERROR_BAD_STATE;
2233 }
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002234
Steven Cooreman1e582352021-02-18 17:24:37 +01002235 psa_status_t status = psa_driver_wrapper_hash_finish(
Gilles Peskine449bd832023-01-11 14:50:10 +01002236 operation, hash, hash_size, hash_length);
2237 psa_hash_abort(operation);
2238 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002239}
2240
Gilles Peskine449bd832023-01-11 14:50:10 +01002241psa_status_t psa_hash_verify(psa_hash_operation_t *operation,
2242 const uint8_t *hash,
2243 size_t hash_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002244{
Ronald Cron69a63422021-10-18 09:47:58 +02002245 uint8_t actual_hash[PSA_HASH_MAX_SIZE];
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002246 size_t actual_hash_length;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002247 psa_status_t status = psa_hash_finish(
Gilles Peskine449bd832023-01-11 14:50:10 +01002248 operation,
2249 actual_hash, sizeof(actual_hash),
2250 &actual_hash_length);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002251
Gilles Peskine449bd832023-01-11 14:50:10 +01002252 if (status != PSA_SUCCESS) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002253 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002254 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002255
Gilles Peskine449bd832023-01-11 14:50:10 +01002256 if (actual_hash_length != hash_length) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002257 status = PSA_ERROR_INVALID_SIGNATURE;
2258 goto exit;
2259 }
2260
Dave Rodgman78701152023-08-29 14:20:18 +01002261 if (mbedtls_ct_memcmp(hash, actual_hash, actual_hash_length) != 0) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002262 status = PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01002263 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002264
2265exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002266 mbedtls_platform_zeroize(actual_hash, sizeof(actual_hash));
2267 if (status != PSA_SUCCESS) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002268 psa_hash_abort(operation);
Gilles Peskine449bd832023-01-11 14:50:10 +01002269 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002270
Gilles Peskine449bd832023-01-11 14:50:10 +01002271 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002272}
2273
Gilles Peskine449bd832023-01-11 14:50:10 +01002274psa_status_t psa_hash_compute(psa_algorithm_t alg,
2275 const uint8_t *input, size_t input_length,
2276 uint8_t *hash, size_t hash_size,
2277 size_t *hash_length)
Gilles Peskine0a749c82019-11-28 19:33:58 +01002278{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002279 *hash_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002280 if (!PSA_ALG_IS_HASH(alg)) {
2281 return PSA_ERROR_INVALID_ARGUMENT;
2282 }
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002283
Gilles Peskine449bd832023-01-11 14:50:10 +01002284 return psa_driver_wrapper_hash_compute(alg, input, input_length,
2285 hash, hash_size, hash_length);
Gilles Peskine0a749c82019-11-28 19:33:58 +01002286}
2287
Gilles Peskine449bd832023-01-11 14:50:10 +01002288psa_status_t psa_hash_compare(psa_algorithm_t alg,
2289 const uint8_t *input, size_t input_length,
2290 const uint8_t *hash, size_t hash_length)
Gilles Peskine0a749c82019-11-28 19:33:58 +01002291{
Ronald Cron69a63422021-10-18 09:47:58 +02002292 uint8_t actual_hash[PSA_HASH_MAX_SIZE];
Steven Cooreman84d670d2021-02-18 16:22:53 +01002293 size_t actual_hash_length;
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002294
Gilles Peskine449bd832023-01-11 14:50:10 +01002295 if (!PSA_ALG_IS_HASH(alg)) {
2296 return PSA_ERROR_INVALID_ARGUMENT;
2297 }
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002298
Steven Cooreman1e582352021-02-18 17:24:37 +01002299 psa_status_t status = psa_driver_wrapper_hash_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01002300 alg, input, input_length,
2301 actual_hash, sizeof(actual_hash),
2302 &actual_hash_length);
2303 if (status != PSA_SUCCESS) {
Gilles Peskine60aebec2021-12-13 12:33:18 +01002304 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002305 }
2306 if (actual_hash_length != hash_length) {
Gilles Peskine60aebec2021-12-13 12:33:18 +01002307 status = PSA_ERROR_INVALID_SIGNATURE;
2308 goto exit;
2309 }
Dave Rodgman78701152023-08-29 14:20:18 +01002310 if (mbedtls_ct_memcmp(hash, actual_hash, actual_hash_length) != 0) {
Gilles Peskine60aebec2021-12-13 12:33:18 +01002311 status = PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01002312 }
Gilles Peskine60aebec2021-12-13 12:33:18 +01002313
2314exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002315 mbedtls_platform_zeroize(actual_hash, sizeof(actual_hash));
2316 return status;
Gilles Peskine0a749c82019-11-28 19:33:58 +01002317}
2318
Gilles Peskine449bd832023-01-11 14:50:10 +01002319psa_status_t psa_hash_clone(const psa_hash_operation_t *source_operation,
2320 psa_hash_operation_t *target_operation)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002321{
Gilles Peskine449bd832023-01-11 14:50:10 +01002322 if (source_operation->id == 0 ||
2323 target_operation->id != 0) {
2324 return PSA_ERROR_BAD_STATE;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002325 }
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002326
Gilles Peskine449bd832023-01-11 14:50:10 +01002327 psa_status_t status = psa_driver_wrapper_hash_clone(source_operation,
2328 target_operation);
2329 if (status != PSA_SUCCESS) {
2330 psa_hash_abort(target_operation);
2331 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002332
Gilles Peskine449bd832023-01-11 14:50:10 +01002333 return status;
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002334}
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002335
2336
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002337/****************************************************************/
Gilles Peskine8c9def32018-02-08 10:02:12 +01002338/* MAC */
2339/****************************************************************/
2340
Gilles Peskine449bd832023-01-11 14:50:10 +01002341psa_status_t psa_mac_abort(psa_mac_operation_t *operation)
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002342{
Steven Cooremane6804192021-03-19 18:28:56 +01002343 /* Aborting a non-active operation is allowed */
Gilles Peskine449bd832023-01-11 14:50:10 +01002344 if (operation->id == 0) {
2345 return PSA_SUCCESS;
2346 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002347
Gilles Peskine449bd832023-01-11 14:50:10 +01002348 psa_status_t status = psa_driver_wrapper_mac_abort(operation);
Steven Cooreman72f736a2021-05-07 14:14:37 +02002349 operation->mac_size = 0;
2350 operation->is_sign = 0;
Steven Cooremane6804192021-03-19 18:28:56 +01002351 operation->id = 0;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002352
Gilles Peskine449bd832023-01-11 14:50:10 +01002353 return status;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002354}
2355
Ronald Cron2dff3b22021-06-17 16:33:22 +02002356static psa_status_t psa_mac_finalize_alg_and_key_validation(
2357 psa_algorithm_t alg,
Ronald Cron79bdd822021-06-17 16:46:44 +02002358 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01002359 uint8_t *mac_size)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002360{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002361 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002362 psa_key_type_t key_type = psa_get_key_type(attributes);
2363 size_t key_bits = psa_get_key_bits(attributes);
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002364
Gilles Peskine449bd832023-01-11 14:50:10 +01002365 if (!PSA_ALG_IS_MAC(alg)) {
2366 return PSA_ERROR_INVALID_ARGUMENT;
2367 }
Steven Cooremane6804192021-03-19 18:28:56 +01002368
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002369 /* Validate the combination of key type and algorithm */
Gilles Peskine449bd832023-01-11 14:50:10 +01002370 status = psa_mac_key_can_do(alg, key_type);
2371 if (status != PSA_SUCCESS) {
2372 return status;
2373 }
Steven Cooreman15472f82021-03-02 16:16:22 +01002374
Steven Cooremand1a68f12021-05-10 11:13:41 +02002375 /* Get the output length for the algorithm and key combination */
Gilles Peskine449bd832023-01-11 14:50:10 +01002376 *mac_size = PSA_MAC_LENGTH(key_type, key_bits, alg);
Steven Cooreman15472f82021-03-02 16:16:22 +01002377
Gilles Peskine449bd832023-01-11 14:50:10 +01002378 if (*mac_size < 4) {
Steven Cooreman15472f82021-03-02 16:16:22 +01002379 /* A very short MAC is too short for security since it can be
2380 * brute-forced. Ancient protocols with 32-bit MACs do exist,
2381 * so we make this our minimum, even though 32 bits is still
2382 * too small for security. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002383 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman15472f82021-03-02 16:16:22 +01002384 }
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02002385
Gilles Peskine449bd832023-01-11 14:50:10 +01002386 if (*mac_size > PSA_MAC_LENGTH(key_type, key_bits,
2387 PSA_ALG_FULL_LENGTH_MAC(alg))) {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002388 /* It's impossible to "truncate" to a larger length than the full length
2389 * of the algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002390 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002391 }
2392
Gilles Peskine449bd832023-01-11 14:50:10 +01002393 if (*mac_size > PSA_MAC_MAX_SIZE) {
Gilles Peskinea9b6c802022-03-16 13:54:49 +01002394 /* PSA_MAC_LENGTH returns the correct length even for a MAC algorithm
2395 * that is disabled in the compile-time configuration. The result can
2396 * therefore be larger than PSA_MAC_MAX_SIZE, which does take the
2397 * configuration into account. In this case, force a return of
2398 * PSA_ERROR_NOT_SUPPORTED here. Otherwise psa_mac_verify(), or
2399 * psa_mac_compute(mac_size=PSA_MAC_MAX_SIZE), would return
2400 * PSA_ERROR_BUFFER_TOO_SMALL for an unsupported algorithm whose MAC size
2401 * is larger than PSA_MAC_MAX_SIZE, which is misleading and which breaks
2402 * systematically generated tests. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002403 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea9b6c802022-03-16 13:54:49 +01002404 }
2405
Gilles Peskine449bd832023-01-11 14:50:10 +01002406 return PSA_SUCCESS;
Ronald Cron2dff3b22021-06-17 16:33:22 +02002407}
2408
Gilles Peskine449bd832023-01-11 14:50:10 +01002409static psa_status_t psa_mac_setup(psa_mac_operation_t *operation,
2410 mbedtls_svc_key_id_t key,
2411 psa_algorithm_t alg,
2412 int is_sign)
Gilles Peskinee59236f2018-01-27 23:32:46 +01002413{
2414 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2415 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman54648242021-06-24 11:49:45 +01002416 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002417 psa_key_attributes_t attributes;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002418
2419 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002420 if (operation->id != 0) {
Dave Rodgman54648242021-06-24 11:49:45 +01002421 status = PSA_ERROR_BAD_STATE;
2422 goto exit;
2423 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002424
2425 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002426 key,
2427 &slot,
2428 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
2429 alg);
2430 if (status != PSA_SUCCESS) {
Dave Rodgman54648242021-06-24 11:49:45 +01002431 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002432 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002433
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002434 attributes = (psa_key_attributes_t) {
Gilles Peskine8c9def32018-02-08 10:02:12 +01002435 .core = slot->attr
2436 };
2437
Gilles Peskine449bd832023-01-11 14:50:10 +01002438 status = psa_mac_finalize_alg_and_key_validation(alg, &attributes,
2439 &operation->mac_size);
2440 if (status != PSA_SUCCESS) {
Gilles Peskine8c9def32018-02-08 10:02:12 +01002441 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002442 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002443
2444 operation->is_sign = is_sign;
Steven Cooremane6804192021-03-19 18:28:56 +01002445 /* Dispatch the MAC setup call with validated input */
Gilles Peskine449bd832023-01-11 14:50:10 +01002446 if (is_sign) {
2447 status = psa_driver_wrapper_mac_sign_setup(operation,
2448 &attributes,
2449 slot->key.data,
2450 slot->key.bytes,
2451 alg);
2452 } else {
2453 status = psa_driver_wrapper_mac_verify_setup(operation,
2454 &attributes,
2455 slot->key.data,
2456 slot->key.bytes,
2457 alg);
Gilles Peskine8c9def32018-02-08 10:02:12 +01002458 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002459
Gilles Peskinefbfac682018-07-08 20:51:54 +02002460exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002461 if (status != PSA_SUCCESS) {
2462 psa_mac_abort(operation);
2463 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002464
Ryan Everett1b70a072024-01-04 10:32:49 +00002465 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02002466
Gilles Peskine449bd832023-01-11 14:50:10 +01002467 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002468}
2469
Gilles Peskine449bd832023-01-11 14:50:10 +01002470psa_status_t psa_mac_sign_setup(psa_mac_operation_t *operation,
2471 mbedtls_svc_key_id_t key,
2472 psa_algorithm_t alg)
Gilles Peskine89167cb2018-07-08 20:12:23 +02002473{
Gilles Peskine449bd832023-01-11 14:50:10 +01002474 return psa_mac_setup(operation, key, alg, 1);
Gilles Peskine89167cb2018-07-08 20:12:23 +02002475}
2476
Gilles Peskine449bd832023-01-11 14:50:10 +01002477psa_status_t psa_mac_verify_setup(psa_mac_operation_t *operation,
2478 mbedtls_svc_key_id_t key,
2479 psa_algorithm_t alg)
Gilles Peskine89167cb2018-07-08 20:12:23 +02002480{
Gilles Peskine449bd832023-01-11 14:50:10 +01002481 return psa_mac_setup(operation, key, alg, 0);
Gilles Peskine89167cb2018-07-08 20:12:23 +02002482}
2483
Gilles Peskine449bd832023-01-11 14:50:10 +01002484psa_status_t psa_mac_update(psa_mac_operation_t *operation,
2485 const uint8_t *input,
2486 size_t input_length)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002487{
Gilles Peskine449bd832023-01-11 14:50:10 +01002488 if (operation->id == 0) {
2489 return PSA_ERROR_BAD_STATE;
2490 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002491
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002492 /* Don't require hash implementations to behave correctly on a
2493 * zero-length input, which may have an invalid pointer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002494 if (input_length == 0) {
2495 return PSA_SUCCESS;
2496 }
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03002497
Gilles Peskine449bd832023-01-11 14:50:10 +01002498 psa_status_t status = psa_driver_wrapper_mac_update(operation,
2499 input, input_length);
2500 if (status != PSA_SUCCESS) {
2501 psa_mac_abort(operation);
2502 }
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002503
Gilles Peskine449bd832023-01-11 14:50:10 +01002504 return status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002505}
2506
Gilles Peskine449bd832023-01-11 14:50:10 +01002507psa_status_t psa_mac_sign_finish(psa_mac_operation_t *operation,
2508 uint8_t *mac,
2509 size_t mac_size,
2510 size_t *mac_length)
mohammad16036df908f2018-04-02 08:34:15 -07002511{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002512 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2513 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002514
Gilles Peskine449bd832023-01-11 14:50:10 +01002515 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002516 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002517 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002518 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002519
Gilles Peskine449bd832023-01-11 14:50:10 +01002520 if (!operation->is_sign) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002521 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002522 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002523 }
Steven Cooreman72f736a2021-05-07 14:14:37 +02002524
Steven Cooreman8af5c5c2021-05-11 11:09:13 +02002525 /* Sanity check. This will guarantee that mac_size != 0 (and so mac != NULL)
2526 * once all the error checks are done. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002527 if (operation->mac_size == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002528 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002529 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002530 }
Steven Cooreman8af5c5c2021-05-11 11:09:13 +02002531
Gilles Peskine449bd832023-01-11 14:50:10 +01002532 if (mac_size < operation->mac_size) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002533 status = PSA_ERROR_BUFFER_TOO_SMALL;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002534 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002535 }
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002536
Gilles Peskine449bd832023-01-11 14:50:10 +01002537 status = psa_driver_wrapper_mac_sign_finish(operation,
2538 mac, operation->mac_size,
2539 mac_length);
Steven Cooreman72f736a2021-05-07 14:14:37 +02002540
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002541exit:
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002542 /* In case of success, set the potential excess room in the output buffer
2543 * to an invalid value, to avoid potentially leaking a longer MAC.
2544 * In case of error, set the output length and content to a safe default,
2545 * such that in case the caller misses an error check, the output would be
2546 * an unachievable MAC.
2547 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002548 if (status != PSA_SUCCESS) {
Steven Cooreman72f736a2021-05-07 14:14:37 +02002549 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002550 operation->mac_size = 0;
Steven Cooreman72f736a2021-05-07 14:14:37 +02002551 }
mohammad16036df908f2018-04-02 08:34:15 -07002552
Paul Elliottdc42ca82023-02-24 18:11:59 +00002553 psa_wipe_tag_output_buffer(mac, status, mac_size, *mac_length);
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002554
Gilles Peskine449bd832023-01-11 14:50:10 +01002555 abort_status = psa_mac_abort(operation);
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002556
Gilles Peskine449bd832023-01-11 14:50:10 +01002557 return status == PSA_SUCCESS ? abort_status : status;
mohammad16036df908f2018-04-02 08:34:15 -07002558}
2559
Gilles Peskine449bd832023-01-11 14:50:10 +01002560psa_status_t psa_mac_verify_finish(psa_mac_operation_t *operation,
2561 const uint8_t *mac,
2562 size_t mac_length)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002563{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002564 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2565 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002566
Gilles Peskine449bd832023-01-11 14:50:10 +01002567 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002568 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002569 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002570 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002571
Gilles Peskine449bd832023-01-11 14:50:10 +01002572 if (operation->is_sign) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002573 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002574 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002575 }
Steven Cooreman72f736a2021-05-07 14:14:37 +02002576
Gilles Peskine449bd832023-01-11 14:50:10 +01002577 if (operation->mac_size != mac_length) {
Steven Cooreman72f736a2021-05-07 14:14:37 +02002578 status = PSA_ERROR_INVALID_SIGNATURE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002579 goto exit;
Steven Cooreman72f736a2021-05-07 14:14:37 +02002580 }
2581
Gilles Peskine449bd832023-01-11 14:50:10 +01002582 status = psa_driver_wrapper_mac_verify_finish(operation,
2583 mac, mac_length);
Steven Cooreman72f736a2021-05-07 14:14:37 +02002584
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002585exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002586 abort_status = psa_mac_abort(operation);
mohammad16036df908f2018-04-02 08:34:15 -07002587
Gilles Peskine449bd832023-01-11 14:50:10 +01002588 return status == PSA_SUCCESS ? abort_status : status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002589}
2590
Gilles Peskine449bd832023-01-11 14:50:10 +01002591static psa_status_t psa_mac_compute_internal(mbedtls_svc_key_id_t key,
2592 psa_algorithm_t alg,
2593 const uint8_t *input,
2594 size_t input_length,
2595 uint8_t *mac,
2596 size_t mac_size,
2597 size_t *mac_length,
2598 int is_sign)
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002599{
2600 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron51131b52021-06-17 17:17:20 +02002601 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2602 psa_key_slot_t *slot;
2603 uint8_t operation_mac_size = 0;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002604 psa_key_attributes_t attributes;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002605
Ronald Cron51131b52021-06-17 17:17:20 +02002606 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002607 key,
2608 &slot,
2609 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
2610 alg);
2611 if (status != PSA_SUCCESS) {
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002612 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002613 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002614
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002615 attributes = (psa_key_attributes_t) {
Ronald Cron51131b52021-06-17 17:17:20 +02002616 .core = slot->attr
2617 };
2618
Gilles Peskine449bd832023-01-11 14:50:10 +01002619 status = psa_mac_finalize_alg_and_key_validation(alg, &attributes,
2620 &operation_mac_size);
2621 if (status != PSA_SUCCESS) {
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002622 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002623 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002624
Gilles Peskine449bd832023-01-11 14:50:10 +01002625 if (mac_size < operation_mac_size) {
Ronald Cron51131b52021-06-17 17:17:20 +02002626 status = PSA_ERROR_BUFFER_TOO_SMALL;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002627 goto exit;
Ronald Cron51131b52021-06-17 17:17:20 +02002628 }
2629
2630 status = psa_driver_wrapper_mac_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01002631 &attributes,
2632 slot->key.data, slot->key.bytes,
2633 alg,
2634 input, input_length,
2635 mac, operation_mac_size, mac_length);
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002636
2637exit:
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002638 /* In case of success, set the potential excess room in the output buffer
2639 * to an invalid value, to avoid potentially leaking a longer MAC.
2640 * In case of error, set the output length and content to a safe default,
2641 * such that in case the caller misses an error check, the output would be
2642 * an unachievable MAC.
2643 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002644 if (status != PSA_SUCCESS) {
Ronald Cron51131b52021-06-17 17:17:20 +02002645 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002646 operation_mac_size = 0;
Ronald Cron51131b52021-06-17 17:17:20 +02002647 }
Paul Elliottdc42ca82023-02-24 18:11:59 +00002648
2649 psa_wipe_tag_output_buffer(mac, status, mac_size, *mac_length);
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002650
Ryan Everett1b70a072024-01-04 10:32:49 +00002651 unlock_status = psa_unregister_read(slot);
Ronald Cron51131b52021-06-17 17:17:20 +02002652
Gilles Peskine449bd832023-01-11 14:50:10 +01002653 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002654}
2655
Gilles Peskine449bd832023-01-11 14:50:10 +01002656psa_status_t psa_mac_compute(mbedtls_svc_key_id_t key,
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002657 psa_algorithm_t alg,
2658 const uint8_t *input,
2659 size_t input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002660 uint8_t *mac,
2661 size_t mac_size,
2662 size_t *mac_length)
2663{
2664 return psa_mac_compute_internal(key, alg,
2665 input, input_length,
2666 mac, mac_size, mac_length, 1);
2667}
2668
2669psa_status_t psa_mac_verify(mbedtls_svc_key_id_t key,
2670 psa_algorithm_t alg,
2671 const uint8_t *input,
2672 size_t input_length,
2673 const uint8_t *mac,
2674 size_t mac_length)
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002675{
2676 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Crona587cbc2021-06-18 14:51:29 +02002677 uint8_t actual_mac[PSA_MAC_MAX_SIZE];
2678 size_t actual_mac_length;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002679
Gilles Peskine449bd832023-01-11 14:50:10 +01002680 status = psa_mac_compute_internal(key, alg,
2681 input, input_length,
2682 actual_mac, sizeof(actual_mac),
2683 &actual_mac_length, 0);
2684 if (status != PSA_SUCCESS) {
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002685 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002686 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002687
Gilles Peskine449bd832023-01-11 14:50:10 +01002688 if (mac_length != actual_mac_length) {
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 }
Dave Rodgman78701152023-08-29 14:20:18 +01002692 if (mbedtls_ct_memcmp(mac, actual_mac, actual_mac_length) != 0) {
Ronald Crona587cbc2021-06-18 14:51:29 +02002693 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002694 goto exit;
Ronald Crona587cbc2021-06-18 14:51:29 +02002695 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002696
2697exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002698 mbedtls_platform_zeroize(actual_mac, sizeof(actual_mac));
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002699
Gilles Peskine449bd832023-01-11 14:50:10 +01002700 return status;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002701}
Gilles Peskinee59236f2018-01-27 23:32:46 +01002702
Gilles Peskinee59236f2018-01-27 23:32:46 +01002703/****************************************************************/
2704/* Asymmetric cryptography */
2705/****************************************************************/
2706
Gilles Peskine449bd832023-01-11 14:50:10 +01002707static psa_status_t psa_sign_verify_check_alg(int input_is_message,
2708 psa_algorithm_t alg)
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002709{
Gilles Peskine449bd832023-01-11 14:50:10 +01002710 if (input_is_message) {
2711 if (!PSA_ALG_IS_SIGN_MESSAGE(alg)) {
2712 return PSA_ERROR_INVALID_ARGUMENT;
2713 }
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002714
Gilles Peskine449bd832023-01-11 14:50:10 +01002715 if (PSA_ALG_IS_SIGN_HASH(alg)) {
2716 if (!PSA_ALG_IS_HASH(PSA_ALG_SIGN_GET_HASH(alg))) {
2717 return PSA_ERROR_INVALID_ARGUMENT;
2718 }
2719 }
2720 } else {
2721 if (!PSA_ALG_IS_SIGN_HASH(alg)) {
2722 return PSA_ERROR_INVALID_ARGUMENT;
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002723 }
2724 }
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002725
Gilles Peskine449bd832023-01-11 14:50:10 +01002726 return PSA_SUCCESS;
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002727}
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002728
Gilles Peskine449bd832023-01-11 14:50:10 +01002729static psa_status_t psa_sign_internal(mbedtls_svc_key_id_t key,
2730 int input_is_message,
2731 psa_algorithm_t alg,
2732 const uint8_t *input,
2733 size_t input_length,
2734 uint8_t *signature,
2735 size_t signature_size,
2736 size_t *signature_length)
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002737{
2738 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2739 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2740 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002741 psa_key_attributes_t attributes;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002742
2743 *signature_length = 0;
2744
Gilles Peskine449bd832023-01-11 14:50:10 +01002745 status = psa_sign_verify_check_alg(input_is_message, alg);
2746 if (status != PSA_SUCCESS) {
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002747 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002748 }
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002749
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002750 /* Immediately reject a zero-length signature buffer. This guarantees
gabor-mezei-arm12b4f342021-05-05 13:54:55 +02002751 * that signature must be a valid pointer. (On the other hand, the input
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002752 * buffer can in principle be empty since it doesn't actually have
2753 * to be a hash.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01002754 if (signature_size == 0) {
2755 return PSA_ERROR_BUFFER_TOO_SMALL;
2756 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002757
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002758 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002759 key, &slot,
2760 input_is_message ? PSA_KEY_USAGE_SIGN_MESSAGE :
2761 PSA_KEY_USAGE_SIGN_HASH,
2762 alg);
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002763
Gilles Peskine449bd832023-01-11 14:50:10 +01002764 if (status != PSA_SUCCESS) {
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002765 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002766 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002767
Gilles Peskine449bd832023-01-11 14:50:10 +01002768 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002769 status = PSA_ERROR_INVALID_ARGUMENT;
2770 goto exit;
2771 }
2772
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002773 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01002774 .core = slot->attr
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002775 };
2776
Gilles Peskine449bd832023-01-11 14:50:10 +01002777 if (input_is_message) {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002778 status = psa_driver_wrapper_sign_message(
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002779 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002780 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002781 signature, signature_size, signature_length);
2782 } else {
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002783
2784 status = psa_driver_wrapper_sign_hash(
2785 &attributes, slot->key.data, slot->key.bytes,
2786 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002787 signature, signature_size, signature_length);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002788 }
2789
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002790
2791exit:
Paul Elliott59200a22023-02-21 15:07:40 +00002792 psa_wipe_tag_output_buffer(signature, status, signature_size,
2793 *signature_length);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002794
Ryan Everett1b70a072024-01-04 10:32:49 +00002795 unlock_status = psa_unregister_read(slot);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002796
Gilles Peskine449bd832023-01-11 14:50:10 +01002797 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002798}
2799
Gilles Peskine449bd832023-01-11 14:50:10 +01002800static psa_status_t psa_verify_internal(mbedtls_svc_key_id_t key,
2801 int input_is_message,
2802 psa_algorithm_t alg,
2803 const uint8_t *input,
2804 size_t input_length,
2805 const uint8_t *signature,
2806 size_t signature_length)
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002807{
2808 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2809 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2810 psa_key_slot_t *slot;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002811
Gilles Peskine449bd832023-01-11 14:50:10 +01002812 status = psa_sign_verify_check_alg(input_is_message, alg);
2813 if (status != PSA_SUCCESS) {
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002814 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002815 }
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002816
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002817 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002818 key, &slot,
2819 input_is_message ? PSA_KEY_USAGE_VERIFY_MESSAGE :
2820 PSA_KEY_USAGE_VERIFY_HASH,
2821 alg);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002822
Gilles Peskine449bd832023-01-11 14:50:10 +01002823 if (status != PSA_SUCCESS) {
2824 return status;
2825 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002826
2827 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01002828 .core = slot->attr
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002829 };
2830
Gilles Peskine449bd832023-01-11 14:50:10 +01002831 if (input_is_message) {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002832 status = psa_driver_wrapper_verify_message(
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002833 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002834 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002835 signature, signature_length);
2836 } else {
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002837 status = psa_driver_wrapper_verify_hash(
2838 &attributes, slot->key.data, slot->key.bytes,
2839 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002840 signature, signature_length);
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002841 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002842
Ryan Everett1b70a072024-01-04 10:32:49 +00002843 unlock_status = psa_unregister_read(slot);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002844
Gilles Peskine449bd832023-01-11 14:50:10 +01002845 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002846
2847}
2848
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002849psa_status_t psa_sign_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002850 const psa_key_attributes_t *attributes,
2851 const uint8_t *key_buffer,
2852 size_t key_buffer_size,
2853 psa_algorithm_t alg,
2854 const uint8_t *input,
2855 size_t input_length,
2856 uint8_t *signature,
2857 size_t signature_size,
Gilles Peskine449bd832023-01-11 14:50:10 +01002858 size_t *signature_length)
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002859{
2860 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002861
Gilles Peskine449bd832023-01-11 14:50:10 +01002862 if (PSA_ALG_IS_SIGN_HASH(alg)) {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002863 size_t hash_length;
2864 uint8_t hash[PSA_HASH_MAX_SIZE];
2865
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002866 status = psa_driver_wrapper_hash_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01002867 PSA_ALG_SIGN_GET_HASH(alg),
2868 input, input_length,
2869 hash, sizeof(hash), &hash_length);
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002870
Gilles Peskine449bd832023-01-11 14:50:10 +01002871 if (status != PSA_SUCCESS) {
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002872 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002873 }
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002874
2875 return psa_driver_wrapper_sign_hash(
Gilles Peskine449bd832023-01-11 14:50:10 +01002876 attributes, key_buffer, key_buffer_size,
2877 alg, hash, hash_length,
2878 signature, signature_size, signature_length);
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002879 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002880
Gilles Peskine449bd832023-01-11 14:50:10 +01002881 return PSA_ERROR_NOT_SUPPORTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002882}
2883
Gilles Peskine449bd832023-01-11 14:50:10 +01002884psa_status_t psa_sign_message(mbedtls_svc_key_id_t key,
2885 psa_algorithm_t alg,
2886 const uint8_t *input,
2887 size_t input_length,
2888 uint8_t *signature,
2889 size_t signature_size,
2890 size_t *signature_length)
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002891{
2892 return psa_sign_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002893 key, 1, alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002894 signature, signature_size, signature_length);
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002895}
2896
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002897psa_status_t psa_verify_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002898 const psa_key_attributes_t *attributes,
2899 const uint8_t *key_buffer,
2900 size_t key_buffer_size,
2901 psa_algorithm_t alg,
2902 const uint8_t *input,
2903 size_t input_length,
2904 const uint8_t *signature,
Gilles Peskine449bd832023-01-11 14:50:10 +01002905 size_t signature_length)
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002906{
2907 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002908
Gilles Peskine449bd832023-01-11 14:50:10 +01002909 if (PSA_ALG_IS_SIGN_HASH(alg)) {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002910 size_t hash_length;
2911 uint8_t hash[PSA_HASH_MAX_SIZE];
2912
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002913 status = psa_driver_wrapper_hash_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01002914 PSA_ALG_SIGN_GET_HASH(alg),
2915 input, input_length,
2916 hash, sizeof(hash), &hash_length);
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002917
Gilles Peskine449bd832023-01-11 14:50:10 +01002918 if (status != PSA_SUCCESS) {
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002919 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002920 }
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002921
2922 return psa_driver_wrapper_verify_hash(
Gilles Peskine449bd832023-01-11 14:50:10 +01002923 attributes, key_buffer, key_buffer_size,
2924 alg, hash, hash_length,
2925 signature, signature_length);
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002926 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002927
Gilles Peskine449bd832023-01-11 14:50:10 +01002928 return PSA_ERROR_NOT_SUPPORTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002929}
2930
Gilles Peskine449bd832023-01-11 14:50:10 +01002931psa_status_t psa_verify_message(mbedtls_svc_key_id_t key,
2932 psa_algorithm_t alg,
2933 const uint8_t *input,
2934 size_t input_length,
2935 const uint8_t *signature,
2936 size_t signature_length)
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002937{
2938 return psa_verify_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002939 key, 1, alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002940 signature, signature_length);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002941}
2942
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002943psa_status_t psa_sign_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01002944 const psa_key_attributes_t *attributes,
2945 const uint8_t *key_buffer, size_t key_buffer_size,
2946 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002947 uint8_t *signature, size_t signature_size, size_t *signature_length)
Gilles Peskinee59236f2018-01-27 23:32:46 +01002948{
Gilles Peskine449bd832023-01-11 14:50:10 +01002949 if (attributes->core.type == PSA_KEY_TYPE_RSA_KEY_PAIR) {
2950 if (PSA_ALG_IS_RSA_PKCS1V15_SIGN(alg) ||
2951 PSA_ALG_IS_RSA_PSS(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01002952#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01002953 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
2954 return mbedtls_psa_rsa_sign_hash(
2955 attributes,
2956 key_buffer, key_buffer_size,
2957 alg, hash, hash_length,
2958 signature, signature_size, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01002959#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
2960 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine449bd832023-01-11 14:50:10 +01002961 } else {
2962 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanacda8342020-07-24 23:09:52 +02002963 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002964 } else if (PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
2965 if (PSA_ALG_IS_ECDSA(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01002966#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01002967 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
2968 return mbedtls_psa_ecdsa_sign_hash(
2969 attributes,
2970 key_buffer, key_buffer_size,
2971 alg, hash, hash_length,
2972 signature, signature_size, signature_length);
Gilles Peskinee59236f2018-01-27 23:32:46 +01002973#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
2974 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskine449bd832023-01-11 14:50:10 +01002975 } else {
2976 return PSA_ERROR_INVALID_ARGUMENT;
Ronald Cron4501c982021-03-19 20:09:32 +01002977 }
Ronald Cron8a494f32021-02-17 09:49:51 +01002978 }
Ronald Cron4501c982021-03-19 20:09:32 +01002979
Gilles Peskine449bd832023-01-11 14:50:10 +01002980 (void) key_buffer;
2981 (void) key_buffer_size;
2982 (void) hash;
2983 (void) hash_length;
2984 (void) signature;
2985 (void) signature_size;
2986 (void) signature_length;
Ronald Cron4501c982021-03-19 20:09:32 +01002987
Gilles Peskine449bd832023-01-11 14:50:10 +01002988 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron18659932020-12-08 16:32:23 +01002989}
Gilles Peskinee59236f2018-01-27 23:32:46 +01002990
Gilles Peskine449bd832023-01-11 14:50:10 +01002991psa_status_t psa_sign_hash(mbedtls_svc_key_id_t key,
2992 psa_algorithm_t alg,
2993 const uint8_t *hash,
2994 size_t hash_length,
2995 uint8_t *signature,
2996 size_t signature_size,
2997 size_t *signature_length)
Gilles Peskinee59236f2018-01-27 23:32:46 +01002998{
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002999 return psa_sign_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02003000 key, 0, alg, hash, hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003001 signature, signature_size, signature_length);
itayzafrir5c753392018-05-08 11:18:38 +03003002}
3003
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02003004psa_status_t psa_verify_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01003005 const psa_key_attributes_t *attributes,
3006 const uint8_t *key_buffer, size_t key_buffer_size,
3007 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003008 const uint8_t *signature, size_t signature_length)
itayzafrir5c753392018-05-08 11:18:38 +03003009{
Gilles Peskine449bd832023-01-11 14:50:10 +01003010 if (PSA_KEY_TYPE_IS_RSA(attributes->core.type)) {
3011 if (PSA_ALG_IS_RSA_PKCS1V15_SIGN(alg) ||
3012 PSA_ALG_IS_RSA_PSS(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003013#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003014 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
3015 return mbedtls_psa_rsa_verify_hash(
3016 attributes,
3017 key_buffer, key_buffer_size,
3018 alg, hash, hash_length,
3019 signature, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01003020#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
3021 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003022 } else {
3023 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanacda8342020-07-24 23:09:52 +02003024 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003025 } else if (PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3026 if (PSA_ALG_IS_ECDSA(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003027#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003028 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3029 return mbedtls_psa_ecdsa_verify_hash(
3030 attributes,
3031 key_buffer, key_buffer_size,
3032 alg, hash, hash_length,
3033 signature, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01003034#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3035 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003036 } else {
3037 return PSA_ERROR_INVALID_ARGUMENT;
Ronald Cron4501c982021-03-19 20:09:32 +01003038 }
Ronald Cron8a494f32021-02-17 09:49:51 +01003039 }
Ronald Cron4501c982021-03-19 20:09:32 +01003040
Gilles Peskine449bd832023-01-11 14:50:10 +01003041 (void) key_buffer;
3042 (void) key_buffer_size;
3043 (void) hash;
3044 (void) hash_length;
3045 (void) signature;
3046 (void) signature_length;
Ronald Cron4501c982021-03-19 20:09:32 +01003047
Gilles Peskine449bd832023-01-11 14:50:10 +01003048 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron18659932020-12-08 16:32:23 +01003049}
3050
Gilles Peskine449bd832023-01-11 14:50:10 +01003051psa_status_t psa_verify_hash(mbedtls_svc_key_id_t key,
3052 psa_algorithm_t alg,
3053 const uint8_t *hash,
3054 size_t hash_length,
3055 const uint8_t *signature,
3056 size_t signature_length)
itayzafrir5c753392018-05-08 11:18:38 +03003057{
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003058 return psa_verify_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02003059 key, 0, alg, hash, hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003060 signature, signature_length);
Gilles Peskinee59236f2018-01-27 23:32:46 +01003061}
3062
Gilles Peskine449bd832023-01-11 14:50:10 +01003063psa_status_t psa_asymmetric_encrypt(mbedtls_svc_key_id_t key,
3064 psa_algorithm_t alg,
3065 const uint8_t *input,
3066 size_t input_length,
3067 const uint8_t *salt,
3068 size_t salt_length,
3069 uint8_t *output,
3070 size_t output_size,
3071 size_t *output_length)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003072{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003073 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003074 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003075 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003076 psa_key_attributes_t attributes;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003077
Darryl Green5cc689a2018-07-24 15:34:10 +01003078 (void) input;
3079 (void) input_length;
3080 (void) salt;
3081 (void) output;
3082 (void) output_size;
3083
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003084 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003085
Gilles Peskine449bd832023-01-11 14:50:10 +01003086 if (!PSA_ALG_IS_RSA_OAEP(alg) && salt_length != 0) {
3087 return PSA_ERROR_INVALID_ARGUMENT;
3088 }
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003089
Ronald Cron5c522922020-11-14 16:35:34 +01003090 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01003091 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg);
3092 if (status != PSA_SUCCESS) {
3093 return status;
3094 }
3095 if (!(PSA_KEY_TYPE_IS_PUBLIC_KEY(slot->attr.type) ||
3096 PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type))) {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003097 status = PSA_ERROR_INVALID_ARGUMENT;
3098 goto exit;
3099 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003100
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003101 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01003102 .core = slot->attr
Przemyslaw Stekiel19e61422021-12-09 11:09:11 +01003103 };
Steven Cooremana2371e52020-07-28 14:30:39 +02003104
Przemyslaw Stekiel19e61422021-12-09 11:09:11 +01003105 status = psa_driver_wrapper_asymmetric_encrypt(
3106 &attributes, slot->key.data, slot->key.bytes,
3107 alg, input, input_length, salt, salt_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003108 output, output_size, output_length);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003109exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00003110 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003111
Gilles Peskine449bd832023-01-11 14:50:10 +01003112 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003113}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003114
Gilles Peskine449bd832023-01-11 14:50:10 +01003115psa_status_t psa_asymmetric_decrypt(mbedtls_svc_key_id_t key,
3116 psa_algorithm_t alg,
3117 const uint8_t *input,
3118 size_t input_length,
3119 const uint8_t *salt,
3120 size_t salt_length,
3121 uint8_t *output,
3122 size_t output_size,
3123 size_t *output_length)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003124{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003125 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003126 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003127 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003128 psa_key_attributes_t attributes;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003129
Darryl Green5cc689a2018-07-24 15:34:10 +01003130 (void) input;
3131 (void) input_length;
3132 (void) salt;
3133 (void) output;
3134 (void) output_size;
3135
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003136 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003137
Gilles Peskine449bd832023-01-11 14:50:10 +01003138 if (!PSA_ALG_IS_RSA_OAEP(alg) && salt_length != 0) {
3139 return PSA_ERROR_INVALID_ARGUMENT;
3140 }
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003141
Ronald Cron5c522922020-11-14 16:35:34 +01003142 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01003143 key, &slot, PSA_KEY_USAGE_DECRYPT, alg);
3144 if (status != PSA_SUCCESS) {
3145 return status;
3146 }
3147 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003148 status = PSA_ERROR_INVALID_ARGUMENT;
3149 goto exit;
3150 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003151
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003152 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01003153 .core = slot->attr
Przemyslaw Stekiel8d45c002021-12-13 08:58:19 +01003154 };
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003155
Przemyslaw Stekiel8d45c002021-12-13 08:58:19 +01003156 status = psa_driver_wrapper_asymmetric_decrypt(
3157 &attributes, slot->key.data, slot->key.bytes,
3158 alg, input, input_length, salt, salt_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003159 output, output_size, output_length);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003160
3161exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00003162 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003163
Gilles Peskine449bd832023-01-11 14:50:10 +01003164 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003165}
Gilles Peskinee59236f2018-01-27 23:32:46 +01003166
Paul Elliott9fe12f62022-11-30 19:16:02 +00003167/****************************************************************/
3168/* Asymmetric interruptible cryptography */
3169/****************************************************************/
3170
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003171static uint32_t psa_interruptible_max_ops = PSA_INTERRUPTIBLE_MAX_OPS_UNLIMITED;
3172
Paul Elliott9fe12f62022-11-30 19:16:02 +00003173void psa_interruptible_set_max_ops(uint32_t max_ops)
3174{
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003175 psa_interruptible_max_ops = max_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003176}
3177
3178uint32_t psa_interruptible_get_max_ops(void)
3179{
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003180 return psa_interruptible_max_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003181}
3182
Paul Elliott9fe12f62022-11-30 19:16:02 +00003183uint32_t psa_sign_hash_get_num_ops(
3184 const psa_sign_hash_interruptible_operation_t *operation)
3185{
Paul Elliott296ede92022-12-15 17:00:30 +00003186 return operation->num_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003187}
3188
3189uint32_t psa_verify_hash_get_num_ops(
3190 const psa_verify_hash_interruptible_operation_t *operation)
3191{
Paul Elliott296ede92022-12-15 17:00:30 +00003192 return operation->num_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003193}
3194
Paul Elliott59ad9452022-12-18 15:09:02 +00003195static psa_status_t psa_sign_hash_abort_internal(
3196 psa_sign_hash_interruptible_operation_t *operation)
3197{
3198 if (operation->id == 0) {
3199 /* The object has (apparently) been initialized but it is not (yet)
3200 * in use. It's ok to call abort on such an object, and there's
3201 * nothing to do. */
3202 return PSA_SUCCESS;
3203 }
3204
3205 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3206
3207 status = psa_driver_wrapper_sign_hash_abort(operation);
3208
3209 operation->id = 0;
3210
Paul Elliotte6145dc2023-02-07 12:51:21 +00003211 /* Do not clear either the error_occurred or num_ops elements here as they
3212 * only want to be cleared by the application calling abort, not by abort
3213 * being called at completion of an operation. */
3214
Paul Elliott59ad9452022-12-18 15:09:02 +00003215 return status;
3216}
3217
Paul Elliott9fe12f62022-11-30 19:16:02 +00003218psa_status_t psa_sign_hash_start(
3219 psa_sign_hash_interruptible_operation_t *operation,
3220 mbedtls_svc_key_id_t key, psa_algorithm_t alg,
3221 const uint8_t *hash, size_t hash_length)
3222{
3223 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3224 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3225 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003226 psa_key_attributes_t attributes;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003227
Paul Elliottc9774412023-02-06 15:14:07 +00003228 /* Check that start has not been previously called, or operation has not
3229 * previously errored. */
3230 if (operation->id != 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003231 return PSA_ERROR_BAD_STATE;
3232 }
3233
Paul Elliott9fe12f62022-11-30 19:16:02 +00003234 status = psa_sign_verify_check_alg(0, alg);
3235 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003236 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003237 return status;
3238 }
3239
3240 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
3241 PSA_KEY_USAGE_SIGN_HASH,
3242 alg);
3243
3244 if (status != PSA_SUCCESS) {
3245 goto exit;
3246 }
3247
3248 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
3249 status = PSA_ERROR_INVALID_ARGUMENT;
3250 goto exit;
3251 }
3252
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003253 attributes = (psa_key_attributes_t) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003254 .core = slot->attr
3255 };
3256
Paul Elliott296ede92022-12-15 17:00:30 +00003257 /* Ensure ops count gets reset, in case of operation re-use. */
3258 operation->num_ops = 0;
3259
Paul Elliott9fe12f62022-11-30 19:16:02 +00003260 status = psa_driver_wrapper_sign_hash_start(operation, &attributes,
3261 slot->key.data,
3262 slot->key.bytes, alg,
3263 hash, hash_length);
3264exit:
3265
3266 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003267 operation->error_occurred = 1;
Paul Elliott59ad9452022-12-18 15:09:02 +00003268 psa_sign_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003269 }
3270
Ryan Everett1b70a072024-01-04 10:32:49 +00003271 unlock_status = psa_unregister_read(slot);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003272
Paul Elliottc9774412023-02-06 15:14:07 +00003273 if (unlock_status != PSA_SUCCESS) {
3274 operation->error_occurred = 1;
3275 }
Paul Elliott9fe12f62022-11-30 19:16:02 +00003276
Paul Elliottc9774412023-02-06 15:14:07 +00003277 return (status == PSA_SUCCESS) ? unlock_status : status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003278}
3279
3280
3281psa_status_t psa_sign_hash_complete(
3282 psa_sign_hash_interruptible_operation_t *operation,
3283 uint8_t *signature, size_t signature_size,
3284 size_t *signature_length)
3285{
3286 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3287
3288 *signature_length = 0;
3289
Paul Elliottc9774412023-02-06 15:14:07 +00003290 /* Check that start has been called first, and that operation has not
3291 * previously errored. */
3292 if (operation->id == 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003293 status = PSA_ERROR_BAD_STATE;
3294 goto exit;
3295 }
3296
Paul Elliott096abc42023-02-03 18:33:23 +00003297 /* Immediately reject a zero-length signature buffer. This guarantees that
3298 * signature must be a valid pointer. */
Paul Elliott9fe12f62022-11-30 19:16:02 +00003299 if (signature_size == 0) {
3300 status = PSA_ERROR_BUFFER_TOO_SMALL;
3301 goto exit;
3302 }
3303
3304 status = psa_driver_wrapper_sign_hash_complete(operation, signature,
3305 signature_size,
3306 signature_length);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003307
Paul Elliott296ede92022-12-15 17:00:30 +00003308 /* Update ops count with work done. */
Paul Elliottde1114c2023-02-07 12:43:11 +00003309 operation->num_ops = psa_driver_wrapper_sign_hash_get_num_ops(operation);
Paul Elliott296ede92022-12-15 17:00:30 +00003310
Paul Elliottebe225c2023-02-10 14:32:53 +00003311exit:
3312
Paul Elliott59200a22023-02-21 15:07:40 +00003313 psa_wipe_tag_output_buffer(signature, status, signature_size,
3314 *signature_length);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003315
Paul Elliott53bb3122023-02-10 14:22:22 +00003316 if (status != PSA_OPERATION_INCOMPLETE) {
Paul Elliottc9774412023-02-06 15:14:07 +00003317 if (status != PSA_SUCCESS) {
3318 operation->error_occurred = 1;
3319 }
3320
Paul Elliott59ad9452022-12-18 15:09:02 +00003321 psa_sign_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003322 }
3323
3324 return status;
3325}
3326
3327psa_status_t psa_sign_hash_abort(
3328 psa_sign_hash_interruptible_operation_t *operation)
3329{
Paul Elliott59ad9452022-12-18 15:09:02 +00003330 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3331
3332 status = psa_sign_hash_abort_internal(operation);
3333
3334 /* We clear the number of ops done here, so that it is not cleared when
3335 * the operation fails or succeeds, only on manual abort. */
3336 operation->num_ops = 0;
3337
Paul Elliottc9774412023-02-06 15:14:07 +00003338 /* Likewise, failure state. */
3339 operation->error_occurred = 0;
3340
Paul Elliott59ad9452022-12-18 15:09:02 +00003341 return status;
3342}
3343
3344static psa_status_t psa_verify_hash_abort_internal(
3345 psa_verify_hash_interruptible_operation_t *operation)
3346{
Paul Elliott9fe12f62022-11-30 19:16:02 +00003347 if (operation->id == 0) {
3348 /* The object has (apparently) been initialized but it is not (yet)
3349 * in use. It's ok to call abort on such an object, and there's
3350 * nothing to do. */
3351 return PSA_SUCCESS;
3352 }
3353
Paul Elliott59ad9452022-12-18 15:09:02 +00003354 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3355
3356 status = psa_driver_wrapper_verify_hash_abort(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003357
3358 operation->id = 0;
3359
Paul Elliotte6145dc2023-02-07 12:51:21 +00003360 /* Do not clear either the error_occurred or num_ops elements here as they
3361 * only want to be cleared by the application calling abort, not by abort
3362 * being called at completion of an operation. */
3363
Paul Elliott59ad9452022-12-18 15:09:02 +00003364 return status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003365}
3366
3367psa_status_t psa_verify_hash_start(
3368 psa_verify_hash_interruptible_operation_t *operation,
3369 mbedtls_svc_key_id_t key, psa_algorithm_t alg,
3370 const uint8_t *hash, size_t hash_length,
3371 const uint8_t *signature, size_t signature_length)
3372{
3373 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3374 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3375 psa_key_slot_t *slot;
3376
Paul Elliottc9774412023-02-06 15:14:07 +00003377 /* Check that start has not been previously called, or operation has not
3378 * previously errored. */
3379 if (operation->id != 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003380 return PSA_ERROR_BAD_STATE;
3381 }
3382
3383 status = psa_sign_verify_check_alg(0, alg);
3384 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003385 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003386 return status;
3387 }
3388
3389 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
3390 PSA_KEY_USAGE_VERIFY_HASH,
3391 alg);
3392
3393 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003394 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003395 return status;
3396 }
3397
3398 psa_key_attributes_t attributes = {
3399 .core = slot->attr
3400 };
3401
Paul Elliott296ede92022-12-15 17:00:30 +00003402 /* Ensure ops count gets reset, in case of operation re-use. */
3403 operation->num_ops = 0;
3404
Paul Elliott9fe12f62022-11-30 19:16:02 +00003405 status = psa_driver_wrapper_verify_hash_start(operation, &attributes,
3406 slot->key.data,
3407 slot->key.bytes,
3408 alg, hash, hash_length,
3409 signature, signature_length);
3410
3411 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003412 operation->error_occurred = 1;
Paul Elliott59ad9452022-12-18 15:09:02 +00003413 psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003414 }
3415
Ryan Everett1b70a072024-01-04 10:32:49 +00003416 unlock_status = psa_unregister_read(slot);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003417
Paul Elliottc9774412023-02-06 15:14:07 +00003418 if (unlock_status != PSA_SUCCESS) {
3419 operation->error_occurred = 1;
3420 }
Paul Elliott9fe12f62022-11-30 19:16:02 +00003421
Paul Elliottc9774412023-02-06 15:14:07 +00003422 return (status == PSA_SUCCESS) ? unlock_status : status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003423}
3424
3425psa_status_t psa_verify_hash_complete(
3426 psa_verify_hash_interruptible_operation_t *operation)
3427{
3428 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3429
Paul Elliottc9774412023-02-06 15:14:07 +00003430 /* Check that start has been called first, and that operation has not
3431 * previously errored. */
3432 if (operation->id == 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003433 status = PSA_ERROR_BAD_STATE;
3434 goto exit;
3435 }
3436
3437 status = psa_driver_wrapper_verify_hash_complete(operation);
3438
Paul Elliott296ede92022-12-15 17:00:30 +00003439 /* Update ops count with work done. */
Paul Elliottde1114c2023-02-07 12:43:11 +00003440 operation->num_ops = psa_driver_wrapper_verify_hash_get_num_ops(
Paul Elliott296ede92022-12-15 17:00:30 +00003441 operation);
3442
Paul Elliottebe225c2023-02-10 14:32:53 +00003443exit:
3444
Paul Elliott9fe12f62022-11-30 19:16:02 +00003445 if (status != PSA_OPERATION_INCOMPLETE) {
Paul Elliottc9774412023-02-06 15:14:07 +00003446 if (status != PSA_SUCCESS) {
3447 operation->error_occurred = 1;
3448 }
3449
Paul Elliott59ad9452022-12-18 15:09:02 +00003450 psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003451 }
3452
3453 return status;
3454}
3455
3456psa_status_t psa_verify_hash_abort(
3457 psa_verify_hash_interruptible_operation_t *operation)
3458{
Paul Elliott59ad9452022-12-18 15:09:02 +00003459 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003460
Paul Elliott59ad9452022-12-18 15:09:02 +00003461 status = psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003462
Paul Elliott59ad9452022-12-18 15:09:02 +00003463 /* We clear the number of ops done here, so that it is not cleared when
3464 * the operation fails or succeeds, only on manual abort. */
3465 operation->num_ops = 0;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003466
Paul Elliottc9774412023-02-06 15:14:07 +00003467 /* Likewise, failure state. */
3468 operation->error_occurred = 0;
3469
Paul Elliott59ad9452022-12-18 15:09:02 +00003470 return status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003471}
3472
Paul Elliott588f8ed2022-12-02 18:10:26 +00003473/****************************************************************/
3474/* Asymmetric interruptible cryptography internal */
3475/* implementations */
3476/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003477
Paul Elliott588f8ed2022-12-02 18:10:26 +00003478void mbedtls_psa_interruptible_set_max_ops(uint32_t max_ops)
3479{
Paul Elliott7cc4e812023-01-10 17:14:11 +00003480
Paul Elliott588f8ed2022-12-02 18:10:26 +00003481#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3482 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3483 defined(MBEDTLS_ECP_RESTARTABLE)
3484
3485 /* Internal implementation uses zero to indicate infinite number max ops,
3486 * therefore avoid this value, and set to minimum possible. */
3487 if (max_ops == 0) {
3488 max_ops = 1;
3489 }
3490
Paul Elliott588f8ed2022-12-02 18:10:26 +00003491 mbedtls_ecp_set_max_ops(max_ops);
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003492#else
3493 (void) max_ops;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003494#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3495 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3496 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3497}
3498
Paul Elliott588f8ed2022-12-02 18:10:26 +00003499uint32_t mbedtls_psa_sign_hash_get_num_ops(
Paul Elliottf8e5b562023-02-19 18:43:45 +00003500 const mbedtls_psa_sign_hash_interruptible_operation_t *operation)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003501{
3502#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3503 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3504 defined(MBEDTLS_ECP_RESTARTABLE)
3505
Paul Elliott93d9ca82023-02-15 18:14:21 +00003506 return operation->num_ops;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003507#else
3508 (void) operation;
3509 return 0;
3510#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3511 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3512 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3513}
3514
3515uint32_t mbedtls_psa_verify_hash_get_num_ops(
Paul Elliottf8e5b562023-02-19 18:43:45 +00003516 const mbedtls_psa_verify_hash_interruptible_operation_t *operation)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003517{
3518 #if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3519 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3520 defined(MBEDTLS_ECP_RESTARTABLE)
3521
Paul Elliott93d9ca82023-02-15 18:14:21 +00003522 return operation->num_ops;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003523#else
3524 (void) operation;
3525 return 0;
3526#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3527 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3528 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3529}
3530
3531psa_status_t mbedtls_psa_sign_hash_start(
3532 mbedtls_psa_sign_hash_interruptible_operation_t *operation,
3533 const psa_key_attributes_t *attributes, const uint8_t *key_buffer,
3534 size_t key_buffer_size, psa_algorithm_t alg,
3535 const uint8_t *hash, size_t hash_length)
3536{
3537 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott0290a762023-02-09 14:30:24 +00003538 size_t required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003539
Paul Elliott068fe072023-01-16 13:59:15 +00003540 if (!PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3541 return PSA_ERROR_NOT_SUPPORTED;
3542 }
3543
3544 if (!PSA_ALG_IS_ECDSA(alg)) {
Paul Elliott813f9cd2023-02-05 15:28:46 +00003545 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott068fe072023-01-16 13:59:15 +00003546 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003547
3548#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Paul Elliott068fe072023-01-16 13:59:15 +00003549 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3550 defined(MBEDTLS_ECP_RESTARTABLE)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003551
Paul Elliotta1c94092023-02-15 16:38:04 +00003552 mbedtls_ecdsa_restart_init(&operation->restart_ctx);
3553
Paul Elliott93d9ca82023-02-15 18:14:21 +00003554 /* Ensure num_ops is zero'ed in case of context re-use. */
3555 operation->num_ops = 0;
3556
Paul Elliott068fe072023-01-16 13:59:15 +00003557 status = mbedtls_psa_ecp_load_representation(attributes->core.type,
3558 attributes->core.bits,
3559 key_buffer,
3560 key_buffer_size,
3561 &operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003562
Paul Elliott068fe072023-01-16 13:59:15 +00003563 if (status != PSA_SUCCESS) {
3564 return status;
3565 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003566
Paul Elliott1bc59df2023-02-05 13:41:57 +00003567 operation->coordinate_bytes = PSA_BITS_TO_BYTES(
Paul Elliottc569fc22023-02-10 13:02:54 +00003568 operation->ctx->grp.nbits);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003569
Paul Elliott068fe072023-01-16 13:59:15 +00003570 psa_algorithm_t hash_alg = PSA_ALG_SIGN_GET_HASH(alg);
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02003571 operation->md_alg = mbedtls_md_type_from_psa_alg(hash_alg);
Paul Elliott068fe072023-01-16 13:59:15 +00003572 operation->alg = alg;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003573
Paul Elliott0290a762023-02-09 14:30:24 +00003574 /* We only need to store the same length of hash as the private key size
3575 * here, it would be truncated by the internal implementation anyway. */
3576 required_hash_length = (hash_length < operation->coordinate_bytes ?
3577 hash_length : operation->coordinate_bytes);
3578
Paul Elliottba70ad42023-02-15 18:23:53 +00003579 if (required_hash_length > sizeof(operation->hash)) {
3580 /* Shouldn't happen, but better safe than sorry. */
3581 return PSA_ERROR_CORRUPTION_DETECTED;
3582 }
3583
Paul Elliott0290a762023-02-09 14:30:24 +00003584 memcpy(operation->hash, hash, required_hash_length);
3585 operation->hash_length = required_hash_length;
Paul Elliott068fe072023-01-16 13:59:15 +00003586
3587 return PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003588
3589#else
Paul Elliott068fe072023-01-16 13:59:15 +00003590 (void) operation;
3591 (void) key_buffer;
3592 (void) key_buffer_size;
3593 (void) alg;
3594 (void) hash;
3595 (void) hash_length;
3596 (void) status;
Paul Elliott0290a762023-02-09 14:30:24 +00003597 (void) required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003598
Paul Elliott068fe072023-01-16 13:59:15 +00003599 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003600#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3601 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3602 * defined( MBEDTLS_ECP_RESTARTABLE ) */
Paul Elliott588f8ed2022-12-02 18:10:26 +00003603}
3604
3605psa_status_t mbedtls_psa_sign_hash_complete(
3606 mbedtls_psa_sign_hash_interruptible_operation_t *operation,
3607 uint8_t *signature, size_t signature_size,
3608 size_t *signature_length)
3609{
Paul Elliott588f8ed2022-12-02 18:10:26 +00003610#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3611 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3612 defined(MBEDTLS_ECP_RESTARTABLE)
3613
Paul Elliotta1c94092023-02-15 16:38:04 +00003614 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott1243f932023-02-07 11:21:10 +00003615 mbedtls_mpi r;
3616 mbedtls_mpi s;
3617
Paul Elliott46845252023-02-03 14:59:11 +00003618 mbedtls_mpi_init(&r);
3619 mbedtls_mpi_init(&s);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003620
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003621 /* Ensure max_ops is set to the current value (or default). */
3622 mbedtls_psa_interruptible_set_max_ops(psa_interruptible_get_max_ops());
3623
Paul Elliotta1c94092023-02-15 16:38:04 +00003624 if (signature_size < 2 * operation->coordinate_bytes) {
3625 status = PSA_ERROR_BUFFER_TOO_SMALL;
3626 goto exit;
3627 }
3628
Paul Elliott588f8ed2022-12-02 18:10:26 +00003629 if (PSA_ALG_ECDSA_IS_DETERMINISTIC(operation->alg)) {
Paul Elliott46845252023-02-03 14:59:11 +00003630
Paul Elliott588f8ed2022-12-02 18:10:26 +00003631#if defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3632 status = mbedtls_to_psa_error(
3633 mbedtls_ecdsa_sign_det_restartable(&operation->ctx->grp,
Paul Elliott46845252023-02-03 14:59:11 +00003634 &r,
3635 &s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003636 &operation->ctx->d,
3637 operation->hash,
3638 operation->hash_length,
3639 operation->md_alg,
3640 mbedtls_psa_get_random,
3641 MBEDTLS_PSA_RANDOM_STATE,
3642 &operation->restart_ctx));
3643#else /* defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Paul Elliott724bd252023-02-08 12:35:08 +00003644 status = PSA_ERROR_NOT_SUPPORTED;
3645 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003646#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
3647 } else {
Paul Elliott588f8ed2022-12-02 18:10:26 +00003648 status = mbedtls_to_psa_error(
3649 mbedtls_ecdsa_sign_restartable(&operation->ctx->grp,
Paul Elliott46845252023-02-03 14:59:11 +00003650 &r,
3651 &s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003652 &operation->ctx->d,
3653 operation->hash,
3654 operation->hash_length,
3655 mbedtls_psa_get_random,
3656 MBEDTLS_PSA_RANDOM_STATE,
3657 mbedtls_psa_get_random,
3658 MBEDTLS_PSA_RANDOM_STATE,
3659 &operation->restart_ctx));
3660 }
3661
Paul Elliottf8e5b562023-02-19 18:43:45 +00003662 /* Hide the fact that the restart context only holds a delta of number of
3663 * ops done during the last operation, not an absolute value. */
3664 operation->num_ops += operation->restart_ctx.ecp.ops_done;
3665
Paul Elliott724bd252023-02-08 12:35:08 +00003666 if (status == PSA_SUCCESS) {
Paul Elliott588f8ed2022-12-02 18:10:26 +00003667 status = mbedtls_to_psa_error(
Paul Elliott46845252023-02-03 14:59:11 +00003668 mbedtls_mpi_write_binary(&r,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003669 signature,
Paul Elliott1bc59df2023-02-05 13:41:57 +00003670 operation->coordinate_bytes)
3671 );
Paul Elliott588f8ed2022-12-02 18:10:26 +00003672
3673 if (status != PSA_SUCCESS) {
Paul Elliott724bd252023-02-08 12:35:08 +00003674 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003675 }
3676
3677 status = mbedtls_to_psa_error(
Paul Elliott46845252023-02-03 14:59:11 +00003678 mbedtls_mpi_write_binary(&s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003679 signature +
Paul Elliott1bc59df2023-02-05 13:41:57 +00003680 operation->coordinate_bytes,
3681 operation->coordinate_bytes)
3682 );
Paul Elliott588f8ed2022-12-02 18:10:26 +00003683
3684 if (status != PSA_SUCCESS) {
Paul Elliott724bd252023-02-08 12:35:08 +00003685 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003686 }
3687
Paul Elliott1bc59df2023-02-05 13:41:57 +00003688 *signature_length = operation->coordinate_bytes * 2;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003689
Paul Elliott724bd252023-02-08 12:35:08 +00003690 status = PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003691 }
Paul Elliott724bd252023-02-08 12:35:08 +00003692
3693exit:
3694
3695 mbedtls_mpi_free(&r);
3696 mbedtls_mpi_free(&s);
3697 return status;
3698
Paul Elliott588f8ed2022-12-02 18:10:26 +00003699 #else
3700
3701 (void) operation;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003702 (void) signature;
3703 (void) signature_size;
3704 (void) signature_length;
3705
3706 return PSA_ERROR_NOT_SUPPORTED;
3707
3708#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3709 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3710 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3711}
3712
3713psa_status_t mbedtls_psa_sign_hash_abort(
3714 mbedtls_psa_sign_hash_interruptible_operation_t *operation)
3715{
3716
3717#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3718 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3719 defined(MBEDTLS_ECP_RESTARTABLE)
3720
3721 if (operation->ctx) {
3722 mbedtls_ecdsa_free(operation->ctx);
3723 mbedtls_free(operation->ctx);
Paul Elliottf9c91a72023-02-05 18:06:38 +00003724 operation->ctx = NULL;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003725 }
3726
3727 mbedtls_ecdsa_restart_free(&operation->restart_ctx);
3728
Paul Elliott93d9ca82023-02-15 18:14:21 +00003729 operation->num_ops = 0;
3730
Paul Elliott588f8ed2022-12-02 18:10:26 +00003731 return PSA_SUCCESS;
3732
3733#else
3734
3735 (void) operation;
3736
3737 return PSA_ERROR_NOT_SUPPORTED;
3738
3739#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3740 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3741 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3742}
3743
3744psa_status_t mbedtls_psa_verify_hash_start(
3745 mbedtls_psa_verify_hash_interruptible_operation_t *operation,
3746 const psa_key_attributes_t *attributes,
3747 const uint8_t *key_buffer, size_t key_buffer_size,
3748 psa_algorithm_t alg,
3749 const uint8_t *hash, size_t hash_length,
3750 const uint8_t *signature, size_t signature_length)
3751{
3752 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott1bc59df2023-02-05 13:41:57 +00003753 size_t coordinate_bytes = 0;
Paul Elliott0290a762023-02-09 14:30:24 +00003754 size_t required_hash_length = 0;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003755
Paul Elliott068fe072023-01-16 13:59:15 +00003756 if (!PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3757 return PSA_ERROR_NOT_SUPPORTED;
3758 }
3759
3760 if (!PSA_ALG_IS_ECDSA(alg)) {
Paul Elliott813f9cd2023-02-05 15:28:46 +00003761 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott068fe072023-01-16 13:59:15 +00003762 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003763
3764#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Paul Elliott068fe072023-01-16 13:59:15 +00003765 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3766 defined(MBEDTLS_ECP_RESTARTABLE)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003767
Paul Elliotta1c94092023-02-15 16:38:04 +00003768 mbedtls_ecdsa_restart_init(&operation->restart_ctx);
3769 mbedtls_mpi_init(&operation->r);
3770 mbedtls_mpi_init(&operation->s);
3771
Paul Elliott93d9ca82023-02-15 18:14:21 +00003772 /* Ensure num_ops is zero'ed in case of context re-use. */
3773 operation->num_ops = 0;
3774
Paul Elliott068fe072023-01-16 13:59:15 +00003775 status = mbedtls_psa_ecp_load_representation(attributes->core.type,
3776 attributes->core.bits,
3777 key_buffer,
3778 key_buffer_size,
3779 &operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003780
Paul Elliott068fe072023-01-16 13:59:15 +00003781 if (status != PSA_SUCCESS) {
3782 return status;
3783 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003784
Paul Elliottc569fc22023-02-10 13:02:54 +00003785 coordinate_bytes = PSA_BITS_TO_BYTES(operation->ctx->grp.nbits);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003786
Paul Elliott1bc59df2023-02-05 13:41:57 +00003787 if (signature_length != 2 * coordinate_bytes) {
Paul Elliott068fe072023-01-16 13:59:15 +00003788 return PSA_ERROR_INVALID_SIGNATURE;
3789 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003790
Paul Elliott068fe072023-01-16 13:59:15 +00003791 status = mbedtls_to_psa_error(
3792 mbedtls_mpi_read_binary(&operation->r,
3793 signature,
Paul Elliott1bc59df2023-02-05 13:41:57 +00003794 coordinate_bytes));
Paul Elliott588f8ed2022-12-02 18:10:26 +00003795
Paul Elliott068fe072023-01-16 13:59:15 +00003796 if (status != PSA_SUCCESS) {
3797 return status;
3798 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003799
Paul Elliott068fe072023-01-16 13:59:15 +00003800 status = mbedtls_to_psa_error(
3801 mbedtls_mpi_read_binary(&operation->s,
3802 signature +
Paul Elliott1bc59df2023-02-05 13:41:57 +00003803 coordinate_bytes,
3804 coordinate_bytes));
Paul Elliott588f8ed2022-12-02 18:10:26 +00003805
Paul Elliott068fe072023-01-16 13:59:15 +00003806 if (status != PSA_SUCCESS) {
3807 return status;
3808 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003809
Paul Elliott2c9843f2023-02-15 17:32:42 +00003810 status = mbedtls_psa_ecp_load_public_part(operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003811
Paul Elliott2c9843f2023-02-15 17:32:42 +00003812 if (status != PSA_SUCCESS) {
3813 return status;
Paul Elliott068fe072023-01-16 13:59:15 +00003814 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003815
Paul Elliott0290a762023-02-09 14:30:24 +00003816 /* We only need to store the same length of hash as the private key size
3817 * here, it would be truncated by the internal implementation anyway. */
3818 required_hash_length = (hash_length < coordinate_bytes ? hash_length :
3819 coordinate_bytes);
3820
Paul Elliottba70ad42023-02-15 18:23:53 +00003821 if (required_hash_length > sizeof(operation->hash)) {
3822 /* Shouldn't happen, but better safe than sorry. */
3823 return PSA_ERROR_CORRUPTION_DETECTED;
3824 }
3825
Paul Elliott0290a762023-02-09 14:30:24 +00003826 memcpy(operation->hash, hash, required_hash_length);
3827 operation->hash_length = required_hash_length;
Paul Elliott068fe072023-01-16 13:59:15 +00003828
3829 return PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003830#else
Paul Elliott068fe072023-01-16 13:59:15 +00003831 (void) operation;
3832 (void) key_buffer;
3833 (void) key_buffer_size;
3834 (void) alg;
3835 (void) hash;
3836 (void) hash_length;
3837 (void) signature;
3838 (void) signature_length;
3839 (void) status;
Paul Elliott1243f932023-02-07 11:21:10 +00003840 (void) coordinate_bytes;
Paul Elliott0290a762023-02-09 14:30:24 +00003841 (void) required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003842
Paul Elliott068fe072023-01-16 13:59:15 +00003843 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003844#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3845 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3846 * defined( MBEDTLS_ECP_RESTARTABLE ) */
Paul Elliott588f8ed2022-12-02 18:10:26 +00003847}
3848
3849psa_status_t mbedtls_psa_verify_hash_complete(
3850 mbedtls_psa_verify_hash_interruptible_operation_t *operation)
3851{
3852
3853#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3854 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3855 defined(MBEDTLS_ECP_RESTARTABLE)
3856
Paul Elliottf8e5b562023-02-19 18:43:45 +00003857 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3858
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003859 /* Ensure max_ops is set to the current value (or default). */
3860 mbedtls_psa_interruptible_set_max_ops(psa_interruptible_get_max_ops());
3861
Paul Elliottf8e5b562023-02-19 18:43:45 +00003862 status = mbedtls_to_psa_error(
Paul Elliott588f8ed2022-12-02 18:10:26 +00003863 mbedtls_ecdsa_verify_restartable(&operation->ctx->grp,
3864 operation->hash,
3865 operation->hash_length,
3866 &operation->ctx->Q,
3867 &operation->r,
3868 &operation->s,
3869 &operation->restart_ctx));
3870
Paul Elliottf8e5b562023-02-19 18:43:45 +00003871 /* Hide the fact that the restart context only holds a delta of number of
3872 * ops done during the last operation, not an absolute value. */
3873 operation->num_ops += operation->restart_ctx.ecp.ops_done;
3874
3875 return status;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003876#else
3877 (void) operation;
3878
3879 return PSA_ERROR_NOT_SUPPORTED;
3880
3881#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3882 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3883 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3884}
3885
3886psa_status_t mbedtls_psa_verify_hash_abort(
3887 mbedtls_psa_verify_hash_interruptible_operation_t *operation)
3888{
3889
3890#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3891 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3892 defined(MBEDTLS_ECP_RESTARTABLE)
3893
3894 if (operation->ctx) {
3895 mbedtls_ecdsa_free(operation->ctx);
3896 mbedtls_free(operation->ctx);
Paul Elliottf9c91a72023-02-05 18:06:38 +00003897 operation->ctx = NULL;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003898 }
3899
3900 mbedtls_ecdsa_restart_free(&operation->restart_ctx);
3901
Paul Elliott93d9ca82023-02-15 18:14:21 +00003902 operation->num_ops = 0;
3903
Paul Elliott588f8ed2022-12-02 18:10:26 +00003904 mbedtls_mpi_free(&operation->r);
3905 mbedtls_mpi_free(&operation->s);
3906
3907 return PSA_SUCCESS;
3908
3909#else
3910 (void) operation;
3911
3912 return PSA_ERROR_NOT_SUPPORTED;
3913
3914#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3915 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3916 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3917}
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003918
mohammad1603503973b2018-03-12 15:59:30 +02003919/****************************************************************/
3920/* Symmetric cryptography */
3921/****************************************************************/
3922
Gilles Peskine449bd832023-01-11 14:50:10 +01003923static psa_status_t psa_cipher_setup(psa_cipher_operation_t *operation,
3924 mbedtls_svc_key_id_t key,
3925 psa_algorithm_t alg,
3926 mbedtls_operation_t cipher_operation)
Ronald Cronab99ac22020-10-01 16:38:28 +02003927{
3928 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3929 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman54648242021-06-24 11:49:45 +01003930 psa_key_slot_t *slot = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01003931 psa_key_usage_t usage = (cipher_operation == MBEDTLS_ENCRYPT ?
3932 PSA_KEY_USAGE_ENCRYPT :
3933 PSA_KEY_USAGE_DECRYPT);
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003934 psa_key_attributes_t attributes;
Ronald Cronab99ac22020-10-01 16:38:28 +02003935
3936 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003937 if (operation->id != 0) {
Dave Rodgman54648242021-06-24 11:49:45 +01003938 status = PSA_ERROR_BAD_STATE;
3939 goto exit;
3940 }
Ronald Cronab99ac22020-10-01 16:38:28 +02003941
Gilles Peskine449bd832023-01-11 14:50:10 +01003942 if (!PSA_ALG_IS_CIPHER(alg)) {
Dave Rodgman54648242021-06-24 11:49:45 +01003943 status = PSA_ERROR_INVALID_ARGUMENT;
3944 goto exit;
3945 }
Ronald Cronab99ac22020-10-01 16:38:28 +02003946
Gilles Peskine449bd832023-01-11 14:50:10 +01003947 status = psa_get_and_lock_key_slot_with_policy(key, &slot, usage, alg);
3948 if (status != PSA_SUCCESS) {
Ronald Cronab99ac22020-10-01 16:38:28 +02003949 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01003950 }
Ronald Cronab99ac22020-10-01 16:38:28 +02003951
Ronald Cron49fafa92021-03-10 08:34:23 +01003952 /* Initialize the operation struct members, except for id. The id member
Ronald Cronab99ac22020-10-01 16:38:28 +02003953 * is used to indicate to psa_cipher_abort that there are resources to free,
Ronald Cron49fafa92021-03-10 08:34:23 +01003954 * so we only set it (in the driver wrapper) after resources have been
3955 * allocated/initialized. */
Ronald Cronab99ac22020-10-01 16:38:28 +02003956 operation->iv_set = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01003957 if (alg == PSA_ALG_ECB_NO_PADDING) {
Ronald Cronab99ac22020-10-01 16:38:28 +02003958 operation->iv_required = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01003959 } else {
Ronald Cronab99ac22020-10-01 16:38:28 +02003960 operation->iv_required = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003961 }
3962 operation->default_iv_length = PSA_CIPHER_IV_LENGTH(slot->attr.type, alg);
Ronald Cronab99ac22020-10-01 16:38:28 +02003963
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003964 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01003965 .core = slot->attr
Ronald Crona4af55f2020-12-14 14:36:06 +01003966 };
3967
Ronald Cronab99ac22020-10-01 16:38:28 +02003968 /* Try doing the operation through a driver before using software fallback. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003969 if (cipher_operation == MBEDTLS_ENCRYPT) {
3970 status = psa_driver_wrapper_cipher_encrypt_setup(operation,
3971 &attributes,
3972 slot->key.data,
3973 slot->key.bytes,
3974 alg);
3975 } else {
3976 status = psa_driver_wrapper_cipher_decrypt_setup(operation,
3977 &attributes,
3978 slot->key.data,
3979 slot->key.bytes,
3980 alg);
3981 }
Ronald Cronab99ac22020-10-01 16:38:28 +02003982
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003983exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01003984 if (status != PSA_SUCCESS) {
3985 psa_cipher_abort(operation);
3986 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003987
Ryan Everett1b70a072024-01-04 10:32:49 +00003988 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003989
Gilles Peskine449bd832023-01-11 14:50:10 +01003990 return (status == PSA_SUCCESS) ? unlock_status : status;
mohammad1603503973b2018-03-12 15:59:30 +02003991}
3992
Gilles Peskine449bd832023-01-11 14:50:10 +01003993psa_status_t psa_cipher_encrypt_setup(psa_cipher_operation_t *operation,
3994 mbedtls_svc_key_id_t key,
3995 psa_algorithm_t alg)
mohammad16038481e742018-03-18 13:57:31 +02003996{
Gilles Peskine449bd832023-01-11 14:50:10 +01003997 return psa_cipher_setup(operation, key, alg, MBEDTLS_ENCRYPT);
mohammad16038481e742018-03-18 13:57:31 +02003998}
3999
Gilles Peskine449bd832023-01-11 14:50:10 +01004000psa_status_t psa_cipher_decrypt_setup(psa_cipher_operation_t *operation,
4001 mbedtls_svc_key_id_t key,
4002 psa_algorithm_t alg)
mohammad16038481e742018-03-18 13:57:31 +02004003{
Gilles Peskine449bd832023-01-11 14:50:10 +01004004 return psa_cipher_setup(operation, key, alg, MBEDTLS_DECRYPT);
mohammad16038481e742018-03-18 13:57:31 +02004005}
4006
Gilles Peskine449bd832023-01-11 14:50:10 +01004007psa_status_t psa_cipher_generate_iv(psa_cipher_operation_t *operation,
4008 uint8_t *iv,
4009 size_t iv_size,
4010 size_t *iv_length)
mohammad1603503973b2018-03-12 15:59:30 +02004011{
Ronald Cron6d051732020-10-01 14:10:20 +02004012 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2fb90522021-07-05 12:31:44 +02004013 uint8_t local_iv[PSA_CIPHER_IV_MAX_SIZE];
Sergeybef1f632023-03-06 15:25:06 -07004014 size_t default_iv_length = 0;
Ronald Cron5618a392021-03-26 09:52:26 +01004015
Gilles Peskine449bd832023-01-11 14:50:10 +01004016 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004017 status = PSA_ERROR_BAD_STATE;
4018 goto exit;
Ronald Cronc45b4af2020-09-29 16:18:05 +02004019 }
4020
Gilles Peskine449bd832023-01-11 14:50:10 +01004021 if (operation->iv_set || !operation->iv_required) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004022 status = PSA_ERROR_BAD_STATE;
4023 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004024 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004025
Ronald Cron2fb90522021-07-05 12:31:44 +02004026 default_iv_length = operation->default_iv_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01004027 if (iv_size < default_iv_length) {
Ronald Cron5618a392021-03-26 09:52:26 +01004028 status = PSA_ERROR_BUFFER_TOO_SMALL;
4029 goto exit;
4030 }
Gilles Peskinee553c652018-06-04 16:22:46 +02004031
Gilles Peskine449bd832023-01-11 14:50:10 +01004032 if (default_iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Ronald Cron2fb90522021-07-05 12:31:44 +02004033 status = PSA_ERROR_GENERIC_ERROR;
4034 goto exit;
4035 }
4036
Gilles Peskine449bd832023-01-11 14:50:10 +01004037 status = psa_generate_random(local_iv, default_iv_length);
4038 if (status != PSA_SUCCESS) {
Ronald Cron5618a392021-03-26 09:52:26 +01004039 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004040 }
Ronald Cron5618a392021-03-26 09:52:26 +01004041
Gilles Peskine449bd832023-01-11 14:50:10 +01004042 status = psa_driver_wrapper_cipher_set_iv(operation,
4043 local_iv, default_iv_length);
Ronald Cron5618a392021-03-26 09:52:26 +01004044
4045exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004046 if (status == PSA_SUCCESS) {
4047 memcpy(iv, local_iv, default_iv_length);
Ronald Cron2fb90522021-07-05 12:31:44 +02004048 *iv_length = default_iv_length;
Steven Cooreman7df02922020-09-09 15:28:49 +02004049 operation->iv_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004050 } else {
Ronald Cron2fb90522021-07-05 12:31:44 +02004051 *iv_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004052 psa_cipher_abort(operation);
Ronald Cron2fb90522021-07-05 12:31:44 +02004053 }
Ronald Cron6d051732020-10-01 14:10:20 +02004054
Gilles Peskine449bd832023-01-11 14:50:10 +01004055 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004056}
4057
Gilles Peskine449bd832023-01-11 14:50:10 +01004058psa_status_t psa_cipher_set_iv(psa_cipher_operation_t *operation,
4059 const uint8_t *iv,
4060 size_t iv_length)
mohammad1603503973b2018-03-12 15:59:30 +02004061{
Ronald Cron6d051732020-10-01 14:10:20 +02004062 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronc45b4af2020-09-29 16:18:05 +02004063
Gilles Peskine449bd832023-01-11 14:50:10 +01004064 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004065 status = PSA_ERROR_BAD_STATE;
4066 goto exit;
4067 }
Ronald Cronc45b4af2020-09-29 16:18:05 +02004068
Gilles Peskine449bd832023-01-11 14:50:10 +01004069 if (operation->iv_set || !operation->iv_required) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004070 status = PSA_ERROR_BAD_STATE;
4071 goto exit;
4072 }
Ronald Crona0d68172021-03-26 10:15:08 +01004073
Gilles Peskine449bd832023-01-11 14:50:10 +01004074 if (iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004075 status = PSA_ERROR_INVALID_ARGUMENT;
4076 goto exit;
4077 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004078
Gilles Peskine449bd832023-01-11 14:50:10 +01004079 status = psa_driver_wrapper_cipher_set_iv(operation,
4080 iv,
4081 iv_length);
Steven Cooremand3feccd2020-09-01 15:56:14 +02004082
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004083exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004084 if (status == PSA_SUCCESS) {
itayzafrir534bd7c2018-08-02 13:56:32 +03004085 operation->iv_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004086 } else {
4087 psa_cipher_abort(operation);
4088 }
4089 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004090}
4091
Gilles Peskine449bd832023-01-11 14:50:10 +01004092psa_status_t psa_cipher_update(psa_cipher_operation_t *operation,
4093 const uint8_t *input,
4094 size_t input_length,
4095 uint8_t *output,
4096 size_t output_size,
4097 size_t *output_length)
mohammad1603503973b2018-03-12 15:59:30 +02004098{
Steven Cooremanffecb7b2020-08-25 15:13:13 +02004099 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron6d051732020-10-01 14:10:20 +02004100
Gilles Peskine449bd832023-01-11 14:50:10 +01004101 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004102 status = PSA_ERROR_BAD_STATE;
4103 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004104 }
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004105
Gilles Peskine449bd832023-01-11 14:50:10 +01004106 if (operation->iv_required && !operation->iv_set) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004107 status = PSA_ERROR_BAD_STATE;
4108 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004109 }
Jaeden Ameroab439972019-02-15 14:12:05 +00004110
Gilles Peskine449bd832023-01-11 14:50:10 +01004111 status = psa_driver_wrapper_cipher_update(operation,
4112 input,
4113 input_length,
4114 output,
4115 output_size,
4116 output_length);
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004117
4118exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004119 if (status != PSA_SUCCESS) {
4120 psa_cipher_abort(operation);
4121 }
Ronald Cron6d051732020-10-01 14:10:20 +02004122
Gilles Peskine449bd832023-01-11 14:50:10 +01004123 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004124}
4125
Gilles Peskine449bd832023-01-11 14:50:10 +01004126psa_status_t psa_cipher_finish(psa_cipher_operation_t *operation,
4127 uint8_t *output,
4128 size_t output_size,
4129 size_t *output_length)
mohammad1603503973b2018-03-12 15:59:30 +02004130{
David Saadab4ecc272019-02-14 13:48:10 +02004131 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Ronald Cron6d051732020-10-01 14:10:20 +02004132
Gilles Peskine449bd832023-01-11 14:50:10 +01004133 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004134 status = PSA_ERROR_BAD_STATE;
4135 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004136 }
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004137
Gilles Peskine449bd832023-01-11 14:50:10 +01004138 if (operation->iv_required && !operation->iv_set) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004139 status = PSA_ERROR_BAD_STATE;
4140 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004141 }
Moran Pekerbed71a22018-04-22 20:19:20 +03004142
Gilles Peskine449bd832023-01-11 14:50:10 +01004143 status = psa_driver_wrapper_cipher_finish(operation,
4144 output,
4145 output_size,
4146 output_length);
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004147
4148exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004149 if (status == PSA_SUCCESS) {
4150 return psa_cipher_abort(operation);
4151 } else {
Steven Cooremanef8575e2020-09-11 11:44:50 +02004152 *output_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004153 (void) psa_cipher_abort(operation);
Janos Follath315b51c2018-07-09 16:04:51 +01004154
Gilles Peskine449bd832023-01-11 14:50:10 +01004155 return status;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004156 }
mohammad1603503973b2018-03-12 15:59:30 +02004157}
4158
Gilles Peskine449bd832023-01-11 14:50:10 +01004159psa_status_t psa_cipher_abort(psa_cipher_operation_t *operation)
Gilles Peskinee553c652018-06-04 16:22:46 +02004160{
Gilles Peskine449bd832023-01-11 14:50:10 +01004161 if (operation->id == 0) {
Steven Cooremana07b9972020-09-10 14:54:14 +02004162 /* The object has (apparently) been initialized but it is not (yet)
Gilles Peskine81736312018-06-26 15:04:31 +02004163 * in use. It's ok to call abort on such an object, and there's
4164 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004165 return PSA_SUCCESS;
Gilles Peskine81736312018-06-26 15:04:31 +02004166 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004167
Gilles Peskine449bd832023-01-11 14:50:10 +01004168 psa_driver_wrapper_cipher_abort(operation);
Gilles Peskinee553c652018-06-04 16:22:46 +02004169
Ronald Cron49fafa92021-03-10 08:34:23 +01004170 operation->id = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004171 operation->iv_set = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004172 operation->iv_required = 0;
Moran Peker41deec42018-04-04 15:43:05 +03004173
Gilles Peskine449bd832023-01-11 14:50:10 +01004174 return PSA_SUCCESS;
mohammad1603503973b2018-03-12 15:59:30 +02004175}
4176
Gilles Peskine449bd832023-01-11 14:50:10 +01004177psa_status_t psa_cipher_encrypt(mbedtls_svc_key_id_t key,
4178 psa_algorithm_t alg,
4179 const uint8_t *input,
4180 size_t input_length,
4181 uint8_t *output,
4182 size_t output_size,
4183 size_t *output_length)
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004184{
4185 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004186 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron23919522021-07-08 19:00:07 +02004187 psa_key_slot_t *slot = NULL;
Ronald Cronc6e6f502021-07-09 18:44:58 +02004188 uint8_t local_iv[PSA_CIPHER_IV_MAX_SIZE];
4189 size_t default_iv_length = 0;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004190 psa_key_attributes_t attributes;
gabor-mezei-arm6f4e5bb2021-06-25 15:21:11 +02004191
Gilles Peskine449bd832023-01-11 14:50:10 +01004192 if (!PSA_ALG_IS_CIPHER(alg)) {
Ronald Cron23919522021-07-08 19:00:07 +02004193 status = PSA_ERROR_INVALID_ARGUMENT;
4194 goto exit;
4195 }
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004196
Gilles Peskine449bd832023-01-11 14:50:10 +01004197 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
4198 PSA_KEY_USAGE_ENCRYPT,
4199 alg);
4200 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004201 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004202 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004203
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004204 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004205 .core = slot->attr
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004206 };
4207
Gilles Peskine449bd832023-01-11 14:50:10 +01004208 default_iv_length = PSA_CIPHER_IV_LENGTH(slot->attr.type, alg);
4209 if (default_iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Ronald Cronc6e6f502021-07-09 18:44:58 +02004210 status = PSA_ERROR_GENERIC_ERROR;
4211 goto exit;
4212 }
4213
Gilles Peskine449bd832023-01-11 14:50:10 +01004214 if (default_iv_length > 0) {
4215 if (output_size < default_iv_length) {
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004216 status = PSA_ERROR_BUFFER_TOO_SMALL;
4217 goto exit;
4218 }
4219
Gilles Peskine449bd832023-01-11 14:50:10 +01004220 status = psa_generate_random(local_iv, default_iv_length);
4221 if (status != PSA_SUCCESS) {
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004222 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004223 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004224 }
4225
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004226 status = psa_driver_wrapper_cipher_encrypt(
4227 &attributes, slot->key.data, slot->key.bytes,
Ronald Cronc6e6f502021-07-09 18:44:58 +02004228 alg, local_iv, default_iv_length, input, input_length,
Ronald Cronafbc7ed2023-01-24 16:02:04 +01004229 psa_crypto_buffer_offset(output, default_iv_length),
Gilles Peskine449bd832023-01-11 14:50:10 +01004230 output_size - default_iv_length, output_length);
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004231
4232exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00004233 unlock_status = psa_unregister_read(slot);
Gilles Peskine449bd832023-01-11 14:50:10 +01004234 if (status == PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004235 status = unlock_status;
Ronald Cronc6e6f502021-07-09 18:44:58 +02004236 }
Ronald Cron23919522021-07-08 19:00:07 +02004237
Gilles Peskine449bd832023-01-11 14:50:10 +01004238 if (status == PSA_SUCCESS) {
4239 if (default_iv_length > 0) {
4240 memcpy(output, local_iv, default_iv_length);
4241 }
4242 *output_length += default_iv_length;
4243 } else {
4244 *output_length = 0;
4245 }
4246
4247 return status;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004248}
4249
Gilles Peskine449bd832023-01-11 14:50:10 +01004250psa_status_t psa_cipher_decrypt(mbedtls_svc_key_id_t key,
4251 psa_algorithm_t alg,
4252 const uint8_t *input,
4253 size_t input_length,
4254 uint8_t *output,
4255 size_t output_size,
4256 size_t *output_length)
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004257{
4258 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004259 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron23919522021-07-08 19:00:07 +02004260 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004261 psa_key_attributes_t attributes;
gabor-mezei-arm6f4e5bb2021-06-25 15:21:11 +02004262
Gilles Peskine449bd832023-01-11 14:50:10 +01004263 if (!PSA_ALG_IS_CIPHER(alg)) {
Ronald Cron23919522021-07-08 19:00:07 +02004264 status = PSA_ERROR_INVALID_ARGUMENT;
4265 goto exit;
4266 }
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004267
Gilles Peskine449bd832023-01-11 14:50:10 +01004268 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
4269 PSA_KEY_USAGE_DECRYPT,
4270 alg);
4271 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004272 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004273 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004274
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004275 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004276 .core = slot->attr
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004277 };
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004278
Gilles Peskine449bd832023-01-11 14:50:10 +01004279 if (alg == PSA_ALG_CCM_STAR_NO_TAG &&
4280 input_length < PSA_BLOCK_CIPHER_BLOCK_LENGTH(slot->attr.type)) {
Mateusz Starzyk594215b2021-10-14 12:23:06 +02004281 status = PSA_ERROR_INVALID_ARGUMENT;
4282 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004283 } else if (input_length < PSA_CIPHER_IV_LENGTH(slot->attr.type, alg)) {
gabor-mezei-arm258ae072021-06-25 15:25:38 +02004284 status = PSA_ERROR_INVALID_ARGUMENT;
4285 goto exit;
4286 }
4287
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004288 status = psa_driver_wrapper_cipher_decrypt(
4289 &attributes, slot->key.data, slot->key.bytes,
4290 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004291 output, output_size, output_length);
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004292
gabor-mezei-arm258ae072021-06-25 15:25:38 +02004293exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00004294 unlock_status = psa_unregister_read(slot);
Gilles Peskine449bd832023-01-11 14:50:10 +01004295 if (status == PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004296 status = unlock_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01004297 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004298
Gilles Peskine449bd832023-01-11 14:50:10 +01004299 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004300 *output_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004301 }
Ronald Cron23919522021-07-08 19:00:07 +02004302
Gilles Peskine449bd832023-01-11 14:50:10 +01004303 return status;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004304}
4305
4306
mohammad16035955c982018-04-26 00:53:03 +03004307/****************************************************************/
4308/* AEAD */
4309/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004310
Paul Elliottbaff51c2021-09-28 17:44:45 +01004311/* Helper function to get the base algorithm from its variants. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004312static psa_algorithm_t psa_aead_get_base_algorithm(psa_algorithm_t alg)
Paul Elliottbaff51c2021-09-28 17:44:45 +01004313{
Gilles Peskine449bd832023-01-11 14:50:10 +01004314 return PSA_ALG_AEAD_WITH_DEFAULT_LENGTH_TAG(alg);
Paul Elliottbaff51c2021-09-28 17:44:45 +01004315}
4316
4317/* Helper function to perform common nonce length checks. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004318static psa_status_t psa_aead_check_nonce_length(psa_algorithm_t alg,
4319 size_t nonce_length)
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004320{
Gilles Peskine449bd832023-01-11 14:50:10 +01004321 psa_algorithm_t base_alg = psa_aead_get_base_algorithm(alg);
Paul Elliottbaff51c2021-09-28 17:44:45 +01004322
Gilles Peskine449bd832023-01-11 14:50:10 +01004323 switch (base_alg) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004324#if defined(PSA_WANT_ALG_GCM)
4325 case PSA_ALG_GCM:
4326 /* Not checking max nonce size here as GCM spec allows almost
Gilles Peskine449bd832023-01-11 14:50:10 +01004327 * arbitrarily large nonces. Please note that we do not generally
4328 * recommend the usage of nonces of greater length than
4329 * PSA_AEAD_NONCE_MAX_SIZE, as large nonces are hashed to a shorter
4330 * size, which can then lead to collisions if you encrypt a very
4331 * large number of messages.*/
4332 if (nonce_length != 0) {
4333 return PSA_SUCCESS;
4334 }
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004335 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004336#endif /* PSA_WANT_ALG_GCM */
4337#if defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004338 case PSA_ALG_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01004339 if (nonce_length >= 7 && nonce_length <= 13) {
4340 return PSA_SUCCESS;
4341 }
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004342 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004343#endif /* PSA_WANT_ALG_CCM */
4344#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004345 case PSA_ALG_CHACHA20_POLY1305:
Gilles Peskine449bd832023-01-11 14:50:10 +01004346 if (nonce_length == 12) {
4347 return PSA_SUCCESS;
4348 } else if (nonce_length == 8) {
4349 return PSA_ERROR_NOT_SUPPORTED;
4350 }
Bence Szépkúti6d48e202021-11-15 20:04:15 +01004351 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004352#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004353 default:
Przemek Stekiel4c499272022-09-27 13:55:37 +02004354 (void) nonce_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01004355 return PSA_ERROR_NOT_SUPPORTED;
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004356 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004357
Gilles Peskine449bd832023-01-11 14:50:10 +01004358 return PSA_ERROR_INVALID_ARGUMENT;
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004359}
4360
Gilles Peskine449bd832023-01-11 14:50:10 +01004361static psa_status_t psa_aead_check_algorithm(psa_algorithm_t alg)
Bence Szépkútiaa3a6e42022-01-13 16:26:03 +01004362{
Gilles Peskine449bd832023-01-11 14:50:10 +01004363 if (!PSA_ALG_IS_AEAD(alg) || PSA_ALG_IS_WILDCARD(alg)) {
4364 return PSA_ERROR_INVALID_ARGUMENT;
4365 }
Bence Szépkúti08f34652021-12-08 21:07:13 +01004366
Gilles Peskine449bd832023-01-11 14:50:10 +01004367 return PSA_SUCCESS;
Bence Szépkúti08f34652021-12-08 21:07:13 +01004368}
4369
Gilles Peskine449bd832023-01-11 14:50:10 +01004370psa_status_t psa_aead_encrypt(mbedtls_svc_key_id_t key,
4371 psa_algorithm_t alg,
4372 const uint8_t *nonce,
4373 size_t nonce_length,
4374 const uint8_t *additional_data,
4375 size_t additional_data_length,
4376 const uint8_t *plaintext,
4377 size_t plaintext_length,
4378 uint8_t *ciphertext,
4379 size_t ciphertext_size,
4380 size_t *ciphertext_length)
mohammad16035955c982018-04-26 00:53:03 +03004381{
Ronald Cron215633c2021-03-16 17:15:37 +01004382 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4383 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02004384
mohammad1603f08a5502018-06-03 15:05:47 +03004385 *ciphertext_length = 0;
mohammad1603e58e6842018-05-09 04:58:32 -07004386
Gilles Peskine449bd832023-01-11 14:50:10 +01004387 status = psa_aead_check_algorithm(alg);
4388 if (status != PSA_SUCCESS) {
4389 return status;
4390 }
Steven Cooremanea7ab132021-03-17 16:28:00 +01004391
Ronald Cron9a986162021-03-26 12:40:07 +01004392 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01004393 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg);
4394 if (status != PSA_SUCCESS) {
4395 return status;
4396 }
mohammad16035955c982018-04-26 00:53:03 +03004397
Ronald Cron215633c2021-03-16 17:15:37 +01004398 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01004399 .core = slot->attr
Ronald Cron215633c2021-03-16 17:15:37 +01004400 };
mohammad16035955c982018-04-26 00:53:03 +03004401
Gilles Peskine449bd832023-01-11 14:50:10 +01004402 status = psa_aead_check_nonce_length(alg, nonce_length);
4403 if (status != PSA_SUCCESS) {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004404 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004405 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004406
Ronald Cronde822812021-03-17 16:08:20 +01004407 status = psa_driver_wrapper_aead_encrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01004408 &attributes, slot->key.data, slot->key.bytes,
4409 alg,
4410 nonce, nonce_length,
4411 additional_data, additional_data_length,
4412 plaintext, plaintext_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004413 ciphertext, ciphertext_size, ciphertext_length);
Gilles Peskine2d277862018-06-18 15:41:12 +02004414
Gilles Peskine449bd832023-01-11 14:50:10 +01004415 if (status != PSA_SUCCESS && ciphertext_size != 0) {
4416 memset(ciphertext, 0, ciphertext_size);
4417 }
Gilles Peskine2d277862018-06-18 15:41:12 +02004418
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004419exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00004420 psa_unregister_read(slot);
mohammad16035955c982018-04-26 00:53:03 +03004421
Gilles Peskine449bd832023-01-11 14:50:10 +01004422 return status;
Gilles Peskineee652a32018-06-01 19:23:52 +02004423}
4424
Gilles Peskine449bd832023-01-11 14:50:10 +01004425psa_status_t psa_aead_decrypt(mbedtls_svc_key_id_t key,
4426 psa_algorithm_t alg,
4427 const uint8_t *nonce,
4428 size_t nonce_length,
4429 const uint8_t *additional_data,
4430 size_t additional_data_length,
4431 const uint8_t *ciphertext,
4432 size_t ciphertext_length,
4433 uint8_t *plaintext,
4434 size_t plaintext_size,
4435 size_t *plaintext_length)
mohammad16035955c982018-04-26 00:53:03 +03004436{
Ronald Cron215633c2021-03-16 17:15:37 +01004437 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4438 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02004439
Gilles Peskineee652a32018-06-01 19:23:52 +02004440 *plaintext_length = 0;
mohammad16039e5a5152018-04-26 12:07:35 +03004441
Gilles Peskine449bd832023-01-11 14:50:10 +01004442 status = psa_aead_check_algorithm(alg);
4443 if (status != PSA_SUCCESS) {
4444 return status;
4445 }
Steven Cooremanea7ab132021-03-17 16:28:00 +01004446
Ronald Cron9a986162021-03-26 12:40:07 +01004447 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01004448 key, &slot, PSA_KEY_USAGE_DECRYPT, alg);
4449 if (status != PSA_SUCCESS) {
4450 return status;
4451 }
mohammad16035955c982018-04-26 00:53:03 +03004452
Ronald Cron215633c2021-03-16 17:15:37 +01004453 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01004454 .core = slot->attr
Ronald Cron215633c2021-03-16 17:15:37 +01004455 };
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004456
Gilles Peskine449bd832023-01-11 14:50:10 +01004457 status = psa_aead_check_nonce_length(alg, nonce_length);
4458 if (status != PSA_SUCCESS) {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004459 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004460 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004461
Ronald Cronde822812021-03-17 16:08:20 +01004462 status = psa_driver_wrapper_aead_decrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01004463 &attributes, slot->key.data, slot->key.bytes,
4464 alg,
4465 nonce, nonce_length,
4466 additional_data, additional_data_length,
4467 ciphertext, ciphertext_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004468 plaintext, plaintext_size, plaintext_length);
Gilles Peskinea40d7742018-06-01 16:28:30 +02004469
Gilles Peskine449bd832023-01-11 14:50:10 +01004470 if (status != PSA_SUCCESS && plaintext_size != 0) {
4471 memset(plaintext, 0, plaintext_size);
4472 }
mohammad160360a64d02018-06-03 17:20:42 +03004473
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004474exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00004475 psa_unregister_read(slot);
Ronald Cron215633c2021-03-16 17:15:37 +01004476
Gilles Peskine449bd832023-01-11 14:50:10 +01004477 return status;
mohammad16035955c982018-04-26 00:53:03 +03004478}
4479
Gilles Peskine449bd832023-01-11 14:50:10 +01004480static psa_status_t psa_validate_tag_length(psa_algorithm_t alg)
4481{
4482 const uint8_t tag_len = PSA_ALG_AEAD_GET_TAG_LENGTH(alg);
Andrzej Kurekf8816012021-12-19 17:00:12 +01004483
Gilles Peskine449bd832023-01-11 14:50:10 +01004484 switch (PSA_ALG_AEAD_WITH_SHORTENED_TAG(alg, 0)) {
Przemek Stekiel86679c72022-10-06 17:06:56 +02004485#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004486 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004487 /* CCM allows the following tag lengths: 4, 6, 8, 10, 12, 14, 16.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004488 if (tag_len < 4 || tag_len > 16 || tag_len % 2) {
4489 return PSA_ERROR_INVALID_ARGUMENT;
4490 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01004491 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02004492#endif /* PSA_WANT_ALG_CCM */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004493
Przemek Stekiel86679c72022-10-06 17:06:56 +02004494#if defined(PSA_WANT_ALG_GCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004495 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_GCM, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004496 /* GCM allows the following tag lengths: 4, 8, 12, 13, 14, 15, 16. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004497 if (tag_len != 4 && tag_len != 8 && (tag_len < 12 || tag_len > 16)) {
4498 return PSA_ERROR_INVALID_ARGUMENT;
4499 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01004500 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02004501#endif /* PSA_WANT_ALG_GCM */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004502
Przemek Stekiel86679c72022-10-06 17:06:56 +02004503#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Gilles Peskine449bd832023-01-11 14:50:10 +01004504 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CHACHA20_POLY1305, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004505 /* We only support the default tag length. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004506 if (tag_len != 16) {
4507 return PSA_ERROR_INVALID_ARGUMENT;
4508 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01004509 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02004510#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004511
4512 default:
4513 (void) tag_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004514 return PSA_ERROR_NOT_SUPPORTED;
Andrzej Kurekf8816012021-12-19 17:00:12 +01004515 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004516 return PSA_SUCCESS;
Andrzej Kurekf8816012021-12-19 17:00:12 +01004517}
4518
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004519/* Set the key for a multipart authenticated operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004520static psa_status_t psa_aead_setup(psa_aead_operation_t *operation,
4521 int is_encrypt,
4522 mbedtls_svc_key_id_t key,
4523 psa_algorithm_t alg)
Paul Elliottc2b71442021-06-24 18:17:52 +01004524{
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004525 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4526 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
4527 psa_key_slot_t *slot = NULL;
4528 psa_key_usage_t key_usage = 0;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004529 psa_key_attributes_t attributes;
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004530
Gilles Peskine449bd832023-01-11 14:50:10 +01004531 status = psa_aead_check_algorithm(alg);
4532 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004533 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004534 }
Paul Elliottc2b71442021-06-24 18:17:52 +01004535
Gilles Peskine449bd832023-01-11 14:50:10 +01004536 if (operation->id != 0) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004537 status = PSA_ERROR_BAD_STATE;
4538 goto exit;
Paul Elliottc2b71442021-06-24 18:17:52 +01004539 }
4540
Gilles Peskine449bd832023-01-11 14:50:10 +01004541 if (operation->nonce_set || operation->lengths_set ||
4542 operation->ad_started || operation->body_started) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004543 status = PSA_ERROR_BAD_STATE;
4544 goto exit;
Paul Elliottc2b71442021-06-24 18:17:52 +01004545 }
4546
Gilles Peskine449bd832023-01-11 14:50:10 +01004547 if (is_encrypt) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004548 key_usage = PSA_KEY_USAGE_ENCRYPT;
Gilles Peskine449bd832023-01-11 14:50:10 +01004549 } else {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004550 key_usage = PSA_KEY_USAGE_DECRYPT;
Gilles Peskine449bd832023-01-11 14:50:10 +01004551 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004552
Gilles Peskine449bd832023-01-11 14:50:10 +01004553 status = psa_get_and_lock_key_slot_with_policy(key, &slot, key_usage,
4554 alg);
4555 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004556 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004557 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004558
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004559 attributes = (psa_key_attributes_t) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004560 .core = slot->attr
4561 };
4562
Gilles Peskine449bd832023-01-11 14:50:10 +01004563 if ((status = psa_validate_tag_length(alg)) != PSA_SUCCESS) {
Przemek Stekiel6ab50762022-10-08 17:54:30 +02004564 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004565 }
Przemek Stekiel6ab50762022-10-08 17:54:30 +02004566
Gilles Peskine449bd832023-01-11 14:50:10 +01004567 if (is_encrypt) {
4568 status = psa_driver_wrapper_aead_encrypt_setup(operation,
4569 &attributes,
4570 slot->key.data,
4571 slot->key.bytes,
4572 alg);
4573 } else {
4574 status = psa_driver_wrapper_aead_decrypt_setup(operation,
4575 &attributes,
4576 slot->key.data,
4577 slot->key.bytes,
4578 alg);
4579 }
4580 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004581 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004582 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004583
Gilles Peskine449bd832023-01-11 14:50:10 +01004584 operation->key_type = psa_get_key_type(&attributes);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004585
4586exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00004587 unlock_status = psa_unregister_read(slot);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004588
Gilles Peskine449bd832023-01-11 14:50:10 +01004589 if (status == PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004590 status = unlock_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01004591 operation->alg = psa_aead_get_base_algorithm(alg);
Paul Elliottd9343f22021-08-23 18:59:49 +01004592 operation->is_encrypt = is_encrypt;
Gilles Peskine449bd832023-01-11 14:50:10 +01004593 } else {
4594 psa_aead_abort(operation);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004595 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004596
Gilles Peskine449bd832023-01-11 14:50:10 +01004597 return status;
Paul Elliottc2b71442021-06-24 18:17:52 +01004598}
4599
Paul Elliott302ff6b2021-04-20 18:10:30 +01004600/* Set the key for a multipart authenticated encryption operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004601psa_status_t psa_aead_encrypt_setup(psa_aead_operation_t *operation,
4602 mbedtls_svc_key_id_t key,
4603 psa_algorithm_t alg)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004604{
Gilles Peskine449bd832023-01-11 14:50:10 +01004605 return psa_aead_setup(operation, 1, key, alg);
Paul Elliott302ff6b2021-04-20 18:10:30 +01004606}
4607
4608/* Set the key for a multipart authenticated decryption operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004609psa_status_t psa_aead_decrypt_setup(psa_aead_operation_t *operation,
4610 mbedtls_svc_key_id_t key,
4611 psa_algorithm_t alg)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004612{
Gilles Peskine449bd832023-01-11 14:50:10 +01004613 return psa_aead_setup(operation, 0, key, alg);
Paul Elliott302ff6b2021-04-20 18:10:30 +01004614}
4615
4616/* Generate a random nonce / IV for multipart AEAD operation */
Gilles Peskine449bd832023-01-11 14:50:10 +01004617psa_status_t psa_aead_generate_nonce(psa_aead_operation_t *operation,
4618 uint8_t *nonce,
4619 size_t nonce_size,
4620 size_t *nonce_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004621{
4622 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Croncae59092021-11-26 18:53:58 +01004623 uint8_t local_nonce[PSA_AEAD_NONCE_MAX_SIZE];
Sergeybef1f632023-03-06 15:25:06 -07004624 size_t required_nonce_size = 0;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004625
Paul Elliott8eb9daf2021-06-04 16:42:21 +01004626 *nonce_length = 0;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004627
Gilles Peskine449bd832023-01-11 14:50:10 +01004628 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004629 status = PSA_ERROR_BAD_STATE;
4630 goto exit;
4631 }
4632
Gilles Peskine449bd832023-01-11 14:50:10 +01004633 if (operation->nonce_set || !operation->is_encrypt) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004634 status = PSA_ERROR_BAD_STATE;
4635 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004636 }
4637
Paul Elliotte193ea82021-10-01 13:00:16 +01004638 /* For CCM, this size may not be correct according to the PSA
4639 * specification. The PSA Crypto 1.0.1 specification states:
4640 *
4641 * CCM encodes the plaintext length pLen in L octets, with L the smallest
4642 * integer >= 2 where pLen < 2^(8L). The nonce length is then 15 - L bytes.
4643 *
4644 * However this restriction that L has to be the smallest integer is not
4645 * applied in practice, and it is not implementable here since the
4646 * plaintext length may or may not be known at this time. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004647 required_nonce_size = PSA_AEAD_NONCE_LENGTH(operation->key_type,
4648 operation->alg);
4649 if (nonce_size < required_nonce_size) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004650 status = PSA_ERROR_BUFFER_TOO_SMALL;
4651 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004652 }
4653
Gilles Peskine449bd832023-01-11 14:50:10 +01004654 status = psa_generate_random(local_nonce, required_nonce_size);
4655 if (status != PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004656 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004657 }
Paul Elliott302ff6b2021-04-20 18:10:30 +01004658
Gilles Peskine449bd832023-01-11 14:50:10 +01004659 status = psa_aead_set_nonce(operation, local_nonce, required_nonce_size);
Paul Elliott302ff6b2021-04-20 18:10:30 +01004660
Paul Elliott39dc6b82021-05-11 19:16:09 +01004661exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004662 if (status == PSA_SUCCESS) {
4663 memcpy(nonce, local_nonce, required_nonce_size);
Paul Elliott39dc6b82021-05-11 19:16:09 +01004664 *nonce_length = required_nonce_size;
Gilles Peskine449bd832023-01-11 14:50:10 +01004665 } else {
4666 psa_aead_abort(operation);
Ronald Croncae59092021-11-26 18:53:58 +01004667 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01004668
Gilles Peskine449bd832023-01-11 14:50:10 +01004669 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004670}
4671
4672/* Set the nonce for a multipart authenticated encryption or decryption
4673 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004674psa_status_t psa_aead_set_nonce(psa_aead_operation_t *operation,
4675 const uint8_t *nonce,
4676 size_t nonce_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004677{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004678 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4679
Gilles Peskine449bd832023-01-11 14:50:10 +01004680 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004681 status = PSA_ERROR_BAD_STATE;
4682 goto exit;
4683 }
4684
Gilles Peskine449bd832023-01-11 14:50:10 +01004685 if (operation->nonce_set) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004686 status = PSA_ERROR_BAD_STATE;
4687 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004688 }
4689
Gilles Peskine449bd832023-01-11 14:50:10 +01004690 status = psa_aead_check_nonce_length(operation->alg, nonce_length);
4691 if (status != PSA_SUCCESS) {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004692 status = PSA_ERROR_INVALID_ARGUMENT;
4693 goto exit;
Paul Elliott4ed1ed12021-09-27 18:09:28 +01004694 }
Paul Elliott1a98aca2021-05-20 18:24:07 +01004695
Gilles Peskine449bd832023-01-11 14:50:10 +01004696 status = psa_driver_wrapper_aead_set_nonce(operation, nonce,
4697 nonce_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004698
Paul Elliott39dc6b82021-05-11 19:16:09 +01004699exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004700 if (status == PSA_SUCCESS) {
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004701 operation->nonce_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004702 } else {
4703 psa_aead_abort(operation);
4704 }
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004705
Gilles Peskine449bd832023-01-11 14:50:10 +01004706 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004707}
4708
4709/* Declare the lengths of the message and additional data for multipart AEAD. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004710psa_status_t psa_aead_set_lengths(psa_aead_operation_t *operation,
4711 size_t ad_length,
4712 size_t plaintext_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004713{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004714 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4715
Gilles Peskine449bd832023-01-11 14:50:10 +01004716 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004717 status = PSA_ERROR_BAD_STATE;
4718 goto exit;
4719 }
4720
Gilles Peskine449bd832023-01-11 14:50:10 +01004721 if (operation->lengths_set || operation->ad_started ||
4722 operation->body_started) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004723 status = PSA_ERROR_BAD_STATE;
4724 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004725 }
4726
Gilles Peskine449bd832023-01-11 14:50:10 +01004727 switch (operation->alg) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004728#if defined(PSA_WANT_ALG_GCM)
4729 case PSA_ALG_GCM:
4730 /* Lengths can only be too large for GCM if size_t is bigger than 32
Gilles Peskine449bd832023-01-11 14:50:10 +01004731 * bits. Without the guard this code will generate warnings on 32bit
4732 * builds. */
Paul Elliott325d3742021-09-27 17:56:28 +01004733#if SIZE_MAX > UINT32_MAX
Gilles Peskine449bd832023-01-11 14:50:10 +01004734 if (((uint64_t) ad_length) >> 61 != 0 ||
4735 ((uint64_t) plaintext_length) > 0xFFFFFFFE0ull) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004736 status = PSA_ERROR_INVALID_ARGUMENT;
4737 goto exit;
4738 }
Paul Elliott325d3742021-09-27 17:56:28 +01004739#endif
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004740 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004741#endif /* PSA_WANT_ALG_GCM */
4742#if defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004743 case PSA_ALG_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01004744 if (ad_length > 0xFF00) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004745 status = PSA_ERROR_INVALID_ARGUMENT;
4746 goto exit;
4747 }
4748 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004749#endif /* PSA_WANT_ALG_CCM */
4750#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004751 case PSA_ALG_CHACHA20_POLY1305:
4752 /* No length restrictions for ChaChaPoly. */
4753 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004754#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004755 default:
4756 break;
4757 }
Paul Elliott325d3742021-09-27 17:56:28 +01004758
Gilles Peskine449bd832023-01-11 14:50:10 +01004759 status = psa_driver_wrapper_aead_set_lengths(operation, ad_length,
4760 plaintext_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004761
Paul Elliott39dc6b82021-05-11 19:16:09 +01004762exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004763 if (status == PSA_SUCCESS) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01004764 operation->ad_remaining = ad_length;
4765 operation->body_remaining = plaintext_length;
Paul Elliott39dc6b82021-05-11 19:16:09 +01004766 operation->lengths_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004767 } else {
4768 psa_aead_abort(operation);
Paul Elliottee4ffe02021-05-20 17:25:06 +01004769 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01004770
Gilles Peskine449bd832023-01-11 14:50:10 +01004771 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004772}
Paul Elliott3d7d52c2021-09-01 10:33:14 +01004773
4774/* Pass additional data to an active multipart AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004775psa_status_t psa_aead_update_ad(psa_aead_operation_t *operation,
4776 const uint8_t *input,
4777 size_t input_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004778{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004779 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4780
Gilles Peskine449bd832023-01-11 14:50:10 +01004781 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004782 status = PSA_ERROR_BAD_STATE;
4783 goto exit;
4784 }
4785
Gilles Peskine449bd832023-01-11 14:50:10 +01004786 if (!operation->nonce_set || operation->body_started) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004787 status = PSA_ERROR_BAD_STATE;
4788 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004789 }
4790
Gilles Peskine449bd832023-01-11 14:50:10 +01004791 if (operation->lengths_set) {
4792 if (operation->ad_remaining < input_length) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01004793 status = PSA_ERROR_INVALID_ARGUMENT;
4794 goto exit;
4795 }
4796
4797 operation->ad_remaining -= input_length;
4798 }
Paul Elliotte193ea82021-10-01 13:00:16 +01004799#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004800 else if (operation->alg == PSA_ALG_CCM) {
Paul Elliotte193ea82021-10-01 13:00:16 +01004801 status = PSA_ERROR_BAD_STATE;
4802 goto exit;
4803 }
4804#endif /* PSA_WANT_ALG_CCM */
Paul Elliottee4ffe02021-05-20 17:25:06 +01004805
Gilles Peskine449bd832023-01-11 14:50:10 +01004806 status = psa_driver_wrapper_aead_update_ad(operation, input,
4807 input_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004808
Paul Elliott39dc6b82021-05-11 19:16:09 +01004809exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004810 if (status == PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004811 operation->ad_started = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004812 } else {
4813 psa_aead_abort(operation);
4814 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01004815
Gilles Peskine449bd832023-01-11 14:50:10 +01004816 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004817}
4818
4819/* Encrypt or decrypt a message fragment in an active multipart AEAD
4820 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004821psa_status_t psa_aead_update(psa_aead_operation_t *operation,
4822 const uint8_t *input,
4823 size_t input_length,
4824 uint8_t *output,
4825 size_t output_size,
4826 size_t *output_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004827{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004828 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004829
4830 *output_length = 0;
4831
Gilles Peskine449bd832023-01-11 14:50:10 +01004832 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004833 status = PSA_ERROR_BAD_STATE;
4834 goto exit;
4835 }
4836
Gilles Peskine449bd832023-01-11 14:50:10 +01004837 if (!operation->nonce_set) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004838 status = PSA_ERROR_BAD_STATE;
4839 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004840 }
4841
Gilles Peskine449bd832023-01-11 14:50:10 +01004842 if (operation->lengths_set) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01004843 /* Additional data length was supplied, but not all the additional
4844 data was supplied.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004845 if (operation->ad_remaining != 0) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01004846 status = PSA_ERROR_INVALID_ARGUMENT;
4847 goto exit;
4848 }
4849
4850 /* Too much data provided. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004851 if (operation->body_remaining < input_length) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01004852 status = PSA_ERROR_INVALID_ARGUMENT;
4853 goto exit;
4854 }
4855
4856 operation->body_remaining -= input_length;
4857 }
Paul Elliotte193ea82021-10-01 13:00:16 +01004858#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004859 else if (operation->alg == PSA_ALG_CCM) {
Paul Elliotte193ea82021-10-01 13:00:16 +01004860 status = PSA_ERROR_BAD_STATE;
4861 goto exit;
4862 }
4863#endif /* PSA_WANT_ALG_CCM */
Paul Elliottee4ffe02021-05-20 17:25:06 +01004864
Gilles Peskine449bd832023-01-11 14:50:10 +01004865 status = psa_driver_wrapper_aead_update(operation, input, input_length,
4866 output, output_size,
4867 output_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004868
Paul Elliott39dc6b82021-05-11 19:16:09 +01004869exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004870 if (status == PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004871 operation->body_started = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004872 } else {
4873 psa_aead_abort(operation);
4874 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01004875
Gilles Peskine449bd832023-01-11 14:50:10 +01004876 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004877}
4878
Gilles Peskine449bd832023-01-11 14:50:10 +01004879static psa_status_t psa_aead_final_checks(const psa_aead_operation_t *operation)
Paul Elliottad53dcc2021-06-23 08:50:14 +01004880{
Gilles Peskine449bd832023-01-11 14:50:10 +01004881 if (operation->id == 0 || !operation->nonce_set) {
4882 return PSA_ERROR_BAD_STATE;
4883 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01004884
Gilles Peskine449bd832023-01-11 14:50:10 +01004885 if (operation->lengths_set && (operation->ad_remaining != 0 ||
4886 operation->body_remaining != 0)) {
4887 return PSA_ERROR_INVALID_ARGUMENT;
4888 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01004889
Gilles Peskine449bd832023-01-11 14:50:10 +01004890 return PSA_SUCCESS;
Paul Elliottad53dcc2021-06-23 08:50:14 +01004891}
4892
Paul Elliott302ff6b2021-04-20 18:10:30 +01004893/* Finish encrypting a message in a multipart AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004894psa_status_t psa_aead_finish(psa_aead_operation_t *operation,
4895 uint8_t *ciphertext,
4896 size_t ciphertext_size,
4897 size_t *ciphertext_length,
4898 uint8_t *tag,
4899 size_t tag_size,
4900 size_t *tag_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004901{
Paul Elliott39dc6b82021-05-11 19:16:09 +01004902 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4903
Paul Elliott302ff6b2021-04-20 18:10:30 +01004904 *ciphertext_length = 0;
Paul Elliottf88a5652021-06-22 17:53:45 +01004905 *tag_length = tag_size;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004906
Gilles Peskine449bd832023-01-11 14:50:10 +01004907 status = psa_aead_final_checks(operation);
4908 if (status != PSA_SUCCESS) {
Paul Elliottad53dcc2021-06-23 08:50:14 +01004909 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004910 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01004911
Gilles Peskine449bd832023-01-11 14:50:10 +01004912 if (!operation->is_encrypt) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004913 status = PSA_ERROR_BAD_STATE;
4914 goto exit;
4915 }
4916
Gilles Peskine449bd832023-01-11 14:50:10 +01004917 status = psa_driver_wrapper_aead_finish(operation, ciphertext,
4918 ciphertext_size,
4919 ciphertext_length,
4920 tag, tag_size, tag_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004921
Paul Elliott39dc6b82021-05-11 19:16:09 +01004922exit:
Paul Elliottdc42ca82023-02-24 18:11:59 +00004923
4924
Paul Elliottf47b0952021-05-21 18:02:33 +01004925 /* In case the operation fails and the user fails to check for failure or
Paul Elliott4c916e82021-09-19 18:34:50 +01004926 * the zero tag size, make sure the tag is set to something implausible.
4927 * Even if the operation succeeds, make sure we clear the rest of the
4928 * buffer to prevent potential leakage of anything previously placed in
4929 * the same buffer.*/
Paul Elliottdc42ca82023-02-24 18:11:59 +00004930 psa_wipe_tag_output_buffer(tag, status, tag_size, *tag_length);
Paul Elliottf47b0952021-05-21 18:02:33 +01004931
Gilles Peskine449bd832023-01-11 14:50:10 +01004932 psa_aead_abort(operation);
Paul Elliott39dc6b82021-05-11 19:16:09 +01004933
Gilles Peskine449bd832023-01-11 14:50:10 +01004934 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004935}
4936
4937/* Finish authenticating and decrypting a message in a multipart AEAD
4938 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004939psa_status_t psa_aead_verify(psa_aead_operation_t *operation,
4940 uint8_t *plaintext,
4941 size_t plaintext_size,
4942 size_t *plaintext_length,
4943 const uint8_t *tag,
4944 size_t tag_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004945{
Paul Elliott39dc6b82021-05-11 19:16:09 +01004946 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4947
Paul Elliott302ff6b2021-04-20 18:10:30 +01004948 *plaintext_length = 0;
4949
Gilles Peskine449bd832023-01-11 14:50:10 +01004950 status = psa_aead_final_checks(operation);
4951 if (status != PSA_SUCCESS) {
Paul Elliottad53dcc2021-06-23 08:50:14 +01004952 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004953 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01004954
Gilles Peskine449bd832023-01-11 14:50:10 +01004955 if (operation->is_encrypt) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004956 status = PSA_ERROR_BAD_STATE;
4957 goto exit;
4958 }
4959
Gilles Peskine449bd832023-01-11 14:50:10 +01004960 status = psa_driver_wrapper_aead_verify(operation, plaintext,
4961 plaintext_size,
4962 plaintext_length,
4963 tag, tag_length);
Paul Elliott39dc6b82021-05-11 19:16:09 +01004964
4965exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004966 psa_aead_abort(operation);
Paul Elliott39dc6b82021-05-11 19:16:09 +01004967
Gilles Peskine449bd832023-01-11 14:50:10 +01004968 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004969}
4970
4971/* Abort an AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004972psa_status_t psa_aead_abort(psa_aead_operation_t *operation)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004973{
4974 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4975
Gilles Peskine449bd832023-01-11 14:50:10 +01004976 if (operation->id == 0) {
Paul Elliott302ff6b2021-04-20 18:10:30 +01004977 /* The object has (apparently) been initialized but it is not (yet)
4978 * in use. It's ok to call abort on such an object, and there's
4979 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004980 return PSA_SUCCESS;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004981 }
4982
Gilles Peskine449bd832023-01-11 14:50:10 +01004983 status = psa_driver_wrapper_aead_abort(operation);
Paul Elliott302ff6b2021-04-20 18:10:30 +01004984
Gilles Peskine449bd832023-01-11 14:50:10 +01004985 memset(operation, 0, sizeof(*operation));
Paul Elliott302ff6b2021-04-20 18:10:30 +01004986
Gilles Peskine449bd832023-01-11 14:50:10 +01004987 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004988}
4989
Gilles Peskinee59236f2018-01-27 23:32:46 +01004990/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02004991/* Generators */
4992/****************************************************************/
4993
Przemek Stekiel69c46792022-06-10 12:59:51 +02004994#if defined(BUILTIN_ALG_ANY_HKDF) || \
John Durkop07cc04a2020-11-16 22:08:34 -08004995 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
Andrzej Kurek08d34b82022-07-29 10:00:16 -04004996 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) || \
Kusumit Ghoderaoaf0b5342023-05-03 11:58:46 +05304997 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS) || \
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05304998 defined(PSA_HAVE_SOFT_PBKDF2)
John Durkop07cc04a2020-11-16 22:08:34 -08004999#define AT_LEAST_ONE_BUILTIN_KDF
Steven Cooreman094a77e2021-05-06 17:58:36 +02005000#endif /* At least one builtin KDF */
5001
Przemek Stekiel69c46792022-06-10 12:59:51 +02005002#if defined(BUILTIN_ALG_ANY_HKDF) || \
Steven Cooreman094a77e2021-05-06 17:58:36 +02005003 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5004 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
5005static psa_status_t psa_key_derivation_start_hmac(
5006 psa_mac_operation_t *operation,
5007 psa_algorithm_t hash_alg,
5008 const uint8_t *hmac_key,
Gilles Peskine449bd832023-01-11 14:50:10 +01005009 size_t hmac_key_length)
Steven Cooreman094a77e2021-05-06 17:58:36 +02005010{
5011 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5012 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01005013 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
5014 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(hmac_key_length));
5015 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_HASH);
Steven Cooreman094a77e2021-05-06 17:58:36 +02005016
Steven Cooreman72f736a2021-05-07 14:14:37 +02005017 operation->is_sign = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005018 operation->mac_size = PSA_HASH_LENGTH(hash_alg);
Steven Cooreman72f736a2021-05-07 14:14:37 +02005019
Gilles Peskine449bd832023-01-11 14:50:10 +01005020 status = psa_driver_wrapper_mac_sign_setup(operation,
5021 &attributes,
5022 hmac_key, hmac_key_length,
5023 PSA_ALG_HMAC(hash_alg));
Steven Cooreman094a77e2021-05-06 17:58:36 +02005024
Gilles Peskine449bd832023-01-11 14:50:10 +01005025 psa_reset_key_attributes(&attributes);
5026 return status;
Steven Cooreman094a77e2021-05-06 17:58:36 +02005027}
5028#endif /* KDF algorithms reliant on HMAC */
John Durkop07cc04a2020-11-16 22:08:34 -08005029
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005030#define HKDF_STATE_INIT 0 /* no input yet */
5031#define HKDF_STATE_STARTED 1 /* got salt */
5032#define HKDF_STATE_KEYED 2 /* got key */
5033#define HKDF_STATE_OUTPUT 3 /* output started */
5034
Gilles Peskinecbe66502019-05-16 16:59:18 +02005035static psa_algorithm_t psa_key_derivation_get_kdf_alg(
Gilles Peskine449bd832023-01-11 14:50:10 +01005036 const psa_key_derivation_operation_t *operation)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005037{
Gilles Peskine449bd832023-01-11 14:50:10 +01005038 if (PSA_ALG_IS_KEY_AGREEMENT(operation->alg)) {
5039 return PSA_ALG_KEY_AGREEMENT_GET_KDF(operation->alg);
5040 } else {
5041 return operation->alg;
5042 }
Gilles Peskine969c5d62019-01-16 15:53:06 +01005043}
5044
Gilles Peskine449bd832023-01-11 14:50:10 +01005045psa_status_t psa_key_derivation_abort(psa_key_derivation_operation_t *operation)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005046{
5047 psa_status_t status = PSA_SUCCESS;
Gilles Peskine449bd832023-01-11 14:50:10 +01005048 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
5049 if (kdf_alg == 0) {
Gilles Peskineeab56e42018-07-12 17:12:33 +02005050 /* The object has (apparently) been initialized but it is not
5051 * in use. It's ok to call abort on such an object, and there's
5052 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005053 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02005054#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01005055 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
5056 mbedtls_free(operation->ctx.hkdf.info);
5057 status = psa_mac_abort(&operation->ctx.hkdf.hmac);
5058 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02005059#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08005060#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5061 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005062 if (PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
5063 /* TLS-1.2 PSK-to-MS KDF uses the same core as TLS-1.2 PRF */
5064 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
5065 if (operation->ctx.tls12_prf.secret != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005066 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.secret,
Gilles Peskine449bd832023-01-11 14:50:10 +01005067 operation->ctx.tls12_prf.secret_length);
Steven Cooremana6df6042021-04-29 19:32:25 +02005068 }
5069
Gilles Peskine449bd832023-01-11 14:50:10 +01005070 if (operation->ctx.tls12_prf.seed != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005071 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.seed,
Gilles Peskine449bd832023-01-11 14:50:10 +01005072 operation->ctx.tls12_prf.seed_length);
Janos Follath6a1d2622019-06-11 10:37:28 +01005073 }
5074
Gilles Peskine449bd832023-01-11 14:50:10 +01005075 if (operation->ctx.tls12_prf.label != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005076 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.label,
Gilles Peskine449bd832023-01-11 14:50:10 +01005077 operation->ctx.tls12_prf.label_length);
Janos Follath6a1d2622019-06-11 10:37:28 +01005078 }
Przemek Stekiel6c764412022-11-22 14:05:12 +01005079#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005080 if (operation->ctx.tls12_prf.other_secret != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005081 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.other_secret,
Gilles Peskine449bd832023-01-11 14:50:10 +01005082 operation->ctx.tls12_prf.other_secret_length);
Przemek Stekiele3ee2212022-04-07 14:29:56 +02005083 }
Przemek Stekiel6c764412022-11-22 14:05:12 +01005084#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Steven Cooremana6df6042021-04-29 19:32:25 +02005085 status = PSA_SUCCESS;
Janos Follath6a1d2622019-06-11 10:37:28 +01005086
5087 /* We leave the fields Ai and output_block to be erased safely by the
5088 * mbedtls_platform_zeroize() in the end of this function. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005089 } else
John Durkop07cc04a2020-11-16 22:08:34 -08005090#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
5091 * defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005092#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005093 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
5094 mbedtls_platform_zeroize(operation->ctx.tls12_ecjpake_to_pms.data,
5095 sizeof(operation->ctx.tls12_ecjpake_to_pms.data));
5096 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005097#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS) */
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305098#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05305099 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305100 if (operation->ctx.pbkdf2.salt != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005101 mbedtls_zeroize_and_free(operation->ctx.pbkdf2.salt,
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305102 operation->ctx.pbkdf2.salt_length);
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305103 }
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305104
5105 status = PSA_SUCCESS;
5106 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305107#endif /* defined(PSA_HAVE_SOFT_PBKDF2) */
Gilles Peskineeab56e42018-07-12 17:12:33 +02005108 {
5109 status = PSA_ERROR_BAD_STATE;
5110 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005111 mbedtls_platform_zeroize(operation, sizeof(*operation));
5112 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005113}
5114
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005115psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskine449bd832023-01-11 14:50:10 +01005116 size_t *capacity)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005117{
Gilles Peskine449bd832023-01-11 14:50:10 +01005118 if (operation->alg == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005119 /* This is a blank key derivation operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005120 return PSA_ERROR_BAD_STATE;
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005121 }
5122
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005123 *capacity = operation->capacity;
Gilles Peskine449bd832023-01-11 14:50:10 +01005124 return PSA_SUCCESS;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005125}
5126
Gilles Peskine449bd832023-01-11 14:50:10 +01005127psa_status_t psa_key_derivation_set_capacity(psa_key_derivation_operation_t *operation,
5128 size_t capacity)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005129{
Gilles Peskine449bd832023-01-11 14:50:10 +01005130 if (operation->alg == 0) {
5131 return PSA_ERROR_BAD_STATE;
5132 }
5133 if (capacity > operation->capacity) {
5134 return PSA_ERROR_INVALID_ARGUMENT;
5135 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005136 operation->capacity = capacity;
Gilles Peskine449bd832023-01-11 14:50:10 +01005137 return PSA_SUCCESS;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005138}
5139
Przemek Stekiel69c46792022-06-10 12:59:51 +02005140#if defined(BUILTIN_ALG_ANY_HKDF)
Przemek Stekiel03d948c2022-05-19 11:45:20 +02005141/* Read some bytes from an HKDF-based operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005142static psa_status_t psa_key_derivation_hkdf_read(psa_hkdf_key_derivation_t *hkdf,
5143 psa_algorithm_t kdf_alg,
5144 uint8_t *output,
5145 size_t output_length)
Gilles Peskinebef7f142018-07-12 17:22:21 +02005146{
Gilles Peskine449bd832023-01-11 14:50:10 +01005147 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
5148 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Steven Cooremand1ed1d92021-04-29 19:11:25 +02005149 size_t hmac_output_length;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005150 psa_status_t status;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005151#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01005152 const uint8_t last_block = PSA_ALG_IS_HKDF_EXTRACT(kdf_alg) ? 0 : 0xff;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005153#else
5154 const uint8_t last_block = 0xff;
5155#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskinebef7f142018-07-12 17:22:21 +02005156
Gilles Peskine449bd832023-01-11 14:50:10 +01005157 if (hkdf->state < HKDF_STATE_KEYED ||
5158 (!hkdf->info_set
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005159#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01005160 && !PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005161#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01005162 )) {
5163 return PSA_ERROR_BAD_STATE;
5164 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005165 hkdf->state = HKDF_STATE_OUTPUT;
5166
Gilles Peskine449bd832023-01-11 14:50:10 +01005167 while (output_length != 0) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005168 /* Copy what remains of the current block */
5169 uint8_t n = hash_length - hkdf->offset_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005170 if (n > output_length) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005171 n = (uint8_t) output_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01005172 }
5173 memcpy(output, hkdf->output_block + hkdf->offset_in_block, n);
Gilles Peskinebef7f142018-07-12 17:22:21 +02005174 output += n;
5175 output_length -= n;
5176 hkdf->offset_in_block += n;
Gilles Peskine449bd832023-01-11 14:50:10 +01005177 if (output_length == 0) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005178 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01005179 }
Przemek Stekiel03d948c2022-05-19 11:45:20 +02005180 /* We can't be wanting more output after the last block, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005181 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005182 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02005183 * object was corrupted or if this function is called directly
5184 * inside the library. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005185 if (hkdf->block_number == last_block) {
5186 return PSA_ERROR_BAD_STATE;
5187 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02005188
5189 /* We need a new block */
5190 ++hkdf->block_number;
5191 hkdf->offset_in_block = 0;
Steven Cooremand1ed1d92021-04-29 19:11:25 +02005192
Gilles Peskine449bd832023-01-11 14:50:10 +01005193 status = psa_key_derivation_start_hmac(&hkdf->hmac,
5194 hash_alg,
5195 hkdf->prk,
5196 hash_length);
5197 if (status != PSA_SUCCESS) {
5198 return status;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005199 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005200
5201 if (hkdf->block_number != 1) {
5202 status = psa_mac_update(&hkdf->hmac,
5203 hkdf->output_block,
5204 hash_length);
5205 if (status != PSA_SUCCESS) {
5206 return status;
5207 }
5208 }
5209 status = psa_mac_update(&hkdf->hmac,
5210 hkdf->info,
5211 hkdf->info_length);
5212 if (status != PSA_SUCCESS) {
5213 return status;
5214 }
5215 status = psa_mac_update(&hkdf->hmac,
5216 &hkdf->block_number, 1);
5217 if (status != PSA_SUCCESS) {
5218 return status;
5219 }
5220 status = psa_mac_sign_finish(&hkdf->hmac,
5221 hkdf->output_block,
5222 sizeof(hkdf->output_block),
5223 &hmac_output_length);
5224 if (status != PSA_SUCCESS) {
5225 return status;
5226 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02005227 }
5228
Gilles Peskine449bd832023-01-11 14:50:10 +01005229 return PSA_SUCCESS;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005230}
Przemek Stekiel69c46792022-06-10 12:59:51 +02005231#endif /* BUILTIN_ALG_ANY_HKDF */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005232
John Durkop07cc04a2020-11-16 22:08:34 -08005233#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5234 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follath7742fee2019-06-17 12:58:10 +01005235static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
5236 psa_tls12_prf_key_derivation_t *tls12_prf,
Gilles Peskine449bd832023-01-11 14:50:10 +01005237 psa_algorithm_t alg)
Janos Follath7742fee2019-06-17 12:58:10 +01005238{
Gilles Peskine449bd832023-01-11 14:50:10 +01005239 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(alg);
5240 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Steven Cooremana6df6042021-04-29 19:32:25 +02005241 psa_mac_operation_t hmac = PSA_MAC_OPERATION_INIT;
5242 size_t hmac_output_length;
Janos Follathea29bfb2019-06-19 12:21:20 +01005243 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005244
Janos Follath7742fee2019-06-17 12:58:10 +01005245 /* We can't be wanting more output after block 0xff, otherwise
5246 * the capacity check in psa_key_derivation_output_bytes() would have
5247 * prevented this call. It could happen only if the operation
5248 * object was corrupted or if this function is called directly
5249 * inside the library. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005250 if (tls12_prf->block_number == 0xff) {
5251 return PSA_ERROR_CORRUPTION_DETECTED;
5252 }
Janos Follath7742fee2019-06-17 12:58:10 +01005253
5254 /* We need a new block */
5255 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01005256 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01005257
5258 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
5259 *
5260 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
5261 *
5262 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
5263 * HMAC_hash(secret, A(2) + seed) +
5264 * HMAC_hash(secret, A(3) + seed) + ...
5265 *
5266 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01005267 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01005268 *
Janos Follathea29bfb2019-06-19 12:21:20 +01005269 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01005270 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01005271 * is currently extracted as `output_block` and where i is
5272 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01005273 */
5274
Gilles Peskine449bd832023-01-11 14:50:10 +01005275 status = psa_key_derivation_start_hmac(&hmac,
5276 hash_alg,
5277 tls12_prf->secret,
5278 tls12_prf->secret_length);
5279 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005280 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005281 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005282
5283 /* Calculate A(i) where i = tls12_prf->block_number. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005284 if (tls12_prf->block_number == 1) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005285 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
5286 * the variable seed and in this instance means it in the context of the
5287 * P_hash function, where seed = label + seed.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01005288 status = psa_mac_update(&hmac,
5289 tls12_prf->label,
5290 tls12_prf->label_length);
5291 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005292 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005293 }
5294 status = psa_mac_update(&hmac,
5295 tls12_prf->seed,
5296 tls12_prf->seed_length);
5297 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005298 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005299 }
5300 } else {
Janos Follathea29bfb2019-06-19 12:21:20 +01005301 /* A(i) = HMAC_hash(secret, A(i-1)) */
Gilles Peskine449bd832023-01-11 14:50:10 +01005302 status = psa_mac_update(&hmac, tls12_prf->Ai, hash_length);
5303 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005304 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005305 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005306 }
5307
Gilles Peskine449bd832023-01-11 14:50:10 +01005308 status = psa_mac_sign_finish(&hmac,
5309 tls12_prf->Ai, hash_length,
5310 &hmac_output_length);
5311 if (hmac_output_length != hash_length) {
Steven Cooremana6df6042021-04-29 19:32:25 +02005312 status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01005313 }
5314 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005315 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005316 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005317
5318 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
Gilles Peskine449bd832023-01-11 14:50:10 +01005319 status = psa_key_derivation_start_hmac(&hmac,
5320 hash_alg,
5321 tls12_prf->secret,
5322 tls12_prf->secret_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->Ai, hash_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->label, tls12_prf->label_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_update(&hmac, tls12_prf->seed, tls12_prf->seed_length);
5335 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005336 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005337 }
5338 status = psa_mac_sign_finish(&hmac,
5339 tls12_prf->output_block, hash_length,
5340 &hmac_output_length);
5341 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005342 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005343 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005344
Janos Follath7742fee2019-06-17 12:58:10 +01005345
5346cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01005347 cleanup_status = psa_mac_abort(&hmac);
5348 if (status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005349 status = cleanup_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01005350 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005351
Gilles Peskine449bd832023-01-11 14:50:10 +01005352 return status;
Janos Follath7742fee2019-06-17 12:58:10 +01005353}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005354
Janos Follath844eb0e2019-06-19 12:10:49 +01005355static psa_status_t psa_key_derivation_tls12_prf_read(
5356 psa_tls12_prf_key_derivation_t *tls12_prf,
5357 psa_algorithm_t alg,
5358 uint8_t *output,
Gilles Peskine449bd832023-01-11 14:50:10 +01005359 size_t output_length)
Janos Follath844eb0e2019-06-19 12:10:49 +01005360{
Gilles Peskine449bd832023-01-11 14:50:10 +01005361 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH(alg);
5362 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Janos Follath844eb0e2019-06-19 12:10:49 +01005363 psa_status_t status;
5364 uint8_t offset, length;
5365
Gilles Peskine449bd832023-01-11 14:50:10 +01005366 switch (tls12_prf->state) {
Gilles Peskineb1edaec2021-06-11 22:41:46 +02005367 case PSA_TLS12_PRF_STATE_LABEL_SET:
5368 tls12_prf->state = PSA_TLS12_PRF_STATE_OUTPUT;
5369 break;
5370 case PSA_TLS12_PRF_STATE_OUTPUT:
5371 break;
5372 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005373 return PSA_ERROR_BAD_STATE;
Gilles Peskineb1edaec2021-06-11 22:41:46 +02005374 }
5375
Gilles Peskine449bd832023-01-11 14:50:10 +01005376 while (output_length != 0) {
Janos Follath844eb0e2019-06-19 12:10:49 +01005377 /* Check if we have fully processed the current block. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005378 if (tls12_prf->left_in_block == 0) {
5379 status = psa_key_derivation_tls12_prf_generate_next_block(tls12_prf,
5380 alg);
5381 if (status != PSA_SUCCESS) {
5382 return status;
5383 }
Janos Follath844eb0e2019-06-19 12:10:49 +01005384
5385 continue;
5386 }
5387
Gilles Peskine449bd832023-01-11 14:50:10 +01005388 if (tls12_prf->left_in_block > output_length) {
Janos Follath844eb0e2019-06-19 12:10:49 +01005389 length = (uint8_t) output_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01005390 } else {
Janos Follath844eb0e2019-06-19 12:10:49 +01005391 length = tls12_prf->left_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005392 }
Janos Follath844eb0e2019-06-19 12:10:49 +01005393
5394 offset = hash_length - tls12_prf->left_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005395 memcpy(output, tls12_prf->output_block + offset, length);
Janos Follath844eb0e2019-06-19 12:10:49 +01005396 output += length;
5397 output_length -= length;
5398 tls12_prf->left_in_block -= length;
5399 }
5400
Gilles Peskine449bd832023-01-11 14:50:10 +01005401 return PSA_SUCCESS;
Janos Follath844eb0e2019-06-19 12:10:49 +01005402}
John Durkop07cc04a2020-11-16 22:08:34 -08005403#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
5404 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskinebef7f142018-07-12 17:22:21 +02005405
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005406#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
5407static psa_status_t psa_key_derivation_tls12_ecjpake_to_pms_read(
5408 psa_tls12_ecjpake_to_pms_t *ecjpake,
5409 uint8_t *output,
Gilles Peskine449bd832023-01-11 14:50:10 +01005410 size_t output_length)
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005411{
5412 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Andrzej Kurek5603efd2022-09-26 10:49:16 -04005413 size_t output_size = 0;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005414
Gilles Peskine449bd832023-01-11 14:50:10 +01005415 if (output_length != 32) {
5416 return PSA_ERROR_INVALID_ARGUMENT;
5417 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005418
Gilles Peskine449bd832023-01-11 14:50:10 +01005419 status = psa_hash_compute(PSA_ALG_SHA_256, ecjpake->data,
5420 PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE, output, output_length,
5421 &output_size);
5422 if (status != PSA_SUCCESS) {
5423 return status;
5424 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005425
Gilles Peskine449bd832023-01-11 14:50:10 +01005426 if (output_size != output_length) {
5427 return PSA_ERROR_GENERIC_ERROR;
5428 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005429
Gilles Peskine449bd832023-01-11 14:50:10 +01005430 return PSA_SUCCESS;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005431}
5432#endif
5433
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305434#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305435static psa_status_t psa_key_derivation_pbkdf2_generate_block(
5436 psa_pbkdf2_key_derivation_t *pbkdf2,
5437 psa_algorithm_t prf_alg,
5438 uint8_t prf_output_length,
5439 psa_key_attributes_t *attributes)
5440{
5441 psa_status_t status;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305442 psa_mac_operation_t mac_operation = PSA_MAC_OPERATION_INIT;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305443 size_t mac_output_length;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305444 uint8_t U_i[PSA_MAC_MAX_SIZE];
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305445 uint8_t *U_accumulator = pbkdf2->output_block;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305446 uint64_t i;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305447 uint8_t block_counter[4];
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305448
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305449 mac_operation.is_sign = 1;
5450 mac_operation.mac_size = prf_output_length;
5451 MBEDTLS_PUT_UINT32_BE(pbkdf2->block_number, block_counter, 0);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305452
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305453 status = psa_driver_wrapper_mac_sign_setup(&mac_operation,
5454 attributes,
5455 pbkdf2->password,
5456 pbkdf2->password_length,
5457 prf_alg);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305458 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305459 goto cleanup;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305460 }
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305461 status = psa_mac_update(&mac_operation, pbkdf2->salt, pbkdf2->salt_length);
5462 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305463 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305464 }
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305465 status = psa_mac_update(&mac_operation, block_counter, sizeof(block_counter));
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305466 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305467 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305468 }
5469 status = psa_mac_sign_finish(&mac_operation, U_i, sizeof(U_i),
5470 &mac_output_length);
5471 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305472 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305473 }
5474
5475 if (mac_output_length != prf_output_length) {
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305476 status = PSA_ERROR_CORRUPTION_DETECTED;
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305477 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305478 }
5479
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305480 memcpy(U_accumulator, U_i, prf_output_length);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305481
5482 for (i = 1; i < pbkdf2->input_cost; i++) {
Kusumit Ghoderao4536bb62023-06-22 15:42:59 +05305483 /* We are passing prf_output_length as mac_size because the driver
5484 * function directly sets mac_output_length as mac_size upon success.
Kusumit Ghoderao5f3345a2023-07-27 21:21:38 +05305485 * See https://github.com/Mbed-TLS/mbedtls/issues/7801 */
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305486 status = psa_driver_wrapper_mac_compute(attributes,
5487 pbkdf2->password,
5488 pbkdf2->password_length,
5489 prf_alg, U_i, prf_output_length,
Kusumit Ghoderao4536bb62023-06-22 15:42:59 +05305490 U_i, prf_output_length,
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305491 &mac_output_length);
5492 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305493 goto cleanup;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305494 }
5495
Kusumit Ghoderao109ee3d2023-06-08 16:36:45 +05305496 mbedtls_xor(U_accumulator, U_accumulator, U_i, prf_output_length);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305497 }
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305498
5499cleanup:
5500 /* Zeroise buffers to clear sensitive data from memory. */
5501 mbedtls_platform_zeroize(U_i, PSA_MAC_MAX_SIZE);
5502 return status;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305503}
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05305504
5505static psa_status_t psa_key_derivation_pbkdf2_read(
5506 psa_pbkdf2_key_derivation_t *pbkdf2,
5507 psa_algorithm_t kdf_alg,
5508 uint8_t *output,
5509 size_t output_length)
5510{
5511 psa_status_t status;
5512 psa_algorithm_t prf_alg;
5513 uint8_t prf_output_length;
5514 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
5515 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(pbkdf2->password_length));
5516 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
5517
5518 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
5519 prf_alg = PSA_ALG_HMAC(PSA_ALG_PBKDF2_HMAC_GET_HASH(kdf_alg));
5520 prf_output_length = PSA_HASH_LENGTH(prf_alg);
5521 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
Kusumit Ghoderaoa2520a52023-06-22 15:42:19 +05305522 } else if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
5523 prf_alg = PSA_ALG_CMAC;
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05305524 prf_output_length = PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC);
Kusumit Ghoderaoa2520a52023-06-22 15:42:19 +05305525 psa_set_key_type(&attributes, PSA_KEY_TYPE_AES);
Kusumit Ghoderaod9ec1af2023-06-08 20:19:51 +05305526 } else {
5527 return PSA_ERROR_INVALID_ARGUMENT;
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05305528 }
5529
5530 switch (pbkdf2->state) {
5531 case PSA_PBKDF2_STATE_PASSWORD_SET:
5532 /* Initially we need a new block so bytes_used is equal to block size*/
5533 pbkdf2->bytes_used = prf_output_length;
5534 pbkdf2->state = PSA_PBKDF2_STATE_OUTPUT;
5535 break;
5536 case PSA_PBKDF2_STATE_OUTPUT:
5537 break;
5538 default:
5539 return PSA_ERROR_BAD_STATE;
5540 }
5541
5542 while (output_length != 0) {
5543 uint8_t n = prf_output_length - pbkdf2->bytes_used;
5544 if (n > output_length) {
5545 n = (uint8_t) output_length;
5546 }
5547 memcpy(output, pbkdf2->output_block + pbkdf2->bytes_used, n);
5548 output += n;
5549 output_length -= n;
5550 pbkdf2->bytes_used += n;
5551
5552 if (output_length == 0) {
5553 break;
5554 }
5555
5556 /* We need a new block */
5557 pbkdf2->bytes_used = 0;
5558 pbkdf2->block_number++;
5559
5560 status = psa_key_derivation_pbkdf2_generate_block(pbkdf2, prf_alg,
5561 prf_output_length,
5562 &attributes);
5563 if (status != PSA_SUCCESS) {
5564 return status;
5565 }
5566 }
5567
5568 return PSA_SUCCESS;
5569}
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305570#endif /* PSA_HAVE_SOFT_PBKDF2 */
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305571
Janos Follath6c6c8fc2019-06-17 12:38:20 +01005572psa_status_t psa_key_derivation_output_bytes(
5573 psa_key_derivation_operation_t *operation,
5574 uint8_t *output,
Gilles Peskine449bd832023-01-11 14:50:10 +01005575 size_t output_length)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005576{
5577 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01005578 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
Gilles Peskineeab56e42018-07-12 17:12:33 +02005579
Gilles Peskine449bd832023-01-11 14:50:10 +01005580 if (operation->alg == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005581 /* This is a blank operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005582 return PSA_ERROR_BAD_STATE;
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005583 }
5584
Gilles Peskine449bd832023-01-11 14:50:10 +01005585 if (output_length > operation->capacity) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005586 operation->capacity = 0;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005587 /* Go through the error path to wipe all confidential data now
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005588 * that the operation object is useless. */
David Saadab4ecc272019-02-14 13:48:10 +02005589 status = PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005590 goto exit;
5591 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005592 if (output_length == 0 && operation->capacity == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005593 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005594 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02005595 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
5596 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005597 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02005598 * output_length > 0. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005599 return PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005600 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005601 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005602
Przemek Stekiel69c46792022-06-10 12:59:51 +02005603#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01005604 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
5605 status = psa_key_derivation_hkdf_read(&operation->ctx.hkdf, kdf_alg,
5606 output, output_length);
5607 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02005608#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08005609#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5610 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005611 if (PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
5612 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
5613 status = psa_key_derivation_tls12_prf_read(&operation->ctx.tls12_prf,
5614 kdf_alg, output,
5615 output_length);
5616 } else
John Durkop07cc04a2020-11-16 22:08:34 -08005617#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
5618 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005619#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005620 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005621 status = psa_key_derivation_tls12_ecjpake_to_pms_read(
Gilles Peskine449bd832023-01-11 14:50:10 +01005622 &operation->ctx.tls12_ecjpake_to_pms, output, output_length);
5623 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005624#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305625#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05305626 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05305627 status = psa_key_derivation_pbkdf2_read(&operation->ctx.pbkdf2, kdf_alg,
5628 output, output_length);
Kusumit Ghoderao056f0c52023-05-03 15:58:34 +05305629 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305630#endif /* PSA_HAVE_SOFT_PBKDF2 */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005631
Gilles Peskineeab56e42018-07-12 17:12:33 +02005632 {
Steven Cooreman74afe472021-02-10 17:19:22 +01005633 (void) kdf_alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01005634 return PSA_ERROR_BAD_STATE;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005635 }
5636
5637exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005638 if (status != PSA_SUCCESS) {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005639 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005640 * This allows us to differentiate between exhausted operations and
5641 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
5642 * operations. */
5643 psa_algorithm_t alg = operation->alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01005644 psa_key_derivation_abort(operation);
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005645 operation->alg = alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01005646 memset(output, '!', output_length);
Gilles Peskineeab56e42018-07-12 17:12:33 +02005647 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005648 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005649}
5650
David Brown7807bf72021-02-09 16:28:23 -07005651#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01005652static void psa_des_set_key_parity(uint8_t *data, size_t data_size)
Gilles Peskine08542d82018-07-19 17:05:42 +02005653{
Gilles Peskine449bd832023-01-11 14:50:10 +01005654 if (data_size >= 8) {
5655 mbedtls_des_key_set_parity(data);
5656 }
5657 if (data_size >= 16) {
5658 mbedtls_des_key_set_parity(data + 8);
5659 }
5660 if (data_size >= 24) {
5661 mbedtls_des_key_set_parity(data + 16);
5662 }
Gilles Peskine08542d82018-07-19 17:05:42 +02005663}
David Brown7807bf72021-02-09 16:28:23 -07005664#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine08542d82018-07-19 17:05:42 +02005665
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005666/*
Gilles Peskine449bd832023-01-11 14:50:10 +01005667 * ECC keys on a Weierstrass elliptic curve require the generation
5668 * of a private key which is an integer
5669 * in the range [1, N - 1], where N is the boundary of the private key domain:
5670 * N is the prime p for Diffie-Hellman, or the order of the
5671 * curve’s base point for ECC.
5672 *
5673 * Let m be the bit size of N, such that 2^m > N >= 2^(m-1).
5674 * This function generates the private key using the following process:
5675 *
5676 * 1. Draw a byte string of length ceiling(m/8) bytes.
5677 * 2. If m is not a multiple of 8, set the most significant
5678 * (8 * ceiling(m/8) - m) bits of the first byte in the string to zero.
5679 * 3. Convert the string to integer k by decoding it as a big-endian byte string.
5680 * 4. If k > N - 2, discard the result and return to step 1.
5681 * 5. Output k + 1 as the private key.
5682 *
5683 * This method allows compliance to NIST standards, specifically the methods titled
5684 * Key-Pair Generation by Testing Candidates in the following publications:
5685 * - NIST Special Publication 800-56A: Recommendation for Pair-Wise Key-Establishment
5686 * Schemes Using Discrete Logarithm Cryptography [SP800-56A] §5.6.1.1.4 for
5687 * Diffie-Hellman keys.
5688 *
5689 * - [SP800-56A] §5.6.1.2.2 or FIPS Publication 186-4: Digital Signature
5690 * Standard (DSS) [FIPS186-4] §B.4.2 for elliptic curve keys.
5691 *
5692 * Note: Function allocates memory for *data buffer, so given *data should be
5693 * always NULL.
5694 */
Valerio Setti86587ab2023-06-27 13:09:30 +02005695#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE)
5696#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE)
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01005697static psa_status_t psa_generate_derived_ecc_key_weierstrass_helper(
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005698 psa_key_slot_t *slot,
5699 size_t bits,
5700 psa_key_derivation_operation_t *operation,
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005701 uint8_t **data
5702 )
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005703{
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005704 unsigned key_out_of_range = 1;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005705 mbedtls_mpi k;
5706 mbedtls_mpi diff_N_2;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005707 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Przemek Stekiela81aed22022-03-01 15:13:30 +01005708 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01005709 size_t m;
5710 size_t m_bytes;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005711
Gilles Peskine449bd832023-01-11 14:50:10 +01005712 mbedtls_mpi_init(&k);
5713 mbedtls_mpi_init(&diff_N_2);
Przemyslaw Stekiel1dfd1222021-11-18 13:35:00 +01005714
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005715 psa_ecc_family_t curve = PSA_KEY_TYPE_ECC_GET_FAMILY(
Gilles Peskine449bd832023-01-11 14:50:10 +01005716 slot->attr.type);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005717 mbedtls_ecp_group_id grp_id =
Gilles Peskine449bd832023-01-11 14:50:10 +01005718 mbedtls_ecc_group_of_psa(curve, bits, 0);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005719
Gilles Peskine449bd832023-01-11 14:50:10 +01005720 if (grp_id == MBEDTLS_ECP_DP_NONE) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005721 ret = MBEDTLS_ERR_ASN1_INVALID_DATA;
Przemyslaw Stekiel871a3362021-12-02 08:46:39 +01005722 goto cleanup;
5723 }
5724
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005725 mbedtls_ecp_group ecp_group;
Gilles Peskine449bd832023-01-11 14:50:10 +01005726 mbedtls_ecp_group_init(&ecp_group);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005727
Gilles Peskine449bd832023-01-11 14:50:10 +01005728 MBEDTLS_MPI_CHK(mbedtls_ecp_group_load(&ecp_group, grp_id));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005729
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005730 /* N is the boundary of the private key domain (ecp_group.N). */
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005731 /* Let m be the bit size of N. */
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01005732 m = ecp_group.nbits;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005733
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01005734 m_bytes = PSA_BITS_TO_BYTES(m);
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005735
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005736 /* Calculate N - 2 - it will be needed later. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005737 MBEDTLS_MPI_CHK(mbedtls_mpi_sub_int(&diff_N_2, &ecp_group.N, 2));
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005738
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005739 /* Note: This function is always called with *data == NULL and it
5740 * allocates memory for the data buffer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005741 *data = mbedtls_calloc(1, m_bytes);
5742 if (*data == NULL) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005743 ret = MBEDTLS_ERR_ASN1_ALLOC_FAILED;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005744 goto cleanup;
5745 }
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005746
Gilles Peskine449bd832023-01-11 14:50:10 +01005747 while (key_out_of_range) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005748 /* 1. Draw a byte string of length ceiling(m/8) bytes. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005749 if ((status = psa_key_derivation_output_bytes(operation, *data, m_bytes)) != 0) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005750 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005751 }
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005752
5753 /* 2. If m is not a multiple of 8 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005754 if (m % 8 != 0) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005755 /* Set the most significant
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005756 * (8 * ceiling(m/8) - m) bits of the first byte in
5757 * the string to zero.
5758 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005759 uint8_t clear_bit_mask = (1 << (m % 8)) - 1;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005760 (*data)[0] &= clear_bit_mask;
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005761 }
5762
5763 /* 3. Convert the string to integer k by decoding it as a
Gilles Peskine449bd832023-01-11 14:50:10 +01005764 * big-endian byte string.
5765 */
5766 MBEDTLS_MPI_CHK(mbedtls_mpi_read_binary(&k, *data, m_bytes));
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005767
5768 /* 4. If k > N - 2, discard the result and return to step 1.
Gilles Peskine449bd832023-01-11 14:50:10 +01005769 * Result of comparison is returned. When it indicates error
5770 * then this function is called again.
5771 */
5772 MBEDTLS_MPI_CHK(mbedtls_mpi_lt_mpi_ct(&diff_N_2, &k, &key_out_of_range));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005773 }
5774
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005775 /* 5. Output k + 1 as the private key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005776 MBEDTLS_MPI_CHK(mbedtls_mpi_add_int(&k, &k, 1));
5777 MBEDTLS_MPI_CHK(mbedtls_mpi_write_binary(&k, *data, m_bytes));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005778cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01005779 if (ret != 0) {
5780 status = mbedtls_to_psa_error(ret);
5781 }
5782 if (status != PSA_SUCCESS) {
5783 mbedtls_free(*data);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005784 *data = NULL;
5785 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005786 mbedtls_mpi_free(&k);
5787 mbedtls_mpi_free(&diff_N_2);
5788 return status;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005789}
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005790
5791/* ECC keys on a Montgomery elliptic curve draws a byte string whose length
5792 * is determined by the curve, and sets the mandatory bits accordingly. That is:
5793 *
5794 * - Curve25519 (PSA_ECC_FAMILY_MONTGOMERY, 255 bits):
5795 * draw a 32-byte string and process it as specified in
5796 * Elliptic Curves for Security [RFC7748] §5.
5797 *
5798 * - Curve448 (PSA_ECC_FAMILY_MONTGOMERY, 448 bits):
5799 * draw a 56-byte string and process it as specified in [RFC7748] §5.
5800 *
5801 * Note: Function allocates memory for *data buffer, so given *data should be
5802 * always NULL.
5803 */
5804
5805static psa_status_t psa_generate_derived_ecc_key_montgomery_helper(
5806 size_t bits,
5807 psa_key_derivation_operation_t *operation,
5808 uint8_t **data
5809 )
5810{
5811 size_t output_length;
Przemek Stekiela81aed22022-03-01 15:13:30 +01005812 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005813
Gilles Peskine449bd832023-01-11 14:50:10 +01005814 switch (bits) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005815 case 255:
5816 output_length = 32;
5817 break;
5818 case 448:
5819 output_length = 56;
5820 break;
5821 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005822 return PSA_ERROR_INVALID_ARGUMENT;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005823 break;
5824 }
5825
Gilles Peskine449bd832023-01-11 14:50:10 +01005826 *data = mbedtls_calloc(1, output_length);
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005827
Gilles Peskine449bd832023-01-11 14:50:10 +01005828 if (*data == NULL) {
5829 return PSA_ERROR_INSUFFICIENT_MEMORY;
5830 }
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005831
Gilles Peskine449bd832023-01-11 14:50:10 +01005832 status = psa_key_derivation_output_bytes(operation, *data, output_length);
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005833
Gilles Peskine449bd832023-01-11 14:50:10 +01005834 if (status != PSA_SUCCESS) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005835 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01005836 }
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005837
Gilles Peskine449bd832023-01-11 14:50:10 +01005838 switch (bits) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005839 case 255:
5840 (*data)[0] &= 248;
5841 (*data)[31] &= 127;
5842 (*data)[31] |= 64;
5843 break;
5844 case 448:
5845 (*data)[0] &= 252;
5846 (*data)[55] |= 128;
5847 break;
5848 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005849 return PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005850 break;
5851 }
5852
5853 return status;
5854}
Valerio Setti86587ab2023-06-27 13:09:30 +02005855#else /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE */
5856static psa_status_t psa_generate_derived_ecc_key_weierstrass_helper(
5857 psa_key_slot_t *slot, size_t bits,
5858 psa_key_derivation_operation_t *operation, uint8_t **data)
5859{
5860 (void) slot;
5861 (void) bits;
5862 (void) operation;
5863 (void) data;
5864 return PSA_ERROR_NOT_SUPPORTED;
5865}
5866
5867static psa_status_t psa_generate_derived_ecc_key_montgomery_helper(
5868 size_t bits, psa_key_derivation_operation_t *operation, uint8_t **data)
5869{
5870 (void) bits;
5871 (void) operation;
5872 (void) data;
5873 return PSA_ERROR_NOT_SUPPORTED;
5874}
5875#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE */
5876#endif /* PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE */
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005877
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01005878static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005879 psa_key_slot_t *slot,
5880 size_t bits,
Gilles Peskine449bd832023-01-11 14:50:10 +01005881 psa_key_derivation_operation_t *operation)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005882{
5883 uint8_t *data = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01005884 size_t bytes = PSA_BITS_TO_BYTES(bits);
Archanad8a83dc2021-06-14 10:04:16 +05305885 size_t storage_size = bytes;
Przemek Stekiela81aed22022-03-01 15:13:30 +01005886 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01005887 psa_key_attributes_t attributes;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005888
Gilles Peskine449bd832023-01-11 14:50:10 +01005889 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(slot->attr.type)) {
5890 return PSA_ERROR_INVALID_ARGUMENT;
5891 }
Gilles Peskineeab56e42018-07-12 17:12:33 +02005892
Valerio Setti8ffdb5d2023-06-20 13:14:08 +02005893#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE) || \
Valerio Settidd24f292023-06-26 12:21:17 +02005894 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE)
Gilles Peskine449bd832023-01-11 14:50:10 +01005895 if (PSA_KEY_TYPE_IS_ECC(slot->attr.type)) {
5896 psa_ecc_family_t curve = PSA_KEY_TYPE_ECC_GET_FAMILY(slot->attr.type);
5897 if (PSA_ECC_FAMILY_IS_WEIERSTRASS(curve)) {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01005898 /* Weierstrass elliptic curve */
Gilles Peskine449bd832023-01-11 14:50:10 +01005899 status = psa_generate_derived_ecc_key_weierstrass_helper(slot, bits, operation, &data);
5900 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005901 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005902 }
5903 } else {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01005904 /* Montgomery elliptic curve */
Gilles Peskine449bd832023-01-11 14:50:10 +01005905 status = psa_generate_derived_ecc_key_montgomery_helper(bits, operation, &data);
5906 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01005907 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005908 }
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01005909 }
Przemyslaw Stekiel1dfd1222021-11-18 13:35:00 +01005910 } else
Valerio Setti8ffdb5d2023-06-20 13:14:08 +02005911#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE) ||
Valerio Settidd24f292023-06-26 12:21:17 +02005912 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE) */
Gilles Peskine449bd832023-01-11 14:50:10 +01005913 if (key_type_is_raw_bytes(slot->attr.type)) {
5914 if (bits % 8 != 0) {
5915 return PSA_ERROR_INVALID_ARGUMENT;
5916 }
5917 data = mbedtls_calloc(1, bytes);
5918 if (data == NULL) {
5919 return PSA_ERROR_INSUFFICIENT_MEMORY;
5920 }
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01005921
Gilles Peskine449bd832023-01-11 14:50:10 +01005922 status = psa_key_derivation_output_bytes(operation, data, bytes);
5923 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01005924 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005925 }
David Brown12ca5032021-02-11 11:02:00 -07005926#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01005927 if (slot->attr.type == PSA_KEY_TYPE_DES) {
5928 psa_des_set_key_parity(data, bytes);
5929 }
Przemek Stekielf110dc02022-03-01 14:48:05 +01005930#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES) */
Gilles Peskine449bd832023-01-11 14:50:10 +01005931 } else {
5932 return PSA_ERROR_NOT_SUPPORTED;
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01005933 }
Ronald Crondd04d422020-11-28 15:14:42 +01005934
Ronald Cronbf33c932020-11-28 18:06:53 +01005935 slot->attr.bits = (psa_key_bits_t) bits;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01005936 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01005937 .core = slot->attr
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01005938 };
5939
Gilles Peskine449bd832023-01-11 14:50:10 +01005940 if (psa_key_lifetime_is_external(attributes.core.lifetime)) {
5941 status = psa_driver_wrapper_get_key_buffer_size(&attributes,
5942 &storage_size);
5943 if (status != PSA_SUCCESS) {
Archanad8a83dc2021-06-14 10:04:16 +05305944 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005945 }
Archanad8a83dc2021-06-14 10:04:16 +05305946 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005947 status = psa_allocate_buffer_to_slot(slot, storage_size);
5948 if (status != PSA_SUCCESS) {
Archanad8a83dc2021-06-14 10:04:16 +05305949 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005950 }
Archanad8a83dc2021-06-14 10:04:16 +05305951
Gilles Peskine449bd832023-01-11 14:50:10 +01005952 status = psa_driver_wrapper_import_key(&attributes,
5953 data, bytes,
5954 slot->key.data,
5955 slot->key.bytes,
5956 &slot->key.bytes, &bits);
5957 if (bits != slot->attr.bits) {
Ronald Cronbf33c932020-11-28 18:06:53 +01005958 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine449bd832023-01-11 14:50:10 +01005959 }
Gilles Peskineeab56e42018-07-12 17:12:33 +02005960
5961exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005962 mbedtls_free(data);
5963 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005964}
5965
Gilles Peskine449bd832023-01-11 14:50:10 +01005966psa_status_t psa_key_derivation_output_key(const psa_key_attributes_t *attributes,
5967 psa_key_derivation_operation_t *operation,
5968 mbedtls_svc_key_id_t *key)
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005969{
5970 psa_status_t status;
5971 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02005972 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine0f84d622019-09-12 19:03:13 +02005973
Ronald Cron81709fc2020-11-14 12:10:32 +01005974 *key = MBEDTLS_SVC_KEY_ID_INIT;
5975
Gilles Peskine0f84d622019-09-12 19:03:13 +02005976 /* Reject any attempt to create a zero-length key so that we don't
5977 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005978 if (psa_get_key_bits(attributes) == 0) {
5979 return PSA_ERROR_INVALID_ARGUMENT;
5980 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02005981
Gilles Peskine449bd832023-01-11 14:50:10 +01005982 if (operation->alg == PSA_ALG_NONE) {
5983 return PSA_ERROR_BAD_STATE;
5984 }
Dave Rodgmand69da6c2021-11-16 10:32:48 +00005985
Gilles Peskine449bd832023-01-11 14:50:10 +01005986 if (!operation->can_output_key) {
5987 return PSA_ERROR_NOT_PERMITTED;
5988 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02005989
Gilles Peskine449bd832023-01-11 14:50:10 +01005990 status = psa_start_key_creation(PSA_KEY_CREATION_DERIVE, attributes,
5991 &slot, &driver);
Gilles Peskinef4ee6622019-07-24 13:44:30 +02005992#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005993 if (driver != NULL) {
Gilles Peskinef4ee6622019-07-24 13:44:30 +02005994 /* Deriving a key in a secure element is not implemented yet. */
5995 status = PSA_ERROR_NOT_SUPPORTED;
5996 }
5997#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine449bd832023-01-11 14:50:10 +01005998 if (status == PSA_SUCCESS) {
5999 status = psa_generate_derived_key_internal(slot,
6000 attributes->core.bits,
6001 operation);
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006002 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006003 if (status == PSA_SUCCESS) {
6004 status = psa_finish_key_creation(slot, driver, key);
6005 }
6006 if (status != PSA_SUCCESS) {
6007 psa_fail_key_creation(slot, driver);
6008 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02006009
Gilles Peskine449bd832023-01-11 14:50:10 +01006010 return status;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006011}
6012
Gilles Peskineeab56e42018-07-12 17:12:33 +02006013
6014
6015/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02006016/* Key derivation */
6017/****************************************************************/
6018
Steven Cooreman932ffb72021-02-15 12:14:32 +01006019#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006020static int is_kdf_alg_supported(psa_algorithm_t kdf_alg)
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006021{
6022#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006023 if (PSA_ALG_IS_HKDF(kdf_alg)) {
6024 return 1;
6025 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006026#endif
Przemek Stekielb57a44b2022-06-06 08:33:45 +02006027#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006028 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6029 return 1;
6030 }
Przemek Stekielb57a44b2022-06-06 08:33:45 +02006031#endif
6032#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006033 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
6034 return 1;
6035 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006036#endif
6037#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006038 if (PSA_ALG_IS_TLS12_PRF(kdf_alg)) {
6039 return 1;
6040 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006041#endif
6042#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006043 if (PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
6044 return 1;
6045 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006046#endif
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006047#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006048 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
6049 return 1;
6050 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006051#endif
Kusumit Ghoderaod132cac2023-05-03 12:00:27 +05306052#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
6053 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
6054 return 1;
6055 }
6056#endif
Kusumit Ghoderao2cd64962023-06-22 15:38:57 +05306057#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128)
6058 if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
6059 return 1;
6060 }
6061#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006062 return 0;
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006063}
6064
Gilles Peskine449bd832023-01-11 14:50:10 +01006065static psa_status_t psa_hash_try_support(psa_algorithm_t alg)
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006066{
6067 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01006068 psa_status_t status = psa_hash_setup(&operation, alg);
6069 psa_hash_abort(&operation);
6070 return status;
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006071}
6072
Gilles Peskine969c5d62019-01-16 15:53:06 +01006073static psa_status_t psa_key_derivation_setup_kdf(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006074 psa_key_derivation_operation_t *operation,
Gilles Peskine449bd832023-01-11 14:50:10 +01006075 psa_algorithm_t kdf_alg)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006076{
Janos Follath5fe19732019-06-20 15:09:30 +01006077 /* Make sure that operation->ctx is properly zero-initialised. (Macro
6078 * initialisers for this union leave some bytes unspecified.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01006079 memset(&operation->ctx, 0, sizeof(operation->ctx));
Janos Follath5fe19732019-06-20 15:09:30 +01006080
Gilles Peskine969c5d62019-01-16 15:53:06 +01006081 /* Make sure that kdf_alg is a supported key derivation algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006082 if (!is_kdf_alg_supported(kdf_alg)) {
6083 return PSA_ERROR_NOT_SUPPORTED;
6084 }
John Durkop07cc04a2020-11-16 22:08:34 -08006085
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006086 /* All currently supported key derivation algorithms (apart from
Kusumit Ghoderao2cd64962023-06-22 15:38:57 +05306087 * ecjpake to pms and pbkdf2_aes_cmac_128) are based on a hash algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006088 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
6089 size_t hash_size = PSA_HASH_LENGTH(hash_alg);
Kusumit Ghoderao2cd64962023-06-22 15:38:57 +05306090 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
6091 hash_size = PSA_HASH_LENGTH(PSA_ALG_SHA_256);
6092 } else if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306093 hash_size = PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC);
Kusumit Ghoderao2cd64962023-06-22 15:38:57 +05306094 } else {
Gilles Peskine449bd832023-01-11 14:50:10 +01006095 if (hash_size == 0) {
6096 return PSA_ERROR_NOT_SUPPORTED;
6097 }
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006098
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006099 /* Make sure that hash_alg is a supported hash algorithm. Otherwise
6100 * we might fail later, which is somewhat unfriendly and potentially
6101 * risk-prone. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006102 psa_status_t status = psa_hash_try_support(hash_alg);
6103 if (status != PSA_SUCCESS) {
6104 return status;
6105 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006106 }
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006107
Gilles Peskine449bd832023-01-11 14:50:10 +01006108 if ((PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
6109 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) &&
6110 !(hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384)) {
6111 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006112 }
Andrzej Kurek77638292022-09-16 12:24:52 -04006113#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT) || \
Andrzej Kurekb510cd22022-09-26 10:50:22 -04006114 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006115 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg) ||
6116 (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS)) {
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006117 operation->capacity = hash_size;
Gilles Peskine449bd832023-01-11 14:50:10 +01006118 } else
Andrzej Kurekb510cd22022-09-26 10:50:22 -04006119#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT ||
6120 MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Gilles Peskine449bd832023-01-11 14:50:10 +01006121 operation->capacity = 255 * hash_size;
6122 return PSA_SUCCESS;
Gilles Peskine969c5d62019-01-16 15:53:06 +01006123}
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006124
Gilles Peskine449bd832023-01-11 14:50:10 +01006125static psa_status_t psa_key_agreement_try_support(psa_algorithm_t alg)
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006126{
6127#if defined(PSA_WANT_ALG_ECDH)
Gilles Peskine449bd832023-01-11 14:50:10 +01006128 if (alg == PSA_ALG_ECDH) {
6129 return PSA_SUCCESS;
6130 }
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006131#endif
Przemek Stekielfb3dd542022-12-01 14:59:15 +01006132#if defined(PSA_WANT_ALG_FFDH)
6133 if (alg == PSA_ALG_FFDH) {
6134 return PSA_SUCCESS;
6135 }
6136#endif
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006137 (void) alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01006138 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006139}
Gilles Peskinebb3814c2022-12-16 01:12:12 +01006140
6141static int psa_key_derivation_allows_free_form_secret_input(
6142 psa_algorithm_t kdf_alg)
6143{
6144#if defined(PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS)
6145 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
6146 return 0;
6147 }
6148#endif
6149 (void) kdf_alg;
6150 return 1;
6151}
John Durkop07cc04a2020-11-16 22:08:34 -08006152#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01006153
Gilles Peskine449bd832023-01-11 14:50:10 +01006154psa_status_t psa_key_derivation_setup(psa_key_derivation_operation_t *operation,
6155 psa_algorithm_t alg)
Gilles Peskine969c5d62019-01-16 15:53:06 +01006156{
6157 psa_status_t status;
6158
Gilles Peskine449bd832023-01-11 14:50:10 +01006159 if (operation->alg != 0) {
6160 return PSA_ERROR_BAD_STATE;
Gilles Peskine969c5d62019-01-16 15:53:06 +01006161 }
Gilles Peskine969c5d62019-01-16 15:53:06 +01006162
Gilles Peskine449bd832023-01-11 14:50:10 +01006163 if (PSA_ALG_IS_RAW_KEY_AGREEMENT(alg)) {
6164 return PSA_ERROR_INVALID_ARGUMENT;
6165 } else if (PSA_ALG_IS_KEY_AGREEMENT(alg)) {
6166#if defined(AT_LEAST_ONE_BUILTIN_KDF)
6167 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF(alg);
6168 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE(alg);
6169 status = psa_key_agreement_try_support(ka_alg);
6170 if (status != PSA_SUCCESS) {
6171 return status;
6172 }
Gilles Peskinebb3814c2022-12-16 01:12:12 +01006173 if (!psa_key_derivation_allows_free_form_secret_input(kdf_alg)) {
6174 return PSA_ERROR_INVALID_ARGUMENT;
6175 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006176 status = psa_key_derivation_setup_kdf(operation, kdf_alg);
6177#else
6178 return PSA_ERROR_NOT_SUPPORTED;
6179#endif /* AT_LEAST_ONE_BUILTIN_KDF */
6180 } else if (PSA_ALG_IS_KEY_DERIVATION(alg)) {
6181#if defined(AT_LEAST_ONE_BUILTIN_KDF)
6182 status = psa_key_derivation_setup_kdf(operation, alg);
6183#else
6184 return PSA_ERROR_NOT_SUPPORTED;
6185#endif /* AT_LEAST_ONE_BUILTIN_KDF */
6186 } else {
6187 return PSA_ERROR_INVALID_ARGUMENT;
6188 }
6189
6190 if (status == PSA_SUCCESS) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006191 operation->alg = alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01006192 }
6193 return status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006194}
6195
Przemek Stekiel69c46792022-06-10 12:59:51 +02006196#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006197static psa_status_t psa_hkdf_input(psa_hkdf_key_derivation_t *hkdf,
6198 psa_algorithm_t kdf_alg,
6199 psa_key_derivation_step_t step,
6200 const uint8_t *data,
6201 size_t data_length)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006202{
Gilles Peskine449bd832023-01-11 14:50:10 +01006203 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006204 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006205 switch (step) {
Gilles Peskine03410b52019-05-16 16:05:19 +02006206 case PSA_KEY_DERIVATION_INPUT_SALT:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006207#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006208 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
6209 return PSA_ERROR_INVALID_ARGUMENT;
6210 }
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006211#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND */
Gilles Peskine449bd832023-01-11 14:50:10 +01006212 if (hkdf->state != HKDF_STATE_INIT) {
6213 return PSA_ERROR_BAD_STATE;
6214 } else {
6215 status = psa_key_derivation_start_hmac(&hkdf->hmac,
6216 hash_alg,
6217 data, data_length);
6218 if (status != PSA_SUCCESS) {
6219 return status;
6220 }
Steven Cooremand1ed1d92021-04-29 19:11:25 +02006221 hkdf->state = HKDF_STATE_STARTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01006222 return PSA_SUCCESS;
Steven Cooremand1ed1d92021-04-29 19:11:25 +02006223 }
Gilles Peskine03410b52019-05-16 16:05:19 +02006224 case PSA_KEY_DERIVATION_INPUT_SECRET:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006225#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006226 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
Przemek Stekiel2fb0dcd2022-05-19 10:34:37 +02006227 /* We shouldn't be in different state as HKDF_EXPAND only allows
6228 * two inputs: SECRET (this case) and INFO which does not modify
6229 * the state. It could happen only if the hkdf
6230 * object was corrupted. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006231 if (hkdf->state != HKDF_STATE_INIT) {
6232 return PSA_ERROR_BAD_STATE;
6233 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006234
Przemek Stekiel2fb0dcd2022-05-19 10:34:37 +02006235 /* Allow only input that fits expected prk size */
Gilles Peskine449bd832023-01-11 14:50:10 +01006236 if (data_length != PSA_HASH_LENGTH(hash_alg)) {
6237 return PSA_ERROR_INVALID_ARGUMENT;
6238 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006239
Gilles Peskine449bd832023-01-11 14:50:10 +01006240 memcpy(hkdf->prk, data, data_length);
6241 } else
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006242#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND */
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006243 {
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006244 /* HKDF: If no salt was provided, use an empty salt.
6245 * HKDF-EXTRACT: salt is mandatory. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006246 if (hkdf->state == HKDF_STATE_INIT) {
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006247#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006248 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6249 return PSA_ERROR_BAD_STATE;
6250 }
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006251#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01006252 status = psa_key_derivation_start_hmac(&hkdf->hmac,
6253 hash_alg,
6254 NULL, 0);
6255 if (status != PSA_SUCCESS) {
6256 return status;
6257 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006258 hkdf->state = HKDF_STATE_STARTED;
6259 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006260 if (hkdf->state != HKDF_STATE_STARTED) {
6261 return PSA_ERROR_BAD_STATE;
6262 }
6263 status = psa_mac_update(&hkdf->hmac,
6264 data, data_length);
6265 if (status != PSA_SUCCESS) {
6266 return status;
6267 }
6268 status = psa_mac_sign_finish(&hkdf->hmac,
6269 hkdf->prk,
6270 sizeof(hkdf->prk),
6271 &data_length);
6272 if (status != PSA_SUCCESS) {
6273 return status;
6274 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006275 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006276
Gilles Peskine2b522db2019-04-12 15:11:49 +02006277 hkdf->state = HKDF_STATE_KEYED;
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006278 hkdf->block_number = 0;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006279#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006280 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006281 /* The only block of output is the PRK. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006282 memcpy(hkdf->output_block, hkdf->prk, PSA_HASH_LENGTH(hash_alg));
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006283 hkdf->offset_in_block = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01006284 } else
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006285#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006286 {
6287 /* Block 0 is empty, and the next block will be
6288 * generated by psa_key_derivation_hkdf_read(). */
Gilles Peskine449bd832023-01-11 14:50:10 +01006289 hkdf->offset_in_block = PSA_HASH_LENGTH(hash_alg);
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006290 }
6291
Gilles Peskine449bd832023-01-11 14:50:10 +01006292 return PSA_SUCCESS;
Gilles Peskine03410b52019-05-16 16:05:19 +02006293 case PSA_KEY_DERIVATION_INPUT_INFO:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006294#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006295 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6296 return PSA_ERROR_INVALID_ARGUMENT;
6297 }
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006298#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Przemek Stekielcde3f782022-06-03 16:12:27 +02006299#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006300 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg) &&
6301 hkdf->state == HKDF_STATE_INIT) {
6302 return PSA_ERROR_BAD_STATE;
6303 }
Przemek Stekielcde3f782022-06-03 16:12:27 +02006304#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01006305 if (hkdf->state == HKDF_STATE_OUTPUT) {
6306 return PSA_ERROR_BAD_STATE;
6307 }
6308 if (hkdf->info_set) {
6309 return PSA_ERROR_BAD_STATE;
6310 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006311 hkdf->info_length = data_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01006312 if (data_length != 0) {
6313 hkdf->info = mbedtls_calloc(1, data_length);
6314 if (hkdf->info == NULL) {
6315 return PSA_ERROR_INSUFFICIENT_MEMORY;
6316 }
6317 memcpy(hkdf->info, data, data_length);
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006318 }
6319 hkdf->info_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01006320 return PSA_SUCCESS;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006321 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006322 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006323 }
6324}
Przemek Stekiel69c46792022-06-10 12:59:51 +02006325#endif /* BUILTIN_ALG_ANY_HKDF */
Janos Follathb03233e2019-06-11 15:30:30 +01006326
John Durkop07cc04a2020-11-16 22:08:34 -08006327#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
6328 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006329static psa_status_t psa_tls12_prf_set_seed(psa_tls12_prf_key_derivation_t *prf,
6330 const uint8_t *data,
6331 size_t data_length)
Janos Follathf08e2652019-06-13 09:05:41 +01006332{
Gilles Peskine449bd832023-01-11 14:50:10 +01006333 if (prf->state != PSA_TLS12_PRF_STATE_INIT) {
6334 return PSA_ERROR_BAD_STATE;
6335 }
Janos Follathf08e2652019-06-13 09:05:41 +01006336
Gilles Peskine449bd832023-01-11 14:50:10 +01006337 if (data_length != 0) {
6338 prf->seed = mbedtls_calloc(1, data_length);
6339 if (prf->seed == NULL) {
6340 return PSA_ERROR_INSUFFICIENT_MEMORY;
6341 }
Janos Follathf08e2652019-06-13 09:05:41 +01006342
Gilles Peskine449bd832023-01-11 14:50:10 +01006343 memcpy(prf->seed, data, data_length);
Janos Follathd6dce9f2019-07-04 09:11:38 +01006344 prf->seed_length = data_length;
6345 }
Janos Follathf08e2652019-06-13 09:05:41 +01006346
Gilles Peskine43f958b2020-12-13 14:55:14 +01006347 prf->state = PSA_TLS12_PRF_STATE_SEED_SET;
Janos Follathf08e2652019-06-13 09:05:41 +01006348
Gilles Peskine449bd832023-01-11 14:50:10 +01006349 return PSA_SUCCESS;
Janos Follathf08e2652019-06-13 09:05:41 +01006350}
6351
Gilles Peskine449bd832023-01-11 14:50:10 +01006352static psa_status_t psa_tls12_prf_set_key(psa_tls12_prf_key_derivation_t *prf,
6353 const uint8_t *data,
6354 size_t data_length)
Janos Follath81550542019-06-13 14:26:34 +01006355{
Gilles Peskine449bd832023-01-11 14:50:10 +01006356 if (prf->state != PSA_TLS12_PRF_STATE_SEED_SET &&
6357 prf->state != PSA_TLS12_PRF_STATE_OTHER_KEY_SET) {
6358 return PSA_ERROR_BAD_STATE;
6359 }
Janos Follath81550542019-06-13 14:26:34 +01006360
Gilles Peskine449bd832023-01-11 14:50:10 +01006361 if (data_length != 0) {
6362 prf->secret = mbedtls_calloc(1, data_length);
6363 if (prf->secret == NULL) {
6364 return PSA_ERROR_INSUFFICIENT_MEMORY;
6365 }
Steven Cooremana6df6042021-04-29 19:32:25 +02006366
Gilles Peskine449bd832023-01-11 14:50:10 +01006367 memcpy(prf->secret, data, data_length);
Steven Cooremana6df6042021-04-29 19:32:25 +02006368 prf->secret_length = data_length;
6369 }
Janos Follath81550542019-06-13 14:26:34 +01006370
Gilles Peskine43f958b2020-12-13 14:55:14 +01006371 prf->state = PSA_TLS12_PRF_STATE_KEY_SET;
Janos Follath81550542019-06-13 14:26:34 +01006372
Gilles Peskine449bd832023-01-11 14:50:10 +01006373 return PSA_SUCCESS;
Janos Follath81550542019-06-13 14:26:34 +01006374}
6375
Gilles Peskine449bd832023-01-11 14:50:10 +01006376static psa_status_t psa_tls12_prf_set_label(psa_tls12_prf_key_derivation_t *prf,
6377 const uint8_t *data,
6378 size_t data_length)
Janos Follath63028dd2019-06-13 09:15:47 +01006379{
Gilles Peskine449bd832023-01-11 14:50:10 +01006380 if (prf->state != PSA_TLS12_PRF_STATE_KEY_SET) {
6381 return PSA_ERROR_BAD_STATE;
6382 }
Janos Follath63028dd2019-06-13 09:15:47 +01006383
Gilles Peskine449bd832023-01-11 14:50:10 +01006384 if (data_length != 0) {
6385 prf->label = mbedtls_calloc(1, data_length);
6386 if (prf->label == NULL) {
6387 return PSA_ERROR_INSUFFICIENT_MEMORY;
6388 }
Janos Follath63028dd2019-06-13 09:15:47 +01006389
Gilles Peskine449bd832023-01-11 14:50:10 +01006390 memcpy(prf->label, data, data_length);
Janos Follathd6dce9f2019-07-04 09:11:38 +01006391 prf->label_length = data_length;
6392 }
Janos Follath63028dd2019-06-13 09:15:47 +01006393
Gilles Peskine43f958b2020-12-13 14:55:14 +01006394 prf->state = PSA_TLS12_PRF_STATE_LABEL_SET;
Janos Follath63028dd2019-06-13 09:15:47 +01006395
Gilles Peskine449bd832023-01-11 14:50:10 +01006396 return PSA_SUCCESS;
Janos Follath63028dd2019-06-13 09:15:47 +01006397}
6398
Gilles Peskine449bd832023-01-11 14:50:10 +01006399static psa_status_t psa_tls12_prf_input(psa_tls12_prf_key_derivation_t *prf,
6400 psa_key_derivation_step_t step,
6401 const uint8_t *data,
6402 size_t data_length)
Janos Follathb03233e2019-06-11 15:30:30 +01006403{
Gilles Peskine449bd832023-01-11 14:50:10 +01006404 switch (step) {
Janos Follathf08e2652019-06-13 09:05:41 +01006405 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskine449bd832023-01-11 14:50:10 +01006406 return psa_tls12_prf_set_seed(prf, data, data_length);
Janos Follath81550542019-06-13 14:26:34 +01006407 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006408 return psa_tls12_prf_set_key(prf, data, data_length);
Janos Follath63028dd2019-06-13 09:15:47 +01006409 case PSA_KEY_DERIVATION_INPUT_LABEL:
Gilles Peskine449bd832023-01-11 14:50:10 +01006410 return psa_tls12_prf_set_label(prf, data, data_length);
Janos Follathb03233e2019-06-11 15:30:30 +01006411 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006412 return PSA_ERROR_INVALID_ARGUMENT;
Janos Follathb03233e2019-06-11 15:30:30 +01006413 }
6414}
John Durkop07cc04a2020-11-16 22:08:34 -08006415#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
6416 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
6417
6418#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
6419static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
6420 psa_tls12_prf_key_derivation_t *prf,
John Durkop07cc04a2020-11-16 22:08:34 -08006421 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006422 size_t data_length)
John Durkop07cc04a2020-11-16 22:08:34 -08006423{
6424 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006425 const size_t pms_len = (prf->state == PSA_TLS12_PRF_STATE_OTHER_KEY_SET ?
6426 4 + data_length + prf->other_secret_length :
6427 4 + 2 * data_length);
John Durkop07cc04a2020-11-16 22:08:34 -08006428
Gilles Peskine449bd832023-01-11 14:50:10 +01006429 if (data_length > PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE) {
6430 return PSA_ERROR_INVALID_ARGUMENT;
6431 }
John Durkop07cc04a2020-11-16 22:08:34 -08006432
Gilles Peskine449bd832023-01-11 14:50:10 +01006433 uint8_t *pms = mbedtls_calloc(1, pms_len);
6434 if (pms == NULL) {
6435 return PSA_ERROR_INSUFFICIENT_MEMORY;
6436 }
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02006437 uint8_t *cur = pms;
6438
6439 /* pure-PSK:
6440 * Quoting RFC 4279, Section 2:
John Durkop07cc04a2020-11-16 22:08:34 -08006441 *
6442 * The premaster secret is formed as follows: if the PSK is N octets
6443 * long, concatenate a uint16 with the value N, N zero octets, a second
6444 * uint16 with the value N, and the PSK itself.
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02006445 *
6446 * mixed-PSK:
6447 * In a DHE-PSK, RSA-PSK, ECDHE-PSK the premaster secret is formed as
6448 * follows: concatenate a uint16 with the length of the other secret,
6449 * the other secret itself, uint16 with the length of PSK, and the
6450 * PSK itself.
6451 * For details please check:
6452 * - RFC 4279, Section 4 for the definition of RSA-PSK,
6453 * - RFC 4279, Section 3 for the definition of DHE-PSK,
6454 * - RFC 5489 for the definition of ECDHE-PSK.
John Durkop07cc04a2020-11-16 22:08:34 -08006455 */
6456
Gilles Peskine449bd832023-01-11 14:50:10 +01006457 if (prf->state == PSA_TLS12_PRF_STATE_OTHER_KEY_SET) {
6458 *cur++ = MBEDTLS_BYTE_1(prf->other_secret_length);
6459 *cur++ = MBEDTLS_BYTE_0(prf->other_secret_length);
6460 if (prf->other_secret_length != 0) {
6461 memcpy(cur, prf->other_secret, prf->other_secret_length);
6462 mbedtls_platform_zeroize(prf->other_secret, prf->other_secret_length);
Przemek Stekiel2503f7e2022-04-12 12:08:01 +02006463 cur += prf->other_secret_length;
6464 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006465 } else {
6466 *cur++ = MBEDTLS_BYTE_1(data_length);
6467 *cur++ = MBEDTLS_BYTE_0(data_length);
6468 memset(cur, 0, data_length);
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02006469 cur += data_length;
6470 }
6471
Gilles Peskine449bd832023-01-11 14:50:10 +01006472 *cur++ = MBEDTLS_BYTE_1(data_length);
6473 *cur++ = MBEDTLS_BYTE_0(data_length);
6474 memcpy(cur, data, data_length);
John Durkop07cc04a2020-11-16 22:08:34 -08006475 cur += data_length;
6476
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00006477 status = psa_tls12_prf_set_key(prf, pms, (size_t) (cur - pms));
John Durkop07cc04a2020-11-16 22:08:34 -08006478
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01006479 mbedtls_zeroize_and_free(pms, pms_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01006480 return status;
John Durkop07cc04a2020-11-16 22:08:34 -08006481}
Janos Follath6660f0e2019-06-17 08:44:03 +01006482
Przemek Stekiele47201b2022-04-19 13:53:28 +02006483static psa_status_t psa_tls12_prf_psk_to_ms_set_other_key(
6484 psa_tls12_prf_key_derivation_t *prf,
6485 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006486 size_t data_length)
Przemek Stekiele47201b2022-04-19 13:53:28 +02006487{
Gilles Peskine449bd832023-01-11 14:50:10 +01006488 if (prf->state != PSA_TLS12_PRF_STATE_SEED_SET) {
6489 return PSA_ERROR_BAD_STATE;
Przemek Stekiele47201b2022-04-19 13:53:28 +02006490 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006491
6492 if (data_length != 0) {
6493 prf->other_secret = mbedtls_calloc(1, data_length);
6494 if (prf->other_secret == NULL) {
6495 return PSA_ERROR_INSUFFICIENT_MEMORY;
6496 }
6497
6498 memcpy(prf->other_secret, data, data_length);
6499 prf->other_secret_length = data_length;
6500 } else {
Przemek Stekiele47201b2022-04-19 13:53:28 +02006501 prf->other_secret_length = 0;
6502 }
6503
6504 prf->state = PSA_TLS12_PRF_STATE_OTHER_KEY_SET;
6505
Gilles Peskine449bd832023-01-11 14:50:10 +01006506 return PSA_SUCCESS;
Przemek Stekiele47201b2022-04-19 13:53:28 +02006507}
6508
Janos Follath6660f0e2019-06-17 08:44:03 +01006509static psa_status_t psa_tls12_prf_psk_to_ms_input(
6510 psa_tls12_prf_key_derivation_t *prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01006511 psa_key_derivation_step_t step,
6512 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006513 size_t data_length)
Janos Follath6660f0e2019-06-17 08:44:03 +01006514{
Gilles Peskine449bd832023-01-11 14:50:10 +01006515 switch (step) {
Przemek Stekiele47201b2022-04-19 13:53:28 +02006516 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006517 return psa_tls12_prf_psk_to_ms_set_key(prf,
6518 data, data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02006519 break;
6520 case PSA_KEY_DERIVATION_INPUT_OTHER_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006521 return psa_tls12_prf_psk_to_ms_set_other_key(prf,
6522 data,
6523 data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02006524 break;
6525 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006526 return psa_tls12_prf_input(prf, step, data, data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02006527 break;
Janos Follath6660f0e2019-06-17 08:44:03 +01006528
Przemek Stekiele47201b2022-04-19 13:53:28 +02006529 }
Janos Follath6660f0e2019-06-17 08:44:03 +01006530}
John Durkop07cc04a2020-11-16 22:08:34 -08006531#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006532
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006533#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
6534static psa_status_t psa_tls12_ecjpake_to_pms_input(
6535 psa_tls12_ecjpake_to_pms_t *ecjpake,
Andrzej Kurek702776f2022-09-16 06:22:44 -04006536 psa_key_derivation_step_t step,
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006537 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006538 size_t data_length)
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006539{
Gilles Peskine449bd832023-01-11 14:50:10 +01006540 if (data_length != PSA_TLS12_ECJPAKE_TO_PMS_INPUT_SIZE ||
6541 step != PSA_KEY_DERIVATION_INPUT_SECRET) {
6542 return PSA_ERROR_INVALID_ARGUMENT;
Andrzej Kurek5603efd2022-09-26 10:49:16 -04006543 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006544
6545 /* Check if the passed point is in an uncompressed form */
Gilles Peskine449bd832023-01-11 14:50:10 +01006546 if (data[0] != 0x04) {
6547 return PSA_ERROR_INVALID_ARGUMENT;
6548 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006549
6550 /* Only K.X has to be extracted - bytes 1 to 32 inclusive. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006551 memcpy(ecjpake->data, data + 1, PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE);
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006552
Gilles Peskine449bd832023-01-11 14:50:10 +01006553 return PSA_SUCCESS;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006554}
6555#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306556
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306557#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306558static psa_status_t psa_pbkdf2_set_input_cost(
6559 psa_pbkdf2_key_derivation_t *pbkdf2,
6560 psa_key_derivation_step_t step,
6561 uint64_t data)
6562{
6563 if (step != PSA_KEY_DERIVATION_INPUT_COST) {
6564 return PSA_ERROR_INVALID_ARGUMENT;
6565 }
6566
6567 if (pbkdf2->state != PSA_PBKDF2_STATE_INIT) {
6568 return PSA_ERROR_BAD_STATE;
6569 }
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05306570
Kusumit Ghoderaoe66a8ad2023-05-24 12:30:43 +05306571 if (data > PSA_VENDOR_PBKDF2_MAX_ITERATIONS) {
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05306572 return PSA_ERROR_NOT_SUPPORTED;
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306573 }
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05306574
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306575 if (data == 0) {
6576 return PSA_ERROR_INVALID_ARGUMENT;
6577 }
Kusumit Ghoderaoe66a8ad2023-05-24 12:30:43 +05306578
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306579 pbkdf2->input_cost = data;
6580 pbkdf2->state = PSA_PBKDF2_STATE_INPUT_COST_SET;
6581
6582 return PSA_SUCCESS;
6583}
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306584
6585static psa_status_t psa_pbkdf2_set_salt(psa_pbkdf2_key_derivation_t *pbkdf2,
6586 const uint8_t *data,
6587 size_t data_length)
6588{
Gilles Peskineead17662023-08-20 22:02:51 +02006589 if (pbkdf2->state == PSA_PBKDF2_STATE_INPUT_COST_SET) {
6590 pbkdf2->state = PSA_PBKDF2_STATE_SALT_SET;
6591 } else if (pbkdf2->state == PSA_PBKDF2_STATE_SALT_SET) {
6592 /* Appending to existing salt. No state change. */
6593 } else {
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306594 return PSA_ERROR_BAD_STATE;
6595 }
6596
Gilles Peskineca57d782023-07-20 19:08:06 +02006597 if (data_length == 0) {
Gilles Peskineead17662023-08-20 22:02:51 +02006598 /* Appending an empty string, nothing to do. */
6599 } else {
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306600 uint8_t *next_salt;
Kusumit Ghoderaob538bb72023-05-24 12:32:14 +05306601
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306602 next_salt = mbedtls_calloc(1, data_length + pbkdf2->salt_length);
6603 if (next_salt == NULL) {
Kusumit Ghoderaod0422f32023-05-08 15:56:19 +05306604 return PSA_ERROR_INSUFFICIENT_MEMORY;
6605 }
6606
Gilles Peskineead17662023-08-20 22:02:51 +02006607 if (pbkdf2->salt_length != 0) {
6608 memcpy(next_salt, pbkdf2->salt, pbkdf2->salt_length);
6609 }
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306610 memcpy(next_salt + pbkdf2->salt_length, data, data_length);
Kusumit Ghoderaod0422f32023-05-08 15:56:19 +05306611 pbkdf2->salt_length += data_length;
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306612 mbedtls_free(pbkdf2->salt);
6613 pbkdf2->salt = next_salt;
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306614 }
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306615 return PSA_SUCCESS;
6616}
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306617
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05306618#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306619static psa_status_t psa_pbkdf2_hmac_set_password(psa_algorithm_t hash_alg,
Kusumit Ghoderaoaac9a582023-05-24 14:19:17 +05306620 const uint8_t *input,
6621 size_t input_len,
6622 uint8_t *output,
Kusumit Ghoderao91f99f52023-05-24 22:21:48 +05306623 size_t *output_len)
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306624{
6625 psa_status_t status = PSA_SUCCESS;
6626 if (input_len > PSA_HASH_BLOCK_LENGTH(hash_alg)) {
6627 status = psa_hash_compute(hash_alg, input, input_len, output,
Kusumit Ghoderao91f99f52023-05-24 22:21:48 +05306628 PSA_HMAC_MAX_HASH_BLOCK_SIZE, output_len);
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306629 } else {
6630 memcpy(output, input, input_len);
Kusumit Ghoderao91f99f52023-05-24 22:21:48 +05306631 *output_len = PSA_HASH_BLOCK_LENGTH(hash_alg);
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306632 }
6633 return status;
6634}
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05306635#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC */
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306636
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05306637#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128)
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306638static psa_status_t psa_pbkdf2_cmac_set_password(const uint8_t *input,
6639 size_t input_len,
6640 uint8_t *output,
6641 size_t *output_len)
6642{
6643 psa_status_t status = PSA_SUCCESS;
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306644 if (input_len != PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC)) {
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306645 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Kusumit Ghoderao3fde8fe2023-06-27 10:41:43 +05306646 uint8_t zeros[16] = { 0 };
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306647 psa_set_key_type(&attributes, PSA_KEY_TYPE_AES);
6648 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(sizeof(zeros)));
6649 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306650 /* Passing PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC) as
Kusumit Ghoderao5f3345a2023-07-27 21:21:38 +05306651 * mac_size as the driver function sets mac_output_length = mac_size
6652 * on success. See https://github.com/Mbed-TLS/mbedtls/issues/7801 */
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306653 status = psa_driver_wrapper_mac_compute(&attributes,
6654 zeros, sizeof(zeros),
6655 PSA_ALG_CMAC, input, input_len,
6656 output,
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306657 PSA_MAC_LENGTH(PSA_KEY_TYPE_AES,
6658 128U,
6659 PSA_ALG_CMAC),
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306660 output_len);
6661 } else {
6662 memcpy(output, input, input_len);
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306663 *output_len = PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC);
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306664 }
6665 return status;
6666}
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05306667#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128 */
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306668
6669static psa_status_t psa_pbkdf2_set_password(psa_pbkdf2_key_derivation_t *pbkdf2,
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306670 psa_algorithm_t kdf_alg,
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306671 const uint8_t *data,
6672 size_t data_length)
6673{
Kusumit Ghoderaoaac9a582023-05-24 14:19:17 +05306674 psa_status_t status = PSA_SUCCESS;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306675 if (pbkdf2->state != PSA_PBKDF2_STATE_SALT_SET) {
6676 return PSA_ERROR_BAD_STATE;
6677 }
6678
Kusumit Ghoderaof3e696d2023-07-28 13:30:50 +05306679#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306680 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
6681 psa_algorithm_t hash_alg = PSA_ALG_PBKDF2_HMAC_GET_HASH(kdf_alg);
6682 status = psa_pbkdf2_hmac_set_password(hash_alg, data, data_length,
6683 pbkdf2->password,
6684 &pbkdf2->password_length);
Kusumit Ghoderaof3e696d2023-07-28 13:30:50 +05306685 } else
6686#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC */
6687#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128)
6688 if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306689 status = psa_pbkdf2_cmac_set_password(data, data_length,
6690 pbkdf2->password,
6691 &pbkdf2->password_length);
Kusumit Ghoderaof3e696d2023-07-28 13:30:50 +05306692 } else
6693#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128 */
6694 {
6695 return PSA_ERROR_INVALID_ARGUMENT;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306696 }
6697
6698 pbkdf2->state = PSA_PBKDF2_STATE_PASSWORD_SET;
6699
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306700 return status;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306701}
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05306702
6703static psa_status_t psa_pbkdf2_input(psa_pbkdf2_key_derivation_t *pbkdf2,
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306704 psa_algorithm_t kdf_alg,
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05306705 psa_key_derivation_step_t step,
6706 const uint8_t *data,
6707 size_t data_length)
6708{
6709 switch (step) {
6710 case PSA_KEY_DERIVATION_INPUT_SALT:
6711 return psa_pbkdf2_set_salt(pbkdf2, data, data_length);
6712 case PSA_KEY_DERIVATION_INPUT_PASSWORD:
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306713 return psa_pbkdf2_set_password(pbkdf2, kdf_alg, data, data_length);
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05306714 default:
6715 return PSA_ERROR_INVALID_ARGUMENT;
6716 }
6717}
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306718#endif /* PSA_HAVE_SOFT_PBKDF2 */
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306719
Gilles Peskineb8965192019-09-24 16:21:10 +02006720/** Check whether the given key type is acceptable for the given
6721 * input step of a key derivation.
6722 *
6723 * Secret inputs must have the type #PSA_KEY_TYPE_DERIVE.
6724 * Non-secret inputs must have the type #PSA_KEY_TYPE_RAW_DATA.
6725 * Both secret and non-secret inputs can alternatively have the type
6726 * #PSA_KEY_TYPE_NONE, which is never the type of a key object, meaning
6727 * that the input was passed as a buffer rather than via a key object.
6728 */
Gilles Peskine224b0d62019-09-23 18:13:17 +02006729static int psa_key_derivation_check_input_type(
6730 psa_key_derivation_step_t step,
Gilles Peskine449bd832023-01-11 14:50:10 +01006731 psa_key_type_t key_type)
Gilles Peskine224b0d62019-09-23 18:13:17 +02006732{
Gilles Peskine449bd832023-01-11 14:50:10 +01006733 switch (step) {
Gilles Peskine224b0d62019-09-23 18:13:17 +02006734 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006735 if (key_type == PSA_KEY_TYPE_DERIVE) {
6736 return PSA_SUCCESS;
6737 }
6738 if (key_type == PSA_KEY_TYPE_NONE) {
6739 return PSA_SUCCESS;
6740 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02006741 break;
Przemek Stekiela7695a22022-04-07 15:39:01 +02006742 case PSA_KEY_DERIVATION_INPUT_OTHER_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006743 if (key_type == PSA_KEY_TYPE_DERIVE) {
6744 return PSA_SUCCESS;
6745 }
6746 if (key_type == PSA_KEY_TYPE_NONE) {
6747 return PSA_SUCCESS;
6748 }
Przemek Stekiela7695a22022-04-07 15:39:01 +02006749 break;
Gilles Peskine224b0d62019-09-23 18:13:17 +02006750 case PSA_KEY_DERIVATION_INPUT_LABEL:
6751 case PSA_KEY_DERIVATION_INPUT_SALT:
6752 case PSA_KEY_DERIVATION_INPUT_INFO:
6753 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskine449bd832023-01-11 14:50:10 +01006754 if (key_type == PSA_KEY_TYPE_RAW_DATA) {
6755 return PSA_SUCCESS;
6756 }
6757 if (key_type == PSA_KEY_TYPE_NONE) {
6758 return PSA_SUCCESS;
6759 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02006760 break;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306761 case PSA_KEY_DERIVATION_INPUT_PASSWORD:
6762 if (key_type == PSA_KEY_TYPE_PASSWORD) {
6763 return PSA_SUCCESS;
6764 }
6765 if (key_type == PSA_KEY_TYPE_DERIVE) {
6766 return PSA_SUCCESS;
6767 }
6768 if (key_type == PSA_KEY_TYPE_NONE) {
6769 return PSA_SUCCESS;
6770 }
6771 break;
Gilles Peskine224b0d62019-09-23 18:13:17 +02006772 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006773 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine224b0d62019-09-23 18:13:17 +02006774}
6775
Janos Follathb80a94e2019-06-12 15:54:46 +01006776static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006777 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01006778 psa_key_derivation_step_t step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02006779 psa_key_type_t key_type,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01006780 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006781 size_t data_length)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006782{
Gilles Peskine46d7faf2019-09-23 19:22:55 +02006783 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006784 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
Gilles Peskine46d7faf2019-09-23 19:22:55 +02006785
Gilles Peskine449bd832023-01-11 14:50:10 +01006786 status = psa_key_derivation_check_input_type(step, key_type);
6787 if (status != PSA_SUCCESS) {
Gilles Peskine224b0d62019-09-23 18:13:17 +02006788 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006789 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02006790
Przemek Stekiel69c46792022-06-10 12:59:51 +02006791#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006792 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
6793 status = psa_hkdf_input(&operation->ctx.hkdf, kdf_alg,
6794 step, data, data_length);
6795 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02006796#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08006797#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006798 if (PSA_ALG_IS_TLS12_PRF(kdf_alg)) {
6799 status = psa_tls12_prf_input(&operation->ctx.tls12_prf,
6800 step, data, data_length);
6801 } else
John Durkop07cc04a2020-11-16 22:08:34 -08006802#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF */
6803#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006804 if (PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
6805 status = psa_tls12_prf_psk_to_ms_input(&operation->ctx.tls12_prf,
6806 step, data, data_length);
6807 } else
John Durkop07cc04a2020-11-16 22:08:34 -08006808#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006809#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006810 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006811 status = psa_tls12_ecjpake_to_pms_input(
Gilles Peskine449bd832023-01-11 14:50:10 +01006812 &operation->ctx.tls12_ecjpake_to_pms, step, data, data_length);
6813 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006814#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306815#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05306816 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306817 status = psa_pbkdf2_input(&operation->ctx.pbkdf2, kdf_alg,
6818 step, data, data_length);
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05306819 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306820#endif /* PSA_HAVE_SOFT_PBKDF2 */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006821 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006822 /* This can't happen unless the operation object was not initialized */
Steven Cooreman74afe472021-02-10 17:19:22 +01006823 (void) data;
6824 (void) data_length;
6825 (void) kdf_alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01006826 return PSA_ERROR_BAD_STATE;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006827 }
6828
Gilles Peskine224b0d62019-09-23 18:13:17 +02006829exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01006830 if (status != PSA_SUCCESS) {
6831 psa_key_derivation_abort(operation);
6832 }
6833 return status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006834}
6835
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05306836static psa_status_t psa_key_derivation_input_integer_internal(
6837 psa_key_derivation_operation_t *operation,
6838 psa_key_derivation_step_t step,
6839 uint64_t value)
6840{
6841 psa_status_t status;
6842 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
6843
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306844#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05306845 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306846 status = psa_pbkdf2_set_input_cost(
6847 &operation->ctx.pbkdf2, step, value);
6848 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306849#endif /* PSA_HAVE_SOFT_PBKDF2 */
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05306850 {
Kusumit Ghoderao3a18dee2023-04-07 16:16:27 +05306851 (void) step;
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05306852 (void) value;
6853 (void) kdf_alg;
Kusumit Ghoderaoa14ae5a2023-04-19 14:16:26 +05306854 status = PSA_ERROR_INVALID_ARGUMENT;
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05306855 }
6856
6857 if (status != PSA_SUCCESS) {
6858 psa_key_derivation_abort(operation);
6859 }
6860 return status;
6861}
6862
Janos Follath51f4a0f2019-06-14 11:35:55 +01006863psa_status_t psa_key_derivation_input_bytes(
6864 psa_key_derivation_operation_t *operation,
6865 psa_key_derivation_step_t step,
6866 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006867 size_t data_length)
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01006868{
Gilles Peskine449bd832023-01-11 14:50:10 +01006869 return psa_key_derivation_input_internal(operation, step,
6870 PSA_KEY_TYPE_NONE,
6871 data, data_length);
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01006872}
6873
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05306874psa_status_t psa_key_derivation_input_integer(
6875 psa_key_derivation_operation_t *operation,
6876 psa_key_derivation_step_t step,
6877 uint64_t value)
6878{
6879 return psa_key_derivation_input_integer_internal(operation, step, value);
6880}
6881
Janos Follath51f4a0f2019-06-14 11:35:55 +01006882psa_status_t psa_key_derivation_input_key(
6883 psa_key_derivation_operation_t *operation,
6884 psa_key_derivation_step_t step,
Gilles Peskine449bd832023-01-11 14:50:10 +01006885 mbedtls_svc_key_id_t key)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006886{
Ronald Cronf95a2b12020-10-22 15:24:49 +02006887 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01006888 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006889 psa_key_slot_t *slot;
Gilles Peskine178c9aa2019-09-24 18:21:06 +02006890
Ronald Cron5c522922020-11-14 16:35:34 +01006891 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01006892 key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg);
6893 if (status != PSA_SUCCESS) {
6894 psa_key_derivation_abort(operation);
6895 return status;
Gilles Peskine593773d2019-09-23 18:17:40 +02006896 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02006897
Kusumit Ghoderao3128c5d2023-05-03 12:27:57 +05306898 /* Passing a key object as a SECRET or PASSWORD input unlocks the
6899 * permission to output to a key object. */
6900 if (step == PSA_KEY_DERIVATION_INPUT_SECRET ||
6901 step == PSA_KEY_DERIVATION_INPUT_PASSWORD) {
Gilles Peskine178c9aa2019-09-24 18:21:06 +02006902 operation->can_output_key = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01006903 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02006904
Gilles Peskine449bd832023-01-11 14:50:10 +01006905 status = psa_key_derivation_input_internal(operation,
6906 step, slot->attr.type,
6907 slot->key.data,
6908 slot->key.bytes);
Ronald Cronf95a2b12020-10-22 15:24:49 +02006909
Ryan Everett1b70a072024-01-04 10:32:49 +00006910 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02006911
Gilles Peskine449bd832023-01-11 14:50:10 +01006912 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006913}
Gilles Peskineea0fb492018-07-12 17:17:20 +02006914
6915
6916
6917/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02006918/* Key agreement */
6919/****************************************************************/
6920
Gilles Peskine449bd832023-01-11 14:50:10 +01006921psa_status_t psa_key_agreement_raw_builtin(const psa_key_attributes_t *attributes,
6922 const uint8_t *key_buffer,
6923 size_t key_buffer_size,
6924 psa_algorithm_t alg,
6925 const uint8_t *peer_key,
6926 size_t peer_key_length,
6927 uint8_t *shared_secret,
6928 size_t shared_secret_size,
6929 size_t *shared_secret_length)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02006930{
Gilles Peskine449bd832023-01-11 14:50:10 +01006931 switch (alg) {
John Durkop6ba40d12020-11-10 08:50:04 -08006932#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskine0216fe12019-04-11 21:23:21 +02006933 case PSA_ALG_ECDH:
Gilles Peskine449bd832023-01-11 14:50:10 +01006934 return mbedtls_psa_key_agreement_ecdh(attributes, key_buffer,
6935 key_buffer_size, alg,
6936 peer_key, peer_key_length,
6937 shared_secret,
6938 shared_secret_size,
6939 shared_secret_length);
Gilles Peskine01d718c2018-09-18 12:01:02 +02006940#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Przemek Stekielfb3dd542022-12-01 14:59:15 +01006941
6942#if defined(MBEDTLS_PSA_BUILTIN_ALG_FFDH)
6943 case PSA_ALG_FFDH:
Przemek Stekiel152bb462023-06-01 11:52:39 +02006944 return mbedtls_psa_ffdh_key_agreement(attributes,
Przemek Stekiel359f4622022-12-05 14:11:55 +01006945 peer_key,
6946 peer_key_length,
6947 key_buffer,
6948 key_buffer_size,
6949 shared_secret,
6950 shared_secret_size,
6951 shared_secret_length);
Przemek Stekielfb3dd542022-12-01 14:59:15 +01006952#endif /* MBEDTLS_PSA_BUILTIN_ALG_FFDH */
6953
Gilles Peskine01d718c2018-09-18 12:01:02 +02006954 default:
Aditya Deshpande17845b82022-10-13 17:21:01 +01006955 (void) attributes;
6956 (void) key_buffer;
6957 (void) key_buffer_size;
Gilles Peskine93f85002018-11-16 16:43:31 +01006958 (void) peer_key;
6959 (void) peer_key_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02006960 (void) shared_secret;
6961 (void) shared_secret_size;
6962 (void) shared_secret_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01006963 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine01d718c2018-09-18 12:01:02 +02006964 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02006965}
Gilles Peskine01d718c2018-09-18 12:01:02 +02006966
Aditya Deshpande17845b82022-10-13 17:21:01 +01006967/** Internal function for raw key agreement
6968 * Calls the driver wrapper which will hand off key agreement task
Aditya Deshpande40c05cc2022-10-14 16:41:40 +01006969 * to the driver's implementation if a driver is present.
6970 * Fallback specified in the driver wrapper is built-in raw key agreement
Aditya Deshpande17845b82022-10-13 17:21:01 +01006971 * (psa_key_agreement_raw_builtin).
6972 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006973static psa_status_t psa_key_agreement_raw_internal(psa_algorithm_t alg,
6974 psa_key_slot_t *private_key,
6975 const uint8_t *peer_key,
6976 size_t peer_key_length,
6977 uint8_t *shared_secret,
6978 size_t shared_secret_size,
6979 size_t *shared_secret_length)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006980{
Gilles Peskine449bd832023-01-11 14:50:10 +01006981 if (!PSA_ALG_IS_RAW_KEY_AGREEMENT(alg)) {
6982 return PSA_ERROR_NOT_SUPPORTED;
6983 }
Aditya Deshpande17845b82022-10-13 17:21:01 +01006984
6985 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01006986 .core = private_key->attr
Aditya Deshpande17845b82022-10-13 17:21:01 +01006987 };
6988
Gilles Peskine449bd832023-01-11 14:50:10 +01006989 return psa_driver_wrapper_key_agreement(&attributes,
6990 private_key->key.data,
6991 private_key->key.bytes, alg,
6992 peer_key, peer_key_length,
6993 shared_secret,
6994 shared_secret_size,
6995 shared_secret_length);
Gilles Peskine0216fe12019-04-11 21:23:21 +02006996}
6997
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02006998/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine01d718c2018-09-18 12:01:02 +02006999 * to potentially free embedded data structures and wipe confidential data.
7000 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007001static psa_status_t psa_key_agreement_internal(psa_key_derivation_operation_t *operation,
7002 psa_key_derivation_step_t step,
7003 psa_key_slot_t *private_key,
7004 const uint8_t *peer_key,
7005 size_t peer_key_length)
Gilles Peskine01d718c2018-09-18 12:01:02 +02007006{
7007 psa_status_t status;
Aditya Deshpande2f7fd762022-11-22 11:10:34 +00007008 uint8_t shared_secret[PSA_RAW_KEY_AGREEMENT_OUTPUT_MAX_SIZE];
Gilles Peskine01d718c2018-09-18 12:01:02 +02007009 size_t shared_secret_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007010 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE(operation->alg);
Gilles Peskine01d718c2018-09-18 12:01:02 +02007011
7012 /* Step 1: run the secret agreement algorithm to generate the shared
7013 * secret. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007014 status = psa_key_agreement_raw_internal(ka_alg,
7015 private_key,
7016 peer_key, peer_key_length,
7017 shared_secret,
7018 sizeof(shared_secret),
7019 &shared_secret_length);
7020 if (status != PSA_SUCCESS) {
Gilles Peskine12313cd2018-06-20 00:20:32 +02007021 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007022 }
Gilles Peskine12313cd2018-06-20 00:20:32 +02007023
Gilles Peskineb0b255c2018-07-06 17:01:38 +02007024 /* Step 2: set up the key derivation to generate key material from
Gilles Peskine224b0d62019-09-23 18:13:17 +02007025 * the shared secret. A shared secret is permitted wherever a key
7026 * of type DERIVE is permitted. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007027 status = psa_key_derivation_input_internal(operation, step,
7028 PSA_KEY_TYPE_DERIVE,
7029 shared_secret,
7030 shared_secret_length);
Gilles Peskine12313cd2018-06-20 00:20:32 +02007031exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007032 mbedtls_platform_zeroize(shared_secret, shared_secret_length);
7033 return status;
Gilles Peskine12313cd2018-06-20 00:20:32 +02007034}
7035
Gilles Peskine449bd832023-01-11 14:50:10 +01007036psa_status_t psa_key_derivation_key_agreement(psa_key_derivation_operation_t *operation,
7037 psa_key_derivation_step_t step,
7038 mbedtls_svc_key_id_t private_key,
7039 const uint8_t *peer_key,
7040 size_t peer_key_length)
Gilles Peskine12313cd2018-06-20 00:20:32 +02007041{
Ronald Cronf95a2b12020-10-22 15:24:49 +02007042 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01007043 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01007044 psa_key_slot_t *slot;
Ronald Cronf95a2b12020-10-22 15:24:49 +02007045
Gilles Peskine449bd832023-01-11 14:50:10 +01007046 if (!PSA_ALG_IS_KEY_AGREEMENT(operation->alg)) {
7047 return PSA_ERROR_INVALID_ARGUMENT;
7048 }
Ronald Cron5c522922020-11-14 16:35:34 +01007049 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01007050 private_key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg);
7051 if (status != PSA_SUCCESS) {
7052 return status;
7053 }
7054 status = psa_key_agreement_internal(operation, step,
7055 slot,
7056 peer_key, peer_key_length);
7057 if (status != PSA_SUCCESS) {
7058 psa_key_derivation_abort(operation);
7059 } else {
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007060 /* If a private key has been added as SECRET, we allow the derived
7061 * key material to be used as a key in PSA Crypto. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007062 if (step == PSA_KEY_DERIVATION_INPUT_SECRET) {
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007063 operation->can_output_key = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01007064 }
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007065 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007066
Ryan Everett1b70a072024-01-04 10:32:49 +00007067 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007068
Gilles Peskine449bd832023-01-11 14:50:10 +01007069 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskineaf3baab2018-06-27 22:55:52 +02007070}
7071
Gilles Peskine449bd832023-01-11 14:50:10 +01007072psa_status_t psa_raw_key_agreement(psa_algorithm_t alg,
7073 mbedtls_svc_key_id_t private_key,
7074 const uint8_t *peer_key,
7075 size_t peer_key_length,
7076 uint8_t *output,
7077 size_t output_size,
7078 size_t *output_length)
Gilles Peskine0216fe12019-04-11 21:23:21 +02007079{
Ronald Cronf95a2b12020-10-22 15:24:49 +02007080 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01007081 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +02007082 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007083 size_t expected_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02007084
Gilles Peskine449bd832023-01-11 14:50:10 +01007085 if (!PSA_ALG_IS_KEY_AGREEMENT(alg)) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007086 status = PSA_ERROR_INVALID_ARGUMENT;
7087 goto exit;
7088 }
Ronald Cron5c522922020-11-14 16:35:34 +01007089 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01007090 private_key, &slot, PSA_KEY_USAGE_DERIVE, alg);
7091 if (status != PSA_SUCCESS) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007092 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007093 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02007094
Gilles Peskine3e561302022-04-14 00:17:15 +02007095 /* PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() is in general an upper bound
7096 * for the output size. The PSA specification only guarantees that this
7097 * function works if output_size >= PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE(...),
7098 * but it might be nice to allow smaller buffers if the output fits.
7099 * At the time of writing this comment, with only ECDH implemented,
7100 * PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() is exact so the point is moot.
7101 * If FFDH is implemented, PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() can easily
7102 * be exact for it as well. */
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007103 expected_length =
Gilles Peskine449bd832023-01-11 14:50:10 +01007104 PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE(slot->attr.type, slot->attr.bits);
7105 if (output_size < expected_length) {
Gilles Peskine3e561302022-04-14 00:17:15 +02007106 status = PSA_ERROR_BUFFER_TOO_SMALL;
7107 goto exit;
7108 }
7109
Gilles Peskine449bd832023-01-11 14:50:10 +01007110 status = psa_key_agreement_raw_internal(alg, slot,
7111 peer_key, peer_key_length,
7112 output, output_size,
7113 output_length);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007114
7115exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007116 if (status != PSA_SUCCESS) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007117 /* If an error happens and is not handled properly, the output
7118 * may be used as a key to protect sensitive data. Arrange for such
7119 * a key to be random, which is likely to result in decryption or
7120 * verification errors. This is better than filling the buffer with
7121 * some constant data such as zeros, which would result in the data
7122 * being protected with a reproducible, easily knowable key.
7123 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007124 psa_generate_random(output, output_size);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007125 *output_length = output_size;
7126 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007127
Ryan Everett1b70a072024-01-04 10:32:49 +00007128 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007129
Gilles Peskine449bd832023-01-11 14:50:10 +01007130 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine0216fe12019-04-11 21:23:21 +02007131}
Gilles Peskine86a440b2018-11-12 18:39:40 +01007132
7133
Gilles Peskine30524eb2020-11-13 17:02:26 +01007134
Gilles Peskine86a440b2018-11-12 18:39:40 +01007135/****************************************************************/
7136/* Random generation */
Gilles Peskine53d991e2018-07-12 01:14:59 +02007137/****************************************************************/
Gilles Peskine12313cd2018-06-20 00:20:32 +02007138
Gilles Peskine672a7712023-04-28 21:00:28 +02007139#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
7140#include "entropy_poll.h"
7141#endif
7142
Gilles Peskine30524eb2020-11-13 17:02:26 +01007143/** Initialize the PSA random generator.
7144 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007145static void mbedtls_psa_random_init(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01007146{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007147#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine449bd832023-01-11 14:50:10 +01007148 memset(rng, 0, sizeof(*rng));
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007149#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
7150
Gilles Peskine30524eb2020-11-13 17:02:26 +01007151 /* Set default configuration if
7152 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007153 if (rng->entropy_init == NULL) {
Gilles Peskine30524eb2020-11-13 17:02:26 +01007154 rng->entropy_init = mbedtls_entropy_init;
Gilles Peskine449bd832023-01-11 14:50:10 +01007155 }
7156 if (rng->entropy_free == NULL) {
Gilles Peskine30524eb2020-11-13 17:02:26 +01007157 rng->entropy_free = mbedtls_entropy_free;
Gilles Peskine449bd832023-01-11 14:50:10 +01007158 }
Gilles Peskine30524eb2020-11-13 17:02:26 +01007159
Gilles Peskine449bd832023-01-11 14:50:10 +01007160 rng->entropy_init(&rng->entropy);
Gilles Peskine30524eb2020-11-13 17:02:26 +01007161#if defined(MBEDTLS_PSA_INJECT_ENTROPY) && \
7162 defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
7163 /* The PSA entropy injection feature depends on using NV seed as an entropy
7164 * source. Add NV seed as an entropy source for PSA entropy injection. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007165 mbedtls_entropy_add_source(&rng->entropy,
7166 mbedtls_nv_seed_poll, NULL,
7167 MBEDTLS_ENTROPY_BLOCK_SIZE,
7168 MBEDTLS_ENTROPY_SOURCE_STRONG);
Gilles Peskine30524eb2020-11-13 17:02:26 +01007169#endif
7170
Gilles Peskine449bd832023-01-11 14:50:10 +01007171 mbedtls_psa_drbg_init(MBEDTLS_PSA_RANDOM_STATE);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007172#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007173}
7174
7175/** Deinitialize the PSA random generator.
7176 */
Valerio Setti83e0de82023-11-24 12:13:05 +01007177static void mbedtls_psa_random_free(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01007178{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007179#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Valerio Setti83e0de82023-11-24 12:13:05 +01007180 memset(rng, 0, sizeof(*rng));
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007181#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Valerio Setti83e0de82023-11-24 12:13:05 +01007182 mbedtls_psa_drbg_free(MBEDTLS_PSA_RANDOM_STATE);
7183 rng->entropy_free(&rng->entropy);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007184#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007185}
7186
7187/** Seed the PSA random generator.
7188 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007189static psa_status_t mbedtls_psa_random_seed(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01007190{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007191#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
7192 /* Do nothing: the external RNG seeds itself. */
7193 (void) rng;
Gilles Peskine449bd832023-01-11 14:50:10 +01007194 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007195#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007196 const unsigned char drbg_seed[] = "PSA";
Gilles Peskine449bd832023-01-11 14:50:10 +01007197 int ret = mbedtls_psa_drbg_seed(&rng->entropy,
7198 drbg_seed, sizeof(drbg_seed) - 1);
7199 return mbedtls_to_psa_error(ret);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007200#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007201}
7202
Gilles Peskine449bd832023-01-11 14:50:10 +01007203psa_status_t psa_generate_random(uint8_t *output,
7204 size_t output_size)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007205{
Gilles Peskinee59236f2018-01-27 23:32:46 +01007206 GUARD_MODULE_INITIALIZED;
7207
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007208#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
7209
7210 size_t output_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007211 psa_status_t status = mbedtls_psa_external_get_random(&global_data.rng,
7212 output, output_size,
7213 &output_length);
7214 if (status != PSA_SUCCESS) {
7215 return status;
7216 }
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007217 /* Breaking up a request into smaller chunks is currently not supported
Tom Cosgrove1797b052022-12-04 17:19:59 +00007218 * for the external RNG interface. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007219 if (output_length != output_size) {
7220 return PSA_ERROR_INSUFFICIENT_ENTROPY;
7221 }
7222 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007223
7224#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
7225
Gilles Peskine449bd832023-01-11 14:50:10 +01007226 while (output_size > 0) {
Gilles Peskine71ddab92021-01-04 21:01:07 +01007227 size_t request_size =
Gilles Peskine449bd832023-01-11 14:50:10 +01007228 (output_size > MBEDTLS_PSA_RANDOM_MAX_REQUEST ?
7229 MBEDTLS_PSA_RANDOM_MAX_REQUEST :
7230 output_size);
7231 int ret = mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE,
7232 output, request_size);
7233 if (ret != 0) {
7234 return mbedtls_to_psa_error(ret);
7235 }
Gilles Peskine71ddab92021-01-04 21:01:07 +01007236 output_size -= request_size;
7237 output += request_size;
Gilles Peskinef181eca2019-08-07 13:49:00 +02007238 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007239 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007240#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskinee59236f2018-01-27 23:32:46 +01007241}
7242
Gilles Peskine8814fc42020-12-14 15:33:44 +01007243/* Wrapper function allowing the classic API to use the PSA RNG.
Gilles Peskine9c3e0602021-01-05 16:03:55 +01007244 *
7245 * `mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE, ...)` calls
7246 * `psa_generate_random(...)`. The state parameter is ignored since the
7247 * PSA API doesn't support passing an explicit state.
7248 *
7249 * In the non-external case, psa_generate_random() calls an
7250 * `mbedtls_xxx_drbg_random` function which has exactly the same signature
7251 * and semantics as mbedtls_psa_get_random(). As an optimization,
7252 * instead of doing this back-and-forth between the PSA API and the
7253 * classic API, psa_crypto_random_impl.h defines `mbedtls_psa_get_random`
7254 * as a constant function pointer to `mbedtls_xxx_drbg_random`.
Gilles Peskine8814fc42020-12-14 15:33:44 +01007255 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007256#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
7257int mbedtls_psa_get_random(void *p_rng,
7258 unsigned char *output,
7259 size_t output_size)
Gilles Peskine8814fc42020-12-14 15:33:44 +01007260{
Gilles Peskine9c3e0602021-01-05 16:03:55 +01007261 /* This function takes a pointer to the RNG state because that's what
7262 * classic mbedtls functions using an RNG expect. The PSA RNG manages
7263 * its own state internally and doesn't let the caller access that state.
7264 * So we just ignore the state parameter, and in practice we'll pass
7265 * NULL. */
Gilles Peskine8814fc42020-12-14 15:33:44 +01007266 (void) p_rng;
Gilles Peskine449bd832023-01-11 14:50:10 +01007267 psa_status_t status = psa_generate_random(output, output_size);
7268 if (status == PSA_SUCCESS) {
7269 return 0;
7270 } else {
7271 return MBEDTLS_ERR_ENTROPY_SOURCE_FAILED;
7272 }
Gilles Peskine8814fc42020-12-14 15:33:44 +01007273}
7274#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
7275
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01007276#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
Gilles Peskine449bd832023-01-11 14:50:10 +01007277psa_status_t mbedtls_psa_inject_entropy(const uint8_t *seed,
7278 size_t seed_size)
Netanel Gonen2bcd3122018-11-19 11:53:02 +02007279{
Gilles Peskine449bd832023-01-11 14:50:10 +01007280 if (global_data.initialized) {
7281 return PSA_ERROR_NOT_PERMITTED;
7282 }
Netanel Gonen21f37cb2018-11-19 11:53:55 +02007283
Gilles Peskine449bd832023-01-11 14:50:10 +01007284 if (((seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM) ||
7285 (seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE)) ||
7286 (seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE)) {
7287 return PSA_ERROR_INVALID_ARGUMENT;
7288 }
Netanel Gonen21f37cb2018-11-19 11:53:55 +02007289
Gilles Peskine449bd832023-01-11 14:50:10 +01007290 return mbedtls_psa_storage_inject_entropy(seed, seed_size);
Netanel Gonen2bcd3122018-11-19 11:53:02 +02007291}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01007292#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02007293
Ronald Cron3772afe2021-02-08 16:10:05 +01007294/** Validate the key type and size for key generation
Ronald Cron01b2aba2020-10-05 09:42:02 +02007295 *
Ronald Cron3772afe2021-02-08 16:10:05 +01007296 * \param type The key type
7297 * \param bits The number of bits of the key
Ronald Cron01b2aba2020-10-05 09:42:02 +02007298 *
7299 * \retval #PSA_SUCCESS
Ronald Cron3772afe2021-02-08 16:10:05 +01007300 * The key type and size are valid.
Ronald Cron01b2aba2020-10-05 09:42:02 +02007301 * \retval #PSA_ERROR_INVALID_ARGUMENT
7302 * The size in bits of the key is not valid.
7303 * \retval #PSA_ERROR_NOT_SUPPORTED
7304 * The type and/or the size in bits of the key or the combination of
7305 * the two is not supported.
7306 */
Ronald Cron3772afe2021-02-08 16:10:05 +01007307static psa_status_t psa_validate_key_type_and_size_for_key_generation(
Gilles Peskine449bd832023-01-11 14:50:10 +01007308 psa_key_type_t type, size_t bits)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007309{
Ronald Cronf3bb7612020-10-02 20:11:59 +02007310 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007311
Gilles Peskine449bd832023-01-11 14:50:10 +01007312 if (key_type_is_raw_bytes(type)) {
7313 status = psa_validate_unstructured_key_bit_size(type, bits);
7314 if (status != PSA_SUCCESS) {
7315 return status;
7316 }
7317 } else
Valerio Settif6d4dfb2023-07-10 10:55:12 +02007318#if defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007319 if (PSA_KEY_TYPE_IS_RSA(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
7320 if (bits > PSA_VENDOR_RSA_MAX_KEY_BITS) {
7321 return PSA_ERROR_NOT_SUPPORTED;
7322 }
Waleed Elmelegyd7bdbbe2023-07-20 16:26:58 +00007323 if (bits < PSA_VENDOR_RSA_GENERATE_MIN_KEY_BITS) {
Waleed Elmelegyab570712023-07-05 16:40:58 +00007324 return PSA_ERROR_NOT_SUPPORTED;
7325 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +02007326
Ronald Cron01b2aba2020-10-05 09:42:02 +02007327 /* Accept only byte-aligned keys, for the same reasons as
7328 * in psa_import_rsa_key(). */
Gilles Peskine449bd832023-01-11 14:50:10 +01007329 if (bits % 8 != 0) {
7330 return PSA_ERROR_NOT_SUPPORTED;
7331 }
7332 } else
Valerio Settif6d4dfb2023-07-10 10:55:12 +02007333#endif /* defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02007334
Valerio Setti6a9d0ee2023-06-21 10:07:21 +02007335#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007336 if (PSA_KEY_TYPE_IS_ECC(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
Ronald Crond81ab562021-02-16 09:01:16 +01007337 /* To avoid empty block, return successfully here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007338 return PSA_SUCCESS;
7339 } else
Valerio Setti6a9d0ee2023-06-21 10:07:21 +02007340#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_GENERATE) */
Przemek Stekielfedd1342022-12-01 15:00:02 +01007341
Valerio Settia55f0422023-07-10 15:34:41 +02007342#if defined(PSA_WANT_KEY_TYPE_DH_KEY_PAIR_GENERATE)
Przemek Stekielfedd1342022-12-01 15:00:02 +01007343 if (PSA_KEY_TYPE_IS_DH(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
Przemek Stekield1cf1ba2023-04-27 12:04:21 +02007344 if (psa_is_dh_key_size_valid(bits) == 0) {
Przemek Stekielfedd1342022-12-01 15:00:02 +01007345 return PSA_ERROR_NOT_SUPPORTED;
7346 }
7347 } else
Valerio Settia55f0422023-07-10 15:34:41 +02007348#endif /* defined(PSA_WANT_KEY_TYPE_DH_KEY_PAIR_GENERATE) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02007349 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007350 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007351 }
7352
Gilles Peskine449bd832023-01-11 14:50:10 +01007353 return PSA_SUCCESS;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007354}
7355
Ronald Cron55ed0592020-10-05 10:30:40 +02007356psa_status_t psa_generate_key_internal(
Ronald Cron2a38a6b2020-10-02 20:02:04 +02007357 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01007358 uint8_t *key_buffer, size_t key_buffer_size, size_t *key_buffer_length)
Ronald Cron01b2aba2020-10-05 09:42:02 +02007359{
7360 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2a38a6b2020-10-02 20:02:04 +02007361 psa_key_type_t type = attributes->core.type;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007362
Gilles Peskine449bd832023-01-11 14:50:10 +01007363 if ((attributes->domain_parameters == NULL) &&
7364 (attributes->domain_parameters_size != 0)) {
7365 return PSA_ERROR_INVALID_ARGUMENT;
7366 }
Ronald Cron01b2aba2020-10-05 09:42:02 +02007367
Gilles Peskine449bd832023-01-11 14:50:10 +01007368 if (key_type_is_raw_bytes(type)) {
7369 status = psa_generate_random(key_buffer, key_buffer_size);
7370 if (status != PSA_SUCCESS) {
7371 return status;
7372 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +02007373
David Brown12ca5032021-02-11 11:02:00 -07007374#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01007375 if (type == PSA_KEY_TYPE_DES) {
7376 psa_des_set_key_parity(key_buffer, key_buffer_size);
7377 }
David Brown8107e312021-02-12 08:08:46 -07007378#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine449bd832023-01-11 14:50:10 +01007379 } else
Gilles Peskinee59236f2018-01-27 23:32:46 +01007380
Valerio Setti76df8c12023-07-11 14:11:28 +02007381#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007382 if (type == PSA_KEY_TYPE_RSA_KEY_PAIR) {
7383 return mbedtls_psa_rsa_generate_key(attributes,
7384 key_buffer,
7385 key_buffer_size,
7386 key_buffer_length);
7387 } else
Valerio Setti76df8c12023-07-11 14:11:28 +02007388#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_GENERATE) */
Gilles Peskinee59236f2018-01-27 23:32:46 +01007389
Valerio Settibfeaf5b2023-06-20 13:27:46 +02007390#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007391 if (PSA_KEY_TYPE_IS_ECC(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
7392 return mbedtls_psa_ecp_generate_key(attributes,
7393 key_buffer,
7394 key_buffer_size,
7395 key_buffer_length);
7396 } else
Valerio Settibfeaf5b2023-06-20 13:27:46 +02007397#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_GENERATE) */
Przemek Stekielfedd1342022-12-01 15:00:02 +01007398
Valerio Settia55f0422023-07-10 15:34:41 +02007399#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_GENERATE)
Przemek Stekielfedd1342022-12-01 15:00:02 +01007400 if (PSA_KEY_TYPE_IS_DH(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
7401 return mbedtls_psa_ffdh_generate_key(attributes,
7402 key_buffer,
7403 key_buffer_size,
7404 key_buffer_length);
7405 } else
Valerio Settia55f0422023-07-10 15:34:41 +02007406#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_GENERATE) */
Steven Cooreman29149862020-08-05 15:43:42 +02007407 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007408 (void) key_buffer_length;
7409 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman29149862020-08-05 15:43:42 +02007410 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01007411
Gilles Peskine449bd832023-01-11 14:50:10 +01007412 return PSA_SUCCESS;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02007413}
Darryl Green0c6575a2018-11-07 16:05:30 +00007414
Gilles Peskine449bd832023-01-11 14:50:10 +01007415psa_status_t psa_generate_key(const psa_key_attributes_t *attributes,
7416 mbedtls_svc_key_id_t *key)
Gilles Peskineff5f0e72019-04-18 12:53:30 +02007417{
7418 psa_status_t status;
7419 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02007420 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cron2b56bc82020-10-05 10:02:26 +02007421 size_t key_buffer_size;
Gilles Peskine11792082019-08-06 18:36:36 +02007422
Ronald Cron81709fc2020-11-14 12:10:32 +01007423 *key = MBEDTLS_SVC_KEY_ID_INIT;
7424
Gilles Peskine0f84d622019-09-12 19:03:13 +02007425 /* Reject any attempt to create a zero-length key so that we don't
7426 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007427 if (psa_get_key_bits(attributes) == 0) {
7428 return PSA_ERROR_INVALID_ARGUMENT;
7429 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02007430
Przemyslaw Stekielc0fe8202021-10-07 11:08:56 +02007431 /* Reject any attempt to create a public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007432 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(attributes->core.type)) {
7433 return PSA_ERROR_INVALID_ARGUMENT;
7434 }
Przemyslaw Stekielc0fe8202021-10-07 11:08:56 +02007435
Gilles Peskine449bd832023-01-11 14:50:10 +01007436 status = psa_start_key_creation(PSA_KEY_CREATION_GENERATE, attributes,
7437 &slot, &driver);
7438 if (status != PSA_SUCCESS) {
Gilles Peskine11792082019-08-06 18:36:36 +02007439 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007440 }
Gilles Peskine11792082019-08-06 18:36:36 +02007441
Ronald Cron977c2472020-10-13 08:32:21 +02007442 /* In the case of a transparent key or an opaque key stored in local
Archana449608b2021-09-08 15:36:05 +05307443 * storage ( thus not in the case of generating a key in a secure element
7444 * with storage ( MBEDTLS_PSA_CRYPTO_SE_C ) ),we have to allocate a
7445 * buffer to hold the generated key material. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007446 if (slot->key.data == NULL) {
7447 if (PSA_KEY_LIFETIME_GET_LOCATION(attributes->core.lifetime) ==
7448 PSA_KEY_LOCATION_LOCAL_STORAGE) {
Ronald Cron3772afe2021-02-08 16:10:05 +01007449 status = psa_validate_key_type_and_size_for_key_generation(
Gilles Peskine449bd832023-01-11 14:50:10 +01007450 attributes->core.type, attributes->core.bits);
7451 if (status != PSA_SUCCESS) {
Ronald Cron3772afe2021-02-08 16:10:05 +01007452 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007453 }
Ronald Cron3772afe2021-02-08 16:10:05 +01007454
7455 key_buffer_size = PSA_EXPORT_KEY_OUTPUT_SIZE(
Gilles Peskine449bd832023-01-11 14:50:10 +01007456 attributes->core.type,
7457 attributes->core.bits);
7458 } else {
Ronald Cron977c2472020-10-13 08:32:21 +02007459 status = psa_driver_wrapper_get_key_buffer_size(
Gilles Peskine449bd832023-01-11 14:50:10 +01007460 attributes, &key_buffer_size);
7461 if (status != PSA_SUCCESS) {
Ronald Cron3772afe2021-02-08 16:10:05 +01007462 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007463 }
Ronald Cron977c2472020-10-13 08:32:21 +02007464 }
Ronald Cron977c2472020-10-13 08:32:21 +02007465
Gilles Peskine449bd832023-01-11 14:50:10 +01007466 status = psa_allocate_buffer_to_slot(slot, key_buffer_size);
7467 if (status != PSA_SUCCESS) {
Ronald Cron977c2472020-10-13 08:32:21 +02007468 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007469 }
Ronald Cron977c2472020-10-13 08:32:21 +02007470 }
7471
Gilles Peskine449bd832023-01-11 14:50:10 +01007472 status = psa_driver_wrapper_generate_key(attributes,
7473 slot->key.data, slot->key.bytes, &slot->key.bytes);
Gilles Peskine11792082019-08-06 18:36:36 +02007474
Gilles Peskine449bd832023-01-11 14:50:10 +01007475 if (status != PSA_SUCCESS) {
7476 psa_remove_key_data_from_memory(slot);
7477 }
Ronald Cron2b56bc82020-10-05 10:02:26 +02007478
Gilles Peskine11792082019-08-06 18:36:36 +02007479exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007480 if (status == PSA_SUCCESS) {
7481 status = psa_finish_key_creation(slot, driver, key);
7482 }
7483 if (status != PSA_SUCCESS) {
7484 psa_fail_key_creation(slot, driver);
7485 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007486
Gilles Peskine449bd832023-01-11 14:50:10 +01007487 return status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007488}
7489
Gilles Peskinee59236f2018-01-27 23:32:46 +01007490/****************************************************************/
7491/* Module setup */
7492/****************************************************************/
7493
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007494#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine5e769522018-11-20 21:59:56 +01007495psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
Gilles Peskine449bd832023-01-11 14:50:10 +01007496 void (* entropy_init)(mbedtls_entropy_context *ctx),
7497 void (* entropy_free)(mbedtls_entropy_context *ctx))
Gilles Peskine5e769522018-11-20 21:59:56 +01007498{
Gilles Peskine449bd832023-01-11 14:50:10 +01007499 if (global_data.rng_state != RNG_NOT_INITIALIZED) {
7500 return PSA_ERROR_BAD_STATE;
7501 }
Gilles Peskine30524eb2020-11-13 17:02:26 +01007502 global_data.rng.entropy_init = entropy_init;
7503 global_data.rng.entropy_free = entropy_free;
Gilles Peskine449bd832023-01-11 14:50:10 +01007504 return PSA_SUCCESS;
Gilles Peskine5e769522018-11-20 21:59:56 +01007505}
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007506#endif /* !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) */
Gilles Peskine5e769522018-11-20 21:59:56 +01007507
Gilles Peskine449bd832023-01-11 14:50:10 +01007508void mbedtls_psa_crypto_free(void)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007509{
Gilles Peskine449bd832023-01-11 14:50:10 +01007510 psa_wipe_all_key_slots();
Valerio Setti83e0de82023-11-24 12:13:05 +01007511 if (global_data.rng_state != RNG_NOT_INITIALIZED) {
7512 mbedtls_psa_random_free(&global_data.rng);
7513 }
Gilles Peskinec6b69072018-11-20 21:42:52 +01007514 /* Wipe all remaining data, including configuration.
7515 * In particular, this sets all state indicator to the value
7516 * indicating "uninitialized". */
Gilles Peskine449bd832023-01-11 14:50:10 +01007517 mbedtls_platform_zeroize(&global_data, sizeof(global_data));
Ronald Cron9ba76912021-04-10 16:57:30 +02007518
7519 /* Terminate drivers */
Gilles Peskine449bd832023-01-11 14:50:10 +01007520 psa_driver_wrapper_free();
Gilles Peskinee59236f2018-01-27 23:32:46 +01007521}
7522
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007523#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
7524/** Recover a transaction that was interrupted by a power failure.
7525 *
7526 * This function is called during initialization, before psa_crypto_init()
7527 * returns. If this function returns a failure status, the initialization
7528 * fails.
7529 */
7530static psa_status_t psa_crypto_recover_transaction(
Gilles Peskine449bd832023-01-11 14:50:10 +01007531 const psa_crypto_transaction_t *transaction)
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007532{
Gilles Peskine449bd832023-01-11 14:50:10 +01007533 switch (transaction->unknown.type) {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007534 case PSA_CRYPTO_TRANSACTION_CREATE_KEY:
7535 case PSA_CRYPTO_TRANSACTION_DESTROY_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01007536 /* TODO - fall through to the failure case until this
7537 * is implemented.
7538 * https://github.com/ARMmbed/mbed-crypto/issues/218
7539 */
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007540 default:
7541 /* We found an unsupported transaction in the storage.
7542 * We don't know what state the storage is in. Give up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007543 return PSA_ERROR_DATA_INVALID;
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007544 }
7545}
7546#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
7547
Gilles Peskine449bd832023-01-11 14:50:10 +01007548psa_status_t psa_crypto_init(void)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007549{
Gilles Peskine66fb1262018-12-10 16:29:04 +01007550 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007551
Gilles Peskinec6b69072018-11-20 21:42:52 +01007552 /* Double initialization is explicitly allowed. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007553 if (global_data.initialized != 0) {
7554 return PSA_SUCCESS;
7555 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01007556
Manuel Pégourié-Gonnard7abdf7e2023-03-09 11:17:43 +01007557 /* Init drivers */
7558 status = psa_driver_wrapper_init();
7559 if (status != PSA_SUCCESS) {
7560 goto exit;
7561 }
7562 global_data.drivers_initialized = 1;
7563
Valerio Setti402cfba2023-11-13 10:24:32 +01007564 status = psa_initialize_key_slots();
7565 if (status != PSA_SUCCESS) {
7566 goto exit;
7567 }
7568
Gilles Peskine30524eb2020-11-13 17:02:26 +01007569 /* Initialize and seed the random generator. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007570 mbedtls_psa_random_init(&global_data.rng);
Gilles Peskinec6b69072018-11-20 21:42:52 +01007571 global_data.rng_state = RNG_INITIALIZED;
Gilles Peskine449bd832023-01-11 14:50:10 +01007572 status = mbedtls_psa_random_seed(&global_data.rng);
7573 if (status != PSA_SUCCESS) {
Gilles Peskinee59236f2018-01-27 23:32:46 +01007574 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007575 }
Gilles Peskinec6b69072018-11-20 21:42:52 +01007576 global_data.rng_state = RNG_SEEDED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007577
Gilles Peskine4b734222019-07-24 15:56:31 +02007578#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007579 status = psa_crypto_load_transaction();
7580 if (status == PSA_SUCCESS) {
7581 status = psa_crypto_recover_transaction(&psa_crypto_transaction);
7582 if (status != PSA_SUCCESS) {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007583 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007584 }
7585 status = psa_crypto_stop_transaction();
7586 } else if (status == PSA_ERROR_DOES_NOT_EXIST) {
Gilles Peskinefc762652019-07-22 19:30:34 +02007587 /* There's no transaction to complete. It's all good. */
7588 status = PSA_SUCCESS;
7589 }
Gilles Peskine4b734222019-07-24 15:56:31 +02007590#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
Gilles Peskinefc762652019-07-22 19:30:34 +02007591
Gilles Peskinec6b69072018-11-20 21:42:52 +01007592 /* All done. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01007593 global_data.initialized = 1;
7594
7595exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007596 if (status != PSA_SUCCESS) {
7597 mbedtls_psa_crypto_free();
7598 }
7599 return status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007600}
7601
Yanray Wangffc3c482023-07-11 12:01:04 +08007602#if defined(PSA_WANT_ALG_SOME_PAKE)
Przemek Stekielca8d2b22023-01-17 16:21:33 +01007603psa_status_t psa_crypto_driver_pake_get_password_len(
7604 const psa_crypto_driver_pake_inputs_t *inputs,
7605 size_t *password_len)
7606{
7607 if (inputs->password_len == 0) {
7608 return PSA_ERROR_BAD_STATE;
7609 }
7610
7611 *password_len = inputs->password_len;
7612
7613 return PSA_SUCCESS;
7614}
7615
7616psa_status_t psa_crypto_driver_pake_get_password(
7617 const psa_crypto_driver_pake_inputs_t *inputs,
7618 uint8_t *buffer, size_t buffer_size, size_t *buffer_length)
7619{
7620 if (inputs->password_len == 0) {
7621 return PSA_ERROR_BAD_STATE;
7622 }
7623
7624 if (buffer_size < inputs->password_len) {
7625 return PSA_ERROR_BUFFER_TOO_SMALL;
7626 }
7627
7628 memcpy(buffer, inputs->password, inputs->password_len);
7629 *buffer_length = inputs->password_len;
7630
7631 return PSA_SUCCESS;
7632}
7633
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007634psa_status_t psa_crypto_driver_pake_get_user_len(
7635 const psa_crypto_driver_pake_inputs_t *inputs,
7636 size_t *user_len)
7637{
7638 if (inputs->user_len == 0) {
7639 return PSA_ERROR_BAD_STATE;
7640 }
7641
7642 *user_len = inputs->user_len;
7643
7644 return PSA_SUCCESS;
7645}
7646
7647psa_status_t psa_crypto_driver_pake_get_user(
7648 const psa_crypto_driver_pake_inputs_t *inputs,
Przemek Stekielc0e62502023-03-14 11:49:36 +01007649 uint8_t *user_id, size_t user_id_size, size_t *user_id_len)
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007650{
7651 if (inputs->user_len == 0) {
7652 return PSA_ERROR_BAD_STATE;
7653 }
7654
Przemek Stekielc0e62502023-03-14 11:49:36 +01007655 if (user_id_size < inputs->user_len) {
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007656 return PSA_ERROR_BUFFER_TOO_SMALL;
7657 }
7658
Przemek Stekielc0e62502023-03-14 11:49:36 +01007659 memcpy(user_id, inputs->user, inputs->user_len);
7660 *user_id_len = inputs->user_len;
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007661
7662 return PSA_SUCCESS;
7663}
7664
7665psa_status_t psa_crypto_driver_pake_get_peer_len(
7666 const psa_crypto_driver_pake_inputs_t *inputs,
7667 size_t *peer_len)
7668{
7669 if (inputs->peer_len == 0) {
7670 return PSA_ERROR_BAD_STATE;
7671 }
7672
7673 *peer_len = inputs->peer_len;
7674
7675 return PSA_SUCCESS;
7676}
7677
7678psa_status_t psa_crypto_driver_pake_get_peer(
7679 const psa_crypto_driver_pake_inputs_t *inputs,
Przemek Stekielc0e62502023-03-14 11:49:36 +01007680 uint8_t *peer_id, size_t peer_id_size, size_t *peer_id_length)
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007681{
7682 if (inputs->peer_len == 0) {
7683 return PSA_ERROR_BAD_STATE;
7684 }
7685
Przemek Stekielc0e62502023-03-14 11:49:36 +01007686 if (peer_id_size < inputs->peer_len) {
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007687 return PSA_ERROR_BUFFER_TOO_SMALL;
7688 }
7689
Przemek Stekielc0e62502023-03-14 11:49:36 +01007690 memcpy(peer_id, inputs->peer, inputs->peer_len);
7691 *peer_id_length = inputs->peer_len;
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007692
7693 return PSA_SUCCESS;
7694}
7695
Przemek Stekielca8d2b22023-01-17 16:21:33 +01007696psa_status_t psa_crypto_driver_pake_get_cipher_suite(
7697 const psa_crypto_driver_pake_inputs_t *inputs,
7698 psa_pake_cipher_suite_t *cipher_suite)
7699{
7700 if (inputs->cipher_suite.algorithm == PSA_ALG_NONE) {
7701 return PSA_ERROR_BAD_STATE;
7702 }
7703
7704 *cipher_suite = inputs->cipher_suite;
7705
7706 return PSA_SUCCESS;
7707}
7708
Neil Armstronga7d08c32022-06-01 18:21:20 +02007709psa_status_t psa_pake_setup(
7710 psa_pake_operation_t *operation,
7711 const psa_pake_cipher_suite_t *cipher_suite)
7712{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007713 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007714
Przemek Stekiel1c3cfb42023-01-26 10:35:02 +01007715 if (operation->stage != PSA_PAKE_OPERATION_STAGE_SETUP) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007716 status = PSA_ERROR_BAD_STATE;
7717 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007718 }
7719
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01007720 if (PSA_ALG_IS_PAKE(cipher_suite->algorithm) == 0 ||
Przemek Stekiel51eac532022-12-07 11:04:51 +01007721 PSA_ALG_IS_HASH(cipher_suite->hash) == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007722 status = PSA_ERROR_INVALID_ARGUMENT;
7723 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007724 }
7725
Przemek Stekiel51eac532022-12-07 11:04:51 +01007726 memset(&operation->data.inputs, 0, sizeof(operation->data.inputs));
7727
Przemek Stekiele12ed362022-12-21 12:54:46 +01007728 operation->alg = cipher_suite->algorithm;
Przemek Stekiel656b2592023-03-22 13:15:33 +01007729 operation->primitive = PSA_PAKE_PRIMITIVE(cipher_suite->type,
7730 cipher_suite->family, cipher_suite->bits);
Przemek Stekiel51eac532022-12-07 11:04:51 +01007731 operation->data.inputs.cipher_suite = *cipher_suite;
7732
Przemek Stekiel4aa99402023-02-27 13:00:57 +01007733#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01007734 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01007735 psa_jpake_computation_stage_t *computation_stage =
Przemek Stekieldde6a912023-01-26 08:46:37 +01007736 &operation->computation_stage.jpake;
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01007737
David Horstmann16f01512023-06-14 17:21:07 +01007738 memset(computation_stage, 0, sizeof(*computation_stage));
David Horstmanne7f21e62023-05-12 18:17:21 +01007739 computation_stage->step = PSA_PAKE_STEP_KEY_SHARE;
Przemek Stekiel80a88492023-02-20 13:32:22 +01007740 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007741#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01007742 {
7743 status = PSA_ERROR_NOT_SUPPORTED;
7744 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01007745 }
7746
Przemek Stekiel1c3cfb42023-01-26 10:35:02 +01007747 operation->stage = PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS;
7748
Przemek Stekiel51eac532022-12-07 11:04:51 +01007749 return PSA_SUCCESS;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007750exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007751 psa_pake_abort(operation);
7752 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02007753}
7754
7755psa_status_t psa_pake_set_password_key(
7756 psa_pake_operation_t *operation,
7757 mbedtls_svc_key_id_t password)
7758{
Neil Armstrong5ae60962022-09-15 11:29:46 +02007759 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel6c764412022-11-22 14:05:12 +01007760 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
7761 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007762 psa_key_attributes_t attributes;
7763 psa_key_type_t type;
Neil Armstrong5ae60962022-09-15 11:29:46 +02007764
Przemek Stekiel51eac532022-12-07 11:04:51 +01007765 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007766 status = PSA_ERROR_BAD_STATE;
7767 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007768 }
7769
Przemek Stekiel6c764412022-11-22 14:05:12 +01007770 status = psa_get_and_lock_key_slot_with_policy(password, &slot,
7771 PSA_KEY_USAGE_DERIVE,
Przemek Stekield5d28a22023-01-26 10:46:05 +01007772 operation->alg);
Neil Armstrong5ae60962022-09-15 11:29:46 +02007773 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007774 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02007775 }
7776
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007777 attributes = (psa_key_attributes_t) {
Przemek Stekiel6c764412022-11-22 14:05:12 +01007778 .core = slot->attr
7779 };
Neil Armstrong5ae60962022-09-15 11:29:46 +02007780
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007781 type = psa_get_key_type(&attributes);
Neil Armstrong5ae60962022-09-15 11:29:46 +02007782
Przemek Stekiel51eac532022-12-07 11:04:51 +01007783 if (type != PSA_KEY_TYPE_PASSWORD &&
7784 type != PSA_KEY_TYPE_PASSWORD_HASH) {
7785 status = PSA_ERROR_INVALID_ARGUMENT;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007786 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007787 }
7788
Przemek Stekiel51eac532022-12-07 11:04:51 +01007789 operation->data.inputs.password = mbedtls_calloc(1, slot->key.bytes);
7790 if (operation->data.inputs.password == NULL) {
Przemek Stekiele12ed362022-12-21 12:54:46 +01007791 status = PSA_ERROR_INSUFFICIENT_MEMORY;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007792 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007793 }
7794
7795 memcpy(operation->data.inputs.password, slot->key.data, slot->key.bytes);
7796 operation->data.inputs.password_len = slot->key.bytes;
Przemek Stekiel9dd24402023-01-26 15:06:09 +01007797 operation->data.inputs.attributes = attributes;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007798exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007799 if (status != PSA_SUCCESS) {
7800 psa_pake_abort(operation);
7801 }
Ryan Everett1b70a072024-01-04 10:32:49 +00007802 unlock_status = psa_unregister_read(slot);
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007803 return (status == PSA_SUCCESS) ? unlock_status : status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02007804}
7805
7806psa_status_t psa_pake_set_user(
7807 psa_pake_operation_t *operation,
7808 const uint8_t *user_id,
7809 size_t user_id_len)
7810{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007811 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007812
7813 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007814 status = PSA_ERROR_BAD_STATE;
7815 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02007816 }
7817
Przemek Stekiel51eac532022-12-07 11:04:51 +01007818 if (user_id_len == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007819 status = PSA_ERROR_INVALID_ARGUMENT;
7820 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02007821 }
7822
Przemek Stekielf309d6b2023-03-10 09:54:45 +01007823 if (operation->data.inputs.user_len != 0) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007824 status = PSA_ERROR_BAD_STATE;
7825 goto exit;
7826 }
7827
Przemek Stekielf309d6b2023-03-10 09:54:45 +01007828 operation->data.inputs.user = mbedtls_calloc(1, user_id_len);
7829 if (operation->data.inputs.user == NULL) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007830 status = PSA_ERROR_INSUFFICIENT_MEMORY;
7831 goto exit;
7832 }
7833
Przemek Stekielf309d6b2023-03-10 09:54:45 +01007834 memcpy(operation->data.inputs.user, user_id, user_id_len);
7835 operation->data.inputs.user_len = user_id_len;
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007836
7837 return PSA_SUCCESS;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007838exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007839 psa_pake_abort(operation);
7840 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02007841}
7842
7843psa_status_t psa_pake_set_peer(
7844 psa_pake_operation_t *operation,
7845 const uint8_t *peer_id,
7846 size_t peer_id_len)
7847{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007848 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007849
7850 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007851 status = PSA_ERROR_BAD_STATE;
7852 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02007853 }
7854
Przemek Stekiel51eac532022-12-07 11:04:51 +01007855 if (peer_id_len == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007856 status = PSA_ERROR_INVALID_ARGUMENT;
7857 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02007858 }
7859
Przemek Stekielf309d6b2023-03-10 09:54:45 +01007860 if (operation->data.inputs.peer_len != 0) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007861 status = PSA_ERROR_BAD_STATE;
7862 goto exit;
7863 }
7864
Przemek Stekielf309d6b2023-03-10 09:54:45 +01007865 operation->data.inputs.peer = mbedtls_calloc(1, peer_id_len);
7866 if (operation->data.inputs.peer == NULL) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007867 status = PSA_ERROR_INSUFFICIENT_MEMORY;
7868 goto exit;
7869 }
7870
Przemek Stekielf309d6b2023-03-10 09:54:45 +01007871 memcpy(operation->data.inputs.peer, peer_id, peer_id_len);
7872 operation->data.inputs.peer_len = peer_id_len;
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007873
7874 return PSA_SUCCESS;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007875exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007876 psa_pake_abort(operation);
7877 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02007878}
7879
7880psa_status_t psa_pake_set_role(
7881 psa_pake_operation_t *operation,
7882 psa_pake_role_t role)
7883{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007884 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007885
Przemek Stekiel51eac532022-12-07 11:04:51 +01007886 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007887 status = PSA_ERROR_BAD_STATE;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007888 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007889 }
7890
Przemek Stekiel09104b82023-03-06 14:11:51 +01007891 switch (operation->alg) {
7892#if defined(PSA_WANT_ALG_JPAKE)
7893 case PSA_ALG_JPAKE:
7894 if (role == PSA_PAKE_ROLE_NONE) {
7895 return PSA_SUCCESS;
7896 }
7897 status = PSA_ERROR_INVALID_ARGUMENT;
7898 break;
7899#endif
7900 default:
7901 (void) role;
7902 status = PSA_ERROR_NOT_SUPPORTED;
7903 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02007904 }
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007905exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007906 psa_pake_abort(operation);
7907 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02007908}
7909
David Horstmanne7f21e62023-05-12 18:17:21 +01007910/* Auxiliary function to convert core computation stage to single driver step. */
Przemek Stekiel4aa99402023-02-27 13:00:57 +01007911#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiel251e86a2023-02-17 14:30:50 +01007912static psa_crypto_driver_pake_step_t convert_jpake_computation_stage_to_driver_step(
Przemek Stekieldde6a912023-01-26 08:46:37 +01007913 psa_jpake_computation_stage_t *stage)
Przemek Stekielb09c4872023-01-17 12:05:38 +01007914{
David Horstmann74a3d8c2023-06-14 18:28:19 +01007915 psa_crypto_driver_pake_step_t key_share_step;
David Horstmann5da95602023-06-08 15:37:12 +01007916 if (stage->round == PSA_JPAKE_FIRST) {
David Horstmanne7f21e62023-05-12 18:17:21 +01007917 int is_x1;
David Horstmann74a3d8c2023-06-14 18:28:19 +01007918
David Horstmann024e5c52023-06-14 15:48:21 +01007919 if (stage->io_mode == PSA_JPAKE_OUTPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01007920 is_x1 = (stage->outputs < 1);
7921 } else {
7922 is_x1 = (stage->inputs < 1);
7923 }
7924
David Horstmann74a3d8c2023-06-14 18:28:19 +01007925 key_share_step = is_x1 ?
7926 PSA_JPAKE_X1_STEP_KEY_SHARE :
7927 PSA_JPAKE_X2_STEP_KEY_SHARE;
David Horstmann5da95602023-06-08 15:37:12 +01007928 } else if (stage->round == PSA_JPAKE_SECOND) {
David Horstmann74a3d8c2023-06-14 18:28:19 +01007929 key_share_step = (stage->io_mode == PSA_JPAKE_OUTPUT) ?
7930 PSA_JPAKE_X2S_STEP_KEY_SHARE :
7931 PSA_JPAKE_X4S_STEP_KEY_SHARE;
7932 } else {
7933 return PSA_JPAKE_STEP_INVALID;
Przemek Stekielb09c4872023-01-17 12:05:38 +01007934 }
Agathiyan Bragadeesh387bfa52023-07-17 17:01:33 +01007935 return (psa_crypto_driver_pake_step_t) (key_share_step + stage->step - PSA_PAKE_STEP_KEY_SHARE);
Przemek Stekielb09c4872023-01-17 12:05:38 +01007936}
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007937#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekielb09c4872023-01-17 12:05:38 +01007938
Przemek Stekiel2797d372022-12-22 11:19:22 +01007939static psa_status_t psa_pake_complete_inputs(
7940 psa_pake_operation_t *operation)
7941{
Przemek Stekiel2797d372022-12-22 11:19:22 +01007942 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel18620a32023-01-17 16:34:52 +01007943 /* Create copy of the inputs on stack as inputs share memory
7944 with the driver context which will be setup by the driver. */
7945 psa_crypto_driver_pake_inputs_t inputs = operation->data.inputs;
Przemek Stekiel2797d372022-12-22 11:19:22 +01007946
Przemek Stekielfde11282023-03-13 16:06:09 +01007947 if (inputs.password_len == 0) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01007948 return PSA_ERROR_BAD_STATE;
7949 }
7950
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007951 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekielfde11282023-03-13 16:06:09 +01007952 if (inputs.user_len == 0 || inputs.peer_len == 0) {
7953 return PSA_ERROR_BAD_STATE;
7954 }
Przemek Stekieldff21d32023-02-14 20:09:10 +01007955 }
7956
Przemek Stekiel18620a32023-01-17 16:34:52 +01007957 /* Clear driver context */
7958 mbedtls_platform_zeroize(&operation->data, sizeof(operation->data));
7959
7960 status = psa_driver_wrapper_pake_setup(operation, &inputs);
Przemek Stekiel2797d372022-12-22 11:19:22 +01007961
7962 /* Driver is responsible for creating its own copy of the password. */
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01007963 mbedtls_zeroize_and_free(inputs.password, inputs.password_len);
Przemek Stekiel2797d372022-12-22 11:19:22 +01007964
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007965 /* User and peer are translated to role. */
7966 mbedtls_free(inputs.user);
7967 mbedtls_free(inputs.peer);
7968
Przemek Stekiel2797d372022-12-22 11:19:22 +01007969 if (status == PSA_SUCCESS) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01007970#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiel2797d372022-12-22 11:19:22 +01007971 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekield93de322023-02-24 08:39:04 +01007972 operation->stage = PSA_PAKE_OPERATION_STAGE_COMPUTATION;
Przemek Stekiel80a88492023-02-20 13:32:22 +01007973 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007974#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01007975 {
7976 status = PSA_ERROR_NOT_SUPPORTED;
Przemek Stekiel2797d372022-12-22 11:19:22 +01007977 }
Przemek Stekiel2797d372022-12-22 11:19:22 +01007978 }
Przemek Stekiel2797d372022-12-22 11:19:22 +01007979 return status;
7980}
7981
Przemek Stekiel4aa99402023-02-27 13:00:57 +01007982#if defined(PSA_WANT_ALG_JPAKE)
David Horstmanne7f21e62023-05-12 18:17:21 +01007983static psa_status_t psa_jpake_prologue(
Przemek Stekiele12ed362022-12-21 12:54:46 +01007984 psa_pake_operation_t *operation,
David Horstmanne7f21e62023-05-12 18:17:21 +01007985 psa_pake_step_t step,
David Horstmann00ad6bf2023-06-14 15:44:24 +01007986 psa_jpake_io_mode_t io_mode)
Przemek Stekiele12ed362022-12-21 12:54:46 +01007987{
Przemek Stekiele12ed362022-12-21 12:54:46 +01007988 if (step != PSA_PAKE_STEP_KEY_SHARE &&
7989 step != PSA_PAKE_STEP_ZK_PUBLIC &&
7990 step != PSA_PAKE_STEP_ZK_PROOF) {
7991 return PSA_ERROR_INVALID_ARGUMENT;
7992 }
7993
Przemek Stekiel5eff1032023-02-21 19:10:36 +01007994 psa_jpake_computation_stage_t *computation_stage =
7995 &operation->computation_stage.jpake;
Przemek Stekiele12ed362022-12-21 12:54:46 +01007996
David Horstmann5da95602023-06-08 15:37:12 +01007997 if (computation_stage->round != PSA_JPAKE_FIRST &&
7998 computation_stage->round != PSA_JPAKE_SECOND) {
Przemek Stekiel5eff1032023-02-21 19:10:36 +01007999 return PSA_ERROR_BAD_STATE;
8000 }
8001
David Horstmanne7f21e62023-05-12 18:17:21 +01008002 /* Check that the step we are given is the one we were expecting */
8003 if (step != computation_stage->step) {
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008004 return PSA_ERROR_BAD_STATE;
8005 }
8006
David Horstmanne7f21e62023-05-12 18:17:21 +01008007 if (step == PSA_PAKE_STEP_KEY_SHARE &&
8008 computation_stage->inputs == 0 &&
8009 computation_stage->outputs == 0) {
8010 /* Start of the round, so function decides whether we are inputting
8011 * or outputting */
David Horstmann024e5c52023-06-14 15:48:21 +01008012 computation_stage->io_mode = io_mode;
8013 } else if (computation_stage->io_mode != io_mode) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008014 /* Middle of the round so the mode we are in must match the function
8015 * called by the user */
8016 return PSA_ERROR_BAD_STATE;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008017 }
8018
8019 return PSA_SUCCESS;
8020}
8021
David Horstmanne7f21e62023-05-12 18:17:21 +01008022static psa_status_t psa_jpake_epilogue(
8023 psa_pake_operation_t *operation,
David Horstmann00ad6bf2023-06-14 15:44:24 +01008024 psa_jpake_io_mode_t io_mode)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008025{
David Horstmanne7f21e62023-05-12 18:17:21 +01008026 psa_jpake_computation_stage_t *stage =
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008027 &operation->computation_stage.jpake;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008028
David Horstmanne7f21e62023-05-12 18:17:21 +01008029 if (stage->step == PSA_PAKE_STEP_ZK_PROOF) {
8030 /* End of an input/output */
David Horstmann00ad6bf2023-06-14 15:44:24 +01008031 if (io_mode == PSA_JPAKE_INPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008032 stage->inputs++;
David Horstmann246ec5a2023-06-27 10:33:06 +01008033 if (stage->inputs == PSA_JPAKE_EXPECTED_INPUTS(stage->round)) {
David Horstmann024e5c52023-06-14 15:48:21 +01008034 stage->io_mode = PSA_JPAKE_OUTPUT;
David Horstmanne7f21e62023-05-12 18:17:21 +01008035 }
8036 }
David Horstmann00ad6bf2023-06-14 15:44:24 +01008037 if (io_mode == PSA_JPAKE_OUTPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008038 stage->outputs++;
David Horstmann246ec5a2023-06-27 10:33:06 +01008039 if (stage->outputs == PSA_JPAKE_EXPECTED_OUTPUTS(stage->round)) {
David Horstmann024e5c52023-06-14 15:48:21 +01008040 stage->io_mode = PSA_JPAKE_INPUT;
David Horstmanne7f21e62023-05-12 18:17:21 +01008041 }
8042 }
David Horstmann246ec5a2023-06-27 10:33:06 +01008043 if (stage->inputs == PSA_JPAKE_EXPECTED_INPUTS(stage->round) &&
8044 stage->outputs == PSA_JPAKE_EXPECTED_OUTPUTS(stage->round)) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008045 /* End of a round, move to the next round */
8046 stage->inputs = 0;
8047 stage->outputs = 0;
8048 stage->round++;
8049 }
8050 stage->step = PSA_PAKE_STEP_KEY_SHARE;
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008051 } else {
David Horstmanne7f21e62023-05-12 18:17:21 +01008052 stage->step++;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008053 }
Przemek Stekiele12ed362022-12-21 12:54:46 +01008054 return PSA_SUCCESS;
8055}
David Horstmanne7f21e62023-05-12 18:17:21 +01008056
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008057#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008058
Neil Armstronga7d08c32022-06-01 18:21:20 +02008059psa_status_t psa_pake_output(
8060 psa_pake_operation_t *operation,
8061 psa_pake_step_t step,
8062 uint8_t *output,
8063 size_t output_size,
8064 size_t *output_length)
8065{
Przemek Stekiel51eac532022-12-07 11:04:51 +01008066 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008067 psa_crypto_driver_pake_step_t driver_step = PSA_JPAKE_STEP_INVALID;
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008068 *output_length = 0;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008069
8070 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01008071 status = psa_pake_complete_inputs(operation);
8072 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008073 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008074 }
8075 }
8076
8077 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008078 status = PSA_ERROR_BAD_STATE;
8079 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008080 }
8081
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008082 if (output_size == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008083 status = PSA_ERROR_INVALID_ARGUMENT;
8084 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008085 }
8086
Przemek Stekiele12ed362022-12-21 12:54:46 +01008087 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008088#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008089 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008090 status = psa_jpake_prologue(operation, step, PSA_JPAKE_OUTPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008091 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008092 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008093 }
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008094 driver_step = convert_jpake_computation_stage_to_driver_step(
8095 &operation->computation_stage.jpake);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008096 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008097#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008098 default:
Przemek Stekiel80a88492023-02-20 13:32:22 +01008099 (void) step;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008100 status = PSA_ERROR_NOT_SUPPORTED;
8101 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008102 }
8103
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008104 status = psa_driver_wrapper_pake_output(operation, driver_step,
8105 output, output_size, output_length);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008106
8107 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008108 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008109 }
8110
8111 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008112#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008113 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008114 status = psa_jpake_epilogue(operation, PSA_JPAKE_OUTPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008115 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008116 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008117 }
8118 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008119#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008120 default:
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008121 status = PSA_ERROR_NOT_SUPPORTED;
8122 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008123 }
8124
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008125 return PSA_SUCCESS;
8126exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008127 psa_pake_abort(operation);
8128 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008129}
8130
8131psa_status_t psa_pake_input(
8132 psa_pake_operation_t *operation,
8133 psa_pake_step_t step,
8134 const uint8_t *input,
8135 size_t input_length)
8136{
Przemek Stekiel51eac532022-12-07 11:04:51 +01008137 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008138 psa_crypto_driver_pake_step_t driver_step = PSA_JPAKE_STEP_INVALID;
Przemek Stekiel256c75d2023-03-23 14:09:34 +01008139 const size_t max_input_length = (size_t) PSA_PAKE_INPUT_SIZE(operation->alg,
8140 operation->primitive,
8141 step);
Przemek Stekiel51eac532022-12-07 11:04:51 +01008142
8143 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01008144 status = psa_pake_complete_inputs(operation);
8145 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008146 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008147 }
8148 }
8149
8150 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008151 status = PSA_ERROR_BAD_STATE;
8152 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008153 }
8154
Przemek Stekiel256c75d2023-03-23 14:09:34 +01008155 if (input_length == 0 || input_length > max_input_length) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008156 status = PSA_ERROR_INVALID_ARGUMENT;
8157 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008158 }
8159
Przemek Stekiele12ed362022-12-21 12:54:46 +01008160 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008161#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008162 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008163 status = psa_jpake_prologue(operation, step, PSA_JPAKE_INPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008164 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008165 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008166 }
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008167 driver_step = convert_jpake_computation_stage_to_driver_step(
8168 &operation->computation_stage.jpake);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008169 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008170#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008171 default:
Przemek Stekiel80a88492023-02-20 13:32:22 +01008172 (void) step;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008173 status = PSA_ERROR_NOT_SUPPORTED;
8174 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008175 }
8176
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008177 status = psa_driver_wrapper_pake_input(operation, driver_step,
8178 input, input_length);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008179
8180 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008181 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008182 }
8183
8184 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008185#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008186 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008187 status = psa_jpake_epilogue(operation, PSA_JPAKE_INPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008188 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008189 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008190 }
8191 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008192#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008193 default:
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008194 status = PSA_ERROR_NOT_SUPPORTED;
8195 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008196 }
8197
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008198 return PSA_SUCCESS;
8199exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008200 psa_pake_abort(operation);
8201 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008202}
8203
8204psa_status_t psa_pake_get_implicit_key(
8205 psa_pake_operation_t *operation,
8206 psa_key_derivation_operation_t *output)
8207{
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008208 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008209 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel251e86a2023-02-17 14:30:50 +01008210 uint8_t shared_key[MBEDTLS_PSA_JPAKE_BUFFER_SIZE];
Przemek Stekiel0c781802022-11-29 14:53:13 +01008211 size_t shared_key_len = 0;
8212
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008213 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008214 status = PSA_ERROR_BAD_STATE;
8215 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008216 }
8217
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008218#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008219 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008220 psa_jpake_computation_stage_t *computation_stage =
Przemek Stekiel083745e2023-02-23 17:28:23 +01008221 &operation->computation_stage.jpake;
David Horstmann5da95602023-06-08 15:37:12 +01008222 if (computation_stage->round != PSA_JPAKE_FINISHED) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008223 status = PSA_ERROR_BAD_STATE;
8224 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008225 }
Przemek Stekiel80a88492023-02-20 13:32:22 +01008226 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008227#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01008228 {
8229 status = PSA_ERROR_NOT_SUPPORTED;
8230 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008231 }
8232
Przemek Stekiel0c781802022-11-29 14:53:13 +01008233 status = psa_driver_wrapper_pake_get_implicit_key(operation,
8234 shared_key,
Przemek Stekiel6b648622023-02-19 22:55:33 +01008235 sizeof(shared_key),
Przemek Stekiel0c781802022-11-29 14:53:13 +01008236 &shared_key_len);
8237
8238 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008239 goto exit;
Przemek Stekiel0c781802022-11-29 14:53:13 +01008240 }
8241
8242 status = psa_key_derivation_input_bytes(output,
8243 PSA_KEY_DERIVATION_INPUT_SECRET,
8244 shared_key,
8245 shared_key_len);
8246
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008247 mbedtls_platform_zeroize(shared_key, sizeof(shared_key));
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008248exit:
8249 abort_status = psa_pake_abort(operation);
8250 return status == PSA_SUCCESS ? abort_status : status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008251}
8252
8253psa_status_t psa_pake_abort(
8254 psa_pake_operation_t *operation)
8255{
Przemek Stekield69dca92023-01-31 19:59:20 +01008256 psa_status_t status = PSA_SUCCESS;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008257
Przemek Stekield69dca92023-01-31 19:59:20 +01008258 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008259 status = psa_driver_wrapper_pake_abort(operation);
Neil Armstrong5ae60962022-09-15 11:29:46 +02008260 }
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008261
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008262 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
8263 if (operation->data.inputs.password != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01008264 mbedtls_zeroize_and_free(operation->data.inputs.password,
Przemek Stekielaa183422023-03-06 14:21:44 +01008265 operation->data.inputs.password_len);
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008266 }
8267 if (operation->data.inputs.user != NULL) {
8268 mbedtls_free(operation->data.inputs.user);
8269 }
8270 if (operation->data.inputs.peer != NULL) {
8271 mbedtls_free(operation->data.inputs.peer);
8272 }
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008273 }
Przemek Stekield69dca92023-01-31 19:59:20 +01008274 memset(operation, 0, sizeof(psa_pake_operation_t));
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008275
Przemek Stekield69dca92023-01-31 19:59:20 +01008276 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008277}
Tom Cosgrove6d62fac2023-05-10 14:40:05 +01008278#endif /* PSA_WANT_ALG_SOME_PAKE */
Neil Armstronga7d08c32022-06-01 18:21:20 +02008279
Gilles Peskinee59236f2018-01-27 23:32:46 +01008280#endif /* MBEDTLS_PSA_CRYPTO_C */