blob: d15ace5595ce376c511906c284adb4057404117a [file] [log] [blame]
Gilles Peskinee59236f2018-01-27 23:32:46 +01001/*
2 * PSA crypto layer on top of Mbed TLS crypto
3 */
Bence Szépkúti86974652020-06-15 11:59:37 +02004/*
Bence Szépkúti1e148272020-08-07 13:07:28 +02005 * Copyright The Mbed TLS Contributors
Dave Rodgman16799db2023-11-02 19:47:20 +00006 * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
Gilles Peskinee59236f2018-01-27 23:32:46 +01007 */
8
Gilles Peskinedb09ef62020-06-03 01:43:33 +02009#include "common.h"
Ronald Cronafbc7ed2023-01-24 16:02:04 +010010#include "psa_crypto_core_common.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010011
12#if defined(MBEDTLS_PSA_CRYPTO_C)
mohammad160327010052018-07-03 13:16:15 +030013
John Durkop07cc04a2020-11-16 22:08:34 -080014#if defined(MBEDTLS_PSA_CRYPTO_CONFIG)
15#include "check_crypto_config.h"
16#endif
17
Gilles Peskinee59236f2018-01-27 23:32:46 +010018#include "psa/crypto.h"
Przemyslaw Stekiel705fb0f2021-11-24 08:47:29 +010019#include "psa/crypto_values.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010020
Ronald Crond6d28882020-12-14 14:56:02 +010021#include "psa_crypto_cipher.h"
Gilles Peskine039b90c2018-12-07 18:24:41 +010022#include "psa_crypto_core.h"
Gilles Peskine5e769522018-11-20 21:59:56 +010023#include "psa_crypto_invasive.h"
Xiaokang Qiane9c39c42023-08-09 08:50:19 +000024#include "psa_crypto_driver_wrappers.h"
Xiaokang Qianfe9666b2023-09-11 10:36:20 +000025#include "psa_crypto_driver_wrappers_no_static.h"
Ronald Cron00b7bfc2020-11-25 15:25:26 +010026#include "psa_crypto_ecp.h"
Przemek Stekiel359f4622022-12-05 14:11:55 +010027#include "psa_crypto_ffdh.h"
Steven Cooreman5f88e772021-03-15 11:07:12 +010028#include "psa_crypto_hash.h"
Steven Cooreman82c66b62021-03-19 17:39:17 +010029#include "psa_crypto_mac.h"
Ronald Cron00b7bfc2020-11-25 15:25:26 +010030#include "psa_crypto_rsa.h"
Ronald Cron7023db52020-11-20 18:17:42 +010031#include "psa_crypto_ecp.h"
Gilles Peskinea8ade162019-06-26 11:24:49 +020032#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined0890212019-06-24 14:34:43 +020033#include "psa_crypto_se.h"
Gilles Peskinea8ade162019-06-26 11:24:49 +020034#endif
Gilles Peskine961849f2018-11-30 18:54:54 +010035#include "psa_crypto_slot_management.h"
Darryl Greend49a4992018-06-18 17:27:26 +010036/* Include internal declarations that are useful for implementing persistently
37 * stored keys. */
38#include "psa_crypto_storage.h"
39
Gilles Peskineb2b64d32020-12-14 16:43:58 +010040#include "psa_crypto_random_impl.h"
Gilles Peskine90edc992020-11-13 15:39:19 +010041
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010042#include <stdlib.h>
43#include <string.h>
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010044#include "mbedtls/platform.h"
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010045
Gilles Peskine1c49f1a2020-11-13 18:46:25 +010046#include "mbedtls/aes.h"
Gilles Peskine9a944802018-06-21 09:35:35 +020047#include "mbedtls/asn1.h"
Jaeden Amero25384a22019-01-10 10:23:21 +000048#include "mbedtls/asn1write.h"
Gilles Peskinea81d85b2018-06-26 16:10:23 +020049#include "mbedtls/bignum.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010050#include "mbedtls/camellia.h"
Gilles Peskine26869f22019-05-06 15:25:00 +020051#include "mbedtls/chacha20.h"
52#include "mbedtls/chachapoly.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010053#include "mbedtls/cipher.h"
54#include "mbedtls/ccm.h"
55#include "mbedtls/cmac.h"
Dave Rodgman78701152023-08-29 14:20:18 +010056#include "mbedtls/constant_time.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010057#include "mbedtls/des.h"
Gilles Peskineb7ecdf02018-09-18 12:11:27 +020058#include "mbedtls/ecdh.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010059#include "mbedtls/ecp.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010060#include "mbedtls/entropy.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010061#include "mbedtls/error.h"
62#include "mbedtls/gcm.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010063#include "mbedtls/md5.h"
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010064#include "mbedtls/pk.h"
Chris Jonesdaacb592021-03-09 17:03:29 +000065#include "pk_wrap.h"
Gilles Peskine3f108122018-12-07 18:14:53 +010066#include "mbedtls/platform_util.h"
Janos Follath24eed8d2019-11-22 13:21:35 +000067#include "mbedtls/error.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010068#include "mbedtls/ripemd160.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010069#include "mbedtls/rsa.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010070#include "mbedtls/sha1.h"
71#include "mbedtls/sha256.h"
72#include "mbedtls/sha512.h"
Manuel Pégourié-Gonnard02b10d82023-03-28 12:33:20 +020073#include "md_psa.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010074
Przemek Stekiel75fe3fb2022-06-09 14:44:55 +020075#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF) || \
76 defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT) || \
77 defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Przemek Stekiel69c46792022-06-10 12:59:51 +020078#define BUILTIN_ALG_ANY_HKDF 1
Przemek Stekiel75fe3fb2022-06-09 14:44:55 +020079#endif
80
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010081/****************************************************************/
82/* Global data, support functions and library management */
83/****************************************************************/
84
Gilles Peskine449bd832023-01-11 14:50:10 +010085static int key_type_is_raw_bytes(psa_key_type_t type)
Gilles Peskine48c0ea12018-06-21 14:15:31 +020086{
Gilles Peskine449bd832023-01-11 14:50:10 +010087 return PSA_KEY_TYPE_IS_UNSTRUCTURED(type);
Gilles Peskine48c0ea12018-06-21 14:15:31 +020088}
89
Gilles Peskine5a3c50e2018-12-04 12:27:09 +010090/* Values for psa_global_data_t::rng_state */
91#define RNG_NOT_INITIALIZED 0
92#define RNG_INITIALIZED 1
93#define RNG_SEEDED 2
Gilles Peskinec6b69072018-11-20 21:42:52 +010094
Gilles Peskine449bd832023-01-11 14:50:10 +010095typedef struct {
Dave Rodgman864f5942023-08-16 18:04:44 +010096 uint8_t initialized;
97 uint8_t rng_state;
98 uint8_t drivers_initialized;
Gilles Peskine2d8a1822021-11-08 22:20:03 +010099 mbedtls_psa_random_context_t rng;
Gilles Peskinee59236f2018-01-27 23:32:46 +0100100} psa_global_data_t;
101
102static psa_global_data_t global_data;
103
Gilles Peskine5894e8e2020-12-14 14:54:06 +0100104#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
105mbedtls_psa_drbg_context_t *const mbedtls_psa_random_state =
106 &global_data.rng.drbg;
107#endif
108
itayzafrir0adf0fc2018-09-06 16:24:41 +0300109#define GUARD_MODULE_INITIALIZED \
Gilles Peskine449bd832023-01-11 14:50:10 +0100110 if (global_data.initialized == 0) \
111 return PSA_ERROR_BAD_STATE;
itayzafrir0adf0fc2018-09-06 16:24:41 +0300112
Manuel Pégourié-Gonnard7abdf7e2023-03-09 11:17:43 +0100113int psa_can_do_hash(psa_algorithm_t hash_alg)
114{
115 (void) hash_alg;
116 return global_data.drivers_initialized;
117}
Valerio Settia55f0422023-07-10 15:34:41 +0200118#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_IMPORT) || \
Przemek Stekiel53410502023-04-28 13:18:43 +0200119 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY) || \
Valerio Settia55f0422023-07-10 15:34:41 +0200120 defined(PSA_WANT_KEY_TYPE_DH_KEY_PAIR_GENERATE)
Przemek Stekiel134cc2e2023-05-05 10:13:37 +0200121static int psa_is_dh_key_size_valid(size_t bits)
122{
Przemek Stekield1cf1ba2023-04-27 12:04:21 +0200123 if (bits != 2048 && bits != 3072 && bits != 4096 &&
124 bits != 6144 && bits != 8192) {
125 return 0;
126 }
127
128 return 1;
129}
Valerio Settia55f0422023-07-10 15:34:41 +0200130#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_IMPORT ||
Przemek Stekiel53410502023-04-28 13:18:43 +0200131 MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY ||
Valerio Settia55f0422023-07-10 15:34:41 +0200132 PSA_WANT_KEY_TYPE_DH_KEY_PAIR_GENERATE */
Manuel Pégourié-Gonnard7abdf7e2023-03-09 11:17:43 +0100133
Gilles Peskine449bd832023-01-11 14:50:10 +0100134psa_status_t mbedtls_to_psa_error(int ret)
Gilles Peskinee59236f2018-01-27 23:32:46 +0100135{
Gilles Peskinedbf68962021-01-06 20:04:23 +0100136 /* Mbed TLS error codes can combine a high-level error code and a
137 * low-level error code. The low-level error usually reflects the
138 * root cause better, so dispatch on that preferably. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100139 int low_level_ret = -(-ret & 0x007f);
140 switch (low_level_ret != 0 ? low_level_ret : ret) {
Gilles Peskinee59236f2018-01-27 23:32:46 +0100141 case 0:
Gilles Peskine449bd832023-01-11 14:50:10 +0100142 return PSA_SUCCESS;
Gilles Peskinea5905292018-02-07 20:59:33 +0100143
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100144#if defined(MBEDTLS_AES_C)
Gilles Peskinea5905292018-02-07 20:59:33 +0100145 case MBEDTLS_ERR_AES_INVALID_KEY_LENGTH:
146 case MBEDTLS_ERR_AES_INVALID_INPUT_LENGTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100147 return PSA_ERROR_NOT_SUPPORTED;
Dave Rodgman09a9e582023-08-31 11:05:22 +0100148 case MBEDTLS_ERR_AES_BAD_INPUT_DATA:
149 return PSA_ERROR_INVALID_ARGUMENT;
Dave Rodgman509b5672023-08-16 19:26:23 +0100150#endif
151
152#if defined(MBEDTLS_ASN1_PARSE_C) || defined(MBEDTLS_ASN1_WRITE_C)
Gilles Peskine9a944802018-06-21 09:35:35 +0200153 case MBEDTLS_ERR_ASN1_OUT_OF_DATA:
154 case MBEDTLS_ERR_ASN1_UNEXPECTED_TAG:
155 case MBEDTLS_ERR_ASN1_INVALID_LENGTH:
156 case MBEDTLS_ERR_ASN1_LENGTH_MISMATCH:
157 case MBEDTLS_ERR_ASN1_INVALID_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100158 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine9a944802018-06-21 09:35:35 +0200159 case MBEDTLS_ERR_ASN1_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100160 return PSA_ERROR_INSUFFICIENT_MEMORY;
Gilles Peskine9a944802018-06-21 09:35:35 +0200161 case MBEDTLS_ERR_ASN1_BUF_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +0100162 return PSA_ERROR_BUFFER_TOO_SMALL;
Dave Rodgman509b5672023-08-16 19:26:23 +0100163#endif
Gilles Peskine9a944802018-06-21 09:35:35 +0200164
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100165#if defined(MBEDTLS_CAMELLIA_C)
Jaeden Amero892cd6d2019-02-11 12:21:12 +0000166 case MBEDTLS_ERR_CAMELLIA_BAD_INPUT_DATA:
Gilles Peskinea5905292018-02-07 20:59:33 +0100167 case MBEDTLS_ERR_CAMELLIA_INVALID_INPUT_LENGTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100168 return PSA_ERROR_NOT_SUPPORTED;
Dave Rodgman509b5672023-08-16 19:26:23 +0100169#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100170
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100171#if defined(MBEDTLS_CCM_C)
Gilles Peskinea5905292018-02-07 20:59:33 +0100172 case MBEDTLS_ERR_CCM_BAD_INPUT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100173 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100174 case MBEDTLS_ERR_CCM_AUTH_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100175 return PSA_ERROR_INVALID_SIGNATURE;
Dave Rodgman509b5672023-08-16 19:26:23 +0100176#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100177
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100178#if defined(MBEDTLS_CHACHA20_C)
Gilles Peskine26869f22019-05-06 15:25:00 +0200179 case MBEDTLS_ERR_CHACHA20_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100180 return PSA_ERROR_INVALID_ARGUMENT;
Dave Rodgman509b5672023-08-16 19:26:23 +0100181#endif
Gilles Peskine26869f22019-05-06 15:25:00 +0200182
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100183#if defined(MBEDTLS_CHACHAPOLY_C)
Gilles Peskine26869f22019-05-06 15:25:00 +0200184 case MBEDTLS_ERR_CHACHAPOLY_BAD_STATE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100185 return PSA_ERROR_BAD_STATE;
Gilles Peskine26869f22019-05-06 15:25:00 +0200186 case MBEDTLS_ERR_CHACHAPOLY_AUTH_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100187 return PSA_ERROR_INVALID_SIGNATURE;
Dave Rodgman509b5672023-08-16 19:26:23 +0100188#endif
Gilles Peskine26869f22019-05-06 15:25:00 +0200189
Dave Rodgman509b5672023-08-16 19:26:23 +0100190#if defined(MBEDTLS_CIPHER_C)
Gilles Peskinea5905292018-02-07 20:59:33 +0100191 case MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100192 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea5905292018-02-07 20:59:33 +0100193 case MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100194 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100195 case MBEDTLS_ERR_CIPHER_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100196 return PSA_ERROR_INSUFFICIENT_MEMORY;
Gilles Peskinea5905292018-02-07 20:59:33 +0100197 case MBEDTLS_ERR_CIPHER_INVALID_PADDING:
Gilles Peskine449bd832023-01-11 14:50:10 +0100198 return PSA_ERROR_INVALID_PADDING;
Gilles Peskinea5905292018-02-07 20:59:33 +0100199 case MBEDTLS_ERR_CIPHER_FULL_BLOCK_EXPECTED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100200 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100201 case MBEDTLS_ERR_CIPHER_AUTH_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100202 return PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskinea5905292018-02-07 20:59:33 +0100203 case MBEDTLS_ERR_CIPHER_INVALID_CONTEXT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100204 return PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman509b5672023-08-16 19:26:23 +0100205#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100206
Gilles Peskine449bd832023-01-11 14:50:10 +0100207#if !(defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) || \
208 defined(MBEDTLS_PSA_HMAC_DRBG_MD_TYPE))
Gilles Peskinebee96c82020-11-23 21:00:09 +0100209 /* Only check CTR_DRBG error codes if underlying mbedtls_xxx
210 * functions are passed a CTR_DRBG instance. */
Gilles Peskinea5905292018-02-07 20:59:33 +0100211 case MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100212 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskinea5905292018-02-07 20:59:33 +0100213 case MBEDTLS_ERR_CTR_DRBG_REQUEST_TOO_BIG:
214 case MBEDTLS_ERR_CTR_DRBG_INPUT_TOO_BIG:
Gilles Peskine449bd832023-01-11 14:50:10 +0100215 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea5905292018-02-07 20:59:33 +0100216 case MBEDTLS_ERR_CTR_DRBG_FILE_IO_ERROR:
Gilles Peskine449bd832023-01-11 14:50:10 +0100217 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskine82e57d12020-11-13 21:31:17 +0100218#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100219
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100220#if defined(MBEDTLS_DES_C)
Gilles Peskinea5905292018-02-07 20:59:33 +0100221 case MBEDTLS_ERR_DES_INVALID_INPUT_LENGTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100222 return PSA_ERROR_NOT_SUPPORTED;
Dave Rodgman509b5672023-08-16 19:26:23 +0100223#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100224
Gilles Peskinee59236f2018-01-27 23:32:46 +0100225 case MBEDTLS_ERR_ENTROPY_NO_SOURCES_DEFINED:
226 case MBEDTLS_ERR_ENTROPY_NO_STRONG_SOURCE:
227 case MBEDTLS_ERR_ENTROPY_SOURCE_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100228 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskinea5905292018-02-07 20:59:33 +0100229
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100230#if defined(MBEDTLS_GCM_C)
Gilles Peskinea5905292018-02-07 20:59:33 +0100231 case MBEDTLS_ERR_GCM_AUTH_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100232 return PSA_ERROR_INVALID_SIGNATURE;
Mateusz Starzykf28261f2021-09-30 16:39:07 +0200233 case MBEDTLS_ERR_GCM_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +0100234 return PSA_ERROR_BUFFER_TOO_SMALL;
Gilles Peskinea5905292018-02-07 20:59:33 +0100235 case MBEDTLS_ERR_GCM_BAD_INPUT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100236 return PSA_ERROR_INVALID_ARGUMENT;
Dave Rodgman509b5672023-08-16 19:26:23 +0100237#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100238
Gilles Peskine82e57d12020-11-13 21:31:17 +0100239#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) && \
Gilles Peskine449bd832023-01-11 14:50:10 +0100240 defined(MBEDTLS_PSA_HMAC_DRBG_MD_TYPE)
Gilles Peskinebee96c82020-11-23 21:00:09 +0100241 /* Only check HMAC_DRBG error codes if underlying mbedtls_xxx
242 * functions are passed a HMAC_DRBG instance. */
Gilles Peskine82e57d12020-11-13 21:31:17 +0100243 case MBEDTLS_ERR_HMAC_DRBG_ENTROPY_SOURCE_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100244 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskine82e57d12020-11-13 21:31:17 +0100245 case MBEDTLS_ERR_HMAC_DRBG_REQUEST_TOO_BIG:
246 case MBEDTLS_ERR_HMAC_DRBG_INPUT_TOO_BIG:
Gilles Peskine449bd832023-01-11 14:50:10 +0100247 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine82e57d12020-11-13 21:31:17 +0100248 case MBEDTLS_ERR_HMAC_DRBG_FILE_IO_ERROR:
Gilles Peskine449bd832023-01-11 14:50:10 +0100249 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskine82e57d12020-11-13 21:31:17 +0100250#endif
251
Dave Rodgmandea266f2023-08-31 11:52:43 +0100252#if defined(MBEDTLS_MD_LIGHT)
Gilles Peskinea5905292018-02-07 20:59:33 +0100253 case MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100254 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea5905292018-02-07 20:59:33 +0100255 case MBEDTLS_ERR_MD_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100256 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100257 case MBEDTLS_ERR_MD_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100258 return PSA_ERROR_INSUFFICIENT_MEMORY;
Dave Rodgman509b5672023-08-16 19:26:23 +0100259#if defined(MBEDTLS_FS_IO)
Gilles Peskinea5905292018-02-07 20:59:33 +0100260 case MBEDTLS_ERR_MD_FILE_IO_ERROR:
Gilles Peskine449bd832023-01-11 14:50:10 +0100261 return PSA_ERROR_STORAGE_FAILURE;
Dave Rodgman509b5672023-08-16 19:26:23 +0100262#endif
263#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100264
Dave Rodgman509b5672023-08-16 19:26:23 +0100265#if defined(MBEDTLS_BIGNUM_C)
266#if defined(MBEDTLS_FS_IO)
Gilles Peskinef76aa772018-10-29 19:24:33 +0100267 case MBEDTLS_ERR_MPI_FILE_IO_ERROR:
Gilles Peskine449bd832023-01-11 14:50:10 +0100268 return PSA_ERROR_STORAGE_FAILURE;
Dave Rodgman509b5672023-08-16 19:26:23 +0100269#endif
Gilles Peskinef76aa772018-10-29 19:24:33 +0100270 case MBEDTLS_ERR_MPI_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100271 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100272 case MBEDTLS_ERR_MPI_INVALID_CHARACTER:
Gilles Peskine449bd832023-01-11 14:50:10 +0100273 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100274 case MBEDTLS_ERR_MPI_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +0100275 return PSA_ERROR_BUFFER_TOO_SMALL;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100276 case MBEDTLS_ERR_MPI_NEGATIVE_VALUE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100277 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100278 case MBEDTLS_ERR_MPI_DIVISION_BY_ZERO:
Gilles Peskine449bd832023-01-11 14:50:10 +0100279 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100280 case MBEDTLS_ERR_MPI_NOT_ACCEPTABLE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100281 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100282 case MBEDTLS_ERR_MPI_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100283 return PSA_ERROR_INSUFFICIENT_MEMORY;
Dave Rodgman509b5672023-08-16 19:26:23 +0100284#endif
Gilles Peskinef76aa772018-10-29 19:24:33 +0100285
Dave Rodgman509b5672023-08-16 19:26:23 +0100286#if defined(MBEDTLS_PK_C)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100287 case MBEDTLS_ERR_PK_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100288 return PSA_ERROR_INSUFFICIENT_MEMORY;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100289 case MBEDTLS_ERR_PK_TYPE_MISMATCH:
290 case MBEDTLS_ERR_PK_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100291 return PSA_ERROR_INVALID_ARGUMENT;
Dave Rodgman509b5672023-08-16 19:26:23 +0100292#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) || defined(MBEDTLS_FS_IO) || \
293 defined(MBEDTLS_PSA_ITS_FILE_C)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100294 case MBEDTLS_ERR_PK_FILE_IO_ERROR:
Gilles Peskine449bd832023-01-11 14:50:10 +0100295 return PSA_ERROR_STORAGE_FAILURE;
Dave Rodgman509b5672023-08-16 19:26:23 +0100296#endif
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100297 case MBEDTLS_ERR_PK_KEY_INVALID_VERSION:
298 case MBEDTLS_ERR_PK_KEY_INVALID_FORMAT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100299 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100300 case MBEDTLS_ERR_PK_UNKNOWN_PK_ALG:
Gilles Peskine449bd832023-01-11 14:50:10 +0100301 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100302 case MBEDTLS_ERR_PK_PASSWORD_REQUIRED:
303 case MBEDTLS_ERR_PK_PASSWORD_MISMATCH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100304 return PSA_ERROR_NOT_PERMITTED;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100305 case MBEDTLS_ERR_PK_INVALID_PUBKEY:
Gilles Peskine449bd832023-01-11 14:50:10 +0100306 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100307 case MBEDTLS_ERR_PK_INVALID_ALG:
308 case MBEDTLS_ERR_PK_UNKNOWN_NAMED_CURVE:
309 case MBEDTLS_ERR_PK_FEATURE_UNAVAILABLE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100310 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100311 case MBEDTLS_ERR_PK_SIG_LEN_MISMATCH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100312 return PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskinef9f1bdf2021-06-23 20:32:27 +0200313 case MBEDTLS_ERR_PK_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +0100314 return PSA_ERROR_BUFFER_TOO_SMALL;
Dave Rodgman509b5672023-08-16 19:26:23 +0100315#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100316
Gilles Peskineff2d2002019-05-06 15:26:23 +0200317 case MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100318 return PSA_ERROR_HARDWARE_FAILURE;
Gilles Peskineff2d2002019-05-06 15:26:23 +0200319 case MBEDTLS_ERR_PLATFORM_FEATURE_UNSUPPORTED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100320 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskineff2d2002019-05-06 15:26:23 +0200321
Dave Rodgman509b5672023-08-16 19:26:23 +0100322#if defined(MBEDTLS_RSA_C)
Gilles Peskinea5905292018-02-07 20:59:33 +0100323 case MBEDTLS_ERR_RSA_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100324 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100325 case MBEDTLS_ERR_RSA_INVALID_PADDING:
Gilles Peskine449bd832023-01-11 14:50:10 +0100326 return PSA_ERROR_INVALID_PADDING;
Gilles Peskinea5905292018-02-07 20:59:33 +0100327 case MBEDTLS_ERR_RSA_KEY_GEN_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100328 return PSA_ERROR_HARDWARE_FAILURE;
Gilles Peskinea5905292018-02-07 20:59:33 +0100329 case MBEDTLS_ERR_RSA_KEY_CHECK_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100330 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100331 case MBEDTLS_ERR_RSA_PUBLIC_FAILED:
332 case MBEDTLS_ERR_RSA_PRIVATE_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100333 return PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinea5905292018-02-07 20:59:33 +0100334 case MBEDTLS_ERR_RSA_VERIFY_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100335 return PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskinea5905292018-02-07 20:59:33 +0100336 case MBEDTLS_ERR_RSA_OUTPUT_TOO_LARGE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100337 return PSA_ERROR_BUFFER_TOO_SMALL;
Gilles Peskinea5905292018-02-07 20:59:33 +0100338 case MBEDTLS_ERR_RSA_RNG_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100339 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Dave Rodgman509b5672023-08-16 19:26:23 +0100340#endif
Manuel Pégourié-Gonnard93c08472021-04-15 12:23:55 +0200341
Dave Rodgman1dab4452023-09-01 09:59:51 +0100342#if defined(MBEDTLS_ECP_LIGHT)
itayzafrir5c753392018-05-08 11:18:38 +0300343 case MBEDTLS_ERR_ECP_BAD_INPUT_DATA:
itayzafrir7b30f8b2018-05-09 16:07:36 +0300344 case MBEDTLS_ERR_ECP_INVALID_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +0100345 return PSA_ERROR_INVALID_ARGUMENT;
itayzafrir7b30f8b2018-05-09 16:07:36 +0300346 case MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +0100347 return PSA_ERROR_BUFFER_TOO_SMALL;
itayzafrir7b30f8b2018-05-09 16:07:36 +0300348 case MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100349 return PSA_ERROR_NOT_SUPPORTED;
itayzafrir7b30f8b2018-05-09 16:07:36 +0300350 case MBEDTLS_ERR_ECP_SIG_LEN_MISMATCH:
351 case MBEDTLS_ERR_ECP_VERIFY_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100352 return PSA_ERROR_INVALID_SIGNATURE;
itayzafrir7b30f8b2018-05-09 16:07:36 +0300353 case MBEDTLS_ERR_ECP_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100354 return PSA_ERROR_INSUFFICIENT_MEMORY;
Gilles Peskine40d81602020-11-25 00:09:47 +0100355 case MBEDTLS_ERR_ECP_RANDOM_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100356 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskine40d81602020-11-25 00:09:47 +0100357
Dave Rodgman509b5672023-08-16 19:26:23 +0100358#if defined(MBEDTLS_ECP_RESTARTABLE)
Paul Elliott588f8ed2022-12-02 18:10:26 +0000359 case MBEDTLS_ERR_ECP_IN_PROGRESS:
360 return PSA_OPERATION_INCOMPLETE;
Dave Rodgman509b5672023-08-16 19:26:23 +0100361#endif
362#endif
Paul Elliott588f8ed2022-12-02 18:10:26 +0000363
Janos Follatha13b9052019-11-22 12:48:59 +0000364 case MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100365 return PSA_ERROR_CORRUPTION_DETECTED;
itayzafrir5c753392018-05-08 11:18:38 +0300366
Gilles Peskinee59236f2018-01-27 23:32:46 +0100367 default:
Gilles Peskine449bd832023-01-11 14:50:10 +0100368 return PSA_ERROR_GENERIC_ERROR;
Gilles Peskinee59236f2018-01-27 23:32:46 +0100369 }
370}
371
Paul Elliottdc42ca82023-02-24 18:11:59 +0000372/**
373 * \brief For output buffers which contain "tags"
374 * (outputs that may be checked for validity like
375 * hashes, MACs and signatures), fill the unused
376 * part of the output buffer (the whole buffer on
377 * error, the trailing part on success) with
378 * something that isn't a valid tag (barring an
379 * attack on the tag and deliberately-crafted
380 * input), in case the caller doesn't check the
381 * return status properly.
382 *
383 * \param output_buffer Pointer to buffer to wipe. May not be NULL
384 * unless \p output_buffer_size is zero.
385 * \param status Status of function called to generate
386 * output_buffer originally
387 * \param output_buffer_size Size of output buffer. If zero, \p output_buffer
388 * could be NULL.
389 * \param output_buffer_length Length of data written to output_buffer, must be
390 * less than \p output_buffer_size
391 */
392static void psa_wipe_tag_output_buffer(uint8_t *output_buffer, psa_status_t status,
Paul Elliott7118d172023-02-26 16:57:05 +0000393 size_t output_buffer_size, size_t output_buffer_length)
394{
Paul Elliottdc42ca82023-02-24 18:11:59 +0000395 size_t offset = 0;
396
397 if (output_buffer_size == 0) {
398 /* If output_buffer_size is 0 then we have nothing to do. We must not
399 call memset because output_buffer may be NULL in this case */
400 return;
401 }
402
403 if (status == PSA_SUCCESS) {
404 offset = output_buffer_length;
405 }
406
407 memset(output_buffer + offset, '!', output_buffer_size - offset);
408}
409
Gilles Peskineb0b255c2018-07-06 17:01:38 +0200410
Gilles Peskine449bd832023-01-11 14:50:10 +0100411psa_status_t psa_validate_unstructured_key_bit_size(psa_key_type_t type,
412 size_t bits)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200413{
414 /* Check that the bit size is acceptable for the key type */
Gilles Peskine449bd832023-01-11 14:50:10 +0100415 switch (type) {
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200416 case PSA_KEY_TYPE_RAW_DATA:
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200417 case PSA_KEY_TYPE_HMAC:
Gilles Peskineea0fb492018-07-12 17:17:20 +0200418 case PSA_KEY_TYPE_DERIVE:
Neil Armstrong4b5710f2022-05-25 11:30:27 +0200419 case PSA_KEY_TYPE_PASSWORD:
420 case PSA_KEY_TYPE_PASSWORD_HASH:
Gilles Peskineea0fb492018-07-12 17:17:20 +0200421 break;
Ronald Cron1f0db802021-03-12 09:59:30 +0100422#if defined(PSA_WANT_KEY_TYPE_AES)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200423 case PSA_KEY_TYPE_AES:
Gilles Peskine449bd832023-01-11 14:50:10 +0100424 if (bits != 128 && bits != 192 && bits != 256) {
425 return PSA_ERROR_INVALID_ARGUMENT;
426 }
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200427 break;
428#endif
Gilles Peskine6c12a1e2021-09-21 11:59:39 +0200429#if defined(PSA_WANT_KEY_TYPE_ARIA)
430 case PSA_KEY_TYPE_ARIA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100431 if (bits != 128 && bits != 192 && bits != 256) {
432 return PSA_ERROR_INVALID_ARGUMENT;
433 }
Gilles Peskine6c12a1e2021-09-21 11:59:39 +0200434 break;
435#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100436#if defined(PSA_WANT_KEY_TYPE_CAMELLIA)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200437 case PSA_KEY_TYPE_CAMELLIA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100438 if (bits != 128 && bits != 192 && bits != 256) {
439 return PSA_ERROR_INVALID_ARGUMENT;
440 }
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200441 break;
442#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100443#if defined(PSA_WANT_KEY_TYPE_DES)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200444 case PSA_KEY_TYPE_DES:
Gilles Peskine449bd832023-01-11 14:50:10 +0100445 if (bits != 64 && bits != 128 && bits != 192) {
446 return PSA_ERROR_INVALID_ARGUMENT;
447 }
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200448 break;
449#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100450#if defined(PSA_WANT_KEY_TYPE_CHACHA20)
Gilles Peskine26869f22019-05-06 15:25:00 +0200451 case PSA_KEY_TYPE_CHACHA20:
Gilles Peskine449bd832023-01-11 14:50:10 +0100452 if (bits != 256) {
453 return PSA_ERROR_INVALID_ARGUMENT;
454 }
Gilles Peskine26869f22019-05-06 15:25:00 +0200455 break;
456#endif
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200457 default:
Gilles Peskine449bd832023-01-11 14:50:10 +0100458 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200459 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100460 if (bits % 8 != 0) {
461 return PSA_ERROR_INVALID_ARGUMENT;
462 }
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200463
Gilles Peskine449bd832023-01-11 14:50:10 +0100464 return PSA_SUCCESS;
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200465}
466
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100467/** Check whether a given key type is valid for use with a given MAC algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100468 *
Steven Cooremancd640932021-03-08 12:00:27 +0100469 * Upon successful return of this function, the behavior of #PSA_MAC_LENGTH
470 * when called with the validated \p algorithm and \p key_type is well-defined.
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100471 *
472 * \param[in] algorithm The specific MAC algorithm (can be wildcard).
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100473 * \param[in] key_type The key type of the key to be used with the
474 * \p algorithm.
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100475 *
476 * \retval #PSA_SUCCESS
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100477 * The \p key_type is valid for use with the \p algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100478 * \retval #PSA_ERROR_INVALID_ARGUMENT
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100479 * The \p key_type is not valid for use with the \p algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100480 */
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100481MBEDTLS_STATIC_TESTABLE psa_status_t psa_mac_key_can_do(
Steven Cooreman58c94d32021-03-02 21:31:17 +0100482 psa_algorithm_t algorithm,
Gilles Peskine449bd832023-01-11 14:50:10 +0100483 psa_key_type_t key_type)
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100484{
Gilles Peskine449bd832023-01-11 14:50:10 +0100485 if (PSA_ALG_IS_HMAC(algorithm)) {
486 if (key_type == PSA_KEY_TYPE_HMAC) {
487 return PSA_SUCCESS;
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100488 }
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100489 }
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100490
Gilles Peskine449bd832023-01-11 14:50:10 +0100491 if (PSA_ALG_IS_BLOCK_CIPHER_MAC(algorithm)) {
492 /* Check that we're calling PSA_BLOCK_CIPHER_BLOCK_LENGTH with a cipher
493 * key. */
494 if ((key_type & PSA_KEY_TYPE_CATEGORY_MASK) ==
495 PSA_KEY_TYPE_CATEGORY_SYMMETRIC) {
496 /* PSA_BLOCK_CIPHER_BLOCK_LENGTH returns 1 for stream ciphers and
497 * the block length (larger than 1) for block ciphers. */
498 if (PSA_BLOCK_CIPHER_BLOCK_LENGTH(key_type) > 1) {
499 return PSA_SUCCESS;
500 }
501 }
502 }
503
504 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100505}
506
Gilles Peskine449bd832023-01-11 14:50:10 +0100507psa_status_t psa_allocate_buffer_to_slot(psa_key_slot_t *slot,
508 size_t buffer_length)
Steven Cooreman75b74362020-07-28 14:30:13 +0200509{
Gilles Peskine449bd832023-01-11 14:50:10 +0100510 if (slot->key.data != NULL) {
511 return PSA_ERROR_ALREADY_EXISTS;
512 }
Steven Cooreman75b74362020-07-28 14:30:13 +0200513
Gilles Peskine449bd832023-01-11 14:50:10 +0100514 slot->key.data = mbedtls_calloc(1, buffer_length);
515 if (slot->key.data == NULL) {
516 return PSA_ERROR_INSUFFICIENT_MEMORY;
517 }
Steven Cooreman75b74362020-07-28 14:30:13 +0200518
Ronald Cronea0f8a62020-11-25 17:52:23 +0100519 slot->key.bytes = buffer_length;
Gilles Peskine449bd832023-01-11 14:50:10 +0100520 return PSA_SUCCESS;
Steven Cooreman75b74362020-07-28 14:30:13 +0200521}
522
Gilles Peskine449bd832023-01-11 14:50:10 +0100523psa_status_t psa_copy_key_material_into_slot(psa_key_slot_t *slot,
524 const uint8_t *data,
525 size_t data_length)
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200526{
Gilles Peskine449bd832023-01-11 14:50:10 +0100527 psa_status_t status = psa_allocate_buffer_to_slot(slot,
528 data_length);
529 if (status != PSA_SUCCESS) {
530 return status;
531 }
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200532
Gilles Peskine449bd832023-01-11 14:50:10 +0100533 memcpy(slot->key.data, data, data_length);
534 return PSA_SUCCESS;
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200535}
536
Ronald Crona0fe59f2020-11-29 11:14:53 +0100537psa_status_t psa_import_key_into_slot(
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100538 const psa_key_attributes_t *attributes,
539 const uint8_t *data, size_t data_length,
540 uint8_t *key_buffer, size_t key_buffer_size,
Gilles Peskine449bd832023-01-11 14:50:10 +0100541 size_t *key_buffer_length, size_t *bits)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100542{
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100543 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
544 psa_key_type_t type = attributes->core.type;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100545
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200546 /* zero-length keys are never supported. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100547 if (data_length == 0) {
548 return PSA_ERROR_NOT_SUPPORTED;
549 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200550
Gilles Peskine449bd832023-01-11 14:50:10 +0100551 if (key_type_is_raw_bytes(type)) {
552 *bits = PSA_BYTES_TO_BITS(data_length);
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200553
Gilles Peskine449bd832023-01-11 14:50:10 +0100554 status = psa_validate_unstructured_key_bit_size(attributes->core.type,
555 *bits);
556 if (status != PSA_SUCCESS) {
557 return status;
558 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200559
Ronald Crondd04d422020-11-28 15:14:42 +0100560 /* Copy the key material. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100561 memcpy(key_buffer, data, data_length);
Ronald Crondd04d422020-11-28 15:14:42 +0100562 *key_buffer_length = data_length;
Gilles Peskine449bd832023-01-11 14:50:10 +0100563 (void) key_buffer_size;
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200564
Gilles Peskine449bd832023-01-11 14:50:10 +0100565 return PSA_SUCCESS;
566 } else if (PSA_KEY_TYPE_IS_ASYMMETRIC(type)) {
Valerio Settia55f0422023-07-10 15:34:41 +0200567#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_IMPORT) || \
Przemek Stekiel6d85afa2023-04-28 11:42:17 +0200568 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY)
Przemek Stekiel472b3f32022-12-01 14:38:49 +0100569 if (PSA_KEY_TYPE_IS_DH(type)) {
Przemek Stekield1cf1ba2023-04-27 12:04:21 +0200570 if (psa_is_dh_key_size_valid(PSA_BYTES_TO_BITS(data_length)) == 0) {
Przemek Stekiel472b3f32022-12-01 14:38:49 +0100571 return PSA_ERROR_INVALID_ARGUMENT;
572 }
Przemek Stekiel33c91eb2023-05-30 15:16:35 +0200573 return mbedtls_psa_ffdh_import_key(attributes,
574 data, data_length,
575 key_buffer, key_buffer_size,
576 key_buffer_length,
577 bits);
Przemek Stekiel472b3f32022-12-01 14:38:49 +0100578 }
Valerio Settia55f0422023-07-10 15:34:41 +0200579#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_IMPORT) ||
Przemek Stekiel6d85afa2023-04-28 11:42:17 +0200580 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY) */
Valerio Setti27c501a2023-06-27 16:58:52 +0200581#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_IMPORT) || \
Gilles Peskine449bd832023-01-11 14:50:10 +0100582 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
583 if (PSA_KEY_TYPE_IS_ECC(type)) {
584 return mbedtls_psa_ecp_import_key(attributes,
585 data, data_length,
586 key_buffer, key_buffer_size,
587 key_buffer_length,
588 bits);
Steven Cooreman40120f62020-10-29 11:42:22 +0100589 }
Valerio Setti27c501a2023-06-27 16:58:52 +0200590#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_IMPORT) ||
John Durkop9814fa22020-11-04 12:28:15 -0800591 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
Valerio Settife478902023-07-25 12:27:19 +0200592#if (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) && \
593 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) || \
Gilles Peskine449bd832023-01-11 14:50:10 +0100594 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
595 if (PSA_KEY_TYPE_IS_RSA(type)) {
596 return mbedtls_psa_rsa_import_key(attributes,
597 data, data_length,
598 key_buffer, key_buffer_size,
599 key_buffer_length,
600 bits);
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200601 }
Valerio Settife478902023-07-25 12:27:19 +0200602#endif /* (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) &&
603 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) ||
John Durkop9814fa22020-11-04 12:28:15 -0800604 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100605 }
Steven Cooreman40120f62020-10-29 11:42:22 +0100606
Gilles Peskine449bd832023-01-11 14:50:10 +0100607 return PSA_ERROR_NOT_SUPPORTED;
Darryl Green06fd18d2018-07-16 11:21:11 +0100608}
609
Gilles Peskinef603c712019-01-19 13:40:11 +0100610/** Calculate the intersection of two algorithm usage policies.
611 *
612 * Return 0 (which allows no operation) on incompatibility.
613 */
614static psa_algorithm_t psa_key_policy_algorithm_intersection(
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100615 psa_key_type_t key_type,
Gilles Peskinef603c712019-01-19 13:40:11 +0100616 psa_algorithm_t alg1,
Gilles Peskine449bd832023-01-11 14:50:10 +0100617 psa_algorithm_t alg2)
Gilles Peskinef603c712019-01-19 13:40:11 +0100618{
Gilles Peskine549ea862019-05-22 11:45:59 +0200619 /* Common case: both sides actually specify the same policy. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100620 if (alg1 == alg2) {
621 return alg1;
622 }
Steven Cooreman03488022021-02-18 12:07:20 +0100623 /* If the policies are from the same hash-and-sign family, check
624 * if one is a wildcard. If so the other has the specific algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100625 if (PSA_ALG_IS_SIGN_HASH(alg1) &&
626 PSA_ALG_IS_SIGN_HASH(alg2) &&
627 (alg1 & ~PSA_ALG_HASH_MASK) == (alg2 & ~PSA_ALG_HASH_MASK)) {
628 if (PSA_ALG_SIGN_GET_HASH(alg1) == PSA_ALG_ANY_HASH) {
629 return alg2;
630 }
631 if (PSA_ALG_SIGN_GET_HASH(alg2) == PSA_ALG_ANY_HASH) {
632 return alg1;
633 }
Steven Cooreman03488022021-02-18 12:07:20 +0100634 }
635 /* If the policies are from the same AEAD family, check whether
Steven Cooreman7de9e2d2021-02-22 17:05:56 +0100636 * one of them is a minimum-tag-length wildcard. Calculate the most
Steven Cooreman03488022021-02-18 12:07:20 +0100637 * restrictive tag length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100638 if (PSA_ALG_IS_AEAD(alg1) && PSA_ALG_IS_AEAD(alg2) &&
639 (PSA_ALG_AEAD_WITH_SHORTENED_TAG(alg1, 0) ==
640 PSA_ALG_AEAD_WITH_SHORTENED_TAG(alg2, 0))) {
641 size_t alg1_len = PSA_ALG_AEAD_GET_TAG_LENGTH(alg1);
642 size_t alg2_len = PSA_ALG_AEAD_GET_TAG_LENGTH(alg2);
Steven Cooremancd640932021-03-08 12:00:27 +0100643 size_t restricted_len = alg1_len > alg2_len ? alg1_len : alg2_len;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100644
Steven Cooreman7de9e2d2021-02-22 17:05:56 +0100645 /* If both are wildcards, return most restrictive wildcard */
Gilles Peskine449bd832023-01-11 14:50:10 +0100646 if (((alg1 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0) &&
647 ((alg2 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0)) {
648 return PSA_ALG_AEAD_WITH_AT_LEAST_THIS_LENGTH_TAG(
649 alg1, restricted_len);
Steven Cooreman03488022021-02-18 12:07:20 +0100650 }
651 /* If only one is a wildcard, return specific algorithm if compatible. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100652 if (((alg1 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0) &&
653 (alg1_len <= alg2_len)) {
654 return alg2;
Steven Cooreman03488022021-02-18 12:07:20 +0100655 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100656 if (((alg2 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0) &&
657 (alg2_len <= alg1_len)) {
658 return alg1;
Steven Cooreman03488022021-02-18 12:07:20 +0100659 }
660 }
661 /* If the policies are from the same MAC family, check whether one
662 * of them is a minimum-MAC-length policy. Calculate the most
663 * restrictive tag length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100664 if (PSA_ALG_IS_MAC(alg1) && PSA_ALG_IS_MAC(alg2) &&
665 (PSA_ALG_FULL_LENGTH_MAC(alg1) ==
666 PSA_ALG_FULL_LENGTH_MAC(alg2))) {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100667 /* Validate the combination of key type and algorithm. Since the base
668 * algorithm of alg1 and alg2 are the same, we only need this once. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100669 if (PSA_SUCCESS != psa_mac_key_can_do(alg1, key_type)) {
670 return 0;
671 }
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100672
Steven Cooreman31a876d2021-03-03 20:47:40 +0100673 /* Get the (exact or at-least) output lengths for both sides of the
674 * requested intersection. None of the currently supported algorithms
675 * have an output length dependent on the actual key size, so setting it
676 * to a bogus value of 0 is currently OK.
677 *
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100678 * Note that for at-least-this-length wildcard algorithms, the output
679 * length is set to the shortest allowed length, which allows us to
680 * calculate the most restrictive tag length for the intersection. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100681 size_t alg1_len = PSA_MAC_LENGTH(key_type, 0, alg1);
682 size_t alg2_len = PSA_MAC_LENGTH(key_type, 0, alg2);
Steven Cooremancd640932021-03-08 12:00:27 +0100683 size_t restricted_len = alg1_len > alg2_len ? alg1_len : alg2_len;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100684
Steven Cooremana1d83222021-02-25 10:20:29 +0100685 /* If both are wildcards, return most restrictive wildcard */
Gilles Peskine449bd832023-01-11 14:50:10 +0100686 if (((alg1 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0) &&
687 ((alg2 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0)) {
688 return PSA_ALG_AT_LEAST_THIS_LENGTH_MAC(alg1, restricted_len);
Steven Cooreman03488022021-02-18 12:07:20 +0100689 }
Steven Cooreman31a876d2021-03-03 20:47:40 +0100690
691 /* If only one is an at-least-this-length policy, the intersection would
692 * be the other (fixed-length) policy as long as said fixed length is
693 * equal to or larger than the shortest allowed length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100694 if ((alg1 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0) {
695 return (alg1_len <= alg2_len) ? alg2 : 0;
Steven Cooreman03488022021-02-18 12:07:20 +0100696 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100697 if ((alg2 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0) {
698 return (alg2_len <= alg1_len) ? alg1 : 0;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100699 }
Steven Cooreman31a876d2021-03-03 20:47:40 +0100700
Steven Cooremancd640932021-03-08 12:00:27 +0100701 /* If none of them are wildcards, check whether they define the same tag
702 * length. This is still possible here when one is default-length and
703 * the other specific-length. Ensure to always return the
704 * specific-length version for the intersection. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100705 if (alg1_len == alg2_len) {
706 return PSA_ALG_TRUNCATED_MAC(alg1, alg1_len);
707 }
Gilles Peskinef603c712019-01-19 13:40:11 +0100708 }
709 /* If the policies are incompatible, allow nothing. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100710 return 0;
Gilles Peskinef603c712019-01-19 13:40:11 +0100711}
712
Gilles Peskine449bd832023-01-11 14:50:10 +0100713static int psa_key_algorithm_permits(psa_key_type_t key_type,
714 psa_algorithm_t policy_alg,
715 psa_algorithm_t requested_alg)
Gilles Peskined6f371b2019-05-10 19:33:38 +0200716{
Gilles Peskine549ea862019-05-22 11:45:59 +0200717 /* Common case: the policy only allows requested_alg. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100718 if (requested_alg == policy_alg) {
719 return 1;
720 }
Steven Cooreman03488022021-02-18 12:07:20 +0100721 /* If policy_alg is a hash-and-sign with a wildcard for the hash,
722 * and requested_alg is the same hash-and-sign family with any hash,
723 * then requested_alg is compliant with policy_alg. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100724 if (PSA_ALG_IS_SIGN_HASH(requested_alg) &&
725 PSA_ALG_SIGN_GET_HASH(policy_alg) == PSA_ALG_ANY_HASH) {
726 return (policy_alg & ~PSA_ALG_HASH_MASK) ==
727 (requested_alg & ~PSA_ALG_HASH_MASK);
Steven Cooreman03488022021-02-18 12:07:20 +0100728 }
729 /* If policy_alg is a wildcard AEAD algorithm of the same base as
730 * the requested algorithm, check the requested tag length to be
731 * equal-length or longer than the wildcard-specified length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100732 if (PSA_ALG_IS_AEAD(policy_alg) &&
733 PSA_ALG_IS_AEAD(requested_alg) &&
734 (PSA_ALG_AEAD_WITH_SHORTENED_TAG(policy_alg, 0) ==
735 PSA_ALG_AEAD_WITH_SHORTENED_TAG(requested_alg, 0)) &&
736 ((policy_alg & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0)) {
737 return PSA_ALG_AEAD_GET_TAG_LENGTH(policy_alg) <=
738 PSA_ALG_AEAD_GET_TAG_LENGTH(requested_alg);
Steven Cooreman03488022021-02-18 12:07:20 +0100739 }
Steven Cooremancd640932021-03-08 12:00:27 +0100740 /* If policy_alg is a MAC algorithm of the same base as the requested
741 * algorithm, check whether their MAC lengths are compatible. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100742 if (PSA_ALG_IS_MAC(policy_alg) &&
743 PSA_ALG_IS_MAC(requested_alg) &&
744 (PSA_ALG_FULL_LENGTH_MAC(policy_alg) ==
745 PSA_ALG_FULL_LENGTH_MAC(requested_alg))) {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100746 /* Validate the combination of key type and algorithm. Since the policy
747 * and requested algorithms are the same, we only need this once. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100748 if (PSA_SUCCESS != psa_mac_key_can_do(policy_alg, key_type)) {
749 return 0;
750 }
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100751
Steven Cooreman31a876d2021-03-03 20:47:40 +0100752 /* Get both the requested output length for the algorithm which is to be
753 * verified, and the default output length for the base algorithm.
754 * Note that none of the currently supported algorithms have an output
755 * length dependent on actual key size, so setting it to a bogus value
756 * of 0 is currently OK. */
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100757 size_t requested_output_length = PSA_MAC_LENGTH(
Gilles Peskine449bd832023-01-11 14:50:10 +0100758 key_type, 0, requested_alg);
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100759 size_t default_output_length = PSA_MAC_LENGTH(
Gilles Peskine449bd832023-01-11 14:50:10 +0100760 key_type, 0,
761 PSA_ALG_FULL_LENGTH_MAC(requested_alg));
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100762
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100763 /* If the policy is default-length, only allow an algorithm with
764 * a declared exact-length matching the default. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100765 if (PSA_MAC_TRUNCATED_LENGTH(policy_alg) == 0) {
766 return requested_output_length == default_output_length;
767 }
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100768
769 /* If the requested algorithm is default-length, allow it if the policy
Steven Cooremancd640932021-03-08 12:00:27 +0100770 * length exactly matches the default length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100771 if (PSA_MAC_TRUNCATED_LENGTH(requested_alg) == 0 &&
772 PSA_MAC_TRUNCATED_LENGTH(policy_alg) == default_output_length) {
773 return 1;
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100774 }
775
Steven Cooremancd640932021-03-08 12:00:27 +0100776 /* If policy_alg is an at-least-this-length wildcard MAC algorithm,
777 * check for the requested MAC length to be equal to or longer than the
778 * minimum allowed length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100779 if ((policy_alg & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0) {
780 return PSA_MAC_TRUNCATED_LENGTH(policy_alg) <=
781 requested_output_length;
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100782 }
Gilles Peskined6f371b2019-05-10 19:33:38 +0200783 }
Steven Cooremance48e852020-10-05 16:02:45 +0200784 /* If policy_alg is a generic key agreement operation, then using it for
Steven Cooremanfa5e6312020-10-15 17:07:12 +0200785 * a key derivation with that key agreement should also be allowed. This
786 * behaviour is expected to be defined in a future specification version. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100787 if (PSA_ALG_IS_RAW_KEY_AGREEMENT(policy_alg) &&
788 PSA_ALG_IS_KEY_AGREEMENT(requested_alg)) {
789 return PSA_ALG_KEY_AGREEMENT_GET_BASE(requested_alg) ==
790 policy_alg;
Steven Cooremance48e852020-10-05 16:02:45 +0200791 }
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100792 /* If it isn't explicitly permitted, it's forbidden. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100793 return 0;
Gilles Peskined6f371b2019-05-10 19:33:38 +0200794}
795
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100796/** Test whether a policy permits an algorithm.
797 *
798 * The caller must test usage flags separately.
Steven Cooreman7e39f052021-02-23 14:18:32 +0100799 *
Steven Cooreman5a172672021-03-02 21:27:42 +0100800 * \note This function requires providing the key type for which the policy is
801 * being validated, since some algorithm policy definitions (e.g. MAC)
802 * have different properties depending on what kind of cipher it is
803 * combined with.
804 *
Steven Cooreman7e39f052021-02-23 14:18:32 +0100805 * \retval PSA_SUCCESS When \p alg is a specific algorithm
806 * allowed by the \p policy.
807 * \retval PSA_ERROR_INVALID_ARGUMENT When \p alg is not a specific algorithm
808 * \retval PSA_ERROR_NOT_PERMITTED When \p alg is a specific algorithm, but
809 * the \p policy does not allow it.
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100810 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100811static psa_status_t psa_key_policy_permits(const psa_key_policy_t *policy,
812 psa_key_type_t key_type,
813 psa_algorithm_t alg)
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100814{
Steven Cooremand788fab2021-02-25 11:29:17 +0100815 /* '0' is not a valid algorithm */
Gilles Peskine449bd832023-01-11 14:50:10 +0100816 if (alg == 0) {
817 return PSA_ERROR_INVALID_ARGUMENT;
818 }
Steven Cooremand788fab2021-02-25 11:29:17 +0100819
Steven Cooreman7e39f052021-02-23 14:18:32 +0100820 /* A requested algorithm cannot be a wildcard. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100821 if (PSA_ALG_IS_WILDCARD(alg)) {
822 return PSA_ERROR_INVALID_ARGUMENT;
823 }
Steven Cooreman7e39f052021-02-23 14:18:32 +0100824
Gilles Peskine449bd832023-01-11 14:50:10 +0100825 if (psa_key_algorithm_permits(key_type, policy->alg, alg) ||
826 psa_key_algorithm_permits(key_type, policy->alg2, alg)) {
827 return PSA_SUCCESS;
828 } else {
829 return PSA_ERROR_NOT_PERMITTED;
830 }
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100831}
832
Gilles Peskinef603c712019-01-19 13:40:11 +0100833/** Restrict a key policy based on a constraint.
834 *
Steven Cooreman5a172672021-03-02 21:27:42 +0100835 * \note This function requires providing the key type for which the policy is
836 * being restricted, since some algorithm policy definitions (e.g. MAC)
837 * have different properties depending on what kind of cipher it is
838 * combined with.
839 *
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100840 * \param[in] key_type The key type for which to restrict the policy
Gilles Peskinef603c712019-01-19 13:40:11 +0100841 * \param[in,out] policy The policy to restrict.
842 * \param[in] constraint The policy constraint to apply.
843 *
844 * \retval #PSA_SUCCESS
845 * \c *policy contains the intersection of the original value of
846 * \c *policy and \c *constraint.
847 * \retval #PSA_ERROR_INVALID_ARGUMENT
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100848 * \c key_type, \c *policy and \c *constraint are incompatible.
Gilles Peskinef603c712019-01-19 13:40:11 +0100849 * \c *policy is unchanged.
850 */
851static psa_status_t psa_restrict_key_policy(
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100852 psa_key_type_t key_type,
Gilles Peskinef603c712019-01-19 13:40:11 +0100853 psa_key_policy_t *policy,
Gilles Peskine449bd832023-01-11 14:50:10 +0100854 const psa_key_policy_t *constraint)
Gilles Peskinef603c712019-01-19 13:40:11 +0100855{
856 psa_algorithm_t intersection_alg =
Gilles Peskine449bd832023-01-11 14:50:10 +0100857 psa_key_policy_algorithm_intersection(key_type, policy->alg,
858 constraint->alg);
Gilles Peskined6f371b2019-05-10 19:33:38 +0200859 psa_algorithm_t intersection_alg2 =
Gilles Peskine449bd832023-01-11 14:50:10 +0100860 psa_key_policy_algorithm_intersection(key_type, policy->alg2,
861 constraint->alg2);
862 if (intersection_alg == 0 && policy->alg != 0 && constraint->alg != 0) {
863 return PSA_ERROR_INVALID_ARGUMENT;
864 }
865 if (intersection_alg2 == 0 && policy->alg2 != 0 && constraint->alg2 != 0) {
866 return PSA_ERROR_INVALID_ARGUMENT;
867 }
Gilles Peskinef603c712019-01-19 13:40:11 +0100868 policy->usage &= constraint->usage;
869 policy->alg = intersection_alg;
Gilles Peskined6f371b2019-05-10 19:33:38 +0200870 policy->alg2 = intersection_alg2;
Gilles Peskine449bd832023-01-11 14:50:10 +0100871 return PSA_SUCCESS;
Gilles Peskinef603c712019-01-19 13:40:11 +0100872}
873
Przemek Stekiel061f6942022-11-30 10:51:35 +0100874/** Get the description of a key given its identifier and policy constraints
875 * and lock it.
876 *
877 * The key must have allow all the usage flags set in \p usage. If \p alg is
878 * nonzero, the key must allow operations with this algorithm. If \p alg is
879 * zero, the algorithm is not checked.
880 *
881 * In case of a persistent key, the function loads the description of the key
882 * into a key slot if not already done.
883 *
Ryan Everett098c6652024-01-03 13:03:36 +0000884 * On success, the returned key slot has been registered for reading.
885 * It is the responsibility of the caller to call psa_unregister_read(slot)
886 * when they have finished reading the contents of the slot.
Przemek Stekiel061f6942022-11-30 10:51:35 +0100887 */
888static psa_status_t psa_get_and_lock_key_slot_with_policy(
Ronald Cron5c522922020-11-14 16:35:34 +0100889 mbedtls_svc_key_id_t key,
890 psa_key_slot_t **p_slot,
891 psa_key_usage_t usage,
Gilles Peskine449bd832023-01-11 14:50:10 +0100892 psa_algorithm_t alg)
Darryl Green06fd18d2018-07-16 11:21:11 +0100893{
Ronald Cronf95a2b12020-10-22 15:24:49 +0200894 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel9a5b8122022-12-22 13:34:47 +0100895 psa_key_slot_t *slot = NULL;
Darryl Green06fd18d2018-07-16 11:21:11 +0100896
Gilles Peskine449bd832023-01-11 14:50:10 +0100897 status = psa_get_and_lock_key_slot(key, p_slot);
898 if (status != PSA_SUCCESS) {
899 return status;
900 }
Ronald Cronf95a2b12020-10-22 15:24:49 +0200901 slot = *p_slot;
Darryl Green06fd18d2018-07-16 11:21:11 +0100902
903 /* Enforce that usage policy for the key slot contains all the flags
904 * required by the usage parameter. There is one exception: public
905 * keys can always be exported, so we treat public key objects as
906 * if they had the export flag. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100907 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(slot->attr.type)) {
Darryl Green06fd18d2018-07-16 11:21:11 +0100908 usage &= ~PSA_KEY_USAGE_EXPORT;
Gilles Peskine449bd832023-01-11 14:50:10 +0100909 }
Ronald Cronf95a2b12020-10-22 15:24:49 +0200910
Gilles Peskine449bd832023-01-11 14:50:10 +0100911 if ((slot->attr.policy.usage & usage) != usage) {
Steven Cooreman328f11c2021-03-02 11:44:51 +0100912 status = PSA_ERROR_NOT_PERMITTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +0200913 goto error;
Steven Cooreman328f11c2021-03-02 11:44:51 +0100914 }
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100915
Shaun Case8b0ecbc2021-12-20 21:14:10 -0800916 /* Enforce that the usage policy permits the requested algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100917 if (alg != 0) {
918 status = psa_key_policy_permits(&slot->attr.policy,
919 slot->attr.type,
920 alg);
921 if (status != PSA_SUCCESS) {
Steven Cooreman7e39f052021-02-23 14:18:32 +0100922 goto error;
Gilles Peskine449bd832023-01-11 14:50:10 +0100923 }
Steven Cooreman7e39f052021-02-23 14:18:32 +0100924 }
Darryl Green06fd18d2018-07-16 11:21:11 +0100925
Gilles Peskine449bd832023-01-11 14:50:10 +0100926 return PSA_SUCCESS;
Ronald Cronf95a2b12020-10-22 15:24:49 +0200927
928error:
929 *p_slot = NULL;
Ryan Everett098c6652024-01-03 13:03:36 +0000930 psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +0200931
Gilles Peskine449bd832023-01-11 14:50:10 +0100932 return status;
Darryl Green06fd18d2018-07-16 11:21:11 +0100933}
Darryl Green940d72c2018-07-13 13:18:51 +0100934
Ronald Cron5c522922020-11-14 16:35:34 +0100935/** Get a key slot containing a transparent key and lock it.
Gilles Peskine28f8f302019-07-24 13:30:31 +0200936 *
937 * A transparent key is a key for which the key material is directly
Ronald Cronddae0f52021-08-24 15:39:44 +0200938 * available, as opposed to a key in a secure element and/or to be used
939 * by a secure element.
Gilles Peskine28f8f302019-07-24 13:30:31 +0200940 *
Ronald Cronddae0f52021-08-24 15:39:44 +0200941 * This is a temporary function that may be used instead of
942 * psa_get_and_lock_key_slot_with_policy() when there is no opaque key support
943 * for a cryptographic operation.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200944 *
Ryan Everett098c6652024-01-03 13:03:36 +0000945 * On success, the returned key slot has been registered for reading.
946 * It is the responsibility of the caller to call psa_unregister_read(slot)
947 * when they have finished reading the contents of the slot.
Gilles Peskine28f8f302019-07-24 13:30:31 +0200948 */
Ronald Cron5c522922020-11-14 16:35:34 +0100949static psa_status_t psa_get_and_lock_transparent_key_slot_with_policy(
950 mbedtls_svc_key_id_t key,
951 psa_key_slot_t **p_slot,
952 psa_key_usage_t usage,
Gilles Peskine449bd832023-01-11 14:50:10 +0100953 psa_algorithm_t alg)
Gilles Peskine28f8f302019-07-24 13:30:31 +0200954{
Gilles Peskine449bd832023-01-11 14:50:10 +0100955 psa_status_t status = psa_get_and_lock_key_slot_with_policy(key, p_slot,
956 usage, alg);
957 if (status != PSA_SUCCESS) {
958 return status;
Gilles Peskine28f8f302019-07-24 13:30:31 +0200959 }
Ronald Cronf95a2b12020-10-22 15:24:49 +0200960
Gilles Peskine449bd832023-01-11 14:50:10 +0100961 if (psa_key_lifetime_is_external((*p_slot)->attr.lifetime)) {
Ryan Everett098c6652024-01-03 13:03:36 +0000962 psa_unregister_read(*p_slot);
Gilles Peskine449bd832023-01-11 14:50:10 +0100963 *p_slot = NULL;
964 return PSA_ERROR_NOT_SUPPORTED;
965 }
966
967 return PSA_SUCCESS;
Gilles Peskine28f8f302019-07-24 13:30:31 +0200968}
Gilles Peskine28f8f302019-07-24 13:30:31 +0200969
Gilles Peskine449bd832023-01-11 14:50:10 +0100970psa_status_t psa_remove_key_data_from_memory(psa_key_slot_t *slot)
Darryl Green40225ba2018-11-15 14:48:15 +0000971{
Gilles Peskine449bd832023-01-11 14:50:10 +0100972 if (slot->key.data != NULL) {
Tom Cosgrove52f7e182023-08-01 09:08:48 +0100973 mbedtls_zeroize_and_free(slot->key.data, slot->key.bytes);
Gilles Peskine449bd832023-01-11 14:50:10 +0100974 }
Ronald Cronea0f8a62020-11-25 17:52:23 +0100975
Ronald Cronea0f8a62020-11-25 17:52:23 +0100976 slot->key.data = NULL;
977 slot->key.bytes = 0;
Darryl Green40225ba2018-11-15 14:48:15 +0000978
Gilles Peskine449bd832023-01-11 14:50:10 +0100979 return PSA_SUCCESS;
Darryl Green40225ba2018-11-15 14:48:15 +0000980}
981
Gilles Peskinef77ed1f2018-12-03 11:58:46 +0100982/** Completely wipe a slot in memory, including its policy.
983 * Persistent storage is not affected. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100984psa_status_t psa_wipe_key_slot(psa_key_slot_t *slot)
Gilles Peskinef77ed1f2018-12-03 11:58:46 +0100985{
Gilles Peskine449bd832023-01-11 14:50:10 +0100986 psa_status_t status = psa_remove_key_data_from_memory(slot);
Ronald Cronddd3d052020-10-30 14:07:07 +0100987
Gilles Peskine449bd832023-01-11 14:50:10 +0100988 /*
989 * As the return error code may not be handled in case of multiple errors,
Ryan Everettaa33c512023-12-21 17:32:07 +0000990 * do our best to report an unexpected amount of registered readers.
991 * Assert with MBEDTLS_TEST_HOOK_TEST_ASSERT that registered_readers is
992 * equal to one:
Gilles Peskine449bd832023-01-11 14:50:10 +0100993 * if the MBEDTLS_TEST_HOOKS configuration option is enabled and the
994 * function is called as part of the execution of a test suite, the
995 * execution of the test suite is stopped in error if the assertion fails.
996 */
Ryan Everett4755e6b2024-01-12 16:35:59 +0000997 if (((slot->state == PSA_SLOT_FULL) ||
998 (slot->state == PSA_SLOT_PENDING_DELETION)) &&
999 (slot->registered_readers != 1)) {
Ryan Everettaa33c512023-12-21 17:32:07 +00001000 MBEDTLS_TEST_HOOK_TEST_ASSERT(slot->registered_readers == 1);
Ronald Cronddd3d052020-10-30 14:07:07 +01001001 status = PSA_ERROR_CORRUPTION_DETECTED;
1002 }
1003
Gilles Peskine3f7cd622019-08-13 15:01:08 +02001004 /* Multipart operations may still be using the key. This is safe
1005 * because all multipart operation objects are independent from
1006 * the key slot: if they need to access the key after the setup
1007 * phase, they have a copy of the key. Note that this means that
1008 * key material can linger until all operations are completed. */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001009 /* At this point, key material and other type-specific content has
1010 * been wiped. Clear remaining metadata. We can call memset and not
Ryan Everettaa33c512023-12-21 17:32:07 +00001011 * zeroize because the metadata is not particularly sensitive.
1012 * This memset also sets the slot's state to PSA_SLOT_EMPTY. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001013 memset(slot, 0, sizeof(*slot));
1014 return status;
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001015}
1016
Gilles Peskine449bd832023-01-11 14:50:10 +01001017psa_status_t psa_destroy_key(mbedtls_svc_key_id_t key)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001018{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001019 psa_key_slot_t *slot;
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001020 psa_status_t status; /* status of the last operation */
1021 psa_status_t overall_status = PSA_SUCCESS;
Gilles Peskine354f7672019-07-12 23:46:38 +02001022#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1023 psa_se_drv_table_entry_t *driver;
1024#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001025
Gilles Peskine449bd832023-01-11 14:50:10 +01001026 if (mbedtls_svc_key_id_is_null(key)) {
1027 return PSA_SUCCESS;
1028 }
Gilles Peskine1841cf42019-10-08 15:48:25 +02001029
Ronald Cronf2911112020-10-29 17:51:10 +01001030 /*
Ronald Cron19daca92020-11-10 18:08:03 +01001031 * Get the description of the key in a key slot. In case of a persistent
Ronald Cronf2911112020-10-29 17:51:10 +01001032 * key, this will load the key description from persistent memory if not
1033 * done yet. We cannot avoid this loading as without it we don't know if
1034 * the key is operated by an SE or not and this information is needed by
1035 * the current implementation.
1036 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001037 status = psa_get_and_lock_key_slot(key, &slot);
1038 if (status != PSA_SUCCESS) {
1039 return status;
1040 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001041
Ronald Cronf2911112020-10-29 17:51:10 +01001042 /*
1043 * If the key slot containing the key description is under access by the
1044 * library (apart from the present access), the key cannot be destroyed
1045 * yet. For the time being, just return in error. Eventually (to be
1046 * implemented), the key should be destroyed when all accesses have
1047 * stopped.
1048 */
Ryan Everettc70ce572024-01-03 16:04:33 +00001049 if (slot->registered_readers > 1) {
1050 psa_unregister_read(slot);
Gilles Peskine449bd832023-01-11 14:50:10 +01001051 return PSA_ERROR_GENERIC_ERROR;
Ronald Cronf2911112020-10-29 17:51:10 +01001052 }
1053
Ryan Everettc70ce572024-01-03 16:04:33 +00001054 slot->state = PSA_SLOT_PENDING_DELETION;
1055
Gilles Peskine449bd832023-01-11 14:50:10 +01001056 if (PSA_KEY_LIFETIME_IS_READ_ONLY(slot->attr.lifetime)) {
Gilles Peskine6687cd02021-04-21 22:32:05 +02001057 /* Refuse the destruction of a read-only key (which may or may not work
1058 * if we attempt it, depending on whether the key is merely read-only
1059 * by policy or actually physically read-only).
Gilles Peskinef9a046e2021-06-07 23:27:54 +02001060 * Just do the best we can, which is to wipe the copy in memory
1061 * (done in this function's cleanup code). */
1062 overall_status = PSA_ERROR_NOT_PERMITTED;
1063 goto exit;
Gilles Peskine6687cd02021-04-21 22:32:05 +02001064 }
1065
Gilles Peskine354f7672019-07-12 23:46:38 +02001066#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001067 driver = psa_get_se_driver_entry(slot->attr.lifetime);
1068 if (driver != NULL) {
Gilles Peskine60450a42019-07-25 11:32:45 +02001069 /* For a key in a secure element, we need to do three things:
1070 * remove the key file in internal storage, destroy the
1071 * key inside the secure element, and update the driver's
1072 * persistent data. Start a transaction that will encompass these
1073 * three actions. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001074 psa_crypto_prepare_transaction(PSA_CRYPTO_TRANSACTION_DESTROY_KEY);
Gilles Peskine8e338702019-07-30 20:06:31 +02001075 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Gilles Peskine449bd832023-01-11 14:50:10 +01001076 psa_crypto_transaction.key.slot = psa_key_slot_get_slot_number(slot);
Gilles Peskine8e338702019-07-30 20:06:31 +02001077 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskine449bd832023-01-11 14:50:10 +01001078 status = psa_crypto_save_transaction();
1079 if (status != PSA_SUCCESS) {
1080 (void) psa_crypto_stop_transaction();
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001081 /* We should still try to destroy the key in the secure
1082 * element and the key metadata in storage. This is especially
1083 * important if the error is that the storage is full.
1084 * But how to do it exactly without risking an inconsistent
1085 * state after a reset?
1086 * https://github.com/ARMmbed/mbed-crypto/issues/215
1087 */
1088 overall_status = status;
1089 goto exit;
Gilles Peskinefc762652019-07-22 19:30:34 +02001090 }
1091
Gilles Peskine449bd832023-01-11 14:50:10 +01001092 status = psa_destroy_se_key(driver,
1093 psa_key_slot_get_slot_number(slot));
1094 if (overall_status == PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001095 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001096 }
Gilles Peskinefc762652019-07-22 19:30:34 +02001097 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001098#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1099
Darryl Greend49a4992018-06-18 17:27:26 +01001100#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001101 if (!PSA_KEY_LIFETIME_IS_VOLATILE(slot->attr.lifetime)) {
1102 status = psa_destroy_persistent_key(slot->attr.id);
1103 if (overall_status == PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001104 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001105 }
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001106
Gilles Peskine9ce31c42019-08-13 15:14:20 +02001107 /* TODO: other slots may have a copy of the same key. We should
1108 * invalidate them.
1109 * https://github.com/ARMmbed/mbed-crypto/issues/214
1110 */
Darryl Greend49a4992018-06-18 17:27:26 +01001111 }
1112#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
Gilles Peskine354f7672019-07-12 23:46:38 +02001113
Gilles Peskinefc762652019-07-22 19:30:34 +02001114#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001115 if (driver != NULL) {
1116 status = psa_save_se_persistent_data(driver);
1117 if (overall_status == PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001118 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001119 }
1120 status = psa_crypto_stop_transaction();
1121 if (overall_status == PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001122 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001123 }
Gilles Peskinefc762652019-07-22 19:30:34 +02001124 }
1125#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1126
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001127exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01001128 status = psa_wipe_key_slot(slot);
Ryan Everett1d32a572024-01-15 11:27:58 +00001129 /* Prioritize CORRUPTION_DETECTED from wiping over a storage error */
Gilles Peskine449bd832023-01-11 14:50:10 +01001130 if (status != PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001131 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001132 }
1133 return overall_status;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001134}
1135
Valerio Settib2bcedb2023-07-10 11:24:00 +02001136#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT) || \
John Durkop0e005192020-10-31 22:06:54 -07001137 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskineb699f072019-04-26 16:06:02 +02001138static psa_status_t psa_get_rsa_public_exponent(
1139 const mbedtls_rsa_context *rsa,
Gilles Peskine449bd832023-01-11 14:50:10 +01001140 psa_key_attributes_t *attributes)
Gilles Peskineb699f072019-04-26 16:06:02 +02001141{
1142 mbedtls_mpi mpi;
Janos Follath24eed8d2019-11-22 13:21:35 +00001143 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb699f072019-04-26 16:06:02 +02001144 uint8_t *buffer = NULL;
1145 size_t buflen;
Gilles Peskine449bd832023-01-11 14:50:10 +01001146 mbedtls_mpi_init(&mpi);
Gilles Peskineb699f072019-04-26 16:06:02 +02001147
Gilles Peskine449bd832023-01-11 14:50:10 +01001148 ret = mbedtls_rsa_export(rsa, NULL, NULL, NULL, NULL, &mpi);
1149 if (ret != 0) {
Gilles Peskineb699f072019-04-26 16:06:02 +02001150 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001151 }
1152 if (mbedtls_mpi_cmp_int(&mpi, 65537) == 0) {
Gilles Peskine772c8b12019-04-26 17:37:21 +02001153 /* It's the default value, which is reported as an empty string,
1154 * so there's nothing to do. */
1155 goto exit;
1156 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001157
Gilles Peskine449bd832023-01-11 14:50:10 +01001158 buflen = mbedtls_mpi_size(&mpi);
1159 buffer = mbedtls_calloc(1, buflen);
1160 if (buffer == NULL) {
Gilles Peskineb699f072019-04-26 16:06:02 +02001161 ret = MBEDTLS_ERR_MPI_ALLOC_FAILED;
1162 goto exit;
1163 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001164 ret = mbedtls_mpi_write_binary(&mpi, buffer, buflen);
1165 if (ret != 0) {
Gilles Peskineb699f072019-04-26 16:06:02 +02001166 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001167 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001168 attributes->domain_parameters = buffer;
1169 attributes->domain_parameters_size = buflen;
1170
1171exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01001172 mbedtls_mpi_free(&mpi);
1173 if (ret != 0) {
1174 mbedtls_free(buffer);
1175 }
1176 return mbedtls_to_psa_error(ret);
Gilles Peskineb699f072019-04-26 16:06:02 +02001177}
Valerio Settib2bcedb2023-07-10 11:24:00 +02001178#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT) ||
John Durkop9814fa22020-11-04 12:28:15 -08001179 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001180
Gilles Peskinebfd322f2019-07-23 11:58:03 +02001181/** Retrieve all the publicly-accessible attributes of a key.
1182 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001183psa_status_t psa_get_key_attributes(mbedtls_svc_key_id_t key,
1184 psa_key_attributes_t *attributes)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001185{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001186 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001187 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001188 psa_key_slot_t *slot;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001189
Gilles Peskine449bd832023-01-11 14:50:10 +01001190 psa_reset_key_attributes(attributes);
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001191
Gilles Peskine449bd832023-01-11 14:50:10 +01001192 status = psa_get_and_lock_key_slot_with_policy(key, &slot, 0, 0);
1193 if (status != PSA_SUCCESS) {
1194 return status;
1195 }
Gilles Peskineb870b182018-07-06 16:02:09 +02001196
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001197 attributes->core = slot->attr;
Gilles Peskine449bd832023-01-11 14:50:10 +01001198 attributes->core.flags &= (MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1199 MBEDTLS_PSA_KA_MASK_DUAL_USE);
Gilles Peskinec8000c02019-08-02 20:15:51 +02001200
1201#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001202 if (psa_get_se_driver_entry(slot->attr.lifetime) != NULL) {
1203 psa_set_key_slot_number(attributes,
1204 psa_key_slot_get_slot_number(slot));
1205 }
Gilles Peskinec8000c02019-08-02 20:15:51 +02001206#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineb699f072019-04-26 16:06:02 +02001207
Gilles Peskine449bd832023-01-11 14:50:10 +01001208 switch (slot->attr.type) {
Valerio Settib2bcedb2023-07-10 11:24:00 +02001209#if (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) && \
1210 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) || \
John Durkop0e005192020-10-31 22:06:54 -07001211 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02001212 case PSA_KEY_TYPE_RSA_KEY_PAIR:
Gilles Peskineb699f072019-04-26 16:06:02 +02001213 case PSA_KEY_TYPE_RSA_PUBLIC_KEY:
Pengyu Lvf75893b2023-12-08 17:21:39 +08001214 /* TODO: This is a temporary situation where domain parameters are deprecated,
1215 * but we need it for namely generating an RSA key with a non-default exponent.
1216 * This would be improved after https://github.com/Mbed-TLS/mbedtls/issues/6494.
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001217 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001218 if (!psa_key_lifetime_is_external(slot->attr.lifetime)) {
Steven Cooremana2371e52020-07-28 14:30:39 +02001219 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02001220
Ronald Cron90857082020-11-25 14:58:33 +01001221 status = mbedtls_psa_rsa_load_representation(
Gilles Peskine449bd832023-01-11 14:50:10 +01001222 slot->attr.type,
1223 slot->key.data,
1224 slot->key.bytes,
1225 &rsa);
1226 if (status != PSA_SUCCESS) {
Steven Cooremana01795d2020-07-24 22:48:15 +02001227 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01001228 }
Steven Cooremana01795d2020-07-24 22:48:15 +02001229
Gilles Peskine449bd832023-01-11 14:50:10 +01001230 status = psa_get_rsa_public_exponent(rsa,
1231 attributes);
1232 mbedtls_rsa_free(rsa);
1233 mbedtls_free(rsa);
Steven Cooremana01795d2020-07-24 22:48:15 +02001234 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001235 break;
Pengyu Lve9efbc22023-12-08 16:59:08 +08001236#else
1237 case PSA_KEY_TYPE_RSA_KEY_PAIR:
1238 case PSA_KEY_TYPE_RSA_PUBLIC_KEY:
1239 attributes->domain_parameters = NULL;
1240 attributes->domain_parameters_size = SIZE_MAX;
1241 break;
Valerio Settib2bcedb2023-07-10 11:24:00 +02001242#endif /* (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) && \
1243 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) ||
John Durkop9814fa22020-11-04 12:28:15 -08001244 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001245 default:
1246 /* Nothing else to do. */
1247 break;
1248 }
1249
Gilles Peskine449bd832023-01-11 14:50:10 +01001250 if (status != PSA_SUCCESS) {
1251 psa_reset_key_attributes(attributes);
1252 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001253
Ryan Everett1b70a072024-01-04 10:32:49 +00001254 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02001255
Gilles Peskine449bd832023-01-11 14:50:10 +01001256 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001257}
1258
Gilles Peskinec8000c02019-08-02 20:15:51 +02001259#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1260psa_status_t psa_get_key_slot_number(
1261 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01001262 psa_key_slot_number_t *slot_number)
Gilles Peskinec8000c02019-08-02 20:15:51 +02001263{
Gilles Peskine449bd832023-01-11 14:50:10 +01001264 if (attributes->core.flags & MBEDTLS_PSA_KA_FLAG_HAS_SLOT_NUMBER) {
Gilles Peskinec8000c02019-08-02 20:15:51 +02001265 *slot_number = attributes->slot_number;
Gilles Peskine449bd832023-01-11 14:50:10 +01001266 return PSA_SUCCESS;
1267 } else {
1268 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinec8000c02019-08-02 20:15:51 +02001269 }
Gilles Peskinec8000c02019-08-02 20:15:51 +02001270}
1271#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1272
Gilles Peskine449bd832023-01-11 14:50:10 +01001273static psa_status_t psa_export_key_buffer_internal(const uint8_t *key_buffer,
1274 size_t key_buffer_size,
1275 uint8_t *data,
1276 size_t data_size,
1277 size_t *data_length)
Steven Cooremana01795d2020-07-24 22:48:15 +02001278{
Gilles Peskine449bd832023-01-11 14:50:10 +01001279 if (key_buffer_size > data_size) {
1280 return PSA_ERROR_BUFFER_TOO_SMALL;
1281 }
1282 memcpy(data, key_buffer, key_buffer_size);
1283 memset(data + key_buffer_size, 0,
1284 data_size - key_buffer_size);
Ronald Crond18b5f82020-11-25 16:46:05 +01001285 *data_length = key_buffer_size;
Gilles Peskine449bd832023-01-11 14:50:10 +01001286 return PSA_SUCCESS;
Steven Cooremana01795d2020-07-24 22:48:15 +02001287}
1288
Ronald Cron7285cda2020-11-26 14:46:37 +01001289psa_status_t psa_export_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001290 const psa_key_attributes_t *attributes,
1291 const uint8_t *key_buffer, size_t key_buffer_size,
Gilles Peskine449bd832023-01-11 14:50:10 +01001292 uint8_t *data, size_t data_size, size_t *data_length)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001293{
Ronald Crond18b5f82020-11-25 16:46:05 +01001294 psa_key_type_t type = attributes->core.type;
1295
Gilles Peskine449bd832023-01-11 14:50:10 +01001296 if (key_type_is_raw_bytes(type) ||
1297 PSA_KEY_TYPE_IS_RSA(type) ||
Przemek Stekiel472b3f32022-12-01 14:38:49 +01001298 PSA_KEY_TYPE_IS_ECC(type) ||
1299 PSA_KEY_TYPE_IS_DH(type)) {
Gilles Peskine449bd832023-01-11 14:50:10 +01001300 return psa_export_key_buffer_internal(
1301 key_buffer, key_buffer_size,
1302 data, data_size, data_length);
1303 } else {
Ronald Cron9486f9d2020-11-26 13:36:23 +01001304 /* This shouldn't happen in the reference implementation, but
1305 it is valid for a special-purpose implementation to omit
1306 support for exporting certain key types. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001307 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron9486f9d2020-11-26 13:36:23 +01001308 }
1309}
1310
Gilles Peskine449bd832023-01-11 14:50:10 +01001311psa_status_t psa_export_key(mbedtls_svc_key_id_t key,
1312 uint8_t *data,
1313 size_t data_size,
1314 size_t *data_length)
Ronald Cron9486f9d2020-11-26 13:36:23 +01001315{
1316 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
1317 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
1318 psa_key_slot_t *slot;
1319
Ronald Crone907e552021-01-18 13:22:38 +01001320 /* Reject a zero-length output buffer now, since this can never be a
1321 * valid key representation. This way we know that data must be a valid
1322 * pointer and we can do things like memset(data, ..., data_size). */
Gilles Peskine449bd832023-01-11 14:50:10 +01001323 if (data_size == 0) {
1324 return PSA_ERROR_BUFFER_TOO_SMALL;
1325 }
Ronald Crone907e552021-01-18 13:22:38 +01001326
Ronald Cron9486f9d2020-11-26 13:36:23 +01001327 /* Set the key to empty now, so that even when there are errors, we always
1328 * set data_length to a value between 0 and data_size. On error, setting
1329 * the key to empty is a good choice because an empty key representation is
1330 * unlikely to be accepted anywhere. */
Jaeden Amerof24c7f82018-06-27 17:20:43 +01001331 *data_length = 0;
1332
Ronald Cron9486f9d2020-11-26 13:36:23 +01001333 /* Export requires the EXPORT flag. There is an exception for public keys,
1334 * which don't require any flag, but
1335 * psa_get_and_lock_key_slot_with_policy() takes care of this.
1336 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001337 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
1338 PSA_KEY_USAGE_EXPORT, 0);
1339 if (status != PSA_SUCCESS) {
1340 return status;
1341 }
mohammad160306e79202018-03-28 13:17:44 +03001342
Ronald Crond18b5f82020-11-25 16:46:05 +01001343 psa_key_attributes_t attributes = {
1344 .core = slot->attr
1345 };
Gilles Peskine449bd832023-01-11 14:50:10 +01001346 status = psa_driver_wrapper_export_key(&attributes,
1347 slot->key.data, slot->key.bytes,
1348 data, data_size, data_length);
Ronald Cron9486f9d2020-11-26 13:36:23 +01001349
Ryan Everett1b70a072024-01-04 10:32:49 +00001350 unlock_status = psa_unregister_read(slot);
Ronald Cron9486f9d2020-11-26 13:36:23 +01001351
Gilles Peskine449bd832023-01-11 14:50:10 +01001352 return (status == PSA_SUCCESS) ? unlock_status : status;
Ronald Cron9486f9d2020-11-26 13:36:23 +01001353}
1354
Ronald Cron7285cda2020-11-26 14:46:37 +01001355psa_status_t psa_export_public_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001356 const psa_key_attributes_t *attributes,
1357 const uint8_t *key_buffer,
1358 size_t key_buffer_size,
1359 uint8_t *data,
1360 size_t data_size,
Gilles Peskine449bd832023-01-11 14:50:10 +01001361 size_t *data_length)
Ronald Cron9486f9d2020-11-26 13:36:23 +01001362{
Ronald Crond18b5f82020-11-25 16:46:05 +01001363 psa_key_type_t type = attributes->core.type;
Ronald Crond18b5f82020-11-25 16:46:05 +01001364
Przemek Stekiel6fd72b62023-04-27 10:20:56 +02001365 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(type) &&
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001366 (PSA_KEY_TYPE_IS_RSA(type) || PSA_KEY_TYPE_IS_ECC(type) ||
1367 PSA_KEY_TYPE_IS_DH(type))) {
Przemek Stekiel6fd72b62023-04-27 10:20:56 +02001368 /* Exporting public -> public */
1369 return psa_export_key_buffer_internal(
1370 key_buffer, key_buffer_size,
1371 data, data_size, data_length);
1372 } else if (PSA_KEY_TYPE_IS_RSA(type)) {
Valerio Settib2bcedb2023-07-10 11:24:00 +02001373#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT) || \
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001374 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
1375 return mbedtls_psa_rsa_export_public_key(attributes,
1376 key_buffer,
1377 key_buffer_size,
1378 data,
1379 data_size,
1380 data_length);
Darryl Green9e2d7a02018-07-24 16:33:30 +01001381#else
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001382 /* We don't know how to convert a private RSA key to public. */
1383 return PSA_ERROR_NOT_SUPPORTED;
Valerio Settib2bcedb2023-07-10 11:24:00 +02001384#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT) ||
John Durkop9814fa22020-11-04 12:28:15 -08001385 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Przemek Stekiel6fd72b62023-04-27 10:20:56 +02001386 } else if (PSA_KEY_TYPE_IS_ECC(type)) {
Valerio Setti27c501a2023-06-27 16:58:52 +02001387#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_EXPORT) || \
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001388 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
1389 return mbedtls_psa_ecp_export_public_key(attributes,
1390 key_buffer,
1391 key_buffer_size,
1392 data,
1393 data_size,
1394 data_length);
Steven Cooreman560c28a2020-07-24 23:20:24 +02001395#else
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001396 /* We don't know how to convert a private ECC key to public */
1397 return PSA_ERROR_NOT_SUPPORTED;
Valerio Setti27c501a2023-06-27 16:58:52 +02001398#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_EXPORT) ||
John Durkop9814fa22020-11-04 12:28:15 -08001399 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
Przemek Stekiel6fd72b62023-04-27 10:20:56 +02001400 } else if (PSA_KEY_TYPE_IS_DH(type)) {
Valerio Settia55f0422023-07-10 15:34:41 +02001401#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_EXPORT) || \
Przemek Stekiel6d85afa2023-04-28 11:42:17 +02001402 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY)
Przemek Stekiel152bb462023-06-01 11:52:39 +02001403 return mbedtls_psa_ffdh_export_public_key(attributes,
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001404 key_buffer,
1405 key_buffer_size,
1406 data, data_size,
1407 data_length);
Przemek Stekiel472b3f32022-12-01 14:38:49 +01001408#else
Przemek Stekiel472b3f32022-12-01 14:38:49 +01001409 return PSA_ERROR_NOT_SUPPORTED;
Valerio Settia55f0422023-07-10 15:34:41 +02001410#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_EXPORT) ||
Przemek Stekiel6d85afa2023-04-28 11:42:17 +02001411 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY) */
Gilles Peskine449bd832023-01-11 14:50:10 +01001412 } else {
Przemek Stekiel0b11ee02023-05-16 13:26:06 +02001413 (void) key_buffer;
1414 (void) key_buffer_size;
1415 (void) data;
1416 (void) data_size;
1417 (void) data_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01001418 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman560c28a2020-07-24 23:20:24 +02001419 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001420}
Ronald Crond18b5f82020-11-25 16:46:05 +01001421
Gilles Peskine449bd832023-01-11 14:50:10 +01001422psa_status_t psa_export_public_key(mbedtls_svc_key_id_t key,
1423 uint8_t *data,
1424 size_t data_size,
1425 size_t *data_length)
Moran Pekerdd4ea382018-04-03 15:30:03 +03001426{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001427 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001428 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001429 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01001430 psa_key_attributes_t attributes;
Darryl Greendd8fb772018-11-07 16:00:44 +00001431
Ronald Crone907e552021-01-18 13:22:38 +01001432 /* Reject a zero-length output buffer now, since this can never be a
1433 * valid key representation. This way we know that data must be a valid
1434 * pointer and we can do things like memset(data, ..., data_size). */
Gilles Peskine449bd832023-01-11 14:50:10 +01001435 if (data_size == 0) {
1436 return PSA_ERROR_BUFFER_TOO_SMALL;
1437 }
Ronald Crone907e552021-01-18 13:22:38 +01001438
Darryl Greendd8fb772018-11-07 16:00:44 +00001439 /* Set the key to empty now, so that even when there are errors, we always
1440 * set data_length to a value between 0 and data_size. On error, setting
1441 * the key to empty is a good choice because an empty key representation is
1442 * unlikely to be accepted anywhere. */
1443 *data_length = 0;
1444
1445 /* Exporting a public key doesn't require a usage flag. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001446 status = psa_get_and_lock_key_slot_with_policy(key, &slot, 0, 0);
1447 if (status != PSA_SUCCESS) {
1448 return status;
1449 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001450
Gilles Peskine449bd832023-01-11 14:50:10 +01001451 if (!PSA_KEY_TYPE_IS_ASYMMETRIC(slot->attr.type)) {
1452 status = PSA_ERROR_INVALID_ARGUMENT;
1453 goto exit;
Ronald Cron9486f9d2020-11-26 13:36:23 +01001454 }
1455
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01001456 attributes = (psa_key_attributes_t) {
Ronald Crond18b5f82020-11-25 16:46:05 +01001457 .core = slot->attr
1458 };
Ronald Cron67227982020-11-26 15:16:05 +01001459 status = psa_driver_wrapper_export_public_key(
Ronald Crond18b5f82020-11-25 16:46:05 +01001460 &attributes, slot->key.data, slot->key.bytes,
Gilles Peskine449bd832023-01-11 14:50:10 +01001461 data, data_size, data_length);
Ronald Cron9486f9d2020-11-26 13:36:23 +01001462
1463exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00001464 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02001465
Gilles Peskine449bd832023-01-11 14:50:10 +01001466 return (status == PSA_SUCCESS) ? unlock_status : status;
Moran Pekerdd4ea382018-04-03 15:30:03 +03001467}
1468
Tom Cosgrove6ef9bb32023-03-08 14:19:51 +00001469MBEDTLS_STATIC_ASSERT(
1470 (MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE) == 0,
1471 "One or more key attribute flag is listed as both external-only and dual-use")
1472MBEDTLS_STATIC_ASSERT(
1473 (PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE) == 0,
1474 "One or more key attribute flag is listed as both internal-only and dual-use")
1475MBEDTLS_STATIC_ASSERT(
1476 (PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY) == 0,
1477 "One or more key attribute flag is listed as both internal-only and external-only")
Gilles Peskine91e8c332019-08-02 19:19:39 +02001478
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001479/** Validate that a key policy is internally well-formed.
1480 *
1481 * This function only rejects invalid policies. It does not validate the
1482 * consistency of the policy with respect to other attributes of the key
1483 * such as the key type.
1484 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001485static psa_status_t psa_validate_key_policy(const psa_key_policy_t *policy)
Gilles Peskine4747d192019-04-17 15:05:45 +02001486{
Gilles Peskine449bd832023-01-11 14:50:10 +01001487 if ((policy->usage & ~(PSA_KEY_USAGE_EXPORT |
1488 PSA_KEY_USAGE_COPY |
1489 PSA_KEY_USAGE_ENCRYPT |
1490 PSA_KEY_USAGE_DECRYPT |
1491 PSA_KEY_USAGE_SIGN_MESSAGE |
1492 PSA_KEY_USAGE_VERIFY_MESSAGE |
1493 PSA_KEY_USAGE_SIGN_HASH |
1494 PSA_KEY_USAGE_VERIFY_HASH |
1495 PSA_KEY_USAGE_VERIFY_DERIVATION |
1496 PSA_KEY_USAGE_DERIVE)) != 0) {
1497 return PSA_ERROR_INVALID_ARGUMENT;
1498 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001499
Gilles Peskine449bd832023-01-11 14:50:10 +01001500 return PSA_SUCCESS;
Gilles Peskine4747d192019-04-17 15:05:45 +02001501}
1502
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001503/** Validate the internal consistency of key attributes.
1504 *
1505 * This function only rejects invalid attribute values. If does not
1506 * validate the consistency of the attributes with any key data that may
1507 * be involved in the creation of the key.
1508 *
1509 * Call this function early in the key creation process.
1510 *
1511 * \param[in] attributes Key attributes for the new key.
1512 * \param[out] p_drv On any return, the driver for the key, if any.
1513 * NULL for a transparent key.
1514 *
1515 */
1516static psa_status_t psa_validate_key_attributes(
1517 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01001518 psa_se_drv_table_entry_t **p_drv)
Darryl Green0c6575a2018-11-07 16:05:30 +00001519{
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001520 psa_status_t status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine449bd832023-01-11 14:50:10 +01001521 psa_key_lifetime_t lifetime = psa_get_key_lifetime(attributes);
1522 mbedtls_svc_key_id_t key = psa_get_key_id(attributes);
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001523
Gilles Peskine449bd832023-01-11 14:50:10 +01001524 status = psa_validate_key_location(lifetime, p_drv);
1525 if (status != PSA_SUCCESS) {
1526 return status;
Ronald Crond2ed4812020-07-17 16:11:30 +02001527 }
1528
Gilles Peskine449bd832023-01-11 14:50:10 +01001529 status = psa_validate_key_persistence(lifetime);
1530 if (status != PSA_SUCCESS) {
1531 return status;
1532 }
1533
1534 if (PSA_KEY_LIFETIME_IS_VOLATILE(lifetime)) {
1535 if (MBEDTLS_SVC_KEY_ID_GET_KEY_ID(key) != 0) {
1536 return PSA_ERROR_INVALID_ARGUMENT;
1537 }
1538 } else {
1539 if (!psa_is_valid_key_id(psa_get_key_id(attributes), 0)) {
1540 return PSA_ERROR_INVALID_ARGUMENT;
1541 }
1542 }
1543
1544 status = psa_validate_key_policy(&attributes->core.policy);
1545 if (status != PSA_SUCCESS) {
1546 return status;
1547 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001548
1549 /* Refuse to create overly large keys.
1550 * Note that this doesn't trigger on import if the attributes don't
1551 * explicitly specify a size (so psa_get_key_bits returns 0), so
1552 * psa_import_key() needs its own checks. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001553 if (psa_get_key_bits(attributes) > PSA_MAX_KEY_BITS) {
1554 return PSA_ERROR_NOT_SUPPORTED;
1555 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001556
Gilles Peskine91e8c332019-08-02 19:19:39 +02001557 /* Reject invalid flags. These should not be reachable through the API. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001558 if (attributes->core.flags & ~(MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1559 MBEDTLS_PSA_KA_MASK_DUAL_USE)) {
1560 return PSA_ERROR_INVALID_ARGUMENT;
1561 }
Gilles Peskine91e8c332019-08-02 19:19:39 +02001562
Gilles Peskine449bd832023-01-11 14:50:10 +01001563 return PSA_SUCCESS;
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001564}
1565
Gilles Peskine4747d192019-04-17 15:05:45 +02001566/** Prepare a key slot to receive key material.
1567 *
1568 * This function allocates a key slot and sets its metadata.
1569 *
1570 * If this function fails, call psa_fail_key_creation().
1571 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001572 * This function is intended to be used as follows:
1573 * -# Call psa_start_key_creation() to allocate a key slot, prepare
Ronald Croncf56a0a2020-08-04 09:51:30 +02001574 * it with the specified attributes, and in case of a volatile key assign it
1575 * a volatile key identifier.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001576 * -# Populate the slot with the key material.
1577 * -# Call psa_finish_key_creation() to finalize the creation of the slot.
1578 * In case of failure at any step, stop the sequence and call
1579 * psa_fail_key_creation().
1580 *
Ryan Everettb69118e2024-01-02 15:54:32 +00001581 * On success, the key slot's state is PSA_SLOT_FILLING.
1582 * It is the responsibility of the caller to change the slot's state to
1583 * PSA_SLOT_EMPTY/FULL once key creation has finished.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001584 *
Gilles Peskinedf179142019-07-15 22:02:14 +02001585 * \param method An identification of the calling function.
Gilles Peskine011e4282019-06-26 18:34:38 +02001586 * \param[in] attributes Key attributes for the new key.
Gilles Peskine011e4282019-06-26 18:34:38 +02001587 * \param[out] p_slot On success, a pointer to the prepared slot.
1588 * \param[out] p_drv On any return, the driver for the key, if any.
1589 * NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001590 *
1591 * \retval #PSA_SUCCESS
1592 * The key slot is ready to receive key material.
1593 * \return If this function fails, the key slot is an invalid state.
1594 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001595 */
1596static psa_status_t psa_start_key_creation(
Gilles Peskinedf179142019-07-15 22:02:14 +02001597 psa_key_creation_method_t method,
Gilles Peskine4747d192019-04-17 15:05:45 +02001598 const psa_key_attributes_t *attributes,
Gilles Peskine011e4282019-06-26 18:34:38 +02001599 psa_key_slot_t **p_slot,
Gilles Peskine449bd832023-01-11 14:50:10 +01001600 psa_se_drv_table_entry_t **p_drv)
Gilles Peskine4747d192019-04-17 15:05:45 +02001601{
1602 psa_status_t status;
Ronald Cron2a993152020-07-17 14:13:26 +02001603 psa_key_id_t volatile_key_id;
Gilles Peskine4747d192019-04-17 15:05:45 +02001604 psa_key_slot_t *slot;
1605
Gilles Peskinedf179142019-07-15 22:02:14 +02001606 (void) method;
Gilles Peskine011e4282019-06-26 18:34:38 +02001607 *p_drv = NULL;
1608
Gilles Peskine449bd832023-01-11 14:50:10 +01001609 status = psa_validate_key_attributes(attributes, p_drv);
1610 if (status != PSA_SUCCESS) {
1611 return status;
1612 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001613
Ryan Everettb69118e2024-01-02 15:54:32 +00001614 status = psa_reserve_free_key_slot(&volatile_key_id, p_slot);
Gilles Peskine449bd832023-01-11 14:50:10 +01001615 if (status != PSA_SUCCESS) {
1616 return status;
1617 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001618 slot = *p_slot;
1619
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001620 /* We're storing the declared bit-size of the key. It's up to each
1621 * creation mechanism to verify that this information is correct.
1622 * It's automatically correct for mechanisms that use the bit-size as
Gilles Peskineb46bef22019-07-30 21:32:04 +02001623 * an input (generate, device) but not for those where the bit-size
Ronald Cronc4d1b512020-07-31 11:26:37 +02001624 * is optional (import, copy). In case of a volatile key, assign it the
1625 * volatile key identifier associated to the slot returned to contain its
1626 * definition. */
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001627
1628 slot->attr = attributes->core;
Gilles Peskine449bd832023-01-11 14:50:10 +01001629 if (PSA_KEY_LIFETIME_IS_VOLATILE(slot->attr.lifetime)) {
Ronald Cronc4d1b512020-07-31 11:26:37 +02001630#if !defined(MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER)
1631 slot->attr.id = volatile_key_id;
1632#else
1633 slot->attr.id.key_id = volatile_key_id;
1634#endif
1635 }
Gilles Peskinec744d992019-07-30 17:26:54 +02001636
Gilles Peskine91e8c332019-08-02 19:19:39 +02001637 /* Erase external-only flags from the internal copy. To access
Gilles Peskine013f5472019-08-07 15:42:14 +02001638 * external-only flags, query `attributes`. Thanks to the check
1639 * in psa_validate_key_attributes(), this leaves the dual-use
Ryan Everettb69118e2024-01-02 15:54:32 +00001640 * flags and any internal flag that psa_reserve_free_key_slot()
Gilles Peskine013f5472019-08-07 15:42:14 +02001641 * may have set. */
1642 slot->attr.flags &= ~MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY;
Gilles Peskine91e8c332019-08-02 19:19:39 +02001643
Gilles Peskinecbaff462019-07-12 23:46:04 +02001644#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001645 /* For a key in a secure element, we need to do three things
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001646 * when creating or registering a persistent key:
Gilles Peskine60450a42019-07-25 11:32:45 +02001647 * create the key file in internal storage, create the
1648 * key inside the secure element, and update the driver's
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001649 * persistent data. This is done by starting a transaction that will
1650 * encompass these three actions.
1651 * For registering a volatile key, we just need to find an appropriate
1652 * slot number inside the SE. Since the key is designated volatile, creating
1653 * a transaction is not required. */
Gilles Peskine60450a42019-07-25 11:32:45 +02001654 /* The first thing to do is to find a slot number for the new key.
1655 * We save the slot number in persistent storage as part of the
1656 * transaction data. It will be needed to recover if the power
1657 * fails during the key creation process, to clean up on the secure
1658 * element side after restarting. Obtaining a slot number from the
1659 * secure element driver updates its persistent state, but we do not yet
1660 * save the driver's persistent state, so that if the power fails,
Gilles Peskinefc762652019-07-22 19:30:34 +02001661 * we can roll back to a state where the key doesn't exist. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001662 if (*p_drv != NULL) {
Ronald Cronea0f8a62020-11-25 17:52:23 +01001663 psa_key_slot_number_t slot_number;
Gilles Peskine449bd832023-01-11 14:50:10 +01001664 status = psa_find_se_slot_for_key(attributes, method, *p_drv,
1665 &slot_number);
1666 if (status != PSA_SUCCESS) {
1667 return status;
1668 }
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001669
Gilles Peskine449bd832023-01-11 14:50:10 +01001670 if (!PSA_KEY_LIFETIME_IS_VOLATILE(attributes->core.lifetime)) {
1671 psa_crypto_prepare_transaction(PSA_CRYPTO_TRANSACTION_CREATE_KEY);
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001672 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001673 psa_crypto_transaction.key.slot = slot_number;
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001674 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskine449bd832023-01-11 14:50:10 +01001675 status = psa_crypto_save_transaction();
1676 if (status != PSA_SUCCESS) {
1677 (void) psa_crypto_stop_transaction();
1678 return status;
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001679 }
Gilles Peskine66be51c2019-07-25 18:02:52 +02001680 }
Ronald Cronea0f8a62020-11-25 17:52:23 +01001681
1682 status = psa_copy_key_material_into_slot(
Gilles Peskine449bd832023-01-11 14:50:10 +01001683 slot, (uint8_t *) (&slot_number), sizeof(slot_number));
Darryl Green0c6575a2018-11-07 16:05:30 +00001684 }
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001685
Gilles Peskine449bd832023-01-11 14:50:10 +01001686 if (*p_drv == NULL && method == PSA_KEY_CREATION_REGISTER) {
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001687 /* Key registration only makes sense with a secure element. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001688 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001689 }
Gilles Peskinecbaff462019-07-12 23:46:04 +02001690#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1691
Gilles Peskine449bd832023-01-11 14:50:10 +01001692 return PSA_SUCCESS;
Darryl Green0c6575a2018-11-07 16:05:30 +00001693}
Gilles Peskine4747d192019-04-17 15:05:45 +02001694
1695/** Finalize the creation of a key once its key material has been set.
1696 *
1697 * This entails writing the key to persistent storage.
1698 *
1699 * If this function fails, call psa_fail_key_creation().
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001700 * See the documentation of psa_start_key_creation() for the intended use
1701 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001702 *
Ryan Everettb69118e2024-01-02 15:54:32 +00001703 * If the finalization succeeds, the function sets the key slot's state to
1704 * PSA_SLOT_FULL, and the key slot can no longer be accessed as part of the
1705 * key creation process.
Ronald Cron50972942020-11-14 11:28:25 +01001706 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001707 * \param[in,out] slot Pointer to the slot with key material.
1708 * \param[in] driver The secure element driver for the key,
1709 * or NULL for a transparent key.
Ronald Cron81709fc2020-11-14 12:10:32 +01001710 * \param[out] key On success, identifier of the key. Note that the
1711 * key identifier is also stored in the key slot.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001712 *
1713 * \retval #PSA_SUCCESS
Ronald Croncf56a0a2020-08-04 09:51:30 +02001714 * The key was successfully created.
Gilles Peskineed733552023-02-14 19:21:09 +01001715 * \retval #PSA_ERROR_INSUFFICIENT_MEMORY \emptydescription
1716 * \retval #PSA_ERROR_INSUFFICIENT_STORAGE \emptydescription
1717 * \retval #PSA_ERROR_ALREADY_EXISTS \emptydescription
1718 * \retval #PSA_ERROR_DATA_INVALID \emptydescription
1719 * \retval #PSA_ERROR_DATA_CORRUPT \emptydescription
1720 * \retval #PSA_ERROR_STORAGE_FAILURE \emptydescription
gabor-mezei-arm452b0a32020-11-09 17:42:55 +01001721 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001722 * \return If this function fails, the key slot is an invalid state.
1723 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001724 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001725static psa_status_t psa_finish_key_creation(
1726 psa_key_slot_t *slot,
Ronald Cron81709fc2020-11-14 12:10:32 +01001727 psa_se_drv_table_entry_t *driver,
1728 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02001729{
1730 psa_status_t status = PSA_SUCCESS;
Gilles Peskine30afafd2019-04-25 13:47:40 +02001731 (void) slot;
Gilles Peskine011e4282019-06-26 18:34:38 +02001732 (void) driver;
Gilles Peskine4747d192019-04-17 15:05:45 +02001733
1734#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001735 if (!PSA_KEY_LIFETIME_IS_VOLATILE(slot->attr.lifetime)) {
Gilles Peskine1df83d42019-07-23 16:13:14 +02001736#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001737 if (driver != NULL) {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001738 psa_se_key_data_storage_t data;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001739 psa_key_slot_number_t slot_number =
Gilles Peskine449bd832023-01-11 14:50:10 +01001740 psa_key_slot_get_slot_number(slot);
Ronald Cronea0f8a62020-11-25 17:52:23 +01001741
Tom Cosgrove6ef9bb32023-03-08 14:19:51 +00001742 MBEDTLS_STATIC_ASSERT(sizeof(slot_number) ==
1743 sizeof(data.slot_number),
1744 "Slot number size does not match psa_se_key_data_storage_t");
1745
Gilles Peskine449bd832023-01-11 14:50:10 +01001746 memcpy(&data.slot_number, &slot_number, sizeof(slot_number));
1747 status = psa_save_persistent_key(&slot->attr,
1748 (uint8_t *) &data,
1749 sizeof(data));
1750 } else
Gilles Peskine1df83d42019-07-23 16:13:14 +02001751#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1752 {
Steven Cooreman40120f62020-10-29 11:42:22 +01001753 /* Key material is saved in export representation in the slot, so
1754 * just pass the slot buffer for storage. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001755 status = psa_save_persistent_key(&slot->attr,
1756 slot->key.data,
1757 slot->key.bytes);
Gilles Peskine1df83d42019-07-23 16:13:14 +02001758 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001759 }
Darryl Green0c6575a2018-11-07 16:05:30 +00001760#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
1761
Gilles Peskinecbaff462019-07-12 23:46:04 +02001762#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001763 /* Finish the transaction for a key creation. This does not
1764 * happen when registering an existing key. Detect this case
1765 * by checking whether a transaction is in progress (actual
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001766 * creation of a persistent key in a secure element requires a transaction,
1767 * but registration or volatile key creation doesn't use one). */
Gilles Peskine449bd832023-01-11 14:50:10 +01001768 if (driver != NULL &&
1769 psa_crypto_transaction.unknown.type == PSA_CRYPTO_TRANSACTION_CREATE_KEY) {
1770 status = psa_save_se_persistent_data(driver);
1771 if (status != PSA_SUCCESS) {
1772 psa_destroy_persistent_key(slot->attr.id);
1773 return status;
Gilles Peskinecbaff462019-07-12 23:46:04 +02001774 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001775 status = psa_crypto_stop_transaction();
Gilles Peskinecbaff462019-07-12 23:46:04 +02001776 }
1777#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1778
Gilles Peskine449bd832023-01-11 14:50:10 +01001779 if (status == PSA_SUCCESS) {
Ronald Cron81709fc2020-11-14 12:10:32 +01001780 *key = slot->attr.id;
Ryan Everettb69118e2024-01-02 15:54:32 +00001781 status = psa_key_slot_state_transition(slot, PSA_SLOT_FILLING,
1782 PSA_SLOT_FULL);
Gilles Peskine449bd832023-01-11 14:50:10 +01001783 if (status != PSA_SUCCESS) {
Ronald Cron81709fc2020-11-14 12:10:32 +01001784 *key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01001785 }
Ronald Cron81709fc2020-11-14 12:10:32 +01001786 }
Ronald Cron50972942020-11-14 11:28:25 +01001787
Gilles Peskine449bd832023-01-11 14:50:10 +01001788 return status;
Gilles Peskine4747d192019-04-17 15:05:45 +02001789}
1790
1791/** Abort the creation of a key.
1792 *
1793 * You may call this function after calling psa_start_key_creation(),
1794 * or after psa_finish_key_creation() fails. In other circumstances, this
1795 * function may not clean up persistent storage.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001796 * See the documentation of psa_start_key_creation() for the intended use
Ryan Everettb69118e2024-01-02 15:54:32 +00001797 * of this function. Sets the slot's state to PSA_SLOT_EMPTY.
Gilles Peskine4747d192019-04-17 15:05:45 +02001798 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001799 * \param[in,out] slot Pointer to the slot with key material.
1800 * \param[in] driver The secure element driver for the key,
1801 * or NULL for a transparent key.
Gilles Peskine4747d192019-04-17 15:05:45 +02001802 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001803static void psa_fail_key_creation(psa_key_slot_t *slot,
1804 psa_se_drv_table_entry_t *driver)
Gilles Peskine4747d192019-04-17 15:05:45 +02001805{
Gilles Peskine011e4282019-06-26 18:34:38 +02001806 (void) driver;
1807
Gilles Peskine449bd832023-01-11 14:50:10 +01001808 if (slot == NULL) {
Gilles Peskine4747d192019-04-17 15:05:45 +02001809 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01001810 }
Gilles Peskine011e4282019-06-26 18:34:38 +02001811
1812#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001813 /* TODO: If the key has already been created in the secure
Gilles Peskine011e4282019-06-26 18:34:38 +02001814 * element, and the failure happened later (when saving metadata
1815 * to internal storage), we need to destroy the key in the secure
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001816 * element.
1817 * https://github.com/ARMmbed/mbed-crypto/issues/217
1818 */
Gilles Peskinefc762652019-07-22 19:30:34 +02001819
Gilles Peskined7729582019-08-05 15:55:54 +02001820 /* Abort the ongoing transaction if any (there may not be one if
1821 * the creation process failed before starting one, or if the
1822 * key creation is a registration of a key in a secure element).
1823 * Earlier functions must already have done what it takes to undo any
1824 * partial creation. All that's left is to update the transaction data
1825 * itself. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001826 (void) psa_crypto_stop_transaction();
Gilles Peskine011e4282019-06-26 18:34:38 +02001827#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine449bd832023-01-11 14:50:10 +01001828 psa_wipe_key_slot(slot);
Gilles Peskine4747d192019-04-17 15:05:45 +02001829}
1830
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001831/** Validate optional attributes during key creation.
1832 *
1833 * Some key attributes are optional during key creation. If they are
1834 * specified in the attributes structure, check that they are consistent
1835 * with the data in the slot.
1836 *
1837 * This function should be called near the end of key creation, after
1838 * the slot in memory is fully populated but before saving persistent data.
1839 */
1840static psa_status_t psa_validate_optional_attributes(
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001841 const psa_key_slot_t *slot,
Gilles Peskine449bd832023-01-11 14:50:10 +01001842 const psa_key_attributes_t *attributes)
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001843{
Gilles Peskine449bd832023-01-11 14:50:10 +01001844 if (attributes->core.type != 0) {
1845 if (attributes->core.type != slot->attr.type) {
1846 return PSA_ERROR_INVALID_ARGUMENT;
1847 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001848 }
1849
Gilles Peskine449bd832023-01-11 14:50:10 +01001850 if (attributes->domain_parameters_size != 0) {
Valerio Settib2bcedb2023-07-10 11:24:00 +02001851#if (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) && \
1852 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01001853 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
1854 if (PSA_KEY_TYPE_IS_RSA(slot->attr.type)) {
Steven Cooremana2371e52020-07-28 14:30:39 +02001855 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman75b74362020-07-28 14:30:13 +02001856 mbedtls_mpi actual, required;
Steven Cooreman6d839f02020-07-30 11:36:45 +02001857 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooremana01795d2020-07-24 22:48:15 +02001858
Ronald Cron90857082020-11-25 14:58:33 +01001859 psa_status_t status = mbedtls_psa_rsa_load_representation(
Gilles Peskine449bd832023-01-11 14:50:10 +01001860 slot->attr.type,
1861 slot->key.data,
1862 slot->key.bytes,
1863 &rsa);
1864 if (status != PSA_SUCCESS) {
1865 return status;
1866 }
Steven Cooreman75b74362020-07-28 14:30:13 +02001867
Gilles Peskine449bd832023-01-11 14:50:10 +01001868 mbedtls_mpi_init(&actual);
1869 mbedtls_mpi_init(&required);
1870 ret = mbedtls_rsa_export(rsa,
1871 NULL, NULL, NULL, NULL, &actual);
1872 mbedtls_rsa_free(rsa);
1873 mbedtls_free(rsa);
1874 if (ret != 0) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001875 goto rsa_exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001876 }
1877 ret = mbedtls_mpi_read_binary(&required,
1878 attributes->domain_parameters,
1879 attributes->domain_parameters_size);
1880 if (ret != 0) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001881 goto rsa_exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001882 }
1883 if (mbedtls_mpi_cmp_mpi(&actual, &required) != 0) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001884 ret = MBEDTLS_ERR_RSA_BAD_INPUT_DATA;
Gilles Peskine449bd832023-01-11 14:50:10 +01001885 }
1886rsa_exit:
1887 mbedtls_mpi_free(&actual);
1888 mbedtls_mpi_free(&required);
1889 if (ret != 0) {
1890 return mbedtls_to_psa_error(ret);
1891 }
1892 } else
Valerio Settib2bcedb2023-07-10 11:24:00 +02001893#endif /* (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) &&
1894 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) ||
John Durkop9814fa22020-11-04 12:28:15 -08001895 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001896 {
Gilles Peskine449bd832023-01-11 14:50:10 +01001897 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001898 }
1899 }
1900
Gilles Peskine449bd832023-01-11 14:50:10 +01001901 if (attributes->core.bits != 0) {
1902 if (attributes->core.bits != slot->attr.bits) {
1903 return PSA_ERROR_INVALID_ARGUMENT;
1904 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001905 }
1906
Gilles Peskine449bd832023-01-11 14:50:10 +01001907 return PSA_SUCCESS;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001908}
1909
Gilles Peskine449bd832023-01-11 14:50:10 +01001910psa_status_t psa_import_key(const psa_key_attributes_t *attributes,
1911 const uint8_t *data,
1912 size_t data_length,
1913 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02001914{
1915 psa_status_t status;
1916 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001917 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001918 size_t bits;
Archanad8a83dc2021-06-14 10:04:16 +05301919 size_t storage_size = data_length;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001920
Ronald Cron81709fc2020-11-14 12:10:32 +01001921 *key = MBEDTLS_SVC_KEY_ID_INIT;
1922
Gilles Peskine0f84d622019-09-12 19:03:13 +02001923 /* Reject zero-length symmetric keys (including raw data key objects).
1924 * This also rejects any key which might be encoded as an empty string,
1925 * which is never valid. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001926 if (data_length == 0) {
1927 return PSA_ERROR_INVALID_ARGUMENT;
1928 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02001929
Archana449608b2021-09-08 15:36:05 +05301930 /* Ensure that the bytes-to-bits conversion cannot overflow. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001931 if (data_length > SIZE_MAX / 8) {
1932 return PSA_ERROR_NOT_SUPPORTED;
1933 }
Archana6ed4bda2021-08-04 10:47:15 +05301934
Gilles Peskine449bd832023-01-11 14:50:10 +01001935 status = psa_start_key_creation(PSA_KEY_CREATION_IMPORT, attributes,
1936 &slot, &driver);
1937 if (status != PSA_SUCCESS) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001938 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001939 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001940
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001941 /* In the case of a transparent key or an opaque key stored in local
Archana449608b2021-09-08 15:36:05 +05301942 * storage ( thus not in the case of importing a key in a secure element
1943 * with storage ( MBEDTLS_PSA_CRYPTO_SE_C ) ),we have to allocate a
1944 * buffer to hold the imported key material. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001945 if (slot->key.data == NULL) {
1946 if (psa_key_lifetime_is_external(attributes->core.lifetime)) {
Archana449608b2021-09-08 15:36:05 +05301947 status = psa_driver_wrapper_get_key_buffer_size_from_key_data(
Gilles Peskine449bd832023-01-11 14:50:10 +01001948 attributes, data, data_length, &storage_size);
1949 if (status != PSA_SUCCESS) {
Archanad8a83dc2021-06-14 10:04:16 +05301950 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001951 }
Archanad8a83dc2021-06-14 10:04:16 +05301952 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001953 status = psa_allocate_buffer_to_slot(slot, storage_size);
1954 if (status != PSA_SUCCESS) {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001955 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001956 }
Gilles Peskine5d309672019-07-12 23:47:28 +02001957 }
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001958
1959 bits = slot->attr.bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01001960 status = psa_driver_wrapper_import_key(attributes,
1961 data, data_length,
1962 slot->key.data,
1963 slot->key.bytes,
1964 &slot->key.bytes, &bits);
1965 if (status != PSA_SUCCESS) {
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001966 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001967 }
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001968
Gilles Peskine449bd832023-01-11 14:50:10 +01001969 if (slot->attr.bits == 0) {
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001970 slot->attr.bits = (psa_key_bits_t) bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01001971 } else if (bits != slot->attr.bits) {
Steven Cooremanac3434f2021-01-15 17:36:02 +01001972 status = PSA_ERROR_INVALID_ARGUMENT;
1973 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02001974 }
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01001975
Archana6ed4bda2021-08-04 10:47:15 +05301976 /* Enforce a size limit, and in particular ensure that the bit
1977 * size fits in its representation type.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01001978 if (bits > PSA_MAX_KEY_BITS) {
Archana6ed4bda2021-08-04 10:47:15 +05301979 status = PSA_ERROR_NOT_SUPPORTED;
1980 goto exit;
1981 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001982 status = psa_validate_optional_attributes(slot, attributes);
1983 if (status != PSA_SUCCESS) {
Gilles Peskine18017402019-07-24 20:25:59 +02001984 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001985 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001986
Gilles Peskine449bd832023-01-11 14:50:10 +01001987 status = psa_finish_key_creation(slot, driver, key);
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001988exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01001989 if (status != PSA_SUCCESS) {
1990 psa_fail_key_creation(slot, driver);
1991 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001992
Gilles Peskine449bd832023-01-11 14:50:10 +01001993 return status;
Gilles Peskine4747d192019-04-17 15:05:45 +02001994}
1995
Gilles Peskined7729582019-08-05 15:55:54 +02001996#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1997psa_status_t mbedtls_psa_register_se_key(
Gilles Peskine449bd832023-01-11 14:50:10 +01001998 const psa_key_attributes_t *attributes)
Gilles Peskined7729582019-08-05 15:55:54 +02001999{
2000 psa_status_t status;
2001 psa_key_slot_t *slot = NULL;
2002 psa_se_drv_table_entry_t *driver = NULL;
Ronald Croncf56a0a2020-08-04 09:51:30 +02002003 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskined7729582019-08-05 15:55:54 +02002004
2005 /* Leaving attributes unspecified is not currently supported.
2006 * It could make sense to query the key type and size from the
2007 * secure element, but not all secure elements support this
2008 * and the driver HAL doesn't currently support it. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002009 if (psa_get_key_type(attributes) == PSA_KEY_TYPE_NONE) {
2010 return PSA_ERROR_NOT_SUPPORTED;
2011 }
2012 if (psa_get_key_bits(attributes) == 0) {
2013 return PSA_ERROR_NOT_SUPPORTED;
2014 }
Gilles Peskined7729582019-08-05 15:55:54 +02002015
Gilles Peskine449bd832023-01-11 14:50:10 +01002016 status = psa_start_key_creation(PSA_KEY_CREATION_REGISTER, attributes,
2017 &slot, &driver);
2018 if (status != PSA_SUCCESS) {
Gilles Peskined7729582019-08-05 15:55:54 +02002019 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002020 }
Gilles Peskined7729582019-08-05 15:55:54 +02002021
Gilles Peskine449bd832023-01-11 14:50:10 +01002022 status = psa_finish_key_creation(slot, driver, &key);
Gilles Peskined7729582019-08-05 15:55:54 +02002023
2024exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002025 if (status != PSA_SUCCESS) {
2026 psa_fail_key_creation(slot, driver);
2027 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002028
Gilles Peskined7729582019-08-05 15:55:54 +02002029 /* Registration doesn't keep the key in RAM. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002030 psa_close_key(key);
2031 return status;
Gilles Peskined7729582019-08-05 15:55:54 +02002032}
2033#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2034
Gilles Peskine449bd832023-01-11 14:50:10 +01002035psa_status_t psa_copy_key(mbedtls_svc_key_id_t source_key,
2036 const psa_key_attributes_t *specified_attributes,
2037 mbedtls_svc_key_id_t *target_key)
Gilles Peskinef603c712019-01-19 13:40:11 +01002038{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002039 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01002040 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinef603c712019-01-19 13:40:11 +01002041 psa_key_slot_t *source_slot = NULL;
2042 psa_key_slot_t *target_slot = NULL;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002043 psa_key_attributes_t actual_attributes = *specified_attributes;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002044 psa_se_drv_table_entry_t *driver = NULL;
Archana8a180362021-07-05 02:18:48 +05302045 size_t storage_size = 0;
Gilles Peskinef603c712019-01-19 13:40:11 +01002046
Ronald Cron81709fc2020-11-14 12:10:32 +01002047 *target_key = MBEDTLS_SVC_KEY_ID_INIT;
2048
Archana8a180362021-07-05 02:18:48 +05302049 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002050 source_key, &source_slot, PSA_KEY_USAGE_COPY, 0);
2051 if (status != PSA_SUCCESS) {
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002052 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002053 }
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002054
Gilles Peskine449bd832023-01-11 14:50:10 +01002055 status = psa_validate_optional_attributes(source_slot,
2056 specified_attributes);
2057 if (status != PSA_SUCCESS) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002058 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002059 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002060
Archana9d17bf42021-09-10 06:22:44 +05302061 /* The target key type and number of bits have been validated by
2062 * psa_validate_optional_attributes() to be either equal to zero or
2063 * equal to the ones of the source key. So it is safe to inherit
2064 * them from the source key now."
Archana374fe5b2021-09-08 15:50:28 +05302065 * */
Archana9d17bf42021-09-10 06:22:44 +05302066 actual_attributes.core.bits = source_slot->attr.bits;
2067 actual_attributes.core.type = source_slot->attr.type;
Archana374fe5b2021-09-08 15:50:28 +05302068
2069
Gilles Peskine449bd832023-01-11 14:50:10 +01002070 status = psa_restrict_key_policy(source_slot->attr.type,
2071 &actual_attributes.core.policy,
2072 &source_slot->attr.policy);
2073 if (status != PSA_SUCCESS) {
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002074 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002075 }
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002076
Gilles Peskine449bd832023-01-11 14:50:10 +01002077 status = psa_start_key_creation(PSA_KEY_CREATION_COPY, &actual_attributes,
2078 &target_slot, &driver);
2079 if (status != PSA_SUCCESS) {
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002080 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002081 }
2082 if (PSA_KEY_LIFETIME_GET_LOCATION(target_slot->attr.lifetime) !=
2083 PSA_KEY_LIFETIME_GET_LOCATION(source_slot->attr.lifetime)) {
Archana8a180362021-07-05 02:18:48 +05302084 /*
Archana9d17bf42021-09-10 06:22:44 +05302085 * If the source and target keys are stored in different locations,
Archana8a180362021-07-05 02:18:48 +05302086 * the source key would need to be exported as plaintext and re-imported
2087 * in the other location. This has security implications which have not
Archana449608b2021-09-08 15:36:05 +05302088 * been fully mapped. For now, this can be achieved through
Archana8a180362021-07-05 02:18:48 +05302089 * appropriate API invocations from the application, if needed.
2090 * */
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002091 status = PSA_ERROR_NOT_SUPPORTED;
2092 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002093 }
Archana8a180362021-07-05 02:18:48 +05302094 /*
2095 * When the source and target keys are within the same location,
Archana449608b2021-09-08 15:36:05 +05302096 * - For transparent keys it is a blind copy without any driver invocation,
Archana8a180362021-07-05 02:18:48 +05302097 * - For opaque keys this translates to an invocation of the drivers'
2098 * copy_key entry point through the dispatch layer.
2099 * */
Gilles Peskine449bd832023-01-11 14:50:10 +01002100 if (psa_key_lifetime_is_external(actual_attributes.core.lifetime)) {
2101 status = psa_driver_wrapper_get_key_buffer_size(&actual_attributes,
2102 &storage_size);
2103 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302104 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002105 }
Archana374fe5b2021-09-08 15:50:28 +05302106
Gilles Peskine449bd832023-01-11 14:50:10 +01002107 status = psa_allocate_buffer_to_slot(target_slot, storage_size);
2108 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302109 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002110 }
Archana374fe5b2021-09-08 15:50:28 +05302111
Gilles Peskine449bd832023-01-11 14:50:10 +01002112 status = psa_driver_wrapper_copy_key(&actual_attributes,
2113 source_slot->key.data,
2114 source_slot->key.bytes,
2115 target_slot->key.data,
2116 target_slot->key.bytes,
2117 &target_slot->key.bytes);
2118 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302119 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002120 }
2121 } else {
2122 status = psa_copy_key_material_into_slot(target_slot,
Archana9d17bf42021-09-10 06:22:44 +05302123 source_slot->key.data,
Gilles Peskine449bd832023-01-11 14:50:10 +01002124 source_slot->key.bytes);
2125 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302126 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002127 }
Archana8a180362021-07-05 02:18:48 +05302128 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002129 status = psa_finish_key_creation(target_slot, driver, target_key);
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002130exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002131 if (status != PSA_SUCCESS) {
2132 psa_fail_key_creation(target_slot, driver);
2133 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002134
Ryan Everett1b70a072024-01-04 10:32:49 +00002135 unlock_status = psa_unregister_read(source_slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02002136
Gilles Peskine449bd832023-01-11 14:50:10 +01002137 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskinef603c712019-01-19 13:40:11 +01002138}
2139
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02002140
2141
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01002142/****************************************************************/
Gilles Peskine20035e32018-02-03 22:44:14 +01002143/* Message digests */
2144/****************************************************************/
2145
Gilles Peskine449bd832023-01-11 14:50:10 +01002146psa_status_t psa_hash_abort(psa_hash_operation_t *operation)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002147{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002148 /* Aborting a non-active operation is allowed */
Gilles Peskine449bd832023-01-11 14:50:10 +01002149 if (operation->id == 0) {
2150 return PSA_SUCCESS;
2151 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002152
Gilles Peskine449bd832023-01-11 14:50:10 +01002153 psa_status_t status = psa_driver_wrapper_hash_abort(operation);
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002154 operation->id = 0;
2155
Gilles Peskine449bd832023-01-11 14:50:10 +01002156 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002157}
2158
Gilles Peskine449bd832023-01-11 14:50:10 +01002159psa_status_t psa_hash_setup(psa_hash_operation_t *operation,
2160 psa_algorithm_t alg)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002161{
Dave Rodgman685b6a72021-06-24 11:49:14 +01002162 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002163
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002164 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002165 if (operation->id != 0) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002166 status = PSA_ERROR_BAD_STATE;
2167 goto exit;
2168 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002169
Gilles Peskine449bd832023-01-11 14:50:10 +01002170 if (!PSA_ALG_IS_HASH(alg)) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002171 status = PSA_ERROR_INVALID_ARGUMENT;
2172 goto exit;
2173 }
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002174
Steven Cooremanb6bf4bb2021-03-15 19:00:14 +01002175 /* Ensure all of the context is zeroized, since PSA_HASH_OPERATION_INIT only
2176 * directly zeroes the int-sized dummy member of the context union. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002177 memset(&operation->ctx, 0, sizeof(operation->ctx));
Steven Cooreman893232f2021-03-15 12:23:37 +01002178
Gilles Peskine449bd832023-01-11 14:50:10 +01002179 status = psa_driver_wrapper_hash_setup(operation, alg);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002180
2181exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002182 if (status != PSA_SUCCESS) {
2183 psa_hash_abort(operation);
2184 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002185
2186 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002187}
2188
Gilles Peskine449bd832023-01-11 14:50:10 +01002189psa_status_t psa_hash_update(psa_hash_operation_t *operation,
2190 const uint8_t *input,
2191 size_t input_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002192{
Dave Rodgman685b6a72021-06-24 11:49:14 +01002193 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2194
Gilles Peskine449bd832023-01-11 14:50:10 +01002195 if (operation->id == 0) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002196 status = PSA_ERROR_BAD_STATE;
2197 goto exit;
2198 }
Gilles Peskine94e44542018-07-12 16:58:43 +02002199
Steven Cooremanc8288352021-03-04 14:02:19 +01002200 /* Don't require hash implementations to behave correctly on a
2201 * zero-length input, which may have an invalid pointer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002202 if (input_length == 0) {
2203 return PSA_SUCCESS;
2204 }
Steven Cooremanc8288352021-03-04 14:02:19 +01002205
Gilles Peskine449bd832023-01-11 14:50:10 +01002206 status = psa_driver_wrapper_hash_update(operation, input, input_length);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002207
2208exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002209 if (status != PSA_SUCCESS) {
2210 psa_hash_abort(operation);
2211 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002212
Gilles Peskine449bd832023-01-11 14:50:10 +01002213 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002214}
2215
Gilles Peskine449bd832023-01-11 14:50:10 +01002216psa_status_t psa_hash_finish(psa_hash_operation_t *operation,
2217 uint8_t *hash,
2218 size_t hash_size,
2219 size_t *hash_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002220{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002221 *hash_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002222 if (operation->id == 0) {
2223 return PSA_ERROR_BAD_STATE;
2224 }
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002225
Steven Cooreman1e582352021-02-18 17:24:37 +01002226 psa_status_t status = psa_driver_wrapper_hash_finish(
Gilles Peskine449bd832023-01-11 14:50:10 +01002227 operation, hash, hash_size, hash_length);
2228 psa_hash_abort(operation);
2229 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002230}
2231
Gilles Peskine449bd832023-01-11 14:50:10 +01002232psa_status_t psa_hash_verify(psa_hash_operation_t *operation,
2233 const uint8_t *hash,
2234 size_t hash_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002235{
Ronald Cron69a63422021-10-18 09:47:58 +02002236 uint8_t actual_hash[PSA_HASH_MAX_SIZE];
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002237 size_t actual_hash_length;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002238 psa_status_t status = psa_hash_finish(
Gilles Peskine449bd832023-01-11 14:50:10 +01002239 operation,
2240 actual_hash, sizeof(actual_hash),
2241 &actual_hash_length);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002242
Gilles Peskine449bd832023-01-11 14:50:10 +01002243 if (status != PSA_SUCCESS) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002244 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002245 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002246
Gilles Peskine449bd832023-01-11 14:50:10 +01002247 if (actual_hash_length != hash_length) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002248 status = PSA_ERROR_INVALID_SIGNATURE;
2249 goto exit;
2250 }
2251
Dave Rodgman78701152023-08-29 14:20:18 +01002252 if (mbedtls_ct_memcmp(hash, actual_hash, actual_hash_length) != 0) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002253 status = PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01002254 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002255
2256exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002257 mbedtls_platform_zeroize(actual_hash, sizeof(actual_hash));
2258 if (status != PSA_SUCCESS) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002259 psa_hash_abort(operation);
Gilles Peskine449bd832023-01-11 14:50:10 +01002260 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002261
Gilles Peskine449bd832023-01-11 14:50:10 +01002262 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002263}
2264
Gilles Peskine449bd832023-01-11 14:50:10 +01002265psa_status_t psa_hash_compute(psa_algorithm_t alg,
2266 const uint8_t *input, size_t input_length,
2267 uint8_t *hash, size_t hash_size,
2268 size_t *hash_length)
Gilles Peskine0a749c82019-11-28 19:33:58 +01002269{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002270 *hash_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002271 if (!PSA_ALG_IS_HASH(alg)) {
2272 return PSA_ERROR_INVALID_ARGUMENT;
2273 }
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002274
Gilles Peskine449bd832023-01-11 14:50:10 +01002275 return psa_driver_wrapper_hash_compute(alg, input, input_length,
2276 hash, hash_size, hash_length);
Gilles Peskine0a749c82019-11-28 19:33:58 +01002277}
2278
Gilles Peskine449bd832023-01-11 14:50:10 +01002279psa_status_t psa_hash_compare(psa_algorithm_t alg,
2280 const uint8_t *input, size_t input_length,
2281 const uint8_t *hash, size_t hash_length)
Gilles Peskine0a749c82019-11-28 19:33:58 +01002282{
Ronald Cron69a63422021-10-18 09:47:58 +02002283 uint8_t actual_hash[PSA_HASH_MAX_SIZE];
Steven Cooreman84d670d2021-02-18 16:22:53 +01002284 size_t actual_hash_length;
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002285
Gilles Peskine449bd832023-01-11 14:50:10 +01002286 if (!PSA_ALG_IS_HASH(alg)) {
2287 return PSA_ERROR_INVALID_ARGUMENT;
2288 }
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002289
Steven Cooreman1e582352021-02-18 17:24:37 +01002290 psa_status_t status = psa_driver_wrapper_hash_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01002291 alg, input, input_length,
2292 actual_hash, sizeof(actual_hash),
2293 &actual_hash_length);
2294 if (status != PSA_SUCCESS) {
Gilles Peskine60aebec2021-12-13 12:33:18 +01002295 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002296 }
2297 if (actual_hash_length != hash_length) {
Gilles Peskine60aebec2021-12-13 12:33:18 +01002298 status = PSA_ERROR_INVALID_SIGNATURE;
2299 goto exit;
2300 }
Dave Rodgman78701152023-08-29 14:20:18 +01002301 if (mbedtls_ct_memcmp(hash, actual_hash, actual_hash_length) != 0) {
Gilles Peskine60aebec2021-12-13 12:33:18 +01002302 status = PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01002303 }
Gilles Peskine60aebec2021-12-13 12:33:18 +01002304
2305exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002306 mbedtls_platform_zeroize(actual_hash, sizeof(actual_hash));
2307 return status;
Gilles Peskine0a749c82019-11-28 19:33:58 +01002308}
2309
Gilles Peskine449bd832023-01-11 14:50:10 +01002310psa_status_t psa_hash_clone(const psa_hash_operation_t *source_operation,
2311 psa_hash_operation_t *target_operation)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002312{
Gilles Peskine449bd832023-01-11 14:50:10 +01002313 if (source_operation->id == 0 ||
2314 target_operation->id != 0) {
2315 return PSA_ERROR_BAD_STATE;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002316 }
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002317
Gilles Peskine449bd832023-01-11 14:50:10 +01002318 psa_status_t status = psa_driver_wrapper_hash_clone(source_operation,
2319 target_operation);
2320 if (status != PSA_SUCCESS) {
2321 psa_hash_abort(target_operation);
2322 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002323
Gilles Peskine449bd832023-01-11 14:50:10 +01002324 return status;
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002325}
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002326
2327
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002328/****************************************************************/
Gilles Peskine8c9def32018-02-08 10:02:12 +01002329/* MAC */
2330/****************************************************************/
2331
Gilles Peskine449bd832023-01-11 14:50:10 +01002332psa_status_t psa_mac_abort(psa_mac_operation_t *operation)
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002333{
Steven Cooremane6804192021-03-19 18:28:56 +01002334 /* Aborting a non-active operation is allowed */
Gilles Peskine449bd832023-01-11 14:50:10 +01002335 if (operation->id == 0) {
2336 return PSA_SUCCESS;
2337 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002338
Gilles Peskine449bd832023-01-11 14:50:10 +01002339 psa_status_t status = psa_driver_wrapper_mac_abort(operation);
Steven Cooreman72f736a2021-05-07 14:14:37 +02002340 operation->mac_size = 0;
2341 operation->is_sign = 0;
Steven Cooremane6804192021-03-19 18:28:56 +01002342 operation->id = 0;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002343
Gilles Peskine449bd832023-01-11 14:50:10 +01002344 return status;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002345}
2346
Ronald Cron2dff3b22021-06-17 16:33:22 +02002347static psa_status_t psa_mac_finalize_alg_and_key_validation(
2348 psa_algorithm_t alg,
Ronald Cron79bdd822021-06-17 16:46:44 +02002349 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01002350 uint8_t *mac_size)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002351{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002352 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002353 psa_key_type_t key_type = psa_get_key_type(attributes);
2354 size_t key_bits = psa_get_key_bits(attributes);
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002355
Gilles Peskine449bd832023-01-11 14:50:10 +01002356 if (!PSA_ALG_IS_MAC(alg)) {
2357 return PSA_ERROR_INVALID_ARGUMENT;
2358 }
Steven Cooremane6804192021-03-19 18:28:56 +01002359
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002360 /* Validate the combination of key type and algorithm */
Gilles Peskine449bd832023-01-11 14:50:10 +01002361 status = psa_mac_key_can_do(alg, key_type);
2362 if (status != PSA_SUCCESS) {
2363 return status;
2364 }
Steven Cooreman15472f82021-03-02 16:16:22 +01002365
Steven Cooremand1a68f12021-05-10 11:13:41 +02002366 /* Get the output length for the algorithm and key combination */
Gilles Peskine449bd832023-01-11 14:50:10 +01002367 *mac_size = PSA_MAC_LENGTH(key_type, key_bits, alg);
Steven Cooreman15472f82021-03-02 16:16:22 +01002368
Gilles Peskine449bd832023-01-11 14:50:10 +01002369 if (*mac_size < 4) {
Steven Cooreman15472f82021-03-02 16:16:22 +01002370 /* A very short MAC is too short for security since it can be
2371 * brute-forced. Ancient protocols with 32-bit MACs do exist,
2372 * so we make this our minimum, even though 32 bits is still
2373 * too small for security. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002374 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman15472f82021-03-02 16:16:22 +01002375 }
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02002376
Gilles Peskine449bd832023-01-11 14:50:10 +01002377 if (*mac_size > PSA_MAC_LENGTH(key_type, key_bits,
2378 PSA_ALG_FULL_LENGTH_MAC(alg))) {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002379 /* It's impossible to "truncate" to a larger length than the full length
2380 * of the algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002381 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002382 }
2383
Gilles Peskine449bd832023-01-11 14:50:10 +01002384 if (*mac_size > PSA_MAC_MAX_SIZE) {
Gilles Peskinea9b6c802022-03-16 13:54:49 +01002385 /* PSA_MAC_LENGTH returns the correct length even for a MAC algorithm
2386 * that is disabled in the compile-time configuration. The result can
2387 * therefore be larger than PSA_MAC_MAX_SIZE, which does take the
2388 * configuration into account. In this case, force a return of
2389 * PSA_ERROR_NOT_SUPPORTED here. Otherwise psa_mac_verify(), or
2390 * psa_mac_compute(mac_size=PSA_MAC_MAX_SIZE), would return
2391 * PSA_ERROR_BUFFER_TOO_SMALL for an unsupported algorithm whose MAC size
2392 * is larger than PSA_MAC_MAX_SIZE, which is misleading and which breaks
2393 * systematically generated tests. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002394 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea9b6c802022-03-16 13:54:49 +01002395 }
2396
Gilles Peskine449bd832023-01-11 14:50:10 +01002397 return PSA_SUCCESS;
Ronald Cron2dff3b22021-06-17 16:33:22 +02002398}
2399
Gilles Peskine449bd832023-01-11 14:50:10 +01002400static psa_status_t psa_mac_setup(psa_mac_operation_t *operation,
2401 mbedtls_svc_key_id_t key,
2402 psa_algorithm_t alg,
2403 int is_sign)
Gilles Peskinee59236f2018-01-27 23:32:46 +01002404{
2405 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2406 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman54648242021-06-24 11:49:45 +01002407 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002408 psa_key_attributes_t attributes;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002409
2410 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002411 if (operation->id != 0) {
Dave Rodgman54648242021-06-24 11:49:45 +01002412 status = PSA_ERROR_BAD_STATE;
2413 goto exit;
2414 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002415
2416 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002417 key,
2418 &slot,
2419 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
2420 alg);
2421 if (status != PSA_SUCCESS) {
Dave Rodgman54648242021-06-24 11:49:45 +01002422 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002423 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002424
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002425 attributes = (psa_key_attributes_t) {
Gilles Peskine8c9def32018-02-08 10:02:12 +01002426 .core = slot->attr
2427 };
2428
Gilles Peskine449bd832023-01-11 14:50:10 +01002429 status = psa_mac_finalize_alg_and_key_validation(alg, &attributes,
2430 &operation->mac_size);
2431 if (status != PSA_SUCCESS) {
Gilles Peskine8c9def32018-02-08 10:02:12 +01002432 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002433 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002434
2435 operation->is_sign = is_sign;
Steven Cooremane6804192021-03-19 18:28:56 +01002436 /* Dispatch the MAC setup call with validated input */
Gilles Peskine449bd832023-01-11 14:50:10 +01002437 if (is_sign) {
2438 status = psa_driver_wrapper_mac_sign_setup(operation,
2439 &attributes,
2440 slot->key.data,
2441 slot->key.bytes,
2442 alg);
2443 } else {
2444 status = psa_driver_wrapper_mac_verify_setup(operation,
2445 &attributes,
2446 slot->key.data,
2447 slot->key.bytes,
2448 alg);
Gilles Peskine8c9def32018-02-08 10:02:12 +01002449 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002450
Gilles Peskinefbfac682018-07-08 20:51:54 +02002451exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002452 if (status != PSA_SUCCESS) {
2453 psa_mac_abort(operation);
2454 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002455
Ryan Everett1b70a072024-01-04 10:32:49 +00002456 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02002457
Gilles Peskine449bd832023-01-11 14:50:10 +01002458 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002459}
2460
Gilles Peskine449bd832023-01-11 14:50:10 +01002461psa_status_t psa_mac_sign_setup(psa_mac_operation_t *operation,
2462 mbedtls_svc_key_id_t key,
2463 psa_algorithm_t alg)
Gilles Peskine89167cb2018-07-08 20:12:23 +02002464{
Gilles Peskine449bd832023-01-11 14:50:10 +01002465 return psa_mac_setup(operation, key, alg, 1);
Gilles Peskine89167cb2018-07-08 20:12:23 +02002466}
2467
Gilles Peskine449bd832023-01-11 14:50:10 +01002468psa_status_t psa_mac_verify_setup(psa_mac_operation_t *operation,
2469 mbedtls_svc_key_id_t key,
2470 psa_algorithm_t alg)
Gilles Peskine89167cb2018-07-08 20:12:23 +02002471{
Gilles Peskine449bd832023-01-11 14:50:10 +01002472 return psa_mac_setup(operation, key, alg, 0);
Gilles Peskine89167cb2018-07-08 20:12:23 +02002473}
2474
Gilles Peskine449bd832023-01-11 14:50:10 +01002475psa_status_t psa_mac_update(psa_mac_operation_t *operation,
2476 const uint8_t *input,
2477 size_t input_length)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002478{
Gilles Peskine449bd832023-01-11 14:50:10 +01002479 if (operation->id == 0) {
2480 return PSA_ERROR_BAD_STATE;
2481 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002482
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002483 /* Don't require hash implementations to behave correctly on a
2484 * zero-length input, which may have an invalid pointer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002485 if (input_length == 0) {
2486 return PSA_SUCCESS;
2487 }
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03002488
Gilles Peskine449bd832023-01-11 14:50:10 +01002489 psa_status_t status = psa_driver_wrapper_mac_update(operation,
2490 input, input_length);
2491 if (status != PSA_SUCCESS) {
2492 psa_mac_abort(operation);
2493 }
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002494
Gilles Peskine449bd832023-01-11 14:50:10 +01002495 return status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002496}
2497
Gilles Peskine449bd832023-01-11 14:50:10 +01002498psa_status_t psa_mac_sign_finish(psa_mac_operation_t *operation,
2499 uint8_t *mac,
2500 size_t mac_size,
2501 size_t *mac_length)
mohammad16036df908f2018-04-02 08:34:15 -07002502{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002503 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2504 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002505
Gilles Peskine449bd832023-01-11 14:50:10 +01002506 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002507 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002508 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002509 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002510
Gilles Peskine449bd832023-01-11 14:50:10 +01002511 if (!operation->is_sign) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002512 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002513 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002514 }
Steven Cooreman72f736a2021-05-07 14:14:37 +02002515
Steven Cooreman8af5c5c2021-05-11 11:09:13 +02002516 /* Sanity check. This will guarantee that mac_size != 0 (and so mac != NULL)
2517 * once all the error checks are done. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002518 if (operation->mac_size == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002519 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002520 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002521 }
Steven Cooreman8af5c5c2021-05-11 11:09:13 +02002522
Gilles Peskine449bd832023-01-11 14:50:10 +01002523 if (mac_size < operation->mac_size) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002524 status = PSA_ERROR_BUFFER_TOO_SMALL;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002525 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002526 }
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002527
Gilles Peskine449bd832023-01-11 14:50:10 +01002528 status = psa_driver_wrapper_mac_sign_finish(operation,
2529 mac, operation->mac_size,
2530 mac_length);
Steven Cooreman72f736a2021-05-07 14:14:37 +02002531
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002532exit:
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002533 /* In case of success, set the potential excess room in the output buffer
2534 * to an invalid value, to avoid potentially leaking a longer MAC.
2535 * In case of error, set the output length and content to a safe default,
2536 * such that in case the caller misses an error check, the output would be
2537 * an unachievable MAC.
2538 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002539 if (status != PSA_SUCCESS) {
Steven Cooreman72f736a2021-05-07 14:14:37 +02002540 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002541 operation->mac_size = 0;
Steven Cooreman72f736a2021-05-07 14:14:37 +02002542 }
mohammad16036df908f2018-04-02 08:34:15 -07002543
Paul Elliottdc42ca82023-02-24 18:11:59 +00002544 psa_wipe_tag_output_buffer(mac, status, mac_size, *mac_length);
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002545
Gilles Peskine449bd832023-01-11 14:50:10 +01002546 abort_status = psa_mac_abort(operation);
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002547
Gilles Peskine449bd832023-01-11 14:50:10 +01002548 return status == PSA_SUCCESS ? abort_status : status;
mohammad16036df908f2018-04-02 08:34:15 -07002549}
2550
Gilles Peskine449bd832023-01-11 14:50:10 +01002551psa_status_t psa_mac_verify_finish(psa_mac_operation_t *operation,
2552 const uint8_t *mac,
2553 size_t mac_length)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002554{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002555 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2556 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002557
Gilles Peskine449bd832023-01-11 14:50:10 +01002558 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002559 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002560 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002561 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002562
Gilles Peskine449bd832023-01-11 14:50:10 +01002563 if (operation->is_sign) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002564 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002565 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002566 }
Steven Cooreman72f736a2021-05-07 14:14:37 +02002567
Gilles Peskine449bd832023-01-11 14:50:10 +01002568 if (operation->mac_size != mac_length) {
Steven Cooreman72f736a2021-05-07 14:14:37 +02002569 status = PSA_ERROR_INVALID_SIGNATURE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002570 goto exit;
Steven Cooreman72f736a2021-05-07 14:14:37 +02002571 }
2572
Gilles Peskine449bd832023-01-11 14:50:10 +01002573 status = psa_driver_wrapper_mac_verify_finish(operation,
2574 mac, mac_length);
Steven Cooreman72f736a2021-05-07 14:14:37 +02002575
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002576exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002577 abort_status = psa_mac_abort(operation);
mohammad16036df908f2018-04-02 08:34:15 -07002578
Gilles Peskine449bd832023-01-11 14:50:10 +01002579 return status == PSA_SUCCESS ? abort_status : status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002580}
2581
Gilles Peskine449bd832023-01-11 14:50:10 +01002582static psa_status_t psa_mac_compute_internal(mbedtls_svc_key_id_t key,
2583 psa_algorithm_t alg,
2584 const uint8_t *input,
2585 size_t input_length,
2586 uint8_t *mac,
2587 size_t mac_size,
2588 size_t *mac_length,
2589 int is_sign)
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002590{
2591 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron51131b52021-06-17 17:17:20 +02002592 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2593 psa_key_slot_t *slot;
2594 uint8_t operation_mac_size = 0;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002595 psa_key_attributes_t attributes;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002596
Ronald Cron51131b52021-06-17 17:17:20 +02002597 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002598 key,
2599 &slot,
2600 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
2601 alg);
2602 if (status != PSA_SUCCESS) {
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002603 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002604 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002605
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002606 attributes = (psa_key_attributes_t) {
Ronald Cron51131b52021-06-17 17:17:20 +02002607 .core = slot->attr
2608 };
2609
Gilles Peskine449bd832023-01-11 14:50:10 +01002610 status = psa_mac_finalize_alg_and_key_validation(alg, &attributes,
2611 &operation_mac_size);
2612 if (status != PSA_SUCCESS) {
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002613 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002614 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002615
Gilles Peskine449bd832023-01-11 14:50:10 +01002616 if (mac_size < operation_mac_size) {
Ronald Cron51131b52021-06-17 17:17:20 +02002617 status = PSA_ERROR_BUFFER_TOO_SMALL;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002618 goto exit;
Ronald Cron51131b52021-06-17 17:17:20 +02002619 }
2620
2621 status = psa_driver_wrapper_mac_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01002622 &attributes,
2623 slot->key.data, slot->key.bytes,
2624 alg,
2625 input, input_length,
2626 mac, operation_mac_size, mac_length);
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002627
2628exit:
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002629 /* In case of success, set the potential excess room in the output buffer
2630 * to an invalid value, to avoid potentially leaking a longer MAC.
2631 * In case of error, set the output length and content to a safe default,
2632 * such that in case the caller misses an error check, the output would be
2633 * an unachievable MAC.
2634 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002635 if (status != PSA_SUCCESS) {
Ronald Cron51131b52021-06-17 17:17:20 +02002636 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002637 operation_mac_size = 0;
Ronald Cron51131b52021-06-17 17:17:20 +02002638 }
Paul Elliottdc42ca82023-02-24 18:11:59 +00002639
2640 psa_wipe_tag_output_buffer(mac, status, mac_size, *mac_length);
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002641
Ryan Everett1b70a072024-01-04 10:32:49 +00002642 unlock_status = psa_unregister_read(slot);
Ronald Cron51131b52021-06-17 17:17:20 +02002643
Gilles Peskine449bd832023-01-11 14:50:10 +01002644 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002645}
2646
Gilles Peskine449bd832023-01-11 14:50:10 +01002647psa_status_t psa_mac_compute(mbedtls_svc_key_id_t key,
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002648 psa_algorithm_t alg,
2649 const uint8_t *input,
2650 size_t input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002651 uint8_t *mac,
2652 size_t mac_size,
2653 size_t *mac_length)
2654{
2655 return psa_mac_compute_internal(key, alg,
2656 input, input_length,
2657 mac, mac_size, mac_length, 1);
2658}
2659
2660psa_status_t psa_mac_verify(mbedtls_svc_key_id_t key,
2661 psa_algorithm_t alg,
2662 const uint8_t *input,
2663 size_t input_length,
2664 const uint8_t *mac,
2665 size_t mac_length)
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002666{
2667 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Crona587cbc2021-06-18 14:51:29 +02002668 uint8_t actual_mac[PSA_MAC_MAX_SIZE];
2669 size_t actual_mac_length;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002670
Gilles Peskine449bd832023-01-11 14:50:10 +01002671 status = psa_mac_compute_internal(key, alg,
2672 input, input_length,
2673 actual_mac, sizeof(actual_mac),
2674 &actual_mac_length, 0);
2675 if (status != PSA_SUCCESS) {
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002676 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002677 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002678
Gilles Peskine449bd832023-01-11 14:50:10 +01002679 if (mac_length != actual_mac_length) {
Ronald Crona587cbc2021-06-18 14:51:29 +02002680 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002681 goto exit;
Ronald Crona587cbc2021-06-18 14:51:29 +02002682 }
Dave Rodgman78701152023-08-29 14:20:18 +01002683 if (mbedtls_ct_memcmp(mac, actual_mac, actual_mac_length) != 0) {
Ronald Crona587cbc2021-06-18 14:51:29 +02002684 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002685 goto exit;
Ronald Crona587cbc2021-06-18 14:51:29 +02002686 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002687
2688exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002689 mbedtls_platform_zeroize(actual_mac, sizeof(actual_mac));
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002690
Gilles Peskine449bd832023-01-11 14:50:10 +01002691 return status;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002692}
Gilles Peskinee59236f2018-01-27 23:32:46 +01002693
Gilles Peskinee59236f2018-01-27 23:32:46 +01002694/****************************************************************/
2695/* Asymmetric cryptography */
2696/****************************************************************/
2697
Gilles Peskine449bd832023-01-11 14:50:10 +01002698static psa_status_t psa_sign_verify_check_alg(int input_is_message,
2699 psa_algorithm_t alg)
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002700{
Gilles Peskine449bd832023-01-11 14:50:10 +01002701 if (input_is_message) {
2702 if (!PSA_ALG_IS_SIGN_MESSAGE(alg)) {
2703 return PSA_ERROR_INVALID_ARGUMENT;
2704 }
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002705
Gilles Peskine449bd832023-01-11 14:50:10 +01002706 if (PSA_ALG_IS_SIGN_HASH(alg)) {
2707 if (!PSA_ALG_IS_HASH(PSA_ALG_SIGN_GET_HASH(alg))) {
2708 return PSA_ERROR_INVALID_ARGUMENT;
2709 }
2710 }
2711 } else {
2712 if (!PSA_ALG_IS_SIGN_HASH(alg)) {
2713 return PSA_ERROR_INVALID_ARGUMENT;
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002714 }
2715 }
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002716
Gilles Peskine449bd832023-01-11 14:50:10 +01002717 return PSA_SUCCESS;
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002718}
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002719
Gilles Peskine449bd832023-01-11 14:50:10 +01002720static psa_status_t psa_sign_internal(mbedtls_svc_key_id_t key,
2721 int input_is_message,
2722 psa_algorithm_t alg,
2723 const uint8_t *input,
2724 size_t input_length,
2725 uint8_t *signature,
2726 size_t signature_size,
2727 size_t *signature_length)
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002728{
2729 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2730 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2731 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002732 psa_key_attributes_t attributes;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002733
2734 *signature_length = 0;
2735
Gilles Peskine449bd832023-01-11 14:50:10 +01002736 status = psa_sign_verify_check_alg(input_is_message, alg);
2737 if (status != PSA_SUCCESS) {
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002738 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002739 }
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002740
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002741 /* Immediately reject a zero-length signature buffer. This guarantees
gabor-mezei-arm12b4f342021-05-05 13:54:55 +02002742 * that signature must be a valid pointer. (On the other hand, the input
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002743 * buffer can in principle be empty since it doesn't actually have
2744 * to be a hash.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01002745 if (signature_size == 0) {
2746 return PSA_ERROR_BUFFER_TOO_SMALL;
2747 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002748
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002749 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002750 key, &slot,
2751 input_is_message ? PSA_KEY_USAGE_SIGN_MESSAGE :
2752 PSA_KEY_USAGE_SIGN_HASH,
2753 alg);
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002754
Gilles Peskine449bd832023-01-11 14:50:10 +01002755 if (status != PSA_SUCCESS) {
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002756 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002757 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002758
Gilles Peskine449bd832023-01-11 14:50:10 +01002759 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002760 status = PSA_ERROR_INVALID_ARGUMENT;
2761 goto exit;
2762 }
2763
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002764 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01002765 .core = slot->attr
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002766 };
2767
Gilles Peskine449bd832023-01-11 14:50:10 +01002768 if (input_is_message) {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002769 status = psa_driver_wrapper_sign_message(
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002770 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002771 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002772 signature, signature_size, signature_length);
2773 } else {
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002774
2775 status = psa_driver_wrapper_sign_hash(
2776 &attributes, slot->key.data, slot->key.bytes,
2777 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002778 signature, signature_size, signature_length);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002779 }
2780
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002781
2782exit:
Paul Elliott59200a22023-02-21 15:07:40 +00002783 psa_wipe_tag_output_buffer(signature, status, signature_size,
2784 *signature_length);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002785
Ryan Everett1b70a072024-01-04 10:32:49 +00002786 unlock_status = psa_unregister_read(slot);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002787
Gilles Peskine449bd832023-01-11 14:50:10 +01002788 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002789}
2790
Gilles Peskine449bd832023-01-11 14:50:10 +01002791static psa_status_t psa_verify_internal(mbedtls_svc_key_id_t key,
2792 int input_is_message,
2793 psa_algorithm_t alg,
2794 const uint8_t *input,
2795 size_t input_length,
2796 const uint8_t *signature,
2797 size_t signature_length)
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002798{
2799 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2800 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2801 psa_key_slot_t *slot;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002802
Gilles Peskine449bd832023-01-11 14:50:10 +01002803 status = psa_sign_verify_check_alg(input_is_message, alg);
2804 if (status != PSA_SUCCESS) {
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002805 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002806 }
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002807
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002808 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002809 key, &slot,
2810 input_is_message ? PSA_KEY_USAGE_VERIFY_MESSAGE :
2811 PSA_KEY_USAGE_VERIFY_HASH,
2812 alg);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002813
Gilles Peskine449bd832023-01-11 14:50:10 +01002814 if (status != PSA_SUCCESS) {
2815 return status;
2816 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002817
2818 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01002819 .core = slot->attr
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002820 };
2821
Gilles Peskine449bd832023-01-11 14:50:10 +01002822 if (input_is_message) {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002823 status = psa_driver_wrapper_verify_message(
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002824 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002825 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002826 signature, signature_length);
2827 } else {
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002828 status = psa_driver_wrapper_verify_hash(
2829 &attributes, slot->key.data, slot->key.bytes,
2830 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002831 signature, signature_length);
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002832 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002833
Ryan Everett1b70a072024-01-04 10:32:49 +00002834 unlock_status = psa_unregister_read(slot);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002835
Gilles Peskine449bd832023-01-11 14:50:10 +01002836 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002837
2838}
2839
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002840psa_status_t psa_sign_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002841 const psa_key_attributes_t *attributes,
2842 const uint8_t *key_buffer,
2843 size_t key_buffer_size,
2844 psa_algorithm_t alg,
2845 const uint8_t *input,
2846 size_t input_length,
2847 uint8_t *signature,
2848 size_t signature_size,
Gilles Peskine449bd832023-01-11 14:50:10 +01002849 size_t *signature_length)
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002850{
2851 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002852
Gilles Peskine449bd832023-01-11 14:50:10 +01002853 if (PSA_ALG_IS_SIGN_HASH(alg)) {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002854 size_t hash_length;
2855 uint8_t hash[PSA_HASH_MAX_SIZE];
2856
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002857 status = psa_driver_wrapper_hash_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01002858 PSA_ALG_SIGN_GET_HASH(alg),
2859 input, input_length,
2860 hash, sizeof(hash), &hash_length);
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002861
Gilles Peskine449bd832023-01-11 14:50:10 +01002862 if (status != PSA_SUCCESS) {
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002863 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002864 }
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002865
2866 return psa_driver_wrapper_sign_hash(
Gilles Peskine449bd832023-01-11 14:50:10 +01002867 attributes, key_buffer, key_buffer_size,
2868 alg, hash, hash_length,
2869 signature, signature_size, signature_length);
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002870 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002871
Gilles Peskine449bd832023-01-11 14:50:10 +01002872 return PSA_ERROR_NOT_SUPPORTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002873}
2874
Gilles Peskine449bd832023-01-11 14:50:10 +01002875psa_status_t psa_sign_message(mbedtls_svc_key_id_t key,
2876 psa_algorithm_t alg,
2877 const uint8_t *input,
2878 size_t input_length,
2879 uint8_t *signature,
2880 size_t signature_size,
2881 size_t *signature_length)
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002882{
2883 return psa_sign_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002884 key, 1, alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002885 signature, signature_size, signature_length);
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002886}
2887
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002888psa_status_t psa_verify_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002889 const psa_key_attributes_t *attributes,
2890 const uint8_t *key_buffer,
2891 size_t key_buffer_size,
2892 psa_algorithm_t alg,
2893 const uint8_t *input,
2894 size_t input_length,
2895 const uint8_t *signature,
Gilles Peskine449bd832023-01-11 14:50:10 +01002896 size_t signature_length)
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002897{
2898 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002899
Gilles Peskine449bd832023-01-11 14:50:10 +01002900 if (PSA_ALG_IS_SIGN_HASH(alg)) {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002901 size_t hash_length;
2902 uint8_t hash[PSA_HASH_MAX_SIZE];
2903
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002904 status = psa_driver_wrapper_hash_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01002905 PSA_ALG_SIGN_GET_HASH(alg),
2906 input, input_length,
2907 hash, sizeof(hash), &hash_length);
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002908
Gilles Peskine449bd832023-01-11 14:50:10 +01002909 if (status != PSA_SUCCESS) {
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002910 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002911 }
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002912
2913 return psa_driver_wrapper_verify_hash(
Gilles Peskine449bd832023-01-11 14:50:10 +01002914 attributes, key_buffer, key_buffer_size,
2915 alg, hash, hash_length,
2916 signature, signature_length);
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002917 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002918
Gilles Peskine449bd832023-01-11 14:50:10 +01002919 return PSA_ERROR_NOT_SUPPORTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002920}
2921
Gilles Peskine449bd832023-01-11 14:50:10 +01002922psa_status_t psa_verify_message(mbedtls_svc_key_id_t key,
2923 psa_algorithm_t alg,
2924 const uint8_t *input,
2925 size_t input_length,
2926 const uint8_t *signature,
2927 size_t signature_length)
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002928{
2929 return psa_verify_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002930 key, 1, alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002931 signature, signature_length);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002932}
2933
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002934psa_status_t psa_sign_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01002935 const psa_key_attributes_t *attributes,
2936 const uint8_t *key_buffer, size_t key_buffer_size,
2937 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002938 uint8_t *signature, size_t signature_size, size_t *signature_length)
Gilles Peskinee59236f2018-01-27 23:32:46 +01002939{
Gilles Peskine449bd832023-01-11 14:50:10 +01002940 if (attributes->core.type == PSA_KEY_TYPE_RSA_KEY_PAIR) {
2941 if (PSA_ALG_IS_RSA_PKCS1V15_SIGN(alg) ||
2942 PSA_ALG_IS_RSA_PSS(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01002943#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01002944 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
2945 return mbedtls_psa_rsa_sign_hash(
2946 attributes,
2947 key_buffer, key_buffer_size,
2948 alg, hash, hash_length,
2949 signature, signature_size, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01002950#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
2951 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine449bd832023-01-11 14:50:10 +01002952 } else {
2953 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanacda8342020-07-24 23:09:52 +02002954 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002955 } else if (PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
2956 if (PSA_ALG_IS_ECDSA(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01002957#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01002958 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
2959 return mbedtls_psa_ecdsa_sign_hash(
2960 attributes,
2961 key_buffer, key_buffer_size,
2962 alg, hash, hash_length,
2963 signature, signature_size, signature_length);
Gilles Peskinee59236f2018-01-27 23:32:46 +01002964#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
2965 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskine449bd832023-01-11 14:50:10 +01002966 } else {
2967 return PSA_ERROR_INVALID_ARGUMENT;
Ronald Cron4501c982021-03-19 20:09:32 +01002968 }
Ronald Cron8a494f32021-02-17 09:49:51 +01002969 }
Ronald Cron4501c982021-03-19 20:09:32 +01002970
Gilles Peskine449bd832023-01-11 14:50:10 +01002971 (void) key_buffer;
2972 (void) key_buffer_size;
2973 (void) hash;
2974 (void) hash_length;
2975 (void) signature;
2976 (void) signature_size;
2977 (void) signature_length;
Ronald Cron4501c982021-03-19 20:09:32 +01002978
Gilles Peskine449bd832023-01-11 14:50:10 +01002979 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron18659932020-12-08 16:32:23 +01002980}
Gilles Peskinee59236f2018-01-27 23:32:46 +01002981
Gilles Peskine449bd832023-01-11 14:50:10 +01002982psa_status_t psa_sign_hash(mbedtls_svc_key_id_t key,
2983 psa_algorithm_t alg,
2984 const uint8_t *hash,
2985 size_t hash_length,
2986 uint8_t *signature,
2987 size_t signature_size,
2988 size_t *signature_length)
Gilles Peskinee59236f2018-01-27 23:32:46 +01002989{
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002990 return psa_sign_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002991 key, 0, alg, hash, hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002992 signature, signature_size, signature_length);
itayzafrir5c753392018-05-08 11:18:38 +03002993}
2994
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002995psa_status_t psa_verify_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01002996 const psa_key_attributes_t *attributes,
2997 const uint8_t *key_buffer, size_t key_buffer_size,
2998 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002999 const uint8_t *signature, size_t signature_length)
itayzafrir5c753392018-05-08 11:18:38 +03003000{
Gilles Peskine449bd832023-01-11 14:50:10 +01003001 if (PSA_KEY_TYPE_IS_RSA(attributes->core.type)) {
3002 if (PSA_ALG_IS_RSA_PKCS1V15_SIGN(alg) ||
3003 PSA_ALG_IS_RSA_PSS(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003004#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003005 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
3006 return mbedtls_psa_rsa_verify_hash(
3007 attributes,
3008 key_buffer, key_buffer_size,
3009 alg, hash, hash_length,
3010 signature, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01003011#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
3012 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003013 } else {
3014 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanacda8342020-07-24 23:09:52 +02003015 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003016 } else if (PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3017 if (PSA_ALG_IS_ECDSA(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003018#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003019 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3020 return mbedtls_psa_ecdsa_verify_hash(
3021 attributes,
3022 key_buffer, key_buffer_size,
3023 alg, hash, hash_length,
3024 signature, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01003025#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3026 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003027 } else {
3028 return PSA_ERROR_INVALID_ARGUMENT;
Ronald Cron4501c982021-03-19 20:09:32 +01003029 }
Ronald Cron8a494f32021-02-17 09:49:51 +01003030 }
Ronald Cron4501c982021-03-19 20:09:32 +01003031
Gilles Peskine449bd832023-01-11 14:50:10 +01003032 (void) key_buffer;
3033 (void) key_buffer_size;
3034 (void) hash;
3035 (void) hash_length;
3036 (void) signature;
3037 (void) signature_length;
Ronald Cron4501c982021-03-19 20:09:32 +01003038
Gilles Peskine449bd832023-01-11 14:50:10 +01003039 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron18659932020-12-08 16:32:23 +01003040}
3041
Gilles Peskine449bd832023-01-11 14:50:10 +01003042psa_status_t psa_verify_hash(mbedtls_svc_key_id_t key,
3043 psa_algorithm_t alg,
3044 const uint8_t *hash,
3045 size_t hash_length,
3046 const uint8_t *signature,
3047 size_t signature_length)
itayzafrir5c753392018-05-08 11:18:38 +03003048{
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003049 return psa_verify_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02003050 key, 0, alg, hash, hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003051 signature, signature_length);
Gilles Peskinee59236f2018-01-27 23:32:46 +01003052}
3053
Gilles Peskine449bd832023-01-11 14:50:10 +01003054psa_status_t psa_asymmetric_encrypt(mbedtls_svc_key_id_t key,
3055 psa_algorithm_t alg,
3056 const uint8_t *input,
3057 size_t input_length,
3058 const uint8_t *salt,
3059 size_t salt_length,
3060 uint8_t *output,
3061 size_t output_size,
3062 size_t *output_length)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003063{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003064 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003065 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003066 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003067 psa_key_attributes_t attributes;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003068
Darryl Green5cc689a2018-07-24 15:34:10 +01003069 (void) input;
3070 (void) input_length;
3071 (void) salt;
3072 (void) output;
3073 (void) output_size;
3074
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003075 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003076
Gilles Peskine449bd832023-01-11 14:50:10 +01003077 if (!PSA_ALG_IS_RSA_OAEP(alg) && salt_length != 0) {
3078 return PSA_ERROR_INVALID_ARGUMENT;
3079 }
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003080
Ronald Cron5c522922020-11-14 16:35:34 +01003081 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01003082 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg);
3083 if (status != PSA_SUCCESS) {
3084 return status;
3085 }
3086 if (!(PSA_KEY_TYPE_IS_PUBLIC_KEY(slot->attr.type) ||
3087 PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type))) {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003088 status = PSA_ERROR_INVALID_ARGUMENT;
3089 goto exit;
3090 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003091
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003092 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01003093 .core = slot->attr
Przemyslaw Stekiel19e61422021-12-09 11:09:11 +01003094 };
Steven Cooremana2371e52020-07-28 14:30:39 +02003095
Przemyslaw Stekiel19e61422021-12-09 11:09:11 +01003096 status = psa_driver_wrapper_asymmetric_encrypt(
3097 &attributes, slot->key.data, slot->key.bytes,
3098 alg, input, input_length, salt, salt_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003099 output, output_size, output_length);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003100exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00003101 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003102
Gilles Peskine449bd832023-01-11 14:50:10 +01003103 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003104}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003105
Gilles Peskine449bd832023-01-11 14:50:10 +01003106psa_status_t psa_asymmetric_decrypt(mbedtls_svc_key_id_t key,
3107 psa_algorithm_t alg,
3108 const uint8_t *input,
3109 size_t input_length,
3110 const uint8_t *salt,
3111 size_t salt_length,
3112 uint8_t *output,
3113 size_t output_size,
3114 size_t *output_length)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003115{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003116 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003117 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003118 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003119 psa_key_attributes_t attributes;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003120
Darryl Green5cc689a2018-07-24 15:34:10 +01003121 (void) input;
3122 (void) input_length;
3123 (void) salt;
3124 (void) output;
3125 (void) output_size;
3126
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003127 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003128
Gilles Peskine449bd832023-01-11 14:50:10 +01003129 if (!PSA_ALG_IS_RSA_OAEP(alg) && salt_length != 0) {
3130 return PSA_ERROR_INVALID_ARGUMENT;
3131 }
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003132
Ronald Cron5c522922020-11-14 16:35:34 +01003133 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01003134 key, &slot, PSA_KEY_USAGE_DECRYPT, alg);
3135 if (status != PSA_SUCCESS) {
3136 return status;
3137 }
3138 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003139 status = PSA_ERROR_INVALID_ARGUMENT;
3140 goto exit;
3141 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003142
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003143 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01003144 .core = slot->attr
Przemyslaw Stekiel8d45c002021-12-13 08:58:19 +01003145 };
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003146
Przemyslaw Stekiel8d45c002021-12-13 08:58:19 +01003147 status = psa_driver_wrapper_asymmetric_decrypt(
3148 &attributes, slot->key.data, slot->key.bytes,
3149 alg, input, input_length, salt, salt_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003150 output, output_size, output_length);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003151
3152exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00003153 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003154
Gilles Peskine449bd832023-01-11 14:50:10 +01003155 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003156}
Gilles Peskinee59236f2018-01-27 23:32:46 +01003157
Paul Elliott9fe12f62022-11-30 19:16:02 +00003158/****************************************************************/
3159/* Asymmetric interruptible cryptography */
3160/****************************************************************/
3161
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003162static uint32_t psa_interruptible_max_ops = PSA_INTERRUPTIBLE_MAX_OPS_UNLIMITED;
3163
Paul Elliott9fe12f62022-11-30 19:16:02 +00003164void psa_interruptible_set_max_ops(uint32_t max_ops)
3165{
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003166 psa_interruptible_max_ops = max_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003167}
3168
3169uint32_t psa_interruptible_get_max_ops(void)
3170{
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003171 return psa_interruptible_max_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003172}
3173
Paul Elliott9fe12f62022-11-30 19:16:02 +00003174uint32_t psa_sign_hash_get_num_ops(
3175 const psa_sign_hash_interruptible_operation_t *operation)
3176{
Paul Elliott296ede92022-12-15 17:00:30 +00003177 return operation->num_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003178}
3179
3180uint32_t psa_verify_hash_get_num_ops(
3181 const psa_verify_hash_interruptible_operation_t *operation)
3182{
Paul Elliott296ede92022-12-15 17:00:30 +00003183 return operation->num_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003184}
3185
Paul Elliott59ad9452022-12-18 15:09:02 +00003186static psa_status_t psa_sign_hash_abort_internal(
3187 psa_sign_hash_interruptible_operation_t *operation)
3188{
3189 if (operation->id == 0) {
3190 /* The object has (apparently) been initialized but it is not (yet)
3191 * in use. It's ok to call abort on such an object, and there's
3192 * nothing to do. */
3193 return PSA_SUCCESS;
3194 }
3195
3196 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3197
3198 status = psa_driver_wrapper_sign_hash_abort(operation);
3199
3200 operation->id = 0;
3201
Paul Elliotte6145dc2023-02-07 12:51:21 +00003202 /* Do not clear either the error_occurred or num_ops elements here as they
3203 * only want to be cleared by the application calling abort, not by abort
3204 * being called at completion of an operation. */
3205
Paul Elliott59ad9452022-12-18 15:09:02 +00003206 return status;
3207}
3208
Paul Elliott9fe12f62022-11-30 19:16:02 +00003209psa_status_t psa_sign_hash_start(
3210 psa_sign_hash_interruptible_operation_t *operation,
3211 mbedtls_svc_key_id_t key, psa_algorithm_t alg,
3212 const uint8_t *hash, size_t hash_length)
3213{
3214 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3215 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3216 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003217 psa_key_attributes_t attributes;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003218
Paul Elliottc9774412023-02-06 15:14:07 +00003219 /* Check that start has not been previously called, or operation has not
3220 * previously errored. */
3221 if (operation->id != 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003222 return PSA_ERROR_BAD_STATE;
3223 }
3224
Paul Elliott9fe12f62022-11-30 19:16:02 +00003225 status = psa_sign_verify_check_alg(0, alg);
3226 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003227 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003228 return status;
3229 }
3230
3231 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
3232 PSA_KEY_USAGE_SIGN_HASH,
3233 alg);
3234
3235 if (status != PSA_SUCCESS) {
3236 goto exit;
3237 }
3238
3239 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
3240 status = PSA_ERROR_INVALID_ARGUMENT;
3241 goto exit;
3242 }
3243
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003244 attributes = (psa_key_attributes_t) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003245 .core = slot->attr
3246 };
3247
Paul Elliott296ede92022-12-15 17:00:30 +00003248 /* Ensure ops count gets reset, in case of operation re-use. */
3249 operation->num_ops = 0;
3250
Paul Elliott9fe12f62022-11-30 19:16:02 +00003251 status = psa_driver_wrapper_sign_hash_start(operation, &attributes,
3252 slot->key.data,
3253 slot->key.bytes, alg,
3254 hash, hash_length);
3255exit:
3256
3257 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003258 operation->error_occurred = 1;
Paul Elliott59ad9452022-12-18 15:09:02 +00003259 psa_sign_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003260 }
3261
Ryan Everett1b70a072024-01-04 10:32:49 +00003262 unlock_status = psa_unregister_read(slot);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003263
Paul Elliottc9774412023-02-06 15:14:07 +00003264 if (unlock_status != PSA_SUCCESS) {
3265 operation->error_occurred = 1;
3266 }
Paul Elliott9fe12f62022-11-30 19:16:02 +00003267
Paul Elliottc9774412023-02-06 15:14:07 +00003268 return (status == PSA_SUCCESS) ? unlock_status : status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003269}
3270
3271
3272psa_status_t psa_sign_hash_complete(
3273 psa_sign_hash_interruptible_operation_t *operation,
3274 uint8_t *signature, size_t signature_size,
3275 size_t *signature_length)
3276{
3277 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3278
3279 *signature_length = 0;
3280
Paul Elliottc9774412023-02-06 15:14:07 +00003281 /* Check that start has been called first, and that operation has not
3282 * previously errored. */
3283 if (operation->id == 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003284 status = PSA_ERROR_BAD_STATE;
3285 goto exit;
3286 }
3287
Paul Elliott096abc42023-02-03 18:33:23 +00003288 /* Immediately reject a zero-length signature buffer. This guarantees that
3289 * signature must be a valid pointer. */
Paul Elliott9fe12f62022-11-30 19:16:02 +00003290 if (signature_size == 0) {
3291 status = PSA_ERROR_BUFFER_TOO_SMALL;
3292 goto exit;
3293 }
3294
3295 status = psa_driver_wrapper_sign_hash_complete(operation, signature,
3296 signature_size,
3297 signature_length);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003298
Paul Elliott296ede92022-12-15 17:00:30 +00003299 /* Update ops count with work done. */
Paul Elliottde1114c2023-02-07 12:43:11 +00003300 operation->num_ops = psa_driver_wrapper_sign_hash_get_num_ops(operation);
Paul Elliott296ede92022-12-15 17:00:30 +00003301
Paul Elliottebe225c2023-02-10 14:32:53 +00003302exit:
3303
Paul Elliott59200a22023-02-21 15:07:40 +00003304 psa_wipe_tag_output_buffer(signature, status, signature_size,
3305 *signature_length);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003306
Paul Elliott53bb3122023-02-10 14:22:22 +00003307 if (status != PSA_OPERATION_INCOMPLETE) {
Paul Elliottc9774412023-02-06 15:14:07 +00003308 if (status != PSA_SUCCESS) {
3309 operation->error_occurred = 1;
3310 }
3311
Paul Elliott59ad9452022-12-18 15:09:02 +00003312 psa_sign_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003313 }
3314
3315 return status;
3316}
3317
3318psa_status_t psa_sign_hash_abort(
3319 psa_sign_hash_interruptible_operation_t *operation)
3320{
Paul Elliott59ad9452022-12-18 15:09:02 +00003321 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3322
3323 status = psa_sign_hash_abort_internal(operation);
3324
3325 /* We clear the number of ops done here, so that it is not cleared when
3326 * the operation fails or succeeds, only on manual abort. */
3327 operation->num_ops = 0;
3328
Paul Elliottc9774412023-02-06 15:14:07 +00003329 /* Likewise, failure state. */
3330 operation->error_occurred = 0;
3331
Paul Elliott59ad9452022-12-18 15:09:02 +00003332 return status;
3333}
3334
3335static psa_status_t psa_verify_hash_abort_internal(
3336 psa_verify_hash_interruptible_operation_t *operation)
3337{
Paul Elliott9fe12f62022-11-30 19:16:02 +00003338 if (operation->id == 0) {
3339 /* The object has (apparently) been initialized but it is not (yet)
3340 * in use. It's ok to call abort on such an object, and there's
3341 * nothing to do. */
3342 return PSA_SUCCESS;
3343 }
3344
Paul Elliott59ad9452022-12-18 15:09:02 +00003345 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3346
3347 status = psa_driver_wrapper_verify_hash_abort(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003348
3349 operation->id = 0;
3350
Paul Elliotte6145dc2023-02-07 12:51:21 +00003351 /* Do not clear either the error_occurred or num_ops elements here as they
3352 * only want to be cleared by the application calling abort, not by abort
3353 * being called at completion of an operation. */
3354
Paul Elliott59ad9452022-12-18 15:09:02 +00003355 return status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003356}
3357
3358psa_status_t psa_verify_hash_start(
3359 psa_verify_hash_interruptible_operation_t *operation,
3360 mbedtls_svc_key_id_t key, psa_algorithm_t alg,
3361 const uint8_t *hash, size_t hash_length,
3362 const uint8_t *signature, size_t signature_length)
3363{
3364 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3365 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3366 psa_key_slot_t *slot;
3367
Paul Elliottc9774412023-02-06 15:14:07 +00003368 /* Check that start has not been previously called, or operation has not
3369 * previously errored. */
3370 if (operation->id != 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003371 return PSA_ERROR_BAD_STATE;
3372 }
3373
3374 status = psa_sign_verify_check_alg(0, alg);
3375 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003376 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003377 return status;
3378 }
3379
3380 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
3381 PSA_KEY_USAGE_VERIFY_HASH,
3382 alg);
3383
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 psa_key_attributes_t attributes = {
3390 .core = slot->attr
3391 };
3392
Paul Elliott296ede92022-12-15 17:00:30 +00003393 /* Ensure ops count gets reset, in case of operation re-use. */
3394 operation->num_ops = 0;
3395
Paul Elliott9fe12f62022-11-30 19:16:02 +00003396 status = psa_driver_wrapper_verify_hash_start(operation, &attributes,
3397 slot->key.data,
3398 slot->key.bytes,
3399 alg, hash, hash_length,
3400 signature, signature_length);
3401
3402 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003403 operation->error_occurred = 1;
Paul Elliott59ad9452022-12-18 15:09:02 +00003404 psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003405 }
3406
Ryan Everett1b70a072024-01-04 10:32:49 +00003407 unlock_status = psa_unregister_read(slot);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003408
Paul Elliottc9774412023-02-06 15:14:07 +00003409 if (unlock_status != PSA_SUCCESS) {
3410 operation->error_occurred = 1;
3411 }
Paul Elliott9fe12f62022-11-30 19:16:02 +00003412
Paul Elliottc9774412023-02-06 15:14:07 +00003413 return (status == PSA_SUCCESS) ? unlock_status : status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003414}
3415
3416psa_status_t psa_verify_hash_complete(
3417 psa_verify_hash_interruptible_operation_t *operation)
3418{
3419 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3420
Paul Elliottc9774412023-02-06 15:14:07 +00003421 /* Check that start has been called first, and that operation has not
3422 * previously errored. */
3423 if (operation->id == 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003424 status = PSA_ERROR_BAD_STATE;
3425 goto exit;
3426 }
3427
3428 status = psa_driver_wrapper_verify_hash_complete(operation);
3429
Paul Elliott296ede92022-12-15 17:00:30 +00003430 /* Update ops count with work done. */
Paul Elliottde1114c2023-02-07 12:43:11 +00003431 operation->num_ops = psa_driver_wrapper_verify_hash_get_num_ops(
Paul Elliott296ede92022-12-15 17:00:30 +00003432 operation);
3433
Paul Elliottebe225c2023-02-10 14:32:53 +00003434exit:
3435
Paul Elliott9fe12f62022-11-30 19:16:02 +00003436 if (status != PSA_OPERATION_INCOMPLETE) {
Paul Elliottc9774412023-02-06 15:14:07 +00003437 if (status != PSA_SUCCESS) {
3438 operation->error_occurred = 1;
3439 }
3440
Paul Elliott59ad9452022-12-18 15:09:02 +00003441 psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003442 }
3443
3444 return status;
3445}
3446
3447psa_status_t psa_verify_hash_abort(
3448 psa_verify_hash_interruptible_operation_t *operation)
3449{
Paul Elliott59ad9452022-12-18 15:09:02 +00003450 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003451
Paul Elliott59ad9452022-12-18 15:09:02 +00003452 status = psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003453
Paul Elliott59ad9452022-12-18 15:09:02 +00003454 /* We clear the number of ops done here, so that it is not cleared when
3455 * the operation fails or succeeds, only on manual abort. */
3456 operation->num_ops = 0;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003457
Paul Elliottc9774412023-02-06 15:14:07 +00003458 /* Likewise, failure state. */
3459 operation->error_occurred = 0;
3460
Paul Elliott59ad9452022-12-18 15:09:02 +00003461 return status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003462}
3463
Paul Elliott588f8ed2022-12-02 18:10:26 +00003464/****************************************************************/
3465/* Asymmetric interruptible cryptography internal */
3466/* implementations */
3467/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003468
Paul Elliott588f8ed2022-12-02 18:10:26 +00003469void mbedtls_psa_interruptible_set_max_ops(uint32_t max_ops)
3470{
Paul Elliott7cc4e812023-01-10 17:14:11 +00003471
Paul Elliott588f8ed2022-12-02 18:10:26 +00003472#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3473 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3474 defined(MBEDTLS_ECP_RESTARTABLE)
3475
3476 /* Internal implementation uses zero to indicate infinite number max ops,
3477 * therefore avoid this value, and set to minimum possible. */
3478 if (max_ops == 0) {
3479 max_ops = 1;
3480 }
3481
Paul Elliott588f8ed2022-12-02 18:10:26 +00003482 mbedtls_ecp_set_max_ops(max_ops);
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003483#else
3484 (void) max_ops;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003485#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3486 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3487 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3488}
3489
Paul Elliott588f8ed2022-12-02 18:10:26 +00003490uint32_t mbedtls_psa_sign_hash_get_num_ops(
Paul Elliottf8e5b562023-02-19 18:43:45 +00003491 const mbedtls_psa_sign_hash_interruptible_operation_t *operation)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003492{
3493#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3494 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3495 defined(MBEDTLS_ECP_RESTARTABLE)
3496
Paul Elliott93d9ca82023-02-15 18:14:21 +00003497 return operation->num_ops;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003498#else
3499 (void) operation;
3500 return 0;
3501#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3502 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3503 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3504}
3505
3506uint32_t mbedtls_psa_verify_hash_get_num_ops(
Paul Elliottf8e5b562023-02-19 18:43:45 +00003507 const mbedtls_psa_verify_hash_interruptible_operation_t *operation)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003508{
3509 #if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3510 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3511 defined(MBEDTLS_ECP_RESTARTABLE)
3512
Paul Elliott93d9ca82023-02-15 18:14:21 +00003513 return operation->num_ops;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003514#else
3515 (void) operation;
3516 return 0;
3517#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3518 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3519 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3520}
3521
3522psa_status_t mbedtls_psa_sign_hash_start(
3523 mbedtls_psa_sign_hash_interruptible_operation_t *operation,
3524 const psa_key_attributes_t *attributes, const uint8_t *key_buffer,
3525 size_t key_buffer_size, psa_algorithm_t alg,
3526 const uint8_t *hash, size_t hash_length)
3527{
3528 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott0290a762023-02-09 14:30:24 +00003529 size_t required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003530
Paul Elliott068fe072023-01-16 13:59:15 +00003531 if (!PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3532 return PSA_ERROR_NOT_SUPPORTED;
3533 }
3534
3535 if (!PSA_ALG_IS_ECDSA(alg)) {
Paul Elliott813f9cd2023-02-05 15:28:46 +00003536 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott068fe072023-01-16 13:59:15 +00003537 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003538
3539#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Paul Elliott068fe072023-01-16 13:59:15 +00003540 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3541 defined(MBEDTLS_ECP_RESTARTABLE)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003542
Paul Elliotta1c94092023-02-15 16:38:04 +00003543 mbedtls_ecdsa_restart_init(&operation->restart_ctx);
3544
Paul Elliott93d9ca82023-02-15 18:14:21 +00003545 /* Ensure num_ops is zero'ed in case of context re-use. */
3546 operation->num_ops = 0;
3547
Paul Elliott068fe072023-01-16 13:59:15 +00003548 status = mbedtls_psa_ecp_load_representation(attributes->core.type,
3549 attributes->core.bits,
3550 key_buffer,
3551 key_buffer_size,
3552 &operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003553
Paul Elliott068fe072023-01-16 13:59:15 +00003554 if (status != PSA_SUCCESS) {
3555 return status;
3556 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003557
Paul Elliott1bc59df2023-02-05 13:41:57 +00003558 operation->coordinate_bytes = PSA_BITS_TO_BYTES(
Paul Elliottc569fc22023-02-10 13:02:54 +00003559 operation->ctx->grp.nbits);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003560
Paul Elliott068fe072023-01-16 13:59:15 +00003561 psa_algorithm_t hash_alg = PSA_ALG_SIGN_GET_HASH(alg);
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02003562 operation->md_alg = mbedtls_md_type_from_psa_alg(hash_alg);
Paul Elliott068fe072023-01-16 13:59:15 +00003563 operation->alg = alg;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003564
Paul Elliott0290a762023-02-09 14:30:24 +00003565 /* We only need to store the same length of hash as the private key size
3566 * here, it would be truncated by the internal implementation anyway. */
3567 required_hash_length = (hash_length < operation->coordinate_bytes ?
3568 hash_length : operation->coordinate_bytes);
3569
Paul Elliottba70ad42023-02-15 18:23:53 +00003570 if (required_hash_length > sizeof(operation->hash)) {
3571 /* Shouldn't happen, but better safe than sorry. */
3572 return PSA_ERROR_CORRUPTION_DETECTED;
3573 }
3574
Paul Elliott0290a762023-02-09 14:30:24 +00003575 memcpy(operation->hash, hash, required_hash_length);
3576 operation->hash_length = required_hash_length;
Paul Elliott068fe072023-01-16 13:59:15 +00003577
3578 return PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003579
3580#else
Paul Elliott068fe072023-01-16 13:59:15 +00003581 (void) operation;
3582 (void) key_buffer;
3583 (void) key_buffer_size;
3584 (void) alg;
3585 (void) hash;
3586 (void) hash_length;
3587 (void) status;
Paul Elliott0290a762023-02-09 14:30:24 +00003588 (void) required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003589
Paul Elliott068fe072023-01-16 13:59:15 +00003590 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003591#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3592 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3593 * defined( MBEDTLS_ECP_RESTARTABLE ) */
Paul Elliott588f8ed2022-12-02 18:10:26 +00003594}
3595
3596psa_status_t mbedtls_psa_sign_hash_complete(
3597 mbedtls_psa_sign_hash_interruptible_operation_t *operation,
3598 uint8_t *signature, size_t signature_size,
3599 size_t *signature_length)
3600{
Paul Elliott588f8ed2022-12-02 18:10:26 +00003601#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3602 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3603 defined(MBEDTLS_ECP_RESTARTABLE)
3604
Paul Elliotta1c94092023-02-15 16:38:04 +00003605 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott1243f932023-02-07 11:21:10 +00003606 mbedtls_mpi r;
3607 mbedtls_mpi s;
3608
Paul Elliott46845252023-02-03 14:59:11 +00003609 mbedtls_mpi_init(&r);
3610 mbedtls_mpi_init(&s);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003611
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003612 /* Ensure max_ops is set to the current value (or default). */
3613 mbedtls_psa_interruptible_set_max_ops(psa_interruptible_get_max_ops());
3614
Paul Elliotta1c94092023-02-15 16:38:04 +00003615 if (signature_size < 2 * operation->coordinate_bytes) {
3616 status = PSA_ERROR_BUFFER_TOO_SMALL;
3617 goto exit;
3618 }
3619
Paul Elliott588f8ed2022-12-02 18:10:26 +00003620 if (PSA_ALG_ECDSA_IS_DETERMINISTIC(operation->alg)) {
Paul Elliott46845252023-02-03 14:59:11 +00003621
Paul Elliott588f8ed2022-12-02 18:10:26 +00003622#if defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3623 status = mbedtls_to_psa_error(
3624 mbedtls_ecdsa_sign_det_restartable(&operation->ctx->grp,
Paul Elliott46845252023-02-03 14:59:11 +00003625 &r,
3626 &s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003627 &operation->ctx->d,
3628 operation->hash,
3629 operation->hash_length,
3630 operation->md_alg,
3631 mbedtls_psa_get_random,
3632 MBEDTLS_PSA_RANDOM_STATE,
3633 &operation->restart_ctx));
3634#else /* defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Paul Elliott724bd252023-02-08 12:35:08 +00003635 status = PSA_ERROR_NOT_SUPPORTED;
3636 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003637#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
3638 } else {
Paul Elliott588f8ed2022-12-02 18:10:26 +00003639 status = mbedtls_to_psa_error(
3640 mbedtls_ecdsa_sign_restartable(&operation->ctx->grp,
Paul Elliott46845252023-02-03 14:59:11 +00003641 &r,
3642 &s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003643 &operation->ctx->d,
3644 operation->hash,
3645 operation->hash_length,
3646 mbedtls_psa_get_random,
3647 MBEDTLS_PSA_RANDOM_STATE,
3648 mbedtls_psa_get_random,
3649 MBEDTLS_PSA_RANDOM_STATE,
3650 &operation->restart_ctx));
3651 }
3652
Paul Elliottf8e5b562023-02-19 18:43:45 +00003653 /* Hide the fact that the restart context only holds a delta of number of
3654 * ops done during the last operation, not an absolute value. */
3655 operation->num_ops += operation->restart_ctx.ecp.ops_done;
3656
Paul Elliott724bd252023-02-08 12:35:08 +00003657 if (status == PSA_SUCCESS) {
Paul Elliott588f8ed2022-12-02 18:10:26 +00003658 status = mbedtls_to_psa_error(
Paul Elliott46845252023-02-03 14:59:11 +00003659 mbedtls_mpi_write_binary(&r,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003660 signature,
Paul Elliott1bc59df2023-02-05 13:41:57 +00003661 operation->coordinate_bytes)
3662 );
Paul Elliott588f8ed2022-12-02 18:10:26 +00003663
3664 if (status != PSA_SUCCESS) {
Paul Elliott724bd252023-02-08 12:35:08 +00003665 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003666 }
3667
3668 status = mbedtls_to_psa_error(
Paul Elliott46845252023-02-03 14:59:11 +00003669 mbedtls_mpi_write_binary(&s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003670 signature +
Paul Elliott1bc59df2023-02-05 13:41:57 +00003671 operation->coordinate_bytes,
3672 operation->coordinate_bytes)
3673 );
Paul Elliott588f8ed2022-12-02 18:10:26 +00003674
3675 if (status != PSA_SUCCESS) {
Paul Elliott724bd252023-02-08 12:35:08 +00003676 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003677 }
3678
Paul Elliott1bc59df2023-02-05 13:41:57 +00003679 *signature_length = operation->coordinate_bytes * 2;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003680
Paul Elliott724bd252023-02-08 12:35:08 +00003681 status = PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003682 }
Paul Elliott724bd252023-02-08 12:35:08 +00003683
3684exit:
3685
3686 mbedtls_mpi_free(&r);
3687 mbedtls_mpi_free(&s);
3688 return status;
3689
Paul Elliott588f8ed2022-12-02 18:10:26 +00003690 #else
3691
3692 (void) operation;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003693 (void) signature;
3694 (void) signature_size;
3695 (void) signature_length;
3696
3697 return PSA_ERROR_NOT_SUPPORTED;
3698
3699#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3700 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3701 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3702}
3703
3704psa_status_t mbedtls_psa_sign_hash_abort(
3705 mbedtls_psa_sign_hash_interruptible_operation_t *operation)
3706{
3707
3708#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3709 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3710 defined(MBEDTLS_ECP_RESTARTABLE)
3711
3712 if (operation->ctx) {
3713 mbedtls_ecdsa_free(operation->ctx);
3714 mbedtls_free(operation->ctx);
Paul Elliottf9c91a72023-02-05 18:06:38 +00003715 operation->ctx = NULL;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003716 }
3717
3718 mbedtls_ecdsa_restart_free(&operation->restart_ctx);
3719
Paul Elliott93d9ca82023-02-15 18:14:21 +00003720 operation->num_ops = 0;
3721
Paul Elliott588f8ed2022-12-02 18:10:26 +00003722 return PSA_SUCCESS;
3723
3724#else
3725
3726 (void) operation;
3727
3728 return PSA_ERROR_NOT_SUPPORTED;
3729
3730#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3731 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3732 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3733}
3734
3735psa_status_t mbedtls_psa_verify_hash_start(
3736 mbedtls_psa_verify_hash_interruptible_operation_t *operation,
3737 const psa_key_attributes_t *attributes,
3738 const uint8_t *key_buffer, size_t key_buffer_size,
3739 psa_algorithm_t alg,
3740 const uint8_t *hash, size_t hash_length,
3741 const uint8_t *signature, size_t signature_length)
3742{
3743 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott1bc59df2023-02-05 13:41:57 +00003744 size_t coordinate_bytes = 0;
Paul Elliott0290a762023-02-09 14:30:24 +00003745 size_t required_hash_length = 0;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003746
Paul Elliott068fe072023-01-16 13:59:15 +00003747 if (!PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3748 return PSA_ERROR_NOT_SUPPORTED;
3749 }
3750
3751 if (!PSA_ALG_IS_ECDSA(alg)) {
Paul Elliott813f9cd2023-02-05 15:28:46 +00003752 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott068fe072023-01-16 13:59:15 +00003753 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003754
3755#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Paul Elliott068fe072023-01-16 13:59:15 +00003756 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3757 defined(MBEDTLS_ECP_RESTARTABLE)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003758
Paul Elliotta1c94092023-02-15 16:38:04 +00003759 mbedtls_ecdsa_restart_init(&operation->restart_ctx);
3760 mbedtls_mpi_init(&operation->r);
3761 mbedtls_mpi_init(&operation->s);
3762
Paul Elliott93d9ca82023-02-15 18:14:21 +00003763 /* Ensure num_ops is zero'ed in case of context re-use. */
3764 operation->num_ops = 0;
3765
Paul Elliott068fe072023-01-16 13:59:15 +00003766 status = mbedtls_psa_ecp_load_representation(attributes->core.type,
3767 attributes->core.bits,
3768 key_buffer,
3769 key_buffer_size,
3770 &operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003771
Paul Elliott068fe072023-01-16 13:59:15 +00003772 if (status != PSA_SUCCESS) {
3773 return status;
3774 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003775
Paul Elliottc569fc22023-02-10 13:02:54 +00003776 coordinate_bytes = PSA_BITS_TO_BYTES(operation->ctx->grp.nbits);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003777
Paul Elliott1bc59df2023-02-05 13:41:57 +00003778 if (signature_length != 2 * coordinate_bytes) {
Paul Elliott068fe072023-01-16 13:59:15 +00003779 return PSA_ERROR_INVALID_SIGNATURE;
3780 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003781
Paul Elliott068fe072023-01-16 13:59:15 +00003782 status = mbedtls_to_psa_error(
3783 mbedtls_mpi_read_binary(&operation->r,
3784 signature,
Paul Elliott1bc59df2023-02-05 13:41:57 +00003785 coordinate_bytes));
Paul Elliott588f8ed2022-12-02 18:10:26 +00003786
Paul Elliott068fe072023-01-16 13:59:15 +00003787 if (status != PSA_SUCCESS) {
3788 return status;
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->s,
3793 signature +
Paul Elliott1bc59df2023-02-05 13:41:57 +00003794 coordinate_bytes,
3795 coordinate_bytes));
Paul Elliott588f8ed2022-12-02 18:10:26 +00003796
Paul Elliott068fe072023-01-16 13:59:15 +00003797 if (status != PSA_SUCCESS) {
3798 return status;
3799 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003800
Paul Elliott2c9843f2023-02-15 17:32:42 +00003801 status = mbedtls_psa_ecp_load_public_part(operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003802
Paul Elliott2c9843f2023-02-15 17:32:42 +00003803 if (status != PSA_SUCCESS) {
3804 return status;
Paul Elliott068fe072023-01-16 13:59:15 +00003805 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003806
Paul Elliott0290a762023-02-09 14:30:24 +00003807 /* We only need to store the same length of hash as the private key size
3808 * here, it would be truncated by the internal implementation anyway. */
3809 required_hash_length = (hash_length < coordinate_bytes ? hash_length :
3810 coordinate_bytes);
3811
Paul Elliottba70ad42023-02-15 18:23:53 +00003812 if (required_hash_length > sizeof(operation->hash)) {
3813 /* Shouldn't happen, but better safe than sorry. */
3814 return PSA_ERROR_CORRUPTION_DETECTED;
3815 }
3816
Paul Elliott0290a762023-02-09 14:30:24 +00003817 memcpy(operation->hash, hash, required_hash_length);
3818 operation->hash_length = required_hash_length;
Paul Elliott068fe072023-01-16 13:59:15 +00003819
3820 return PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003821#else
Paul Elliott068fe072023-01-16 13:59:15 +00003822 (void) operation;
3823 (void) key_buffer;
3824 (void) key_buffer_size;
3825 (void) alg;
3826 (void) hash;
3827 (void) hash_length;
3828 (void) signature;
3829 (void) signature_length;
3830 (void) status;
Paul Elliott1243f932023-02-07 11:21:10 +00003831 (void) coordinate_bytes;
Paul Elliott0290a762023-02-09 14:30:24 +00003832 (void) required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003833
Paul Elliott068fe072023-01-16 13:59:15 +00003834 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003835#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3836 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3837 * defined( MBEDTLS_ECP_RESTARTABLE ) */
Paul Elliott588f8ed2022-12-02 18:10:26 +00003838}
3839
3840psa_status_t mbedtls_psa_verify_hash_complete(
3841 mbedtls_psa_verify_hash_interruptible_operation_t *operation)
3842{
3843
3844#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3845 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3846 defined(MBEDTLS_ECP_RESTARTABLE)
3847
Paul Elliottf8e5b562023-02-19 18:43:45 +00003848 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3849
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003850 /* Ensure max_ops is set to the current value (or default). */
3851 mbedtls_psa_interruptible_set_max_ops(psa_interruptible_get_max_ops());
3852
Paul Elliottf8e5b562023-02-19 18:43:45 +00003853 status = mbedtls_to_psa_error(
Paul Elliott588f8ed2022-12-02 18:10:26 +00003854 mbedtls_ecdsa_verify_restartable(&operation->ctx->grp,
3855 operation->hash,
3856 operation->hash_length,
3857 &operation->ctx->Q,
3858 &operation->r,
3859 &operation->s,
3860 &operation->restart_ctx));
3861
Paul Elliottf8e5b562023-02-19 18:43:45 +00003862 /* Hide the fact that the restart context only holds a delta of number of
3863 * ops done during the last operation, not an absolute value. */
3864 operation->num_ops += operation->restart_ctx.ecp.ops_done;
3865
3866 return status;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003867#else
3868 (void) operation;
3869
3870 return PSA_ERROR_NOT_SUPPORTED;
3871
3872#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3873 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3874 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3875}
3876
3877psa_status_t mbedtls_psa_verify_hash_abort(
3878 mbedtls_psa_verify_hash_interruptible_operation_t *operation)
3879{
3880
3881#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3882 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3883 defined(MBEDTLS_ECP_RESTARTABLE)
3884
3885 if (operation->ctx) {
3886 mbedtls_ecdsa_free(operation->ctx);
3887 mbedtls_free(operation->ctx);
Paul Elliottf9c91a72023-02-05 18:06:38 +00003888 operation->ctx = NULL;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003889 }
3890
3891 mbedtls_ecdsa_restart_free(&operation->restart_ctx);
3892
Paul Elliott93d9ca82023-02-15 18:14:21 +00003893 operation->num_ops = 0;
3894
Paul Elliott588f8ed2022-12-02 18:10:26 +00003895 mbedtls_mpi_free(&operation->r);
3896 mbedtls_mpi_free(&operation->s);
3897
3898 return PSA_SUCCESS;
3899
3900#else
3901 (void) operation;
3902
3903 return PSA_ERROR_NOT_SUPPORTED;
3904
3905#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3906 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3907 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3908}
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003909
mohammad1603503973b2018-03-12 15:59:30 +02003910/****************************************************************/
3911/* Symmetric cryptography */
3912/****************************************************************/
3913
Gilles Peskine449bd832023-01-11 14:50:10 +01003914static psa_status_t psa_cipher_setup(psa_cipher_operation_t *operation,
3915 mbedtls_svc_key_id_t key,
3916 psa_algorithm_t alg,
3917 mbedtls_operation_t cipher_operation)
Ronald Cronab99ac22020-10-01 16:38:28 +02003918{
3919 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3920 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman54648242021-06-24 11:49:45 +01003921 psa_key_slot_t *slot = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01003922 psa_key_usage_t usage = (cipher_operation == MBEDTLS_ENCRYPT ?
3923 PSA_KEY_USAGE_ENCRYPT :
3924 PSA_KEY_USAGE_DECRYPT);
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003925 psa_key_attributes_t attributes;
Ronald Cronab99ac22020-10-01 16:38:28 +02003926
3927 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003928 if (operation->id != 0) {
Dave Rodgman54648242021-06-24 11:49:45 +01003929 status = PSA_ERROR_BAD_STATE;
3930 goto exit;
3931 }
Ronald Cronab99ac22020-10-01 16:38:28 +02003932
Gilles Peskine449bd832023-01-11 14:50:10 +01003933 if (!PSA_ALG_IS_CIPHER(alg)) {
Dave Rodgman54648242021-06-24 11:49:45 +01003934 status = PSA_ERROR_INVALID_ARGUMENT;
3935 goto exit;
3936 }
Ronald Cronab99ac22020-10-01 16:38:28 +02003937
Gilles Peskine449bd832023-01-11 14:50:10 +01003938 status = psa_get_and_lock_key_slot_with_policy(key, &slot, usage, alg);
3939 if (status != PSA_SUCCESS) {
Ronald Cronab99ac22020-10-01 16:38:28 +02003940 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01003941 }
Ronald Cronab99ac22020-10-01 16:38:28 +02003942
Ronald Cron49fafa92021-03-10 08:34:23 +01003943 /* Initialize the operation struct members, except for id. The id member
Ronald Cronab99ac22020-10-01 16:38:28 +02003944 * is used to indicate to psa_cipher_abort that there are resources to free,
Ronald Cron49fafa92021-03-10 08:34:23 +01003945 * so we only set it (in the driver wrapper) after resources have been
3946 * allocated/initialized. */
Ronald Cronab99ac22020-10-01 16:38:28 +02003947 operation->iv_set = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01003948 if (alg == PSA_ALG_ECB_NO_PADDING) {
Ronald Cronab99ac22020-10-01 16:38:28 +02003949 operation->iv_required = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01003950 } else {
Ronald Cronab99ac22020-10-01 16:38:28 +02003951 operation->iv_required = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003952 }
3953 operation->default_iv_length = PSA_CIPHER_IV_LENGTH(slot->attr.type, alg);
Ronald Cronab99ac22020-10-01 16:38:28 +02003954
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003955 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01003956 .core = slot->attr
Ronald Crona4af55f2020-12-14 14:36:06 +01003957 };
3958
Ronald Cronab99ac22020-10-01 16:38:28 +02003959 /* Try doing the operation through a driver before using software fallback. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003960 if (cipher_operation == MBEDTLS_ENCRYPT) {
3961 status = psa_driver_wrapper_cipher_encrypt_setup(operation,
3962 &attributes,
3963 slot->key.data,
3964 slot->key.bytes,
3965 alg);
3966 } else {
3967 status = psa_driver_wrapper_cipher_decrypt_setup(operation,
3968 &attributes,
3969 slot->key.data,
3970 slot->key.bytes,
3971 alg);
3972 }
Ronald Cronab99ac22020-10-01 16:38:28 +02003973
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003974exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01003975 if (status != PSA_SUCCESS) {
3976 psa_cipher_abort(operation);
3977 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003978
Ryan Everett1b70a072024-01-04 10:32:49 +00003979 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003980
Gilles Peskine449bd832023-01-11 14:50:10 +01003981 return (status == PSA_SUCCESS) ? unlock_status : status;
mohammad1603503973b2018-03-12 15:59:30 +02003982}
3983
Gilles Peskine449bd832023-01-11 14:50:10 +01003984psa_status_t psa_cipher_encrypt_setup(psa_cipher_operation_t *operation,
3985 mbedtls_svc_key_id_t key,
3986 psa_algorithm_t alg)
mohammad16038481e742018-03-18 13:57:31 +02003987{
Gilles Peskine449bd832023-01-11 14:50:10 +01003988 return psa_cipher_setup(operation, key, alg, MBEDTLS_ENCRYPT);
mohammad16038481e742018-03-18 13:57:31 +02003989}
3990
Gilles Peskine449bd832023-01-11 14:50:10 +01003991psa_status_t psa_cipher_decrypt_setup(psa_cipher_operation_t *operation,
3992 mbedtls_svc_key_id_t key,
3993 psa_algorithm_t alg)
mohammad16038481e742018-03-18 13:57:31 +02003994{
Gilles Peskine449bd832023-01-11 14:50:10 +01003995 return psa_cipher_setup(operation, key, alg, MBEDTLS_DECRYPT);
mohammad16038481e742018-03-18 13:57:31 +02003996}
3997
Gilles Peskine449bd832023-01-11 14:50:10 +01003998psa_status_t psa_cipher_generate_iv(psa_cipher_operation_t *operation,
3999 uint8_t *iv,
4000 size_t iv_size,
4001 size_t *iv_length)
mohammad1603503973b2018-03-12 15:59:30 +02004002{
Ronald Cron6d051732020-10-01 14:10:20 +02004003 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2fb90522021-07-05 12:31:44 +02004004 uint8_t local_iv[PSA_CIPHER_IV_MAX_SIZE];
Sergeybef1f632023-03-06 15:25:06 -07004005 size_t default_iv_length = 0;
Ronald Cron5618a392021-03-26 09:52:26 +01004006
Gilles Peskine449bd832023-01-11 14:50:10 +01004007 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004008 status = PSA_ERROR_BAD_STATE;
4009 goto exit;
Ronald Cronc45b4af2020-09-29 16:18:05 +02004010 }
4011
Gilles Peskine449bd832023-01-11 14:50:10 +01004012 if (operation->iv_set || !operation->iv_required) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004013 status = PSA_ERROR_BAD_STATE;
4014 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004015 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004016
Ronald Cron2fb90522021-07-05 12:31:44 +02004017 default_iv_length = operation->default_iv_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01004018 if (iv_size < default_iv_length) {
Ronald Cron5618a392021-03-26 09:52:26 +01004019 status = PSA_ERROR_BUFFER_TOO_SMALL;
4020 goto exit;
4021 }
Gilles Peskinee553c652018-06-04 16:22:46 +02004022
Gilles Peskine449bd832023-01-11 14:50:10 +01004023 if (default_iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Ronald Cron2fb90522021-07-05 12:31:44 +02004024 status = PSA_ERROR_GENERIC_ERROR;
4025 goto exit;
4026 }
4027
Gilles Peskine449bd832023-01-11 14:50:10 +01004028 status = psa_generate_random(local_iv, default_iv_length);
4029 if (status != PSA_SUCCESS) {
Ronald Cron5618a392021-03-26 09:52:26 +01004030 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004031 }
Ronald Cron5618a392021-03-26 09:52:26 +01004032
Gilles Peskine449bd832023-01-11 14:50:10 +01004033 status = psa_driver_wrapper_cipher_set_iv(operation,
4034 local_iv, default_iv_length);
Ronald Cron5618a392021-03-26 09:52:26 +01004035
4036exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004037 if (status == PSA_SUCCESS) {
4038 memcpy(iv, local_iv, default_iv_length);
Ronald Cron2fb90522021-07-05 12:31:44 +02004039 *iv_length = default_iv_length;
Steven Cooreman7df02922020-09-09 15:28:49 +02004040 operation->iv_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004041 } else {
Ronald Cron2fb90522021-07-05 12:31:44 +02004042 *iv_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004043 psa_cipher_abort(operation);
Ronald Cron2fb90522021-07-05 12:31:44 +02004044 }
Ronald Cron6d051732020-10-01 14:10:20 +02004045
Gilles Peskine449bd832023-01-11 14:50:10 +01004046 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004047}
4048
Gilles Peskine449bd832023-01-11 14:50:10 +01004049psa_status_t psa_cipher_set_iv(psa_cipher_operation_t *operation,
4050 const uint8_t *iv,
4051 size_t iv_length)
mohammad1603503973b2018-03-12 15:59:30 +02004052{
Ronald Cron6d051732020-10-01 14:10:20 +02004053 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronc45b4af2020-09-29 16:18:05 +02004054
Gilles Peskine449bd832023-01-11 14:50:10 +01004055 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004056 status = PSA_ERROR_BAD_STATE;
4057 goto exit;
4058 }
Ronald Cronc45b4af2020-09-29 16:18:05 +02004059
Gilles Peskine449bd832023-01-11 14:50:10 +01004060 if (operation->iv_set || !operation->iv_required) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004061 status = PSA_ERROR_BAD_STATE;
4062 goto exit;
4063 }
Ronald Crona0d68172021-03-26 10:15:08 +01004064
Gilles Peskine449bd832023-01-11 14:50:10 +01004065 if (iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004066 status = PSA_ERROR_INVALID_ARGUMENT;
4067 goto exit;
4068 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004069
Gilles Peskine449bd832023-01-11 14:50:10 +01004070 status = psa_driver_wrapper_cipher_set_iv(operation,
4071 iv,
4072 iv_length);
Steven Cooremand3feccd2020-09-01 15:56:14 +02004073
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004074exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004075 if (status == PSA_SUCCESS) {
itayzafrir534bd7c2018-08-02 13:56:32 +03004076 operation->iv_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004077 } else {
4078 psa_cipher_abort(operation);
4079 }
4080 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004081}
4082
Gilles Peskine449bd832023-01-11 14:50:10 +01004083psa_status_t psa_cipher_update(psa_cipher_operation_t *operation,
4084 const uint8_t *input,
4085 size_t input_length,
4086 uint8_t *output,
4087 size_t output_size,
4088 size_t *output_length)
mohammad1603503973b2018-03-12 15:59:30 +02004089{
Steven Cooremanffecb7b2020-08-25 15:13:13 +02004090 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron6d051732020-10-01 14:10:20 +02004091
Gilles Peskine449bd832023-01-11 14:50:10 +01004092 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004093 status = PSA_ERROR_BAD_STATE;
4094 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004095 }
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004096
Gilles Peskine449bd832023-01-11 14:50:10 +01004097 if (operation->iv_required && !operation->iv_set) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004098 status = PSA_ERROR_BAD_STATE;
4099 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004100 }
Jaeden Ameroab439972019-02-15 14:12:05 +00004101
Gilles Peskine449bd832023-01-11 14:50:10 +01004102 status = psa_driver_wrapper_cipher_update(operation,
4103 input,
4104 input_length,
4105 output,
4106 output_size,
4107 output_length);
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004108
4109exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004110 if (status != PSA_SUCCESS) {
4111 psa_cipher_abort(operation);
4112 }
Ronald Cron6d051732020-10-01 14:10:20 +02004113
Gilles Peskine449bd832023-01-11 14:50:10 +01004114 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004115}
4116
Gilles Peskine449bd832023-01-11 14:50:10 +01004117psa_status_t psa_cipher_finish(psa_cipher_operation_t *operation,
4118 uint8_t *output,
4119 size_t output_size,
4120 size_t *output_length)
mohammad1603503973b2018-03-12 15:59:30 +02004121{
David Saadab4ecc272019-02-14 13:48:10 +02004122 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Ronald Cron6d051732020-10-01 14:10:20 +02004123
Gilles Peskine449bd832023-01-11 14:50:10 +01004124 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004125 status = PSA_ERROR_BAD_STATE;
4126 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004127 }
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004128
Gilles Peskine449bd832023-01-11 14:50:10 +01004129 if (operation->iv_required && !operation->iv_set) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004130 status = PSA_ERROR_BAD_STATE;
4131 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004132 }
Moran Pekerbed71a22018-04-22 20:19:20 +03004133
Gilles Peskine449bd832023-01-11 14:50:10 +01004134 status = psa_driver_wrapper_cipher_finish(operation,
4135 output,
4136 output_size,
4137 output_length);
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004138
4139exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004140 if (status == PSA_SUCCESS) {
4141 return psa_cipher_abort(operation);
4142 } else {
Steven Cooremanef8575e2020-09-11 11:44:50 +02004143 *output_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004144 (void) psa_cipher_abort(operation);
Janos Follath315b51c2018-07-09 16:04:51 +01004145
Gilles Peskine449bd832023-01-11 14:50:10 +01004146 return status;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004147 }
mohammad1603503973b2018-03-12 15:59:30 +02004148}
4149
Gilles Peskine449bd832023-01-11 14:50:10 +01004150psa_status_t psa_cipher_abort(psa_cipher_operation_t *operation)
Gilles Peskinee553c652018-06-04 16:22:46 +02004151{
Gilles Peskine449bd832023-01-11 14:50:10 +01004152 if (operation->id == 0) {
Steven Cooremana07b9972020-09-10 14:54:14 +02004153 /* The object has (apparently) been initialized but it is not (yet)
Gilles Peskine81736312018-06-26 15:04:31 +02004154 * in use. It's ok to call abort on such an object, and there's
4155 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004156 return PSA_SUCCESS;
Gilles Peskine81736312018-06-26 15:04:31 +02004157 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004158
Gilles Peskine449bd832023-01-11 14:50:10 +01004159 psa_driver_wrapper_cipher_abort(operation);
Gilles Peskinee553c652018-06-04 16:22:46 +02004160
Ronald Cron49fafa92021-03-10 08:34:23 +01004161 operation->id = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004162 operation->iv_set = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004163 operation->iv_required = 0;
Moran Peker41deec42018-04-04 15:43:05 +03004164
Gilles Peskine449bd832023-01-11 14:50:10 +01004165 return PSA_SUCCESS;
mohammad1603503973b2018-03-12 15:59:30 +02004166}
4167
Gilles Peskine449bd832023-01-11 14:50:10 +01004168psa_status_t psa_cipher_encrypt(mbedtls_svc_key_id_t key,
4169 psa_algorithm_t alg,
4170 const uint8_t *input,
4171 size_t input_length,
4172 uint8_t *output,
4173 size_t output_size,
4174 size_t *output_length)
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004175{
4176 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004177 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron23919522021-07-08 19:00:07 +02004178 psa_key_slot_t *slot = NULL;
Ronald Cronc6e6f502021-07-09 18:44:58 +02004179 uint8_t local_iv[PSA_CIPHER_IV_MAX_SIZE];
4180 size_t default_iv_length = 0;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004181 psa_key_attributes_t attributes;
gabor-mezei-arm6f4e5bb2021-06-25 15:21:11 +02004182
Gilles Peskine449bd832023-01-11 14:50:10 +01004183 if (!PSA_ALG_IS_CIPHER(alg)) {
Ronald Cron23919522021-07-08 19:00:07 +02004184 status = PSA_ERROR_INVALID_ARGUMENT;
4185 goto exit;
4186 }
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004187
Gilles Peskine449bd832023-01-11 14:50:10 +01004188 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
4189 PSA_KEY_USAGE_ENCRYPT,
4190 alg);
4191 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004192 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004193 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004194
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004195 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004196 .core = slot->attr
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004197 };
4198
Gilles Peskine449bd832023-01-11 14:50:10 +01004199 default_iv_length = PSA_CIPHER_IV_LENGTH(slot->attr.type, alg);
4200 if (default_iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Ronald Cronc6e6f502021-07-09 18:44:58 +02004201 status = PSA_ERROR_GENERIC_ERROR;
4202 goto exit;
4203 }
4204
Gilles Peskine449bd832023-01-11 14:50:10 +01004205 if (default_iv_length > 0) {
4206 if (output_size < default_iv_length) {
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004207 status = PSA_ERROR_BUFFER_TOO_SMALL;
4208 goto exit;
4209 }
4210
Gilles Peskine449bd832023-01-11 14:50:10 +01004211 status = psa_generate_random(local_iv, default_iv_length);
4212 if (status != PSA_SUCCESS) {
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004213 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004214 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004215 }
4216
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004217 status = psa_driver_wrapper_cipher_encrypt(
4218 &attributes, slot->key.data, slot->key.bytes,
Ronald Cronc6e6f502021-07-09 18:44:58 +02004219 alg, local_iv, default_iv_length, input, input_length,
Ronald Cronafbc7ed2023-01-24 16:02:04 +01004220 psa_crypto_buffer_offset(output, default_iv_length),
Gilles Peskine449bd832023-01-11 14:50:10 +01004221 output_size - default_iv_length, output_length);
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004222
4223exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00004224 unlock_status = psa_unregister_read(slot);
Gilles Peskine449bd832023-01-11 14:50:10 +01004225 if (status == PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004226 status = unlock_status;
Ronald Cronc6e6f502021-07-09 18:44:58 +02004227 }
Ronald Cron23919522021-07-08 19:00:07 +02004228
Gilles Peskine449bd832023-01-11 14:50:10 +01004229 if (status == PSA_SUCCESS) {
4230 if (default_iv_length > 0) {
4231 memcpy(output, local_iv, default_iv_length);
4232 }
4233 *output_length += default_iv_length;
4234 } else {
4235 *output_length = 0;
4236 }
4237
4238 return status;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004239}
4240
Gilles Peskine449bd832023-01-11 14:50:10 +01004241psa_status_t psa_cipher_decrypt(mbedtls_svc_key_id_t key,
4242 psa_algorithm_t alg,
4243 const uint8_t *input,
4244 size_t input_length,
4245 uint8_t *output,
4246 size_t output_size,
4247 size_t *output_length)
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004248{
4249 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004250 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron23919522021-07-08 19:00:07 +02004251 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004252 psa_key_attributes_t attributes;
gabor-mezei-arm6f4e5bb2021-06-25 15:21:11 +02004253
Gilles Peskine449bd832023-01-11 14:50:10 +01004254 if (!PSA_ALG_IS_CIPHER(alg)) {
Ronald Cron23919522021-07-08 19:00:07 +02004255 status = PSA_ERROR_INVALID_ARGUMENT;
4256 goto exit;
4257 }
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004258
Gilles Peskine449bd832023-01-11 14:50:10 +01004259 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
4260 PSA_KEY_USAGE_DECRYPT,
4261 alg);
4262 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004263 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004264 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004265
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004266 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004267 .core = slot->attr
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004268 };
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004269
Gilles Peskine449bd832023-01-11 14:50:10 +01004270 if (alg == PSA_ALG_CCM_STAR_NO_TAG &&
4271 input_length < PSA_BLOCK_CIPHER_BLOCK_LENGTH(slot->attr.type)) {
Mateusz Starzyk594215b2021-10-14 12:23:06 +02004272 status = PSA_ERROR_INVALID_ARGUMENT;
4273 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004274 } else if (input_length < PSA_CIPHER_IV_LENGTH(slot->attr.type, alg)) {
gabor-mezei-arm258ae072021-06-25 15:25:38 +02004275 status = PSA_ERROR_INVALID_ARGUMENT;
4276 goto exit;
4277 }
4278
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004279 status = psa_driver_wrapper_cipher_decrypt(
4280 &attributes, slot->key.data, slot->key.bytes,
4281 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004282 output, output_size, output_length);
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004283
gabor-mezei-arm258ae072021-06-25 15:25:38 +02004284exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00004285 unlock_status = psa_unregister_read(slot);
Gilles Peskine449bd832023-01-11 14:50:10 +01004286 if (status == PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004287 status = unlock_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01004288 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004289
Gilles Peskine449bd832023-01-11 14:50:10 +01004290 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004291 *output_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004292 }
Ronald Cron23919522021-07-08 19:00:07 +02004293
Gilles Peskine449bd832023-01-11 14:50:10 +01004294 return status;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004295}
4296
4297
mohammad16035955c982018-04-26 00:53:03 +03004298/****************************************************************/
4299/* AEAD */
4300/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004301
Paul Elliottbaff51c2021-09-28 17:44:45 +01004302/* Helper function to get the base algorithm from its variants. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004303static psa_algorithm_t psa_aead_get_base_algorithm(psa_algorithm_t alg)
Paul Elliottbaff51c2021-09-28 17:44:45 +01004304{
Gilles Peskine449bd832023-01-11 14:50:10 +01004305 return PSA_ALG_AEAD_WITH_DEFAULT_LENGTH_TAG(alg);
Paul Elliottbaff51c2021-09-28 17:44:45 +01004306}
4307
4308/* Helper function to perform common nonce length checks. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004309static psa_status_t psa_aead_check_nonce_length(psa_algorithm_t alg,
4310 size_t nonce_length)
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004311{
Gilles Peskine449bd832023-01-11 14:50:10 +01004312 psa_algorithm_t base_alg = psa_aead_get_base_algorithm(alg);
Paul Elliottbaff51c2021-09-28 17:44:45 +01004313
Gilles Peskine449bd832023-01-11 14:50:10 +01004314 switch (base_alg) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004315#if defined(PSA_WANT_ALG_GCM)
4316 case PSA_ALG_GCM:
4317 /* Not checking max nonce size here as GCM spec allows almost
Gilles Peskine449bd832023-01-11 14:50:10 +01004318 * arbitrarily large nonces. Please note that we do not generally
4319 * recommend the usage of nonces of greater length than
4320 * PSA_AEAD_NONCE_MAX_SIZE, as large nonces are hashed to a shorter
4321 * size, which can then lead to collisions if you encrypt a very
4322 * large number of messages.*/
4323 if (nonce_length != 0) {
4324 return PSA_SUCCESS;
4325 }
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004326 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004327#endif /* PSA_WANT_ALG_GCM */
4328#if defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004329 case PSA_ALG_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01004330 if (nonce_length >= 7 && nonce_length <= 13) {
4331 return PSA_SUCCESS;
4332 }
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004333 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004334#endif /* PSA_WANT_ALG_CCM */
4335#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004336 case PSA_ALG_CHACHA20_POLY1305:
Gilles Peskine449bd832023-01-11 14:50:10 +01004337 if (nonce_length == 12) {
4338 return PSA_SUCCESS;
4339 } else if (nonce_length == 8) {
4340 return PSA_ERROR_NOT_SUPPORTED;
4341 }
Bence Szépkúti6d48e202021-11-15 20:04:15 +01004342 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004343#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004344 default:
Przemek Stekiel4c499272022-09-27 13:55:37 +02004345 (void) nonce_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01004346 return PSA_ERROR_NOT_SUPPORTED;
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004347 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004348
Gilles Peskine449bd832023-01-11 14:50:10 +01004349 return PSA_ERROR_INVALID_ARGUMENT;
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004350}
4351
Gilles Peskine449bd832023-01-11 14:50:10 +01004352static psa_status_t psa_aead_check_algorithm(psa_algorithm_t alg)
Bence Szépkútiaa3a6e42022-01-13 16:26:03 +01004353{
Gilles Peskine449bd832023-01-11 14:50:10 +01004354 if (!PSA_ALG_IS_AEAD(alg) || PSA_ALG_IS_WILDCARD(alg)) {
4355 return PSA_ERROR_INVALID_ARGUMENT;
4356 }
Bence Szépkúti08f34652021-12-08 21:07:13 +01004357
Gilles Peskine449bd832023-01-11 14:50:10 +01004358 return PSA_SUCCESS;
Bence Szépkúti08f34652021-12-08 21:07:13 +01004359}
4360
Gilles Peskine449bd832023-01-11 14:50:10 +01004361psa_status_t psa_aead_encrypt(mbedtls_svc_key_id_t key,
4362 psa_algorithm_t alg,
4363 const uint8_t *nonce,
4364 size_t nonce_length,
4365 const uint8_t *additional_data,
4366 size_t additional_data_length,
4367 const uint8_t *plaintext,
4368 size_t plaintext_length,
4369 uint8_t *ciphertext,
4370 size_t ciphertext_size,
4371 size_t *ciphertext_length)
mohammad16035955c982018-04-26 00:53:03 +03004372{
Ronald Cron215633c2021-03-16 17:15:37 +01004373 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4374 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02004375
mohammad1603f08a5502018-06-03 15:05:47 +03004376 *ciphertext_length = 0;
mohammad1603e58e6842018-05-09 04:58:32 -07004377
Gilles Peskine449bd832023-01-11 14:50:10 +01004378 status = psa_aead_check_algorithm(alg);
4379 if (status != PSA_SUCCESS) {
4380 return status;
4381 }
Steven Cooremanea7ab132021-03-17 16:28:00 +01004382
Ronald Cron9a986162021-03-26 12:40:07 +01004383 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01004384 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg);
4385 if (status != PSA_SUCCESS) {
4386 return status;
4387 }
mohammad16035955c982018-04-26 00:53:03 +03004388
Ronald Cron215633c2021-03-16 17:15:37 +01004389 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01004390 .core = slot->attr
Ronald Cron215633c2021-03-16 17:15:37 +01004391 };
mohammad16035955c982018-04-26 00:53:03 +03004392
Gilles Peskine449bd832023-01-11 14:50:10 +01004393 status = psa_aead_check_nonce_length(alg, nonce_length);
4394 if (status != PSA_SUCCESS) {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004395 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004396 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004397
Ronald Cronde822812021-03-17 16:08:20 +01004398 status = psa_driver_wrapper_aead_encrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01004399 &attributes, slot->key.data, slot->key.bytes,
4400 alg,
4401 nonce, nonce_length,
4402 additional_data, additional_data_length,
4403 plaintext, plaintext_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004404 ciphertext, ciphertext_size, ciphertext_length);
Gilles Peskine2d277862018-06-18 15:41:12 +02004405
Gilles Peskine449bd832023-01-11 14:50:10 +01004406 if (status != PSA_SUCCESS && ciphertext_size != 0) {
4407 memset(ciphertext, 0, ciphertext_size);
4408 }
Gilles Peskine2d277862018-06-18 15:41:12 +02004409
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004410exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00004411 psa_unregister_read(slot);
mohammad16035955c982018-04-26 00:53:03 +03004412
Gilles Peskine449bd832023-01-11 14:50:10 +01004413 return status;
Gilles Peskineee652a32018-06-01 19:23:52 +02004414}
4415
Gilles Peskine449bd832023-01-11 14:50:10 +01004416psa_status_t psa_aead_decrypt(mbedtls_svc_key_id_t key,
4417 psa_algorithm_t alg,
4418 const uint8_t *nonce,
4419 size_t nonce_length,
4420 const uint8_t *additional_data,
4421 size_t additional_data_length,
4422 const uint8_t *ciphertext,
4423 size_t ciphertext_length,
4424 uint8_t *plaintext,
4425 size_t plaintext_size,
4426 size_t *plaintext_length)
mohammad16035955c982018-04-26 00:53:03 +03004427{
Ronald Cron215633c2021-03-16 17:15:37 +01004428 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4429 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02004430
Gilles Peskineee652a32018-06-01 19:23:52 +02004431 *plaintext_length = 0;
mohammad16039e5a5152018-04-26 12:07:35 +03004432
Gilles Peskine449bd832023-01-11 14:50:10 +01004433 status = psa_aead_check_algorithm(alg);
4434 if (status != PSA_SUCCESS) {
4435 return status;
4436 }
Steven Cooremanea7ab132021-03-17 16:28:00 +01004437
Ronald Cron9a986162021-03-26 12:40:07 +01004438 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01004439 key, &slot, PSA_KEY_USAGE_DECRYPT, alg);
4440 if (status != PSA_SUCCESS) {
4441 return status;
4442 }
mohammad16035955c982018-04-26 00:53:03 +03004443
Ronald Cron215633c2021-03-16 17:15:37 +01004444 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01004445 .core = slot->attr
Ronald Cron215633c2021-03-16 17:15:37 +01004446 };
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004447
Gilles Peskine449bd832023-01-11 14:50:10 +01004448 status = psa_aead_check_nonce_length(alg, nonce_length);
4449 if (status != PSA_SUCCESS) {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004450 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004451 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004452
Ronald Cronde822812021-03-17 16:08:20 +01004453 status = psa_driver_wrapper_aead_decrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01004454 &attributes, slot->key.data, slot->key.bytes,
4455 alg,
4456 nonce, nonce_length,
4457 additional_data, additional_data_length,
4458 ciphertext, ciphertext_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004459 plaintext, plaintext_size, plaintext_length);
Gilles Peskinea40d7742018-06-01 16:28:30 +02004460
Gilles Peskine449bd832023-01-11 14:50:10 +01004461 if (status != PSA_SUCCESS && plaintext_size != 0) {
4462 memset(plaintext, 0, plaintext_size);
4463 }
mohammad160360a64d02018-06-03 17:20:42 +03004464
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004465exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00004466 psa_unregister_read(slot);
Ronald Cron215633c2021-03-16 17:15:37 +01004467
Gilles Peskine449bd832023-01-11 14:50:10 +01004468 return status;
mohammad16035955c982018-04-26 00:53:03 +03004469}
4470
Gilles Peskine449bd832023-01-11 14:50:10 +01004471static psa_status_t psa_validate_tag_length(psa_algorithm_t alg)
4472{
4473 const uint8_t tag_len = PSA_ALG_AEAD_GET_TAG_LENGTH(alg);
Andrzej Kurekf8816012021-12-19 17:00:12 +01004474
Gilles Peskine449bd832023-01-11 14:50:10 +01004475 switch (PSA_ALG_AEAD_WITH_SHORTENED_TAG(alg, 0)) {
Przemek Stekiel86679c72022-10-06 17:06:56 +02004476#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004477 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004478 /* CCM allows the following tag lengths: 4, 6, 8, 10, 12, 14, 16.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004479 if (tag_len < 4 || tag_len > 16 || tag_len % 2) {
4480 return PSA_ERROR_INVALID_ARGUMENT;
4481 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01004482 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02004483#endif /* PSA_WANT_ALG_CCM */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004484
Przemek Stekiel86679c72022-10-06 17:06:56 +02004485#if defined(PSA_WANT_ALG_GCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004486 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_GCM, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004487 /* GCM allows the following tag lengths: 4, 8, 12, 13, 14, 15, 16. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004488 if (tag_len != 4 && tag_len != 8 && (tag_len < 12 || tag_len > 16)) {
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_GCM */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004493
Przemek Stekiel86679c72022-10-06 17:06:56 +02004494#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Gilles Peskine449bd832023-01-11 14:50:10 +01004495 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CHACHA20_POLY1305, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004496 /* We only support the default tag length. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004497 if (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_CHACHA20_POLY1305 */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004502
4503 default:
4504 (void) tag_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004505 return PSA_ERROR_NOT_SUPPORTED;
Andrzej Kurekf8816012021-12-19 17:00:12 +01004506 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004507 return PSA_SUCCESS;
Andrzej Kurekf8816012021-12-19 17:00:12 +01004508}
4509
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004510/* Set the key for a multipart authenticated operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004511static psa_status_t psa_aead_setup(psa_aead_operation_t *operation,
4512 int is_encrypt,
4513 mbedtls_svc_key_id_t key,
4514 psa_algorithm_t alg)
Paul Elliottc2b71442021-06-24 18:17:52 +01004515{
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004516 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4517 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
4518 psa_key_slot_t *slot = NULL;
4519 psa_key_usage_t key_usage = 0;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004520 psa_key_attributes_t attributes;
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004521
Gilles Peskine449bd832023-01-11 14:50:10 +01004522 status = psa_aead_check_algorithm(alg);
4523 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004524 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004525 }
Paul Elliottc2b71442021-06-24 18:17:52 +01004526
Gilles Peskine449bd832023-01-11 14:50:10 +01004527 if (operation->id != 0) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004528 status = PSA_ERROR_BAD_STATE;
4529 goto exit;
Paul Elliottc2b71442021-06-24 18:17:52 +01004530 }
4531
Gilles Peskine449bd832023-01-11 14:50:10 +01004532 if (operation->nonce_set || operation->lengths_set ||
4533 operation->ad_started || operation->body_started) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004534 status = PSA_ERROR_BAD_STATE;
4535 goto exit;
Paul Elliottc2b71442021-06-24 18:17:52 +01004536 }
4537
Gilles Peskine449bd832023-01-11 14:50:10 +01004538 if (is_encrypt) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004539 key_usage = PSA_KEY_USAGE_ENCRYPT;
Gilles Peskine449bd832023-01-11 14:50:10 +01004540 } else {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004541 key_usage = PSA_KEY_USAGE_DECRYPT;
Gilles Peskine449bd832023-01-11 14:50:10 +01004542 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004543
Gilles Peskine449bd832023-01-11 14:50:10 +01004544 status = psa_get_and_lock_key_slot_with_policy(key, &slot, key_usage,
4545 alg);
4546 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004547 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004548 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004549
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004550 attributes = (psa_key_attributes_t) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004551 .core = slot->attr
4552 };
4553
Gilles Peskine449bd832023-01-11 14:50:10 +01004554 if ((status = psa_validate_tag_length(alg)) != PSA_SUCCESS) {
Przemek Stekiel6ab50762022-10-08 17:54:30 +02004555 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004556 }
Przemek Stekiel6ab50762022-10-08 17:54:30 +02004557
Gilles Peskine449bd832023-01-11 14:50:10 +01004558 if (is_encrypt) {
4559 status = psa_driver_wrapper_aead_encrypt_setup(operation,
4560 &attributes,
4561 slot->key.data,
4562 slot->key.bytes,
4563 alg);
4564 } else {
4565 status = psa_driver_wrapper_aead_decrypt_setup(operation,
4566 &attributes,
4567 slot->key.data,
4568 slot->key.bytes,
4569 alg);
4570 }
4571 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004572 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004573 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004574
Gilles Peskine449bd832023-01-11 14:50:10 +01004575 operation->key_type = psa_get_key_type(&attributes);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004576
4577exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00004578 unlock_status = psa_unregister_read(slot);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004579
Gilles Peskine449bd832023-01-11 14:50:10 +01004580 if (status == PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004581 status = unlock_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01004582 operation->alg = psa_aead_get_base_algorithm(alg);
Paul Elliottd9343f22021-08-23 18:59:49 +01004583 operation->is_encrypt = is_encrypt;
Gilles Peskine449bd832023-01-11 14:50:10 +01004584 } else {
4585 psa_aead_abort(operation);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004586 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004587
Gilles Peskine449bd832023-01-11 14:50:10 +01004588 return status;
Paul Elliottc2b71442021-06-24 18:17:52 +01004589}
4590
Paul Elliott302ff6b2021-04-20 18:10:30 +01004591/* Set the key for a multipart authenticated encryption operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004592psa_status_t psa_aead_encrypt_setup(psa_aead_operation_t *operation,
4593 mbedtls_svc_key_id_t key,
4594 psa_algorithm_t alg)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004595{
Gilles Peskine449bd832023-01-11 14:50:10 +01004596 return psa_aead_setup(operation, 1, key, alg);
Paul Elliott302ff6b2021-04-20 18:10:30 +01004597}
4598
4599/* Set the key for a multipart authenticated decryption operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004600psa_status_t psa_aead_decrypt_setup(psa_aead_operation_t *operation,
4601 mbedtls_svc_key_id_t key,
4602 psa_algorithm_t alg)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004603{
Gilles Peskine449bd832023-01-11 14:50:10 +01004604 return psa_aead_setup(operation, 0, key, alg);
Paul Elliott302ff6b2021-04-20 18:10:30 +01004605}
4606
4607/* Generate a random nonce / IV for multipart AEAD operation */
Gilles Peskine449bd832023-01-11 14:50:10 +01004608psa_status_t psa_aead_generate_nonce(psa_aead_operation_t *operation,
4609 uint8_t *nonce,
4610 size_t nonce_size,
4611 size_t *nonce_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004612{
4613 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Croncae59092021-11-26 18:53:58 +01004614 uint8_t local_nonce[PSA_AEAD_NONCE_MAX_SIZE];
Sergeybef1f632023-03-06 15:25:06 -07004615 size_t required_nonce_size = 0;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004616
Paul Elliott8eb9daf2021-06-04 16:42:21 +01004617 *nonce_length = 0;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004618
Gilles Peskine449bd832023-01-11 14:50:10 +01004619 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004620 status = PSA_ERROR_BAD_STATE;
4621 goto exit;
4622 }
4623
Gilles Peskine449bd832023-01-11 14:50:10 +01004624 if (operation->nonce_set || !operation->is_encrypt) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004625 status = PSA_ERROR_BAD_STATE;
4626 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004627 }
4628
Paul Elliotte193ea82021-10-01 13:00:16 +01004629 /* For CCM, this size may not be correct according to the PSA
4630 * specification. The PSA Crypto 1.0.1 specification states:
4631 *
4632 * CCM encodes the plaintext length pLen in L octets, with L the smallest
4633 * integer >= 2 where pLen < 2^(8L). The nonce length is then 15 - L bytes.
4634 *
4635 * However this restriction that L has to be the smallest integer is not
4636 * applied in practice, and it is not implementable here since the
4637 * plaintext length may or may not be known at this time. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004638 required_nonce_size = PSA_AEAD_NONCE_LENGTH(operation->key_type,
4639 operation->alg);
4640 if (nonce_size < required_nonce_size) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004641 status = PSA_ERROR_BUFFER_TOO_SMALL;
4642 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004643 }
4644
Gilles Peskine449bd832023-01-11 14:50:10 +01004645 status = psa_generate_random(local_nonce, required_nonce_size);
4646 if (status != PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004647 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004648 }
Paul Elliott302ff6b2021-04-20 18:10:30 +01004649
Gilles Peskine449bd832023-01-11 14:50:10 +01004650 status = psa_aead_set_nonce(operation, local_nonce, required_nonce_size);
Paul Elliott302ff6b2021-04-20 18:10:30 +01004651
Paul Elliott39dc6b82021-05-11 19:16:09 +01004652exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004653 if (status == PSA_SUCCESS) {
4654 memcpy(nonce, local_nonce, required_nonce_size);
Paul Elliott39dc6b82021-05-11 19:16:09 +01004655 *nonce_length = required_nonce_size;
Gilles Peskine449bd832023-01-11 14:50:10 +01004656 } else {
4657 psa_aead_abort(operation);
Ronald Croncae59092021-11-26 18:53:58 +01004658 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01004659
Gilles Peskine449bd832023-01-11 14:50:10 +01004660 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004661}
4662
4663/* Set the nonce for a multipart authenticated encryption or decryption
4664 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004665psa_status_t psa_aead_set_nonce(psa_aead_operation_t *operation,
4666 const uint8_t *nonce,
4667 size_t nonce_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004668{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004669 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4670
Gilles Peskine449bd832023-01-11 14:50:10 +01004671 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004672 status = PSA_ERROR_BAD_STATE;
4673 goto exit;
4674 }
4675
Gilles Peskine449bd832023-01-11 14:50:10 +01004676 if (operation->nonce_set) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004677 status = PSA_ERROR_BAD_STATE;
4678 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004679 }
4680
Gilles Peskine449bd832023-01-11 14:50:10 +01004681 status = psa_aead_check_nonce_length(operation->alg, nonce_length);
4682 if (status != PSA_SUCCESS) {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004683 status = PSA_ERROR_INVALID_ARGUMENT;
4684 goto exit;
Paul Elliott4ed1ed12021-09-27 18:09:28 +01004685 }
Paul Elliott1a98aca2021-05-20 18:24:07 +01004686
Gilles Peskine449bd832023-01-11 14:50:10 +01004687 status = psa_driver_wrapper_aead_set_nonce(operation, nonce,
4688 nonce_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004689
Paul Elliott39dc6b82021-05-11 19:16:09 +01004690exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004691 if (status == PSA_SUCCESS) {
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004692 operation->nonce_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004693 } else {
4694 psa_aead_abort(operation);
4695 }
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004696
Gilles Peskine449bd832023-01-11 14:50:10 +01004697 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004698}
4699
4700/* Declare the lengths of the message and additional data for multipart AEAD. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004701psa_status_t psa_aead_set_lengths(psa_aead_operation_t *operation,
4702 size_t ad_length,
4703 size_t plaintext_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004704{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004705 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4706
Gilles Peskine449bd832023-01-11 14:50:10 +01004707 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004708 status = PSA_ERROR_BAD_STATE;
4709 goto exit;
4710 }
4711
Gilles Peskine449bd832023-01-11 14:50:10 +01004712 if (operation->lengths_set || operation->ad_started ||
4713 operation->body_started) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004714 status = PSA_ERROR_BAD_STATE;
4715 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004716 }
4717
Gilles Peskine449bd832023-01-11 14:50:10 +01004718 switch (operation->alg) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004719#if defined(PSA_WANT_ALG_GCM)
4720 case PSA_ALG_GCM:
4721 /* Lengths can only be too large for GCM if size_t is bigger than 32
Gilles Peskine449bd832023-01-11 14:50:10 +01004722 * bits. Without the guard this code will generate warnings on 32bit
4723 * builds. */
Paul Elliott325d3742021-09-27 17:56:28 +01004724#if SIZE_MAX > UINT32_MAX
Gilles Peskine449bd832023-01-11 14:50:10 +01004725 if (((uint64_t) ad_length) >> 61 != 0 ||
4726 ((uint64_t) plaintext_length) > 0xFFFFFFFE0ull) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004727 status = PSA_ERROR_INVALID_ARGUMENT;
4728 goto exit;
4729 }
Paul Elliott325d3742021-09-27 17:56:28 +01004730#endif
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004731 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004732#endif /* PSA_WANT_ALG_GCM */
4733#if defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004734 case PSA_ALG_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01004735 if (ad_length > 0xFF00) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004736 status = PSA_ERROR_INVALID_ARGUMENT;
4737 goto exit;
4738 }
4739 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004740#endif /* PSA_WANT_ALG_CCM */
4741#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004742 case PSA_ALG_CHACHA20_POLY1305:
4743 /* No length restrictions for ChaChaPoly. */
4744 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004745#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004746 default:
4747 break;
4748 }
Paul Elliott325d3742021-09-27 17:56:28 +01004749
Gilles Peskine449bd832023-01-11 14:50:10 +01004750 status = psa_driver_wrapper_aead_set_lengths(operation, ad_length,
4751 plaintext_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004752
Paul Elliott39dc6b82021-05-11 19:16:09 +01004753exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004754 if (status == PSA_SUCCESS) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01004755 operation->ad_remaining = ad_length;
4756 operation->body_remaining = plaintext_length;
Paul Elliott39dc6b82021-05-11 19:16:09 +01004757 operation->lengths_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004758 } else {
4759 psa_aead_abort(operation);
Paul Elliottee4ffe02021-05-20 17:25:06 +01004760 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01004761
Gilles Peskine449bd832023-01-11 14:50:10 +01004762 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004763}
Paul Elliott3d7d52c2021-09-01 10:33:14 +01004764
4765/* Pass additional data to an active multipart AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004766psa_status_t psa_aead_update_ad(psa_aead_operation_t *operation,
4767 const uint8_t *input,
4768 size_t input_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004769{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004770 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4771
Gilles Peskine449bd832023-01-11 14:50:10 +01004772 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004773 status = PSA_ERROR_BAD_STATE;
4774 goto exit;
4775 }
4776
Gilles Peskine449bd832023-01-11 14:50:10 +01004777 if (!operation->nonce_set || operation->body_started) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004778 status = PSA_ERROR_BAD_STATE;
4779 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004780 }
4781
Gilles Peskine449bd832023-01-11 14:50:10 +01004782 if (operation->lengths_set) {
4783 if (operation->ad_remaining < input_length) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01004784 status = PSA_ERROR_INVALID_ARGUMENT;
4785 goto exit;
4786 }
4787
4788 operation->ad_remaining -= input_length;
4789 }
Paul Elliotte193ea82021-10-01 13:00:16 +01004790#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004791 else if (operation->alg == PSA_ALG_CCM) {
Paul Elliotte193ea82021-10-01 13:00:16 +01004792 status = PSA_ERROR_BAD_STATE;
4793 goto exit;
4794 }
4795#endif /* PSA_WANT_ALG_CCM */
Paul Elliottee4ffe02021-05-20 17:25:06 +01004796
Gilles Peskine449bd832023-01-11 14:50:10 +01004797 status = psa_driver_wrapper_aead_update_ad(operation, input,
4798 input_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004799
Paul Elliott39dc6b82021-05-11 19:16:09 +01004800exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004801 if (status == PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004802 operation->ad_started = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004803 } else {
4804 psa_aead_abort(operation);
4805 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01004806
Gilles Peskine449bd832023-01-11 14:50:10 +01004807 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004808}
4809
4810/* Encrypt or decrypt a message fragment in an active multipart AEAD
4811 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004812psa_status_t psa_aead_update(psa_aead_operation_t *operation,
4813 const uint8_t *input,
4814 size_t input_length,
4815 uint8_t *output,
4816 size_t output_size,
4817 size_t *output_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004818{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004819 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004820
4821 *output_length = 0;
4822
Gilles Peskine449bd832023-01-11 14:50:10 +01004823 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004824 status = PSA_ERROR_BAD_STATE;
4825 goto exit;
4826 }
4827
Gilles Peskine449bd832023-01-11 14:50:10 +01004828 if (!operation->nonce_set) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004829 status = PSA_ERROR_BAD_STATE;
4830 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004831 }
4832
Gilles Peskine449bd832023-01-11 14:50:10 +01004833 if (operation->lengths_set) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01004834 /* Additional data length was supplied, but not all the additional
4835 data was supplied.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004836 if (operation->ad_remaining != 0) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01004837 status = PSA_ERROR_INVALID_ARGUMENT;
4838 goto exit;
4839 }
4840
4841 /* Too much data provided. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004842 if (operation->body_remaining < input_length) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01004843 status = PSA_ERROR_INVALID_ARGUMENT;
4844 goto exit;
4845 }
4846
4847 operation->body_remaining -= input_length;
4848 }
Paul Elliotte193ea82021-10-01 13:00:16 +01004849#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004850 else if (operation->alg == PSA_ALG_CCM) {
Paul Elliotte193ea82021-10-01 13:00:16 +01004851 status = PSA_ERROR_BAD_STATE;
4852 goto exit;
4853 }
4854#endif /* PSA_WANT_ALG_CCM */
Paul Elliottee4ffe02021-05-20 17:25:06 +01004855
Gilles Peskine449bd832023-01-11 14:50:10 +01004856 status = psa_driver_wrapper_aead_update(operation, input, input_length,
4857 output, output_size,
4858 output_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004859
Paul Elliott39dc6b82021-05-11 19:16:09 +01004860exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004861 if (status == PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004862 operation->body_started = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004863 } else {
4864 psa_aead_abort(operation);
4865 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01004866
Gilles Peskine449bd832023-01-11 14:50:10 +01004867 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004868}
4869
Gilles Peskine449bd832023-01-11 14:50:10 +01004870static psa_status_t psa_aead_final_checks(const psa_aead_operation_t *operation)
Paul Elliottad53dcc2021-06-23 08:50:14 +01004871{
Gilles Peskine449bd832023-01-11 14:50:10 +01004872 if (operation->id == 0 || !operation->nonce_set) {
4873 return PSA_ERROR_BAD_STATE;
4874 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01004875
Gilles Peskine449bd832023-01-11 14:50:10 +01004876 if (operation->lengths_set && (operation->ad_remaining != 0 ||
4877 operation->body_remaining != 0)) {
4878 return PSA_ERROR_INVALID_ARGUMENT;
4879 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01004880
Gilles Peskine449bd832023-01-11 14:50:10 +01004881 return PSA_SUCCESS;
Paul Elliottad53dcc2021-06-23 08:50:14 +01004882}
4883
Paul Elliott302ff6b2021-04-20 18:10:30 +01004884/* Finish encrypting a message in a multipart AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004885psa_status_t psa_aead_finish(psa_aead_operation_t *operation,
4886 uint8_t *ciphertext,
4887 size_t ciphertext_size,
4888 size_t *ciphertext_length,
4889 uint8_t *tag,
4890 size_t tag_size,
4891 size_t *tag_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004892{
Paul Elliott39dc6b82021-05-11 19:16:09 +01004893 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4894
Paul Elliott302ff6b2021-04-20 18:10:30 +01004895 *ciphertext_length = 0;
Paul Elliottf88a5652021-06-22 17:53:45 +01004896 *tag_length = tag_size;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004897
Gilles Peskine449bd832023-01-11 14:50:10 +01004898 status = psa_aead_final_checks(operation);
4899 if (status != PSA_SUCCESS) {
Paul Elliottad53dcc2021-06-23 08:50:14 +01004900 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004901 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01004902
Gilles Peskine449bd832023-01-11 14:50:10 +01004903 if (!operation->is_encrypt) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004904 status = PSA_ERROR_BAD_STATE;
4905 goto exit;
4906 }
4907
Gilles Peskine449bd832023-01-11 14:50:10 +01004908 status = psa_driver_wrapper_aead_finish(operation, ciphertext,
4909 ciphertext_size,
4910 ciphertext_length,
4911 tag, tag_size, tag_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004912
Paul Elliott39dc6b82021-05-11 19:16:09 +01004913exit:
Paul Elliottdc42ca82023-02-24 18:11:59 +00004914
4915
Paul Elliottf47b0952021-05-21 18:02:33 +01004916 /* In case the operation fails and the user fails to check for failure or
Paul Elliott4c916e82021-09-19 18:34:50 +01004917 * the zero tag size, make sure the tag is set to something implausible.
4918 * Even if the operation succeeds, make sure we clear the rest of the
4919 * buffer to prevent potential leakage of anything previously placed in
4920 * the same buffer.*/
Paul Elliottdc42ca82023-02-24 18:11:59 +00004921 psa_wipe_tag_output_buffer(tag, status, tag_size, *tag_length);
Paul Elliottf47b0952021-05-21 18:02:33 +01004922
Gilles Peskine449bd832023-01-11 14:50:10 +01004923 psa_aead_abort(operation);
Paul Elliott39dc6b82021-05-11 19:16:09 +01004924
Gilles Peskine449bd832023-01-11 14:50:10 +01004925 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004926}
4927
4928/* Finish authenticating and decrypting a message in a multipart AEAD
4929 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004930psa_status_t psa_aead_verify(psa_aead_operation_t *operation,
4931 uint8_t *plaintext,
4932 size_t plaintext_size,
4933 size_t *plaintext_length,
4934 const uint8_t *tag,
4935 size_t tag_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004936{
Paul Elliott39dc6b82021-05-11 19:16:09 +01004937 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4938
Paul Elliott302ff6b2021-04-20 18:10:30 +01004939 *plaintext_length = 0;
4940
Gilles Peskine449bd832023-01-11 14:50:10 +01004941 status = psa_aead_final_checks(operation);
4942 if (status != PSA_SUCCESS) {
Paul Elliottad53dcc2021-06-23 08:50:14 +01004943 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004944 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01004945
Gilles Peskine449bd832023-01-11 14:50:10 +01004946 if (operation->is_encrypt) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004947 status = PSA_ERROR_BAD_STATE;
4948 goto exit;
4949 }
4950
Gilles Peskine449bd832023-01-11 14:50:10 +01004951 status = psa_driver_wrapper_aead_verify(operation, plaintext,
4952 plaintext_size,
4953 plaintext_length,
4954 tag, tag_length);
Paul Elliott39dc6b82021-05-11 19:16:09 +01004955
4956exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004957 psa_aead_abort(operation);
Paul Elliott39dc6b82021-05-11 19:16:09 +01004958
Gilles Peskine449bd832023-01-11 14:50:10 +01004959 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004960}
4961
4962/* Abort an AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004963psa_status_t psa_aead_abort(psa_aead_operation_t *operation)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004964{
4965 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4966
Gilles Peskine449bd832023-01-11 14:50:10 +01004967 if (operation->id == 0) {
Paul Elliott302ff6b2021-04-20 18:10:30 +01004968 /* The object has (apparently) been initialized but it is not (yet)
4969 * in use. It's ok to call abort on such an object, and there's
4970 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004971 return PSA_SUCCESS;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004972 }
4973
Gilles Peskine449bd832023-01-11 14:50:10 +01004974 status = psa_driver_wrapper_aead_abort(operation);
Paul Elliott302ff6b2021-04-20 18:10:30 +01004975
Gilles Peskine449bd832023-01-11 14:50:10 +01004976 memset(operation, 0, sizeof(*operation));
Paul Elliott302ff6b2021-04-20 18:10:30 +01004977
Gilles Peskine449bd832023-01-11 14:50:10 +01004978 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004979}
4980
Gilles Peskinee59236f2018-01-27 23:32:46 +01004981/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02004982/* Generators */
4983/****************************************************************/
4984
Przemek Stekiel69c46792022-06-10 12:59:51 +02004985#if defined(BUILTIN_ALG_ANY_HKDF) || \
John Durkop07cc04a2020-11-16 22:08:34 -08004986 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
Andrzej Kurek08d34b82022-07-29 10:00:16 -04004987 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) || \
Kusumit Ghoderaoaf0b5342023-05-03 11:58:46 +05304988 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS) || \
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05304989 defined(PSA_HAVE_SOFT_PBKDF2)
John Durkop07cc04a2020-11-16 22:08:34 -08004990#define AT_LEAST_ONE_BUILTIN_KDF
Steven Cooreman094a77e2021-05-06 17:58:36 +02004991#endif /* At least one builtin KDF */
4992
Przemek Stekiel69c46792022-06-10 12:59:51 +02004993#if defined(BUILTIN_ALG_ANY_HKDF) || \
Steven Cooreman094a77e2021-05-06 17:58:36 +02004994 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4995 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4996static psa_status_t psa_key_derivation_start_hmac(
4997 psa_mac_operation_t *operation,
4998 psa_algorithm_t hash_alg,
4999 const uint8_t *hmac_key,
Gilles Peskine449bd832023-01-11 14:50:10 +01005000 size_t hmac_key_length)
Steven Cooreman094a77e2021-05-06 17:58:36 +02005001{
5002 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5003 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01005004 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
5005 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(hmac_key_length));
5006 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_HASH);
Steven Cooreman094a77e2021-05-06 17:58:36 +02005007
Steven Cooreman72f736a2021-05-07 14:14:37 +02005008 operation->is_sign = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005009 operation->mac_size = PSA_HASH_LENGTH(hash_alg);
Steven Cooreman72f736a2021-05-07 14:14:37 +02005010
Gilles Peskine449bd832023-01-11 14:50:10 +01005011 status = psa_driver_wrapper_mac_sign_setup(operation,
5012 &attributes,
5013 hmac_key, hmac_key_length,
5014 PSA_ALG_HMAC(hash_alg));
Steven Cooreman094a77e2021-05-06 17:58:36 +02005015
Gilles Peskine449bd832023-01-11 14:50:10 +01005016 psa_reset_key_attributes(&attributes);
5017 return status;
Steven Cooreman094a77e2021-05-06 17:58:36 +02005018}
5019#endif /* KDF algorithms reliant on HMAC */
John Durkop07cc04a2020-11-16 22:08:34 -08005020
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005021#define HKDF_STATE_INIT 0 /* no input yet */
5022#define HKDF_STATE_STARTED 1 /* got salt */
5023#define HKDF_STATE_KEYED 2 /* got key */
5024#define HKDF_STATE_OUTPUT 3 /* output started */
5025
Gilles Peskinecbe66502019-05-16 16:59:18 +02005026static psa_algorithm_t psa_key_derivation_get_kdf_alg(
Gilles Peskine449bd832023-01-11 14:50:10 +01005027 const psa_key_derivation_operation_t *operation)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005028{
Gilles Peskine449bd832023-01-11 14:50:10 +01005029 if (PSA_ALG_IS_KEY_AGREEMENT(operation->alg)) {
5030 return PSA_ALG_KEY_AGREEMENT_GET_KDF(operation->alg);
5031 } else {
5032 return operation->alg;
5033 }
Gilles Peskine969c5d62019-01-16 15:53:06 +01005034}
5035
Gilles Peskine449bd832023-01-11 14:50:10 +01005036psa_status_t psa_key_derivation_abort(psa_key_derivation_operation_t *operation)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005037{
5038 psa_status_t status = PSA_SUCCESS;
Gilles Peskine449bd832023-01-11 14:50:10 +01005039 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
5040 if (kdf_alg == 0) {
Gilles Peskineeab56e42018-07-12 17:12:33 +02005041 /* The object has (apparently) been initialized but it is not
5042 * in use. It's ok to call abort on such an object, and there's
5043 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005044 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02005045#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01005046 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
5047 mbedtls_free(operation->ctx.hkdf.info);
5048 status = psa_mac_abort(&operation->ctx.hkdf.hmac);
5049 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02005050#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08005051#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5052 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005053 if (PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
5054 /* TLS-1.2 PSK-to-MS KDF uses the same core as TLS-1.2 PRF */
5055 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
5056 if (operation->ctx.tls12_prf.secret != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005057 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.secret,
Gilles Peskine449bd832023-01-11 14:50:10 +01005058 operation->ctx.tls12_prf.secret_length);
Steven Cooremana6df6042021-04-29 19:32:25 +02005059 }
5060
Gilles Peskine449bd832023-01-11 14:50:10 +01005061 if (operation->ctx.tls12_prf.seed != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005062 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.seed,
Gilles Peskine449bd832023-01-11 14:50:10 +01005063 operation->ctx.tls12_prf.seed_length);
Janos Follath6a1d2622019-06-11 10:37:28 +01005064 }
5065
Gilles Peskine449bd832023-01-11 14:50:10 +01005066 if (operation->ctx.tls12_prf.label != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005067 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.label,
Gilles Peskine449bd832023-01-11 14:50:10 +01005068 operation->ctx.tls12_prf.label_length);
Janos Follath6a1d2622019-06-11 10:37:28 +01005069 }
Przemek Stekiel6c764412022-11-22 14:05:12 +01005070#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005071 if (operation->ctx.tls12_prf.other_secret != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005072 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.other_secret,
Gilles Peskine449bd832023-01-11 14:50:10 +01005073 operation->ctx.tls12_prf.other_secret_length);
Przemek Stekiele3ee2212022-04-07 14:29:56 +02005074 }
Przemek Stekiel6c764412022-11-22 14:05:12 +01005075#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Steven Cooremana6df6042021-04-29 19:32:25 +02005076 status = PSA_SUCCESS;
Janos Follath6a1d2622019-06-11 10:37:28 +01005077
5078 /* We leave the fields Ai and output_block to be erased safely by the
5079 * mbedtls_platform_zeroize() in the end of this function. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005080 } else
John Durkop07cc04a2020-11-16 22:08:34 -08005081#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
5082 * defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005083#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005084 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
5085 mbedtls_platform_zeroize(operation->ctx.tls12_ecjpake_to_pms.data,
5086 sizeof(operation->ctx.tls12_ecjpake_to_pms.data));
5087 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005088#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS) */
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305089#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05305090 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305091 if (operation->ctx.pbkdf2.salt != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005092 mbedtls_zeroize_and_free(operation->ctx.pbkdf2.salt,
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305093 operation->ctx.pbkdf2.salt_length);
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305094 }
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305095
5096 status = PSA_SUCCESS;
5097 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305098#endif /* defined(PSA_HAVE_SOFT_PBKDF2) */
Gilles Peskineeab56e42018-07-12 17:12:33 +02005099 {
5100 status = PSA_ERROR_BAD_STATE;
5101 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005102 mbedtls_platform_zeroize(operation, sizeof(*operation));
5103 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005104}
5105
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005106psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskine449bd832023-01-11 14:50:10 +01005107 size_t *capacity)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005108{
Gilles Peskine449bd832023-01-11 14:50:10 +01005109 if (operation->alg == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005110 /* This is a blank key derivation operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005111 return PSA_ERROR_BAD_STATE;
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005112 }
5113
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005114 *capacity = operation->capacity;
Gilles Peskine449bd832023-01-11 14:50:10 +01005115 return PSA_SUCCESS;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005116}
5117
Gilles Peskine449bd832023-01-11 14:50:10 +01005118psa_status_t psa_key_derivation_set_capacity(psa_key_derivation_operation_t *operation,
5119 size_t capacity)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005120{
Gilles Peskine449bd832023-01-11 14:50:10 +01005121 if (operation->alg == 0) {
5122 return PSA_ERROR_BAD_STATE;
5123 }
5124 if (capacity > operation->capacity) {
5125 return PSA_ERROR_INVALID_ARGUMENT;
5126 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005127 operation->capacity = capacity;
Gilles Peskine449bd832023-01-11 14:50:10 +01005128 return PSA_SUCCESS;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005129}
5130
Przemek Stekiel69c46792022-06-10 12:59:51 +02005131#if defined(BUILTIN_ALG_ANY_HKDF)
Przemek Stekiel03d948c2022-05-19 11:45:20 +02005132/* Read some bytes from an HKDF-based operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005133static psa_status_t psa_key_derivation_hkdf_read(psa_hkdf_key_derivation_t *hkdf,
5134 psa_algorithm_t kdf_alg,
5135 uint8_t *output,
5136 size_t output_length)
Gilles Peskinebef7f142018-07-12 17:22:21 +02005137{
Gilles Peskine449bd832023-01-11 14:50:10 +01005138 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
5139 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Steven Cooremand1ed1d92021-04-29 19:11:25 +02005140 size_t hmac_output_length;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005141 psa_status_t status;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005142#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01005143 const uint8_t last_block = PSA_ALG_IS_HKDF_EXTRACT(kdf_alg) ? 0 : 0xff;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005144#else
5145 const uint8_t last_block = 0xff;
5146#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskinebef7f142018-07-12 17:22:21 +02005147
Gilles Peskine449bd832023-01-11 14:50:10 +01005148 if (hkdf->state < HKDF_STATE_KEYED ||
5149 (!hkdf->info_set
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005150#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01005151 && !PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005152#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01005153 )) {
5154 return PSA_ERROR_BAD_STATE;
5155 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005156 hkdf->state = HKDF_STATE_OUTPUT;
5157
Gilles Peskine449bd832023-01-11 14:50:10 +01005158 while (output_length != 0) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005159 /* Copy what remains of the current block */
5160 uint8_t n = hash_length - hkdf->offset_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005161 if (n > output_length) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005162 n = (uint8_t) output_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01005163 }
5164 memcpy(output, hkdf->output_block + hkdf->offset_in_block, n);
Gilles Peskinebef7f142018-07-12 17:22:21 +02005165 output += n;
5166 output_length -= n;
5167 hkdf->offset_in_block += n;
Gilles Peskine449bd832023-01-11 14:50:10 +01005168 if (output_length == 0) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005169 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01005170 }
Przemek Stekiel03d948c2022-05-19 11:45:20 +02005171 /* We can't be wanting more output after the last block, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005172 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005173 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02005174 * object was corrupted or if this function is called directly
5175 * inside the library. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005176 if (hkdf->block_number == last_block) {
5177 return PSA_ERROR_BAD_STATE;
5178 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02005179
5180 /* We need a new block */
5181 ++hkdf->block_number;
5182 hkdf->offset_in_block = 0;
Steven Cooremand1ed1d92021-04-29 19:11:25 +02005183
Gilles Peskine449bd832023-01-11 14:50:10 +01005184 status = psa_key_derivation_start_hmac(&hkdf->hmac,
5185 hash_alg,
5186 hkdf->prk,
5187 hash_length);
5188 if (status != PSA_SUCCESS) {
5189 return status;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005190 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005191
5192 if (hkdf->block_number != 1) {
5193 status = psa_mac_update(&hkdf->hmac,
5194 hkdf->output_block,
5195 hash_length);
5196 if (status != PSA_SUCCESS) {
5197 return status;
5198 }
5199 }
5200 status = psa_mac_update(&hkdf->hmac,
5201 hkdf->info,
5202 hkdf->info_length);
5203 if (status != PSA_SUCCESS) {
5204 return status;
5205 }
5206 status = psa_mac_update(&hkdf->hmac,
5207 &hkdf->block_number, 1);
5208 if (status != PSA_SUCCESS) {
5209 return status;
5210 }
5211 status = psa_mac_sign_finish(&hkdf->hmac,
5212 hkdf->output_block,
5213 sizeof(hkdf->output_block),
5214 &hmac_output_length);
5215 if (status != PSA_SUCCESS) {
5216 return status;
5217 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02005218 }
5219
Gilles Peskine449bd832023-01-11 14:50:10 +01005220 return PSA_SUCCESS;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005221}
Przemek Stekiel69c46792022-06-10 12:59:51 +02005222#endif /* BUILTIN_ALG_ANY_HKDF */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005223
John Durkop07cc04a2020-11-16 22:08:34 -08005224#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5225 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follath7742fee2019-06-17 12:58:10 +01005226static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
5227 psa_tls12_prf_key_derivation_t *tls12_prf,
Gilles Peskine449bd832023-01-11 14:50:10 +01005228 psa_algorithm_t alg)
Janos Follath7742fee2019-06-17 12:58:10 +01005229{
Gilles Peskine449bd832023-01-11 14:50:10 +01005230 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(alg);
5231 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Steven Cooremana6df6042021-04-29 19:32:25 +02005232 psa_mac_operation_t hmac = PSA_MAC_OPERATION_INIT;
5233 size_t hmac_output_length;
Janos Follathea29bfb2019-06-19 12:21:20 +01005234 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005235
Janos Follath7742fee2019-06-17 12:58:10 +01005236 /* We can't be wanting more output after block 0xff, otherwise
5237 * the capacity check in psa_key_derivation_output_bytes() would have
5238 * prevented this call. It could happen only if the operation
5239 * object was corrupted or if this function is called directly
5240 * inside the library. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005241 if (tls12_prf->block_number == 0xff) {
5242 return PSA_ERROR_CORRUPTION_DETECTED;
5243 }
Janos Follath7742fee2019-06-17 12:58:10 +01005244
5245 /* We need a new block */
5246 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01005247 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01005248
5249 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
5250 *
5251 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
5252 *
5253 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
5254 * HMAC_hash(secret, A(2) + seed) +
5255 * HMAC_hash(secret, A(3) + seed) + ...
5256 *
5257 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01005258 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01005259 *
Janos Follathea29bfb2019-06-19 12:21:20 +01005260 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01005261 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01005262 * is currently extracted as `output_block` and where i is
5263 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01005264 */
5265
Gilles Peskine449bd832023-01-11 14:50:10 +01005266 status = psa_key_derivation_start_hmac(&hmac,
5267 hash_alg,
5268 tls12_prf->secret,
5269 tls12_prf->secret_length);
5270 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005271 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005272 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005273
5274 /* Calculate A(i) where i = tls12_prf->block_number. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005275 if (tls12_prf->block_number == 1) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005276 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
5277 * the variable seed and in this instance means it in the context of the
5278 * P_hash function, where seed = label + seed.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01005279 status = psa_mac_update(&hmac,
5280 tls12_prf->label,
5281 tls12_prf->label_length);
5282 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005283 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005284 }
5285 status = psa_mac_update(&hmac,
5286 tls12_prf->seed,
5287 tls12_prf->seed_length);
5288 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005289 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005290 }
5291 } else {
Janos Follathea29bfb2019-06-19 12:21:20 +01005292 /* A(i) = HMAC_hash(secret, A(i-1)) */
Gilles Peskine449bd832023-01-11 14:50:10 +01005293 status = psa_mac_update(&hmac, tls12_prf->Ai, hash_length);
5294 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005295 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005296 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005297 }
5298
Gilles Peskine449bd832023-01-11 14:50:10 +01005299 status = psa_mac_sign_finish(&hmac,
5300 tls12_prf->Ai, hash_length,
5301 &hmac_output_length);
5302 if (hmac_output_length != hash_length) {
Steven Cooremana6df6042021-04-29 19:32:25 +02005303 status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01005304 }
5305 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005306 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005307 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005308
5309 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
Gilles Peskine449bd832023-01-11 14:50:10 +01005310 status = psa_key_derivation_start_hmac(&hmac,
5311 hash_alg,
5312 tls12_prf->secret,
5313 tls12_prf->secret_length);
5314 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005315 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005316 }
5317 status = psa_mac_update(&hmac, tls12_prf->Ai, hash_length);
5318 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005319 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005320 }
5321 status = psa_mac_update(&hmac, tls12_prf->label, tls12_prf->label_length);
5322 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005323 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005324 }
5325 status = psa_mac_update(&hmac, tls12_prf->seed, tls12_prf->seed_length);
5326 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005327 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005328 }
5329 status = psa_mac_sign_finish(&hmac,
5330 tls12_prf->output_block, hash_length,
5331 &hmac_output_length);
5332 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005333 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005334 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005335
Janos Follath7742fee2019-06-17 12:58:10 +01005336
5337cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01005338 cleanup_status = psa_mac_abort(&hmac);
5339 if (status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005340 status = cleanup_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01005341 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005342
Gilles Peskine449bd832023-01-11 14:50:10 +01005343 return status;
Janos Follath7742fee2019-06-17 12:58:10 +01005344}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005345
Janos Follath844eb0e2019-06-19 12:10:49 +01005346static psa_status_t psa_key_derivation_tls12_prf_read(
5347 psa_tls12_prf_key_derivation_t *tls12_prf,
5348 psa_algorithm_t alg,
5349 uint8_t *output,
Gilles Peskine449bd832023-01-11 14:50:10 +01005350 size_t output_length)
Janos Follath844eb0e2019-06-19 12:10:49 +01005351{
Gilles Peskine449bd832023-01-11 14:50:10 +01005352 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH(alg);
5353 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Janos Follath844eb0e2019-06-19 12:10:49 +01005354 psa_status_t status;
5355 uint8_t offset, length;
5356
Gilles Peskine449bd832023-01-11 14:50:10 +01005357 switch (tls12_prf->state) {
Gilles Peskineb1edaec2021-06-11 22:41:46 +02005358 case PSA_TLS12_PRF_STATE_LABEL_SET:
5359 tls12_prf->state = PSA_TLS12_PRF_STATE_OUTPUT;
5360 break;
5361 case PSA_TLS12_PRF_STATE_OUTPUT:
5362 break;
5363 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005364 return PSA_ERROR_BAD_STATE;
Gilles Peskineb1edaec2021-06-11 22:41:46 +02005365 }
5366
Gilles Peskine449bd832023-01-11 14:50:10 +01005367 while (output_length != 0) {
Janos Follath844eb0e2019-06-19 12:10:49 +01005368 /* Check if we have fully processed the current block. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005369 if (tls12_prf->left_in_block == 0) {
5370 status = psa_key_derivation_tls12_prf_generate_next_block(tls12_prf,
5371 alg);
5372 if (status != PSA_SUCCESS) {
5373 return status;
5374 }
Janos Follath844eb0e2019-06-19 12:10:49 +01005375
5376 continue;
5377 }
5378
Gilles Peskine449bd832023-01-11 14:50:10 +01005379 if (tls12_prf->left_in_block > output_length) {
Janos Follath844eb0e2019-06-19 12:10:49 +01005380 length = (uint8_t) output_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01005381 } else {
Janos Follath844eb0e2019-06-19 12:10:49 +01005382 length = tls12_prf->left_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005383 }
Janos Follath844eb0e2019-06-19 12:10:49 +01005384
5385 offset = hash_length - tls12_prf->left_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005386 memcpy(output, tls12_prf->output_block + offset, length);
Janos Follath844eb0e2019-06-19 12:10:49 +01005387 output += length;
5388 output_length -= length;
5389 tls12_prf->left_in_block -= length;
5390 }
5391
Gilles Peskine449bd832023-01-11 14:50:10 +01005392 return PSA_SUCCESS;
Janos Follath844eb0e2019-06-19 12:10:49 +01005393}
John Durkop07cc04a2020-11-16 22:08:34 -08005394#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
5395 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskinebef7f142018-07-12 17:22:21 +02005396
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005397#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
5398static psa_status_t psa_key_derivation_tls12_ecjpake_to_pms_read(
5399 psa_tls12_ecjpake_to_pms_t *ecjpake,
5400 uint8_t *output,
Gilles Peskine449bd832023-01-11 14:50:10 +01005401 size_t output_length)
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005402{
5403 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Andrzej Kurek5603efd2022-09-26 10:49:16 -04005404 size_t output_size = 0;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005405
Gilles Peskine449bd832023-01-11 14:50:10 +01005406 if (output_length != 32) {
5407 return PSA_ERROR_INVALID_ARGUMENT;
5408 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005409
Gilles Peskine449bd832023-01-11 14:50:10 +01005410 status = psa_hash_compute(PSA_ALG_SHA_256, ecjpake->data,
5411 PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE, output, output_length,
5412 &output_size);
5413 if (status != PSA_SUCCESS) {
5414 return status;
5415 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005416
Gilles Peskine449bd832023-01-11 14:50:10 +01005417 if (output_size != output_length) {
5418 return PSA_ERROR_GENERIC_ERROR;
5419 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005420
Gilles Peskine449bd832023-01-11 14:50:10 +01005421 return PSA_SUCCESS;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005422}
5423#endif
5424
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305425#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305426static psa_status_t psa_key_derivation_pbkdf2_generate_block(
5427 psa_pbkdf2_key_derivation_t *pbkdf2,
5428 psa_algorithm_t prf_alg,
5429 uint8_t prf_output_length,
5430 psa_key_attributes_t *attributes)
5431{
5432 psa_status_t status;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305433 psa_mac_operation_t mac_operation = PSA_MAC_OPERATION_INIT;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305434 size_t mac_output_length;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305435 uint8_t U_i[PSA_MAC_MAX_SIZE];
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305436 uint8_t *U_accumulator = pbkdf2->output_block;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305437 uint64_t i;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305438 uint8_t block_counter[4];
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305439
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305440 mac_operation.is_sign = 1;
5441 mac_operation.mac_size = prf_output_length;
5442 MBEDTLS_PUT_UINT32_BE(pbkdf2->block_number, block_counter, 0);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305443
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305444 status = psa_driver_wrapper_mac_sign_setup(&mac_operation,
5445 attributes,
5446 pbkdf2->password,
5447 pbkdf2->password_length,
5448 prf_alg);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305449 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305450 goto cleanup;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305451 }
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305452 status = psa_mac_update(&mac_operation, pbkdf2->salt, pbkdf2->salt_length);
5453 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305454 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305455 }
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305456 status = psa_mac_update(&mac_operation, block_counter, sizeof(block_counter));
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305457 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305458 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305459 }
5460 status = psa_mac_sign_finish(&mac_operation, U_i, sizeof(U_i),
5461 &mac_output_length);
5462 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305463 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305464 }
5465
5466 if (mac_output_length != prf_output_length) {
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305467 status = PSA_ERROR_CORRUPTION_DETECTED;
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305468 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305469 }
5470
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305471 memcpy(U_accumulator, U_i, prf_output_length);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305472
5473 for (i = 1; i < pbkdf2->input_cost; i++) {
Kusumit Ghoderao4536bb62023-06-22 15:42:59 +05305474 /* We are passing prf_output_length as mac_size because the driver
5475 * function directly sets mac_output_length as mac_size upon success.
Kusumit Ghoderao5f3345a2023-07-27 21:21:38 +05305476 * See https://github.com/Mbed-TLS/mbedtls/issues/7801 */
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305477 status = psa_driver_wrapper_mac_compute(attributes,
5478 pbkdf2->password,
5479 pbkdf2->password_length,
5480 prf_alg, U_i, prf_output_length,
Kusumit Ghoderao4536bb62023-06-22 15:42:59 +05305481 U_i, prf_output_length,
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305482 &mac_output_length);
5483 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305484 goto cleanup;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305485 }
5486
Kusumit Ghoderao109ee3d2023-06-08 16:36:45 +05305487 mbedtls_xor(U_accumulator, U_accumulator, U_i, prf_output_length);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305488 }
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305489
5490cleanup:
5491 /* Zeroise buffers to clear sensitive data from memory. */
5492 mbedtls_platform_zeroize(U_i, PSA_MAC_MAX_SIZE);
5493 return status;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305494}
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05305495
5496static psa_status_t psa_key_derivation_pbkdf2_read(
5497 psa_pbkdf2_key_derivation_t *pbkdf2,
5498 psa_algorithm_t kdf_alg,
5499 uint8_t *output,
5500 size_t output_length)
5501{
5502 psa_status_t status;
5503 psa_algorithm_t prf_alg;
5504 uint8_t prf_output_length;
5505 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
5506 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(pbkdf2->password_length));
5507 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
5508
5509 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
5510 prf_alg = PSA_ALG_HMAC(PSA_ALG_PBKDF2_HMAC_GET_HASH(kdf_alg));
5511 prf_output_length = PSA_HASH_LENGTH(prf_alg);
5512 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
Kusumit Ghoderaoa2520a52023-06-22 15:42:19 +05305513 } else if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
5514 prf_alg = PSA_ALG_CMAC;
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05305515 prf_output_length = PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC);
Kusumit Ghoderaoa2520a52023-06-22 15:42:19 +05305516 psa_set_key_type(&attributes, PSA_KEY_TYPE_AES);
Kusumit Ghoderaod9ec1af2023-06-08 20:19:51 +05305517 } else {
5518 return PSA_ERROR_INVALID_ARGUMENT;
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05305519 }
5520
5521 switch (pbkdf2->state) {
5522 case PSA_PBKDF2_STATE_PASSWORD_SET:
5523 /* Initially we need a new block so bytes_used is equal to block size*/
5524 pbkdf2->bytes_used = prf_output_length;
5525 pbkdf2->state = PSA_PBKDF2_STATE_OUTPUT;
5526 break;
5527 case PSA_PBKDF2_STATE_OUTPUT:
5528 break;
5529 default:
5530 return PSA_ERROR_BAD_STATE;
5531 }
5532
5533 while (output_length != 0) {
5534 uint8_t n = prf_output_length - pbkdf2->bytes_used;
5535 if (n > output_length) {
5536 n = (uint8_t) output_length;
5537 }
5538 memcpy(output, pbkdf2->output_block + pbkdf2->bytes_used, n);
5539 output += n;
5540 output_length -= n;
5541 pbkdf2->bytes_used += n;
5542
5543 if (output_length == 0) {
5544 break;
5545 }
5546
5547 /* We need a new block */
5548 pbkdf2->bytes_used = 0;
5549 pbkdf2->block_number++;
5550
5551 status = psa_key_derivation_pbkdf2_generate_block(pbkdf2, prf_alg,
5552 prf_output_length,
5553 &attributes);
5554 if (status != PSA_SUCCESS) {
5555 return status;
5556 }
5557 }
5558
5559 return PSA_SUCCESS;
5560}
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305561#endif /* PSA_HAVE_SOFT_PBKDF2 */
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305562
Janos Follath6c6c8fc2019-06-17 12:38:20 +01005563psa_status_t psa_key_derivation_output_bytes(
5564 psa_key_derivation_operation_t *operation,
5565 uint8_t *output,
Gilles Peskine449bd832023-01-11 14:50:10 +01005566 size_t output_length)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005567{
5568 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01005569 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
Gilles Peskineeab56e42018-07-12 17:12:33 +02005570
Gilles Peskine449bd832023-01-11 14:50:10 +01005571 if (operation->alg == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005572 /* This is a blank operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005573 return PSA_ERROR_BAD_STATE;
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005574 }
5575
Gilles Peskine449bd832023-01-11 14:50:10 +01005576 if (output_length > operation->capacity) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005577 operation->capacity = 0;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005578 /* Go through the error path to wipe all confidential data now
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005579 * that the operation object is useless. */
David Saadab4ecc272019-02-14 13:48:10 +02005580 status = PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005581 goto exit;
5582 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005583 if (output_length == 0 && operation->capacity == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005584 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005585 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02005586 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
5587 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005588 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02005589 * output_length > 0. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005590 return PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005591 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005592 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005593
Przemek Stekiel69c46792022-06-10 12:59:51 +02005594#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01005595 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
5596 status = psa_key_derivation_hkdf_read(&operation->ctx.hkdf, kdf_alg,
5597 output, output_length);
5598 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02005599#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08005600#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5601 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005602 if (PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
5603 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
5604 status = psa_key_derivation_tls12_prf_read(&operation->ctx.tls12_prf,
5605 kdf_alg, output,
5606 output_length);
5607 } else
John Durkop07cc04a2020-11-16 22:08:34 -08005608#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
5609 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005610#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005611 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005612 status = psa_key_derivation_tls12_ecjpake_to_pms_read(
Gilles Peskine449bd832023-01-11 14:50:10 +01005613 &operation->ctx.tls12_ecjpake_to_pms, output, output_length);
5614 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005615#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305616#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05305617 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05305618 status = psa_key_derivation_pbkdf2_read(&operation->ctx.pbkdf2, kdf_alg,
5619 output, output_length);
Kusumit Ghoderao056f0c52023-05-03 15:58:34 +05305620 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305621#endif /* PSA_HAVE_SOFT_PBKDF2 */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005622
Gilles Peskineeab56e42018-07-12 17:12:33 +02005623 {
Steven Cooreman74afe472021-02-10 17:19:22 +01005624 (void) kdf_alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01005625 return PSA_ERROR_BAD_STATE;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005626 }
5627
5628exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005629 if (status != PSA_SUCCESS) {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005630 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005631 * This allows us to differentiate between exhausted operations and
5632 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
5633 * operations. */
5634 psa_algorithm_t alg = operation->alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01005635 psa_key_derivation_abort(operation);
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005636 operation->alg = alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01005637 memset(output, '!', output_length);
Gilles Peskineeab56e42018-07-12 17:12:33 +02005638 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005639 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005640}
5641
David Brown7807bf72021-02-09 16:28:23 -07005642#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01005643static void psa_des_set_key_parity(uint8_t *data, size_t data_size)
Gilles Peskine08542d82018-07-19 17:05:42 +02005644{
Gilles Peskine449bd832023-01-11 14:50:10 +01005645 if (data_size >= 8) {
5646 mbedtls_des_key_set_parity(data);
5647 }
5648 if (data_size >= 16) {
5649 mbedtls_des_key_set_parity(data + 8);
5650 }
5651 if (data_size >= 24) {
5652 mbedtls_des_key_set_parity(data + 16);
5653 }
Gilles Peskine08542d82018-07-19 17:05:42 +02005654}
David Brown7807bf72021-02-09 16:28:23 -07005655#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine08542d82018-07-19 17:05:42 +02005656
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005657/*
Gilles Peskine449bd832023-01-11 14:50:10 +01005658 * ECC keys on a Weierstrass elliptic curve require the generation
5659 * of a private key which is an integer
5660 * in the range [1, N - 1], where N is the boundary of the private key domain:
5661 * N is the prime p for Diffie-Hellman, or the order of the
5662 * curve’s base point for ECC.
5663 *
5664 * Let m be the bit size of N, such that 2^m > N >= 2^(m-1).
5665 * This function generates the private key using the following process:
5666 *
5667 * 1. Draw a byte string of length ceiling(m/8) bytes.
5668 * 2. If m is not a multiple of 8, set the most significant
5669 * (8 * ceiling(m/8) - m) bits of the first byte in the string to zero.
5670 * 3. Convert the string to integer k by decoding it as a big-endian byte string.
5671 * 4. If k > N - 2, discard the result and return to step 1.
5672 * 5. Output k + 1 as the private key.
5673 *
5674 * This method allows compliance to NIST standards, specifically the methods titled
5675 * Key-Pair Generation by Testing Candidates in the following publications:
5676 * - NIST Special Publication 800-56A: Recommendation for Pair-Wise Key-Establishment
5677 * Schemes Using Discrete Logarithm Cryptography [SP800-56A] §5.6.1.1.4 for
5678 * Diffie-Hellman keys.
5679 *
5680 * - [SP800-56A] §5.6.1.2.2 or FIPS Publication 186-4: Digital Signature
5681 * Standard (DSS) [FIPS186-4] §B.4.2 for elliptic curve keys.
5682 *
5683 * Note: Function allocates memory for *data buffer, so given *data should be
5684 * always NULL.
5685 */
Valerio Setti86587ab2023-06-27 13:09:30 +02005686#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE)
5687#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE)
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01005688static psa_status_t psa_generate_derived_ecc_key_weierstrass_helper(
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005689 psa_key_slot_t *slot,
5690 size_t bits,
5691 psa_key_derivation_operation_t *operation,
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005692 uint8_t **data
5693 )
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005694{
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005695 unsigned key_out_of_range = 1;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005696 mbedtls_mpi k;
5697 mbedtls_mpi diff_N_2;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005698 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Przemek Stekiela81aed22022-03-01 15:13:30 +01005699 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01005700 size_t m;
5701 size_t m_bytes;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005702
Gilles Peskine449bd832023-01-11 14:50:10 +01005703 mbedtls_mpi_init(&k);
5704 mbedtls_mpi_init(&diff_N_2);
Przemyslaw Stekiel1dfd1222021-11-18 13:35:00 +01005705
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005706 psa_ecc_family_t curve = PSA_KEY_TYPE_ECC_GET_FAMILY(
Gilles Peskine449bd832023-01-11 14:50:10 +01005707 slot->attr.type);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005708 mbedtls_ecp_group_id grp_id =
Gilles Peskine449bd832023-01-11 14:50:10 +01005709 mbedtls_ecc_group_of_psa(curve, bits, 0);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005710
Gilles Peskine449bd832023-01-11 14:50:10 +01005711 if (grp_id == MBEDTLS_ECP_DP_NONE) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005712 ret = MBEDTLS_ERR_ASN1_INVALID_DATA;
Przemyslaw Stekiel871a3362021-12-02 08:46:39 +01005713 goto cleanup;
5714 }
5715
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005716 mbedtls_ecp_group ecp_group;
Gilles Peskine449bd832023-01-11 14:50:10 +01005717 mbedtls_ecp_group_init(&ecp_group);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005718
Gilles Peskine449bd832023-01-11 14:50:10 +01005719 MBEDTLS_MPI_CHK(mbedtls_ecp_group_load(&ecp_group, grp_id));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005720
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005721 /* N is the boundary of the private key domain (ecp_group.N). */
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005722 /* Let m be the bit size of N. */
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01005723 m = ecp_group.nbits;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005724
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01005725 m_bytes = PSA_BITS_TO_BYTES(m);
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005726
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005727 /* Calculate N - 2 - it will be needed later. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005728 MBEDTLS_MPI_CHK(mbedtls_mpi_sub_int(&diff_N_2, &ecp_group.N, 2));
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005729
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005730 /* Note: This function is always called with *data == NULL and it
5731 * allocates memory for the data buffer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005732 *data = mbedtls_calloc(1, m_bytes);
5733 if (*data == NULL) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005734 ret = MBEDTLS_ERR_ASN1_ALLOC_FAILED;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005735 goto cleanup;
5736 }
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005737
Gilles Peskine449bd832023-01-11 14:50:10 +01005738 while (key_out_of_range) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005739 /* 1. Draw a byte string of length ceiling(m/8) bytes. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005740 if ((status = psa_key_derivation_output_bytes(operation, *data, m_bytes)) != 0) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005741 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005742 }
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005743
5744 /* 2. If m is not a multiple of 8 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005745 if (m % 8 != 0) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005746 /* Set the most significant
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005747 * (8 * ceiling(m/8) - m) bits of the first byte in
5748 * the string to zero.
5749 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005750 uint8_t clear_bit_mask = (1 << (m % 8)) - 1;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005751 (*data)[0] &= clear_bit_mask;
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005752 }
5753
5754 /* 3. Convert the string to integer k by decoding it as a
Gilles Peskine449bd832023-01-11 14:50:10 +01005755 * big-endian byte string.
5756 */
5757 MBEDTLS_MPI_CHK(mbedtls_mpi_read_binary(&k, *data, m_bytes));
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005758
5759 /* 4. If k > N - 2, discard the result and return to step 1.
Gilles Peskine449bd832023-01-11 14:50:10 +01005760 * Result of comparison is returned. When it indicates error
5761 * then this function is called again.
5762 */
5763 MBEDTLS_MPI_CHK(mbedtls_mpi_lt_mpi_ct(&diff_N_2, &k, &key_out_of_range));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005764 }
5765
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005766 /* 5. Output k + 1 as the private key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005767 MBEDTLS_MPI_CHK(mbedtls_mpi_add_int(&k, &k, 1));
5768 MBEDTLS_MPI_CHK(mbedtls_mpi_write_binary(&k, *data, m_bytes));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005769cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01005770 if (ret != 0) {
5771 status = mbedtls_to_psa_error(ret);
5772 }
5773 if (status != PSA_SUCCESS) {
5774 mbedtls_free(*data);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005775 *data = NULL;
5776 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005777 mbedtls_mpi_free(&k);
5778 mbedtls_mpi_free(&diff_N_2);
5779 return status;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005780}
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005781
5782/* ECC keys on a Montgomery elliptic curve draws a byte string whose length
5783 * is determined by the curve, and sets the mandatory bits accordingly. That is:
5784 *
5785 * - Curve25519 (PSA_ECC_FAMILY_MONTGOMERY, 255 bits):
5786 * draw a 32-byte string and process it as specified in
5787 * Elliptic Curves for Security [RFC7748] §5.
5788 *
5789 * - Curve448 (PSA_ECC_FAMILY_MONTGOMERY, 448 bits):
5790 * draw a 56-byte string and process it as specified in [RFC7748] §5.
5791 *
5792 * Note: Function allocates memory for *data buffer, so given *data should be
5793 * always NULL.
5794 */
5795
5796static psa_status_t psa_generate_derived_ecc_key_montgomery_helper(
5797 size_t bits,
5798 psa_key_derivation_operation_t *operation,
5799 uint8_t **data
5800 )
5801{
5802 size_t output_length;
Przemek Stekiela81aed22022-03-01 15:13:30 +01005803 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005804
Gilles Peskine449bd832023-01-11 14:50:10 +01005805 switch (bits) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005806 case 255:
5807 output_length = 32;
5808 break;
5809 case 448:
5810 output_length = 56;
5811 break;
5812 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005813 return PSA_ERROR_INVALID_ARGUMENT;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005814 break;
5815 }
5816
Gilles Peskine449bd832023-01-11 14:50:10 +01005817 *data = mbedtls_calloc(1, output_length);
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005818
Gilles Peskine449bd832023-01-11 14:50:10 +01005819 if (*data == NULL) {
5820 return PSA_ERROR_INSUFFICIENT_MEMORY;
5821 }
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005822
Gilles Peskine449bd832023-01-11 14:50:10 +01005823 status = psa_key_derivation_output_bytes(operation, *data, output_length);
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005824
Gilles Peskine449bd832023-01-11 14:50:10 +01005825 if (status != PSA_SUCCESS) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005826 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01005827 }
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005828
Gilles Peskine449bd832023-01-11 14:50:10 +01005829 switch (bits) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005830 case 255:
5831 (*data)[0] &= 248;
5832 (*data)[31] &= 127;
5833 (*data)[31] |= 64;
5834 break;
5835 case 448:
5836 (*data)[0] &= 252;
5837 (*data)[55] |= 128;
5838 break;
5839 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005840 return PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005841 break;
5842 }
5843
5844 return status;
5845}
Valerio Setti86587ab2023-06-27 13:09:30 +02005846#else /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE */
5847static psa_status_t psa_generate_derived_ecc_key_weierstrass_helper(
5848 psa_key_slot_t *slot, size_t bits,
5849 psa_key_derivation_operation_t *operation, uint8_t **data)
5850{
5851 (void) slot;
5852 (void) bits;
5853 (void) operation;
5854 (void) data;
5855 return PSA_ERROR_NOT_SUPPORTED;
5856}
5857
5858static psa_status_t psa_generate_derived_ecc_key_montgomery_helper(
5859 size_t bits, psa_key_derivation_operation_t *operation, uint8_t **data)
5860{
5861 (void) bits;
5862 (void) operation;
5863 (void) data;
5864 return PSA_ERROR_NOT_SUPPORTED;
5865}
5866#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE */
5867#endif /* PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE */
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005868
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01005869static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005870 psa_key_slot_t *slot,
5871 size_t bits,
Gilles Peskine449bd832023-01-11 14:50:10 +01005872 psa_key_derivation_operation_t *operation)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005873{
5874 uint8_t *data = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01005875 size_t bytes = PSA_BITS_TO_BYTES(bits);
Archanad8a83dc2021-06-14 10:04:16 +05305876 size_t storage_size = bytes;
Przemek Stekiela81aed22022-03-01 15:13:30 +01005877 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01005878 psa_key_attributes_t attributes;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005879
Gilles Peskine449bd832023-01-11 14:50:10 +01005880 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(slot->attr.type)) {
5881 return PSA_ERROR_INVALID_ARGUMENT;
5882 }
Gilles Peskineeab56e42018-07-12 17:12:33 +02005883
Valerio Setti8ffdb5d2023-06-20 13:14:08 +02005884#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE) || \
Valerio Settidd24f292023-06-26 12:21:17 +02005885 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE)
Gilles Peskine449bd832023-01-11 14:50:10 +01005886 if (PSA_KEY_TYPE_IS_ECC(slot->attr.type)) {
5887 psa_ecc_family_t curve = PSA_KEY_TYPE_ECC_GET_FAMILY(slot->attr.type);
5888 if (PSA_ECC_FAMILY_IS_WEIERSTRASS(curve)) {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01005889 /* Weierstrass elliptic curve */
Gilles Peskine449bd832023-01-11 14:50:10 +01005890 status = psa_generate_derived_ecc_key_weierstrass_helper(slot, bits, operation, &data);
5891 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005892 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005893 }
5894 } else {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01005895 /* Montgomery elliptic curve */
Gilles Peskine449bd832023-01-11 14:50:10 +01005896 status = psa_generate_derived_ecc_key_montgomery_helper(bits, operation, &data);
5897 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01005898 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005899 }
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01005900 }
Przemyslaw Stekiel1dfd1222021-11-18 13:35:00 +01005901 } else
Valerio Setti8ffdb5d2023-06-20 13:14:08 +02005902#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE) ||
Valerio Settidd24f292023-06-26 12:21:17 +02005903 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE) */
Gilles Peskine449bd832023-01-11 14:50:10 +01005904 if (key_type_is_raw_bytes(slot->attr.type)) {
5905 if (bits % 8 != 0) {
5906 return PSA_ERROR_INVALID_ARGUMENT;
5907 }
5908 data = mbedtls_calloc(1, bytes);
5909 if (data == NULL) {
5910 return PSA_ERROR_INSUFFICIENT_MEMORY;
5911 }
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01005912
Gilles Peskine449bd832023-01-11 14:50:10 +01005913 status = psa_key_derivation_output_bytes(operation, data, bytes);
5914 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01005915 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005916 }
David Brown12ca5032021-02-11 11:02:00 -07005917#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01005918 if (slot->attr.type == PSA_KEY_TYPE_DES) {
5919 psa_des_set_key_parity(data, bytes);
5920 }
Przemek Stekielf110dc02022-03-01 14:48:05 +01005921#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES) */
Gilles Peskine449bd832023-01-11 14:50:10 +01005922 } else {
5923 return PSA_ERROR_NOT_SUPPORTED;
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01005924 }
Ronald Crondd04d422020-11-28 15:14:42 +01005925
Ronald Cronbf33c932020-11-28 18:06:53 +01005926 slot->attr.bits = (psa_key_bits_t) bits;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01005927 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01005928 .core = slot->attr
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01005929 };
5930
Gilles Peskine449bd832023-01-11 14:50:10 +01005931 if (psa_key_lifetime_is_external(attributes.core.lifetime)) {
5932 status = psa_driver_wrapper_get_key_buffer_size(&attributes,
5933 &storage_size);
5934 if (status != PSA_SUCCESS) {
Archanad8a83dc2021-06-14 10:04:16 +05305935 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005936 }
Archanad8a83dc2021-06-14 10:04:16 +05305937 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005938 status = psa_allocate_buffer_to_slot(slot, storage_size);
5939 if (status != PSA_SUCCESS) {
Archanad8a83dc2021-06-14 10:04:16 +05305940 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005941 }
Archanad8a83dc2021-06-14 10:04:16 +05305942
Gilles Peskine449bd832023-01-11 14:50:10 +01005943 status = psa_driver_wrapper_import_key(&attributes,
5944 data, bytes,
5945 slot->key.data,
5946 slot->key.bytes,
5947 &slot->key.bytes, &bits);
5948 if (bits != slot->attr.bits) {
Ronald Cronbf33c932020-11-28 18:06:53 +01005949 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine449bd832023-01-11 14:50:10 +01005950 }
Gilles Peskineeab56e42018-07-12 17:12:33 +02005951
5952exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005953 mbedtls_free(data);
5954 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005955}
5956
Gilles Peskine449bd832023-01-11 14:50:10 +01005957psa_status_t psa_key_derivation_output_key(const psa_key_attributes_t *attributes,
5958 psa_key_derivation_operation_t *operation,
5959 mbedtls_svc_key_id_t *key)
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005960{
5961 psa_status_t status;
5962 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02005963 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine0f84d622019-09-12 19:03:13 +02005964
Ronald Cron81709fc2020-11-14 12:10:32 +01005965 *key = MBEDTLS_SVC_KEY_ID_INIT;
5966
Gilles Peskine0f84d622019-09-12 19:03:13 +02005967 /* Reject any attempt to create a zero-length key so that we don't
5968 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005969 if (psa_get_key_bits(attributes) == 0) {
5970 return PSA_ERROR_INVALID_ARGUMENT;
5971 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02005972
Gilles Peskine449bd832023-01-11 14:50:10 +01005973 if (operation->alg == PSA_ALG_NONE) {
5974 return PSA_ERROR_BAD_STATE;
5975 }
Dave Rodgmand69da6c2021-11-16 10:32:48 +00005976
Gilles Peskine449bd832023-01-11 14:50:10 +01005977 if (!operation->can_output_key) {
5978 return PSA_ERROR_NOT_PERMITTED;
5979 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02005980
Gilles Peskine449bd832023-01-11 14:50:10 +01005981 status = psa_start_key_creation(PSA_KEY_CREATION_DERIVE, attributes,
5982 &slot, &driver);
Gilles Peskinef4ee6622019-07-24 13:44:30 +02005983#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005984 if (driver != NULL) {
Gilles Peskinef4ee6622019-07-24 13:44:30 +02005985 /* Deriving a key in a secure element is not implemented yet. */
5986 status = PSA_ERROR_NOT_SUPPORTED;
5987 }
5988#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine449bd832023-01-11 14:50:10 +01005989 if (status == PSA_SUCCESS) {
5990 status = psa_generate_derived_key_internal(slot,
5991 attributes->core.bits,
5992 operation);
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005993 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005994 if (status == PSA_SUCCESS) {
5995 status = psa_finish_key_creation(slot, driver, key);
5996 }
5997 if (status != PSA_SUCCESS) {
5998 psa_fail_key_creation(slot, driver);
5999 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02006000
Gilles Peskine449bd832023-01-11 14:50:10 +01006001 return status;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006002}
6003
Gilles Peskineeab56e42018-07-12 17:12:33 +02006004
6005
6006/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02006007/* Key derivation */
6008/****************************************************************/
6009
Steven Cooreman932ffb72021-02-15 12:14:32 +01006010#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006011static int is_kdf_alg_supported(psa_algorithm_t kdf_alg)
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006012{
6013#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006014 if (PSA_ALG_IS_HKDF(kdf_alg)) {
6015 return 1;
6016 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006017#endif
Przemek Stekielb57a44b2022-06-06 08:33:45 +02006018#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006019 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6020 return 1;
6021 }
Przemek Stekielb57a44b2022-06-06 08:33:45 +02006022#endif
6023#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006024 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
6025 return 1;
6026 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006027#endif
6028#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006029 if (PSA_ALG_IS_TLS12_PRF(kdf_alg)) {
6030 return 1;
6031 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006032#endif
6033#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006034 if (PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
6035 return 1;
6036 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006037#endif
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006038#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006039 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
6040 return 1;
6041 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006042#endif
Kusumit Ghoderaod132cac2023-05-03 12:00:27 +05306043#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
6044 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
6045 return 1;
6046 }
6047#endif
Kusumit Ghoderao2cd64962023-06-22 15:38:57 +05306048#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128)
6049 if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
6050 return 1;
6051 }
6052#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006053 return 0;
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006054}
6055
Gilles Peskine449bd832023-01-11 14:50:10 +01006056static psa_status_t psa_hash_try_support(psa_algorithm_t alg)
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006057{
6058 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01006059 psa_status_t status = psa_hash_setup(&operation, alg);
6060 psa_hash_abort(&operation);
6061 return status;
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006062}
6063
Gilles Peskine969c5d62019-01-16 15:53:06 +01006064static psa_status_t psa_key_derivation_setup_kdf(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006065 psa_key_derivation_operation_t *operation,
Gilles Peskine449bd832023-01-11 14:50:10 +01006066 psa_algorithm_t kdf_alg)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006067{
Janos Follath5fe19732019-06-20 15:09:30 +01006068 /* Make sure that operation->ctx is properly zero-initialised. (Macro
6069 * initialisers for this union leave some bytes unspecified.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01006070 memset(&operation->ctx, 0, sizeof(operation->ctx));
Janos Follath5fe19732019-06-20 15:09:30 +01006071
Gilles Peskine969c5d62019-01-16 15:53:06 +01006072 /* Make sure that kdf_alg is a supported key derivation algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006073 if (!is_kdf_alg_supported(kdf_alg)) {
6074 return PSA_ERROR_NOT_SUPPORTED;
6075 }
John Durkop07cc04a2020-11-16 22:08:34 -08006076
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006077 /* All currently supported key derivation algorithms (apart from
Kusumit Ghoderao2cd64962023-06-22 15:38:57 +05306078 * ecjpake to pms and pbkdf2_aes_cmac_128) are based on a hash algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006079 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
6080 size_t hash_size = PSA_HASH_LENGTH(hash_alg);
Kusumit Ghoderao2cd64962023-06-22 15:38:57 +05306081 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
6082 hash_size = PSA_HASH_LENGTH(PSA_ALG_SHA_256);
6083 } else if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306084 hash_size = PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC);
Kusumit Ghoderao2cd64962023-06-22 15:38:57 +05306085 } else {
Gilles Peskine449bd832023-01-11 14:50:10 +01006086 if (hash_size == 0) {
6087 return PSA_ERROR_NOT_SUPPORTED;
6088 }
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006089
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006090 /* Make sure that hash_alg is a supported hash algorithm. Otherwise
6091 * we might fail later, which is somewhat unfriendly and potentially
6092 * risk-prone. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006093 psa_status_t status = psa_hash_try_support(hash_alg);
6094 if (status != PSA_SUCCESS) {
6095 return status;
6096 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006097 }
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006098
Gilles Peskine449bd832023-01-11 14:50:10 +01006099 if ((PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
6100 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) &&
6101 !(hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384)) {
6102 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006103 }
Andrzej Kurek77638292022-09-16 12:24:52 -04006104#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT) || \
Andrzej Kurekb510cd22022-09-26 10:50:22 -04006105 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006106 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg) ||
6107 (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS)) {
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006108 operation->capacity = hash_size;
Gilles Peskine449bd832023-01-11 14:50:10 +01006109 } else
Andrzej Kurekb510cd22022-09-26 10:50:22 -04006110#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT ||
6111 MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Gilles Peskine449bd832023-01-11 14:50:10 +01006112 operation->capacity = 255 * hash_size;
6113 return PSA_SUCCESS;
Gilles Peskine969c5d62019-01-16 15:53:06 +01006114}
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006115
Gilles Peskine449bd832023-01-11 14:50:10 +01006116static psa_status_t psa_key_agreement_try_support(psa_algorithm_t alg)
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006117{
6118#if defined(PSA_WANT_ALG_ECDH)
Gilles Peskine449bd832023-01-11 14:50:10 +01006119 if (alg == PSA_ALG_ECDH) {
6120 return PSA_SUCCESS;
6121 }
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006122#endif
Przemek Stekielfb3dd542022-12-01 14:59:15 +01006123#if defined(PSA_WANT_ALG_FFDH)
6124 if (alg == PSA_ALG_FFDH) {
6125 return PSA_SUCCESS;
6126 }
6127#endif
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006128 (void) alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01006129 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006130}
Gilles Peskinebb3814c2022-12-16 01:12:12 +01006131
6132static int psa_key_derivation_allows_free_form_secret_input(
6133 psa_algorithm_t kdf_alg)
6134{
6135#if defined(PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS)
6136 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
6137 return 0;
6138 }
6139#endif
6140 (void) kdf_alg;
6141 return 1;
6142}
John Durkop07cc04a2020-11-16 22:08:34 -08006143#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01006144
Gilles Peskine449bd832023-01-11 14:50:10 +01006145psa_status_t psa_key_derivation_setup(psa_key_derivation_operation_t *operation,
6146 psa_algorithm_t alg)
Gilles Peskine969c5d62019-01-16 15:53:06 +01006147{
6148 psa_status_t status;
6149
Gilles Peskine449bd832023-01-11 14:50:10 +01006150 if (operation->alg != 0) {
6151 return PSA_ERROR_BAD_STATE;
Gilles Peskine969c5d62019-01-16 15:53:06 +01006152 }
Gilles Peskine969c5d62019-01-16 15:53:06 +01006153
Gilles Peskine449bd832023-01-11 14:50:10 +01006154 if (PSA_ALG_IS_RAW_KEY_AGREEMENT(alg)) {
6155 return PSA_ERROR_INVALID_ARGUMENT;
6156 } else if (PSA_ALG_IS_KEY_AGREEMENT(alg)) {
6157#if defined(AT_LEAST_ONE_BUILTIN_KDF)
6158 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF(alg);
6159 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE(alg);
6160 status = psa_key_agreement_try_support(ka_alg);
6161 if (status != PSA_SUCCESS) {
6162 return status;
6163 }
Gilles Peskinebb3814c2022-12-16 01:12:12 +01006164 if (!psa_key_derivation_allows_free_form_secret_input(kdf_alg)) {
6165 return PSA_ERROR_INVALID_ARGUMENT;
6166 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006167 status = psa_key_derivation_setup_kdf(operation, kdf_alg);
6168#else
6169 return PSA_ERROR_NOT_SUPPORTED;
6170#endif /* AT_LEAST_ONE_BUILTIN_KDF */
6171 } else if (PSA_ALG_IS_KEY_DERIVATION(alg)) {
6172#if defined(AT_LEAST_ONE_BUILTIN_KDF)
6173 status = psa_key_derivation_setup_kdf(operation, alg);
6174#else
6175 return PSA_ERROR_NOT_SUPPORTED;
6176#endif /* AT_LEAST_ONE_BUILTIN_KDF */
6177 } else {
6178 return PSA_ERROR_INVALID_ARGUMENT;
6179 }
6180
6181 if (status == PSA_SUCCESS) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006182 operation->alg = alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01006183 }
6184 return status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006185}
6186
Przemek Stekiel69c46792022-06-10 12:59:51 +02006187#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006188static psa_status_t psa_hkdf_input(psa_hkdf_key_derivation_t *hkdf,
6189 psa_algorithm_t kdf_alg,
6190 psa_key_derivation_step_t step,
6191 const uint8_t *data,
6192 size_t data_length)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006193{
Gilles Peskine449bd832023-01-11 14:50:10 +01006194 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006195 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006196 switch (step) {
Gilles Peskine03410b52019-05-16 16:05:19 +02006197 case PSA_KEY_DERIVATION_INPUT_SALT:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006198#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006199 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
6200 return PSA_ERROR_INVALID_ARGUMENT;
6201 }
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006202#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND */
Gilles Peskine449bd832023-01-11 14:50:10 +01006203 if (hkdf->state != HKDF_STATE_INIT) {
6204 return PSA_ERROR_BAD_STATE;
6205 } else {
6206 status = psa_key_derivation_start_hmac(&hkdf->hmac,
6207 hash_alg,
6208 data, data_length);
6209 if (status != PSA_SUCCESS) {
6210 return status;
6211 }
Steven Cooremand1ed1d92021-04-29 19:11:25 +02006212 hkdf->state = HKDF_STATE_STARTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01006213 return PSA_SUCCESS;
Steven Cooremand1ed1d92021-04-29 19:11:25 +02006214 }
Gilles Peskine03410b52019-05-16 16:05:19 +02006215 case PSA_KEY_DERIVATION_INPUT_SECRET:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006216#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006217 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
Przemek Stekiel2fb0dcd2022-05-19 10:34:37 +02006218 /* We shouldn't be in different state as HKDF_EXPAND only allows
6219 * two inputs: SECRET (this case) and INFO which does not modify
6220 * the state. It could happen only if the hkdf
6221 * object was corrupted. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006222 if (hkdf->state != HKDF_STATE_INIT) {
6223 return PSA_ERROR_BAD_STATE;
6224 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006225
Przemek Stekiel2fb0dcd2022-05-19 10:34:37 +02006226 /* Allow only input that fits expected prk size */
Gilles Peskine449bd832023-01-11 14:50:10 +01006227 if (data_length != PSA_HASH_LENGTH(hash_alg)) {
6228 return PSA_ERROR_INVALID_ARGUMENT;
6229 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006230
Gilles Peskine449bd832023-01-11 14:50:10 +01006231 memcpy(hkdf->prk, data, data_length);
6232 } else
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006233#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND */
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006234 {
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006235 /* HKDF: If no salt was provided, use an empty salt.
6236 * HKDF-EXTRACT: salt is mandatory. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006237 if (hkdf->state == HKDF_STATE_INIT) {
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006238#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006239 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6240 return PSA_ERROR_BAD_STATE;
6241 }
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006242#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01006243 status = psa_key_derivation_start_hmac(&hkdf->hmac,
6244 hash_alg,
6245 NULL, 0);
6246 if (status != PSA_SUCCESS) {
6247 return status;
6248 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006249 hkdf->state = HKDF_STATE_STARTED;
6250 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006251 if (hkdf->state != HKDF_STATE_STARTED) {
6252 return PSA_ERROR_BAD_STATE;
6253 }
6254 status = psa_mac_update(&hkdf->hmac,
6255 data, data_length);
6256 if (status != PSA_SUCCESS) {
6257 return status;
6258 }
6259 status = psa_mac_sign_finish(&hkdf->hmac,
6260 hkdf->prk,
6261 sizeof(hkdf->prk),
6262 &data_length);
6263 if (status != PSA_SUCCESS) {
6264 return status;
6265 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006266 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006267
Gilles Peskine2b522db2019-04-12 15:11:49 +02006268 hkdf->state = HKDF_STATE_KEYED;
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006269 hkdf->block_number = 0;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006270#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006271 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006272 /* The only block of output is the PRK. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006273 memcpy(hkdf->output_block, hkdf->prk, PSA_HASH_LENGTH(hash_alg));
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006274 hkdf->offset_in_block = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01006275 } else
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006276#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006277 {
6278 /* Block 0 is empty, and the next block will be
6279 * generated by psa_key_derivation_hkdf_read(). */
Gilles Peskine449bd832023-01-11 14:50:10 +01006280 hkdf->offset_in_block = PSA_HASH_LENGTH(hash_alg);
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006281 }
6282
Gilles Peskine449bd832023-01-11 14:50:10 +01006283 return PSA_SUCCESS;
Gilles Peskine03410b52019-05-16 16:05:19 +02006284 case PSA_KEY_DERIVATION_INPUT_INFO:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006285#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006286 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6287 return PSA_ERROR_INVALID_ARGUMENT;
6288 }
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006289#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Przemek Stekielcde3f782022-06-03 16:12:27 +02006290#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006291 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg) &&
6292 hkdf->state == HKDF_STATE_INIT) {
6293 return PSA_ERROR_BAD_STATE;
6294 }
Przemek Stekielcde3f782022-06-03 16:12:27 +02006295#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01006296 if (hkdf->state == HKDF_STATE_OUTPUT) {
6297 return PSA_ERROR_BAD_STATE;
6298 }
6299 if (hkdf->info_set) {
6300 return PSA_ERROR_BAD_STATE;
6301 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006302 hkdf->info_length = data_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01006303 if (data_length != 0) {
6304 hkdf->info = mbedtls_calloc(1, data_length);
6305 if (hkdf->info == NULL) {
6306 return PSA_ERROR_INSUFFICIENT_MEMORY;
6307 }
6308 memcpy(hkdf->info, data, data_length);
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006309 }
6310 hkdf->info_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01006311 return PSA_SUCCESS;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006312 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006313 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006314 }
6315}
Przemek Stekiel69c46792022-06-10 12:59:51 +02006316#endif /* BUILTIN_ALG_ANY_HKDF */
Janos Follathb03233e2019-06-11 15:30:30 +01006317
John Durkop07cc04a2020-11-16 22:08:34 -08006318#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
6319 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006320static psa_status_t psa_tls12_prf_set_seed(psa_tls12_prf_key_derivation_t *prf,
6321 const uint8_t *data,
6322 size_t data_length)
Janos Follathf08e2652019-06-13 09:05:41 +01006323{
Gilles Peskine449bd832023-01-11 14:50:10 +01006324 if (prf->state != PSA_TLS12_PRF_STATE_INIT) {
6325 return PSA_ERROR_BAD_STATE;
6326 }
Janos Follathf08e2652019-06-13 09:05:41 +01006327
Gilles Peskine449bd832023-01-11 14:50:10 +01006328 if (data_length != 0) {
6329 prf->seed = mbedtls_calloc(1, data_length);
6330 if (prf->seed == NULL) {
6331 return PSA_ERROR_INSUFFICIENT_MEMORY;
6332 }
Janos Follathf08e2652019-06-13 09:05:41 +01006333
Gilles Peskine449bd832023-01-11 14:50:10 +01006334 memcpy(prf->seed, data, data_length);
Janos Follathd6dce9f2019-07-04 09:11:38 +01006335 prf->seed_length = data_length;
6336 }
Janos Follathf08e2652019-06-13 09:05:41 +01006337
Gilles Peskine43f958b2020-12-13 14:55:14 +01006338 prf->state = PSA_TLS12_PRF_STATE_SEED_SET;
Janos Follathf08e2652019-06-13 09:05:41 +01006339
Gilles Peskine449bd832023-01-11 14:50:10 +01006340 return PSA_SUCCESS;
Janos Follathf08e2652019-06-13 09:05:41 +01006341}
6342
Gilles Peskine449bd832023-01-11 14:50:10 +01006343static psa_status_t psa_tls12_prf_set_key(psa_tls12_prf_key_derivation_t *prf,
6344 const uint8_t *data,
6345 size_t data_length)
Janos Follath81550542019-06-13 14:26:34 +01006346{
Gilles Peskine449bd832023-01-11 14:50:10 +01006347 if (prf->state != PSA_TLS12_PRF_STATE_SEED_SET &&
6348 prf->state != PSA_TLS12_PRF_STATE_OTHER_KEY_SET) {
6349 return PSA_ERROR_BAD_STATE;
6350 }
Janos Follath81550542019-06-13 14:26:34 +01006351
Gilles Peskine449bd832023-01-11 14:50:10 +01006352 if (data_length != 0) {
6353 prf->secret = mbedtls_calloc(1, data_length);
6354 if (prf->secret == NULL) {
6355 return PSA_ERROR_INSUFFICIENT_MEMORY;
6356 }
Steven Cooremana6df6042021-04-29 19:32:25 +02006357
Gilles Peskine449bd832023-01-11 14:50:10 +01006358 memcpy(prf->secret, data, data_length);
Steven Cooremana6df6042021-04-29 19:32:25 +02006359 prf->secret_length = data_length;
6360 }
Janos Follath81550542019-06-13 14:26:34 +01006361
Gilles Peskine43f958b2020-12-13 14:55:14 +01006362 prf->state = PSA_TLS12_PRF_STATE_KEY_SET;
Janos Follath81550542019-06-13 14:26:34 +01006363
Gilles Peskine449bd832023-01-11 14:50:10 +01006364 return PSA_SUCCESS;
Janos Follath81550542019-06-13 14:26:34 +01006365}
6366
Gilles Peskine449bd832023-01-11 14:50:10 +01006367static psa_status_t psa_tls12_prf_set_label(psa_tls12_prf_key_derivation_t *prf,
6368 const uint8_t *data,
6369 size_t data_length)
Janos Follath63028dd2019-06-13 09:15:47 +01006370{
Gilles Peskine449bd832023-01-11 14:50:10 +01006371 if (prf->state != PSA_TLS12_PRF_STATE_KEY_SET) {
6372 return PSA_ERROR_BAD_STATE;
6373 }
Janos Follath63028dd2019-06-13 09:15:47 +01006374
Gilles Peskine449bd832023-01-11 14:50:10 +01006375 if (data_length != 0) {
6376 prf->label = mbedtls_calloc(1, data_length);
6377 if (prf->label == NULL) {
6378 return PSA_ERROR_INSUFFICIENT_MEMORY;
6379 }
Janos Follath63028dd2019-06-13 09:15:47 +01006380
Gilles Peskine449bd832023-01-11 14:50:10 +01006381 memcpy(prf->label, data, data_length);
Janos Follathd6dce9f2019-07-04 09:11:38 +01006382 prf->label_length = data_length;
6383 }
Janos Follath63028dd2019-06-13 09:15:47 +01006384
Gilles Peskine43f958b2020-12-13 14:55:14 +01006385 prf->state = PSA_TLS12_PRF_STATE_LABEL_SET;
Janos Follath63028dd2019-06-13 09:15:47 +01006386
Gilles Peskine449bd832023-01-11 14:50:10 +01006387 return PSA_SUCCESS;
Janos Follath63028dd2019-06-13 09:15:47 +01006388}
6389
Gilles Peskine449bd832023-01-11 14:50:10 +01006390static psa_status_t psa_tls12_prf_input(psa_tls12_prf_key_derivation_t *prf,
6391 psa_key_derivation_step_t step,
6392 const uint8_t *data,
6393 size_t data_length)
Janos Follathb03233e2019-06-11 15:30:30 +01006394{
Gilles Peskine449bd832023-01-11 14:50:10 +01006395 switch (step) {
Janos Follathf08e2652019-06-13 09:05:41 +01006396 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskine449bd832023-01-11 14:50:10 +01006397 return psa_tls12_prf_set_seed(prf, data, data_length);
Janos Follath81550542019-06-13 14:26:34 +01006398 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006399 return psa_tls12_prf_set_key(prf, data, data_length);
Janos Follath63028dd2019-06-13 09:15:47 +01006400 case PSA_KEY_DERIVATION_INPUT_LABEL:
Gilles Peskine449bd832023-01-11 14:50:10 +01006401 return psa_tls12_prf_set_label(prf, data, data_length);
Janos Follathb03233e2019-06-11 15:30:30 +01006402 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006403 return PSA_ERROR_INVALID_ARGUMENT;
Janos Follathb03233e2019-06-11 15:30:30 +01006404 }
6405}
John Durkop07cc04a2020-11-16 22:08:34 -08006406#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
6407 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
6408
6409#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
6410static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
6411 psa_tls12_prf_key_derivation_t *prf,
John Durkop07cc04a2020-11-16 22:08:34 -08006412 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006413 size_t data_length)
John Durkop07cc04a2020-11-16 22:08:34 -08006414{
6415 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006416 const size_t pms_len = (prf->state == PSA_TLS12_PRF_STATE_OTHER_KEY_SET ?
6417 4 + data_length + prf->other_secret_length :
6418 4 + 2 * data_length);
John Durkop07cc04a2020-11-16 22:08:34 -08006419
Gilles Peskine449bd832023-01-11 14:50:10 +01006420 if (data_length > PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE) {
6421 return PSA_ERROR_INVALID_ARGUMENT;
6422 }
John Durkop07cc04a2020-11-16 22:08:34 -08006423
Gilles Peskine449bd832023-01-11 14:50:10 +01006424 uint8_t *pms = mbedtls_calloc(1, pms_len);
6425 if (pms == NULL) {
6426 return PSA_ERROR_INSUFFICIENT_MEMORY;
6427 }
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02006428 uint8_t *cur = pms;
6429
6430 /* pure-PSK:
6431 * Quoting RFC 4279, Section 2:
John Durkop07cc04a2020-11-16 22:08:34 -08006432 *
6433 * The premaster secret is formed as follows: if the PSK is N octets
6434 * long, concatenate a uint16 with the value N, N zero octets, a second
6435 * uint16 with the value N, and the PSK itself.
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02006436 *
6437 * mixed-PSK:
6438 * In a DHE-PSK, RSA-PSK, ECDHE-PSK the premaster secret is formed as
6439 * follows: concatenate a uint16 with the length of the other secret,
6440 * the other secret itself, uint16 with the length of PSK, and the
6441 * PSK itself.
6442 * For details please check:
6443 * - RFC 4279, Section 4 for the definition of RSA-PSK,
6444 * - RFC 4279, Section 3 for the definition of DHE-PSK,
6445 * - RFC 5489 for the definition of ECDHE-PSK.
John Durkop07cc04a2020-11-16 22:08:34 -08006446 */
6447
Gilles Peskine449bd832023-01-11 14:50:10 +01006448 if (prf->state == PSA_TLS12_PRF_STATE_OTHER_KEY_SET) {
6449 *cur++ = MBEDTLS_BYTE_1(prf->other_secret_length);
6450 *cur++ = MBEDTLS_BYTE_0(prf->other_secret_length);
6451 if (prf->other_secret_length != 0) {
6452 memcpy(cur, prf->other_secret, prf->other_secret_length);
6453 mbedtls_platform_zeroize(prf->other_secret, prf->other_secret_length);
Przemek Stekiel2503f7e2022-04-12 12:08:01 +02006454 cur += prf->other_secret_length;
6455 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006456 } else {
6457 *cur++ = MBEDTLS_BYTE_1(data_length);
6458 *cur++ = MBEDTLS_BYTE_0(data_length);
6459 memset(cur, 0, data_length);
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02006460 cur += data_length;
6461 }
6462
Gilles Peskine449bd832023-01-11 14:50:10 +01006463 *cur++ = MBEDTLS_BYTE_1(data_length);
6464 *cur++ = MBEDTLS_BYTE_0(data_length);
6465 memcpy(cur, data, data_length);
John Durkop07cc04a2020-11-16 22:08:34 -08006466 cur += data_length;
6467
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00006468 status = psa_tls12_prf_set_key(prf, pms, (size_t) (cur - pms));
John Durkop07cc04a2020-11-16 22:08:34 -08006469
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01006470 mbedtls_zeroize_and_free(pms, pms_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01006471 return status;
John Durkop07cc04a2020-11-16 22:08:34 -08006472}
Janos Follath6660f0e2019-06-17 08:44:03 +01006473
Przemek Stekiele47201b2022-04-19 13:53:28 +02006474static psa_status_t psa_tls12_prf_psk_to_ms_set_other_key(
6475 psa_tls12_prf_key_derivation_t *prf,
6476 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006477 size_t data_length)
Przemek Stekiele47201b2022-04-19 13:53:28 +02006478{
Gilles Peskine449bd832023-01-11 14:50:10 +01006479 if (prf->state != PSA_TLS12_PRF_STATE_SEED_SET) {
6480 return PSA_ERROR_BAD_STATE;
Przemek Stekiele47201b2022-04-19 13:53:28 +02006481 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006482
6483 if (data_length != 0) {
6484 prf->other_secret = mbedtls_calloc(1, data_length);
6485 if (prf->other_secret == NULL) {
6486 return PSA_ERROR_INSUFFICIENT_MEMORY;
6487 }
6488
6489 memcpy(prf->other_secret, data, data_length);
6490 prf->other_secret_length = data_length;
6491 } else {
Przemek Stekiele47201b2022-04-19 13:53:28 +02006492 prf->other_secret_length = 0;
6493 }
6494
6495 prf->state = PSA_TLS12_PRF_STATE_OTHER_KEY_SET;
6496
Gilles Peskine449bd832023-01-11 14:50:10 +01006497 return PSA_SUCCESS;
Przemek Stekiele47201b2022-04-19 13:53:28 +02006498}
6499
Janos Follath6660f0e2019-06-17 08:44:03 +01006500static psa_status_t psa_tls12_prf_psk_to_ms_input(
6501 psa_tls12_prf_key_derivation_t *prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01006502 psa_key_derivation_step_t step,
6503 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006504 size_t data_length)
Janos Follath6660f0e2019-06-17 08:44:03 +01006505{
Gilles Peskine449bd832023-01-11 14:50:10 +01006506 switch (step) {
Przemek Stekiele47201b2022-04-19 13:53:28 +02006507 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006508 return psa_tls12_prf_psk_to_ms_set_key(prf,
6509 data, data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02006510 break;
6511 case PSA_KEY_DERIVATION_INPUT_OTHER_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006512 return psa_tls12_prf_psk_to_ms_set_other_key(prf,
6513 data,
6514 data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02006515 break;
6516 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006517 return psa_tls12_prf_input(prf, step, data, data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02006518 break;
Janos Follath6660f0e2019-06-17 08:44:03 +01006519
Przemek Stekiele47201b2022-04-19 13:53:28 +02006520 }
Janos Follath6660f0e2019-06-17 08:44:03 +01006521}
John Durkop07cc04a2020-11-16 22:08:34 -08006522#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006523
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006524#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
6525static psa_status_t psa_tls12_ecjpake_to_pms_input(
6526 psa_tls12_ecjpake_to_pms_t *ecjpake,
Andrzej Kurek702776f2022-09-16 06:22:44 -04006527 psa_key_derivation_step_t step,
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006528 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006529 size_t data_length)
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006530{
Gilles Peskine449bd832023-01-11 14:50:10 +01006531 if (data_length != PSA_TLS12_ECJPAKE_TO_PMS_INPUT_SIZE ||
6532 step != PSA_KEY_DERIVATION_INPUT_SECRET) {
6533 return PSA_ERROR_INVALID_ARGUMENT;
Andrzej Kurek5603efd2022-09-26 10:49:16 -04006534 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006535
6536 /* Check if the passed point is in an uncompressed form */
Gilles Peskine449bd832023-01-11 14:50:10 +01006537 if (data[0] != 0x04) {
6538 return PSA_ERROR_INVALID_ARGUMENT;
6539 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006540
6541 /* Only K.X has to be extracted - bytes 1 to 32 inclusive. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006542 memcpy(ecjpake->data, data + 1, PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE);
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006543
Gilles Peskine449bd832023-01-11 14:50:10 +01006544 return PSA_SUCCESS;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006545}
6546#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306547
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306548#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306549static psa_status_t psa_pbkdf2_set_input_cost(
6550 psa_pbkdf2_key_derivation_t *pbkdf2,
6551 psa_key_derivation_step_t step,
6552 uint64_t data)
6553{
6554 if (step != PSA_KEY_DERIVATION_INPUT_COST) {
6555 return PSA_ERROR_INVALID_ARGUMENT;
6556 }
6557
6558 if (pbkdf2->state != PSA_PBKDF2_STATE_INIT) {
6559 return PSA_ERROR_BAD_STATE;
6560 }
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05306561
Kusumit Ghoderaoe66a8ad2023-05-24 12:30:43 +05306562 if (data > PSA_VENDOR_PBKDF2_MAX_ITERATIONS) {
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05306563 return PSA_ERROR_NOT_SUPPORTED;
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306564 }
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05306565
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306566 if (data == 0) {
6567 return PSA_ERROR_INVALID_ARGUMENT;
6568 }
Kusumit Ghoderaoe66a8ad2023-05-24 12:30:43 +05306569
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306570 pbkdf2->input_cost = data;
6571 pbkdf2->state = PSA_PBKDF2_STATE_INPUT_COST_SET;
6572
6573 return PSA_SUCCESS;
6574}
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306575
6576static psa_status_t psa_pbkdf2_set_salt(psa_pbkdf2_key_derivation_t *pbkdf2,
6577 const uint8_t *data,
6578 size_t data_length)
6579{
Gilles Peskineead17662023-08-20 22:02:51 +02006580 if (pbkdf2->state == PSA_PBKDF2_STATE_INPUT_COST_SET) {
6581 pbkdf2->state = PSA_PBKDF2_STATE_SALT_SET;
6582 } else if (pbkdf2->state == PSA_PBKDF2_STATE_SALT_SET) {
6583 /* Appending to existing salt. No state change. */
6584 } else {
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306585 return PSA_ERROR_BAD_STATE;
6586 }
6587
Gilles Peskineca57d782023-07-20 19:08:06 +02006588 if (data_length == 0) {
Gilles Peskineead17662023-08-20 22:02:51 +02006589 /* Appending an empty string, nothing to do. */
6590 } else {
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306591 uint8_t *next_salt;
Kusumit Ghoderaob538bb72023-05-24 12:32:14 +05306592
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306593 next_salt = mbedtls_calloc(1, data_length + pbkdf2->salt_length);
6594 if (next_salt == NULL) {
Kusumit Ghoderaod0422f32023-05-08 15:56:19 +05306595 return PSA_ERROR_INSUFFICIENT_MEMORY;
6596 }
6597
Gilles Peskineead17662023-08-20 22:02:51 +02006598 if (pbkdf2->salt_length != 0) {
6599 memcpy(next_salt, pbkdf2->salt, pbkdf2->salt_length);
6600 }
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306601 memcpy(next_salt + pbkdf2->salt_length, data, data_length);
Kusumit Ghoderaod0422f32023-05-08 15:56:19 +05306602 pbkdf2->salt_length += data_length;
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306603 mbedtls_free(pbkdf2->salt);
6604 pbkdf2->salt = next_salt;
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306605 }
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306606 return PSA_SUCCESS;
6607}
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306608
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05306609#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306610static psa_status_t psa_pbkdf2_hmac_set_password(psa_algorithm_t hash_alg,
Kusumit Ghoderaoaac9a582023-05-24 14:19:17 +05306611 const uint8_t *input,
6612 size_t input_len,
6613 uint8_t *output,
Kusumit Ghoderao91f99f52023-05-24 22:21:48 +05306614 size_t *output_len)
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306615{
6616 psa_status_t status = PSA_SUCCESS;
6617 if (input_len > PSA_HASH_BLOCK_LENGTH(hash_alg)) {
6618 status = psa_hash_compute(hash_alg, input, input_len, output,
Kusumit Ghoderao91f99f52023-05-24 22:21:48 +05306619 PSA_HMAC_MAX_HASH_BLOCK_SIZE, output_len);
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306620 } else {
6621 memcpy(output, input, input_len);
Kusumit Ghoderao91f99f52023-05-24 22:21:48 +05306622 *output_len = PSA_HASH_BLOCK_LENGTH(hash_alg);
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306623 }
6624 return status;
6625}
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05306626#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC */
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306627
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05306628#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128)
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306629static psa_status_t psa_pbkdf2_cmac_set_password(const uint8_t *input,
6630 size_t input_len,
6631 uint8_t *output,
6632 size_t *output_len)
6633{
6634 psa_status_t status = PSA_SUCCESS;
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306635 if (input_len != PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC)) {
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306636 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Kusumit Ghoderao3fde8fe2023-06-27 10:41:43 +05306637 uint8_t zeros[16] = { 0 };
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306638 psa_set_key_type(&attributes, PSA_KEY_TYPE_AES);
6639 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(sizeof(zeros)));
6640 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306641 /* Passing PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC) as
Kusumit Ghoderao5f3345a2023-07-27 21:21:38 +05306642 * mac_size as the driver function sets mac_output_length = mac_size
6643 * on success. See https://github.com/Mbed-TLS/mbedtls/issues/7801 */
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306644 status = psa_driver_wrapper_mac_compute(&attributes,
6645 zeros, sizeof(zeros),
6646 PSA_ALG_CMAC, input, input_len,
6647 output,
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306648 PSA_MAC_LENGTH(PSA_KEY_TYPE_AES,
6649 128U,
6650 PSA_ALG_CMAC),
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306651 output_len);
6652 } else {
6653 memcpy(output, input, input_len);
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306654 *output_len = PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC);
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306655 }
6656 return status;
6657}
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05306658#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128 */
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306659
6660static psa_status_t psa_pbkdf2_set_password(psa_pbkdf2_key_derivation_t *pbkdf2,
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306661 psa_algorithm_t kdf_alg,
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306662 const uint8_t *data,
6663 size_t data_length)
6664{
Kusumit Ghoderaoaac9a582023-05-24 14:19:17 +05306665 psa_status_t status = PSA_SUCCESS;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306666 if (pbkdf2->state != PSA_PBKDF2_STATE_SALT_SET) {
6667 return PSA_ERROR_BAD_STATE;
6668 }
6669
Kusumit Ghoderaof3e696d2023-07-28 13:30:50 +05306670#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306671 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
6672 psa_algorithm_t hash_alg = PSA_ALG_PBKDF2_HMAC_GET_HASH(kdf_alg);
6673 status = psa_pbkdf2_hmac_set_password(hash_alg, data, data_length,
6674 pbkdf2->password,
6675 &pbkdf2->password_length);
Kusumit Ghoderaof3e696d2023-07-28 13:30:50 +05306676 } else
6677#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC */
6678#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128)
6679 if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306680 status = psa_pbkdf2_cmac_set_password(data, data_length,
6681 pbkdf2->password,
6682 &pbkdf2->password_length);
Kusumit Ghoderaof3e696d2023-07-28 13:30:50 +05306683 } else
6684#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128 */
6685 {
6686 return PSA_ERROR_INVALID_ARGUMENT;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306687 }
6688
6689 pbkdf2->state = PSA_PBKDF2_STATE_PASSWORD_SET;
6690
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306691 return status;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306692}
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05306693
6694static psa_status_t psa_pbkdf2_input(psa_pbkdf2_key_derivation_t *pbkdf2,
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306695 psa_algorithm_t kdf_alg,
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05306696 psa_key_derivation_step_t step,
6697 const uint8_t *data,
6698 size_t data_length)
6699{
6700 switch (step) {
6701 case PSA_KEY_DERIVATION_INPUT_SALT:
6702 return psa_pbkdf2_set_salt(pbkdf2, data, data_length);
6703 case PSA_KEY_DERIVATION_INPUT_PASSWORD:
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306704 return psa_pbkdf2_set_password(pbkdf2, kdf_alg, data, data_length);
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05306705 default:
6706 return PSA_ERROR_INVALID_ARGUMENT;
6707 }
6708}
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306709#endif /* PSA_HAVE_SOFT_PBKDF2 */
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306710
Gilles Peskineb8965192019-09-24 16:21:10 +02006711/** Check whether the given key type is acceptable for the given
6712 * input step of a key derivation.
6713 *
6714 * Secret inputs must have the type #PSA_KEY_TYPE_DERIVE.
6715 * Non-secret inputs must have the type #PSA_KEY_TYPE_RAW_DATA.
6716 * Both secret and non-secret inputs can alternatively have the type
6717 * #PSA_KEY_TYPE_NONE, which is never the type of a key object, meaning
6718 * that the input was passed as a buffer rather than via a key object.
6719 */
Gilles Peskine224b0d62019-09-23 18:13:17 +02006720static int psa_key_derivation_check_input_type(
6721 psa_key_derivation_step_t step,
Gilles Peskine449bd832023-01-11 14:50:10 +01006722 psa_key_type_t key_type)
Gilles Peskine224b0d62019-09-23 18:13:17 +02006723{
Gilles Peskine449bd832023-01-11 14:50:10 +01006724 switch (step) {
Gilles Peskine224b0d62019-09-23 18:13:17 +02006725 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006726 if (key_type == PSA_KEY_TYPE_DERIVE) {
6727 return PSA_SUCCESS;
6728 }
6729 if (key_type == PSA_KEY_TYPE_NONE) {
6730 return PSA_SUCCESS;
6731 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02006732 break;
Przemek Stekiela7695a22022-04-07 15:39:01 +02006733 case PSA_KEY_DERIVATION_INPUT_OTHER_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006734 if (key_type == PSA_KEY_TYPE_DERIVE) {
6735 return PSA_SUCCESS;
6736 }
6737 if (key_type == PSA_KEY_TYPE_NONE) {
6738 return PSA_SUCCESS;
6739 }
Przemek Stekiela7695a22022-04-07 15:39:01 +02006740 break;
Gilles Peskine224b0d62019-09-23 18:13:17 +02006741 case PSA_KEY_DERIVATION_INPUT_LABEL:
6742 case PSA_KEY_DERIVATION_INPUT_SALT:
6743 case PSA_KEY_DERIVATION_INPUT_INFO:
6744 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskine449bd832023-01-11 14:50:10 +01006745 if (key_type == PSA_KEY_TYPE_RAW_DATA) {
6746 return PSA_SUCCESS;
6747 }
6748 if (key_type == PSA_KEY_TYPE_NONE) {
6749 return PSA_SUCCESS;
6750 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02006751 break;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306752 case PSA_KEY_DERIVATION_INPUT_PASSWORD:
6753 if (key_type == PSA_KEY_TYPE_PASSWORD) {
6754 return PSA_SUCCESS;
6755 }
6756 if (key_type == PSA_KEY_TYPE_DERIVE) {
6757 return PSA_SUCCESS;
6758 }
6759 if (key_type == PSA_KEY_TYPE_NONE) {
6760 return PSA_SUCCESS;
6761 }
6762 break;
Gilles Peskine224b0d62019-09-23 18:13:17 +02006763 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006764 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine224b0d62019-09-23 18:13:17 +02006765}
6766
Janos Follathb80a94e2019-06-12 15:54:46 +01006767static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006768 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01006769 psa_key_derivation_step_t step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02006770 psa_key_type_t key_type,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01006771 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006772 size_t data_length)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006773{
Gilles Peskine46d7faf2019-09-23 19:22:55 +02006774 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006775 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
Gilles Peskine46d7faf2019-09-23 19:22:55 +02006776
Gilles Peskine449bd832023-01-11 14:50:10 +01006777 status = psa_key_derivation_check_input_type(step, key_type);
6778 if (status != PSA_SUCCESS) {
Gilles Peskine224b0d62019-09-23 18:13:17 +02006779 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006780 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02006781
Przemek Stekiel69c46792022-06-10 12:59:51 +02006782#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006783 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
6784 status = psa_hkdf_input(&operation->ctx.hkdf, kdf_alg,
6785 step, data, data_length);
6786 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02006787#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08006788#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006789 if (PSA_ALG_IS_TLS12_PRF(kdf_alg)) {
6790 status = psa_tls12_prf_input(&operation->ctx.tls12_prf,
6791 step, data, data_length);
6792 } else
John Durkop07cc04a2020-11-16 22:08:34 -08006793#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF */
6794#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006795 if (PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
6796 status = psa_tls12_prf_psk_to_ms_input(&operation->ctx.tls12_prf,
6797 step, data, data_length);
6798 } else
John Durkop07cc04a2020-11-16 22:08:34 -08006799#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006800#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006801 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006802 status = psa_tls12_ecjpake_to_pms_input(
Gilles Peskine449bd832023-01-11 14:50:10 +01006803 &operation->ctx.tls12_ecjpake_to_pms, step, data, data_length);
6804 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006805#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306806#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05306807 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306808 status = psa_pbkdf2_input(&operation->ctx.pbkdf2, kdf_alg,
6809 step, data, data_length);
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05306810 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306811#endif /* PSA_HAVE_SOFT_PBKDF2 */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006812 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006813 /* This can't happen unless the operation object was not initialized */
Steven Cooreman74afe472021-02-10 17:19:22 +01006814 (void) data;
6815 (void) data_length;
6816 (void) kdf_alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01006817 return PSA_ERROR_BAD_STATE;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006818 }
6819
Gilles Peskine224b0d62019-09-23 18:13:17 +02006820exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01006821 if (status != PSA_SUCCESS) {
6822 psa_key_derivation_abort(operation);
6823 }
6824 return status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006825}
6826
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05306827static psa_status_t psa_key_derivation_input_integer_internal(
6828 psa_key_derivation_operation_t *operation,
6829 psa_key_derivation_step_t step,
6830 uint64_t value)
6831{
6832 psa_status_t status;
6833 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
6834
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306835#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05306836 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306837 status = psa_pbkdf2_set_input_cost(
6838 &operation->ctx.pbkdf2, step, value);
6839 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306840#endif /* PSA_HAVE_SOFT_PBKDF2 */
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05306841 {
Kusumit Ghoderao3a18dee2023-04-07 16:16:27 +05306842 (void) step;
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05306843 (void) value;
6844 (void) kdf_alg;
Kusumit Ghoderaoa14ae5a2023-04-19 14:16:26 +05306845 status = PSA_ERROR_INVALID_ARGUMENT;
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05306846 }
6847
6848 if (status != PSA_SUCCESS) {
6849 psa_key_derivation_abort(operation);
6850 }
6851 return status;
6852}
6853
Janos Follath51f4a0f2019-06-14 11:35:55 +01006854psa_status_t psa_key_derivation_input_bytes(
6855 psa_key_derivation_operation_t *operation,
6856 psa_key_derivation_step_t step,
6857 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006858 size_t data_length)
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01006859{
Gilles Peskine449bd832023-01-11 14:50:10 +01006860 return psa_key_derivation_input_internal(operation, step,
6861 PSA_KEY_TYPE_NONE,
6862 data, data_length);
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01006863}
6864
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05306865psa_status_t psa_key_derivation_input_integer(
6866 psa_key_derivation_operation_t *operation,
6867 psa_key_derivation_step_t step,
6868 uint64_t value)
6869{
6870 return psa_key_derivation_input_integer_internal(operation, step, value);
6871}
6872
Janos Follath51f4a0f2019-06-14 11:35:55 +01006873psa_status_t psa_key_derivation_input_key(
6874 psa_key_derivation_operation_t *operation,
6875 psa_key_derivation_step_t step,
Gilles Peskine449bd832023-01-11 14:50:10 +01006876 mbedtls_svc_key_id_t key)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006877{
Ronald Cronf95a2b12020-10-22 15:24:49 +02006878 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01006879 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006880 psa_key_slot_t *slot;
Gilles Peskine178c9aa2019-09-24 18:21:06 +02006881
Ronald Cron5c522922020-11-14 16:35:34 +01006882 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01006883 key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg);
6884 if (status != PSA_SUCCESS) {
6885 psa_key_derivation_abort(operation);
6886 return status;
Gilles Peskine593773d2019-09-23 18:17:40 +02006887 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02006888
Kusumit Ghoderao3128c5d2023-05-03 12:27:57 +05306889 /* Passing a key object as a SECRET or PASSWORD input unlocks the
6890 * permission to output to a key object. */
6891 if (step == PSA_KEY_DERIVATION_INPUT_SECRET ||
6892 step == PSA_KEY_DERIVATION_INPUT_PASSWORD) {
Gilles Peskine178c9aa2019-09-24 18:21:06 +02006893 operation->can_output_key = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01006894 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02006895
Gilles Peskine449bd832023-01-11 14:50:10 +01006896 status = psa_key_derivation_input_internal(operation,
6897 step, slot->attr.type,
6898 slot->key.data,
6899 slot->key.bytes);
Ronald Cronf95a2b12020-10-22 15:24:49 +02006900
Ryan Everett1b70a072024-01-04 10:32:49 +00006901 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02006902
Gilles Peskine449bd832023-01-11 14:50:10 +01006903 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006904}
Gilles Peskineea0fb492018-07-12 17:17:20 +02006905
6906
6907
6908/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02006909/* Key agreement */
6910/****************************************************************/
6911
Gilles Peskine449bd832023-01-11 14:50:10 +01006912psa_status_t psa_key_agreement_raw_builtin(const psa_key_attributes_t *attributes,
6913 const uint8_t *key_buffer,
6914 size_t key_buffer_size,
6915 psa_algorithm_t alg,
6916 const uint8_t *peer_key,
6917 size_t peer_key_length,
6918 uint8_t *shared_secret,
6919 size_t shared_secret_size,
6920 size_t *shared_secret_length)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02006921{
Gilles Peskine449bd832023-01-11 14:50:10 +01006922 switch (alg) {
John Durkop6ba40d12020-11-10 08:50:04 -08006923#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskine0216fe12019-04-11 21:23:21 +02006924 case PSA_ALG_ECDH:
Gilles Peskine449bd832023-01-11 14:50:10 +01006925 return mbedtls_psa_key_agreement_ecdh(attributes, key_buffer,
6926 key_buffer_size, alg,
6927 peer_key, peer_key_length,
6928 shared_secret,
6929 shared_secret_size,
6930 shared_secret_length);
Gilles Peskine01d718c2018-09-18 12:01:02 +02006931#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Przemek Stekielfb3dd542022-12-01 14:59:15 +01006932
6933#if defined(MBEDTLS_PSA_BUILTIN_ALG_FFDH)
6934 case PSA_ALG_FFDH:
Przemek Stekiel152bb462023-06-01 11:52:39 +02006935 return mbedtls_psa_ffdh_key_agreement(attributes,
Przemek Stekiel359f4622022-12-05 14:11:55 +01006936 peer_key,
6937 peer_key_length,
6938 key_buffer,
6939 key_buffer_size,
6940 shared_secret,
6941 shared_secret_size,
6942 shared_secret_length);
Przemek Stekielfb3dd542022-12-01 14:59:15 +01006943#endif /* MBEDTLS_PSA_BUILTIN_ALG_FFDH */
6944
Gilles Peskine01d718c2018-09-18 12:01:02 +02006945 default:
Aditya Deshpande17845b82022-10-13 17:21:01 +01006946 (void) attributes;
6947 (void) key_buffer;
6948 (void) key_buffer_size;
Gilles Peskine93f85002018-11-16 16:43:31 +01006949 (void) peer_key;
6950 (void) peer_key_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02006951 (void) shared_secret;
6952 (void) shared_secret_size;
6953 (void) shared_secret_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01006954 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine01d718c2018-09-18 12:01:02 +02006955 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02006956}
Gilles Peskine01d718c2018-09-18 12:01:02 +02006957
Aditya Deshpande17845b82022-10-13 17:21:01 +01006958/** Internal function for raw key agreement
6959 * Calls the driver wrapper which will hand off key agreement task
Aditya Deshpande40c05cc2022-10-14 16:41:40 +01006960 * to the driver's implementation if a driver is present.
6961 * Fallback specified in the driver wrapper is built-in raw key agreement
Aditya Deshpande17845b82022-10-13 17:21:01 +01006962 * (psa_key_agreement_raw_builtin).
6963 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006964static psa_status_t psa_key_agreement_raw_internal(psa_algorithm_t alg,
6965 psa_key_slot_t *private_key,
6966 const uint8_t *peer_key,
6967 size_t peer_key_length,
6968 uint8_t *shared_secret,
6969 size_t shared_secret_size,
6970 size_t *shared_secret_length)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006971{
Gilles Peskine449bd832023-01-11 14:50:10 +01006972 if (!PSA_ALG_IS_RAW_KEY_AGREEMENT(alg)) {
6973 return PSA_ERROR_NOT_SUPPORTED;
6974 }
Aditya Deshpande17845b82022-10-13 17:21:01 +01006975
6976 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01006977 .core = private_key->attr
Aditya Deshpande17845b82022-10-13 17:21:01 +01006978 };
6979
Gilles Peskine449bd832023-01-11 14:50:10 +01006980 return psa_driver_wrapper_key_agreement(&attributes,
6981 private_key->key.data,
6982 private_key->key.bytes, alg,
6983 peer_key, peer_key_length,
6984 shared_secret,
6985 shared_secret_size,
6986 shared_secret_length);
Gilles Peskine0216fe12019-04-11 21:23:21 +02006987}
6988
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02006989/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine01d718c2018-09-18 12:01:02 +02006990 * to potentially free embedded data structures and wipe confidential data.
6991 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006992static psa_status_t psa_key_agreement_internal(psa_key_derivation_operation_t *operation,
6993 psa_key_derivation_step_t step,
6994 psa_key_slot_t *private_key,
6995 const uint8_t *peer_key,
6996 size_t peer_key_length)
Gilles Peskine01d718c2018-09-18 12:01:02 +02006997{
6998 psa_status_t status;
Aditya Deshpande2f7fd762022-11-22 11:10:34 +00006999 uint8_t shared_secret[PSA_RAW_KEY_AGREEMENT_OUTPUT_MAX_SIZE];
Gilles Peskine01d718c2018-09-18 12:01:02 +02007000 size_t shared_secret_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007001 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE(operation->alg);
Gilles Peskine01d718c2018-09-18 12:01:02 +02007002
7003 /* Step 1: run the secret agreement algorithm to generate the shared
7004 * secret. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007005 status = psa_key_agreement_raw_internal(ka_alg,
7006 private_key,
7007 peer_key, peer_key_length,
7008 shared_secret,
7009 sizeof(shared_secret),
7010 &shared_secret_length);
7011 if (status != PSA_SUCCESS) {
Gilles Peskine12313cd2018-06-20 00:20:32 +02007012 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007013 }
Gilles Peskine12313cd2018-06-20 00:20:32 +02007014
Gilles Peskineb0b255c2018-07-06 17:01:38 +02007015 /* Step 2: set up the key derivation to generate key material from
Gilles Peskine224b0d62019-09-23 18:13:17 +02007016 * the shared secret. A shared secret is permitted wherever a key
7017 * of type DERIVE is permitted. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007018 status = psa_key_derivation_input_internal(operation, step,
7019 PSA_KEY_TYPE_DERIVE,
7020 shared_secret,
7021 shared_secret_length);
Gilles Peskine12313cd2018-06-20 00:20:32 +02007022exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007023 mbedtls_platform_zeroize(shared_secret, shared_secret_length);
7024 return status;
Gilles Peskine12313cd2018-06-20 00:20:32 +02007025}
7026
Gilles Peskine449bd832023-01-11 14:50:10 +01007027psa_status_t psa_key_derivation_key_agreement(psa_key_derivation_operation_t *operation,
7028 psa_key_derivation_step_t step,
7029 mbedtls_svc_key_id_t private_key,
7030 const uint8_t *peer_key,
7031 size_t peer_key_length)
Gilles Peskine12313cd2018-06-20 00:20:32 +02007032{
Ronald Cronf95a2b12020-10-22 15:24:49 +02007033 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01007034 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01007035 psa_key_slot_t *slot;
Ronald Cronf95a2b12020-10-22 15:24:49 +02007036
Gilles Peskine449bd832023-01-11 14:50:10 +01007037 if (!PSA_ALG_IS_KEY_AGREEMENT(operation->alg)) {
7038 return PSA_ERROR_INVALID_ARGUMENT;
7039 }
Ronald Cron5c522922020-11-14 16:35:34 +01007040 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01007041 private_key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg);
7042 if (status != PSA_SUCCESS) {
7043 return status;
7044 }
7045 status = psa_key_agreement_internal(operation, step,
7046 slot,
7047 peer_key, peer_key_length);
7048 if (status != PSA_SUCCESS) {
7049 psa_key_derivation_abort(operation);
7050 } else {
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007051 /* If a private key has been added as SECRET, we allow the derived
7052 * key material to be used as a key in PSA Crypto. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007053 if (step == PSA_KEY_DERIVATION_INPUT_SECRET) {
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007054 operation->can_output_key = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01007055 }
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007056 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007057
Ryan Everett1b70a072024-01-04 10:32:49 +00007058 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007059
Gilles Peskine449bd832023-01-11 14:50:10 +01007060 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskineaf3baab2018-06-27 22:55:52 +02007061}
7062
Gilles Peskine449bd832023-01-11 14:50:10 +01007063psa_status_t psa_raw_key_agreement(psa_algorithm_t alg,
7064 mbedtls_svc_key_id_t private_key,
7065 const uint8_t *peer_key,
7066 size_t peer_key_length,
7067 uint8_t *output,
7068 size_t output_size,
7069 size_t *output_length)
Gilles Peskine0216fe12019-04-11 21:23:21 +02007070{
Ronald Cronf95a2b12020-10-22 15:24:49 +02007071 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01007072 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +02007073 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007074 size_t expected_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02007075
Gilles Peskine449bd832023-01-11 14:50:10 +01007076 if (!PSA_ALG_IS_KEY_AGREEMENT(alg)) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007077 status = PSA_ERROR_INVALID_ARGUMENT;
7078 goto exit;
7079 }
Ronald Cron5c522922020-11-14 16:35:34 +01007080 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01007081 private_key, &slot, PSA_KEY_USAGE_DERIVE, alg);
7082 if (status != PSA_SUCCESS) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007083 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007084 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02007085
Gilles Peskine3e561302022-04-14 00:17:15 +02007086 /* PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() is in general an upper bound
7087 * for the output size. The PSA specification only guarantees that this
7088 * function works if output_size >= PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE(...),
7089 * but it might be nice to allow smaller buffers if the output fits.
7090 * At the time of writing this comment, with only ECDH implemented,
7091 * PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() is exact so the point is moot.
7092 * If FFDH is implemented, PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() can easily
7093 * be exact for it as well. */
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007094 expected_length =
Gilles Peskine449bd832023-01-11 14:50:10 +01007095 PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE(slot->attr.type, slot->attr.bits);
7096 if (output_size < expected_length) {
Gilles Peskine3e561302022-04-14 00:17:15 +02007097 status = PSA_ERROR_BUFFER_TOO_SMALL;
7098 goto exit;
7099 }
7100
Gilles Peskine449bd832023-01-11 14:50:10 +01007101 status = psa_key_agreement_raw_internal(alg, slot,
7102 peer_key, peer_key_length,
7103 output, output_size,
7104 output_length);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007105
7106exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007107 if (status != PSA_SUCCESS) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007108 /* If an error happens and is not handled properly, the output
7109 * may be used as a key to protect sensitive data. Arrange for such
7110 * a key to be random, which is likely to result in decryption or
7111 * verification errors. This is better than filling the buffer with
7112 * some constant data such as zeros, which would result in the data
7113 * being protected with a reproducible, easily knowable key.
7114 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007115 psa_generate_random(output, output_size);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007116 *output_length = output_size;
7117 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007118
Ryan Everett1b70a072024-01-04 10:32:49 +00007119 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007120
Gilles Peskine449bd832023-01-11 14:50:10 +01007121 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine0216fe12019-04-11 21:23:21 +02007122}
Gilles Peskine86a440b2018-11-12 18:39:40 +01007123
7124
Gilles Peskine30524eb2020-11-13 17:02:26 +01007125
Gilles Peskine86a440b2018-11-12 18:39:40 +01007126/****************************************************************/
7127/* Random generation */
Gilles Peskine53d991e2018-07-12 01:14:59 +02007128/****************************************************************/
Gilles Peskine12313cd2018-06-20 00:20:32 +02007129
Gilles Peskine672a7712023-04-28 21:00:28 +02007130#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
7131#include "entropy_poll.h"
7132#endif
7133
Gilles Peskine30524eb2020-11-13 17:02:26 +01007134/** Initialize the PSA random generator.
7135 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007136static void mbedtls_psa_random_init(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01007137{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007138#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine449bd832023-01-11 14:50:10 +01007139 memset(rng, 0, sizeof(*rng));
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007140#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
7141
Gilles Peskine30524eb2020-11-13 17:02:26 +01007142 /* Set default configuration if
7143 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007144 if (rng->entropy_init == NULL) {
Gilles Peskine30524eb2020-11-13 17:02:26 +01007145 rng->entropy_init = mbedtls_entropy_init;
Gilles Peskine449bd832023-01-11 14:50:10 +01007146 }
7147 if (rng->entropy_free == NULL) {
Gilles Peskine30524eb2020-11-13 17:02:26 +01007148 rng->entropy_free = mbedtls_entropy_free;
Gilles Peskine449bd832023-01-11 14:50:10 +01007149 }
Gilles Peskine30524eb2020-11-13 17:02:26 +01007150
Gilles Peskine449bd832023-01-11 14:50:10 +01007151 rng->entropy_init(&rng->entropy);
Gilles Peskine30524eb2020-11-13 17:02:26 +01007152#if defined(MBEDTLS_PSA_INJECT_ENTROPY) && \
7153 defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
7154 /* The PSA entropy injection feature depends on using NV seed as an entropy
7155 * source. Add NV seed as an entropy source for PSA entropy injection. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007156 mbedtls_entropy_add_source(&rng->entropy,
7157 mbedtls_nv_seed_poll, NULL,
7158 MBEDTLS_ENTROPY_BLOCK_SIZE,
7159 MBEDTLS_ENTROPY_SOURCE_STRONG);
Gilles Peskine30524eb2020-11-13 17:02:26 +01007160#endif
7161
Gilles Peskine449bd832023-01-11 14:50:10 +01007162 mbedtls_psa_drbg_init(MBEDTLS_PSA_RANDOM_STATE);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007163#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007164}
7165
7166/** Deinitialize the PSA random generator.
7167 */
Valerio Setti83e0de82023-11-24 12:13:05 +01007168static void mbedtls_psa_random_free(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01007169{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007170#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Valerio Setti83e0de82023-11-24 12:13:05 +01007171 memset(rng, 0, sizeof(*rng));
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007172#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Valerio Setti83e0de82023-11-24 12:13:05 +01007173 mbedtls_psa_drbg_free(MBEDTLS_PSA_RANDOM_STATE);
7174 rng->entropy_free(&rng->entropy);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007175#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007176}
7177
7178/** Seed the PSA random generator.
7179 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007180static psa_status_t mbedtls_psa_random_seed(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01007181{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007182#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
7183 /* Do nothing: the external RNG seeds itself. */
7184 (void) rng;
Gilles Peskine449bd832023-01-11 14:50:10 +01007185 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007186#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007187 const unsigned char drbg_seed[] = "PSA";
Gilles Peskine449bd832023-01-11 14:50:10 +01007188 int ret = mbedtls_psa_drbg_seed(&rng->entropy,
7189 drbg_seed, sizeof(drbg_seed) - 1);
7190 return mbedtls_to_psa_error(ret);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007191#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007192}
7193
Gilles Peskine449bd832023-01-11 14:50:10 +01007194psa_status_t psa_generate_random(uint8_t *output,
7195 size_t output_size)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007196{
Gilles Peskinee59236f2018-01-27 23:32:46 +01007197 GUARD_MODULE_INITIALIZED;
7198
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007199#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
7200
7201 size_t output_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007202 psa_status_t status = mbedtls_psa_external_get_random(&global_data.rng,
7203 output, output_size,
7204 &output_length);
7205 if (status != PSA_SUCCESS) {
7206 return status;
7207 }
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007208 /* Breaking up a request into smaller chunks is currently not supported
Tom Cosgrove1797b052022-12-04 17:19:59 +00007209 * for the external RNG interface. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007210 if (output_length != output_size) {
7211 return PSA_ERROR_INSUFFICIENT_ENTROPY;
7212 }
7213 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007214
7215#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
7216
Gilles Peskine449bd832023-01-11 14:50:10 +01007217 while (output_size > 0) {
Gilles Peskine71ddab92021-01-04 21:01:07 +01007218 size_t request_size =
Gilles Peskine449bd832023-01-11 14:50:10 +01007219 (output_size > MBEDTLS_PSA_RANDOM_MAX_REQUEST ?
7220 MBEDTLS_PSA_RANDOM_MAX_REQUEST :
7221 output_size);
7222 int ret = mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE,
7223 output, request_size);
7224 if (ret != 0) {
7225 return mbedtls_to_psa_error(ret);
7226 }
Gilles Peskine71ddab92021-01-04 21:01:07 +01007227 output_size -= request_size;
7228 output += request_size;
Gilles Peskinef181eca2019-08-07 13:49:00 +02007229 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007230 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007231#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskinee59236f2018-01-27 23:32:46 +01007232}
7233
Gilles Peskine8814fc42020-12-14 15:33:44 +01007234/* Wrapper function allowing the classic API to use the PSA RNG.
Gilles Peskine9c3e0602021-01-05 16:03:55 +01007235 *
7236 * `mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE, ...)` calls
7237 * `psa_generate_random(...)`. The state parameter is ignored since the
7238 * PSA API doesn't support passing an explicit state.
7239 *
7240 * In the non-external case, psa_generate_random() calls an
7241 * `mbedtls_xxx_drbg_random` function which has exactly the same signature
7242 * and semantics as mbedtls_psa_get_random(). As an optimization,
7243 * instead of doing this back-and-forth between the PSA API and the
7244 * classic API, psa_crypto_random_impl.h defines `mbedtls_psa_get_random`
7245 * as a constant function pointer to `mbedtls_xxx_drbg_random`.
Gilles Peskine8814fc42020-12-14 15:33:44 +01007246 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007247#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
7248int mbedtls_psa_get_random(void *p_rng,
7249 unsigned char *output,
7250 size_t output_size)
Gilles Peskine8814fc42020-12-14 15:33:44 +01007251{
Gilles Peskine9c3e0602021-01-05 16:03:55 +01007252 /* This function takes a pointer to the RNG state because that's what
7253 * classic mbedtls functions using an RNG expect. The PSA RNG manages
7254 * its own state internally and doesn't let the caller access that state.
7255 * So we just ignore the state parameter, and in practice we'll pass
7256 * NULL. */
Gilles Peskine8814fc42020-12-14 15:33:44 +01007257 (void) p_rng;
Gilles Peskine449bd832023-01-11 14:50:10 +01007258 psa_status_t status = psa_generate_random(output, output_size);
7259 if (status == PSA_SUCCESS) {
7260 return 0;
7261 } else {
7262 return MBEDTLS_ERR_ENTROPY_SOURCE_FAILED;
7263 }
Gilles Peskine8814fc42020-12-14 15:33:44 +01007264}
7265#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
7266
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01007267#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
Gilles Peskine449bd832023-01-11 14:50:10 +01007268psa_status_t mbedtls_psa_inject_entropy(const uint8_t *seed,
7269 size_t seed_size)
Netanel Gonen2bcd3122018-11-19 11:53:02 +02007270{
Gilles Peskine449bd832023-01-11 14:50:10 +01007271 if (global_data.initialized) {
7272 return PSA_ERROR_NOT_PERMITTED;
7273 }
Netanel Gonen21f37cb2018-11-19 11:53:55 +02007274
Gilles Peskine449bd832023-01-11 14:50:10 +01007275 if (((seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM) ||
7276 (seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE)) ||
7277 (seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE)) {
7278 return PSA_ERROR_INVALID_ARGUMENT;
7279 }
Netanel Gonen21f37cb2018-11-19 11:53:55 +02007280
Gilles Peskine449bd832023-01-11 14:50:10 +01007281 return mbedtls_psa_storage_inject_entropy(seed, seed_size);
Netanel Gonen2bcd3122018-11-19 11:53:02 +02007282}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01007283#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02007284
Ronald Cron3772afe2021-02-08 16:10:05 +01007285/** Validate the key type and size for key generation
Ronald Cron01b2aba2020-10-05 09:42:02 +02007286 *
Ronald Cron3772afe2021-02-08 16:10:05 +01007287 * \param type The key type
7288 * \param bits The number of bits of the key
Ronald Cron01b2aba2020-10-05 09:42:02 +02007289 *
7290 * \retval #PSA_SUCCESS
Ronald Cron3772afe2021-02-08 16:10:05 +01007291 * The key type and size are valid.
Ronald Cron01b2aba2020-10-05 09:42:02 +02007292 * \retval #PSA_ERROR_INVALID_ARGUMENT
7293 * The size in bits of the key is not valid.
7294 * \retval #PSA_ERROR_NOT_SUPPORTED
7295 * The type and/or the size in bits of the key or the combination of
7296 * the two is not supported.
7297 */
Ronald Cron3772afe2021-02-08 16:10:05 +01007298static psa_status_t psa_validate_key_type_and_size_for_key_generation(
Gilles Peskine449bd832023-01-11 14:50:10 +01007299 psa_key_type_t type, size_t bits)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007300{
Ronald Cronf3bb7612020-10-02 20:11:59 +02007301 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007302
Gilles Peskine449bd832023-01-11 14:50:10 +01007303 if (key_type_is_raw_bytes(type)) {
7304 status = psa_validate_unstructured_key_bit_size(type, bits);
7305 if (status != PSA_SUCCESS) {
7306 return status;
7307 }
7308 } else
Valerio Settif6d4dfb2023-07-10 10:55:12 +02007309#if defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007310 if (PSA_KEY_TYPE_IS_RSA(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
7311 if (bits > PSA_VENDOR_RSA_MAX_KEY_BITS) {
7312 return PSA_ERROR_NOT_SUPPORTED;
7313 }
Waleed Elmelegyd7bdbbe2023-07-20 16:26:58 +00007314 if (bits < PSA_VENDOR_RSA_GENERATE_MIN_KEY_BITS) {
Waleed Elmelegyab570712023-07-05 16:40:58 +00007315 return PSA_ERROR_NOT_SUPPORTED;
7316 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +02007317
Ronald Cron01b2aba2020-10-05 09:42:02 +02007318 /* Accept only byte-aligned keys, for the same reasons as
7319 * in psa_import_rsa_key(). */
Gilles Peskine449bd832023-01-11 14:50:10 +01007320 if (bits % 8 != 0) {
7321 return PSA_ERROR_NOT_SUPPORTED;
7322 }
7323 } else
Valerio Settif6d4dfb2023-07-10 10:55:12 +02007324#endif /* defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02007325
Valerio Setti6a9d0ee2023-06-21 10:07:21 +02007326#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007327 if (PSA_KEY_TYPE_IS_ECC(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
Ronald Crond81ab562021-02-16 09:01:16 +01007328 /* To avoid empty block, return successfully here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007329 return PSA_SUCCESS;
7330 } else
Valerio Setti6a9d0ee2023-06-21 10:07:21 +02007331#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_GENERATE) */
Przemek Stekielfedd1342022-12-01 15:00:02 +01007332
Valerio Settia55f0422023-07-10 15:34:41 +02007333#if defined(PSA_WANT_KEY_TYPE_DH_KEY_PAIR_GENERATE)
Przemek Stekielfedd1342022-12-01 15:00:02 +01007334 if (PSA_KEY_TYPE_IS_DH(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
Przemek Stekield1cf1ba2023-04-27 12:04:21 +02007335 if (psa_is_dh_key_size_valid(bits) == 0) {
Przemek Stekielfedd1342022-12-01 15:00:02 +01007336 return PSA_ERROR_NOT_SUPPORTED;
7337 }
7338 } else
Valerio Settia55f0422023-07-10 15:34:41 +02007339#endif /* defined(PSA_WANT_KEY_TYPE_DH_KEY_PAIR_GENERATE) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02007340 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007341 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007342 }
7343
Gilles Peskine449bd832023-01-11 14:50:10 +01007344 return PSA_SUCCESS;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007345}
7346
Ronald Cron55ed0592020-10-05 10:30:40 +02007347psa_status_t psa_generate_key_internal(
Ronald Cron2a38a6b2020-10-02 20:02:04 +02007348 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01007349 uint8_t *key_buffer, size_t key_buffer_size, size_t *key_buffer_length)
Ronald Cron01b2aba2020-10-05 09:42:02 +02007350{
7351 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2a38a6b2020-10-02 20:02:04 +02007352 psa_key_type_t type = attributes->core.type;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007353
Gilles Peskine449bd832023-01-11 14:50:10 +01007354 if ((attributes->domain_parameters == NULL) &&
7355 (attributes->domain_parameters_size != 0)) {
7356 return PSA_ERROR_INVALID_ARGUMENT;
7357 }
Ronald Cron01b2aba2020-10-05 09:42:02 +02007358
Gilles Peskine449bd832023-01-11 14:50:10 +01007359 if (key_type_is_raw_bytes(type)) {
7360 status = psa_generate_random(key_buffer, key_buffer_size);
7361 if (status != PSA_SUCCESS) {
7362 return status;
7363 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +02007364
David Brown12ca5032021-02-11 11:02:00 -07007365#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01007366 if (type == PSA_KEY_TYPE_DES) {
7367 psa_des_set_key_parity(key_buffer, key_buffer_size);
7368 }
David Brown8107e312021-02-12 08:08:46 -07007369#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine449bd832023-01-11 14:50:10 +01007370 } else
Gilles Peskinee59236f2018-01-27 23:32:46 +01007371
Valerio Setti76df8c12023-07-11 14:11:28 +02007372#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007373 if (type == PSA_KEY_TYPE_RSA_KEY_PAIR) {
7374 return mbedtls_psa_rsa_generate_key(attributes,
7375 key_buffer,
7376 key_buffer_size,
7377 key_buffer_length);
7378 } else
Valerio Setti76df8c12023-07-11 14:11:28 +02007379#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_GENERATE) */
Gilles Peskinee59236f2018-01-27 23:32:46 +01007380
Valerio Settibfeaf5b2023-06-20 13:27:46 +02007381#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007382 if (PSA_KEY_TYPE_IS_ECC(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
7383 return mbedtls_psa_ecp_generate_key(attributes,
7384 key_buffer,
7385 key_buffer_size,
7386 key_buffer_length);
7387 } else
Valerio Settibfeaf5b2023-06-20 13:27:46 +02007388#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_GENERATE) */
Przemek Stekielfedd1342022-12-01 15:00:02 +01007389
Valerio Settia55f0422023-07-10 15:34:41 +02007390#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_GENERATE)
Przemek Stekielfedd1342022-12-01 15:00:02 +01007391 if (PSA_KEY_TYPE_IS_DH(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
7392 return mbedtls_psa_ffdh_generate_key(attributes,
7393 key_buffer,
7394 key_buffer_size,
7395 key_buffer_length);
7396 } else
Valerio Settia55f0422023-07-10 15:34:41 +02007397#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_GENERATE) */
Steven Cooreman29149862020-08-05 15:43:42 +02007398 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007399 (void) key_buffer_length;
7400 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman29149862020-08-05 15:43:42 +02007401 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01007402
Gilles Peskine449bd832023-01-11 14:50:10 +01007403 return PSA_SUCCESS;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02007404}
Darryl Green0c6575a2018-11-07 16:05:30 +00007405
Gilles Peskine449bd832023-01-11 14:50:10 +01007406psa_status_t psa_generate_key(const psa_key_attributes_t *attributes,
7407 mbedtls_svc_key_id_t *key)
Gilles Peskineff5f0e72019-04-18 12:53:30 +02007408{
7409 psa_status_t status;
7410 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02007411 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cron2b56bc82020-10-05 10:02:26 +02007412 size_t key_buffer_size;
Gilles Peskine11792082019-08-06 18:36:36 +02007413
Ronald Cron81709fc2020-11-14 12:10:32 +01007414 *key = MBEDTLS_SVC_KEY_ID_INIT;
7415
Gilles Peskine0f84d622019-09-12 19:03:13 +02007416 /* Reject any attempt to create a zero-length key so that we don't
7417 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007418 if (psa_get_key_bits(attributes) == 0) {
7419 return PSA_ERROR_INVALID_ARGUMENT;
7420 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02007421
Przemyslaw Stekielc0fe8202021-10-07 11:08:56 +02007422 /* Reject any attempt to create a public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007423 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(attributes->core.type)) {
7424 return PSA_ERROR_INVALID_ARGUMENT;
7425 }
Przemyslaw Stekielc0fe8202021-10-07 11:08:56 +02007426
Gilles Peskine449bd832023-01-11 14:50:10 +01007427 status = psa_start_key_creation(PSA_KEY_CREATION_GENERATE, attributes,
7428 &slot, &driver);
7429 if (status != PSA_SUCCESS) {
Gilles Peskine11792082019-08-06 18:36:36 +02007430 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007431 }
Gilles Peskine11792082019-08-06 18:36:36 +02007432
Ronald Cron977c2472020-10-13 08:32:21 +02007433 /* In the case of a transparent key or an opaque key stored in local
Archana449608b2021-09-08 15:36:05 +05307434 * storage ( thus not in the case of generating a key in a secure element
7435 * with storage ( MBEDTLS_PSA_CRYPTO_SE_C ) ),we have to allocate a
7436 * buffer to hold the generated key material. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007437 if (slot->key.data == NULL) {
7438 if (PSA_KEY_LIFETIME_GET_LOCATION(attributes->core.lifetime) ==
7439 PSA_KEY_LOCATION_LOCAL_STORAGE) {
Ronald Cron3772afe2021-02-08 16:10:05 +01007440 status = psa_validate_key_type_and_size_for_key_generation(
Gilles Peskine449bd832023-01-11 14:50:10 +01007441 attributes->core.type, attributes->core.bits);
7442 if (status != PSA_SUCCESS) {
Ronald Cron3772afe2021-02-08 16:10:05 +01007443 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007444 }
Ronald Cron3772afe2021-02-08 16:10:05 +01007445
7446 key_buffer_size = PSA_EXPORT_KEY_OUTPUT_SIZE(
Gilles Peskine449bd832023-01-11 14:50:10 +01007447 attributes->core.type,
7448 attributes->core.bits);
7449 } else {
Ronald Cron977c2472020-10-13 08:32:21 +02007450 status = psa_driver_wrapper_get_key_buffer_size(
Gilles Peskine449bd832023-01-11 14:50:10 +01007451 attributes, &key_buffer_size);
7452 if (status != PSA_SUCCESS) {
Ronald Cron3772afe2021-02-08 16:10:05 +01007453 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007454 }
Ronald Cron977c2472020-10-13 08:32:21 +02007455 }
Ronald Cron977c2472020-10-13 08:32:21 +02007456
Gilles Peskine449bd832023-01-11 14:50:10 +01007457 status = psa_allocate_buffer_to_slot(slot, key_buffer_size);
7458 if (status != PSA_SUCCESS) {
Ronald Cron977c2472020-10-13 08:32:21 +02007459 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007460 }
Ronald Cron977c2472020-10-13 08:32:21 +02007461 }
7462
Gilles Peskine449bd832023-01-11 14:50:10 +01007463 status = psa_driver_wrapper_generate_key(attributes,
7464 slot->key.data, slot->key.bytes, &slot->key.bytes);
Gilles Peskine11792082019-08-06 18:36:36 +02007465
Gilles Peskine449bd832023-01-11 14:50:10 +01007466 if (status != PSA_SUCCESS) {
7467 psa_remove_key_data_from_memory(slot);
7468 }
Ronald Cron2b56bc82020-10-05 10:02:26 +02007469
Gilles Peskine11792082019-08-06 18:36:36 +02007470exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007471 if (status == PSA_SUCCESS) {
7472 status = psa_finish_key_creation(slot, driver, key);
7473 }
7474 if (status != PSA_SUCCESS) {
7475 psa_fail_key_creation(slot, driver);
7476 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007477
Gilles Peskine449bd832023-01-11 14:50:10 +01007478 return status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007479}
7480
Gilles Peskinee59236f2018-01-27 23:32:46 +01007481/****************************************************************/
7482/* Module setup */
7483/****************************************************************/
7484
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007485#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine5e769522018-11-20 21:59:56 +01007486psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
Gilles Peskine449bd832023-01-11 14:50:10 +01007487 void (* entropy_init)(mbedtls_entropy_context *ctx),
7488 void (* entropy_free)(mbedtls_entropy_context *ctx))
Gilles Peskine5e769522018-11-20 21:59:56 +01007489{
Gilles Peskine449bd832023-01-11 14:50:10 +01007490 if (global_data.rng_state != RNG_NOT_INITIALIZED) {
7491 return PSA_ERROR_BAD_STATE;
7492 }
Gilles Peskine30524eb2020-11-13 17:02:26 +01007493 global_data.rng.entropy_init = entropy_init;
7494 global_data.rng.entropy_free = entropy_free;
Gilles Peskine449bd832023-01-11 14:50:10 +01007495 return PSA_SUCCESS;
Gilles Peskine5e769522018-11-20 21:59:56 +01007496}
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007497#endif /* !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) */
Gilles Peskine5e769522018-11-20 21:59:56 +01007498
Gilles Peskine449bd832023-01-11 14:50:10 +01007499void mbedtls_psa_crypto_free(void)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007500{
Gilles Peskine449bd832023-01-11 14:50:10 +01007501 psa_wipe_all_key_slots();
Valerio Setti83e0de82023-11-24 12:13:05 +01007502 if (global_data.rng_state != RNG_NOT_INITIALIZED) {
7503 mbedtls_psa_random_free(&global_data.rng);
7504 }
Gilles Peskinec6b69072018-11-20 21:42:52 +01007505 /* Wipe all remaining data, including configuration.
7506 * In particular, this sets all state indicator to the value
7507 * indicating "uninitialized". */
Gilles Peskine449bd832023-01-11 14:50:10 +01007508 mbedtls_platform_zeroize(&global_data, sizeof(global_data));
Ronald Cron9ba76912021-04-10 16:57:30 +02007509
7510 /* Terminate drivers */
Gilles Peskine449bd832023-01-11 14:50:10 +01007511 psa_driver_wrapper_free();
Gilles Peskinee59236f2018-01-27 23:32:46 +01007512}
7513
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007514#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
7515/** Recover a transaction that was interrupted by a power failure.
7516 *
7517 * This function is called during initialization, before psa_crypto_init()
7518 * returns. If this function returns a failure status, the initialization
7519 * fails.
7520 */
7521static psa_status_t psa_crypto_recover_transaction(
Gilles Peskine449bd832023-01-11 14:50:10 +01007522 const psa_crypto_transaction_t *transaction)
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007523{
Gilles Peskine449bd832023-01-11 14:50:10 +01007524 switch (transaction->unknown.type) {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007525 case PSA_CRYPTO_TRANSACTION_CREATE_KEY:
7526 case PSA_CRYPTO_TRANSACTION_DESTROY_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01007527 /* TODO - fall through to the failure case until this
7528 * is implemented.
7529 * https://github.com/ARMmbed/mbed-crypto/issues/218
7530 */
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007531 default:
7532 /* We found an unsupported transaction in the storage.
7533 * We don't know what state the storage is in. Give up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007534 return PSA_ERROR_DATA_INVALID;
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007535 }
7536}
7537#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
7538
Gilles Peskine449bd832023-01-11 14:50:10 +01007539psa_status_t psa_crypto_init(void)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007540{
Gilles Peskine66fb1262018-12-10 16:29:04 +01007541 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007542
Gilles Peskinec6b69072018-11-20 21:42:52 +01007543 /* Double initialization is explicitly allowed. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007544 if (global_data.initialized != 0) {
7545 return PSA_SUCCESS;
7546 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01007547
Manuel Pégourié-Gonnard7abdf7e2023-03-09 11:17:43 +01007548 /* Init drivers */
7549 status = psa_driver_wrapper_init();
7550 if (status != PSA_SUCCESS) {
7551 goto exit;
7552 }
7553 global_data.drivers_initialized = 1;
7554
Valerio Setti402cfba2023-11-13 10:24:32 +01007555 status = psa_initialize_key_slots();
7556 if (status != PSA_SUCCESS) {
7557 goto exit;
7558 }
7559
Gilles Peskine30524eb2020-11-13 17:02:26 +01007560 /* Initialize and seed the random generator. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007561 mbedtls_psa_random_init(&global_data.rng);
Gilles Peskinec6b69072018-11-20 21:42:52 +01007562 global_data.rng_state = RNG_INITIALIZED;
Gilles Peskine449bd832023-01-11 14:50:10 +01007563 status = mbedtls_psa_random_seed(&global_data.rng);
7564 if (status != PSA_SUCCESS) {
Gilles Peskinee59236f2018-01-27 23:32:46 +01007565 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007566 }
Gilles Peskinec6b69072018-11-20 21:42:52 +01007567 global_data.rng_state = RNG_SEEDED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007568
Gilles Peskine4b734222019-07-24 15:56:31 +02007569#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007570 status = psa_crypto_load_transaction();
7571 if (status == PSA_SUCCESS) {
7572 status = psa_crypto_recover_transaction(&psa_crypto_transaction);
7573 if (status != PSA_SUCCESS) {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007574 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007575 }
7576 status = psa_crypto_stop_transaction();
7577 } else if (status == PSA_ERROR_DOES_NOT_EXIST) {
Gilles Peskinefc762652019-07-22 19:30:34 +02007578 /* There's no transaction to complete. It's all good. */
7579 status = PSA_SUCCESS;
7580 }
Gilles Peskine4b734222019-07-24 15:56:31 +02007581#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
Gilles Peskinefc762652019-07-22 19:30:34 +02007582
Gilles Peskinec6b69072018-11-20 21:42:52 +01007583 /* All done. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01007584 global_data.initialized = 1;
7585
7586exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007587 if (status != PSA_SUCCESS) {
7588 mbedtls_psa_crypto_free();
7589 }
7590 return status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007591}
7592
Yanray Wangffc3c482023-07-11 12:01:04 +08007593#if defined(PSA_WANT_ALG_SOME_PAKE)
Przemek Stekielca8d2b22023-01-17 16:21:33 +01007594psa_status_t psa_crypto_driver_pake_get_password_len(
7595 const psa_crypto_driver_pake_inputs_t *inputs,
7596 size_t *password_len)
7597{
7598 if (inputs->password_len == 0) {
7599 return PSA_ERROR_BAD_STATE;
7600 }
7601
7602 *password_len = inputs->password_len;
7603
7604 return PSA_SUCCESS;
7605}
7606
7607psa_status_t psa_crypto_driver_pake_get_password(
7608 const psa_crypto_driver_pake_inputs_t *inputs,
7609 uint8_t *buffer, size_t buffer_size, size_t *buffer_length)
7610{
7611 if (inputs->password_len == 0) {
7612 return PSA_ERROR_BAD_STATE;
7613 }
7614
7615 if (buffer_size < inputs->password_len) {
7616 return PSA_ERROR_BUFFER_TOO_SMALL;
7617 }
7618
7619 memcpy(buffer, inputs->password, inputs->password_len);
7620 *buffer_length = inputs->password_len;
7621
7622 return PSA_SUCCESS;
7623}
7624
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007625psa_status_t psa_crypto_driver_pake_get_user_len(
7626 const psa_crypto_driver_pake_inputs_t *inputs,
7627 size_t *user_len)
7628{
7629 if (inputs->user_len == 0) {
7630 return PSA_ERROR_BAD_STATE;
7631 }
7632
7633 *user_len = inputs->user_len;
7634
7635 return PSA_SUCCESS;
7636}
7637
7638psa_status_t psa_crypto_driver_pake_get_user(
7639 const psa_crypto_driver_pake_inputs_t *inputs,
Przemek Stekielc0e62502023-03-14 11:49:36 +01007640 uint8_t *user_id, size_t user_id_size, size_t *user_id_len)
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007641{
7642 if (inputs->user_len == 0) {
7643 return PSA_ERROR_BAD_STATE;
7644 }
7645
Przemek Stekielc0e62502023-03-14 11:49:36 +01007646 if (user_id_size < inputs->user_len) {
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007647 return PSA_ERROR_BUFFER_TOO_SMALL;
7648 }
7649
Przemek Stekielc0e62502023-03-14 11:49:36 +01007650 memcpy(user_id, inputs->user, inputs->user_len);
7651 *user_id_len = inputs->user_len;
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007652
7653 return PSA_SUCCESS;
7654}
7655
7656psa_status_t psa_crypto_driver_pake_get_peer_len(
7657 const psa_crypto_driver_pake_inputs_t *inputs,
7658 size_t *peer_len)
7659{
7660 if (inputs->peer_len == 0) {
7661 return PSA_ERROR_BAD_STATE;
7662 }
7663
7664 *peer_len = inputs->peer_len;
7665
7666 return PSA_SUCCESS;
7667}
7668
7669psa_status_t psa_crypto_driver_pake_get_peer(
7670 const psa_crypto_driver_pake_inputs_t *inputs,
Przemek Stekielc0e62502023-03-14 11:49:36 +01007671 uint8_t *peer_id, size_t peer_id_size, size_t *peer_id_length)
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007672{
7673 if (inputs->peer_len == 0) {
7674 return PSA_ERROR_BAD_STATE;
7675 }
7676
Przemek Stekielc0e62502023-03-14 11:49:36 +01007677 if (peer_id_size < inputs->peer_len) {
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007678 return PSA_ERROR_BUFFER_TOO_SMALL;
7679 }
7680
Przemek Stekielc0e62502023-03-14 11:49:36 +01007681 memcpy(peer_id, inputs->peer, inputs->peer_len);
7682 *peer_id_length = inputs->peer_len;
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007683
7684 return PSA_SUCCESS;
7685}
7686
Przemek Stekielca8d2b22023-01-17 16:21:33 +01007687psa_status_t psa_crypto_driver_pake_get_cipher_suite(
7688 const psa_crypto_driver_pake_inputs_t *inputs,
7689 psa_pake_cipher_suite_t *cipher_suite)
7690{
7691 if (inputs->cipher_suite.algorithm == PSA_ALG_NONE) {
7692 return PSA_ERROR_BAD_STATE;
7693 }
7694
7695 *cipher_suite = inputs->cipher_suite;
7696
7697 return PSA_SUCCESS;
7698}
7699
Neil Armstronga7d08c32022-06-01 18:21:20 +02007700psa_status_t psa_pake_setup(
7701 psa_pake_operation_t *operation,
7702 const psa_pake_cipher_suite_t *cipher_suite)
7703{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007704 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007705
Przemek Stekiel1c3cfb42023-01-26 10:35:02 +01007706 if (operation->stage != PSA_PAKE_OPERATION_STAGE_SETUP) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007707 status = PSA_ERROR_BAD_STATE;
7708 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007709 }
7710
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01007711 if (PSA_ALG_IS_PAKE(cipher_suite->algorithm) == 0 ||
Przemek Stekiel51eac532022-12-07 11:04:51 +01007712 PSA_ALG_IS_HASH(cipher_suite->hash) == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007713 status = PSA_ERROR_INVALID_ARGUMENT;
7714 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007715 }
7716
Przemek Stekiel51eac532022-12-07 11:04:51 +01007717 memset(&operation->data.inputs, 0, sizeof(operation->data.inputs));
7718
Przemek Stekiele12ed362022-12-21 12:54:46 +01007719 operation->alg = cipher_suite->algorithm;
Przemek Stekiel656b2592023-03-22 13:15:33 +01007720 operation->primitive = PSA_PAKE_PRIMITIVE(cipher_suite->type,
7721 cipher_suite->family, cipher_suite->bits);
Przemek Stekiel51eac532022-12-07 11:04:51 +01007722 operation->data.inputs.cipher_suite = *cipher_suite;
7723
Przemek Stekiel4aa99402023-02-27 13:00:57 +01007724#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01007725 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01007726 psa_jpake_computation_stage_t *computation_stage =
Przemek Stekieldde6a912023-01-26 08:46:37 +01007727 &operation->computation_stage.jpake;
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01007728
David Horstmann16f01512023-06-14 17:21:07 +01007729 memset(computation_stage, 0, sizeof(*computation_stage));
David Horstmanne7f21e62023-05-12 18:17:21 +01007730 computation_stage->step = PSA_PAKE_STEP_KEY_SHARE;
Przemek Stekiel80a88492023-02-20 13:32:22 +01007731 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007732#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01007733 {
7734 status = PSA_ERROR_NOT_SUPPORTED;
7735 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01007736 }
7737
Przemek Stekiel1c3cfb42023-01-26 10:35:02 +01007738 operation->stage = PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS;
7739
Przemek Stekiel51eac532022-12-07 11:04:51 +01007740 return PSA_SUCCESS;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007741exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007742 psa_pake_abort(operation);
7743 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02007744}
7745
7746psa_status_t psa_pake_set_password_key(
7747 psa_pake_operation_t *operation,
7748 mbedtls_svc_key_id_t password)
7749{
Neil Armstrong5ae60962022-09-15 11:29:46 +02007750 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel6c764412022-11-22 14:05:12 +01007751 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
7752 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007753 psa_key_attributes_t attributes;
7754 psa_key_type_t type;
Neil Armstrong5ae60962022-09-15 11:29:46 +02007755
Przemek Stekiel51eac532022-12-07 11:04:51 +01007756 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007757 status = PSA_ERROR_BAD_STATE;
7758 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007759 }
7760
Przemek Stekiel6c764412022-11-22 14:05:12 +01007761 status = psa_get_and_lock_key_slot_with_policy(password, &slot,
7762 PSA_KEY_USAGE_DERIVE,
Przemek Stekield5d28a22023-01-26 10:46:05 +01007763 operation->alg);
Neil Armstrong5ae60962022-09-15 11:29:46 +02007764 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007765 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02007766 }
7767
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007768 attributes = (psa_key_attributes_t) {
Przemek Stekiel6c764412022-11-22 14:05:12 +01007769 .core = slot->attr
7770 };
Neil Armstrong5ae60962022-09-15 11:29:46 +02007771
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007772 type = psa_get_key_type(&attributes);
Neil Armstrong5ae60962022-09-15 11:29:46 +02007773
Przemek Stekiel51eac532022-12-07 11:04:51 +01007774 if (type != PSA_KEY_TYPE_PASSWORD &&
7775 type != PSA_KEY_TYPE_PASSWORD_HASH) {
7776 status = PSA_ERROR_INVALID_ARGUMENT;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007777 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007778 }
7779
Przemek Stekiel51eac532022-12-07 11:04:51 +01007780 operation->data.inputs.password = mbedtls_calloc(1, slot->key.bytes);
7781 if (operation->data.inputs.password == NULL) {
Przemek Stekiele12ed362022-12-21 12:54:46 +01007782 status = PSA_ERROR_INSUFFICIENT_MEMORY;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007783 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007784 }
7785
7786 memcpy(operation->data.inputs.password, slot->key.data, slot->key.bytes);
7787 operation->data.inputs.password_len = slot->key.bytes;
Przemek Stekiel9dd24402023-01-26 15:06:09 +01007788 operation->data.inputs.attributes = attributes;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007789exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007790 if (status != PSA_SUCCESS) {
7791 psa_pake_abort(operation);
7792 }
Ryan Everett1b70a072024-01-04 10:32:49 +00007793 unlock_status = psa_unregister_read(slot);
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007794 return (status == PSA_SUCCESS) ? unlock_status : status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02007795}
7796
7797psa_status_t psa_pake_set_user(
7798 psa_pake_operation_t *operation,
7799 const uint8_t *user_id,
7800 size_t user_id_len)
7801{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007802 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007803
7804 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007805 status = PSA_ERROR_BAD_STATE;
7806 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02007807 }
7808
Przemek Stekiel51eac532022-12-07 11:04:51 +01007809 if (user_id_len == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007810 status = PSA_ERROR_INVALID_ARGUMENT;
7811 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02007812 }
7813
Przemek Stekielf309d6b2023-03-10 09:54:45 +01007814 if (operation->data.inputs.user_len != 0) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007815 status = PSA_ERROR_BAD_STATE;
7816 goto exit;
7817 }
7818
Przemek Stekielf309d6b2023-03-10 09:54:45 +01007819 operation->data.inputs.user = mbedtls_calloc(1, user_id_len);
7820 if (operation->data.inputs.user == NULL) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007821 status = PSA_ERROR_INSUFFICIENT_MEMORY;
7822 goto exit;
7823 }
7824
Przemek Stekielf309d6b2023-03-10 09:54:45 +01007825 memcpy(operation->data.inputs.user, user_id, user_id_len);
7826 operation->data.inputs.user_len = user_id_len;
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007827
7828 return PSA_SUCCESS;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007829exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007830 psa_pake_abort(operation);
7831 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02007832}
7833
7834psa_status_t psa_pake_set_peer(
7835 psa_pake_operation_t *operation,
7836 const uint8_t *peer_id,
7837 size_t peer_id_len)
7838{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007839 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007840
7841 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007842 status = PSA_ERROR_BAD_STATE;
7843 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02007844 }
7845
Przemek Stekiel51eac532022-12-07 11:04:51 +01007846 if (peer_id_len == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007847 status = PSA_ERROR_INVALID_ARGUMENT;
7848 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02007849 }
7850
Przemek Stekielf309d6b2023-03-10 09:54:45 +01007851 if (operation->data.inputs.peer_len != 0) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007852 status = PSA_ERROR_BAD_STATE;
7853 goto exit;
7854 }
7855
Przemek Stekielf309d6b2023-03-10 09:54:45 +01007856 operation->data.inputs.peer = mbedtls_calloc(1, peer_id_len);
7857 if (operation->data.inputs.peer == NULL) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007858 status = PSA_ERROR_INSUFFICIENT_MEMORY;
7859 goto exit;
7860 }
7861
Przemek Stekielf309d6b2023-03-10 09:54:45 +01007862 memcpy(operation->data.inputs.peer, peer_id, peer_id_len);
7863 operation->data.inputs.peer_len = peer_id_len;
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007864
7865 return PSA_SUCCESS;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007866exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007867 psa_pake_abort(operation);
7868 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02007869}
7870
7871psa_status_t psa_pake_set_role(
7872 psa_pake_operation_t *operation,
7873 psa_pake_role_t role)
7874{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007875 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007876
Przemek Stekiel51eac532022-12-07 11:04:51 +01007877 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007878 status = PSA_ERROR_BAD_STATE;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007879 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007880 }
7881
Przemek Stekiel09104b82023-03-06 14:11:51 +01007882 switch (operation->alg) {
7883#if defined(PSA_WANT_ALG_JPAKE)
7884 case PSA_ALG_JPAKE:
7885 if (role == PSA_PAKE_ROLE_NONE) {
7886 return PSA_SUCCESS;
7887 }
7888 status = PSA_ERROR_INVALID_ARGUMENT;
7889 break;
7890#endif
7891 default:
7892 (void) role;
7893 status = PSA_ERROR_NOT_SUPPORTED;
7894 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02007895 }
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007896exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007897 psa_pake_abort(operation);
7898 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02007899}
7900
David Horstmanne7f21e62023-05-12 18:17:21 +01007901/* Auxiliary function to convert core computation stage to single driver step. */
Przemek Stekiel4aa99402023-02-27 13:00:57 +01007902#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiel251e86a2023-02-17 14:30:50 +01007903static psa_crypto_driver_pake_step_t convert_jpake_computation_stage_to_driver_step(
Przemek Stekieldde6a912023-01-26 08:46:37 +01007904 psa_jpake_computation_stage_t *stage)
Przemek Stekielb09c4872023-01-17 12:05:38 +01007905{
David Horstmann74a3d8c2023-06-14 18:28:19 +01007906 psa_crypto_driver_pake_step_t key_share_step;
David Horstmann5da95602023-06-08 15:37:12 +01007907 if (stage->round == PSA_JPAKE_FIRST) {
David Horstmanne7f21e62023-05-12 18:17:21 +01007908 int is_x1;
David Horstmann74a3d8c2023-06-14 18:28:19 +01007909
David Horstmann024e5c52023-06-14 15:48:21 +01007910 if (stage->io_mode == PSA_JPAKE_OUTPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01007911 is_x1 = (stage->outputs < 1);
7912 } else {
7913 is_x1 = (stage->inputs < 1);
7914 }
7915
David Horstmann74a3d8c2023-06-14 18:28:19 +01007916 key_share_step = is_x1 ?
7917 PSA_JPAKE_X1_STEP_KEY_SHARE :
7918 PSA_JPAKE_X2_STEP_KEY_SHARE;
David Horstmann5da95602023-06-08 15:37:12 +01007919 } else if (stage->round == PSA_JPAKE_SECOND) {
David Horstmann74a3d8c2023-06-14 18:28:19 +01007920 key_share_step = (stage->io_mode == PSA_JPAKE_OUTPUT) ?
7921 PSA_JPAKE_X2S_STEP_KEY_SHARE :
7922 PSA_JPAKE_X4S_STEP_KEY_SHARE;
7923 } else {
7924 return PSA_JPAKE_STEP_INVALID;
Przemek Stekielb09c4872023-01-17 12:05:38 +01007925 }
Agathiyan Bragadeesh387bfa52023-07-17 17:01:33 +01007926 return (psa_crypto_driver_pake_step_t) (key_share_step + stage->step - PSA_PAKE_STEP_KEY_SHARE);
Przemek Stekielb09c4872023-01-17 12:05:38 +01007927}
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007928#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekielb09c4872023-01-17 12:05:38 +01007929
Przemek Stekiel2797d372022-12-22 11:19:22 +01007930static psa_status_t psa_pake_complete_inputs(
7931 psa_pake_operation_t *operation)
7932{
Przemek Stekiel2797d372022-12-22 11:19:22 +01007933 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel18620a32023-01-17 16:34:52 +01007934 /* Create copy of the inputs on stack as inputs share memory
7935 with the driver context which will be setup by the driver. */
7936 psa_crypto_driver_pake_inputs_t inputs = operation->data.inputs;
Przemek Stekiel2797d372022-12-22 11:19:22 +01007937
Przemek Stekielfde11282023-03-13 16:06:09 +01007938 if (inputs.password_len == 0) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01007939 return PSA_ERROR_BAD_STATE;
7940 }
7941
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007942 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekielfde11282023-03-13 16:06:09 +01007943 if (inputs.user_len == 0 || inputs.peer_len == 0) {
7944 return PSA_ERROR_BAD_STATE;
7945 }
Przemek Stekieldff21d32023-02-14 20:09:10 +01007946 }
7947
Przemek Stekiel18620a32023-01-17 16:34:52 +01007948 /* Clear driver context */
7949 mbedtls_platform_zeroize(&operation->data, sizeof(operation->data));
7950
7951 status = psa_driver_wrapper_pake_setup(operation, &inputs);
Przemek Stekiel2797d372022-12-22 11:19:22 +01007952
7953 /* Driver is responsible for creating its own copy of the password. */
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01007954 mbedtls_zeroize_and_free(inputs.password, inputs.password_len);
Przemek Stekiel2797d372022-12-22 11:19:22 +01007955
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007956 /* User and peer are translated to role. */
7957 mbedtls_free(inputs.user);
7958 mbedtls_free(inputs.peer);
7959
Przemek Stekiel2797d372022-12-22 11:19:22 +01007960 if (status == PSA_SUCCESS) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01007961#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiel2797d372022-12-22 11:19:22 +01007962 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekield93de322023-02-24 08:39:04 +01007963 operation->stage = PSA_PAKE_OPERATION_STAGE_COMPUTATION;
Przemek Stekiel80a88492023-02-20 13:32:22 +01007964 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007965#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01007966 {
7967 status = PSA_ERROR_NOT_SUPPORTED;
Przemek Stekiel2797d372022-12-22 11:19:22 +01007968 }
Przemek Stekiel2797d372022-12-22 11:19:22 +01007969 }
Przemek Stekiel2797d372022-12-22 11:19:22 +01007970 return status;
7971}
7972
Przemek Stekiel4aa99402023-02-27 13:00:57 +01007973#if defined(PSA_WANT_ALG_JPAKE)
David Horstmanne7f21e62023-05-12 18:17:21 +01007974static psa_status_t psa_jpake_prologue(
Przemek Stekiele12ed362022-12-21 12:54:46 +01007975 psa_pake_operation_t *operation,
David Horstmanne7f21e62023-05-12 18:17:21 +01007976 psa_pake_step_t step,
David Horstmann00ad6bf2023-06-14 15:44:24 +01007977 psa_jpake_io_mode_t io_mode)
Przemek Stekiele12ed362022-12-21 12:54:46 +01007978{
Przemek Stekiele12ed362022-12-21 12:54:46 +01007979 if (step != PSA_PAKE_STEP_KEY_SHARE &&
7980 step != PSA_PAKE_STEP_ZK_PUBLIC &&
7981 step != PSA_PAKE_STEP_ZK_PROOF) {
7982 return PSA_ERROR_INVALID_ARGUMENT;
7983 }
7984
Przemek Stekiel5eff1032023-02-21 19:10:36 +01007985 psa_jpake_computation_stage_t *computation_stage =
7986 &operation->computation_stage.jpake;
Przemek Stekiele12ed362022-12-21 12:54:46 +01007987
David Horstmann5da95602023-06-08 15:37:12 +01007988 if (computation_stage->round != PSA_JPAKE_FIRST &&
7989 computation_stage->round != PSA_JPAKE_SECOND) {
Przemek Stekiel5eff1032023-02-21 19:10:36 +01007990 return PSA_ERROR_BAD_STATE;
7991 }
7992
David Horstmanne7f21e62023-05-12 18:17:21 +01007993 /* Check that the step we are given is the one we were expecting */
7994 if (step != computation_stage->step) {
Przemek Stekiel5eff1032023-02-21 19:10:36 +01007995 return PSA_ERROR_BAD_STATE;
7996 }
7997
David Horstmanne7f21e62023-05-12 18:17:21 +01007998 if (step == PSA_PAKE_STEP_KEY_SHARE &&
7999 computation_stage->inputs == 0 &&
8000 computation_stage->outputs == 0) {
8001 /* Start of the round, so function decides whether we are inputting
8002 * or outputting */
David Horstmann024e5c52023-06-14 15:48:21 +01008003 computation_stage->io_mode = io_mode;
8004 } else if (computation_stage->io_mode != io_mode) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008005 /* Middle of the round so the mode we are in must match the function
8006 * called by the user */
8007 return PSA_ERROR_BAD_STATE;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008008 }
8009
8010 return PSA_SUCCESS;
8011}
8012
David Horstmanne7f21e62023-05-12 18:17:21 +01008013static psa_status_t psa_jpake_epilogue(
8014 psa_pake_operation_t *operation,
David Horstmann00ad6bf2023-06-14 15:44:24 +01008015 psa_jpake_io_mode_t io_mode)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008016{
David Horstmanne7f21e62023-05-12 18:17:21 +01008017 psa_jpake_computation_stage_t *stage =
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008018 &operation->computation_stage.jpake;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008019
David Horstmanne7f21e62023-05-12 18:17:21 +01008020 if (stage->step == PSA_PAKE_STEP_ZK_PROOF) {
8021 /* End of an input/output */
David Horstmann00ad6bf2023-06-14 15:44:24 +01008022 if (io_mode == PSA_JPAKE_INPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008023 stage->inputs++;
David Horstmann246ec5a2023-06-27 10:33:06 +01008024 if (stage->inputs == PSA_JPAKE_EXPECTED_INPUTS(stage->round)) {
David Horstmann024e5c52023-06-14 15:48:21 +01008025 stage->io_mode = PSA_JPAKE_OUTPUT;
David Horstmanne7f21e62023-05-12 18:17:21 +01008026 }
8027 }
David Horstmann00ad6bf2023-06-14 15:44:24 +01008028 if (io_mode == PSA_JPAKE_OUTPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008029 stage->outputs++;
David Horstmann246ec5a2023-06-27 10:33:06 +01008030 if (stage->outputs == PSA_JPAKE_EXPECTED_OUTPUTS(stage->round)) {
David Horstmann024e5c52023-06-14 15:48:21 +01008031 stage->io_mode = PSA_JPAKE_INPUT;
David Horstmanne7f21e62023-05-12 18:17:21 +01008032 }
8033 }
David Horstmann246ec5a2023-06-27 10:33:06 +01008034 if (stage->inputs == PSA_JPAKE_EXPECTED_INPUTS(stage->round) &&
8035 stage->outputs == PSA_JPAKE_EXPECTED_OUTPUTS(stage->round)) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008036 /* End of a round, move to the next round */
8037 stage->inputs = 0;
8038 stage->outputs = 0;
8039 stage->round++;
8040 }
8041 stage->step = PSA_PAKE_STEP_KEY_SHARE;
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008042 } else {
David Horstmanne7f21e62023-05-12 18:17:21 +01008043 stage->step++;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008044 }
Przemek Stekiele12ed362022-12-21 12:54:46 +01008045 return PSA_SUCCESS;
8046}
David Horstmanne7f21e62023-05-12 18:17:21 +01008047
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008048#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008049
Neil Armstronga7d08c32022-06-01 18:21:20 +02008050psa_status_t psa_pake_output(
8051 psa_pake_operation_t *operation,
8052 psa_pake_step_t step,
8053 uint8_t *output,
8054 size_t output_size,
8055 size_t *output_length)
8056{
Przemek Stekiel51eac532022-12-07 11:04:51 +01008057 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008058 psa_crypto_driver_pake_step_t driver_step = PSA_JPAKE_STEP_INVALID;
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008059 *output_length = 0;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008060
8061 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01008062 status = psa_pake_complete_inputs(operation);
8063 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008064 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008065 }
8066 }
8067
8068 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008069 status = PSA_ERROR_BAD_STATE;
8070 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008071 }
8072
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008073 if (output_size == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008074 status = PSA_ERROR_INVALID_ARGUMENT;
8075 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008076 }
8077
Przemek Stekiele12ed362022-12-21 12:54:46 +01008078 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008079#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008080 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008081 status = psa_jpake_prologue(operation, step, PSA_JPAKE_OUTPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008082 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008083 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008084 }
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008085 driver_step = convert_jpake_computation_stage_to_driver_step(
8086 &operation->computation_stage.jpake);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008087 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008088#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008089 default:
Przemek Stekiel80a88492023-02-20 13:32:22 +01008090 (void) step;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008091 status = PSA_ERROR_NOT_SUPPORTED;
8092 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008093 }
8094
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008095 status = psa_driver_wrapper_pake_output(operation, driver_step,
8096 output, output_size, output_length);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008097
8098 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008099 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008100 }
8101
8102 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008103#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008104 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008105 status = psa_jpake_epilogue(operation, PSA_JPAKE_OUTPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008106 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008107 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008108 }
8109 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008110#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008111 default:
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008112 status = PSA_ERROR_NOT_SUPPORTED;
8113 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008114 }
8115
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008116 return PSA_SUCCESS;
8117exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008118 psa_pake_abort(operation);
8119 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008120}
8121
8122psa_status_t psa_pake_input(
8123 psa_pake_operation_t *operation,
8124 psa_pake_step_t step,
8125 const uint8_t *input,
8126 size_t input_length)
8127{
Przemek Stekiel51eac532022-12-07 11:04:51 +01008128 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008129 psa_crypto_driver_pake_step_t driver_step = PSA_JPAKE_STEP_INVALID;
Przemek Stekiel256c75d2023-03-23 14:09:34 +01008130 const size_t max_input_length = (size_t) PSA_PAKE_INPUT_SIZE(operation->alg,
8131 operation->primitive,
8132 step);
Przemek Stekiel51eac532022-12-07 11:04:51 +01008133
8134 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01008135 status = psa_pake_complete_inputs(operation);
8136 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008137 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008138 }
8139 }
8140
8141 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008142 status = PSA_ERROR_BAD_STATE;
8143 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008144 }
8145
Przemek Stekiel256c75d2023-03-23 14:09:34 +01008146 if (input_length == 0 || input_length > max_input_length) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008147 status = PSA_ERROR_INVALID_ARGUMENT;
8148 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008149 }
8150
Przemek Stekiele12ed362022-12-21 12:54:46 +01008151 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008152#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008153 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008154 status = psa_jpake_prologue(operation, step, PSA_JPAKE_INPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008155 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008156 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008157 }
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008158 driver_step = convert_jpake_computation_stage_to_driver_step(
8159 &operation->computation_stage.jpake);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008160 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008161#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008162 default:
Przemek Stekiel80a88492023-02-20 13:32:22 +01008163 (void) step;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008164 status = PSA_ERROR_NOT_SUPPORTED;
8165 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008166 }
8167
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008168 status = psa_driver_wrapper_pake_input(operation, driver_step,
8169 input, input_length);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008170
8171 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008172 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008173 }
8174
8175 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008176#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008177 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008178 status = psa_jpake_epilogue(operation, PSA_JPAKE_INPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008179 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008180 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008181 }
8182 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008183#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008184 default:
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008185 status = PSA_ERROR_NOT_SUPPORTED;
8186 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008187 }
8188
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008189 return PSA_SUCCESS;
8190exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008191 psa_pake_abort(operation);
8192 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008193}
8194
8195psa_status_t psa_pake_get_implicit_key(
8196 psa_pake_operation_t *operation,
8197 psa_key_derivation_operation_t *output)
8198{
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008199 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008200 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel251e86a2023-02-17 14:30:50 +01008201 uint8_t shared_key[MBEDTLS_PSA_JPAKE_BUFFER_SIZE];
Przemek Stekiel0c781802022-11-29 14:53:13 +01008202 size_t shared_key_len = 0;
8203
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008204 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008205 status = PSA_ERROR_BAD_STATE;
8206 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008207 }
8208
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008209#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008210 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008211 psa_jpake_computation_stage_t *computation_stage =
Przemek Stekiel083745e2023-02-23 17:28:23 +01008212 &operation->computation_stage.jpake;
David Horstmann5da95602023-06-08 15:37:12 +01008213 if (computation_stage->round != PSA_JPAKE_FINISHED) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008214 status = PSA_ERROR_BAD_STATE;
8215 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008216 }
Przemek Stekiel80a88492023-02-20 13:32:22 +01008217 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008218#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01008219 {
8220 status = PSA_ERROR_NOT_SUPPORTED;
8221 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008222 }
8223
Przemek Stekiel0c781802022-11-29 14:53:13 +01008224 status = psa_driver_wrapper_pake_get_implicit_key(operation,
8225 shared_key,
Przemek Stekiel6b648622023-02-19 22:55:33 +01008226 sizeof(shared_key),
Przemek Stekiel0c781802022-11-29 14:53:13 +01008227 &shared_key_len);
8228
8229 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008230 goto exit;
Przemek Stekiel0c781802022-11-29 14:53:13 +01008231 }
8232
8233 status = psa_key_derivation_input_bytes(output,
8234 PSA_KEY_DERIVATION_INPUT_SECRET,
8235 shared_key,
8236 shared_key_len);
8237
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008238 mbedtls_platform_zeroize(shared_key, sizeof(shared_key));
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008239exit:
8240 abort_status = psa_pake_abort(operation);
8241 return status == PSA_SUCCESS ? abort_status : status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008242}
8243
8244psa_status_t psa_pake_abort(
8245 psa_pake_operation_t *operation)
8246{
Przemek Stekield69dca92023-01-31 19:59:20 +01008247 psa_status_t status = PSA_SUCCESS;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008248
Przemek Stekield69dca92023-01-31 19:59:20 +01008249 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008250 status = psa_driver_wrapper_pake_abort(operation);
Neil Armstrong5ae60962022-09-15 11:29:46 +02008251 }
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008252
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008253 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
8254 if (operation->data.inputs.password != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01008255 mbedtls_zeroize_and_free(operation->data.inputs.password,
Przemek Stekielaa183422023-03-06 14:21:44 +01008256 operation->data.inputs.password_len);
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008257 }
8258 if (operation->data.inputs.user != NULL) {
8259 mbedtls_free(operation->data.inputs.user);
8260 }
8261 if (operation->data.inputs.peer != NULL) {
8262 mbedtls_free(operation->data.inputs.peer);
8263 }
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008264 }
Przemek Stekield69dca92023-01-31 19:59:20 +01008265 memset(operation, 0, sizeof(psa_pake_operation_t));
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008266
Przemek Stekield69dca92023-01-31 19:59:20 +01008267 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008268}
Tom Cosgrove6d62fac2023-05-10 14:40:05 +01008269#endif /* PSA_WANT_ALG_SOME_PAKE */
Neil Armstronga7d08c32022-06-01 18:21:20 +02008270
Gilles Peskinee59236f2018-01-27 23:32:46 +01008271#endif /* MBEDTLS_PSA_CRYPTO_C */