blob: 7a76c0bbfabce68ffa332a971d07fa2bb1ecb2eb [file] [log] [blame]
Gilles Peskinee59236f2018-01-27 23:32:46 +01001/*
2 * PSA crypto layer on top of Mbed TLS crypto
3 */
Bence Szépkúti86974652020-06-15 11:59:37 +02004/*
Bence Szépkúti1e148272020-08-07 13:07:28 +02005 * Copyright The Mbed TLS Contributors
Dave Rodgman16799db2023-11-02 19:47:20 +00006 * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
Gilles Peskinee59236f2018-01-27 23:32:46 +01007 */
8
Gilles Peskinedb09ef62020-06-03 01:43:33 +02009#include "common.h"
Ronald Cronafbc7ed2023-01-24 16:02:04 +010010#include "psa_crypto_core_common.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010011
12#if defined(MBEDTLS_PSA_CRYPTO_C)
mohammad160327010052018-07-03 13:16:15 +030013
John Durkop07cc04a2020-11-16 22:08:34 -080014#if defined(MBEDTLS_PSA_CRYPTO_CONFIG)
15#include "check_crypto_config.h"
16#endif
17
Gilles Peskinee59236f2018-01-27 23:32:46 +010018#include "psa/crypto.h"
Przemyslaw Stekiel705fb0f2021-11-24 08:47:29 +010019#include "psa/crypto_values.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010020
Ronald Crond6d28882020-12-14 14:56:02 +010021#include "psa_crypto_cipher.h"
Gilles Peskine039b90c2018-12-07 18:24:41 +010022#include "psa_crypto_core.h"
Gilles Peskine5e769522018-11-20 21:59:56 +010023#include "psa_crypto_invasive.h"
Xiaokang Qiane9c39c42023-08-09 08:50:19 +000024#include "psa_crypto_driver_wrappers.h"
Xiaokang Qianfe9666b2023-09-11 10:36:20 +000025#include "psa_crypto_driver_wrappers_no_static.h"
Ronald Cron00b7bfc2020-11-25 15:25:26 +010026#include "psa_crypto_ecp.h"
Przemek Stekiel359f4622022-12-05 14:11:55 +010027#include "psa_crypto_ffdh.h"
Steven Cooreman5f88e772021-03-15 11:07:12 +010028#include "psa_crypto_hash.h"
Steven Cooreman82c66b62021-03-19 17:39:17 +010029#include "psa_crypto_mac.h"
Ronald Cron00b7bfc2020-11-25 15:25:26 +010030#include "psa_crypto_rsa.h"
Ronald Cron7023db52020-11-20 18:17:42 +010031#include "psa_crypto_ecp.h"
Gilles Peskinea8ade162019-06-26 11:24:49 +020032#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined0890212019-06-24 14:34:43 +020033#include "psa_crypto_se.h"
Gilles Peskinea8ade162019-06-26 11:24:49 +020034#endif
Gilles Peskine961849f2018-11-30 18:54:54 +010035#include "psa_crypto_slot_management.h"
Darryl Greend49a4992018-06-18 17:27:26 +010036/* Include internal declarations that are useful for implementing persistently
37 * stored keys. */
38#include "psa_crypto_storage.h"
39
Gilles Peskineb2b64d32020-12-14 16:43:58 +010040#include "psa_crypto_random_impl.h"
Gilles Peskine90edc992020-11-13 15:39:19 +010041
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010042#include <stdlib.h>
43#include <string.h>
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010044#include "mbedtls/platform.h"
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010045
Gilles Peskine1c49f1a2020-11-13 18:46:25 +010046#include "mbedtls/aes.h"
Gilles Peskine9a944802018-06-21 09:35:35 +020047#include "mbedtls/asn1.h"
Jaeden Amero25384a22019-01-10 10:23:21 +000048#include "mbedtls/asn1write.h"
Gilles Peskinea81d85b2018-06-26 16:10:23 +020049#include "mbedtls/bignum.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010050#include "mbedtls/camellia.h"
Gilles Peskine26869f22019-05-06 15:25:00 +020051#include "mbedtls/chacha20.h"
52#include "mbedtls/chachapoly.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010053#include "mbedtls/cipher.h"
54#include "mbedtls/ccm.h"
55#include "mbedtls/cmac.h"
Dave Rodgman78701152023-08-29 14:20:18 +010056#include "mbedtls/constant_time.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010057#include "mbedtls/des.h"
Gilles Peskineb7ecdf02018-09-18 12:11:27 +020058#include "mbedtls/ecdh.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010059#include "mbedtls/ecp.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010060#include "mbedtls/entropy.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010061#include "mbedtls/error.h"
62#include "mbedtls/gcm.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010063#include "mbedtls/md5.h"
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010064#include "mbedtls/pk.h"
Chris Jonesdaacb592021-03-09 17:03:29 +000065#include "pk_wrap.h"
Gilles Peskine3f108122018-12-07 18:14:53 +010066#include "mbedtls/platform_util.h"
Janos Follath24eed8d2019-11-22 13:21:35 +000067#include "mbedtls/error.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010068#include "mbedtls/ripemd160.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010069#include "mbedtls/rsa.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010070#include "mbedtls/sha1.h"
71#include "mbedtls/sha256.h"
72#include "mbedtls/sha512.h"
Manuel Pégourié-Gonnard02b10d82023-03-28 12:33:20 +020073#include "md_psa.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010074
Przemek Stekiel75fe3fb2022-06-09 14:44:55 +020075#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF) || \
76 defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT) || \
77 defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Przemek Stekiel69c46792022-06-10 12:59:51 +020078#define BUILTIN_ALG_ANY_HKDF 1
Przemek Stekiel75fe3fb2022-06-09 14:44:55 +020079#endif
80
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010081/****************************************************************/
82/* Global data, support functions and library management */
83/****************************************************************/
84
Gilles Peskine449bd832023-01-11 14:50:10 +010085static int key_type_is_raw_bytes(psa_key_type_t type)
Gilles Peskine48c0ea12018-06-21 14:15:31 +020086{
Gilles Peskine449bd832023-01-11 14:50:10 +010087 return PSA_KEY_TYPE_IS_UNSTRUCTURED(type);
Gilles Peskine48c0ea12018-06-21 14:15:31 +020088}
89
Gilles Peskine5a3c50e2018-12-04 12:27:09 +010090/* Values for psa_global_data_t::rng_state */
91#define RNG_NOT_INITIALIZED 0
92#define RNG_INITIALIZED 1
93#define RNG_SEEDED 2
Gilles Peskinec6b69072018-11-20 21:42:52 +010094
Gilles Peskine449bd832023-01-11 14:50:10 +010095typedef struct {
Dave Rodgman864f5942023-08-16 18:04:44 +010096 uint8_t initialized;
97 uint8_t rng_state;
98 uint8_t drivers_initialized;
Gilles Peskine2d8a1822021-11-08 22:20:03 +010099 mbedtls_psa_random_context_t rng;
Gilles Peskinee59236f2018-01-27 23:32:46 +0100100} psa_global_data_t;
101
102static psa_global_data_t global_data;
103
Gilles Peskine5894e8e2020-12-14 14:54:06 +0100104#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
105mbedtls_psa_drbg_context_t *const mbedtls_psa_random_state =
106 &global_data.rng.drbg;
107#endif
108
itayzafrir0adf0fc2018-09-06 16:24:41 +0300109#define GUARD_MODULE_INITIALIZED \
Gilles Peskine449bd832023-01-11 14:50:10 +0100110 if (global_data.initialized == 0) \
111 return PSA_ERROR_BAD_STATE;
itayzafrir0adf0fc2018-09-06 16:24:41 +0300112
Manuel Pégourié-Gonnard7abdf7e2023-03-09 11:17:43 +0100113int psa_can_do_hash(psa_algorithm_t hash_alg)
114{
115 (void) hash_alg;
116 return global_data.drivers_initialized;
117}
Valerio Settia55f0422023-07-10 15:34:41 +0200118#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_IMPORT) || \
Przemek Stekiel53410502023-04-28 13:18:43 +0200119 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY) || \
Valerio Settia55f0422023-07-10 15:34:41 +0200120 defined(PSA_WANT_KEY_TYPE_DH_KEY_PAIR_GENERATE)
Przemek Stekiel134cc2e2023-05-05 10:13:37 +0200121static int psa_is_dh_key_size_valid(size_t bits)
122{
Przemek Stekield1cf1ba2023-04-27 12:04:21 +0200123 if (bits != 2048 && bits != 3072 && bits != 4096 &&
124 bits != 6144 && bits != 8192) {
125 return 0;
126 }
127
128 return 1;
129}
Valerio Settia55f0422023-07-10 15:34:41 +0200130#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_IMPORT ||
Przemek Stekiel53410502023-04-28 13:18:43 +0200131 MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY ||
Valerio Settia55f0422023-07-10 15:34:41 +0200132 PSA_WANT_KEY_TYPE_DH_KEY_PAIR_GENERATE */
Manuel Pégourié-Gonnard7abdf7e2023-03-09 11:17:43 +0100133
Gilles Peskine449bd832023-01-11 14:50:10 +0100134psa_status_t mbedtls_to_psa_error(int ret)
Gilles Peskinee59236f2018-01-27 23:32:46 +0100135{
Gilles Peskinedbf68962021-01-06 20:04:23 +0100136 /* Mbed TLS error codes can combine a high-level error code and a
137 * low-level error code. The low-level error usually reflects the
138 * root cause better, so dispatch on that preferably. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100139 int low_level_ret = -(-ret & 0x007f);
140 switch (low_level_ret != 0 ? low_level_ret : ret) {
Gilles Peskinee59236f2018-01-27 23:32:46 +0100141 case 0:
Gilles Peskine449bd832023-01-11 14:50:10 +0100142 return PSA_SUCCESS;
Gilles Peskinea5905292018-02-07 20:59:33 +0100143
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100144#if defined(MBEDTLS_AES_C)
Gilles Peskinea5905292018-02-07 20:59:33 +0100145 case MBEDTLS_ERR_AES_INVALID_KEY_LENGTH:
146 case MBEDTLS_ERR_AES_INVALID_INPUT_LENGTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100147 return PSA_ERROR_NOT_SUPPORTED;
Dave Rodgman09a9e582023-08-31 11:05:22 +0100148 case MBEDTLS_ERR_AES_BAD_INPUT_DATA:
149 return PSA_ERROR_INVALID_ARGUMENT;
Dave Rodgman509b5672023-08-16 19:26:23 +0100150#endif
151
152#if defined(MBEDTLS_ASN1_PARSE_C) || defined(MBEDTLS_ASN1_WRITE_C)
Gilles Peskine9a944802018-06-21 09:35:35 +0200153 case MBEDTLS_ERR_ASN1_OUT_OF_DATA:
154 case MBEDTLS_ERR_ASN1_UNEXPECTED_TAG:
155 case MBEDTLS_ERR_ASN1_INVALID_LENGTH:
156 case MBEDTLS_ERR_ASN1_LENGTH_MISMATCH:
157 case MBEDTLS_ERR_ASN1_INVALID_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100158 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine9a944802018-06-21 09:35:35 +0200159 case MBEDTLS_ERR_ASN1_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100160 return PSA_ERROR_INSUFFICIENT_MEMORY;
Gilles Peskine9a944802018-06-21 09:35:35 +0200161 case MBEDTLS_ERR_ASN1_BUF_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +0100162 return PSA_ERROR_BUFFER_TOO_SMALL;
Dave Rodgman509b5672023-08-16 19:26:23 +0100163#endif
Gilles Peskine9a944802018-06-21 09:35:35 +0200164
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100165#if defined(MBEDTLS_CAMELLIA_C)
Jaeden Amero892cd6d2019-02-11 12:21:12 +0000166 case MBEDTLS_ERR_CAMELLIA_BAD_INPUT_DATA:
Gilles Peskinea5905292018-02-07 20:59:33 +0100167 case MBEDTLS_ERR_CAMELLIA_INVALID_INPUT_LENGTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100168 return PSA_ERROR_NOT_SUPPORTED;
Dave Rodgman509b5672023-08-16 19:26:23 +0100169#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100170
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100171#if defined(MBEDTLS_CCM_C)
Gilles Peskinea5905292018-02-07 20:59:33 +0100172 case MBEDTLS_ERR_CCM_BAD_INPUT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100173 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100174 case MBEDTLS_ERR_CCM_AUTH_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100175 return PSA_ERROR_INVALID_SIGNATURE;
Dave Rodgman509b5672023-08-16 19:26:23 +0100176#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100177
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100178#if defined(MBEDTLS_CHACHA20_C)
Gilles Peskine26869f22019-05-06 15:25:00 +0200179 case MBEDTLS_ERR_CHACHA20_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100180 return PSA_ERROR_INVALID_ARGUMENT;
Dave Rodgman509b5672023-08-16 19:26:23 +0100181#endif
Gilles Peskine26869f22019-05-06 15:25:00 +0200182
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100183#if defined(MBEDTLS_CHACHAPOLY_C)
Gilles Peskine26869f22019-05-06 15:25:00 +0200184 case MBEDTLS_ERR_CHACHAPOLY_BAD_STATE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100185 return PSA_ERROR_BAD_STATE;
Gilles Peskine26869f22019-05-06 15:25:00 +0200186 case MBEDTLS_ERR_CHACHAPOLY_AUTH_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100187 return PSA_ERROR_INVALID_SIGNATURE;
Dave Rodgman509b5672023-08-16 19:26:23 +0100188#endif
Gilles Peskine26869f22019-05-06 15:25:00 +0200189
Dave Rodgman509b5672023-08-16 19:26:23 +0100190#if defined(MBEDTLS_CIPHER_C)
Gilles Peskinea5905292018-02-07 20:59:33 +0100191 case MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100192 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea5905292018-02-07 20:59:33 +0100193 case MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100194 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100195 case MBEDTLS_ERR_CIPHER_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100196 return PSA_ERROR_INSUFFICIENT_MEMORY;
Gilles Peskinea5905292018-02-07 20:59:33 +0100197 case MBEDTLS_ERR_CIPHER_INVALID_PADDING:
Gilles Peskine449bd832023-01-11 14:50:10 +0100198 return PSA_ERROR_INVALID_PADDING;
Gilles Peskinea5905292018-02-07 20:59:33 +0100199 case MBEDTLS_ERR_CIPHER_FULL_BLOCK_EXPECTED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100200 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100201 case MBEDTLS_ERR_CIPHER_AUTH_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100202 return PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskinea5905292018-02-07 20:59:33 +0100203 case MBEDTLS_ERR_CIPHER_INVALID_CONTEXT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100204 return PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman509b5672023-08-16 19:26:23 +0100205#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100206
Gilles Peskine449bd832023-01-11 14:50:10 +0100207#if !(defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) || \
208 defined(MBEDTLS_PSA_HMAC_DRBG_MD_TYPE))
Gilles Peskinebee96c82020-11-23 21:00:09 +0100209 /* Only check CTR_DRBG error codes if underlying mbedtls_xxx
210 * functions are passed a CTR_DRBG instance. */
Gilles Peskinea5905292018-02-07 20:59:33 +0100211 case MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100212 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskinea5905292018-02-07 20:59:33 +0100213 case MBEDTLS_ERR_CTR_DRBG_REQUEST_TOO_BIG:
214 case MBEDTLS_ERR_CTR_DRBG_INPUT_TOO_BIG:
Gilles Peskine449bd832023-01-11 14:50:10 +0100215 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea5905292018-02-07 20:59:33 +0100216 case MBEDTLS_ERR_CTR_DRBG_FILE_IO_ERROR:
Gilles Peskine449bd832023-01-11 14:50:10 +0100217 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskine82e57d12020-11-13 21:31:17 +0100218#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100219
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100220#if defined(MBEDTLS_DES_C)
Gilles Peskinea5905292018-02-07 20:59:33 +0100221 case MBEDTLS_ERR_DES_INVALID_INPUT_LENGTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100222 return PSA_ERROR_NOT_SUPPORTED;
Dave Rodgman509b5672023-08-16 19:26:23 +0100223#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100224
Gilles Peskinee59236f2018-01-27 23:32:46 +0100225 case MBEDTLS_ERR_ENTROPY_NO_SOURCES_DEFINED:
226 case MBEDTLS_ERR_ENTROPY_NO_STRONG_SOURCE:
227 case MBEDTLS_ERR_ENTROPY_SOURCE_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100228 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskinea5905292018-02-07 20:59:33 +0100229
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100230#if defined(MBEDTLS_GCM_C)
Gilles Peskinea5905292018-02-07 20:59:33 +0100231 case MBEDTLS_ERR_GCM_AUTH_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100232 return PSA_ERROR_INVALID_SIGNATURE;
Mateusz Starzykf28261f2021-09-30 16:39:07 +0200233 case MBEDTLS_ERR_GCM_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +0100234 return PSA_ERROR_BUFFER_TOO_SMALL;
Gilles Peskinea5905292018-02-07 20:59:33 +0100235 case MBEDTLS_ERR_GCM_BAD_INPUT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100236 return PSA_ERROR_INVALID_ARGUMENT;
Dave Rodgman509b5672023-08-16 19:26:23 +0100237#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100238
Gilles Peskine82e57d12020-11-13 21:31:17 +0100239#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) && \
Gilles Peskine449bd832023-01-11 14:50:10 +0100240 defined(MBEDTLS_PSA_HMAC_DRBG_MD_TYPE)
Gilles Peskinebee96c82020-11-23 21:00:09 +0100241 /* Only check HMAC_DRBG error codes if underlying mbedtls_xxx
242 * functions are passed a HMAC_DRBG instance. */
Gilles Peskine82e57d12020-11-13 21:31:17 +0100243 case MBEDTLS_ERR_HMAC_DRBG_ENTROPY_SOURCE_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100244 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskine82e57d12020-11-13 21:31:17 +0100245 case MBEDTLS_ERR_HMAC_DRBG_REQUEST_TOO_BIG:
246 case MBEDTLS_ERR_HMAC_DRBG_INPUT_TOO_BIG:
Gilles Peskine449bd832023-01-11 14:50:10 +0100247 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine82e57d12020-11-13 21:31:17 +0100248 case MBEDTLS_ERR_HMAC_DRBG_FILE_IO_ERROR:
Gilles Peskine449bd832023-01-11 14:50:10 +0100249 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskine82e57d12020-11-13 21:31:17 +0100250#endif
251
Dave Rodgmandea266f2023-08-31 11:52:43 +0100252#if defined(MBEDTLS_MD_LIGHT)
Gilles Peskinea5905292018-02-07 20:59:33 +0100253 case MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100254 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea5905292018-02-07 20:59:33 +0100255 case MBEDTLS_ERR_MD_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100256 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100257 case MBEDTLS_ERR_MD_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100258 return PSA_ERROR_INSUFFICIENT_MEMORY;
Dave Rodgman509b5672023-08-16 19:26:23 +0100259#if defined(MBEDTLS_FS_IO)
Gilles Peskinea5905292018-02-07 20:59:33 +0100260 case MBEDTLS_ERR_MD_FILE_IO_ERROR:
Gilles Peskine449bd832023-01-11 14:50:10 +0100261 return PSA_ERROR_STORAGE_FAILURE;
Dave Rodgman509b5672023-08-16 19:26:23 +0100262#endif
263#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100264
Dave Rodgman509b5672023-08-16 19:26:23 +0100265#if defined(MBEDTLS_BIGNUM_C)
266#if defined(MBEDTLS_FS_IO)
Gilles Peskinef76aa772018-10-29 19:24:33 +0100267 case MBEDTLS_ERR_MPI_FILE_IO_ERROR:
Gilles Peskine449bd832023-01-11 14:50:10 +0100268 return PSA_ERROR_STORAGE_FAILURE;
Dave Rodgman509b5672023-08-16 19:26:23 +0100269#endif
Gilles Peskinef76aa772018-10-29 19:24:33 +0100270 case MBEDTLS_ERR_MPI_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100271 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100272 case MBEDTLS_ERR_MPI_INVALID_CHARACTER:
Gilles Peskine449bd832023-01-11 14:50:10 +0100273 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100274 case MBEDTLS_ERR_MPI_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +0100275 return PSA_ERROR_BUFFER_TOO_SMALL;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100276 case MBEDTLS_ERR_MPI_NEGATIVE_VALUE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100277 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100278 case MBEDTLS_ERR_MPI_DIVISION_BY_ZERO:
Gilles Peskine449bd832023-01-11 14:50:10 +0100279 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100280 case MBEDTLS_ERR_MPI_NOT_ACCEPTABLE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100281 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100282 case MBEDTLS_ERR_MPI_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100283 return PSA_ERROR_INSUFFICIENT_MEMORY;
Dave Rodgman509b5672023-08-16 19:26:23 +0100284#endif
Gilles Peskinef76aa772018-10-29 19:24:33 +0100285
Dave Rodgman509b5672023-08-16 19:26:23 +0100286#if defined(MBEDTLS_PK_C)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100287 case MBEDTLS_ERR_PK_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100288 return PSA_ERROR_INSUFFICIENT_MEMORY;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100289 case MBEDTLS_ERR_PK_TYPE_MISMATCH:
290 case MBEDTLS_ERR_PK_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100291 return PSA_ERROR_INVALID_ARGUMENT;
Dave Rodgman509b5672023-08-16 19:26:23 +0100292#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) || defined(MBEDTLS_FS_IO) || \
293 defined(MBEDTLS_PSA_ITS_FILE_C)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100294 case MBEDTLS_ERR_PK_FILE_IO_ERROR:
Gilles Peskine449bd832023-01-11 14:50:10 +0100295 return PSA_ERROR_STORAGE_FAILURE;
Dave Rodgman509b5672023-08-16 19:26:23 +0100296#endif
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100297 case MBEDTLS_ERR_PK_KEY_INVALID_VERSION:
298 case MBEDTLS_ERR_PK_KEY_INVALID_FORMAT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100299 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100300 case MBEDTLS_ERR_PK_UNKNOWN_PK_ALG:
Gilles Peskine449bd832023-01-11 14:50:10 +0100301 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100302 case MBEDTLS_ERR_PK_PASSWORD_REQUIRED:
303 case MBEDTLS_ERR_PK_PASSWORD_MISMATCH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100304 return PSA_ERROR_NOT_PERMITTED;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100305 case MBEDTLS_ERR_PK_INVALID_PUBKEY:
Gilles Peskine449bd832023-01-11 14:50:10 +0100306 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100307 case MBEDTLS_ERR_PK_INVALID_ALG:
308 case MBEDTLS_ERR_PK_UNKNOWN_NAMED_CURVE:
309 case MBEDTLS_ERR_PK_FEATURE_UNAVAILABLE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100310 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100311 case MBEDTLS_ERR_PK_SIG_LEN_MISMATCH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100312 return PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskinef9f1bdf2021-06-23 20:32:27 +0200313 case MBEDTLS_ERR_PK_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +0100314 return PSA_ERROR_BUFFER_TOO_SMALL;
Dave Rodgman509b5672023-08-16 19:26:23 +0100315#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100316
Gilles Peskineff2d2002019-05-06 15:26:23 +0200317 case MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100318 return PSA_ERROR_HARDWARE_FAILURE;
Gilles Peskineff2d2002019-05-06 15:26:23 +0200319 case MBEDTLS_ERR_PLATFORM_FEATURE_UNSUPPORTED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100320 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskineff2d2002019-05-06 15:26:23 +0200321
Dave Rodgman509b5672023-08-16 19:26:23 +0100322#if defined(MBEDTLS_RSA_C)
Gilles Peskinea5905292018-02-07 20:59:33 +0100323 case MBEDTLS_ERR_RSA_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100324 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100325 case MBEDTLS_ERR_RSA_INVALID_PADDING:
Gilles Peskine449bd832023-01-11 14:50:10 +0100326 return PSA_ERROR_INVALID_PADDING;
Gilles Peskinea5905292018-02-07 20:59:33 +0100327 case MBEDTLS_ERR_RSA_KEY_GEN_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100328 return PSA_ERROR_HARDWARE_FAILURE;
Gilles Peskinea5905292018-02-07 20:59:33 +0100329 case MBEDTLS_ERR_RSA_KEY_CHECK_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100330 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100331 case MBEDTLS_ERR_RSA_PUBLIC_FAILED:
332 case MBEDTLS_ERR_RSA_PRIVATE_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100333 return PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinea5905292018-02-07 20:59:33 +0100334 case MBEDTLS_ERR_RSA_VERIFY_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100335 return PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskinea5905292018-02-07 20:59:33 +0100336 case MBEDTLS_ERR_RSA_OUTPUT_TOO_LARGE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100337 return PSA_ERROR_BUFFER_TOO_SMALL;
Gilles Peskinea5905292018-02-07 20:59:33 +0100338 case MBEDTLS_ERR_RSA_RNG_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100339 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Dave Rodgman509b5672023-08-16 19:26:23 +0100340#endif
Manuel Pégourié-Gonnard93c08472021-04-15 12:23:55 +0200341
Dave Rodgman1dab4452023-09-01 09:59:51 +0100342#if defined(MBEDTLS_ECP_LIGHT)
itayzafrir5c753392018-05-08 11:18:38 +0300343 case MBEDTLS_ERR_ECP_BAD_INPUT_DATA:
itayzafrir7b30f8b2018-05-09 16:07:36 +0300344 case MBEDTLS_ERR_ECP_INVALID_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +0100345 return PSA_ERROR_INVALID_ARGUMENT;
itayzafrir7b30f8b2018-05-09 16:07:36 +0300346 case MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +0100347 return PSA_ERROR_BUFFER_TOO_SMALL;
itayzafrir7b30f8b2018-05-09 16:07:36 +0300348 case MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100349 return PSA_ERROR_NOT_SUPPORTED;
itayzafrir7b30f8b2018-05-09 16:07:36 +0300350 case MBEDTLS_ERR_ECP_SIG_LEN_MISMATCH:
351 case MBEDTLS_ERR_ECP_VERIFY_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100352 return PSA_ERROR_INVALID_SIGNATURE;
itayzafrir7b30f8b2018-05-09 16:07:36 +0300353 case MBEDTLS_ERR_ECP_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100354 return PSA_ERROR_INSUFFICIENT_MEMORY;
Gilles Peskine40d81602020-11-25 00:09:47 +0100355 case MBEDTLS_ERR_ECP_RANDOM_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100356 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskine40d81602020-11-25 00:09:47 +0100357
Dave Rodgman509b5672023-08-16 19:26:23 +0100358#if defined(MBEDTLS_ECP_RESTARTABLE)
Paul Elliott588f8ed2022-12-02 18:10:26 +0000359 case MBEDTLS_ERR_ECP_IN_PROGRESS:
360 return PSA_OPERATION_INCOMPLETE;
Dave Rodgman509b5672023-08-16 19:26:23 +0100361#endif
362#endif
Paul Elliott588f8ed2022-12-02 18:10:26 +0000363
Janos Follatha13b9052019-11-22 12:48:59 +0000364 case MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100365 return PSA_ERROR_CORRUPTION_DETECTED;
itayzafrir5c753392018-05-08 11:18:38 +0300366
Gilles Peskinee59236f2018-01-27 23:32:46 +0100367 default:
Gilles Peskine449bd832023-01-11 14:50:10 +0100368 return PSA_ERROR_GENERIC_ERROR;
Gilles Peskinee59236f2018-01-27 23:32:46 +0100369 }
370}
371
Paul Elliottdc42ca82023-02-24 18:11:59 +0000372/**
373 * \brief For output buffers which contain "tags"
374 * (outputs that may be checked for validity like
375 * hashes, MACs and signatures), fill the unused
376 * part of the output buffer (the whole buffer on
377 * error, the trailing part on success) with
378 * something that isn't a valid tag (barring an
379 * attack on the tag and deliberately-crafted
380 * input), in case the caller doesn't check the
381 * return status properly.
382 *
383 * \param output_buffer Pointer to buffer to wipe. May not be NULL
384 * unless \p output_buffer_size is zero.
385 * \param status Status of function called to generate
386 * output_buffer originally
387 * \param output_buffer_size Size of output buffer. If zero, \p output_buffer
388 * could be NULL.
389 * \param output_buffer_length Length of data written to output_buffer, must be
390 * less than \p output_buffer_size
391 */
392static void psa_wipe_tag_output_buffer(uint8_t *output_buffer, psa_status_t status,
Paul Elliott7118d172023-02-26 16:57:05 +0000393 size_t output_buffer_size, size_t output_buffer_length)
394{
Paul Elliottdc42ca82023-02-24 18:11:59 +0000395 size_t offset = 0;
396
397 if (output_buffer_size == 0) {
398 /* If output_buffer_size is 0 then we have nothing to do. We must not
399 call memset because output_buffer may be NULL in this case */
400 return;
401 }
402
403 if (status == PSA_SUCCESS) {
404 offset = output_buffer_length;
405 }
406
407 memset(output_buffer + offset, '!', output_buffer_size - offset);
408}
409
Gilles Peskineb0b255c2018-07-06 17:01:38 +0200410
Gilles Peskine449bd832023-01-11 14:50:10 +0100411psa_status_t psa_validate_unstructured_key_bit_size(psa_key_type_t type,
412 size_t bits)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200413{
414 /* Check that the bit size is acceptable for the key type */
Gilles Peskine449bd832023-01-11 14:50:10 +0100415 switch (type) {
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200416 case PSA_KEY_TYPE_RAW_DATA:
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200417 case PSA_KEY_TYPE_HMAC:
Gilles Peskineea0fb492018-07-12 17:17:20 +0200418 case PSA_KEY_TYPE_DERIVE:
Neil Armstrong4b5710f2022-05-25 11:30:27 +0200419 case PSA_KEY_TYPE_PASSWORD:
420 case PSA_KEY_TYPE_PASSWORD_HASH:
Gilles Peskineea0fb492018-07-12 17:17:20 +0200421 break;
Ronald Cron1f0db802021-03-12 09:59:30 +0100422#if defined(PSA_WANT_KEY_TYPE_AES)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200423 case PSA_KEY_TYPE_AES:
Gilles Peskine449bd832023-01-11 14:50:10 +0100424 if (bits != 128 && bits != 192 && bits != 256) {
425 return PSA_ERROR_INVALID_ARGUMENT;
426 }
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200427 break;
428#endif
Gilles Peskine6c12a1e2021-09-21 11:59:39 +0200429#if defined(PSA_WANT_KEY_TYPE_ARIA)
430 case PSA_KEY_TYPE_ARIA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100431 if (bits != 128 && bits != 192 && bits != 256) {
432 return PSA_ERROR_INVALID_ARGUMENT;
433 }
Gilles Peskine6c12a1e2021-09-21 11:59:39 +0200434 break;
435#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100436#if defined(PSA_WANT_KEY_TYPE_CAMELLIA)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200437 case PSA_KEY_TYPE_CAMELLIA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100438 if (bits != 128 && bits != 192 && bits != 256) {
439 return PSA_ERROR_INVALID_ARGUMENT;
440 }
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200441 break;
442#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100443#if defined(PSA_WANT_KEY_TYPE_DES)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200444 case PSA_KEY_TYPE_DES:
Gilles Peskine449bd832023-01-11 14:50:10 +0100445 if (bits != 64 && bits != 128 && bits != 192) {
446 return PSA_ERROR_INVALID_ARGUMENT;
447 }
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200448 break;
449#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100450#if defined(PSA_WANT_KEY_TYPE_CHACHA20)
Gilles Peskine26869f22019-05-06 15:25:00 +0200451 case PSA_KEY_TYPE_CHACHA20:
Gilles Peskine449bd832023-01-11 14:50:10 +0100452 if (bits != 256) {
453 return PSA_ERROR_INVALID_ARGUMENT;
454 }
Gilles Peskine26869f22019-05-06 15:25:00 +0200455 break;
456#endif
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200457 default:
Gilles Peskine449bd832023-01-11 14:50:10 +0100458 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200459 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100460 if (bits % 8 != 0) {
461 return PSA_ERROR_INVALID_ARGUMENT;
462 }
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200463
Gilles Peskine449bd832023-01-11 14:50:10 +0100464 return PSA_SUCCESS;
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200465}
466
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100467/** Check whether a given key type is valid for use with a given MAC algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100468 *
Steven Cooremancd640932021-03-08 12:00:27 +0100469 * Upon successful return of this function, the behavior of #PSA_MAC_LENGTH
470 * when called with the validated \p algorithm and \p key_type is well-defined.
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100471 *
472 * \param[in] algorithm The specific MAC algorithm (can be wildcard).
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100473 * \param[in] key_type The key type of the key to be used with the
474 * \p algorithm.
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100475 *
476 * \retval #PSA_SUCCESS
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100477 * The \p key_type is valid for use with the \p algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100478 * \retval #PSA_ERROR_INVALID_ARGUMENT
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100479 * The \p key_type is not valid for use with the \p algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100480 */
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100481MBEDTLS_STATIC_TESTABLE psa_status_t psa_mac_key_can_do(
Steven Cooreman58c94d32021-03-02 21:31:17 +0100482 psa_algorithm_t algorithm,
Gilles Peskine449bd832023-01-11 14:50:10 +0100483 psa_key_type_t key_type)
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100484{
Gilles Peskine449bd832023-01-11 14:50:10 +0100485 if (PSA_ALG_IS_HMAC(algorithm)) {
486 if (key_type == PSA_KEY_TYPE_HMAC) {
487 return PSA_SUCCESS;
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100488 }
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100489 }
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100490
Gilles Peskine449bd832023-01-11 14:50:10 +0100491 if (PSA_ALG_IS_BLOCK_CIPHER_MAC(algorithm)) {
492 /* Check that we're calling PSA_BLOCK_CIPHER_BLOCK_LENGTH with a cipher
493 * key. */
494 if ((key_type & PSA_KEY_TYPE_CATEGORY_MASK) ==
495 PSA_KEY_TYPE_CATEGORY_SYMMETRIC) {
496 /* PSA_BLOCK_CIPHER_BLOCK_LENGTH returns 1 for stream ciphers and
497 * the block length (larger than 1) for block ciphers. */
498 if (PSA_BLOCK_CIPHER_BLOCK_LENGTH(key_type) > 1) {
499 return PSA_SUCCESS;
500 }
501 }
502 }
503
504 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100505}
506
Gilles Peskine449bd832023-01-11 14:50:10 +0100507psa_status_t psa_allocate_buffer_to_slot(psa_key_slot_t *slot,
508 size_t buffer_length)
Steven Cooreman75b74362020-07-28 14:30:13 +0200509{
Gilles Peskine449bd832023-01-11 14:50:10 +0100510 if (slot->key.data != NULL) {
511 return PSA_ERROR_ALREADY_EXISTS;
512 }
Steven Cooreman75b74362020-07-28 14:30:13 +0200513
Gilles Peskine449bd832023-01-11 14:50:10 +0100514 slot->key.data = mbedtls_calloc(1, buffer_length);
515 if (slot->key.data == NULL) {
516 return PSA_ERROR_INSUFFICIENT_MEMORY;
517 }
Steven Cooreman75b74362020-07-28 14:30:13 +0200518
Ronald Cronea0f8a62020-11-25 17:52:23 +0100519 slot->key.bytes = buffer_length;
Gilles Peskine449bd832023-01-11 14:50:10 +0100520 return PSA_SUCCESS;
Steven Cooreman75b74362020-07-28 14:30:13 +0200521}
522
Gilles Peskine449bd832023-01-11 14:50:10 +0100523psa_status_t psa_copy_key_material_into_slot(psa_key_slot_t *slot,
524 const uint8_t *data,
525 size_t data_length)
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200526{
Gilles Peskine449bd832023-01-11 14:50:10 +0100527 psa_status_t status = psa_allocate_buffer_to_slot(slot,
528 data_length);
529 if (status != PSA_SUCCESS) {
530 return status;
531 }
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200532
Gilles Peskine449bd832023-01-11 14:50:10 +0100533 memcpy(slot->key.data, data, data_length);
534 return PSA_SUCCESS;
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200535}
536
Ronald Crona0fe59f2020-11-29 11:14:53 +0100537psa_status_t psa_import_key_into_slot(
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100538 const psa_key_attributes_t *attributes,
539 const uint8_t *data, size_t data_length,
540 uint8_t *key_buffer, size_t key_buffer_size,
Gilles Peskine449bd832023-01-11 14:50:10 +0100541 size_t *key_buffer_length, size_t *bits)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100542{
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100543 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
544 psa_key_type_t type = attributes->core.type;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100545
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200546 /* zero-length keys are never supported. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100547 if (data_length == 0) {
548 return PSA_ERROR_NOT_SUPPORTED;
549 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200550
Gilles Peskine449bd832023-01-11 14:50:10 +0100551 if (key_type_is_raw_bytes(type)) {
552 *bits = PSA_BYTES_TO_BITS(data_length);
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200553
Gilles Peskine449bd832023-01-11 14:50:10 +0100554 status = psa_validate_unstructured_key_bit_size(attributes->core.type,
555 *bits);
556 if (status != PSA_SUCCESS) {
557 return status;
558 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200559
Ronald Crondd04d422020-11-28 15:14:42 +0100560 /* Copy the key material. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100561 memcpy(key_buffer, data, data_length);
Ronald Crondd04d422020-11-28 15:14:42 +0100562 *key_buffer_length = data_length;
Gilles Peskine449bd832023-01-11 14:50:10 +0100563 (void) key_buffer_size;
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200564
Gilles Peskine449bd832023-01-11 14:50:10 +0100565 return PSA_SUCCESS;
566 } else if (PSA_KEY_TYPE_IS_ASYMMETRIC(type)) {
Valerio Settia55f0422023-07-10 15:34:41 +0200567#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_IMPORT) || \
Przemek Stekiel6d85afa2023-04-28 11:42:17 +0200568 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY)
Przemek Stekiel472b3f32022-12-01 14:38:49 +0100569 if (PSA_KEY_TYPE_IS_DH(type)) {
Przemek Stekield1cf1ba2023-04-27 12:04:21 +0200570 if (psa_is_dh_key_size_valid(PSA_BYTES_TO_BITS(data_length)) == 0) {
Przemek Stekiel472b3f32022-12-01 14:38:49 +0100571 return PSA_ERROR_INVALID_ARGUMENT;
572 }
Przemek Stekiel33c91eb2023-05-30 15:16:35 +0200573 return mbedtls_psa_ffdh_import_key(attributes,
574 data, data_length,
575 key_buffer, key_buffer_size,
576 key_buffer_length,
577 bits);
Przemek Stekiel472b3f32022-12-01 14:38:49 +0100578 }
Valerio Settia55f0422023-07-10 15:34:41 +0200579#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_IMPORT) ||
Przemek Stekiel6d85afa2023-04-28 11:42:17 +0200580 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY) */
Valerio Setti27c501a2023-06-27 16:58:52 +0200581#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_IMPORT) || \
Gilles Peskine449bd832023-01-11 14:50:10 +0100582 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
583 if (PSA_KEY_TYPE_IS_ECC(type)) {
584 return mbedtls_psa_ecp_import_key(attributes,
585 data, data_length,
586 key_buffer, key_buffer_size,
587 key_buffer_length,
588 bits);
Steven Cooreman40120f62020-10-29 11:42:22 +0100589 }
Valerio Setti27c501a2023-06-27 16:58:52 +0200590#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_IMPORT) ||
John Durkop9814fa22020-11-04 12:28:15 -0800591 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
Valerio Settife478902023-07-25 12:27:19 +0200592#if (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) && \
593 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) || \
Gilles Peskine449bd832023-01-11 14:50:10 +0100594 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
595 if (PSA_KEY_TYPE_IS_RSA(type)) {
596 return mbedtls_psa_rsa_import_key(attributes,
597 data, data_length,
598 key_buffer, key_buffer_size,
599 key_buffer_length,
600 bits);
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200601 }
Valerio Settife478902023-07-25 12:27:19 +0200602#endif /* (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) &&
603 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) ||
John Durkop9814fa22020-11-04 12:28:15 -0800604 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100605 }
Steven Cooreman40120f62020-10-29 11:42:22 +0100606
Gilles Peskine449bd832023-01-11 14:50:10 +0100607 return PSA_ERROR_NOT_SUPPORTED;
Darryl Green06fd18d2018-07-16 11:21:11 +0100608}
609
Gilles Peskinef603c712019-01-19 13:40:11 +0100610/** Calculate the intersection of two algorithm usage policies.
611 *
612 * Return 0 (which allows no operation) on incompatibility.
613 */
614static psa_algorithm_t psa_key_policy_algorithm_intersection(
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100615 psa_key_type_t key_type,
Gilles Peskinef603c712019-01-19 13:40:11 +0100616 psa_algorithm_t alg1,
Gilles Peskine449bd832023-01-11 14:50:10 +0100617 psa_algorithm_t alg2)
Gilles Peskinef603c712019-01-19 13:40:11 +0100618{
Gilles Peskine549ea862019-05-22 11:45:59 +0200619 /* Common case: both sides actually specify the same policy. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100620 if (alg1 == alg2) {
621 return alg1;
622 }
Steven Cooreman03488022021-02-18 12:07:20 +0100623 /* If the policies are from the same hash-and-sign family, check
624 * if one is a wildcard. If so the other has the specific algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100625 if (PSA_ALG_IS_SIGN_HASH(alg1) &&
626 PSA_ALG_IS_SIGN_HASH(alg2) &&
627 (alg1 & ~PSA_ALG_HASH_MASK) == (alg2 & ~PSA_ALG_HASH_MASK)) {
628 if (PSA_ALG_SIGN_GET_HASH(alg1) == PSA_ALG_ANY_HASH) {
629 return alg2;
630 }
631 if (PSA_ALG_SIGN_GET_HASH(alg2) == PSA_ALG_ANY_HASH) {
632 return alg1;
633 }
Steven Cooreman03488022021-02-18 12:07:20 +0100634 }
635 /* If the policies are from the same AEAD family, check whether
Steven Cooreman7de9e2d2021-02-22 17:05:56 +0100636 * one of them is a minimum-tag-length wildcard. Calculate the most
Steven Cooreman03488022021-02-18 12:07:20 +0100637 * restrictive tag length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100638 if (PSA_ALG_IS_AEAD(alg1) && PSA_ALG_IS_AEAD(alg2) &&
639 (PSA_ALG_AEAD_WITH_SHORTENED_TAG(alg1, 0) ==
640 PSA_ALG_AEAD_WITH_SHORTENED_TAG(alg2, 0))) {
641 size_t alg1_len = PSA_ALG_AEAD_GET_TAG_LENGTH(alg1);
642 size_t alg2_len = PSA_ALG_AEAD_GET_TAG_LENGTH(alg2);
Steven Cooremancd640932021-03-08 12:00:27 +0100643 size_t restricted_len = alg1_len > alg2_len ? alg1_len : alg2_len;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100644
Steven Cooreman7de9e2d2021-02-22 17:05:56 +0100645 /* If both are wildcards, return most restrictive wildcard */
Gilles Peskine449bd832023-01-11 14:50:10 +0100646 if (((alg1 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0) &&
647 ((alg2 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0)) {
648 return PSA_ALG_AEAD_WITH_AT_LEAST_THIS_LENGTH_TAG(
649 alg1, restricted_len);
Steven Cooreman03488022021-02-18 12:07:20 +0100650 }
651 /* If only one is a wildcard, return specific algorithm if compatible. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100652 if (((alg1 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0) &&
653 (alg1_len <= alg2_len)) {
654 return alg2;
Steven Cooreman03488022021-02-18 12:07:20 +0100655 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100656 if (((alg2 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0) &&
657 (alg2_len <= alg1_len)) {
658 return alg1;
Steven Cooreman03488022021-02-18 12:07:20 +0100659 }
660 }
661 /* If the policies are from the same MAC family, check whether one
662 * of them is a minimum-MAC-length policy. Calculate the most
663 * restrictive tag length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100664 if (PSA_ALG_IS_MAC(alg1) && PSA_ALG_IS_MAC(alg2) &&
665 (PSA_ALG_FULL_LENGTH_MAC(alg1) ==
666 PSA_ALG_FULL_LENGTH_MAC(alg2))) {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100667 /* Validate the combination of key type and algorithm. Since the base
668 * algorithm of alg1 and alg2 are the same, we only need this once. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100669 if (PSA_SUCCESS != psa_mac_key_can_do(alg1, key_type)) {
670 return 0;
671 }
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100672
Steven Cooreman31a876d2021-03-03 20:47:40 +0100673 /* Get the (exact or at-least) output lengths for both sides of the
674 * requested intersection. None of the currently supported algorithms
675 * have an output length dependent on the actual key size, so setting it
676 * to a bogus value of 0 is currently OK.
677 *
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100678 * Note that for at-least-this-length wildcard algorithms, the output
679 * length is set to the shortest allowed length, which allows us to
680 * calculate the most restrictive tag length for the intersection. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100681 size_t alg1_len = PSA_MAC_LENGTH(key_type, 0, alg1);
682 size_t alg2_len = PSA_MAC_LENGTH(key_type, 0, alg2);
Steven Cooremancd640932021-03-08 12:00:27 +0100683 size_t restricted_len = alg1_len > alg2_len ? alg1_len : alg2_len;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100684
Steven Cooremana1d83222021-02-25 10:20:29 +0100685 /* If both are wildcards, return most restrictive wildcard */
Gilles Peskine449bd832023-01-11 14:50:10 +0100686 if (((alg1 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0) &&
687 ((alg2 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0)) {
688 return PSA_ALG_AT_LEAST_THIS_LENGTH_MAC(alg1, restricted_len);
Steven Cooreman03488022021-02-18 12:07:20 +0100689 }
Steven Cooreman31a876d2021-03-03 20:47:40 +0100690
691 /* If only one is an at-least-this-length policy, the intersection would
692 * be the other (fixed-length) policy as long as said fixed length is
693 * equal to or larger than the shortest allowed length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100694 if ((alg1 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0) {
695 return (alg1_len <= alg2_len) ? alg2 : 0;
Steven Cooreman03488022021-02-18 12:07:20 +0100696 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100697 if ((alg2 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0) {
698 return (alg2_len <= alg1_len) ? alg1 : 0;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100699 }
Steven Cooreman31a876d2021-03-03 20:47:40 +0100700
Steven Cooremancd640932021-03-08 12:00:27 +0100701 /* If none of them are wildcards, check whether they define the same tag
702 * length. This is still possible here when one is default-length and
703 * the other specific-length. Ensure to always return the
704 * specific-length version for the intersection. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100705 if (alg1_len == alg2_len) {
706 return PSA_ALG_TRUNCATED_MAC(alg1, alg1_len);
707 }
Gilles Peskinef603c712019-01-19 13:40:11 +0100708 }
709 /* If the policies are incompatible, allow nothing. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100710 return 0;
Gilles Peskinef603c712019-01-19 13:40:11 +0100711}
712
Gilles Peskine449bd832023-01-11 14:50:10 +0100713static int psa_key_algorithm_permits(psa_key_type_t key_type,
714 psa_algorithm_t policy_alg,
715 psa_algorithm_t requested_alg)
Gilles Peskined6f371b2019-05-10 19:33:38 +0200716{
Gilles Peskine549ea862019-05-22 11:45:59 +0200717 /* Common case: the policy only allows requested_alg. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100718 if (requested_alg == policy_alg) {
719 return 1;
720 }
Steven Cooreman03488022021-02-18 12:07:20 +0100721 /* If policy_alg is a hash-and-sign with a wildcard for the hash,
722 * and requested_alg is the same hash-and-sign family with any hash,
723 * then requested_alg is compliant with policy_alg. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100724 if (PSA_ALG_IS_SIGN_HASH(requested_alg) &&
725 PSA_ALG_SIGN_GET_HASH(policy_alg) == PSA_ALG_ANY_HASH) {
726 return (policy_alg & ~PSA_ALG_HASH_MASK) ==
727 (requested_alg & ~PSA_ALG_HASH_MASK);
Steven Cooreman03488022021-02-18 12:07:20 +0100728 }
729 /* If policy_alg is a wildcard AEAD algorithm of the same base as
730 * the requested algorithm, check the requested tag length to be
731 * equal-length or longer than the wildcard-specified length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100732 if (PSA_ALG_IS_AEAD(policy_alg) &&
733 PSA_ALG_IS_AEAD(requested_alg) &&
734 (PSA_ALG_AEAD_WITH_SHORTENED_TAG(policy_alg, 0) ==
735 PSA_ALG_AEAD_WITH_SHORTENED_TAG(requested_alg, 0)) &&
736 ((policy_alg & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0)) {
737 return PSA_ALG_AEAD_GET_TAG_LENGTH(policy_alg) <=
738 PSA_ALG_AEAD_GET_TAG_LENGTH(requested_alg);
Steven Cooreman03488022021-02-18 12:07:20 +0100739 }
Steven Cooremancd640932021-03-08 12:00:27 +0100740 /* If policy_alg is a MAC algorithm of the same base as the requested
741 * algorithm, check whether their MAC lengths are compatible. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100742 if (PSA_ALG_IS_MAC(policy_alg) &&
743 PSA_ALG_IS_MAC(requested_alg) &&
744 (PSA_ALG_FULL_LENGTH_MAC(policy_alg) ==
745 PSA_ALG_FULL_LENGTH_MAC(requested_alg))) {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100746 /* Validate the combination of key type and algorithm. Since the policy
747 * and requested algorithms are the same, we only need this once. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100748 if (PSA_SUCCESS != psa_mac_key_can_do(policy_alg, key_type)) {
749 return 0;
750 }
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100751
Steven Cooreman31a876d2021-03-03 20:47:40 +0100752 /* Get both the requested output length for the algorithm which is to be
753 * verified, and the default output length for the base algorithm.
754 * Note that none of the currently supported algorithms have an output
755 * length dependent on actual key size, so setting it to a bogus value
756 * of 0 is currently OK. */
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100757 size_t requested_output_length = PSA_MAC_LENGTH(
Gilles Peskine449bd832023-01-11 14:50:10 +0100758 key_type, 0, requested_alg);
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100759 size_t default_output_length = PSA_MAC_LENGTH(
Gilles Peskine449bd832023-01-11 14:50:10 +0100760 key_type, 0,
761 PSA_ALG_FULL_LENGTH_MAC(requested_alg));
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100762
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100763 /* If the policy is default-length, only allow an algorithm with
764 * a declared exact-length matching the default. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100765 if (PSA_MAC_TRUNCATED_LENGTH(policy_alg) == 0) {
766 return requested_output_length == default_output_length;
767 }
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100768
769 /* If the requested algorithm is default-length, allow it if the policy
Steven Cooremancd640932021-03-08 12:00:27 +0100770 * length exactly matches the default length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100771 if (PSA_MAC_TRUNCATED_LENGTH(requested_alg) == 0 &&
772 PSA_MAC_TRUNCATED_LENGTH(policy_alg) == default_output_length) {
773 return 1;
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100774 }
775
Steven Cooremancd640932021-03-08 12:00:27 +0100776 /* If policy_alg is an at-least-this-length wildcard MAC algorithm,
777 * check for the requested MAC length to be equal to or longer than the
778 * minimum allowed length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100779 if ((policy_alg & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0) {
780 return PSA_MAC_TRUNCATED_LENGTH(policy_alg) <=
781 requested_output_length;
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100782 }
Gilles Peskined6f371b2019-05-10 19:33:38 +0200783 }
Steven Cooremance48e852020-10-05 16:02:45 +0200784 /* If policy_alg is a generic key agreement operation, then using it for
Steven Cooremanfa5e6312020-10-15 17:07:12 +0200785 * a key derivation with that key agreement should also be allowed. This
786 * behaviour is expected to be defined in a future specification version. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100787 if (PSA_ALG_IS_RAW_KEY_AGREEMENT(policy_alg) &&
788 PSA_ALG_IS_KEY_AGREEMENT(requested_alg)) {
789 return PSA_ALG_KEY_AGREEMENT_GET_BASE(requested_alg) ==
790 policy_alg;
Steven Cooremance48e852020-10-05 16:02:45 +0200791 }
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100792 /* If it isn't explicitly permitted, it's forbidden. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100793 return 0;
Gilles Peskined6f371b2019-05-10 19:33:38 +0200794}
795
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100796/** Test whether a policy permits an algorithm.
797 *
798 * The caller must test usage flags separately.
Steven Cooreman7e39f052021-02-23 14:18:32 +0100799 *
Steven Cooreman5a172672021-03-02 21:27:42 +0100800 * \note This function requires providing the key type for which the policy is
801 * being validated, since some algorithm policy definitions (e.g. MAC)
802 * have different properties depending on what kind of cipher it is
803 * combined with.
804 *
Steven Cooreman7e39f052021-02-23 14:18:32 +0100805 * \retval PSA_SUCCESS When \p alg is a specific algorithm
806 * allowed by the \p policy.
807 * \retval PSA_ERROR_INVALID_ARGUMENT When \p alg is not a specific algorithm
808 * \retval PSA_ERROR_NOT_PERMITTED When \p alg is a specific algorithm, but
809 * the \p policy does not allow it.
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100810 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100811static psa_status_t psa_key_policy_permits(const psa_key_policy_t *policy,
812 psa_key_type_t key_type,
813 psa_algorithm_t alg)
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100814{
Steven Cooremand788fab2021-02-25 11:29:17 +0100815 /* '0' is not a valid algorithm */
Gilles Peskine449bd832023-01-11 14:50:10 +0100816 if (alg == 0) {
817 return PSA_ERROR_INVALID_ARGUMENT;
818 }
Steven Cooremand788fab2021-02-25 11:29:17 +0100819
Steven Cooreman7e39f052021-02-23 14:18:32 +0100820 /* A requested algorithm cannot be a wildcard. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100821 if (PSA_ALG_IS_WILDCARD(alg)) {
822 return PSA_ERROR_INVALID_ARGUMENT;
823 }
Steven Cooreman7e39f052021-02-23 14:18:32 +0100824
Gilles Peskine449bd832023-01-11 14:50:10 +0100825 if (psa_key_algorithm_permits(key_type, policy->alg, alg) ||
826 psa_key_algorithm_permits(key_type, policy->alg2, alg)) {
827 return PSA_SUCCESS;
828 } else {
829 return PSA_ERROR_NOT_PERMITTED;
830 }
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100831}
832
Gilles Peskinef603c712019-01-19 13:40:11 +0100833/** Restrict a key policy based on a constraint.
834 *
Steven Cooreman5a172672021-03-02 21:27:42 +0100835 * \note This function requires providing the key type for which the policy is
836 * being restricted, since some algorithm policy definitions (e.g. MAC)
837 * have different properties depending on what kind of cipher it is
838 * combined with.
839 *
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100840 * \param[in] key_type The key type for which to restrict the policy
Gilles Peskinef603c712019-01-19 13:40:11 +0100841 * \param[in,out] policy The policy to restrict.
842 * \param[in] constraint The policy constraint to apply.
843 *
844 * \retval #PSA_SUCCESS
845 * \c *policy contains the intersection of the original value of
846 * \c *policy and \c *constraint.
847 * \retval #PSA_ERROR_INVALID_ARGUMENT
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100848 * \c key_type, \c *policy and \c *constraint are incompatible.
Gilles Peskinef603c712019-01-19 13:40:11 +0100849 * \c *policy is unchanged.
850 */
851static psa_status_t psa_restrict_key_policy(
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100852 psa_key_type_t key_type,
Gilles Peskinef603c712019-01-19 13:40:11 +0100853 psa_key_policy_t *policy,
Gilles Peskine449bd832023-01-11 14:50:10 +0100854 const psa_key_policy_t *constraint)
Gilles Peskinef603c712019-01-19 13:40:11 +0100855{
856 psa_algorithm_t intersection_alg =
Gilles Peskine449bd832023-01-11 14:50:10 +0100857 psa_key_policy_algorithm_intersection(key_type, policy->alg,
858 constraint->alg);
Gilles Peskined6f371b2019-05-10 19:33:38 +0200859 psa_algorithm_t intersection_alg2 =
Gilles Peskine449bd832023-01-11 14:50:10 +0100860 psa_key_policy_algorithm_intersection(key_type, policy->alg2,
861 constraint->alg2);
862 if (intersection_alg == 0 && policy->alg != 0 && constraint->alg != 0) {
863 return PSA_ERROR_INVALID_ARGUMENT;
864 }
865 if (intersection_alg2 == 0 && policy->alg2 != 0 && constraint->alg2 != 0) {
866 return PSA_ERROR_INVALID_ARGUMENT;
867 }
Gilles Peskinef603c712019-01-19 13:40:11 +0100868 policy->usage &= constraint->usage;
869 policy->alg = intersection_alg;
Gilles Peskined6f371b2019-05-10 19:33:38 +0200870 policy->alg2 = intersection_alg2;
Gilles Peskine449bd832023-01-11 14:50:10 +0100871 return PSA_SUCCESS;
Gilles Peskinef603c712019-01-19 13:40:11 +0100872}
873
Przemek Stekiel061f6942022-11-30 10:51:35 +0100874/** Get the description of a key given its identifier and policy constraints
875 * and lock it.
876 *
877 * The key must have allow all the usage flags set in \p usage. If \p alg is
878 * nonzero, the key must allow operations with this algorithm. If \p alg is
879 * zero, the algorithm is not checked.
880 *
881 * In case of a persistent key, the function loads the description of the key
882 * into a key slot if not already done.
883 *
884 * On success, the returned key slot is locked. It is the responsibility of
885 * the caller to unlock the key slot when it does not access it anymore.
886 */
887static psa_status_t psa_get_and_lock_key_slot_with_policy(
Ronald Cron5c522922020-11-14 16:35:34 +0100888 mbedtls_svc_key_id_t key,
889 psa_key_slot_t **p_slot,
890 psa_key_usage_t usage,
Gilles Peskine449bd832023-01-11 14:50:10 +0100891 psa_algorithm_t alg)
Darryl Green06fd18d2018-07-16 11:21:11 +0100892{
Ronald Cronf95a2b12020-10-22 15:24:49 +0200893 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel9a5b8122022-12-22 13:34:47 +0100894 psa_key_slot_t *slot = NULL;
Darryl Green06fd18d2018-07-16 11:21:11 +0100895
Gilles Peskine449bd832023-01-11 14:50:10 +0100896 status = psa_get_and_lock_key_slot(key, p_slot);
897 if (status != PSA_SUCCESS) {
898 return status;
899 }
Ronald Cronf95a2b12020-10-22 15:24:49 +0200900 slot = *p_slot;
Darryl Green06fd18d2018-07-16 11:21:11 +0100901
902 /* Enforce that usage policy for the key slot contains all the flags
903 * required by the usage parameter. There is one exception: public
904 * keys can always be exported, so we treat public key objects as
905 * if they had the export flag. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100906 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(slot->attr.type)) {
Darryl Green06fd18d2018-07-16 11:21:11 +0100907 usage &= ~PSA_KEY_USAGE_EXPORT;
Gilles Peskine449bd832023-01-11 14:50:10 +0100908 }
Ronald Cronf95a2b12020-10-22 15:24:49 +0200909
Gilles Peskine449bd832023-01-11 14:50:10 +0100910 if ((slot->attr.policy.usage & usage) != usage) {
Steven Cooreman328f11c2021-03-02 11:44:51 +0100911 status = PSA_ERROR_NOT_PERMITTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +0200912 goto error;
Steven Cooreman328f11c2021-03-02 11:44:51 +0100913 }
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100914
Shaun Case8b0ecbc2021-12-20 21:14:10 -0800915 /* Enforce that the usage policy permits the requested algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100916 if (alg != 0) {
917 status = psa_key_policy_permits(&slot->attr.policy,
918 slot->attr.type,
919 alg);
920 if (status != PSA_SUCCESS) {
Steven Cooreman7e39f052021-02-23 14:18:32 +0100921 goto error;
Gilles Peskine449bd832023-01-11 14:50:10 +0100922 }
Steven Cooreman7e39f052021-02-23 14:18:32 +0100923 }
Darryl Green06fd18d2018-07-16 11:21:11 +0100924
Gilles Peskine449bd832023-01-11 14:50:10 +0100925 return PSA_SUCCESS;
Ronald Cronf95a2b12020-10-22 15:24:49 +0200926
927error:
928 *p_slot = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +0100929 psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +0200930
Gilles Peskine449bd832023-01-11 14:50:10 +0100931 return status;
Darryl Green06fd18d2018-07-16 11:21:11 +0100932}
Darryl Green940d72c2018-07-13 13:18:51 +0100933
Ronald Cron5c522922020-11-14 16:35:34 +0100934/** Get a key slot containing a transparent key and lock it.
Gilles Peskine28f8f302019-07-24 13:30:31 +0200935 *
936 * A transparent key is a key for which the key material is directly
Ronald Cronddae0f52021-08-24 15:39:44 +0200937 * available, as opposed to a key in a secure element and/or to be used
938 * by a secure element.
Gilles Peskine28f8f302019-07-24 13:30:31 +0200939 *
Ronald Cronddae0f52021-08-24 15:39:44 +0200940 * This is a temporary function that may be used instead of
941 * psa_get_and_lock_key_slot_with_policy() when there is no opaque key support
942 * for a cryptographic operation.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200943 *
Ronald Cron5c522922020-11-14 16:35:34 +0100944 * On success, the returned key slot is locked. It is the responsibility of the
945 * caller to unlock the key slot when it does not access it anymore.
Gilles Peskine28f8f302019-07-24 13:30:31 +0200946 */
Ronald Cron5c522922020-11-14 16:35:34 +0100947static psa_status_t psa_get_and_lock_transparent_key_slot_with_policy(
948 mbedtls_svc_key_id_t key,
949 psa_key_slot_t **p_slot,
950 psa_key_usage_t usage,
Gilles Peskine449bd832023-01-11 14:50:10 +0100951 psa_algorithm_t alg)
Gilles Peskine28f8f302019-07-24 13:30:31 +0200952{
Gilles Peskine449bd832023-01-11 14:50:10 +0100953 psa_status_t status = psa_get_and_lock_key_slot_with_policy(key, p_slot,
954 usage, alg);
955 if (status != PSA_SUCCESS) {
956 return status;
Gilles Peskine28f8f302019-07-24 13:30:31 +0200957 }
Ronald Cronf95a2b12020-10-22 15:24:49 +0200958
Gilles Peskine449bd832023-01-11 14:50:10 +0100959 if (psa_key_lifetime_is_external((*p_slot)->attr.lifetime)) {
960 psa_unlock_key_slot(*p_slot);
961 *p_slot = NULL;
962 return PSA_ERROR_NOT_SUPPORTED;
963 }
964
965 return PSA_SUCCESS;
Gilles Peskine28f8f302019-07-24 13:30:31 +0200966}
Gilles Peskine28f8f302019-07-24 13:30:31 +0200967
Gilles Peskine449bd832023-01-11 14:50:10 +0100968psa_status_t psa_remove_key_data_from_memory(psa_key_slot_t *slot)
Darryl Green40225ba2018-11-15 14:48:15 +0000969{
Gilles Peskine449bd832023-01-11 14:50:10 +0100970 if (slot->key.data != NULL) {
Tom Cosgrove52f7e182023-08-01 09:08:48 +0100971 mbedtls_zeroize_and_free(slot->key.data, slot->key.bytes);
Gilles Peskine449bd832023-01-11 14:50:10 +0100972 }
Ronald Cronea0f8a62020-11-25 17:52:23 +0100973
Ronald Cronea0f8a62020-11-25 17:52:23 +0100974 slot->key.data = NULL;
975 slot->key.bytes = 0;
Darryl Green40225ba2018-11-15 14:48:15 +0000976
Gilles Peskine449bd832023-01-11 14:50:10 +0100977 return PSA_SUCCESS;
Darryl Green40225ba2018-11-15 14:48:15 +0000978}
979
Gilles Peskinef77ed1f2018-12-03 11:58:46 +0100980/** Completely wipe a slot in memory, including its policy.
981 * Persistent storage is not affected. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100982psa_status_t psa_wipe_key_slot(psa_key_slot_t *slot)
Gilles Peskinef77ed1f2018-12-03 11:58:46 +0100983{
Ryan Everettaa33c512023-12-21 17:32:07 +0000984 if (slot->state != PSA_SLOT_PENDING_DELETION) {
985 return PSA_ERROR_BAD_STATE;
986 }
987
Gilles Peskine449bd832023-01-11 14:50:10 +0100988 psa_status_t status = psa_remove_key_data_from_memory(slot);
Ronald Cronddd3d052020-10-30 14:07:07 +0100989
Gilles Peskine449bd832023-01-11 14:50:10 +0100990 /*
991 * As the return error code may not be handled in case of multiple errors,
Ryan Everettaa33c512023-12-21 17:32:07 +0000992 * do our best to report an unexpected amount of registered readers.
993 * Assert with MBEDTLS_TEST_HOOK_TEST_ASSERT that registered_readers is
994 * equal to one:
Gilles Peskine449bd832023-01-11 14:50:10 +0100995 * if the MBEDTLS_TEST_HOOKS configuration option is enabled and the
996 * function is called as part of the execution of a test suite, the
997 * execution of the test suite is stopped in error if the assertion fails.
998 */
Ryan Everettaa33c512023-12-21 17:32:07 +0000999 if (slot->registered_readers != 1) {
1000 MBEDTLS_TEST_HOOK_TEST_ASSERT(slot->registered_readers == 1);
Ronald Cronddd3d052020-10-30 14:07:07 +01001001 status = PSA_ERROR_CORRUPTION_DETECTED;
1002 }
1003
Gilles Peskine3f7cd622019-08-13 15:01:08 +02001004 /* Multipart operations may still be using the key. This is safe
1005 * because all multipart operation objects are independent from
1006 * the key slot: if they need to access the key after the setup
1007 * phase, they have a copy of the key. Note that this means that
1008 * key material can linger until all operations are completed. */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001009 /* At this point, key material and other type-specific content has
1010 * been wiped. Clear remaining metadata. We can call memset and not
Ryan Everettaa33c512023-12-21 17:32:07 +00001011 * zeroize because the metadata is not particularly sensitive.
1012 * This memset also sets the slot's state to PSA_SLOT_EMPTY. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001013 memset(slot, 0, sizeof(*slot));
1014 return status;
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001015}
1016
Gilles Peskine449bd832023-01-11 14:50:10 +01001017psa_status_t psa_destroy_key(mbedtls_svc_key_id_t key)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001018{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001019 psa_key_slot_t *slot;
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001020 psa_status_t status; /* status of the last operation */
1021 psa_status_t overall_status = PSA_SUCCESS;
Gilles Peskine354f7672019-07-12 23:46:38 +02001022#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1023 psa_se_drv_table_entry_t *driver;
1024#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001025
Gilles Peskine449bd832023-01-11 14:50:10 +01001026 if (mbedtls_svc_key_id_is_null(key)) {
1027 return PSA_SUCCESS;
1028 }
Gilles Peskine1841cf42019-10-08 15:48:25 +02001029
Ronald Cronf2911112020-10-29 17:51:10 +01001030 /*
Ronald Cron19daca92020-11-10 18:08:03 +01001031 * Get the description of the key in a key slot. In case of a persistent
Ronald Cronf2911112020-10-29 17:51:10 +01001032 * key, this will load the key description from persistent memory if not
1033 * done yet. We cannot avoid this loading as without it we don't know if
1034 * the key is operated by an SE or not and this information is needed by
1035 * the current implementation.
1036 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001037 status = psa_get_and_lock_key_slot(key, &slot);
1038 if (status != PSA_SUCCESS) {
1039 return status;
1040 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001041
Ronald Cronf2911112020-10-29 17:51:10 +01001042 /*
1043 * If the key slot containing the key description is under access by the
1044 * library (apart from the present access), the key cannot be destroyed
1045 * yet. For the time being, just return in error. Eventually (to be
1046 * implemented), the key should be destroyed when all accesses have
1047 * stopped.
1048 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001049 if (slot->lock_count > 1) {
1050 psa_unlock_key_slot(slot);
1051 return PSA_ERROR_GENERIC_ERROR;
Ronald Cronf2911112020-10-29 17:51:10 +01001052 }
1053
Gilles Peskine449bd832023-01-11 14:50:10 +01001054 if (PSA_KEY_LIFETIME_IS_READ_ONLY(slot->attr.lifetime)) {
Gilles Peskine6687cd02021-04-21 22:32:05 +02001055 /* Refuse the destruction of a read-only key (which may or may not work
1056 * if we attempt it, depending on whether the key is merely read-only
1057 * by policy or actually physically read-only).
Gilles Peskinef9a046e2021-06-07 23:27:54 +02001058 * Just do the best we can, which is to wipe the copy in memory
1059 * (done in this function's cleanup code). */
1060 overall_status = PSA_ERROR_NOT_PERMITTED;
1061 goto exit;
Gilles Peskine6687cd02021-04-21 22:32:05 +02001062 }
1063
Gilles Peskine354f7672019-07-12 23:46:38 +02001064#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001065 driver = psa_get_se_driver_entry(slot->attr.lifetime);
1066 if (driver != NULL) {
Gilles Peskine60450a42019-07-25 11:32:45 +02001067 /* For a key in a secure element, we need to do three things:
1068 * remove the key file in internal storage, destroy the
1069 * key inside the secure element, and update the driver's
1070 * persistent data. Start a transaction that will encompass these
1071 * three actions. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001072 psa_crypto_prepare_transaction(PSA_CRYPTO_TRANSACTION_DESTROY_KEY);
Gilles Peskine8e338702019-07-30 20:06:31 +02001073 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Gilles Peskine449bd832023-01-11 14:50:10 +01001074 psa_crypto_transaction.key.slot = psa_key_slot_get_slot_number(slot);
Gilles Peskine8e338702019-07-30 20:06:31 +02001075 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskine449bd832023-01-11 14:50:10 +01001076 status = psa_crypto_save_transaction();
1077 if (status != PSA_SUCCESS) {
1078 (void) psa_crypto_stop_transaction();
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001079 /* We should still try to destroy the key in the secure
1080 * element and the key metadata in storage. This is especially
1081 * important if the error is that the storage is full.
1082 * But how to do it exactly without risking an inconsistent
1083 * state after a reset?
1084 * https://github.com/ARMmbed/mbed-crypto/issues/215
1085 */
1086 overall_status = status;
1087 goto exit;
Gilles Peskinefc762652019-07-22 19:30:34 +02001088 }
1089
Gilles Peskine449bd832023-01-11 14:50:10 +01001090 status = psa_destroy_se_key(driver,
1091 psa_key_slot_get_slot_number(slot));
1092 if (overall_status == PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001093 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001094 }
Gilles Peskinefc762652019-07-22 19:30:34 +02001095 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001096#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1097
Darryl Greend49a4992018-06-18 17:27:26 +01001098#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001099 if (!PSA_KEY_LIFETIME_IS_VOLATILE(slot->attr.lifetime)) {
1100 status = psa_destroy_persistent_key(slot->attr.id);
1101 if (overall_status == PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001102 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001103 }
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001104
Gilles Peskine9ce31c42019-08-13 15:14:20 +02001105 /* TODO: other slots may have a copy of the same key. We should
1106 * invalidate them.
1107 * https://github.com/ARMmbed/mbed-crypto/issues/214
1108 */
Darryl Greend49a4992018-06-18 17:27:26 +01001109 }
1110#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
Gilles Peskine354f7672019-07-12 23:46:38 +02001111
Gilles Peskinefc762652019-07-22 19:30:34 +02001112#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001113 if (driver != NULL) {
1114 status = psa_save_se_persistent_data(driver);
1115 if (overall_status == PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001116 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001117 }
1118 status = psa_crypto_stop_transaction();
1119 if (overall_status == PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001120 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001121 }
Gilles Peskinefc762652019-07-22 19:30:34 +02001122 }
1123#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1124
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001125exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01001126 status = psa_wipe_key_slot(slot);
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001127 /* Prioritize CORRUPTION_DETECTED from wiping over a storage error */
Gilles Peskine449bd832023-01-11 14:50:10 +01001128 if (status != PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001129 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001130 }
1131 return overall_status;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001132}
1133
Valerio Settib2bcedb2023-07-10 11:24:00 +02001134#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT) || \
John Durkop0e005192020-10-31 22:06:54 -07001135 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskineb699f072019-04-26 16:06:02 +02001136static psa_status_t psa_get_rsa_public_exponent(
1137 const mbedtls_rsa_context *rsa,
Gilles Peskine449bd832023-01-11 14:50:10 +01001138 psa_key_attributes_t *attributes)
Gilles Peskineb699f072019-04-26 16:06:02 +02001139{
1140 mbedtls_mpi mpi;
Janos Follath24eed8d2019-11-22 13:21:35 +00001141 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb699f072019-04-26 16:06:02 +02001142 uint8_t *buffer = NULL;
1143 size_t buflen;
Gilles Peskine449bd832023-01-11 14:50:10 +01001144 mbedtls_mpi_init(&mpi);
Gilles Peskineb699f072019-04-26 16:06:02 +02001145
Gilles Peskine449bd832023-01-11 14:50:10 +01001146 ret = mbedtls_rsa_export(rsa, NULL, NULL, NULL, NULL, &mpi);
1147 if (ret != 0) {
Gilles Peskineb699f072019-04-26 16:06:02 +02001148 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001149 }
1150 if (mbedtls_mpi_cmp_int(&mpi, 65537) == 0) {
Gilles Peskine772c8b12019-04-26 17:37:21 +02001151 /* It's the default value, which is reported as an empty string,
1152 * so there's nothing to do. */
1153 goto exit;
1154 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001155
Gilles Peskine449bd832023-01-11 14:50:10 +01001156 buflen = mbedtls_mpi_size(&mpi);
1157 buffer = mbedtls_calloc(1, buflen);
1158 if (buffer == NULL) {
Gilles Peskineb699f072019-04-26 16:06:02 +02001159 ret = MBEDTLS_ERR_MPI_ALLOC_FAILED;
1160 goto exit;
1161 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001162 ret = mbedtls_mpi_write_binary(&mpi, buffer, buflen);
1163 if (ret != 0) {
Gilles Peskineb699f072019-04-26 16:06:02 +02001164 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001165 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001166 attributes->domain_parameters = buffer;
1167 attributes->domain_parameters_size = buflen;
1168
1169exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01001170 mbedtls_mpi_free(&mpi);
1171 if (ret != 0) {
1172 mbedtls_free(buffer);
1173 }
1174 return mbedtls_to_psa_error(ret);
Gilles Peskineb699f072019-04-26 16:06:02 +02001175}
Valerio Settib2bcedb2023-07-10 11:24:00 +02001176#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT) ||
John Durkop9814fa22020-11-04 12:28:15 -08001177 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001178
Gilles Peskinebfd322f2019-07-23 11:58:03 +02001179/** Retrieve all the publicly-accessible attributes of a key.
1180 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001181psa_status_t psa_get_key_attributes(mbedtls_svc_key_id_t key,
1182 psa_key_attributes_t *attributes)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001183{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001184 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001185 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001186 psa_key_slot_t *slot;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001187
Gilles Peskine449bd832023-01-11 14:50:10 +01001188 psa_reset_key_attributes(attributes);
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001189
Gilles Peskine449bd832023-01-11 14:50:10 +01001190 status = psa_get_and_lock_key_slot_with_policy(key, &slot, 0, 0);
1191 if (status != PSA_SUCCESS) {
1192 return status;
1193 }
Gilles Peskineb870b182018-07-06 16:02:09 +02001194
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001195 attributes->core = slot->attr;
Gilles Peskine449bd832023-01-11 14:50:10 +01001196 attributes->core.flags &= (MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1197 MBEDTLS_PSA_KA_MASK_DUAL_USE);
Gilles Peskinec8000c02019-08-02 20:15:51 +02001198
1199#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001200 if (psa_get_se_driver_entry(slot->attr.lifetime) != NULL) {
1201 psa_set_key_slot_number(attributes,
1202 psa_key_slot_get_slot_number(slot));
1203 }
Gilles Peskinec8000c02019-08-02 20:15:51 +02001204#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineb699f072019-04-26 16:06:02 +02001205
Gilles Peskine449bd832023-01-11 14:50:10 +01001206 switch (slot->attr.type) {
Valerio Settib2bcedb2023-07-10 11:24:00 +02001207#if (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) && \
1208 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) || \
John Durkop0e005192020-10-31 22:06:54 -07001209 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02001210 case PSA_KEY_TYPE_RSA_KEY_PAIR:
Gilles Peskineb699f072019-04-26 16:06:02 +02001211 case PSA_KEY_TYPE_RSA_PUBLIC_KEY:
Pengyu Lvf75893b2023-12-08 17:21:39 +08001212 /* TODO: This is a temporary situation where domain parameters are deprecated,
1213 * but we need it for namely generating an RSA key with a non-default exponent.
1214 * This would be improved after https://github.com/Mbed-TLS/mbedtls/issues/6494.
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001215 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001216 if (!psa_key_lifetime_is_external(slot->attr.lifetime)) {
Steven Cooremana2371e52020-07-28 14:30:39 +02001217 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02001218
Ronald Cron90857082020-11-25 14:58:33 +01001219 status = mbedtls_psa_rsa_load_representation(
Gilles Peskine449bd832023-01-11 14:50:10 +01001220 slot->attr.type,
1221 slot->key.data,
1222 slot->key.bytes,
1223 &rsa);
1224 if (status != PSA_SUCCESS) {
Steven Cooremana01795d2020-07-24 22:48:15 +02001225 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01001226 }
Steven Cooremana01795d2020-07-24 22:48:15 +02001227
Gilles Peskine449bd832023-01-11 14:50:10 +01001228 status = psa_get_rsa_public_exponent(rsa,
1229 attributes);
1230 mbedtls_rsa_free(rsa);
1231 mbedtls_free(rsa);
Steven Cooremana01795d2020-07-24 22:48:15 +02001232 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001233 break;
Pengyu Lve9efbc22023-12-08 16:59:08 +08001234#else
1235 case PSA_KEY_TYPE_RSA_KEY_PAIR:
1236 case PSA_KEY_TYPE_RSA_PUBLIC_KEY:
1237 attributes->domain_parameters = NULL;
1238 attributes->domain_parameters_size = SIZE_MAX;
1239 break;
Valerio Settib2bcedb2023-07-10 11:24:00 +02001240#endif /* (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) && \
1241 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) ||
John Durkop9814fa22020-11-04 12:28:15 -08001242 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001243 default:
1244 /* Nothing else to do. */
1245 break;
1246 }
1247
Gilles Peskine449bd832023-01-11 14:50:10 +01001248 if (status != PSA_SUCCESS) {
1249 psa_reset_key_attributes(attributes);
1250 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001251
Gilles Peskine449bd832023-01-11 14:50:10 +01001252 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02001253
Gilles Peskine449bd832023-01-11 14:50:10 +01001254 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001255}
1256
Gilles Peskinec8000c02019-08-02 20:15:51 +02001257#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1258psa_status_t psa_get_key_slot_number(
1259 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01001260 psa_key_slot_number_t *slot_number)
Gilles Peskinec8000c02019-08-02 20:15:51 +02001261{
Gilles Peskine449bd832023-01-11 14:50:10 +01001262 if (attributes->core.flags & MBEDTLS_PSA_KA_FLAG_HAS_SLOT_NUMBER) {
Gilles Peskinec8000c02019-08-02 20:15:51 +02001263 *slot_number = attributes->slot_number;
Gilles Peskine449bd832023-01-11 14:50:10 +01001264 return PSA_SUCCESS;
1265 } else {
1266 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinec8000c02019-08-02 20:15:51 +02001267 }
Gilles Peskinec8000c02019-08-02 20:15:51 +02001268}
1269#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1270
Gilles Peskine449bd832023-01-11 14:50:10 +01001271static psa_status_t psa_export_key_buffer_internal(const uint8_t *key_buffer,
1272 size_t key_buffer_size,
1273 uint8_t *data,
1274 size_t data_size,
1275 size_t *data_length)
Steven Cooremana01795d2020-07-24 22:48:15 +02001276{
Gilles Peskine449bd832023-01-11 14:50:10 +01001277 if (key_buffer_size > data_size) {
1278 return PSA_ERROR_BUFFER_TOO_SMALL;
1279 }
1280 memcpy(data, key_buffer, key_buffer_size);
1281 memset(data + key_buffer_size, 0,
1282 data_size - key_buffer_size);
Ronald Crond18b5f82020-11-25 16:46:05 +01001283 *data_length = key_buffer_size;
Gilles Peskine449bd832023-01-11 14:50:10 +01001284 return PSA_SUCCESS;
Steven Cooremana01795d2020-07-24 22:48:15 +02001285}
1286
Ronald Cron7285cda2020-11-26 14:46:37 +01001287psa_status_t psa_export_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001288 const psa_key_attributes_t *attributes,
1289 const uint8_t *key_buffer, size_t key_buffer_size,
Gilles Peskine449bd832023-01-11 14:50:10 +01001290 uint8_t *data, size_t data_size, size_t *data_length)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001291{
Ronald Crond18b5f82020-11-25 16:46:05 +01001292 psa_key_type_t type = attributes->core.type;
1293
Gilles Peskine449bd832023-01-11 14:50:10 +01001294 if (key_type_is_raw_bytes(type) ||
1295 PSA_KEY_TYPE_IS_RSA(type) ||
Przemek Stekiel472b3f32022-12-01 14:38:49 +01001296 PSA_KEY_TYPE_IS_ECC(type) ||
1297 PSA_KEY_TYPE_IS_DH(type)) {
Gilles Peskine449bd832023-01-11 14:50:10 +01001298 return psa_export_key_buffer_internal(
1299 key_buffer, key_buffer_size,
1300 data, data_size, data_length);
1301 } else {
Ronald Cron9486f9d2020-11-26 13:36:23 +01001302 /* This shouldn't happen in the reference implementation, but
1303 it is valid for a special-purpose implementation to omit
1304 support for exporting certain key types. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001305 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron9486f9d2020-11-26 13:36:23 +01001306 }
1307}
1308
Gilles Peskine449bd832023-01-11 14:50:10 +01001309psa_status_t psa_export_key(mbedtls_svc_key_id_t key,
1310 uint8_t *data,
1311 size_t data_size,
1312 size_t *data_length)
Ronald Cron9486f9d2020-11-26 13:36:23 +01001313{
1314 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
1315 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
1316 psa_key_slot_t *slot;
1317
Ronald Crone907e552021-01-18 13:22:38 +01001318 /* Reject a zero-length output buffer now, since this can never be a
1319 * valid key representation. This way we know that data must be a valid
1320 * pointer and we can do things like memset(data, ..., data_size). */
Gilles Peskine449bd832023-01-11 14:50:10 +01001321 if (data_size == 0) {
1322 return PSA_ERROR_BUFFER_TOO_SMALL;
1323 }
Ronald Crone907e552021-01-18 13:22:38 +01001324
Ronald Cron9486f9d2020-11-26 13:36:23 +01001325 /* Set the key to empty now, so that even when there are errors, we always
1326 * set data_length to a value between 0 and data_size. On error, setting
1327 * the key to empty is a good choice because an empty key representation is
1328 * unlikely to be accepted anywhere. */
Jaeden Amerof24c7f82018-06-27 17:20:43 +01001329 *data_length = 0;
1330
Ronald Cron9486f9d2020-11-26 13:36:23 +01001331 /* Export requires the EXPORT flag. There is an exception for public keys,
1332 * which don't require any flag, but
1333 * psa_get_and_lock_key_slot_with_policy() takes care of this.
1334 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001335 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
1336 PSA_KEY_USAGE_EXPORT, 0);
1337 if (status != PSA_SUCCESS) {
1338 return status;
1339 }
mohammad160306e79202018-03-28 13:17:44 +03001340
Ronald Crond18b5f82020-11-25 16:46:05 +01001341 psa_key_attributes_t attributes = {
1342 .core = slot->attr
1343 };
Gilles Peskine449bd832023-01-11 14:50:10 +01001344 status = psa_driver_wrapper_export_key(&attributes,
1345 slot->key.data, slot->key.bytes,
1346 data, data_size, data_length);
Ronald Cron9486f9d2020-11-26 13:36:23 +01001347
Gilles Peskine449bd832023-01-11 14:50:10 +01001348 unlock_status = psa_unlock_key_slot(slot);
Ronald Cron9486f9d2020-11-26 13:36:23 +01001349
Gilles Peskine449bd832023-01-11 14:50:10 +01001350 return (status == PSA_SUCCESS) ? unlock_status : status;
Ronald Cron9486f9d2020-11-26 13:36:23 +01001351}
1352
Ronald Cron7285cda2020-11-26 14:46:37 +01001353psa_status_t psa_export_public_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001354 const psa_key_attributes_t *attributes,
1355 const uint8_t *key_buffer,
1356 size_t key_buffer_size,
1357 uint8_t *data,
1358 size_t data_size,
Gilles Peskine449bd832023-01-11 14:50:10 +01001359 size_t *data_length)
Ronald Cron9486f9d2020-11-26 13:36:23 +01001360{
Ronald Crond18b5f82020-11-25 16:46:05 +01001361 psa_key_type_t type = attributes->core.type;
Ronald Crond18b5f82020-11-25 16:46:05 +01001362
Przemek Stekiel6fd72b62023-04-27 10:20:56 +02001363 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(type) &&
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001364 (PSA_KEY_TYPE_IS_RSA(type) || PSA_KEY_TYPE_IS_ECC(type) ||
1365 PSA_KEY_TYPE_IS_DH(type))) {
Przemek Stekiel6fd72b62023-04-27 10:20:56 +02001366 /* Exporting public -> public */
1367 return psa_export_key_buffer_internal(
1368 key_buffer, key_buffer_size,
1369 data, data_size, data_length);
1370 } else if (PSA_KEY_TYPE_IS_RSA(type)) {
Valerio Settib2bcedb2023-07-10 11:24:00 +02001371#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT) || \
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001372 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
1373 return mbedtls_psa_rsa_export_public_key(attributes,
1374 key_buffer,
1375 key_buffer_size,
1376 data,
1377 data_size,
1378 data_length);
Darryl Green9e2d7a02018-07-24 16:33:30 +01001379#else
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001380 /* We don't know how to convert a private RSA key to public. */
1381 return PSA_ERROR_NOT_SUPPORTED;
Valerio Settib2bcedb2023-07-10 11:24:00 +02001382#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT) ||
John Durkop9814fa22020-11-04 12:28:15 -08001383 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Przemek Stekiel6fd72b62023-04-27 10:20:56 +02001384 } else if (PSA_KEY_TYPE_IS_ECC(type)) {
Valerio Setti27c501a2023-06-27 16:58:52 +02001385#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_EXPORT) || \
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001386 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
1387 return mbedtls_psa_ecp_export_public_key(attributes,
1388 key_buffer,
1389 key_buffer_size,
1390 data,
1391 data_size,
1392 data_length);
Steven Cooreman560c28a2020-07-24 23:20:24 +02001393#else
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001394 /* We don't know how to convert a private ECC key to public */
1395 return PSA_ERROR_NOT_SUPPORTED;
Valerio Setti27c501a2023-06-27 16:58:52 +02001396#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_EXPORT) ||
John Durkop9814fa22020-11-04 12:28:15 -08001397 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
Przemek Stekiel6fd72b62023-04-27 10:20:56 +02001398 } else if (PSA_KEY_TYPE_IS_DH(type)) {
Valerio Settia55f0422023-07-10 15:34:41 +02001399#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_EXPORT) || \
Przemek Stekiel6d85afa2023-04-28 11:42:17 +02001400 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY)
Przemek Stekiel152bb462023-06-01 11:52:39 +02001401 return mbedtls_psa_ffdh_export_public_key(attributes,
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001402 key_buffer,
1403 key_buffer_size,
1404 data, data_size,
1405 data_length);
Przemek Stekiel472b3f32022-12-01 14:38:49 +01001406#else
Przemek Stekiel472b3f32022-12-01 14:38:49 +01001407 return PSA_ERROR_NOT_SUPPORTED;
Valerio Settia55f0422023-07-10 15:34:41 +02001408#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_EXPORT) ||
Przemek Stekiel6d85afa2023-04-28 11:42:17 +02001409 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY) */
Gilles Peskine449bd832023-01-11 14:50:10 +01001410 } else {
Przemek Stekiel0b11ee02023-05-16 13:26:06 +02001411 (void) key_buffer;
1412 (void) key_buffer_size;
1413 (void) data;
1414 (void) data_size;
1415 (void) data_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01001416 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman560c28a2020-07-24 23:20:24 +02001417 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001418}
Ronald Crond18b5f82020-11-25 16:46:05 +01001419
Gilles Peskine449bd832023-01-11 14:50:10 +01001420psa_status_t psa_export_public_key(mbedtls_svc_key_id_t key,
1421 uint8_t *data,
1422 size_t data_size,
1423 size_t *data_length)
Moran Pekerdd4ea382018-04-03 15:30:03 +03001424{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001425 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001426 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001427 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01001428 psa_key_attributes_t attributes;
Darryl Greendd8fb772018-11-07 16:00:44 +00001429
Ronald Crone907e552021-01-18 13:22:38 +01001430 /* Reject a zero-length output buffer now, since this can never be a
1431 * valid key representation. This way we know that data must be a valid
1432 * pointer and we can do things like memset(data, ..., data_size). */
Gilles Peskine449bd832023-01-11 14:50:10 +01001433 if (data_size == 0) {
1434 return PSA_ERROR_BUFFER_TOO_SMALL;
1435 }
Ronald Crone907e552021-01-18 13:22:38 +01001436
Darryl Greendd8fb772018-11-07 16:00:44 +00001437 /* Set the key to empty now, so that even when there are errors, we always
1438 * set data_length to a value between 0 and data_size. On error, setting
1439 * the key to empty is a good choice because an empty key representation is
1440 * unlikely to be accepted anywhere. */
1441 *data_length = 0;
1442
1443 /* Exporting a public key doesn't require a usage flag. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001444 status = psa_get_and_lock_key_slot_with_policy(key, &slot, 0, 0);
1445 if (status != PSA_SUCCESS) {
1446 return status;
1447 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001448
Gilles Peskine449bd832023-01-11 14:50:10 +01001449 if (!PSA_KEY_TYPE_IS_ASYMMETRIC(slot->attr.type)) {
1450 status = PSA_ERROR_INVALID_ARGUMENT;
1451 goto exit;
Ronald Cron9486f9d2020-11-26 13:36:23 +01001452 }
1453
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01001454 attributes = (psa_key_attributes_t) {
Ronald Crond18b5f82020-11-25 16:46:05 +01001455 .core = slot->attr
1456 };
Ronald Cron67227982020-11-26 15:16:05 +01001457 status = psa_driver_wrapper_export_public_key(
Ronald Crond18b5f82020-11-25 16:46:05 +01001458 &attributes, slot->key.data, slot->key.bytes,
Gilles Peskine449bd832023-01-11 14:50:10 +01001459 data, data_size, data_length);
Ronald Cron9486f9d2020-11-26 13:36:23 +01001460
1461exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01001462 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02001463
Gilles Peskine449bd832023-01-11 14:50:10 +01001464 return (status == PSA_SUCCESS) ? unlock_status : status;
Moran Pekerdd4ea382018-04-03 15:30:03 +03001465}
1466
Tom Cosgrove6ef9bb32023-03-08 14:19:51 +00001467MBEDTLS_STATIC_ASSERT(
1468 (MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE) == 0,
1469 "One or more key attribute flag is listed as both external-only and dual-use")
1470MBEDTLS_STATIC_ASSERT(
1471 (PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE) == 0,
1472 "One or more key attribute flag is listed as both internal-only and dual-use")
1473MBEDTLS_STATIC_ASSERT(
1474 (PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY) == 0,
1475 "One or more key attribute flag is listed as both internal-only and external-only")
Gilles Peskine91e8c332019-08-02 19:19:39 +02001476
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001477/** Validate that a key policy is internally well-formed.
1478 *
1479 * This function only rejects invalid policies. It does not validate the
1480 * consistency of the policy with respect to other attributes of the key
1481 * such as the key type.
1482 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001483static psa_status_t psa_validate_key_policy(const psa_key_policy_t *policy)
Gilles Peskine4747d192019-04-17 15:05:45 +02001484{
Gilles Peskine449bd832023-01-11 14:50:10 +01001485 if ((policy->usage & ~(PSA_KEY_USAGE_EXPORT |
1486 PSA_KEY_USAGE_COPY |
1487 PSA_KEY_USAGE_ENCRYPT |
1488 PSA_KEY_USAGE_DECRYPT |
1489 PSA_KEY_USAGE_SIGN_MESSAGE |
1490 PSA_KEY_USAGE_VERIFY_MESSAGE |
1491 PSA_KEY_USAGE_SIGN_HASH |
1492 PSA_KEY_USAGE_VERIFY_HASH |
1493 PSA_KEY_USAGE_VERIFY_DERIVATION |
1494 PSA_KEY_USAGE_DERIVE)) != 0) {
1495 return PSA_ERROR_INVALID_ARGUMENT;
1496 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001497
Gilles Peskine449bd832023-01-11 14:50:10 +01001498 return PSA_SUCCESS;
Gilles Peskine4747d192019-04-17 15:05:45 +02001499}
1500
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001501/** Validate the internal consistency of key attributes.
1502 *
1503 * This function only rejects invalid attribute values. If does not
1504 * validate the consistency of the attributes with any key data that may
1505 * be involved in the creation of the key.
1506 *
1507 * Call this function early in the key creation process.
1508 *
1509 * \param[in] attributes Key attributes for the new key.
1510 * \param[out] p_drv On any return, the driver for the key, if any.
1511 * NULL for a transparent key.
1512 *
1513 */
1514static psa_status_t psa_validate_key_attributes(
1515 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01001516 psa_se_drv_table_entry_t **p_drv)
Darryl Green0c6575a2018-11-07 16:05:30 +00001517{
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001518 psa_status_t status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine449bd832023-01-11 14:50:10 +01001519 psa_key_lifetime_t lifetime = psa_get_key_lifetime(attributes);
1520 mbedtls_svc_key_id_t key = psa_get_key_id(attributes);
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001521
Gilles Peskine449bd832023-01-11 14:50:10 +01001522 status = psa_validate_key_location(lifetime, p_drv);
1523 if (status != PSA_SUCCESS) {
1524 return status;
Ronald Crond2ed4812020-07-17 16:11:30 +02001525 }
1526
Gilles Peskine449bd832023-01-11 14:50:10 +01001527 status = psa_validate_key_persistence(lifetime);
1528 if (status != PSA_SUCCESS) {
1529 return status;
1530 }
1531
1532 if (PSA_KEY_LIFETIME_IS_VOLATILE(lifetime)) {
1533 if (MBEDTLS_SVC_KEY_ID_GET_KEY_ID(key) != 0) {
1534 return PSA_ERROR_INVALID_ARGUMENT;
1535 }
1536 } else {
1537 if (!psa_is_valid_key_id(psa_get_key_id(attributes), 0)) {
1538 return PSA_ERROR_INVALID_ARGUMENT;
1539 }
1540 }
1541
1542 status = psa_validate_key_policy(&attributes->core.policy);
1543 if (status != PSA_SUCCESS) {
1544 return status;
1545 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001546
1547 /* Refuse to create overly large keys.
1548 * Note that this doesn't trigger on import if the attributes don't
1549 * explicitly specify a size (so psa_get_key_bits returns 0), so
1550 * psa_import_key() needs its own checks. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001551 if (psa_get_key_bits(attributes) > PSA_MAX_KEY_BITS) {
1552 return PSA_ERROR_NOT_SUPPORTED;
1553 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001554
Gilles Peskine91e8c332019-08-02 19:19:39 +02001555 /* Reject invalid flags. These should not be reachable through the API. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001556 if (attributes->core.flags & ~(MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1557 MBEDTLS_PSA_KA_MASK_DUAL_USE)) {
1558 return PSA_ERROR_INVALID_ARGUMENT;
1559 }
Gilles Peskine91e8c332019-08-02 19:19:39 +02001560
Gilles Peskine449bd832023-01-11 14:50:10 +01001561 return PSA_SUCCESS;
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001562}
1563
Gilles Peskine4747d192019-04-17 15:05:45 +02001564/** Prepare a key slot to receive key material.
1565 *
1566 * This function allocates a key slot and sets its metadata.
1567 *
1568 * If this function fails, call psa_fail_key_creation().
1569 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001570 * This function is intended to be used as follows:
1571 * -# Call psa_start_key_creation() to allocate a key slot, prepare
Ronald Croncf56a0a2020-08-04 09:51:30 +02001572 * it with the specified attributes, and in case of a volatile key assign it
1573 * a volatile key identifier.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001574 * -# Populate the slot with the key material.
1575 * -# Call psa_finish_key_creation() to finalize the creation of the slot.
1576 * In case of failure at any step, stop the sequence and call
1577 * psa_fail_key_creation().
1578 *
Ronald Cron5c522922020-11-14 16:35:34 +01001579 * On success, the key slot is locked. It is the responsibility of the caller
1580 * to unlock the key slot when it does not access it anymore.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001581 *
Gilles Peskinedf179142019-07-15 22:02:14 +02001582 * \param method An identification of the calling function.
Gilles Peskine011e4282019-06-26 18:34:38 +02001583 * \param[in] attributes Key attributes for the new key.
Gilles Peskine011e4282019-06-26 18:34:38 +02001584 * \param[out] p_slot On success, a pointer to the prepared slot.
1585 * \param[out] p_drv On any return, the driver for the key, if any.
1586 * NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001587 *
1588 * \retval #PSA_SUCCESS
1589 * The key slot is ready to receive key material.
1590 * \return If this function fails, the key slot is an invalid state.
1591 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001592 */
1593static psa_status_t psa_start_key_creation(
Gilles Peskinedf179142019-07-15 22:02:14 +02001594 psa_key_creation_method_t method,
Gilles Peskine4747d192019-04-17 15:05:45 +02001595 const psa_key_attributes_t *attributes,
Gilles Peskine011e4282019-06-26 18:34:38 +02001596 psa_key_slot_t **p_slot,
Gilles Peskine449bd832023-01-11 14:50:10 +01001597 psa_se_drv_table_entry_t **p_drv)
Gilles Peskine4747d192019-04-17 15:05:45 +02001598{
1599 psa_status_t status;
Ronald Cron2a993152020-07-17 14:13:26 +02001600 psa_key_id_t volatile_key_id;
Gilles Peskine4747d192019-04-17 15:05:45 +02001601 psa_key_slot_t *slot;
1602
Gilles Peskinedf179142019-07-15 22:02:14 +02001603 (void) method;
Gilles Peskine011e4282019-06-26 18:34:38 +02001604 *p_drv = NULL;
1605
Gilles Peskine449bd832023-01-11 14:50:10 +01001606 status = psa_validate_key_attributes(attributes, p_drv);
1607 if (status != PSA_SUCCESS) {
1608 return status;
1609 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001610
Gilles Peskine449bd832023-01-11 14:50:10 +01001611 status = psa_get_empty_key_slot(&volatile_key_id, p_slot);
1612 if (status != PSA_SUCCESS) {
1613 return status;
1614 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001615 slot = *p_slot;
1616
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001617 /* We're storing the declared bit-size of the key. It's up to each
1618 * creation mechanism to verify that this information is correct.
1619 * It's automatically correct for mechanisms that use the bit-size as
Gilles Peskineb46bef22019-07-30 21:32:04 +02001620 * an input (generate, device) but not for those where the bit-size
Ronald Cronc4d1b512020-07-31 11:26:37 +02001621 * is optional (import, copy). In case of a volatile key, assign it the
1622 * volatile key identifier associated to the slot returned to contain its
1623 * definition. */
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001624
1625 slot->attr = attributes->core;
Gilles Peskine449bd832023-01-11 14:50:10 +01001626 if (PSA_KEY_LIFETIME_IS_VOLATILE(slot->attr.lifetime)) {
Ronald Cronc4d1b512020-07-31 11:26:37 +02001627#if !defined(MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER)
1628 slot->attr.id = volatile_key_id;
1629#else
1630 slot->attr.id.key_id = volatile_key_id;
1631#endif
1632 }
Gilles Peskinec744d992019-07-30 17:26:54 +02001633
Gilles Peskine91e8c332019-08-02 19:19:39 +02001634 /* Erase external-only flags from the internal copy. To access
Gilles Peskine013f5472019-08-07 15:42:14 +02001635 * external-only flags, query `attributes`. Thanks to the check
1636 * in psa_validate_key_attributes(), this leaves the dual-use
Gilles Peskineedbed562019-08-07 18:19:59 +02001637 * flags and any internal flag that psa_get_empty_key_slot()
Gilles Peskine013f5472019-08-07 15:42:14 +02001638 * may have set. */
1639 slot->attr.flags &= ~MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY;
Gilles Peskine91e8c332019-08-02 19:19:39 +02001640
Gilles Peskinecbaff462019-07-12 23:46:04 +02001641#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001642 /* For a key in a secure element, we need to do three things
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001643 * when creating or registering a persistent key:
Gilles Peskine60450a42019-07-25 11:32:45 +02001644 * create the key file in internal storage, create the
1645 * key inside the secure element, and update the driver's
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001646 * persistent data. This is done by starting a transaction that will
1647 * encompass these three actions.
1648 * For registering a volatile key, we just need to find an appropriate
1649 * slot number inside the SE. Since the key is designated volatile, creating
1650 * a transaction is not required. */
Gilles Peskine60450a42019-07-25 11:32:45 +02001651 /* The first thing to do is to find a slot number for the new key.
1652 * We save the slot number in persistent storage as part of the
1653 * transaction data. It will be needed to recover if the power
1654 * fails during the key creation process, to clean up on the secure
1655 * element side after restarting. Obtaining a slot number from the
1656 * secure element driver updates its persistent state, but we do not yet
1657 * save the driver's persistent state, so that if the power fails,
Gilles Peskinefc762652019-07-22 19:30:34 +02001658 * we can roll back to a state where the key doesn't exist. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001659 if (*p_drv != NULL) {
Ronald Cronea0f8a62020-11-25 17:52:23 +01001660 psa_key_slot_number_t slot_number;
Gilles Peskine449bd832023-01-11 14:50:10 +01001661 status = psa_find_se_slot_for_key(attributes, method, *p_drv,
1662 &slot_number);
1663 if (status != PSA_SUCCESS) {
1664 return status;
1665 }
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001666
Gilles Peskine449bd832023-01-11 14:50:10 +01001667 if (!PSA_KEY_LIFETIME_IS_VOLATILE(attributes->core.lifetime)) {
1668 psa_crypto_prepare_transaction(PSA_CRYPTO_TRANSACTION_CREATE_KEY);
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001669 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001670 psa_crypto_transaction.key.slot = slot_number;
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001671 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskine449bd832023-01-11 14:50:10 +01001672 status = psa_crypto_save_transaction();
1673 if (status != PSA_SUCCESS) {
1674 (void) psa_crypto_stop_transaction();
1675 return status;
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001676 }
Gilles Peskine66be51c2019-07-25 18:02:52 +02001677 }
Ronald Cronea0f8a62020-11-25 17:52:23 +01001678
1679 status = psa_copy_key_material_into_slot(
Gilles Peskine449bd832023-01-11 14:50:10 +01001680 slot, (uint8_t *) (&slot_number), sizeof(slot_number));
Darryl Green0c6575a2018-11-07 16:05:30 +00001681 }
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001682
Gilles Peskine449bd832023-01-11 14:50:10 +01001683 if (*p_drv == NULL && method == PSA_KEY_CREATION_REGISTER) {
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001684 /* Key registration only makes sense with a secure element. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001685 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001686 }
Gilles Peskinecbaff462019-07-12 23:46:04 +02001687#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1688
Ryan Everett975d4112023-11-16 13:37:51 +00001689 slot->status = PSA_SLOT_OCCUPIED;
1690
Gilles Peskine449bd832023-01-11 14:50:10 +01001691 return PSA_SUCCESS;
Darryl Green0c6575a2018-11-07 16:05:30 +00001692}
Gilles Peskine4747d192019-04-17 15:05:45 +02001693
1694/** Finalize the creation of a key once its key material has been set.
1695 *
1696 * This entails writing the key to persistent storage.
1697 *
1698 * If this function fails, call psa_fail_key_creation().
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001699 * See the documentation of psa_start_key_creation() for the intended use
1700 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001701 *
Ronald Cron5c522922020-11-14 16:35:34 +01001702 * If the finalization succeeds, the function unlocks the key slot (it was
1703 * locked by psa_start_key_creation()) and the key slot cannot be accessed
1704 * anymore as part of the key creation process.
Ronald Cron50972942020-11-14 11:28:25 +01001705 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001706 * \param[in,out] slot Pointer to the slot with key material.
1707 * \param[in] driver The secure element driver for the key,
1708 * or NULL for a transparent key.
Ronald Cron81709fc2020-11-14 12:10:32 +01001709 * \param[out] key On success, identifier of the key. Note that the
1710 * key identifier is also stored in the key slot.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001711 *
1712 * \retval #PSA_SUCCESS
Ronald Croncf56a0a2020-08-04 09:51:30 +02001713 * The key was successfully created.
Gilles Peskineed733552023-02-14 19:21:09 +01001714 * \retval #PSA_ERROR_INSUFFICIENT_MEMORY \emptydescription
1715 * \retval #PSA_ERROR_INSUFFICIENT_STORAGE \emptydescription
1716 * \retval #PSA_ERROR_ALREADY_EXISTS \emptydescription
1717 * \retval #PSA_ERROR_DATA_INVALID \emptydescription
1718 * \retval #PSA_ERROR_DATA_CORRUPT \emptydescription
1719 * \retval #PSA_ERROR_STORAGE_FAILURE \emptydescription
gabor-mezei-arm452b0a32020-11-09 17:42:55 +01001720 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001721 * \return If this function fails, the key slot is an invalid state.
1722 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001723 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001724static psa_status_t psa_finish_key_creation(
1725 psa_key_slot_t *slot,
Ronald Cron81709fc2020-11-14 12:10:32 +01001726 psa_se_drv_table_entry_t *driver,
1727 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02001728{
1729 psa_status_t status = PSA_SUCCESS;
Gilles Peskine30afafd2019-04-25 13:47:40 +02001730 (void) slot;
Gilles Peskine011e4282019-06-26 18:34:38 +02001731 (void) driver;
Gilles Peskine4747d192019-04-17 15:05:45 +02001732
1733#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001734 if (!PSA_KEY_LIFETIME_IS_VOLATILE(slot->attr.lifetime)) {
Gilles Peskine1df83d42019-07-23 16:13:14 +02001735#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001736 if (driver != NULL) {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001737 psa_se_key_data_storage_t data;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001738 psa_key_slot_number_t slot_number =
Gilles Peskine449bd832023-01-11 14:50:10 +01001739 psa_key_slot_get_slot_number(slot);
Ronald Cronea0f8a62020-11-25 17:52:23 +01001740
Tom Cosgrove6ef9bb32023-03-08 14:19:51 +00001741 MBEDTLS_STATIC_ASSERT(sizeof(slot_number) ==
1742 sizeof(data.slot_number),
1743 "Slot number size does not match psa_se_key_data_storage_t");
1744
Gilles Peskine449bd832023-01-11 14:50:10 +01001745 memcpy(&data.slot_number, &slot_number, sizeof(slot_number));
1746 status = psa_save_persistent_key(&slot->attr,
1747 (uint8_t *) &data,
1748 sizeof(data));
1749 } else
Gilles Peskine1df83d42019-07-23 16:13:14 +02001750#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1751 {
Steven Cooreman40120f62020-10-29 11:42:22 +01001752 /* Key material is saved in export representation in the slot, so
1753 * just pass the slot buffer for storage. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001754 status = psa_save_persistent_key(&slot->attr,
1755 slot->key.data,
1756 slot->key.bytes);
Gilles Peskine1df83d42019-07-23 16:13:14 +02001757 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001758 }
Darryl Green0c6575a2018-11-07 16:05:30 +00001759#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
1760
Gilles Peskinecbaff462019-07-12 23:46:04 +02001761#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001762 /* Finish the transaction for a key creation. This does not
1763 * happen when registering an existing key. Detect this case
1764 * by checking whether a transaction is in progress (actual
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001765 * creation of a persistent key in a secure element requires a transaction,
1766 * but registration or volatile key creation doesn't use one). */
Gilles Peskine449bd832023-01-11 14:50:10 +01001767 if (driver != NULL &&
1768 psa_crypto_transaction.unknown.type == PSA_CRYPTO_TRANSACTION_CREATE_KEY) {
1769 status = psa_save_se_persistent_data(driver);
1770 if (status != PSA_SUCCESS) {
1771 psa_destroy_persistent_key(slot->attr.id);
1772 return status;
Gilles Peskinecbaff462019-07-12 23:46:04 +02001773 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001774 status = psa_crypto_stop_transaction();
Gilles Peskinecbaff462019-07-12 23:46:04 +02001775 }
1776#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1777
Gilles Peskine449bd832023-01-11 14:50:10 +01001778 if (status == PSA_SUCCESS) {
Ronald Cron81709fc2020-11-14 12:10:32 +01001779 *key = slot->attr.id;
Gilles Peskine449bd832023-01-11 14:50:10 +01001780 status = psa_unlock_key_slot(slot);
1781 if (status != PSA_SUCCESS) {
Ronald Cron81709fc2020-11-14 12:10:32 +01001782 *key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01001783 }
Ronald Cron81709fc2020-11-14 12:10:32 +01001784 }
Ronald Cron50972942020-11-14 11:28:25 +01001785
Gilles Peskine449bd832023-01-11 14:50:10 +01001786 return status;
Gilles Peskine4747d192019-04-17 15:05:45 +02001787}
1788
1789/** Abort the creation of a key.
1790 *
1791 * You may call this function after calling psa_start_key_creation(),
1792 * or after psa_finish_key_creation() fails. In other circumstances, this
1793 * function may not clean up persistent storage.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001794 * See the documentation of psa_start_key_creation() for the intended use
1795 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001796 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001797 * \param[in,out] slot Pointer to the slot with key material.
1798 * \param[in] driver The secure element driver for the key,
1799 * or NULL for a transparent key.
Gilles Peskine4747d192019-04-17 15:05:45 +02001800 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001801static void psa_fail_key_creation(psa_key_slot_t *slot,
1802 psa_se_drv_table_entry_t *driver)
Gilles Peskine4747d192019-04-17 15:05:45 +02001803{
Gilles Peskine011e4282019-06-26 18:34:38 +02001804 (void) driver;
1805
Gilles Peskine449bd832023-01-11 14:50:10 +01001806 if (slot == NULL) {
Gilles Peskine4747d192019-04-17 15:05:45 +02001807 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01001808 }
Gilles Peskine011e4282019-06-26 18:34:38 +02001809
1810#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001811 /* TODO: If the key has already been created in the secure
Gilles Peskine011e4282019-06-26 18:34:38 +02001812 * element, and the failure happened later (when saving metadata
1813 * to internal storage), we need to destroy the key in the secure
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001814 * element.
1815 * https://github.com/ARMmbed/mbed-crypto/issues/217
1816 */
Gilles Peskinefc762652019-07-22 19:30:34 +02001817
Gilles Peskined7729582019-08-05 15:55:54 +02001818 /* Abort the ongoing transaction if any (there may not be one if
1819 * the creation process failed before starting one, or if the
1820 * key creation is a registration of a key in a secure element).
1821 * Earlier functions must already have done what it takes to undo any
1822 * partial creation. All that's left is to update the transaction data
1823 * itself. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001824 (void) psa_crypto_stop_transaction();
Gilles Peskine011e4282019-06-26 18:34:38 +02001825#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1826
Gilles Peskine449bd832023-01-11 14:50:10 +01001827 psa_wipe_key_slot(slot);
Gilles Peskine4747d192019-04-17 15:05:45 +02001828}
1829
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001830/** Validate optional attributes during key creation.
1831 *
1832 * Some key attributes are optional during key creation. If they are
1833 * specified in the attributes structure, check that they are consistent
1834 * with the data in the slot.
1835 *
1836 * This function should be called near the end of key creation, after
1837 * the slot in memory is fully populated but before saving persistent data.
1838 */
1839static psa_status_t psa_validate_optional_attributes(
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001840 const psa_key_slot_t *slot,
Gilles Peskine449bd832023-01-11 14:50:10 +01001841 const psa_key_attributes_t *attributes)
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001842{
Gilles Peskine449bd832023-01-11 14:50:10 +01001843 if (attributes->core.type != 0) {
1844 if (attributes->core.type != slot->attr.type) {
1845 return PSA_ERROR_INVALID_ARGUMENT;
1846 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001847 }
1848
Gilles Peskine449bd832023-01-11 14:50:10 +01001849 if (attributes->domain_parameters_size != 0) {
Valerio Settib2bcedb2023-07-10 11:24:00 +02001850#if (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) && \
1851 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01001852 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
1853 if (PSA_KEY_TYPE_IS_RSA(slot->attr.type)) {
Steven Cooremana2371e52020-07-28 14:30:39 +02001854 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman75b74362020-07-28 14:30:13 +02001855 mbedtls_mpi actual, required;
Steven Cooreman6d839f02020-07-30 11:36:45 +02001856 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooremana01795d2020-07-24 22:48:15 +02001857
Ronald Cron90857082020-11-25 14:58:33 +01001858 psa_status_t status = mbedtls_psa_rsa_load_representation(
Gilles Peskine449bd832023-01-11 14:50:10 +01001859 slot->attr.type,
1860 slot->key.data,
1861 slot->key.bytes,
1862 &rsa);
1863 if (status != PSA_SUCCESS) {
1864 return status;
1865 }
Steven Cooreman75b74362020-07-28 14:30:13 +02001866
Gilles Peskine449bd832023-01-11 14:50:10 +01001867 mbedtls_mpi_init(&actual);
1868 mbedtls_mpi_init(&required);
1869 ret = mbedtls_rsa_export(rsa,
1870 NULL, NULL, NULL, NULL, &actual);
1871 mbedtls_rsa_free(rsa);
1872 mbedtls_free(rsa);
1873 if (ret != 0) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001874 goto rsa_exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001875 }
1876 ret = mbedtls_mpi_read_binary(&required,
1877 attributes->domain_parameters,
1878 attributes->domain_parameters_size);
1879 if (ret != 0) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001880 goto rsa_exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001881 }
1882 if (mbedtls_mpi_cmp_mpi(&actual, &required) != 0) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001883 ret = MBEDTLS_ERR_RSA_BAD_INPUT_DATA;
Gilles Peskine449bd832023-01-11 14:50:10 +01001884 }
1885rsa_exit:
1886 mbedtls_mpi_free(&actual);
1887 mbedtls_mpi_free(&required);
1888 if (ret != 0) {
1889 return mbedtls_to_psa_error(ret);
1890 }
1891 } else
Valerio Settib2bcedb2023-07-10 11:24:00 +02001892#endif /* (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) &&
1893 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) ||
John Durkop9814fa22020-11-04 12:28:15 -08001894 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001895 {
Gilles Peskine449bd832023-01-11 14:50:10 +01001896 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001897 }
1898 }
1899
Gilles Peskine449bd832023-01-11 14:50:10 +01001900 if (attributes->core.bits != 0) {
1901 if (attributes->core.bits != slot->attr.bits) {
1902 return PSA_ERROR_INVALID_ARGUMENT;
1903 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001904 }
1905
Gilles Peskine449bd832023-01-11 14:50:10 +01001906 return PSA_SUCCESS;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001907}
1908
Gilles Peskine449bd832023-01-11 14:50:10 +01001909psa_status_t psa_import_key(const psa_key_attributes_t *attributes,
1910 const uint8_t *data,
1911 size_t data_length,
1912 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02001913{
1914 psa_status_t status;
1915 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001916 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001917 size_t bits;
Archanad8a83dc2021-06-14 10:04:16 +05301918 size_t storage_size = data_length;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001919
Ronald Cron81709fc2020-11-14 12:10:32 +01001920 *key = MBEDTLS_SVC_KEY_ID_INIT;
1921
Gilles Peskine0f84d622019-09-12 19:03:13 +02001922 /* Reject zero-length symmetric keys (including raw data key objects).
1923 * This also rejects any key which might be encoded as an empty string,
1924 * which is never valid. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001925 if (data_length == 0) {
1926 return PSA_ERROR_INVALID_ARGUMENT;
1927 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02001928
Archana449608b2021-09-08 15:36:05 +05301929 /* Ensure that the bytes-to-bits conversion cannot overflow. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001930 if (data_length > SIZE_MAX / 8) {
1931 return PSA_ERROR_NOT_SUPPORTED;
1932 }
Archana6ed4bda2021-08-04 10:47:15 +05301933
Gilles Peskine449bd832023-01-11 14:50:10 +01001934 status = psa_start_key_creation(PSA_KEY_CREATION_IMPORT, attributes,
1935 &slot, &driver);
1936 if (status != PSA_SUCCESS) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001937 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001938 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001939
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001940 /* In the case of a transparent key or an opaque key stored in local
Archana449608b2021-09-08 15:36:05 +05301941 * storage ( thus not in the case of importing a key in a secure element
1942 * with storage ( MBEDTLS_PSA_CRYPTO_SE_C ) ),we have to allocate a
1943 * buffer to hold the imported key material. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001944 if (slot->key.data == NULL) {
1945 if (psa_key_lifetime_is_external(attributes->core.lifetime)) {
Archana449608b2021-09-08 15:36:05 +05301946 status = psa_driver_wrapper_get_key_buffer_size_from_key_data(
Gilles Peskine449bd832023-01-11 14:50:10 +01001947 attributes, data, data_length, &storage_size);
1948 if (status != PSA_SUCCESS) {
Archanad8a83dc2021-06-14 10:04:16 +05301949 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001950 }
Archanad8a83dc2021-06-14 10:04:16 +05301951 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001952 status = psa_allocate_buffer_to_slot(slot, storage_size);
1953 if (status != PSA_SUCCESS) {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001954 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001955 }
Gilles Peskine5d309672019-07-12 23:47:28 +02001956 }
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001957
1958 bits = slot->attr.bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01001959 status = psa_driver_wrapper_import_key(attributes,
1960 data, data_length,
1961 slot->key.data,
1962 slot->key.bytes,
1963 &slot->key.bytes, &bits);
1964 if (status != PSA_SUCCESS) {
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001965 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001966 }
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001967
Gilles Peskine449bd832023-01-11 14:50:10 +01001968 if (slot->attr.bits == 0) {
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001969 slot->attr.bits = (psa_key_bits_t) bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01001970 } else if (bits != slot->attr.bits) {
Steven Cooremanac3434f2021-01-15 17:36:02 +01001971 status = PSA_ERROR_INVALID_ARGUMENT;
1972 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02001973 }
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01001974
Archana6ed4bda2021-08-04 10:47:15 +05301975 /* Enforce a size limit, and in particular ensure that the bit
1976 * size fits in its representation type.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01001977 if (bits > PSA_MAX_KEY_BITS) {
Archana6ed4bda2021-08-04 10:47:15 +05301978 status = PSA_ERROR_NOT_SUPPORTED;
1979 goto exit;
1980 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001981 status = psa_validate_optional_attributes(slot, attributes);
1982 if (status != PSA_SUCCESS) {
Gilles Peskine18017402019-07-24 20:25:59 +02001983 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001984 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001985
Gilles Peskine449bd832023-01-11 14:50:10 +01001986 status = psa_finish_key_creation(slot, driver, key);
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001987exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01001988 if (status != PSA_SUCCESS) {
1989 psa_fail_key_creation(slot, driver);
1990 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001991
Gilles Peskine449bd832023-01-11 14:50:10 +01001992 return status;
Gilles Peskine4747d192019-04-17 15:05:45 +02001993}
1994
Gilles Peskined7729582019-08-05 15:55:54 +02001995#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1996psa_status_t mbedtls_psa_register_se_key(
Gilles Peskine449bd832023-01-11 14:50:10 +01001997 const psa_key_attributes_t *attributes)
Gilles Peskined7729582019-08-05 15:55:54 +02001998{
1999 psa_status_t status;
2000 psa_key_slot_t *slot = NULL;
2001 psa_se_drv_table_entry_t *driver = NULL;
Ronald Croncf56a0a2020-08-04 09:51:30 +02002002 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskined7729582019-08-05 15:55:54 +02002003
2004 /* Leaving attributes unspecified is not currently supported.
2005 * It could make sense to query the key type and size from the
2006 * secure element, but not all secure elements support this
2007 * and the driver HAL doesn't currently support it. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002008 if (psa_get_key_type(attributes) == PSA_KEY_TYPE_NONE) {
2009 return PSA_ERROR_NOT_SUPPORTED;
2010 }
2011 if (psa_get_key_bits(attributes) == 0) {
2012 return PSA_ERROR_NOT_SUPPORTED;
2013 }
Gilles Peskined7729582019-08-05 15:55:54 +02002014
Gilles Peskine449bd832023-01-11 14:50:10 +01002015 status = psa_start_key_creation(PSA_KEY_CREATION_REGISTER, attributes,
2016 &slot, &driver);
2017 if (status != PSA_SUCCESS) {
Gilles Peskined7729582019-08-05 15:55:54 +02002018 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002019 }
Gilles Peskined7729582019-08-05 15:55:54 +02002020
Gilles Peskine449bd832023-01-11 14:50:10 +01002021 status = psa_finish_key_creation(slot, driver, &key);
Gilles Peskined7729582019-08-05 15:55:54 +02002022
2023exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002024 if (status != PSA_SUCCESS) {
2025 psa_fail_key_creation(slot, driver);
2026 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002027
Gilles Peskined7729582019-08-05 15:55:54 +02002028 /* Registration doesn't keep the key in RAM. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002029 psa_close_key(key);
2030 return status;
Gilles Peskined7729582019-08-05 15:55:54 +02002031}
2032#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2033
Gilles Peskine449bd832023-01-11 14:50:10 +01002034psa_status_t psa_copy_key(mbedtls_svc_key_id_t source_key,
2035 const psa_key_attributes_t *specified_attributes,
2036 mbedtls_svc_key_id_t *target_key)
Gilles Peskinef603c712019-01-19 13:40:11 +01002037{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002038 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01002039 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinef603c712019-01-19 13:40:11 +01002040 psa_key_slot_t *source_slot = NULL;
2041 psa_key_slot_t *target_slot = NULL;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002042 psa_key_attributes_t actual_attributes = *specified_attributes;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002043 psa_se_drv_table_entry_t *driver = NULL;
Archana8a180362021-07-05 02:18:48 +05302044 size_t storage_size = 0;
Gilles Peskinef603c712019-01-19 13:40:11 +01002045
Ronald Cron81709fc2020-11-14 12:10:32 +01002046 *target_key = MBEDTLS_SVC_KEY_ID_INIT;
2047
Archana8a180362021-07-05 02:18:48 +05302048 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002049 source_key, &source_slot, PSA_KEY_USAGE_COPY, 0);
2050 if (status != PSA_SUCCESS) {
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002051 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002052 }
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002053
Gilles Peskine449bd832023-01-11 14:50:10 +01002054 status = psa_validate_optional_attributes(source_slot,
2055 specified_attributes);
2056 if (status != PSA_SUCCESS) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002057 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002058 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002059
Archana9d17bf42021-09-10 06:22:44 +05302060 /* The target key type and number of bits have been validated by
2061 * psa_validate_optional_attributes() to be either equal to zero or
2062 * equal to the ones of the source key. So it is safe to inherit
2063 * them from the source key now."
Archana374fe5b2021-09-08 15:50:28 +05302064 * */
Archana9d17bf42021-09-10 06:22:44 +05302065 actual_attributes.core.bits = source_slot->attr.bits;
2066 actual_attributes.core.type = source_slot->attr.type;
Archana374fe5b2021-09-08 15:50:28 +05302067
2068
Gilles Peskine449bd832023-01-11 14:50:10 +01002069 status = psa_restrict_key_policy(source_slot->attr.type,
2070 &actual_attributes.core.policy,
2071 &source_slot->attr.policy);
2072 if (status != PSA_SUCCESS) {
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002073 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002074 }
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002075
Gilles Peskine449bd832023-01-11 14:50:10 +01002076 status = psa_start_key_creation(PSA_KEY_CREATION_COPY, &actual_attributes,
2077 &target_slot, &driver);
2078 if (status != PSA_SUCCESS) {
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002079 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002080 }
2081 if (PSA_KEY_LIFETIME_GET_LOCATION(target_slot->attr.lifetime) !=
2082 PSA_KEY_LIFETIME_GET_LOCATION(source_slot->attr.lifetime)) {
Archana8a180362021-07-05 02:18:48 +05302083 /*
Archana9d17bf42021-09-10 06:22:44 +05302084 * If the source and target keys are stored in different locations,
Archana8a180362021-07-05 02:18:48 +05302085 * the source key would need to be exported as plaintext and re-imported
2086 * in the other location. This has security implications which have not
Archana449608b2021-09-08 15:36:05 +05302087 * been fully mapped. For now, this can be achieved through
Archana8a180362021-07-05 02:18:48 +05302088 * appropriate API invocations from the application, if needed.
2089 * */
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002090 status = PSA_ERROR_NOT_SUPPORTED;
2091 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002092 }
Archana8a180362021-07-05 02:18:48 +05302093 /*
2094 * When the source and target keys are within the same location,
Archana449608b2021-09-08 15:36:05 +05302095 * - For transparent keys it is a blind copy without any driver invocation,
Archana8a180362021-07-05 02:18:48 +05302096 * - For opaque keys this translates to an invocation of the drivers'
2097 * copy_key entry point through the dispatch layer.
2098 * */
Gilles Peskine449bd832023-01-11 14:50:10 +01002099 if (psa_key_lifetime_is_external(actual_attributes.core.lifetime)) {
2100 status = psa_driver_wrapper_get_key_buffer_size(&actual_attributes,
2101 &storage_size);
2102 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302103 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002104 }
Archana374fe5b2021-09-08 15:50:28 +05302105
Gilles Peskine449bd832023-01-11 14:50:10 +01002106 status = psa_allocate_buffer_to_slot(target_slot, storage_size);
2107 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302108 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002109 }
Archana374fe5b2021-09-08 15:50:28 +05302110
Gilles Peskine449bd832023-01-11 14:50:10 +01002111 status = psa_driver_wrapper_copy_key(&actual_attributes,
2112 source_slot->key.data,
2113 source_slot->key.bytes,
2114 target_slot->key.data,
2115 target_slot->key.bytes,
2116 &target_slot->key.bytes);
2117 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302118 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002119 }
2120 } else {
2121 status = psa_copy_key_material_into_slot(target_slot,
Archana9d17bf42021-09-10 06:22:44 +05302122 source_slot->key.data,
Gilles Peskine449bd832023-01-11 14:50:10 +01002123 source_slot->key.bytes);
2124 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302125 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002126 }
Archana8a180362021-07-05 02:18:48 +05302127 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002128 status = psa_finish_key_creation(target_slot, driver, target_key);
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002129exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002130 if (status != PSA_SUCCESS) {
2131 psa_fail_key_creation(target_slot, driver);
2132 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002133
Gilles Peskine449bd832023-01-11 14:50:10 +01002134 unlock_status = psa_unlock_key_slot(source_slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02002135
Gilles Peskine449bd832023-01-11 14:50:10 +01002136 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskinef603c712019-01-19 13:40:11 +01002137}
2138
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02002139
2140
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01002141/****************************************************************/
Gilles Peskine20035e32018-02-03 22:44:14 +01002142/* Message digests */
2143/****************************************************************/
2144
Gilles Peskine449bd832023-01-11 14:50:10 +01002145psa_status_t psa_hash_abort(psa_hash_operation_t *operation)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002146{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002147 /* Aborting a non-active operation is allowed */
Gilles Peskine449bd832023-01-11 14:50:10 +01002148 if (operation->id == 0) {
2149 return PSA_SUCCESS;
2150 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002151
Gilles Peskine449bd832023-01-11 14:50:10 +01002152 psa_status_t status = psa_driver_wrapper_hash_abort(operation);
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002153 operation->id = 0;
2154
Gilles Peskine449bd832023-01-11 14:50:10 +01002155 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002156}
2157
Gilles Peskine449bd832023-01-11 14:50:10 +01002158psa_status_t psa_hash_setup(psa_hash_operation_t *operation,
2159 psa_algorithm_t alg)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002160{
Dave Rodgman685b6a72021-06-24 11:49:14 +01002161 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002162
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002163 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002164 if (operation->id != 0) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002165 status = PSA_ERROR_BAD_STATE;
2166 goto exit;
2167 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002168
Gilles Peskine449bd832023-01-11 14:50:10 +01002169 if (!PSA_ALG_IS_HASH(alg)) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002170 status = PSA_ERROR_INVALID_ARGUMENT;
2171 goto exit;
2172 }
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002173
Steven Cooremanb6bf4bb2021-03-15 19:00:14 +01002174 /* Ensure all of the context is zeroized, since PSA_HASH_OPERATION_INIT only
2175 * directly zeroes the int-sized dummy member of the context union. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002176 memset(&operation->ctx, 0, sizeof(operation->ctx));
Steven Cooreman893232f2021-03-15 12:23:37 +01002177
Gilles Peskine449bd832023-01-11 14:50:10 +01002178 status = psa_driver_wrapper_hash_setup(operation, alg);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002179
2180exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002181 if (status != PSA_SUCCESS) {
2182 psa_hash_abort(operation);
2183 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002184
2185 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002186}
2187
Gilles Peskine449bd832023-01-11 14:50:10 +01002188psa_status_t psa_hash_update(psa_hash_operation_t *operation,
2189 const uint8_t *input,
2190 size_t input_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002191{
Dave Rodgman685b6a72021-06-24 11:49:14 +01002192 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2193
Gilles Peskine449bd832023-01-11 14:50:10 +01002194 if (operation->id == 0) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002195 status = PSA_ERROR_BAD_STATE;
2196 goto exit;
2197 }
Gilles Peskine94e44542018-07-12 16:58:43 +02002198
Steven Cooremanc8288352021-03-04 14:02:19 +01002199 /* Don't require hash implementations to behave correctly on a
2200 * zero-length input, which may have an invalid pointer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002201 if (input_length == 0) {
2202 return PSA_SUCCESS;
2203 }
Steven Cooremanc8288352021-03-04 14:02:19 +01002204
Gilles Peskine449bd832023-01-11 14:50:10 +01002205 status = psa_driver_wrapper_hash_update(operation, input, input_length);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002206
2207exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002208 if (status != PSA_SUCCESS) {
2209 psa_hash_abort(operation);
2210 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002211
Gilles Peskine449bd832023-01-11 14:50:10 +01002212 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002213}
2214
Gilles Peskine449bd832023-01-11 14:50:10 +01002215psa_status_t psa_hash_finish(psa_hash_operation_t *operation,
2216 uint8_t *hash,
2217 size_t hash_size,
2218 size_t *hash_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002219{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002220 *hash_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002221 if (operation->id == 0) {
2222 return PSA_ERROR_BAD_STATE;
2223 }
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002224
Steven Cooreman1e582352021-02-18 17:24:37 +01002225 psa_status_t status = psa_driver_wrapper_hash_finish(
Gilles Peskine449bd832023-01-11 14:50:10 +01002226 operation, hash, hash_size, hash_length);
2227 psa_hash_abort(operation);
2228 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002229}
2230
Gilles Peskine449bd832023-01-11 14:50:10 +01002231psa_status_t psa_hash_verify(psa_hash_operation_t *operation,
2232 const uint8_t *hash,
2233 size_t hash_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002234{
Ronald Cron69a63422021-10-18 09:47:58 +02002235 uint8_t actual_hash[PSA_HASH_MAX_SIZE];
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002236 size_t actual_hash_length;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002237 psa_status_t status = psa_hash_finish(
Gilles Peskine449bd832023-01-11 14:50:10 +01002238 operation,
2239 actual_hash, sizeof(actual_hash),
2240 &actual_hash_length);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002241
Gilles Peskine449bd832023-01-11 14:50:10 +01002242 if (status != PSA_SUCCESS) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002243 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002244 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002245
Gilles Peskine449bd832023-01-11 14:50:10 +01002246 if (actual_hash_length != hash_length) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002247 status = PSA_ERROR_INVALID_SIGNATURE;
2248 goto exit;
2249 }
2250
Dave Rodgman78701152023-08-29 14:20:18 +01002251 if (mbedtls_ct_memcmp(hash, actual_hash, actual_hash_length) != 0) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002252 status = PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01002253 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002254
2255exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002256 mbedtls_platform_zeroize(actual_hash, sizeof(actual_hash));
2257 if (status != PSA_SUCCESS) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002258 psa_hash_abort(operation);
Gilles Peskine449bd832023-01-11 14:50:10 +01002259 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002260
Gilles Peskine449bd832023-01-11 14:50:10 +01002261 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002262}
2263
Gilles Peskine449bd832023-01-11 14:50:10 +01002264psa_status_t psa_hash_compute(psa_algorithm_t alg,
2265 const uint8_t *input, size_t input_length,
2266 uint8_t *hash, size_t hash_size,
2267 size_t *hash_length)
Gilles Peskine0a749c82019-11-28 19:33:58 +01002268{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002269 *hash_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002270 if (!PSA_ALG_IS_HASH(alg)) {
2271 return PSA_ERROR_INVALID_ARGUMENT;
2272 }
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002273
Gilles Peskine449bd832023-01-11 14:50:10 +01002274 return psa_driver_wrapper_hash_compute(alg, input, input_length,
2275 hash, hash_size, hash_length);
Gilles Peskine0a749c82019-11-28 19:33:58 +01002276}
2277
Gilles Peskine449bd832023-01-11 14:50:10 +01002278psa_status_t psa_hash_compare(psa_algorithm_t alg,
2279 const uint8_t *input, size_t input_length,
2280 const uint8_t *hash, size_t hash_length)
Gilles Peskine0a749c82019-11-28 19:33:58 +01002281{
Ronald Cron69a63422021-10-18 09:47:58 +02002282 uint8_t actual_hash[PSA_HASH_MAX_SIZE];
Steven Cooreman84d670d2021-02-18 16:22:53 +01002283 size_t actual_hash_length;
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002284
Gilles Peskine449bd832023-01-11 14:50:10 +01002285 if (!PSA_ALG_IS_HASH(alg)) {
2286 return PSA_ERROR_INVALID_ARGUMENT;
2287 }
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002288
Steven Cooreman1e582352021-02-18 17:24:37 +01002289 psa_status_t status = psa_driver_wrapper_hash_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01002290 alg, input, input_length,
2291 actual_hash, sizeof(actual_hash),
2292 &actual_hash_length);
2293 if (status != PSA_SUCCESS) {
Gilles Peskine60aebec2021-12-13 12:33:18 +01002294 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002295 }
2296 if (actual_hash_length != hash_length) {
Gilles Peskine60aebec2021-12-13 12:33:18 +01002297 status = PSA_ERROR_INVALID_SIGNATURE;
2298 goto exit;
2299 }
Dave Rodgman78701152023-08-29 14:20:18 +01002300 if (mbedtls_ct_memcmp(hash, actual_hash, actual_hash_length) != 0) {
Gilles Peskine60aebec2021-12-13 12:33:18 +01002301 status = PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01002302 }
Gilles Peskine60aebec2021-12-13 12:33:18 +01002303
2304exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002305 mbedtls_platform_zeroize(actual_hash, sizeof(actual_hash));
2306 return status;
Gilles Peskine0a749c82019-11-28 19:33:58 +01002307}
2308
Gilles Peskine449bd832023-01-11 14:50:10 +01002309psa_status_t psa_hash_clone(const psa_hash_operation_t *source_operation,
2310 psa_hash_operation_t *target_operation)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002311{
Gilles Peskine449bd832023-01-11 14:50:10 +01002312 if (source_operation->id == 0 ||
2313 target_operation->id != 0) {
2314 return PSA_ERROR_BAD_STATE;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002315 }
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002316
Gilles Peskine449bd832023-01-11 14:50:10 +01002317 psa_status_t status = psa_driver_wrapper_hash_clone(source_operation,
2318 target_operation);
2319 if (status != PSA_SUCCESS) {
2320 psa_hash_abort(target_operation);
2321 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002322
Gilles Peskine449bd832023-01-11 14:50:10 +01002323 return status;
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002324}
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002325
2326
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002327/****************************************************************/
Gilles Peskine8c9def32018-02-08 10:02:12 +01002328/* MAC */
2329/****************************************************************/
2330
Gilles Peskine449bd832023-01-11 14:50:10 +01002331psa_status_t psa_mac_abort(psa_mac_operation_t *operation)
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002332{
Steven Cooremane6804192021-03-19 18:28:56 +01002333 /* Aborting a non-active operation is allowed */
Gilles Peskine449bd832023-01-11 14:50:10 +01002334 if (operation->id == 0) {
2335 return PSA_SUCCESS;
2336 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002337
Gilles Peskine449bd832023-01-11 14:50:10 +01002338 psa_status_t status = psa_driver_wrapper_mac_abort(operation);
Steven Cooreman72f736a2021-05-07 14:14:37 +02002339 operation->mac_size = 0;
2340 operation->is_sign = 0;
Steven Cooremane6804192021-03-19 18:28:56 +01002341 operation->id = 0;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002342
Gilles Peskine449bd832023-01-11 14:50:10 +01002343 return status;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002344}
2345
Ronald Cron2dff3b22021-06-17 16:33:22 +02002346static psa_status_t psa_mac_finalize_alg_and_key_validation(
2347 psa_algorithm_t alg,
Ronald Cron79bdd822021-06-17 16:46:44 +02002348 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01002349 uint8_t *mac_size)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002350{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002351 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002352 psa_key_type_t key_type = psa_get_key_type(attributes);
2353 size_t key_bits = psa_get_key_bits(attributes);
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002354
Gilles Peskine449bd832023-01-11 14:50:10 +01002355 if (!PSA_ALG_IS_MAC(alg)) {
2356 return PSA_ERROR_INVALID_ARGUMENT;
2357 }
Steven Cooremane6804192021-03-19 18:28:56 +01002358
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002359 /* Validate the combination of key type and algorithm */
Gilles Peskine449bd832023-01-11 14:50:10 +01002360 status = psa_mac_key_can_do(alg, key_type);
2361 if (status != PSA_SUCCESS) {
2362 return status;
2363 }
Steven Cooreman15472f82021-03-02 16:16:22 +01002364
Steven Cooremand1a68f12021-05-10 11:13:41 +02002365 /* Get the output length for the algorithm and key combination */
Gilles Peskine449bd832023-01-11 14:50:10 +01002366 *mac_size = PSA_MAC_LENGTH(key_type, key_bits, alg);
Steven Cooreman15472f82021-03-02 16:16:22 +01002367
Gilles Peskine449bd832023-01-11 14:50:10 +01002368 if (*mac_size < 4) {
Steven Cooreman15472f82021-03-02 16:16:22 +01002369 /* A very short MAC is too short for security since it can be
2370 * brute-forced. Ancient protocols with 32-bit MACs do exist,
2371 * so we make this our minimum, even though 32 bits is still
2372 * too small for security. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002373 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman15472f82021-03-02 16:16:22 +01002374 }
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02002375
Gilles Peskine449bd832023-01-11 14:50:10 +01002376 if (*mac_size > PSA_MAC_LENGTH(key_type, key_bits,
2377 PSA_ALG_FULL_LENGTH_MAC(alg))) {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002378 /* It's impossible to "truncate" to a larger length than the full length
2379 * of the algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002380 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002381 }
2382
Gilles Peskine449bd832023-01-11 14:50:10 +01002383 if (*mac_size > PSA_MAC_MAX_SIZE) {
Gilles Peskinea9b6c802022-03-16 13:54:49 +01002384 /* PSA_MAC_LENGTH returns the correct length even for a MAC algorithm
2385 * that is disabled in the compile-time configuration. The result can
2386 * therefore be larger than PSA_MAC_MAX_SIZE, which does take the
2387 * configuration into account. In this case, force a return of
2388 * PSA_ERROR_NOT_SUPPORTED here. Otherwise psa_mac_verify(), or
2389 * psa_mac_compute(mac_size=PSA_MAC_MAX_SIZE), would return
2390 * PSA_ERROR_BUFFER_TOO_SMALL for an unsupported algorithm whose MAC size
2391 * is larger than PSA_MAC_MAX_SIZE, which is misleading and which breaks
2392 * systematically generated tests. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002393 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea9b6c802022-03-16 13:54:49 +01002394 }
2395
Gilles Peskine449bd832023-01-11 14:50:10 +01002396 return PSA_SUCCESS;
Ronald Cron2dff3b22021-06-17 16:33:22 +02002397}
2398
Gilles Peskine449bd832023-01-11 14:50:10 +01002399static psa_status_t psa_mac_setup(psa_mac_operation_t *operation,
2400 mbedtls_svc_key_id_t key,
2401 psa_algorithm_t alg,
2402 int is_sign)
Gilles Peskinee59236f2018-01-27 23:32:46 +01002403{
2404 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2405 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman54648242021-06-24 11:49:45 +01002406 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002407 psa_key_attributes_t attributes;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002408
2409 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002410 if (operation->id != 0) {
Dave Rodgman54648242021-06-24 11:49:45 +01002411 status = PSA_ERROR_BAD_STATE;
2412 goto exit;
2413 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002414
2415 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002416 key,
2417 &slot,
2418 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
2419 alg);
2420 if (status != PSA_SUCCESS) {
Dave Rodgman54648242021-06-24 11:49:45 +01002421 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002422 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002423
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002424 attributes = (psa_key_attributes_t) {
Gilles Peskine8c9def32018-02-08 10:02:12 +01002425 .core = slot->attr
2426 };
2427
Gilles Peskine449bd832023-01-11 14:50:10 +01002428 status = psa_mac_finalize_alg_and_key_validation(alg, &attributes,
2429 &operation->mac_size);
2430 if (status != PSA_SUCCESS) {
Gilles Peskine8c9def32018-02-08 10:02:12 +01002431 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002432 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002433
2434 operation->is_sign = is_sign;
Steven Cooremane6804192021-03-19 18:28:56 +01002435 /* Dispatch the MAC setup call with validated input */
Gilles Peskine449bd832023-01-11 14:50:10 +01002436 if (is_sign) {
2437 status = psa_driver_wrapper_mac_sign_setup(operation,
2438 &attributes,
2439 slot->key.data,
2440 slot->key.bytes,
2441 alg);
2442 } else {
2443 status = psa_driver_wrapper_mac_verify_setup(operation,
2444 &attributes,
2445 slot->key.data,
2446 slot->key.bytes,
2447 alg);
Gilles Peskine8c9def32018-02-08 10:02:12 +01002448 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002449
Gilles Peskinefbfac682018-07-08 20:51:54 +02002450exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002451 if (status != PSA_SUCCESS) {
2452 psa_mac_abort(operation);
2453 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002454
Gilles Peskine449bd832023-01-11 14:50:10 +01002455 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02002456
Gilles Peskine449bd832023-01-11 14:50:10 +01002457 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002458}
2459
Gilles Peskine449bd832023-01-11 14:50:10 +01002460psa_status_t psa_mac_sign_setup(psa_mac_operation_t *operation,
2461 mbedtls_svc_key_id_t key,
2462 psa_algorithm_t alg)
Gilles Peskine89167cb2018-07-08 20:12:23 +02002463{
Gilles Peskine449bd832023-01-11 14:50:10 +01002464 return psa_mac_setup(operation, key, alg, 1);
Gilles Peskine89167cb2018-07-08 20:12:23 +02002465}
2466
Gilles Peskine449bd832023-01-11 14:50:10 +01002467psa_status_t psa_mac_verify_setup(psa_mac_operation_t *operation,
2468 mbedtls_svc_key_id_t key,
2469 psa_algorithm_t alg)
Gilles Peskine89167cb2018-07-08 20:12:23 +02002470{
Gilles Peskine449bd832023-01-11 14:50:10 +01002471 return psa_mac_setup(operation, key, alg, 0);
Gilles Peskine89167cb2018-07-08 20:12:23 +02002472}
2473
Gilles Peskine449bd832023-01-11 14:50:10 +01002474psa_status_t psa_mac_update(psa_mac_operation_t *operation,
2475 const uint8_t *input,
2476 size_t input_length)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002477{
Gilles Peskine449bd832023-01-11 14:50:10 +01002478 if (operation->id == 0) {
2479 return PSA_ERROR_BAD_STATE;
2480 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002481
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002482 /* Don't require hash implementations to behave correctly on a
2483 * zero-length input, which may have an invalid pointer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002484 if (input_length == 0) {
2485 return PSA_SUCCESS;
2486 }
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03002487
Gilles Peskine449bd832023-01-11 14:50:10 +01002488 psa_status_t status = psa_driver_wrapper_mac_update(operation,
2489 input, input_length);
2490 if (status != PSA_SUCCESS) {
2491 psa_mac_abort(operation);
2492 }
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002493
Gilles Peskine449bd832023-01-11 14:50:10 +01002494 return status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002495}
2496
Gilles Peskine449bd832023-01-11 14:50:10 +01002497psa_status_t psa_mac_sign_finish(psa_mac_operation_t *operation,
2498 uint8_t *mac,
2499 size_t mac_size,
2500 size_t *mac_length)
mohammad16036df908f2018-04-02 08:34:15 -07002501{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002502 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2503 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002504
Gilles Peskine449bd832023-01-11 14:50:10 +01002505 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002506 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002507 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002508 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002509
Gilles Peskine449bd832023-01-11 14:50:10 +01002510 if (!operation->is_sign) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002511 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002512 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002513 }
Steven Cooreman72f736a2021-05-07 14:14:37 +02002514
Steven Cooreman8af5c5c2021-05-11 11:09:13 +02002515 /* Sanity check. This will guarantee that mac_size != 0 (and so mac != NULL)
2516 * once all the error checks are done. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002517 if (operation->mac_size == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002518 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002519 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002520 }
Steven Cooreman8af5c5c2021-05-11 11:09:13 +02002521
Gilles Peskine449bd832023-01-11 14:50:10 +01002522 if (mac_size < operation->mac_size) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002523 status = PSA_ERROR_BUFFER_TOO_SMALL;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002524 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002525 }
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002526
Gilles Peskine449bd832023-01-11 14:50:10 +01002527 status = psa_driver_wrapper_mac_sign_finish(operation,
2528 mac, operation->mac_size,
2529 mac_length);
Steven Cooreman72f736a2021-05-07 14:14:37 +02002530
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002531exit:
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002532 /* In case of success, set the potential excess room in the output buffer
2533 * to an invalid value, to avoid potentially leaking a longer MAC.
2534 * In case of error, set the output length and content to a safe default,
2535 * such that in case the caller misses an error check, the output would be
2536 * an unachievable MAC.
2537 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002538 if (status != PSA_SUCCESS) {
Steven Cooreman72f736a2021-05-07 14:14:37 +02002539 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002540 operation->mac_size = 0;
Steven Cooreman72f736a2021-05-07 14:14:37 +02002541 }
mohammad16036df908f2018-04-02 08:34:15 -07002542
Paul Elliottdc42ca82023-02-24 18:11:59 +00002543 psa_wipe_tag_output_buffer(mac, status, mac_size, *mac_length);
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002544
Gilles Peskine449bd832023-01-11 14:50:10 +01002545 abort_status = psa_mac_abort(operation);
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002546
Gilles Peskine449bd832023-01-11 14:50:10 +01002547 return status == PSA_SUCCESS ? abort_status : status;
mohammad16036df908f2018-04-02 08:34:15 -07002548}
2549
Gilles Peskine449bd832023-01-11 14:50:10 +01002550psa_status_t psa_mac_verify_finish(psa_mac_operation_t *operation,
2551 const uint8_t *mac,
2552 size_t mac_length)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002553{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002554 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2555 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002556
Gilles Peskine449bd832023-01-11 14:50:10 +01002557 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002558 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002559 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002560 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002561
Gilles Peskine449bd832023-01-11 14:50:10 +01002562 if (operation->is_sign) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002563 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002564 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002565 }
Steven Cooreman72f736a2021-05-07 14:14:37 +02002566
Gilles Peskine449bd832023-01-11 14:50:10 +01002567 if (operation->mac_size != mac_length) {
Steven Cooreman72f736a2021-05-07 14:14:37 +02002568 status = PSA_ERROR_INVALID_SIGNATURE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002569 goto exit;
Steven Cooreman72f736a2021-05-07 14:14:37 +02002570 }
2571
Gilles Peskine449bd832023-01-11 14:50:10 +01002572 status = psa_driver_wrapper_mac_verify_finish(operation,
2573 mac, mac_length);
Steven Cooreman72f736a2021-05-07 14:14:37 +02002574
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002575exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002576 abort_status = psa_mac_abort(operation);
mohammad16036df908f2018-04-02 08:34:15 -07002577
Gilles Peskine449bd832023-01-11 14:50:10 +01002578 return status == PSA_SUCCESS ? abort_status : status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002579}
2580
Gilles Peskine449bd832023-01-11 14:50:10 +01002581static psa_status_t psa_mac_compute_internal(mbedtls_svc_key_id_t key,
2582 psa_algorithm_t alg,
2583 const uint8_t *input,
2584 size_t input_length,
2585 uint8_t *mac,
2586 size_t mac_size,
2587 size_t *mac_length,
2588 int is_sign)
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002589{
2590 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron51131b52021-06-17 17:17:20 +02002591 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2592 psa_key_slot_t *slot;
2593 uint8_t operation_mac_size = 0;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002594 psa_key_attributes_t attributes;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002595
Ronald Cron51131b52021-06-17 17:17:20 +02002596 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002597 key,
2598 &slot,
2599 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
2600 alg);
2601 if (status != PSA_SUCCESS) {
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002602 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002603 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002604
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002605 attributes = (psa_key_attributes_t) {
Ronald Cron51131b52021-06-17 17:17:20 +02002606 .core = slot->attr
2607 };
2608
Gilles Peskine449bd832023-01-11 14:50:10 +01002609 status = psa_mac_finalize_alg_and_key_validation(alg, &attributes,
2610 &operation_mac_size);
2611 if (status != PSA_SUCCESS) {
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002612 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002613 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002614
Gilles Peskine449bd832023-01-11 14:50:10 +01002615 if (mac_size < operation_mac_size) {
Ronald Cron51131b52021-06-17 17:17:20 +02002616 status = PSA_ERROR_BUFFER_TOO_SMALL;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002617 goto exit;
Ronald Cron51131b52021-06-17 17:17:20 +02002618 }
2619
2620 status = psa_driver_wrapper_mac_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01002621 &attributes,
2622 slot->key.data, slot->key.bytes,
2623 alg,
2624 input, input_length,
2625 mac, operation_mac_size, mac_length);
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002626
2627exit:
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002628 /* In case of success, set the potential excess room in the output buffer
2629 * to an invalid value, to avoid potentially leaking a longer MAC.
2630 * In case of error, set the output length and content to a safe default,
2631 * such that in case the caller misses an error check, the output would be
2632 * an unachievable MAC.
2633 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002634 if (status != PSA_SUCCESS) {
Ronald Cron51131b52021-06-17 17:17:20 +02002635 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002636 operation_mac_size = 0;
Ronald Cron51131b52021-06-17 17:17:20 +02002637 }
Paul Elliottdc42ca82023-02-24 18:11:59 +00002638
2639 psa_wipe_tag_output_buffer(mac, status, mac_size, *mac_length);
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002640
Gilles Peskine449bd832023-01-11 14:50:10 +01002641 unlock_status = psa_unlock_key_slot(slot);
Ronald Cron51131b52021-06-17 17:17:20 +02002642
Gilles Peskine449bd832023-01-11 14:50:10 +01002643 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002644}
2645
Gilles Peskine449bd832023-01-11 14:50:10 +01002646psa_status_t psa_mac_compute(mbedtls_svc_key_id_t key,
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002647 psa_algorithm_t alg,
2648 const uint8_t *input,
2649 size_t input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002650 uint8_t *mac,
2651 size_t mac_size,
2652 size_t *mac_length)
2653{
2654 return psa_mac_compute_internal(key, alg,
2655 input, input_length,
2656 mac, mac_size, mac_length, 1);
2657}
2658
2659psa_status_t psa_mac_verify(mbedtls_svc_key_id_t key,
2660 psa_algorithm_t alg,
2661 const uint8_t *input,
2662 size_t input_length,
2663 const uint8_t *mac,
2664 size_t mac_length)
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002665{
2666 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Crona587cbc2021-06-18 14:51:29 +02002667 uint8_t actual_mac[PSA_MAC_MAX_SIZE];
2668 size_t actual_mac_length;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002669
Gilles Peskine449bd832023-01-11 14:50:10 +01002670 status = psa_mac_compute_internal(key, alg,
2671 input, input_length,
2672 actual_mac, sizeof(actual_mac),
2673 &actual_mac_length, 0);
2674 if (status != PSA_SUCCESS) {
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002675 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002676 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002677
Gilles Peskine449bd832023-01-11 14:50:10 +01002678 if (mac_length != actual_mac_length) {
Ronald Crona587cbc2021-06-18 14:51:29 +02002679 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002680 goto exit;
Ronald Crona587cbc2021-06-18 14:51:29 +02002681 }
Dave Rodgman78701152023-08-29 14:20:18 +01002682 if (mbedtls_ct_memcmp(mac, actual_mac, actual_mac_length) != 0) {
Ronald Crona587cbc2021-06-18 14:51:29 +02002683 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002684 goto exit;
Ronald Crona587cbc2021-06-18 14:51:29 +02002685 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002686
2687exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002688 mbedtls_platform_zeroize(actual_mac, sizeof(actual_mac));
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002689
Gilles Peskine449bd832023-01-11 14:50:10 +01002690 return status;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002691}
Gilles Peskinee59236f2018-01-27 23:32:46 +01002692
Gilles Peskinee59236f2018-01-27 23:32:46 +01002693/****************************************************************/
2694/* Asymmetric cryptography */
2695/****************************************************************/
2696
Gilles Peskine449bd832023-01-11 14:50:10 +01002697static psa_status_t psa_sign_verify_check_alg(int input_is_message,
2698 psa_algorithm_t alg)
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002699{
Gilles Peskine449bd832023-01-11 14:50:10 +01002700 if (input_is_message) {
2701 if (!PSA_ALG_IS_SIGN_MESSAGE(alg)) {
2702 return PSA_ERROR_INVALID_ARGUMENT;
2703 }
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002704
Gilles Peskine449bd832023-01-11 14:50:10 +01002705 if (PSA_ALG_IS_SIGN_HASH(alg)) {
2706 if (!PSA_ALG_IS_HASH(PSA_ALG_SIGN_GET_HASH(alg))) {
2707 return PSA_ERROR_INVALID_ARGUMENT;
2708 }
2709 }
2710 } else {
2711 if (!PSA_ALG_IS_SIGN_HASH(alg)) {
2712 return PSA_ERROR_INVALID_ARGUMENT;
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002713 }
2714 }
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002715
Gilles Peskine449bd832023-01-11 14:50:10 +01002716 return PSA_SUCCESS;
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002717}
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002718
Gilles Peskine449bd832023-01-11 14:50:10 +01002719static psa_status_t psa_sign_internal(mbedtls_svc_key_id_t key,
2720 int input_is_message,
2721 psa_algorithm_t alg,
2722 const uint8_t *input,
2723 size_t input_length,
2724 uint8_t *signature,
2725 size_t signature_size,
2726 size_t *signature_length)
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002727{
2728 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2729 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2730 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002731 psa_key_attributes_t attributes;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002732
2733 *signature_length = 0;
2734
Gilles Peskine449bd832023-01-11 14:50:10 +01002735 status = psa_sign_verify_check_alg(input_is_message, alg);
2736 if (status != PSA_SUCCESS) {
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002737 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002738 }
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002739
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002740 /* Immediately reject a zero-length signature buffer. This guarantees
gabor-mezei-arm12b4f342021-05-05 13:54:55 +02002741 * that signature must be a valid pointer. (On the other hand, the input
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002742 * buffer can in principle be empty since it doesn't actually have
2743 * to be a hash.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01002744 if (signature_size == 0) {
2745 return PSA_ERROR_BUFFER_TOO_SMALL;
2746 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002747
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002748 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002749 key, &slot,
2750 input_is_message ? PSA_KEY_USAGE_SIGN_MESSAGE :
2751 PSA_KEY_USAGE_SIGN_HASH,
2752 alg);
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002753
Gilles Peskine449bd832023-01-11 14:50:10 +01002754 if (status != PSA_SUCCESS) {
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002755 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002756 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002757
Gilles Peskine449bd832023-01-11 14:50:10 +01002758 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002759 status = PSA_ERROR_INVALID_ARGUMENT;
2760 goto exit;
2761 }
2762
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002763 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01002764 .core = slot->attr
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002765 };
2766
Gilles Peskine449bd832023-01-11 14:50:10 +01002767 if (input_is_message) {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002768 status = psa_driver_wrapper_sign_message(
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002769 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002770 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002771 signature, signature_size, signature_length);
2772 } else {
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002773
2774 status = psa_driver_wrapper_sign_hash(
2775 &attributes, slot->key.data, slot->key.bytes,
2776 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002777 signature, signature_size, signature_length);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002778 }
2779
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002780
2781exit:
Paul Elliott59200a22023-02-21 15:07:40 +00002782 psa_wipe_tag_output_buffer(signature, status, signature_size,
2783 *signature_length);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002784
Gilles Peskine449bd832023-01-11 14:50:10 +01002785 unlock_status = psa_unlock_key_slot(slot);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002786
Gilles Peskine449bd832023-01-11 14:50:10 +01002787 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002788}
2789
Gilles Peskine449bd832023-01-11 14:50:10 +01002790static psa_status_t psa_verify_internal(mbedtls_svc_key_id_t key,
2791 int input_is_message,
2792 psa_algorithm_t alg,
2793 const uint8_t *input,
2794 size_t input_length,
2795 const uint8_t *signature,
2796 size_t signature_length)
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002797{
2798 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2799 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2800 psa_key_slot_t *slot;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002801
Gilles Peskine449bd832023-01-11 14:50:10 +01002802 status = psa_sign_verify_check_alg(input_is_message, alg);
2803 if (status != PSA_SUCCESS) {
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002804 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002805 }
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002806
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002807 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002808 key, &slot,
2809 input_is_message ? PSA_KEY_USAGE_VERIFY_MESSAGE :
2810 PSA_KEY_USAGE_VERIFY_HASH,
2811 alg);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002812
Gilles Peskine449bd832023-01-11 14:50:10 +01002813 if (status != PSA_SUCCESS) {
2814 return status;
2815 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002816
2817 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01002818 .core = slot->attr
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002819 };
2820
Gilles Peskine449bd832023-01-11 14:50:10 +01002821 if (input_is_message) {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002822 status = psa_driver_wrapper_verify_message(
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002823 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002824 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002825 signature, signature_length);
2826 } else {
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002827 status = psa_driver_wrapper_verify_hash(
2828 &attributes, slot->key.data, slot->key.bytes,
2829 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002830 signature, signature_length);
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002831 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002832
Gilles Peskine449bd832023-01-11 14:50:10 +01002833 unlock_status = psa_unlock_key_slot(slot);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002834
Gilles Peskine449bd832023-01-11 14:50:10 +01002835 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002836
2837}
2838
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002839psa_status_t psa_sign_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002840 const psa_key_attributes_t *attributes,
2841 const uint8_t *key_buffer,
2842 size_t key_buffer_size,
2843 psa_algorithm_t alg,
2844 const uint8_t *input,
2845 size_t input_length,
2846 uint8_t *signature,
2847 size_t signature_size,
Gilles Peskine449bd832023-01-11 14:50:10 +01002848 size_t *signature_length)
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002849{
2850 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002851
Gilles Peskine449bd832023-01-11 14:50:10 +01002852 if (PSA_ALG_IS_SIGN_HASH(alg)) {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002853 size_t hash_length;
2854 uint8_t hash[PSA_HASH_MAX_SIZE];
2855
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002856 status = psa_driver_wrapper_hash_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01002857 PSA_ALG_SIGN_GET_HASH(alg),
2858 input, input_length,
2859 hash, sizeof(hash), &hash_length);
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002860
Gilles Peskine449bd832023-01-11 14:50:10 +01002861 if (status != PSA_SUCCESS) {
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002862 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002863 }
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002864
2865 return psa_driver_wrapper_sign_hash(
Gilles Peskine449bd832023-01-11 14:50:10 +01002866 attributes, key_buffer, key_buffer_size,
2867 alg, hash, hash_length,
2868 signature, signature_size, signature_length);
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002869 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002870
Gilles Peskine449bd832023-01-11 14:50:10 +01002871 return PSA_ERROR_NOT_SUPPORTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002872}
2873
Gilles Peskine449bd832023-01-11 14:50:10 +01002874psa_status_t psa_sign_message(mbedtls_svc_key_id_t key,
2875 psa_algorithm_t alg,
2876 const uint8_t *input,
2877 size_t input_length,
2878 uint8_t *signature,
2879 size_t signature_size,
2880 size_t *signature_length)
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002881{
2882 return psa_sign_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002883 key, 1, alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002884 signature, signature_size, signature_length);
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002885}
2886
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002887psa_status_t psa_verify_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002888 const psa_key_attributes_t *attributes,
2889 const uint8_t *key_buffer,
2890 size_t key_buffer_size,
2891 psa_algorithm_t alg,
2892 const uint8_t *input,
2893 size_t input_length,
2894 const uint8_t *signature,
Gilles Peskine449bd832023-01-11 14:50:10 +01002895 size_t signature_length)
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002896{
2897 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002898
Gilles Peskine449bd832023-01-11 14:50:10 +01002899 if (PSA_ALG_IS_SIGN_HASH(alg)) {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002900 size_t hash_length;
2901 uint8_t hash[PSA_HASH_MAX_SIZE];
2902
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002903 status = psa_driver_wrapper_hash_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01002904 PSA_ALG_SIGN_GET_HASH(alg),
2905 input, input_length,
2906 hash, sizeof(hash), &hash_length);
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002907
Gilles Peskine449bd832023-01-11 14:50:10 +01002908 if (status != PSA_SUCCESS) {
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002909 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002910 }
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002911
2912 return psa_driver_wrapper_verify_hash(
Gilles Peskine449bd832023-01-11 14:50:10 +01002913 attributes, key_buffer, key_buffer_size,
2914 alg, hash, hash_length,
2915 signature, signature_length);
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002916 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002917
Gilles Peskine449bd832023-01-11 14:50:10 +01002918 return PSA_ERROR_NOT_SUPPORTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002919}
2920
Gilles Peskine449bd832023-01-11 14:50:10 +01002921psa_status_t psa_verify_message(mbedtls_svc_key_id_t key,
2922 psa_algorithm_t alg,
2923 const uint8_t *input,
2924 size_t input_length,
2925 const uint8_t *signature,
2926 size_t signature_length)
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002927{
2928 return psa_verify_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002929 key, 1, alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002930 signature, signature_length);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002931}
2932
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002933psa_status_t psa_sign_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01002934 const psa_key_attributes_t *attributes,
2935 const uint8_t *key_buffer, size_t key_buffer_size,
2936 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002937 uint8_t *signature, size_t signature_size, size_t *signature_length)
Gilles Peskinee59236f2018-01-27 23:32:46 +01002938{
Gilles Peskine449bd832023-01-11 14:50:10 +01002939 if (attributes->core.type == PSA_KEY_TYPE_RSA_KEY_PAIR) {
2940 if (PSA_ALG_IS_RSA_PKCS1V15_SIGN(alg) ||
2941 PSA_ALG_IS_RSA_PSS(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01002942#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01002943 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
2944 return mbedtls_psa_rsa_sign_hash(
2945 attributes,
2946 key_buffer, key_buffer_size,
2947 alg, hash, hash_length,
2948 signature, signature_size, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01002949#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
2950 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine449bd832023-01-11 14:50:10 +01002951 } else {
2952 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanacda8342020-07-24 23:09:52 +02002953 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002954 } else if (PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
2955 if (PSA_ALG_IS_ECDSA(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01002956#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01002957 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
2958 return mbedtls_psa_ecdsa_sign_hash(
2959 attributes,
2960 key_buffer, key_buffer_size,
2961 alg, hash, hash_length,
2962 signature, signature_size, signature_length);
Gilles Peskinee59236f2018-01-27 23:32:46 +01002963#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
2964 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskine449bd832023-01-11 14:50:10 +01002965 } else {
2966 return PSA_ERROR_INVALID_ARGUMENT;
Ronald Cron4501c982021-03-19 20:09:32 +01002967 }
Ronald Cron8a494f32021-02-17 09:49:51 +01002968 }
Ronald Cron4501c982021-03-19 20:09:32 +01002969
Gilles Peskine449bd832023-01-11 14:50:10 +01002970 (void) key_buffer;
2971 (void) key_buffer_size;
2972 (void) hash;
2973 (void) hash_length;
2974 (void) signature;
2975 (void) signature_size;
2976 (void) signature_length;
Ronald Cron4501c982021-03-19 20:09:32 +01002977
Gilles Peskine449bd832023-01-11 14:50:10 +01002978 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron18659932020-12-08 16:32:23 +01002979}
Gilles Peskinee59236f2018-01-27 23:32:46 +01002980
Gilles Peskine449bd832023-01-11 14:50:10 +01002981psa_status_t psa_sign_hash(mbedtls_svc_key_id_t key,
2982 psa_algorithm_t alg,
2983 const uint8_t *hash,
2984 size_t hash_length,
2985 uint8_t *signature,
2986 size_t signature_size,
2987 size_t *signature_length)
Gilles Peskinee59236f2018-01-27 23:32:46 +01002988{
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002989 return psa_sign_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002990 key, 0, alg, hash, hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002991 signature, signature_size, signature_length);
itayzafrir5c753392018-05-08 11:18:38 +03002992}
2993
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002994psa_status_t psa_verify_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01002995 const psa_key_attributes_t *attributes,
2996 const uint8_t *key_buffer, size_t key_buffer_size,
2997 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002998 const uint8_t *signature, size_t signature_length)
itayzafrir5c753392018-05-08 11:18:38 +03002999{
Gilles Peskine449bd832023-01-11 14:50:10 +01003000 if (PSA_KEY_TYPE_IS_RSA(attributes->core.type)) {
3001 if (PSA_ALG_IS_RSA_PKCS1V15_SIGN(alg) ||
3002 PSA_ALG_IS_RSA_PSS(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003003#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003004 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
3005 return mbedtls_psa_rsa_verify_hash(
3006 attributes,
3007 key_buffer, key_buffer_size,
3008 alg, hash, hash_length,
3009 signature, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01003010#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
3011 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003012 } else {
3013 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanacda8342020-07-24 23:09:52 +02003014 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003015 } else if (PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3016 if (PSA_ALG_IS_ECDSA(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003017#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003018 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3019 return mbedtls_psa_ecdsa_verify_hash(
3020 attributes,
3021 key_buffer, key_buffer_size,
3022 alg, hash, hash_length,
3023 signature, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01003024#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3025 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003026 } else {
3027 return PSA_ERROR_INVALID_ARGUMENT;
Ronald Cron4501c982021-03-19 20:09:32 +01003028 }
Ronald Cron8a494f32021-02-17 09:49:51 +01003029 }
Ronald Cron4501c982021-03-19 20:09:32 +01003030
Gilles Peskine449bd832023-01-11 14:50:10 +01003031 (void) key_buffer;
3032 (void) key_buffer_size;
3033 (void) hash;
3034 (void) hash_length;
3035 (void) signature;
3036 (void) signature_length;
Ronald Cron4501c982021-03-19 20:09:32 +01003037
Gilles Peskine449bd832023-01-11 14:50:10 +01003038 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron18659932020-12-08 16:32:23 +01003039}
3040
Gilles Peskine449bd832023-01-11 14:50:10 +01003041psa_status_t psa_verify_hash(mbedtls_svc_key_id_t key,
3042 psa_algorithm_t alg,
3043 const uint8_t *hash,
3044 size_t hash_length,
3045 const uint8_t *signature,
3046 size_t signature_length)
itayzafrir5c753392018-05-08 11:18:38 +03003047{
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003048 return psa_verify_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02003049 key, 0, alg, hash, hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003050 signature, signature_length);
Gilles Peskinee59236f2018-01-27 23:32:46 +01003051}
3052
Gilles Peskine449bd832023-01-11 14:50:10 +01003053psa_status_t psa_asymmetric_encrypt(mbedtls_svc_key_id_t key,
3054 psa_algorithm_t alg,
3055 const uint8_t *input,
3056 size_t input_length,
3057 const uint8_t *salt,
3058 size_t salt_length,
3059 uint8_t *output,
3060 size_t output_size,
3061 size_t *output_length)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003062{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003063 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003064 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003065 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003066 psa_key_attributes_t attributes;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003067
Darryl Green5cc689a2018-07-24 15:34:10 +01003068 (void) input;
3069 (void) input_length;
3070 (void) salt;
3071 (void) output;
3072 (void) output_size;
3073
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003074 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003075
Gilles Peskine449bd832023-01-11 14:50:10 +01003076 if (!PSA_ALG_IS_RSA_OAEP(alg) && salt_length != 0) {
3077 return PSA_ERROR_INVALID_ARGUMENT;
3078 }
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003079
Ronald Cron5c522922020-11-14 16:35:34 +01003080 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01003081 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg);
3082 if (status != PSA_SUCCESS) {
3083 return status;
3084 }
3085 if (!(PSA_KEY_TYPE_IS_PUBLIC_KEY(slot->attr.type) ||
3086 PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type))) {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003087 status = PSA_ERROR_INVALID_ARGUMENT;
3088 goto exit;
3089 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003090
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003091 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01003092 .core = slot->attr
Przemyslaw Stekiel19e61422021-12-09 11:09:11 +01003093 };
Steven Cooremana2371e52020-07-28 14:30:39 +02003094
Przemyslaw Stekiel19e61422021-12-09 11:09:11 +01003095 status = psa_driver_wrapper_asymmetric_encrypt(
3096 &attributes, slot->key.data, slot->key.bytes,
3097 alg, input, input_length, salt, salt_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003098 output, output_size, output_length);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003099exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01003100 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003101
Gilles Peskine449bd832023-01-11 14:50:10 +01003102 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003103}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003104
Gilles Peskine449bd832023-01-11 14:50:10 +01003105psa_status_t psa_asymmetric_decrypt(mbedtls_svc_key_id_t key,
3106 psa_algorithm_t alg,
3107 const uint8_t *input,
3108 size_t input_length,
3109 const uint8_t *salt,
3110 size_t salt_length,
3111 uint8_t *output,
3112 size_t output_size,
3113 size_t *output_length)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003114{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003115 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003116 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003117 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003118 psa_key_attributes_t attributes;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003119
Darryl Green5cc689a2018-07-24 15:34:10 +01003120 (void) input;
3121 (void) input_length;
3122 (void) salt;
3123 (void) output;
3124 (void) output_size;
3125
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003126 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003127
Gilles Peskine449bd832023-01-11 14:50:10 +01003128 if (!PSA_ALG_IS_RSA_OAEP(alg) && salt_length != 0) {
3129 return PSA_ERROR_INVALID_ARGUMENT;
3130 }
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003131
Ronald Cron5c522922020-11-14 16:35:34 +01003132 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01003133 key, &slot, PSA_KEY_USAGE_DECRYPT, alg);
3134 if (status != PSA_SUCCESS) {
3135 return status;
3136 }
3137 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003138 status = PSA_ERROR_INVALID_ARGUMENT;
3139 goto exit;
3140 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003141
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003142 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01003143 .core = slot->attr
Przemyslaw Stekiel8d45c002021-12-13 08:58:19 +01003144 };
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003145
Przemyslaw Stekiel8d45c002021-12-13 08:58:19 +01003146 status = psa_driver_wrapper_asymmetric_decrypt(
3147 &attributes, slot->key.data, slot->key.bytes,
3148 alg, input, input_length, salt, salt_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003149 output, output_size, output_length);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003150
3151exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01003152 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003153
Gilles Peskine449bd832023-01-11 14:50:10 +01003154 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003155}
Gilles Peskinee59236f2018-01-27 23:32:46 +01003156
Paul Elliott9fe12f62022-11-30 19:16:02 +00003157/****************************************************************/
3158/* Asymmetric interruptible cryptography */
3159/****************************************************************/
3160
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003161static uint32_t psa_interruptible_max_ops = PSA_INTERRUPTIBLE_MAX_OPS_UNLIMITED;
3162
Paul Elliott9fe12f62022-11-30 19:16:02 +00003163void psa_interruptible_set_max_ops(uint32_t max_ops)
3164{
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003165 psa_interruptible_max_ops = max_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003166}
3167
3168uint32_t psa_interruptible_get_max_ops(void)
3169{
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003170 return psa_interruptible_max_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003171}
3172
Paul Elliott9fe12f62022-11-30 19:16:02 +00003173uint32_t psa_sign_hash_get_num_ops(
3174 const psa_sign_hash_interruptible_operation_t *operation)
3175{
Paul Elliott296ede92022-12-15 17:00:30 +00003176 return operation->num_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003177}
3178
3179uint32_t psa_verify_hash_get_num_ops(
3180 const psa_verify_hash_interruptible_operation_t *operation)
3181{
Paul Elliott296ede92022-12-15 17:00:30 +00003182 return operation->num_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003183}
3184
Paul Elliott59ad9452022-12-18 15:09:02 +00003185static psa_status_t psa_sign_hash_abort_internal(
3186 psa_sign_hash_interruptible_operation_t *operation)
3187{
3188 if (operation->id == 0) {
3189 /* The object has (apparently) been initialized but it is not (yet)
3190 * in use. It's ok to call abort on such an object, and there's
3191 * nothing to do. */
3192 return PSA_SUCCESS;
3193 }
3194
3195 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3196
3197 status = psa_driver_wrapper_sign_hash_abort(operation);
3198
3199 operation->id = 0;
3200
Paul Elliotte6145dc2023-02-07 12:51:21 +00003201 /* Do not clear either the error_occurred or num_ops elements here as they
3202 * only want to be cleared by the application calling abort, not by abort
3203 * being called at completion of an operation. */
3204
Paul Elliott59ad9452022-12-18 15:09:02 +00003205 return status;
3206}
3207
Paul Elliott9fe12f62022-11-30 19:16:02 +00003208psa_status_t psa_sign_hash_start(
3209 psa_sign_hash_interruptible_operation_t *operation,
3210 mbedtls_svc_key_id_t key, psa_algorithm_t alg,
3211 const uint8_t *hash, size_t hash_length)
3212{
3213 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3214 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3215 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003216 psa_key_attributes_t attributes;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003217
Paul Elliottc9774412023-02-06 15:14:07 +00003218 /* Check that start has not been previously called, or operation has not
3219 * previously errored. */
3220 if (operation->id != 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003221 return PSA_ERROR_BAD_STATE;
3222 }
3223
Paul Elliott9fe12f62022-11-30 19:16:02 +00003224 status = psa_sign_verify_check_alg(0, alg);
3225 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003226 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003227 return status;
3228 }
3229
3230 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
3231 PSA_KEY_USAGE_SIGN_HASH,
3232 alg);
3233
3234 if (status != PSA_SUCCESS) {
3235 goto exit;
3236 }
3237
3238 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
3239 status = PSA_ERROR_INVALID_ARGUMENT;
3240 goto exit;
3241 }
3242
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003243 attributes = (psa_key_attributes_t) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003244 .core = slot->attr
3245 };
3246
Paul Elliott296ede92022-12-15 17:00:30 +00003247 /* Ensure ops count gets reset, in case of operation re-use. */
3248 operation->num_ops = 0;
3249
Paul Elliott9fe12f62022-11-30 19:16:02 +00003250 status = psa_driver_wrapper_sign_hash_start(operation, &attributes,
3251 slot->key.data,
3252 slot->key.bytes, alg,
3253 hash, hash_length);
3254exit:
3255
3256 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003257 operation->error_occurred = 1;
Paul Elliott59ad9452022-12-18 15:09:02 +00003258 psa_sign_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003259 }
3260
3261 unlock_status = psa_unlock_key_slot(slot);
3262
Paul Elliottc9774412023-02-06 15:14:07 +00003263 if (unlock_status != PSA_SUCCESS) {
3264 operation->error_occurred = 1;
3265 }
Paul Elliott9fe12f62022-11-30 19:16:02 +00003266
Paul Elliottc9774412023-02-06 15:14:07 +00003267 return (status == PSA_SUCCESS) ? unlock_status : status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003268}
3269
3270
3271psa_status_t psa_sign_hash_complete(
3272 psa_sign_hash_interruptible_operation_t *operation,
3273 uint8_t *signature, size_t signature_size,
3274 size_t *signature_length)
3275{
3276 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3277
3278 *signature_length = 0;
3279
Paul Elliottc9774412023-02-06 15:14:07 +00003280 /* Check that start has been called first, and that operation has not
3281 * previously errored. */
3282 if (operation->id == 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003283 status = PSA_ERROR_BAD_STATE;
3284 goto exit;
3285 }
3286
Paul Elliott096abc42023-02-03 18:33:23 +00003287 /* Immediately reject a zero-length signature buffer. This guarantees that
3288 * signature must be a valid pointer. */
Paul Elliott9fe12f62022-11-30 19:16:02 +00003289 if (signature_size == 0) {
3290 status = PSA_ERROR_BUFFER_TOO_SMALL;
3291 goto exit;
3292 }
3293
3294 status = psa_driver_wrapper_sign_hash_complete(operation, signature,
3295 signature_size,
3296 signature_length);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003297
Paul Elliott296ede92022-12-15 17:00:30 +00003298 /* Update ops count with work done. */
Paul Elliottde1114c2023-02-07 12:43:11 +00003299 operation->num_ops = psa_driver_wrapper_sign_hash_get_num_ops(operation);
Paul Elliott296ede92022-12-15 17:00:30 +00003300
Paul Elliottebe225c2023-02-10 14:32:53 +00003301exit:
3302
Paul Elliott59200a22023-02-21 15:07:40 +00003303 psa_wipe_tag_output_buffer(signature, status, signature_size,
3304 *signature_length);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003305
Paul Elliott53bb3122023-02-10 14:22:22 +00003306 if (status != PSA_OPERATION_INCOMPLETE) {
Paul Elliottc9774412023-02-06 15:14:07 +00003307 if (status != PSA_SUCCESS) {
3308 operation->error_occurred = 1;
3309 }
3310
Paul Elliott59ad9452022-12-18 15:09:02 +00003311 psa_sign_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003312 }
3313
3314 return status;
3315}
3316
3317psa_status_t psa_sign_hash_abort(
3318 psa_sign_hash_interruptible_operation_t *operation)
3319{
Paul Elliott59ad9452022-12-18 15:09:02 +00003320 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3321
3322 status = psa_sign_hash_abort_internal(operation);
3323
3324 /* We clear the number of ops done here, so that it is not cleared when
3325 * the operation fails or succeeds, only on manual abort. */
3326 operation->num_ops = 0;
3327
Paul Elliottc9774412023-02-06 15:14:07 +00003328 /* Likewise, failure state. */
3329 operation->error_occurred = 0;
3330
Paul Elliott59ad9452022-12-18 15:09:02 +00003331 return status;
3332}
3333
3334static psa_status_t psa_verify_hash_abort_internal(
3335 psa_verify_hash_interruptible_operation_t *operation)
3336{
Paul Elliott9fe12f62022-11-30 19:16:02 +00003337 if (operation->id == 0) {
3338 /* The object has (apparently) been initialized but it is not (yet)
3339 * in use. It's ok to call abort on such an object, and there's
3340 * nothing to do. */
3341 return PSA_SUCCESS;
3342 }
3343
Paul Elliott59ad9452022-12-18 15:09:02 +00003344 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3345
3346 status = psa_driver_wrapper_verify_hash_abort(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003347
3348 operation->id = 0;
3349
Paul Elliotte6145dc2023-02-07 12:51:21 +00003350 /* Do not clear either the error_occurred or num_ops elements here as they
3351 * only want to be cleared by the application calling abort, not by abort
3352 * being called at completion of an operation. */
3353
Paul Elliott59ad9452022-12-18 15:09:02 +00003354 return status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003355}
3356
3357psa_status_t psa_verify_hash_start(
3358 psa_verify_hash_interruptible_operation_t *operation,
3359 mbedtls_svc_key_id_t key, psa_algorithm_t alg,
3360 const uint8_t *hash, size_t hash_length,
3361 const uint8_t *signature, size_t signature_length)
3362{
3363 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3364 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3365 psa_key_slot_t *slot;
3366
Paul Elliottc9774412023-02-06 15:14:07 +00003367 /* Check that start has not been previously called, or operation has not
3368 * previously errored. */
3369 if (operation->id != 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003370 return PSA_ERROR_BAD_STATE;
3371 }
3372
3373 status = psa_sign_verify_check_alg(0, alg);
3374 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003375 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003376 return status;
3377 }
3378
3379 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
3380 PSA_KEY_USAGE_VERIFY_HASH,
3381 alg);
3382
3383 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003384 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003385 return status;
3386 }
3387
3388 psa_key_attributes_t attributes = {
3389 .core = slot->attr
3390 };
3391
Paul Elliott296ede92022-12-15 17:00:30 +00003392 /* Ensure ops count gets reset, in case of operation re-use. */
3393 operation->num_ops = 0;
3394
Paul Elliott9fe12f62022-11-30 19:16:02 +00003395 status = psa_driver_wrapper_verify_hash_start(operation, &attributes,
3396 slot->key.data,
3397 slot->key.bytes,
3398 alg, hash, hash_length,
3399 signature, signature_length);
3400
3401 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003402 operation->error_occurred = 1;
Paul Elliott59ad9452022-12-18 15:09:02 +00003403 psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003404 }
3405
3406 unlock_status = psa_unlock_key_slot(slot);
3407
Paul Elliottc9774412023-02-06 15:14:07 +00003408 if (unlock_status != PSA_SUCCESS) {
3409 operation->error_occurred = 1;
3410 }
Paul Elliott9fe12f62022-11-30 19:16:02 +00003411
Paul Elliottc9774412023-02-06 15:14:07 +00003412 return (status == PSA_SUCCESS) ? unlock_status : status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003413}
3414
3415psa_status_t psa_verify_hash_complete(
3416 psa_verify_hash_interruptible_operation_t *operation)
3417{
3418 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3419
Paul Elliottc9774412023-02-06 15:14:07 +00003420 /* Check that start has been called first, and that operation has not
3421 * previously errored. */
3422 if (operation->id == 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003423 status = PSA_ERROR_BAD_STATE;
3424 goto exit;
3425 }
3426
3427 status = psa_driver_wrapper_verify_hash_complete(operation);
3428
Paul Elliott296ede92022-12-15 17:00:30 +00003429 /* Update ops count with work done. */
Paul Elliottde1114c2023-02-07 12:43:11 +00003430 operation->num_ops = psa_driver_wrapper_verify_hash_get_num_ops(
Paul Elliott296ede92022-12-15 17:00:30 +00003431 operation);
3432
Paul Elliottebe225c2023-02-10 14:32:53 +00003433exit:
3434
Paul Elliott9fe12f62022-11-30 19:16:02 +00003435 if (status != PSA_OPERATION_INCOMPLETE) {
Paul Elliottc9774412023-02-06 15:14:07 +00003436 if (status != PSA_SUCCESS) {
3437 operation->error_occurred = 1;
3438 }
3439
Paul Elliott59ad9452022-12-18 15:09:02 +00003440 psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003441 }
3442
3443 return status;
3444}
3445
3446psa_status_t psa_verify_hash_abort(
3447 psa_verify_hash_interruptible_operation_t *operation)
3448{
Paul Elliott59ad9452022-12-18 15:09:02 +00003449 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003450
Paul Elliott59ad9452022-12-18 15:09:02 +00003451 status = psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003452
Paul Elliott59ad9452022-12-18 15:09:02 +00003453 /* We clear the number of ops done here, so that it is not cleared when
3454 * the operation fails or succeeds, only on manual abort. */
3455 operation->num_ops = 0;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003456
Paul Elliottc9774412023-02-06 15:14:07 +00003457 /* Likewise, failure state. */
3458 operation->error_occurred = 0;
3459
Paul Elliott59ad9452022-12-18 15:09:02 +00003460 return status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003461}
3462
Paul Elliott588f8ed2022-12-02 18:10:26 +00003463/****************************************************************/
3464/* Asymmetric interruptible cryptography internal */
3465/* implementations */
3466/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003467
Paul Elliott588f8ed2022-12-02 18:10:26 +00003468void mbedtls_psa_interruptible_set_max_ops(uint32_t max_ops)
3469{
Paul Elliott7cc4e812023-01-10 17:14:11 +00003470
Paul Elliott588f8ed2022-12-02 18:10:26 +00003471#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3472 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3473 defined(MBEDTLS_ECP_RESTARTABLE)
3474
3475 /* Internal implementation uses zero to indicate infinite number max ops,
3476 * therefore avoid this value, and set to minimum possible. */
3477 if (max_ops == 0) {
3478 max_ops = 1;
3479 }
3480
Paul Elliott588f8ed2022-12-02 18:10:26 +00003481 mbedtls_ecp_set_max_ops(max_ops);
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003482#else
3483 (void) max_ops;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003484#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3485 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3486 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3487}
3488
Paul Elliott588f8ed2022-12-02 18:10:26 +00003489uint32_t mbedtls_psa_sign_hash_get_num_ops(
Paul Elliottf8e5b562023-02-19 18:43:45 +00003490 const mbedtls_psa_sign_hash_interruptible_operation_t *operation)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003491{
3492#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3493 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3494 defined(MBEDTLS_ECP_RESTARTABLE)
3495
Paul Elliott93d9ca82023-02-15 18:14:21 +00003496 return operation->num_ops;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003497#else
3498 (void) operation;
3499 return 0;
3500#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3501 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3502 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3503}
3504
3505uint32_t mbedtls_psa_verify_hash_get_num_ops(
Paul Elliottf8e5b562023-02-19 18:43:45 +00003506 const mbedtls_psa_verify_hash_interruptible_operation_t *operation)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003507{
3508 #if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3509 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3510 defined(MBEDTLS_ECP_RESTARTABLE)
3511
Paul Elliott93d9ca82023-02-15 18:14:21 +00003512 return operation->num_ops;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003513#else
3514 (void) operation;
3515 return 0;
3516#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3517 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3518 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3519}
3520
3521psa_status_t mbedtls_psa_sign_hash_start(
3522 mbedtls_psa_sign_hash_interruptible_operation_t *operation,
3523 const psa_key_attributes_t *attributes, const uint8_t *key_buffer,
3524 size_t key_buffer_size, psa_algorithm_t alg,
3525 const uint8_t *hash, size_t hash_length)
3526{
3527 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott0290a762023-02-09 14:30:24 +00003528 size_t required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003529
Paul Elliott068fe072023-01-16 13:59:15 +00003530 if (!PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3531 return PSA_ERROR_NOT_SUPPORTED;
3532 }
3533
3534 if (!PSA_ALG_IS_ECDSA(alg)) {
Paul Elliott813f9cd2023-02-05 15:28:46 +00003535 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott068fe072023-01-16 13:59:15 +00003536 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003537
3538#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Paul Elliott068fe072023-01-16 13:59:15 +00003539 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3540 defined(MBEDTLS_ECP_RESTARTABLE)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003541
Paul Elliotta1c94092023-02-15 16:38:04 +00003542 mbedtls_ecdsa_restart_init(&operation->restart_ctx);
3543
Paul Elliott93d9ca82023-02-15 18:14:21 +00003544 /* Ensure num_ops is zero'ed in case of context re-use. */
3545 operation->num_ops = 0;
3546
Paul Elliott068fe072023-01-16 13:59:15 +00003547 status = mbedtls_psa_ecp_load_representation(attributes->core.type,
3548 attributes->core.bits,
3549 key_buffer,
3550 key_buffer_size,
3551 &operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003552
Paul Elliott068fe072023-01-16 13:59:15 +00003553 if (status != PSA_SUCCESS) {
3554 return status;
3555 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003556
Paul Elliott1bc59df2023-02-05 13:41:57 +00003557 operation->coordinate_bytes = PSA_BITS_TO_BYTES(
Paul Elliottc569fc22023-02-10 13:02:54 +00003558 operation->ctx->grp.nbits);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003559
Paul Elliott068fe072023-01-16 13:59:15 +00003560 psa_algorithm_t hash_alg = PSA_ALG_SIGN_GET_HASH(alg);
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02003561 operation->md_alg = mbedtls_md_type_from_psa_alg(hash_alg);
Paul Elliott068fe072023-01-16 13:59:15 +00003562 operation->alg = alg;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003563
Paul Elliott0290a762023-02-09 14:30:24 +00003564 /* We only need to store the same length of hash as the private key size
3565 * here, it would be truncated by the internal implementation anyway. */
3566 required_hash_length = (hash_length < operation->coordinate_bytes ?
3567 hash_length : operation->coordinate_bytes);
3568
Paul Elliottba70ad42023-02-15 18:23:53 +00003569 if (required_hash_length > sizeof(operation->hash)) {
3570 /* Shouldn't happen, but better safe than sorry. */
3571 return PSA_ERROR_CORRUPTION_DETECTED;
3572 }
3573
Paul Elliott0290a762023-02-09 14:30:24 +00003574 memcpy(operation->hash, hash, required_hash_length);
3575 operation->hash_length = required_hash_length;
Paul Elliott068fe072023-01-16 13:59:15 +00003576
3577 return PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003578
3579#else
Paul Elliott068fe072023-01-16 13:59:15 +00003580 (void) operation;
3581 (void) key_buffer;
3582 (void) key_buffer_size;
3583 (void) alg;
3584 (void) hash;
3585 (void) hash_length;
3586 (void) status;
Paul Elliott0290a762023-02-09 14:30:24 +00003587 (void) required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003588
Paul Elliott068fe072023-01-16 13:59:15 +00003589 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003590#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3591 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3592 * defined( MBEDTLS_ECP_RESTARTABLE ) */
Paul Elliott588f8ed2022-12-02 18:10:26 +00003593}
3594
3595psa_status_t mbedtls_psa_sign_hash_complete(
3596 mbedtls_psa_sign_hash_interruptible_operation_t *operation,
3597 uint8_t *signature, size_t signature_size,
3598 size_t *signature_length)
3599{
Paul Elliott588f8ed2022-12-02 18:10:26 +00003600#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3601 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3602 defined(MBEDTLS_ECP_RESTARTABLE)
3603
Paul Elliotta1c94092023-02-15 16:38:04 +00003604 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott1243f932023-02-07 11:21:10 +00003605 mbedtls_mpi r;
3606 mbedtls_mpi s;
3607
Paul Elliott46845252023-02-03 14:59:11 +00003608 mbedtls_mpi_init(&r);
3609 mbedtls_mpi_init(&s);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003610
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003611 /* Ensure max_ops is set to the current value (or default). */
3612 mbedtls_psa_interruptible_set_max_ops(psa_interruptible_get_max_ops());
3613
Paul Elliotta1c94092023-02-15 16:38:04 +00003614 if (signature_size < 2 * operation->coordinate_bytes) {
3615 status = PSA_ERROR_BUFFER_TOO_SMALL;
3616 goto exit;
3617 }
3618
Paul Elliott588f8ed2022-12-02 18:10:26 +00003619 if (PSA_ALG_ECDSA_IS_DETERMINISTIC(operation->alg)) {
Paul Elliott46845252023-02-03 14:59:11 +00003620
Paul Elliott588f8ed2022-12-02 18:10:26 +00003621#if defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3622 status = mbedtls_to_psa_error(
3623 mbedtls_ecdsa_sign_det_restartable(&operation->ctx->grp,
Paul Elliott46845252023-02-03 14:59:11 +00003624 &r,
3625 &s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003626 &operation->ctx->d,
3627 operation->hash,
3628 operation->hash_length,
3629 operation->md_alg,
3630 mbedtls_psa_get_random,
3631 MBEDTLS_PSA_RANDOM_STATE,
3632 &operation->restart_ctx));
3633#else /* defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Paul Elliott724bd252023-02-08 12:35:08 +00003634 status = PSA_ERROR_NOT_SUPPORTED;
3635 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003636#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
3637 } else {
Paul Elliott588f8ed2022-12-02 18:10:26 +00003638 status = mbedtls_to_psa_error(
3639 mbedtls_ecdsa_sign_restartable(&operation->ctx->grp,
Paul Elliott46845252023-02-03 14:59:11 +00003640 &r,
3641 &s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003642 &operation->ctx->d,
3643 operation->hash,
3644 operation->hash_length,
3645 mbedtls_psa_get_random,
3646 MBEDTLS_PSA_RANDOM_STATE,
3647 mbedtls_psa_get_random,
3648 MBEDTLS_PSA_RANDOM_STATE,
3649 &operation->restart_ctx));
3650 }
3651
Paul Elliottf8e5b562023-02-19 18:43:45 +00003652 /* Hide the fact that the restart context only holds a delta of number of
3653 * ops done during the last operation, not an absolute value. */
3654 operation->num_ops += operation->restart_ctx.ecp.ops_done;
3655
Paul Elliott724bd252023-02-08 12:35:08 +00003656 if (status == PSA_SUCCESS) {
Paul Elliott588f8ed2022-12-02 18:10:26 +00003657 status = mbedtls_to_psa_error(
Paul Elliott46845252023-02-03 14:59:11 +00003658 mbedtls_mpi_write_binary(&r,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003659 signature,
Paul Elliott1bc59df2023-02-05 13:41:57 +00003660 operation->coordinate_bytes)
3661 );
Paul Elliott588f8ed2022-12-02 18:10:26 +00003662
3663 if (status != PSA_SUCCESS) {
Paul Elliott724bd252023-02-08 12:35:08 +00003664 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003665 }
3666
3667 status = mbedtls_to_psa_error(
Paul Elliott46845252023-02-03 14:59:11 +00003668 mbedtls_mpi_write_binary(&s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003669 signature +
Paul Elliott1bc59df2023-02-05 13:41:57 +00003670 operation->coordinate_bytes,
3671 operation->coordinate_bytes)
3672 );
Paul Elliott588f8ed2022-12-02 18:10:26 +00003673
3674 if (status != PSA_SUCCESS) {
Paul Elliott724bd252023-02-08 12:35:08 +00003675 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003676 }
3677
Paul Elliott1bc59df2023-02-05 13:41:57 +00003678 *signature_length = operation->coordinate_bytes * 2;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003679
Paul Elliott724bd252023-02-08 12:35:08 +00003680 status = PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003681 }
Paul Elliott724bd252023-02-08 12:35:08 +00003682
3683exit:
3684
3685 mbedtls_mpi_free(&r);
3686 mbedtls_mpi_free(&s);
3687 return status;
3688
Paul Elliott588f8ed2022-12-02 18:10:26 +00003689 #else
3690
3691 (void) operation;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003692 (void) signature;
3693 (void) signature_size;
3694 (void) signature_length;
3695
3696 return PSA_ERROR_NOT_SUPPORTED;
3697
3698#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3699 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3700 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3701}
3702
3703psa_status_t mbedtls_psa_sign_hash_abort(
3704 mbedtls_psa_sign_hash_interruptible_operation_t *operation)
3705{
3706
3707#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3708 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3709 defined(MBEDTLS_ECP_RESTARTABLE)
3710
3711 if (operation->ctx) {
3712 mbedtls_ecdsa_free(operation->ctx);
3713 mbedtls_free(operation->ctx);
Paul Elliottf9c91a72023-02-05 18:06:38 +00003714 operation->ctx = NULL;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003715 }
3716
3717 mbedtls_ecdsa_restart_free(&operation->restart_ctx);
3718
Paul Elliott93d9ca82023-02-15 18:14:21 +00003719 operation->num_ops = 0;
3720
Paul Elliott588f8ed2022-12-02 18:10:26 +00003721 return PSA_SUCCESS;
3722
3723#else
3724
3725 (void) operation;
3726
3727 return PSA_ERROR_NOT_SUPPORTED;
3728
3729#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3730 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3731 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3732}
3733
3734psa_status_t mbedtls_psa_verify_hash_start(
3735 mbedtls_psa_verify_hash_interruptible_operation_t *operation,
3736 const psa_key_attributes_t *attributes,
3737 const uint8_t *key_buffer, size_t key_buffer_size,
3738 psa_algorithm_t alg,
3739 const uint8_t *hash, size_t hash_length,
3740 const uint8_t *signature, size_t signature_length)
3741{
3742 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott1bc59df2023-02-05 13:41:57 +00003743 size_t coordinate_bytes = 0;
Paul Elliott0290a762023-02-09 14:30:24 +00003744 size_t required_hash_length = 0;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003745
Paul Elliott068fe072023-01-16 13:59:15 +00003746 if (!PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3747 return PSA_ERROR_NOT_SUPPORTED;
3748 }
3749
3750 if (!PSA_ALG_IS_ECDSA(alg)) {
Paul Elliott813f9cd2023-02-05 15:28:46 +00003751 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott068fe072023-01-16 13:59:15 +00003752 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003753
3754#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Paul Elliott068fe072023-01-16 13:59:15 +00003755 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3756 defined(MBEDTLS_ECP_RESTARTABLE)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003757
Paul Elliotta1c94092023-02-15 16:38:04 +00003758 mbedtls_ecdsa_restart_init(&operation->restart_ctx);
3759 mbedtls_mpi_init(&operation->r);
3760 mbedtls_mpi_init(&operation->s);
3761
Paul Elliott93d9ca82023-02-15 18:14:21 +00003762 /* Ensure num_ops is zero'ed in case of context re-use. */
3763 operation->num_ops = 0;
3764
Paul Elliott068fe072023-01-16 13:59:15 +00003765 status = mbedtls_psa_ecp_load_representation(attributes->core.type,
3766 attributes->core.bits,
3767 key_buffer,
3768 key_buffer_size,
3769 &operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003770
Paul Elliott068fe072023-01-16 13:59:15 +00003771 if (status != PSA_SUCCESS) {
3772 return status;
3773 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003774
Paul Elliottc569fc22023-02-10 13:02:54 +00003775 coordinate_bytes = PSA_BITS_TO_BYTES(operation->ctx->grp.nbits);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003776
Paul Elliott1bc59df2023-02-05 13:41:57 +00003777 if (signature_length != 2 * coordinate_bytes) {
Paul Elliott068fe072023-01-16 13:59:15 +00003778 return PSA_ERROR_INVALID_SIGNATURE;
3779 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003780
Paul Elliott068fe072023-01-16 13:59:15 +00003781 status = mbedtls_to_psa_error(
3782 mbedtls_mpi_read_binary(&operation->r,
3783 signature,
Paul Elliott1bc59df2023-02-05 13:41:57 +00003784 coordinate_bytes));
Paul Elliott588f8ed2022-12-02 18:10:26 +00003785
Paul Elliott068fe072023-01-16 13:59:15 +00003786 if (status != PSA_SUCCESS) {
3787 return status;
3788 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003789
Paul Elliott068fe072023-01-16 13:59:15 +00003790 status = mbedtls_to_psa_error(
3791 mbedtls_mpi_read_binary(&operation->s,
3792 signature +
Paul Elliott1bc59df2023-02-05 13:41:57 +00003793 coordinate_bytes,
3794 coordinate_bytes));
Paul Elliott588f8ed2022-12-02 18:10:26 +00003795
Paul Elliott068fe072023-01-16 13:59:15 +00003796 if (status != PSA_SUCCESS) {
3797 return status;
3798 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003799
Paul Elliott2c9843f2023-02-15 17:32:42 +00003800 status = mbedtls_psa_ecp_load_public_part(operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003801
Paul Elliott2c9843f2023-02-15 17:32:42 +00003802 if (status != PSA_SUCCESS) {
3803 return status;
Paul Elliott068fe072023-01-16 13:59:15 +00003804 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003805
Paul Elliott0290a762023-02-09 14:30:24 +00003806 /* We only need to store the same length of hash as the private key size
3807 * here, it would be truncated by the internal implementation anyway. */
3808 required_hash_length = (hash_length < coordinate_bytes ? hash_length :
3809 coordinate_bytes);
3810
Paul Elliottba70ad42023-02-15 18:23:53 +00003811 if (required_hash_length > sizeof(operation->hash)) {
3812 /* Shouldn't happen, but better safe than sorry. */
3813 return PSA_ERROR_CORRUPTION_DETECTED;
3814 }
3815
Paul Elliott0290a762023-02-09 14:30:24 +00003816 memcpy(operation->hash, hash, required_hash_length);
3817 operation->hash_length = required_hash_length;
Paul Elliott068fe072023-01-16 13:59:15 +00003818
3819 return PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003820#else
Paul Elliott068fe072023-01-16 13:59:15 +00003821 (void) operation;
3822 (void) key_buffer;
3823 (void) key_buffer_size;
3824 (void) alg;
3825 (void) hash;
3826 (void) hash_length;
3827 (void) signature;
3828 (void) signature_length;
3829 (void) status;
Paul Elliott1243f932023-02-07 11:21:10 +00003830 (void) coordinate_bytes;
Paul Elliott0290a762023-02-09 14:30:24 +00003831 (void) required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003832
Paul Elliott068fe072023-01-16 13:59:15 +00003833 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003834#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3835 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3836 * defined( MBEDTLS_ECP_RESTARTABLE ) */
Paul Elliott588f8ed2022-12-02 18:10:26 +00003837}
3838
3839psa_status_t mbedtls_psa_verify_hash_complete(
3840 mbedtls_psa_verify_hash_interruptible_operation_t *operation)
3841{
3842
3843#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3844 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3845 defined(MBEDTLS_ECP_RESTARTABLE)
3846
Paul Elliottf8e5b562023-02-19 18:43:45 +00003847 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3848
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003849 /* Ensure max_ops is set to the current value (or default). */
3850 mbedtls_psa_interruptible_set_max_ops(psa_interruptible_get_max_ops());
3851
Paul Elliottf8e5b562023-02-19 18:43:45 +00003852 status = mbedtls_to_psa_error(
Paul Elliott588f8ed2022-12-02 18:10:26 +00003853 mbedtls_ecdsa_verify_restartable(&operation->ctx->grp,
3854 operation->hash,
3855 operation->hash_length,
3856 &operation->ctx->Q,
3857 &operation->r,
3858 &operation->s,
3859 &operation->restart_ctx));
3860
Paul Elliottf8e5b562023-02-19 18:43:45 +00003861 /* Hide the fact that the restart context only holds a delta of number of
3862 * ops done during the last operation, not an absolute value. */
3863 operation->num_ops += operation->restart_ctx.ecp.ops_done;
3864
3865 return status;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003866#else
3867 (void) operation;
3868
3869 return PSA_ERROR_NOT_SUPPORTED;
3870
3871#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3872 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3873 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3874}
3875
3876psa_status_t mbedtls_psa_verify_hash_abort(
3877 mbedtls_psa_verify_hash_interruptible_operation_t *operation)
3878{
3879
3880#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3881 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3882 defined(MBEDTLS_ECP_RESTARTABLE)
3883
3884 if (operation->ctx) {
3885 mbedtls_ecdsa_free(operation->ctx);
3886 mbedtls_free(operation->ctx);
Paul Elliottf9c91a72023-02-05 18:06:38 +00003887 operation->ctx = NULL;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003888 }
3889
3890 mbedtls_ecdsa_restart_free(&operation->restart_ctx);
3891
Paul Elliott93d9ca82023-02-15 18:14:21 +00003892 operation->num_ops = 0;
3893
Paul Elliott588f8ed2022-12-02 18:10:26 +00003894 mbedtls_mpi_free(&operation->r);
3895 mbedtls_mpi_free(&operation->s);
3896
3897 return PSA_SUCCESS;
3898
3899#else
3900 (void) operation;
3901
3902 return PSA_ERROR_NOT_SUPPORTED;
3903
3904#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3905 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3906 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3907}
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003908
mohammad1603503973b2018-03-12 15:59:30 +02003909/****************************************************************/
3910/* Symmetric cryptography */
3911/****************************************************************/
3912
Gilles Peskine449bd832023-01-11 14:50:10 +01003913static psa_status_t psa_cipher_setup(psa_cipher_operation_t *operation,
3914 mbedtls_svc_key_id_t key,
3915 psa_algorithm_t alg,
3916 mbedtls_operation_t cipher_operation)
Ronald Cronab99ac22020-10-01 16:38:28 +02003917{
3918 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3919 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman54648242021-06-24 11:49:45 +01003920 psa_key_slot_t *slot = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01003921 psa_key_usage_t usage = (cipher_operation == MBEDTLS_ENCRYPT ?
3922 PSA_KEY_USAGE_ENCRYPT :
3923 PSA_KEY_USAGE_DECRYPT);
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003924 psa_key_attributes_t attributes;
Ronald Cronab99ac22020-10-01 16:38:28 +02003925
3926 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003927 if (operation->id != 0) {
Dave Rodgman54648242021-06-24 11:49:45 +01003928 status = PSA_ERROR_BAD_STATE;
3929 goto exit;
3930 }
Ronald Cronab99ac22020-10-01 16:38:28 +02003931
Gilles Peskine449bd832023-01-11 14:50:10 +01003932 if (!PSA_ALG_IS_CIPHER(alg)) {
Dave Rodgman54648242021-06-24 11:49:45 +01003933 status = PSA_ERROR_INVALID_ARGUMENT;
3934 goto exit;
3935 }
Ronald Cronab99ac22020-10-01 16:38:28 +02003936
Gilles Peskine449bd832023-01-11 14:50:10 +01003937 status = psa_get_and_lock_key_slot_with_policy(key, &slot, usage, alg);
3938 if (status != PSA_SUCCESS) {
Ronald Cronab99ac22020-10-01 16:38:28 +02003939 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01003940 }
Ronald Cronab99ac22020-10-01 16:38:28 +02003941
Ronald Cron49fafa92021-03-10 08:34:23 +01003942 /* Initialize the operation struct members, except for id. The id member
Ronald Cronab99ac22020-10-01 16:38:28 +02003943 * is used to indicate to psa_cipher_abort that there are resources to free,
Ronald Cron49fafa92021-03-10 08:34:23 +01003944 * so we only set it (in the driver wrapper) after resources have been
3945 * allocated/initialized. */
Ronald Cronab99ac22020-10-01 16:38:28 +02003946 operation->iv_set = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01003947 if (alg == PSA_ALG_ECB_NO_PADDING) {
Ronald Cronab99ac22020-10-01 16:38:28 +02003948 operation->iv_required = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01003949 } else {
Ronald Cronab99ac22020-10-01 16:38:28 +02003950 operation->iv_required = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003951 }
3952 operation->default_iv_length = PSA_CIPHER_IV_LENGTH(slot->attr.type, alg);
Ronald Cronab99ac22020-10-01 16:38:28 +02003953
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003954 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01003955 .core = slot->attr
Ronald Crona4af55f2020-12-14 14:36:06 +01003956 };
3957
Ronald Cronab99ac22020-10-01 16:38:28 +02003958 /* Try doing the operation through a driver before using software fallback. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003959 if (cipher_operation == MBEDTLS_ENCRYPT) {
3960 status = psa_driver_wrapper_cipher_encrypt_setup(operation,
3961 &attributes,
3962 slot->key.data,
3963 slot->key.bytes,
3964 alg);
3965 } else {
3966 status = psa_driver_wrapper_cipher_decrypt_setup(operation,
3967 &attributes,
3968 slot->key.data,
3969 slot->key.bytes,
3970 alg);
3971 }
Ronald Cronab99ac22020-10-01 16:38:28 +02003972
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003973exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01003974 if (status != PSA_SUCCESS) {
3975 psa_cipher_abort(operation);
3976 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003977
Gilles Peskine449bd832023-01-11 14:50:10 +01003978 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003979
Gilles Peskine449bd832023-01-11 14:50:10 +01003980 return (status == PSA_SUCCESS) ? unlock_status : status;
mohammad1603503973b2018-03-12 15:59:30 +02003981}
3982
Gilles Peskine449bd832023-01-11 14:50:10 +01003983psa_status_t psa_cipher_encrypt_setup(psa_cipher_operation_t *operation,
3984 mbedtls_svc_key_id_t key,
3985 psa_algorithm_t alg)
mohammad16038481e742018-03-18 13:57:31 +02003986{
Gilles Peskine449bd832023-01-11 14:50:10 +01003987 return psa_cipher_setup(operation, key, alg, MBEDTLS_ENCRYPT);
mohammad16038481e742018-03-18 13:57:31 +02003988}
3989
Gilles Peskine449bd832023-01-11 14:50:10 +01003990psa_status_t psa_cipher_decrypt_setup(psa_cipher_operation_t *operation,
3991 mbedtls_svc_key_id_t key,
3992 psa_algorithm_t alg)
mohammad16038481e742018-03-18 13:57:31 +02003993{
Gilles Peskine449bd832023-01-11 14:50:10 +01003994 return psa_cipher_setup(operation, key, alg, MBEDTLS_DECRYPT);
mohammad16038481e742018-03-18 13:57:31 +02003995}
3996
Gilles Peskine449bd832023-01-11 14:50:10 +01003997psa_status_t psa_cipher_generate_iv(psa_cipher_operation_t *operation,
3998 uint8_t *iv,
3999 size_t iv_size,
4000 size_t *iv_length)
mohammad1603503973b2018-03-12 15:59:30 +02004001{
Ronald Cron6d051732020-10-01 14:10:20 +02004002 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2fb90522021-07-05 12:31:44 +02004003 uint8_t local_iv[PSA_CIPHER_IV_MAX_SIZE];
Sergeybef1f632023-03-06 15:25:06 -07004004 size_t default_iv_length = 0;
Ronald Cron5618a392021-03-26 09:52:26 +01004005
Gilles Peskine449bd832023-01-11 14:50:10 +01004006 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004007 status = PSA_ERROR_BAD_STATE;
4008 goto exit;
Ronald Cronc45b4af2020-09-29 16:18:05 +02004009 }
4010
Gilles Peskine449bd832023-01-11 14:50:10 +01004011 if (operation->iv_set || !operation->iv_required) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004012 status = PSA_ERROR_BAD_STATE;
4013 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004014 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004015
Ronald Cron2fb90522021-07-05 12:31:44 +02004016 default_iv_length = operation->default_iv_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01004017 if (iv_size < default_iv_length) {
Ronald Cron5618a392021-03-26 09:52:26 +01004018 status = PSA_ERROR_BUFFER_TOO_SMALL;
4019 goto exit;
4020 }
Gilles Peskinee553c652018-06-04 16:22:46 +02004021
Gilles Peskine449bd832023-01-11 14:50:10 +01004022 if (default_iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Ronald Cron2fb90522021-07-05 12:31:44 +02004023 status = PSA_ERROR_GENERIC_ERROR;
4024 goto exit;
4025 }
4026
Gilles Peskine449bd832023-01-11 14:50:10 +01004027 status = psa_generate_random(local_iv, default_iv_length);
4028 if (status != PSA_SUCCESS) {
Ronald Cron5618a392021-03-26 09:52:26 +01004029 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004030 }
Ronald Cron5618a392021-03-26 09:52:26 +01004031
Gilles Peskine449bd832023-01-11 14:50:10 +01004032 status = psa_driver_wrapper_cipher_set_iv(operation,
4033 local_iv, default_iv_length);
Ronald Cron5618a392021-03-26 09:52:26 +01004034
4035exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004036 if (status == PSA_SUCCESS) {
4037 memcpy(iv, local_iv, default_iv_length);
Ronald Cron2fb90522021-07-05 12:31:44 +02004038 *iv_length = default_iv_length;
Steven Cooreman7df02922020-09-09 15:28:49 +02004039 operation->iv_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004040 } else {
Ronald Cron2fb90522021-07-05 12:31:44 +02004041 *iv_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004042 psa_cipher_abort(operation);
Ronald Cron2fb90522021-07-05 12:31:44 +02004043 }
Ronald Cron6d051732020-10-01 14:10:20 +02004044
Gilles Peskine449bd832023-01-11 14:50:10 +01004045 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004046}
4047
Gilles Peskine449bd832023-01-11 14:50:10 +01004048psa_status_t psa_cipher_set_iv(psa_cipher_operation_t *operation,
4049 const uint8_t *iv,
4050 size_t iv_length)
mohammad1603503973b2018-03-12 15:59:30 +02004051{
Ronald Cron6d051732020-10-01 14:10:20 +02004052 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronc45b4af2020-09-29 16:18:05 +02004053
Gilles Peskine449bd832023-01-11 14:50:10 +01004054 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004055 status = PSA_ERROR_BAD_STATE;
4056 goto exit;
4057 }
Ronald Cronc45b4af2020-09-29 16:18:05 +02004058
Gilles Peskine449bd832023-01-11 14:50:10 +01004059 if (operation->iv_set || !operation->iv_required) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004060 status = PSA_ERROR_BAD_STATE;
4061 goto exit;
4062 }
Ronald Crona0d68172021-03-26 10:15:08 +01004063
Gilles Peskine449bd832023-01-11 14:50:10 +01004064 if (iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004065 status = PSA_ERROR_INVALID_ARGUMENT;
4066 goto exit;
4067 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004068
Gilles Peskine449bd832023-01-11 14:50:10 +01004069 status = psa_driver_wrapper_cipher_set_iv(operation,
4070 iv,
4071 iv_length);
Steven Cooremand3feccd2020-09-01 15:56:14 +02004072
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004073exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004074 if (status == PSA_SUCCESS) {
itayzafrir534bd7c2018-08-02 13:56:32 +03004075 operation->iv_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004076 } else {
4077 psa_cipher_abort(operation);
4078 }
4079 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004080}
4081
Gilles Peskine449bd832023-01-11 14:50:10 +01004082psa_status_t psa_cipher_update(psa_cipher_operation_t *operation,
4083 const uint8_t *input,
4084 size_t input_length,
4085 uint8_t *output,
4086 size_t output_size,
4087 size_t *output_length)
mohammad1603503973b2018-03-12 15:59:30 +02004088{
Steven Cooremanffecb7b2020-08-25 15:13:13 +02004089 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron6d051732020-10-01 14:10:20 +02004090
Gilles Peskine449bd832023-01-11 14:50:10 +01004091 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004092 status = PSA_ERROR_BAD_STATE;
4093 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004094 }
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004095
Gilles Peskine449bd832023-01-11 14:50:10 +01004096 if (operation->iv_required && !operation->iv_set) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004097 status = PSA_ERROR_BAD_STATE;
4098 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004099 }
Jaeden Ameroab439972019-02-15 14:12:05 +00004100
Gilles Peskine449bd832023-01-11 14:50:10 +01004101 status = psa_driver_wrapper_cipher_update(operation,
4102 input,
4103 input_length,
4104 output,
4105 output_size,
4106 output_length);
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004107
4108exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004109 if (status != PSA_SUCCESS) {
4110 psa_cipher_abort(operation);
4111 }
Ronald Cron6d051732020-10-01 14:10:20 +02004112
Gilles Peskine449bd832023-01-11 14:50:10 +01004113 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004114}
4115
Gilles Peskine449bd832023-01-11 14:50:10 +01004116psa_status_t psa_cipher_finish(psa_cipher_operation_t *operation,
4117 uint8_t *output,
4118 size_t output_size,
4119 size_t *output_length)
mohammad1603503973b2018-03-12 15:59:30 +02004120{
David Saadab4ecc272019-02-14 13:48:10 +02004121 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Ronald Cron6d051732020-10-01 14:10:20 +02004122
Gilles Peskine449bd832023-01-11 14:50:10 +01004123 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004124 status = PSA_ERROR_BAD_STATE;
4125 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004126 }
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004127
Gilles Peskine449bd832023-01-11 14:50:10 +01004128 if (operation->iv_required && !operation->iv_set) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004129 status = PSA_ERROR_BAD_STATE;
4130 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004131 }
Moran Pekerbed71a22018-04-22 20:19:20 +03004132
Gilles Peskine449bd832023-01-11 14:50:10 +01004133 status = psa_driver_wrapper_cipher_finish(operation,
4134 output,
4135 output_size,
4136 output_length);
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004137
4138exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004139 if (status == PSA_SUCCESS) {
4140 return psa_cipher_abort(operation);
4141 } else {
Steven Cooremanef8575e2020-09-11 11:44:50 +02004142 *output_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004143 (void) psa_cipher_abort(operation);
Janos Follath315b51c2018-07-09 16:04:51 +01004144
Gilles Peskine449bd832023-01-11 14:50:10 +01004145 return status;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004146 }
mohammad1603503973b2018-03-12 15:59:30 +02004147}
4148
Gilles Peskine449bd832023-01-11 14:50:10 +01004149psa_status_t psa_cipher_abort(psa_cipher_operation_t *operation)
Gilles Peskinee553c652018-06-04 16:22:46 +02004150{
Gilles Peskine449bd832023-01-11 14:50:10 +01004151 if (operation->id == 0) {
Steven Cooremana07b9972020-09-10 14:54:14 +02004152 /* The object has (apparently) been initialized but it is not (yet)
Gilles Peskine81736312018-06-26 15:04:31 +02004153 * in use. It's ok to call abort on such an object, and there's
4154 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004155 return PSA_SUCCESS;
Gilles Peskine81736312018-06-26 15:04:31 +02004156 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004157
Gilles Peskine449bd832023-01-11 14:50:10 +01004158 psa_driver_wrapper_cipher_abort(operation);
Gilles Peskinee553c652018-06-04 16:22:46 +02004159
Ronald Cron49fafa92021-03-10 08:34:23 +01004160 operation->id = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004161 operation->iv_set = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004162 operation->iv_required = 0;
Moran Peker41deec42018-04-04 15:43:05 +03004163
Gilles Peskine449bd832023-01-11 14:50:10 +01004164 return PSA_SUCCESS;
mohammad1603503973b2018-03-12 15:59:30 +02004165}
4166
Gilles Peskine449bd832023-01-11 14:50:10 +01004167psa_status_t psa_cipher_encrypt(mbedtls_svc_key_id_t key,
4168 psa_algorithm_t alg,
4169 const uint8_t *input,
4170 size_t input_length,
4171 uint8_t *output,
4172 size_t output_size,
4173 size_t *output_length)
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004174{
4175 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004176 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron23919522021-07-08 19:00:07 +02004177 psa_key_slot_t *slot = NULL;
Ronald Cronc6e6f502021-07-09 18:44:58 +02004178 uint8_t local_iv[PSA_CIPHER_IV_MAX_SIZE];
4179 size_t default_iv_length = 0;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004180 psa_key_attributes_t attributes;
gabor-mezei-arm6f4e5bb2021-06-25 15:21:11 +02004181
Gilles Peskine449bd832023-01-11 14:50:10 +01004182 if (!PSA_ALG_IS_CIPHER(alg)) {
Ronald Cron23919522021-07-08 19:00:07 +02004183 status = PSA_ERROR_INVALID_ARGUMENT;
4184 goto exit;
4185 }
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004186
Gilles Peskine449bd832023-01-11 14:50:10 +01004187 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
4188 PSA_KEY_USAGE_ENCRYPT,
4189 alg);
4190 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004191 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004192 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004193
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004194 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004195 .core = slot->attr
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004196 };
4197
Gilles Peskine449bd832023-01-11 14:50:10 +01004198 default_iv_length = PSA_CIPHER_IV_LENGTH(slot->attr.type, alg);
4199 if (default_iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Ronald Cronc6e6f502021-07-09 18:44:58 +02004200 status = PSA_ERROR_GENERIC_ERROR;
4201 goto exit;
4202 }
4203
Gilles Peskine449bd832023-01-11 14:50:10 +01004204 if (default_iv_length > 0) {
4205 if (output_size < default_iv_length) {
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004206 status = PSA_ERROR_BUFFER_TOO_SMALL;
4207 goto exit;
4208 }
4209
Gilles Peskine449bd832023-01-11 14:50:10 +01004210 status = psa_generate_random(local_iv, default_iv_length);
4211 if (status != PSA_SUCCESS) {
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004212 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004213 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004214 }
4215
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004216 status = psa_driver_wrapper_cipher_encrypt(
4217 &attributes, slot->key.data, slot->key.bytes,
Ronald Cronc6e6f502021-07-09 18:44:58 +02004218 alg, local_iv, default_iv_length, input, input_length,
Ronald Cronafbc7ed2023-01-24 16:02:04 +01004219 psa_crypto_buffer_offset(output, default_iv_length),
Gilles Peskine449bd832023-01-11 14:50:10 +01004220 output_size - default_iv_length, output_length);
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004221
4222exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004223 unlock_status = psa_unlock_key_slot(slot);
4224 if (status == PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004225 status = unlock_status;
Ronald Cronc6e6f502021-07-09 18:44:58 +02004226 }
Ronald Cron23919522021-07-08 19:00:07 +02004227
Gilles Peskine449bd832023-01-11 14:50:10 +01004228 if (status == PSA_SUCCESS) {
4229 if (default_iv_length > 0) {
4230 memcpy(output, local_iv, default_iv_length);
4231 }
4232 *output_length += default_iv_length;
4233 } else {
4234 *output_length = 0;
4235 }
4236
4237 return status;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004238}
4239
Gilles Peskine449bd832023-01-11 14:50:10 +01004240psa_status_t psa_cipher_decrypt(mbedtls_svc_key_id_t key,
4241 psa_algorithm_t alg,
4242 const uint8_t *input,
4243 size_t input_length,
4244 uint8_t *output,
4245 size_t output_size,
4246 size_t *output_length)
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004247{
4248 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004249 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron23919522021-07-08 19:00:07 +02004250 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004251 psa_key_attributes_t attributes;
gabor-mezei-arm6f4e5bb2021-06-25 15:21:11 +02004252
Gilles Peskine449bd832023-01-11 14:50:10 +01004253 if (!PSA_ALG_IS_CIPHER(alg)) {
Ronald Cron23919522021-07-08 19:00:07 +02004254 status = PSA_ERROR_INVALID_ARGUMENT;
4255 goto exit;
4256 }
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004257
Gilles Peskine449bd832023-01-11 14:50:10 +01004258 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
4259 PSA_KEY_USAGE_DECRYPT,
4260 alg);
4261 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004262 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004263 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004264
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004265 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004266 .core = slot->attr
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004267 };
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004268
Gilles Peskine449bd832023-01-11 14:50:10 +01004269 if (alg == PSA_ALG_CCM_STAR_NO_TAG &&
4270 input_length < PSA_BLOCK_CIPHER_BLOCK_LENGTH(slot->attr.type)) {
Mateusz Starzyk594215b2021-10-14 12:23:06 +02004271 status = PSA_ERROR_INVALID_ARGUMENT;
4272 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004273 } else if (input_length < PSA_CIPHER_IV_LENGTH(slot->attr.type, alg)) {
gabor-mezei-arm258ae072021-06-25 15:25:38 +02004274 status = PSA_ERROR_INVALID_ARGUMENT;
4275 goto exit;
4276 }
4277
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004278 status = psa_driver_wrapper_cipher_decrypt(
4279 &attributes, slot->key.data, slot->key.bytes,
4280 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004281 output, output_size, output_length);
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004282
gabor-mezei-arm258ae072021-06-25 15:25:38 +02004283exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004284 unlock_status = psa_unlock_key_slot(slot);
4285 if (status == PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004286 status = unlock_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01004287 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004288
Gilles Peskine449bd832023-01-11 14:50:10 +01004289 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004290 *output_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004291 }
Ronald Cron23919522021-07-08 19:00:07 +02004292
Gilles Peskine449bd832023-01-11 14:50:10 +01004293 return status;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004294}
4295
4296
mohammad16035955c982018-04-26 00:53:03 +03004297/****************************************************************/
4298/* AEAD */
4299/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004300
Paul Elliottbaff51c2021-09-28 17:44:45 +01004301/* Helper function to get the base algorithm from its variants. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004302static psa_algorithm_t psa_aead_get_base_algorithm(psa_algorithm_t alg)
Paul Elliottbaff51c2021-09-28 17:44:45 +01004303{
Gilles Peskine449bd832023-01-11 14:50:10 +01004304 return PSA_ALG_AEAD_WITH_DEFAULT_LENGTH_TAG(alg);
Paul Elliottbaff51c2021-09-28 17:44:45 +01004305}
4306
4307/* Helper function to perform common nonce length checks. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004308static psa_status_t psa_aead_check_nonce_length(psa_algorithm_t alg,
4309 size_t nonce_length)
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004310{
Gilles Peskine449bd832023-01-11 14:50:10 +01004311 psa_algorithm_t base_alg = psa_aead_get_base_algorithm(alg);
Paul Elliottbaff51c2021-09-28 17:44:45 +01004312
Gilles Peskine449bd832023-01-11 14:50:10 +01004313 switch (base_alg) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004314#if defined(PSA_WANT_ALG_GCM)
4315 case PSA_ALG_GCM:
4316 /* Not checking max nonce size here as GCM spec allows almost
Gilles Peskine449bd832023-01-11 14:50:10 +01004317 * arbitrarily large nonces. Please note that we do not generally
4318 * recommend the usage of nonces of greater length than
4319 * PSA_AEAD_NONCE_MAX_SIZE, as large nonces are hashed to a shorter
4320 * size, which can then lead to collisions if you encrypt a very
4321 * large number of messages.*/
4322 if (nonce_length != 0) {
4323 return PSA_SUCCESS;
4324 }
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004325 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004326#endif /* PSA_WANT_ALG_GCM */
4327#if defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004328 case PSA_ALG_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01004329 if (nonce_length >= 7 && nonce_length <= 13) {
4330 return PSA_SUCCESS;
4331 }
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004332 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004333#endif /* PSA_WANT_ALG_CCM */
4334#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004335 case PSA_ALG_CHACHA20_POLY1305:
Gilles Peskine449bd832023-01-11 14:50:10 +01004336 if (nonce_length == 12) {
4337 return PSA_SUCCESS;
4338 } else if (nonce_length == 8) {
4339 return PSA_ERROR_NOT_SUPPORTED;
4340 }
Bence Szépkúti6d48e202021-11-15 20:04:15 +01004341 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004342#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004343 default:
Przemek Stekiel4c499272022-09-27 13:55:37 +02004344 (void) nonce_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01004345 return PSA_ERROR_NOT_SUPPORTED;
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004346 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004347
Gilles Peskine449bd832023-01-11 14:50:10 +01004348 return PSA_ERROR_INVALID_ARGUMENT;
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004349}
4350
Gilles Peskine449bd832023-01-11 14:50:10 +01004351static psa_status_t psa_aead_check_algorithm(psa_algorithm_t alg)
Bence Szépkútiaa3a6e42022-01-13 16:26:03 +01004352{
Gilles Peskine449bd832023-01-11 14:50:10 +01004353 if (!PSA_ALG_IS_AEAD(alg) || PSA_ALG_IS_WILDCARD(alg)) {
4354 return PSA_ERROR_INVALID_ARGUMENT;
4355 }
Bence Szépkúti08f34652021-12-08 21:07:13 +01004356
Gilles Peskine449bd832023-01-11 14:50:10 +01004357 return PSA_SUCCESS;
Bence Szépkúti08f34652021-12-08 21:07:13 +01004358}
4359
Gilles Peskine449bd832023-01-11 14:50:10 +01004360psa_status_t psa_aead_encrypt(mbedtls_svc_key_id_t key,
4361 psa_algorithm_t alg,
4362 const uint8_t *nonce,
4363 size_t nonce_length,
4364 const uint8_t *additional_data,
4365 size_t additional_data_length,
4366 const uint8_t *plaintext,
4367 size_t plaintext_length,
4368 uint8_t *ciphertext,
4369 size_t ciphertext_size,
4370 size_t *ciphertext_length)
mohammad16035955c982018-04-26 00:53:03 +03004371{
Ronald Cron215633c2021-03-16 17:15:37 +01004372 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4373 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02004374
mohammad1603f08a5502018-06-03 15:05:47 +03004375 *ciphertext_length = 0;
mohammad1603e58e6842018-05-09 04:58:32 -07004376
Gilles Peskine449bd832023-01-11 14:50:10 +01004377 status = psa_aead_check_algorithm(alg);
4378 if (status != PSA_SUCCESS) {
4379 return status;
4380 }
Steven Cooremanea7ab132021-03-17 16:28:00 +01004381
Ronald Cron9a986162021-03-26 12:40:07 +01004382 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01004383 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg);
4384 if (status != PSA_SUCCESS) {
4385 return status;
4386 }
mohammad16035955c982018-04-26 00:53:03 +03004387
Ronald Cron215633c2021-03-16 17:15:37 +01004388 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01004389 .core = slot->attr
Ronald Cron215633c2021-03-16 17:15:37 +01004390 };
mohammad16035955c982018-04-26 00:53:03 +03004391
Gilles Peskine449bd832023-01-11 14:50:10 +01004392 status = psa_aead_check_nonce_length(alg, nonce_length);
4393 if (status != PSA_SUCCESS) {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004394 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004395 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004396
Ronald Cronde822812021-03-17 16:08:20 +01004397 status = psa_driver_wrapper_aead_encrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01004398 &attributes, slot->key.data, slot->key.bytes,
4399 alg,
4400 nonce, nonce_length,
4401 additional_data, additional_data_length,
4402 plaintext, plaintext_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004403 ciphertext, ciphertext_size, ciphertext_length);
Gilles Peskine2d277862018-06-18 15:41:12 +02004404
Gilles Peskine449bd832023-01-11 14:50:10 +01004405 if (status != PSA_SUCCESS && ciphertext_size != 0) {
4406 memset(ciphertext, 0, ciphertext_size);
4407 }
Gilles Peskine2d277862018-06-18 15:41:12 +02004408
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004409exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004410 psa_unlock_key_slot(slot);
mohammad16035955c982018-04-26 00:53:03 +03004411
Gilles Peskine449bd832023-01-11 14:50:10 +01004412 return status;
Gilles Peskineee652a32018-06-01 19:23:52 +02004413}
4414
Gilles Peskine449bd832023-01-11 14:50:10 +01004415psa_status_t psa_aead_decrypt(mbedtls_svc_key_id_t key,
4416 psa_algorithm_t alg,
4417 const uint8_t *nonce,
4418 size_t nonce_length,
4419 const uint8_t *additional_data,
4420 size_t additional_data_length,
4421 const uint8_t *ciphertext,
4422 size_t ciphertext_length,
4423 uint8_t *plaintext,
4424 size_t plaintext_size,
4425 size_t *plaintext_length)
mohammad16035955c982018-04-26 00:53:03 +03004426{
Ronald Cron215633c2021-03-16 17:15:37 +01004427 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4428 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02004429
Gilles Peskineee652a32018-06-01 19:23:52 +02004430 *plaintext_length = 0;
mohammad16039e5a5152018-04-26 12:07:35 +03004431
Gilles Peskine449bd832023-01-11 14:50:10 +01004432 status = psa_aead_check_algorithm(alg);
4433 if (status != PSA_SUCCESS) {
4434 return status;
4435 }
Steven Cooremanea7ab132021-03-17 16:28:00 +01004436
Ronald Cron9a986162021-03-26 12:40:07 +01004437 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01004438 key, &slot, PSA_KEY_USAGE_DECRYPT, alg);
4439 if (status != PSA_SUCCESS) {
4440 return status;
4441 }
mohammad16035955c982018-04-26 00:53:03 +03004442
Ronald Cron215633c2021-03-16 17:15:37 +01004443 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01004444 .core = slot->attr
Ronald Cron215633c2021-03-16 17:15:37 +01004445 };
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004446
Gilles Peskine449bd832023-01-11 14:50:10 +01004447 status = psa_aead_check_nonce_length(alg, nonce_length);
4448 if (status != PSA_SUCCESS) {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004449 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004450 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004451
Ronald Cronde822812021-03-17 16:08:20 +01004452 status = psa_driver_wrapper_aead_decrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01004453 &attributes, slot->key.data, slot->key.bytes,
4454 alg,
4455 nonce, nonce_length,
4456 additional_data, additional_data_length,
4457 ciphertext, ciphertext_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004458 plaintext, plaintext_size, plaintext_length);
Gilles Peskinea40d7742018-06-01 16:28:30 +02004459
Gilles Peskine449bd832023-01-11 14:50:10 +01004460 if (status != PSA_SUCCESS && plaintext_size != 0) {
4461 memset(plaintext, 0, plaintext_size);
4462 }
mohammad160360a64d02018-06-03 17:20:42 +03004463
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004464exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004465 psa_unlock_key_slot(slot);
Ronald Cron215633c2021-03-16 17:15:37 +01004466
Gilles Peskine449bd832023-01-11 14:50:10 +01004467 return status;
mohammad16035955c982018-04-26 00:53:03 +03004468}
4469
Gilles Peskine449bd832023-01-11 14:50:10 +01004470static psa_status_t psa_validate_tag_length(psa_algorithm_t alg)
4471{
4472 const uint8_t tag_len = PSA_ALG_AEAD_GET_TAG_LENGTH(alg);
Andrzej Kurekf8816012021-12-19 17:00:12 +01004473
Gilles Peskine449bd832023-01-11 14:50:10 +01004474 switch (PSA_ALG_AEAD_WITH_SHORTENED_TAG(alg, 0)) {
Przemek Stekiel86679c72022-10-06 17:06:56 +02004475#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004476 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004477 /* CCM allows the following tag lengths: 4, 6, 8, 10, 12, 14, 16.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004478 if (tag_len < 4 || tag_len > 16 || tag_len % 2) {
4479 return PSA_ERROR_INVALID_ARGUMENT;
4480 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01004481 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02004482#endif /* PSA_WANT_ALG_CCM */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004483
Przemek Stekiel86679c72022-10-06 17:06:56 +02004484#if defined(PSA_WANT_ALG_GCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004485 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_GCM, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004486 /* GCM allows the following tag lengths: 4, 8, 12, 13, 14, 15, 16. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004487 if (tag_len != 4 && tag_len != 8 && (tag_len < 12 || tag_len > 16)) {
4488 return PSA_ERROR_INVALID_ARGUMENT;
4489 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01004490 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02004491#endif /* PSA_WANT_ALG_GCM */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004492
Przemek Stekiel86679c72022-10-06 17:06:56 +02004493#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Gilles Peskine449bd832023-01-11 14:50:10 +01004494 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CHACHA20_POLY1305, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004495 /* We only support the default tag length. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004496 if (tag_len != 16) {
4497 return PSA_ERROR_INVALID_ARGUMENT;
4498 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01004499 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02004500#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004501
4502 default:
4503 (void) tag_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004504 return PSA_ERROR_NOT_SUPPORTED;
Andrzej Kurekf8816012021-12-19 17:00:12 +01004505 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004506 return PSA_SUCCESS;
Andrzej Kurekf8816012021-12-19 17:00:12 +01004507}
4508
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004509/* Set the key for a multipart authenticated operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004510static psa_status_t psa_aead_setup(psa_aead_operation_t *operation,
4511 int is_encrypt,
4512 mbedtls_svc_key_id_t key,
4513 psa_algorithm_t alg)
Paul Elliottc2b71442021-06-24 18:17:52 +01004514{
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004515 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4516 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
4517 psa_key_slot_t *slot = NULL;
4518 psa_key_usage_t key_usage = 0;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004519 psa_key_attributes_t attributes;
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004520
Gilles Peskine449bd832023-01-11 14:50:10 +01004521 status = psa_aead_check_algorithm(alg);
4522 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004523 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004524 }
Paul Elliottc2b71442021-06-24 18:17:52 +01004525
Gilles Peskine449bd832023-01-11 14:50:10 +01004526 if (operation->id != 0) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004527 status = PSA_ERROR_BAD_STATE;
4528 goto exit;
Paul Elliottc2b71442021-06-24 18:17:52 +01004529 }
4530
Gilles Peskine449bd832023-01-11 14:50:10 +01004531 if (operation->nonce_set || operation->lengths_set ||
4532 operation->ad_started || operation->body_started) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004533 status = PSA_ERROR_BAD_STATE;
4534 goto exit;
Paul Elliottc2b71442021-06-24 18:17:52 +01004535 }
4536
Gilles Peskine449bd832023-01-11 14:50:10 +01004537 if (is_encrypt) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004538 key_usage = PSA_KEY_USAGE_ENCRYPT;
Gilles Peskine449bd832023-01-11 14:50:10 +01004539 } else {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004540 key_usage = PSA_KEY_USAGE_DECRYPT;
Gilles Peskine449bd832023-01-11 14:50:10 +01004541 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004542
Gilles Peskine449bd832023-01-11 14:50:10 +01004543 status = psa_get_and_lock_key_slot_with_policy(key, &slot, key_usage,
4544 alg);
4545 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004546 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004547 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004548
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004549 attributes = (psa_key_attributes_t) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004550 .core = slot->attr
4551 };
4552
Gilles Peskine449bd832023-01-11 14:50:10 +01004553 if ((status = psa_validate_tag_length(alg)) != PSA_SUCCESS) {
Przemek Stekiel6ab50762022-10-08 17:54:30 +02004554 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004555 }
Przemek Stekiel6ab50762022-10-08 17:54:30 +02004556
Gilles Peskine449bd832023-01-11 14:50:10 +01004557 if (is_encrypt) {
4558 status = psa_driver_wrapper_aead_encrypt_setup(operation,
4559 &attributes,
4560 slot->key.data,
4561 slot->key.bytes,
4562 alg);
4563 } else {
4564 status = psa_driver_wrapper_aead_decrypt_setup(operation,
4565 &attributes,
4566 slot->key.data,
4567 slot->key.bytes,
4568 alg);
4569 }
4570 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004571 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004572 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004573
Gilles Peskine449bd832023-01-11 14:50:10 +01004574 operation->key_type = psa_get_key_type(&attributes);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004575
4576exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004577 unlock_status = psa_unlock_key_slot(slot);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004578
Gilles Peskine449bd832023-01-11 14:50:10 +01004579 if (status == PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004580 status = unlock_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01004581 operation->alg = psa_aead_get_base_algorithm(alg);
Paul Elliottd9343f22021-08-23 18:59:49 +01004582 operation->is_encrypt = is_encrypt;
Gilles Peskine449bd832023-01-11 14:50:10 +01004583 } else {
4584 psa_aead_abort(operation);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004585 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004586
Gilles Peskine449bd832023-01-11 14:50:10 +01004587 return status;
Paul Elliottc2b71442021-06-24 18:17:52 +01004588}
4589
Paul Elliott302ff6b2021-04-20 18:10:30 +01004590/* Set the key for a multipart authenticated encryption operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004591psa_status_t psa_aead_encrypt_setup(psa_aead_operation_t *operation,
4592 mbedtls_svc_key_id_t key,
4593 psa_algorithm_t alg)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004594{
Gilles Peskine449bd832023-01-11 14:50:10 +01004595 return psa_aead_setup(operation, 1, key, alg);
Paul Elliott302ff6b2021-04-20 18:10:30 +01004596}
4597
4598/* Set the key for a multipart authenticated decryption operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004599psa_status_t psa_aead_decrypt_setup(psa_aead_operation_t *operation,
4600 mbedtls_svc_key_id_t key,
4601 psa_algorithm_t alg)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004602{
Gilles Peskine449bd832023-01-11 14:50:10 +01004603 return psa_aead_setup(operation, 0, key, alg);
Paul Elliott302ff6b2021-04-20 18:10:30 +01004604}
4605
4606/* Generate a random nonce / IV for multipart AEAD operation */
Gilles Peskine449bd832023-01-11 14:50:10 +01004607psa_status_t psa_aead_generate_nonce(psa_aead_operation_t *operation,
4608 uint8_t *nonce,
4609 size_t nonce_size,
4610 size_t *nonce_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004611{
4612 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Croncae59092021-11-26 18:53:58 +01004613 uint8_t local_nonce[PSA_AEAD_NONCE_MAX_SIZE];
Sergeybef1f632023-03-06 15:25:06 -07004614 size_t required_nonce_size = 0;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004615
Paul Elliott8eb9daf2021-06-04 16:42:21 +01004616 *nonce_length = 0;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004617
Gilles Peskine449bd832023-01-11 14:50:10 +01004618 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004619 status = PSA_ERROR_BAD_STATE;
4620 goto exit;
4621 }
4622
Gilles Peskine449bd832023-01-11 14:50:10 +01004623 if (operation->nonce_set || !operation->is_encrypt) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004624 status = PSA_ERROR_BAD_STATE;
4625 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004626 }
4627
Paul Elliotte193ea82021-10-01 13:00:16 +01004628 /* For CCM, this size may not be correct according to the PSA
4629 * specification. The PSA Crypto 1.0.1 specification states:
4630 *
4631 * CCM encodes the plaintext length pLen in L octets, with L the smallest
4632 * integer >= 2 where pLen < 2^(8L). The nonce length is then 15 - L bytes.
4633 *
4634 * However this restriction that L has to be the smallest integer is not
4635 * applied in practice, and it is not implementable here since the
4636 * plaintext length may or may not be known at this time. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004637 required_nonce_size = PSA_AEAD_NONCE_LENGTH(operation->key_type,
4638 operation->alg);
4639 if (nonce_size < required_nonce_size) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004640 status = PSA_ERROR_BUFFER_TOO_SMALL;
4641 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004642 }
4643
Gilles Peskine449bd832023-01-11 14:50:10 +01004644 status = psa_generate_random(local_nonce, required_nonce_size);
4645 if (status != PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004646 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004647 }
Paul Elliott302ff6b2021-04-20 18:10:30 +01004648
Gilles Peskine449bd832023-01-11 14:50:10 +01004649 status = psa_aead_set_nonce(operation, local_nonce, required_nonce_size);
Paul Elliott302ff6b2021-04-20 18:10:30 +01004650
Paul Elliott39dc6b82021-05-11 19:16:09 +01004651exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004652 if (status == PSA_SUCCESS) {
4653 memcpy(nonce, local_nonce, required_nonce_size);
Paul Elliott39dc6b82021-05-11 19:16:09 +01004654 *nonce_length = required_nonce_size;
Gilles Peskine449bd832023-01-11 14:50:10 +01004655 } else {
4656 psa_aead_abort(operation);
Ronald Croncae59092021-11-26 18:53:58 +01004657 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01004658
Gilles Peskine449bd832023-01-11 14:50:10 +01004659 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004660}
4661
4662/* Set the nonce for a multipart authenticated encryption or decryption
4663 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004664psa_status_t psa_aead_set_nonce(psa_aead_operation_t *operation,
4665 const uint8_t *nonce,
4666 size_t nonce_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004667{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004668 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4669
Gilles Peskine449bd832023-01-11 14:50:10 +01004670 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004671 status = PSA_ERROR_BAD_STATE;
4672 goto exit;
4673 }
4674
Gilles Peskine449bd832023-01-11 14:50:10 +01004675 if (operation->nonce_set) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004676 status = PSA_ERROR_BAD_STATE;
4677 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004678 }
4679
Gilles Peskine449bd832023-01-11 14:50:10 +01004680 status = psa_aead_check_nonce_length(operation->alg, nonce_length);
4681 if (status != PSA_SUCCESS) {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004682 status = PSA_ERROR_INVALID_ARGUMENT;
4683 goto exit;
Paul Elliott4ed1ed12021-09-27 18:09:28 +01004684 }
Paul Elliott1a98aca2021-05-20 18:24:07 +01004685
Gilles Peskine449bd832023-01-11 14:50:10 +01004686 status = psa_driver_wrapper_aead_set_nonce(operation, nonce,
4687 nonce_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004688
Paul Elliott39dc6b82021-05-11 19:16:09 +01004689exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004690 if (status == PSA_SUCCESS) {
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004691 operation->nonce_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004692 } else {
4693 psa_aead_abort(operation);
4694 }
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004695
Gilles Peskine449bd832023-01-11 14:50:10 +01004696 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004697}
4698
4699/* Declare the lengths of the message and additional data for multipart AEAD. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004700psa_status_t psa_aead_set_lengths(psa_aead_operation_t *operation,
4701 size_t ad_length,
4702 size_t plaintext_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004703{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004704 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4705
Gilles Peskine449bd832023-01-11 14:50:10 +01004706 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004707 status = PSA_ERROR_BAD_STATE;
4708 goto exit;
4709 }
4710
Gilles Peskine449bd832023-01-11 14:50:10 +01004711 if (operation->lengths_set || operation->ad_started ||
4712 operation->body_started) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004713 status = PSA_ERROR_BAD_STATE;
4714 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004715 }
4716
Gilles Peskine449bd832023-01-11 14:50:10 +01004717 switch (operation->alg) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004718#if defined(PSA_WANT_ALG_GCM)
4719 case PSA_ALG_GCM:
4720 /* Lengths can only be too large for GCM if size_t is bigger than 32
Gilles Peskine449bd832023-01-11 14:50:10 +01004721 * bits. Without the guard this code will generate warnings on 32bit
4722 * builds. */
Paul Elliott325d3742021-09-27 17:56:28 +01004723#if SIZE_MAX > UINT32_MAX
Gilles Peskine449bd832023-01-11 14:50:10 +01004724 if (((uint64_t) ad_length) >> 61 != 0 ||
4725 ((uint64_t) plaintext_length) > 0xFFFFFFFE0ull) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004726 status = PSA_ERROR_INVALID_ARGUMENT;
4727 goto exit;
4728 }
Paul Elliott325d3742021-09-27 17:56:28 +01004729#endif
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004730 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004731#endif /* PSA_WANT_ALG_GCM */
4732#if defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004733 case PSA_ALG_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01004734 if (ad_length > 0xFF00) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004735 status = PSA_ERROR_INVALID_ARGUMENT;
4736 goto exit;
4737 }
4738 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004739#endif /* PSA_WANT_ALG_CCM */
4740#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004741 case PSA_ALG_CHACHA20_POLY1305:
4742 /* No length restrictions for ChaChaPoly. */
4743 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004744#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004745 default:
4746 break;
4747 }
Paul Elliott325d3742021-09-27 17:56:28 +01004748
Gilles Peskine449bd832023-01-11 14:50:10 +01004749 status = psa_driver_wrapper_aead_set_lengths(operation, ad_length,
4750 plaintext_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004751
Paul Elliott39dc6b82021-05-11 19:16:09 +01004752exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004753 if (status == PSA_SUCCESS) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01004754 operation->ad_remaining = ad_length;
4755 operation->body_remaining = plaintext_length;
Paul Elliott39dc6b82021-05-11 19:16:09 +01004756 operation->lengths_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004757 } else {
4758 psa_aead_abort(operation);
Paul Elliottee4ffe02021-05-20 17:25:06 +01004759 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01004760
Gilles Peskine449bd832023-01-11 14:50:10 +01004761 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004762}
Paul Elliott3d7d52c2021-09-01 10:33:14 +01004763
4764/* Pass additional data to an active multipart AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004765psa_status_t psa_aead_update_ad(psa_aead_operation_t *operation,
4766 const uint8_t *input,
4767 size_t input_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004768{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004769 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4770
Gilles Peskine449bd832023-01-11 14:50:10 +01004771 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004772 status = PSA_ERROR_BAD_STATE;
4773 goto exit;
4774 }
4775
Gilles Peskine449bd832023-01-11 14:50:10 +01004776 if (!operation->nonce_set || operation->body_started) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004777 status = PSA_ERROR_BAD_STATE;
4778 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004779 }
4780
Gilles Peskine449bd832023-01-11 14:50:10 +01004781 if (operation->lengths_set) {
4782 if (operation->ad_remaining < input_length) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01004783 status = PSA_ERROR_INVALID_ARGUMENT;
4784 goto exit;
4785 }
4786
4787 operation->ad_remaining -= input_length;
4788 }
Paul Elliotte193ea82021-10-01 13:00:16 +01004789#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004790 else if (operation->alg == PSA_ALG_CCM) {
Paul Elliotte193ea82021-10-01 13:00:16 +01004791 status = PSA_ERROR_BAD_STATE;
4792 goto exit;
4793 }
4794#endif /* PSA_WANT_ALG_CCM */
Paul Elliottee4ffe02021-05-20 17:25:06 +01004795
Gilles Peskine449bd832023-01-11 14:50:10 +01004796 status = psa_driver_wrapper_aead_update_ad(operation, input,
4797 input_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004798
Paul Elliott39dc6b82021-05-11 19:16:09 +01004799exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004800 if (status == PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004801 operation->ad_started = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004802 } else {
4803 psa_aead_abort(operation);
4804 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01004805
Gilles Peskine449bd832023-01-11 14:50:10 +01004806 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004807}
4808
4809/* Encrypt or decrypt a message fragment in an active multipart AEAD
4810 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004811psa_status_t psa_aead_update(psa_aead_operation_t *operation,
4812 const uint8_t *input,
4813 size_t input_length,
4814 uint8_t *output,
4815 size_t output_size,
4816 size_t *output_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004817{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004818 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004819
4820 *output_length = 0;
4821
Gilles Peskine449bd832023-01-11 14:50:10 +01004822 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004823 status = PSA_ERROR_BAD_STATE;
4824 goto exit;
4825 }
4826
Gilles Peskine449bd832023-01-11 14:50:10 +01004827 if (!operation->nonce_set) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004828 status = PSA_ERROR_BAD_STATE;
4829 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004830 }
4831
Gilles Peskine449bd832023-01-11 14:50:10 +01004832 if (operation->lengths_set) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01004833 /* Additional data length was supplied, but not all the additional
4834 data was supplied.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004835 if (operation->ad_remaining != 0) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01004836 status = PSA_ERROR_INVALID_ARGUMENT;
4837 goto exit;
4838 }
4839
4840 /* Too much data provided. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004841 if (operation->body_remaining < input_length) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01004842 status = PSA_ERROR_INVALID_ARGUMENT;
4843 goto exit;
4844 }
4845
4846 operation->body_remaining -= input_length;
4847 }
Paul Elliotte193ea82021-10-01 13:00:16 +01004848#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004849 else if (operation->alg == PSA_ALG_CCM) {
Paul Elliotte193ea82021-10-01 13:00:16 +01004850 status = PSA_ERROR_BAD_STATE;
4851 goto exit;
4852 }
4853#endif /* PSA_WANT_ALG_CCM */
Paul Elliottee4ffe02021-05-20 17:25:06 +01004854
Gilles Peskine449bd832023-01-11 14:50:10 +01004855 status = psa_driver_wrapper_aead_update(operation, input, input_length,
4856 output, output_size,
4857 output_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004858
Paul Elliott39dc6b82021-05-11 19:16:09 +01004859exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004860 if (status == PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004861 operation->body_started = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004862 } else {
4863 psa_aead_abort(operation);
4864 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01004865
Gilles Peskine449bd832023-01-11 14:50:10 +01004866 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004867}
4868
Gilles Peskine449bd832023-01-11 14:50:10 +01004869static psa_status_t psa_aead_final_checks(const psa_aead_operation_t *operation)
Paul Elliottad53dcc2021-06-23 08:50:14 +01004870{
Gilles Peskine449bd832023-01-11 14:50:10 +01004871 if (operation->id == 0 || !operation->nonce_set) {
4872 return PSA_ERROR_BAD_STATE;
4873 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01004874
Gilles Peskine449bd832023-01-11 14:50:10 +01004875 if (operation->lengths_set && (operation->ad_remaining != 0 ||
4876 operation->body_remaining != 0)) {
4877 return PSA_ERROR_INVALID_ARGUMENT;
4878 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01004879
Gilles Peskine449bd832023-01-11 14:50:10 +01004880 return PSA_SUCCESS;
Paul Elliottad53dcc2021-06-23 08:50:14 +01004881}
4882
Paul Elliott302ff6b2021-04-20 18:10:30 +01004883/* Finish encrypting a message in a multipart AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004884psa_status_t psa_aead_finish(psa_aead_operation_t *operation,
4885 uint8_t *ciphertext,
4886 size_t ciphertext_size,
4887 size_t *ciphertext_length,
4888 uint8_t *tag,
4889 size_t tag_size,
4890 size_t *tag_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004891{
Paul Elliott39dc6b82021-05-11 19:16:09 +01004892 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4893
Paul Elliott302ff6b2021-04-20 18:10:30 +01004894 *ciphertext_length = 0;
Paul Elliottf88a5652021-06-22 17:53:45 +01004895 *tag_length = tag_size;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004896
Gilles Peskine449bd832023-01-11 14:50:10 +01004897 status = psa_aead_final_checks(operation);
4898 if (status != PSA_SUCCESS) {
Paul Elliottad53dcc2021-06-23 08:50:14 +01004899 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004900 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01004901
Gilles Peskine449bd832023-01-11 14:50:10 +01004902 if (!operation->is_encrypt) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004903 status = PSA_ERROR_BAD_STATE;
4904 goto exit;
4905 }
4906
Gilles Peskine449bd832023-01-11 14:50:10 +01004907 status = psa_driver_wrapper_aead_finish(operation, ciphertext,
4908 ciphertext_size,
4909 ciphertext_length,
4910 tag, tag_size, tag_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004911
Paul Elliott39dc6b82021-05-11 19:16:09 +01004912exit:
Paul Elliottdc42ca82023-02-24 18:11:59 +00004913
4914
Paul Elliottf47b0952021-05-21 18:02:33 +01004915 /* In case the operation fails and the user fails to check for failure or
Paul Elliott4c916e82021-09-19 18:34:50 +01004916 * the zero tag size, make sure the tag is set to something implausible.
4917 * Even if the operation succeeds, make sure we clear the rest of the
4918 * buffer to prevent potential leakage of anything previously placed in
4919 * the same buffer.*/
Paul Elliottdc42ca82023-02-24 18:11:59 +00004920 psa_wipe_tag_output_buffer(tag, status, tag_size, *tag_length);
Paul Elliottf47b0952021-05-21 18:02:33 +01004921
Gilles Peskine449bd832023-01-11 14:50:10 +01004922 psa_aead_abort(operation);
Paul Elliott39dc6b82021-05-11 19:16:09 +01004923
Gilles Peskine449bd832023-01-11 14:50:10 +01004924 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004925}
4926
4927/* Finish authenticating and decrypting a message in a multipart AEAD
4928 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004929psa_status_t psa_aead_verify(psa_aead_operation_t *operation,
4930 uint8_t *plaintext,
4931 size_t plaintext_size,
4932 size_t *plaintext_length,
4933 const uint8_t *tag,
4934 size_t tag_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004935{
Paul Elliott39dc6b82021-05-11 19:16:09 +01004936 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4937
Paul Elliott302ff6b2021-04-20 18:10:30 +01004938 *plaintext_length = 0;
4939
Gilles Peskine449bd832023-01-11 14:50:10 +01004940 status = psa_aead_final_checks(operation);
4941 if (status != PSA_SUCCESS) {
Paul Elliottad53dcc2021-06-23 08:50:14 +01004942 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004943 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01004944
Gilles Peskine449bd832023-01-11 14:50:10 +01004945 if (operation->is_encrypt) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004946 status = PSA_ERROR_BAD_STATE;
4947 goto exit;
4948 }
4949
Gilles Peskine449bd832023-01-11 14:50:10 +01004950 status = psa_driver_wrapper_aead_verify(operation, plaintext,
4951 plaintext_size,
4952 plaintext_length,
4953 tag, tag_length);
Paul Elliott39dc6b82021-05-11 19:16:09 +01004954
4955exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004956 psa_aead_abort(operation);
Paul Elliott39dc6b82021-05-11 19:16:09 +01004957
Gilles Peskine449bd832023-01-11 14:50:10 +01004958 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004959}
4960
4961/* Abort an AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004962psa_status_t psa_aead_abort(psa_aead_operation_t *operation)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004963{
4964 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4965
Gilles Peskine449bd832023-01-11 14:50:10 +01004966 if (operation->id == 0) {
Paul Elliott302ff6b2021-04-20 18:10:30 +01004967 /* The object has (apparently) been initialized but it is not (yet)
4968 * in use. It's ok to call abort on such an object, and there's
4969 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004970 return PSA_SUCCESS;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004971 }
4972
Gilles Peskine449bd832023-01-11 14:50:10 +01004973 status = psa_driver_wrapper_aead_abort(operation);
Paul Elliott302ff6b2021-04-20 18:10:30 +01004974
Gilles Peskine449bd832023-01-11 14:50:10 +01004975 memset(operation, 0, sizeof(*operation));
Paul Elliott302ff6b2021-04-20 18:10:30 +01004976
Gilles Peskine449bd832023-01-11 14:50:10 +01004977 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004978}
4979
Gilles Peskinee59236f2018-01-27 23:32:46 +01004980/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02004981/* Generators */
4982/****************************************************************/
4983
Przemek Stekiel69c46792022-06-10 12:59:51 +02004984#if defined(BUILTIN_ALG_ANY_HKDF) || \
John Durkop07cc04a2020-11-16 22:08:34 -08004985 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
Andrzej Kurek08d34b82022-07-29 10:00:16 -04004986 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) || \
Kusumit Ghoderaoaf0b5342023-05-03 11:58:46 +05304987 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS) || \
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05304988 defined(PSA_HAVE_SOFT_PBKDF2)
John Durkop07cc04a2020-11-16 22:08:34 -08004989#define AT_LEAST_ONE_BUILTIN_KDF
Steven Cooreman094a77e2021-05-06 17:58:36 +02004990#endif /* At least one builtin KDF */
4991
Przemek Stekiel69c46792022-06-10 12:59:51 +02004992#if defined(BUILTIN_ALG_ANY_HKDF) || \
Steven Cooreman094a77e2021-05-06 17:58:36 +02004993 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4994 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4995static psa_status_t psa_key_derivation_start_hmac(
4996 psa_mac_operation_t *operation,
4997 psa_algorithm_t hash_alg,
4998 const uint8_t *hmac_key,
Gilles Peskine449bd832023-01-11 14:50:10 +01004999 size_t hmac_key_length)
Steven Cooreman094a77e2021-05-06 17:58:36 +02005000{
5001 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5002 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01005003 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
5004 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(hmac_key_length));
5005 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_HASH);
Steven Cooreman094a77e2021-05-06 17:58:36 +02005006
Steven Cooreman72f736a2021-05-07 14:14:37 +02005007 operation->is_sign = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005008 operation->mac_size = PSA_HASH_LENGTH(hash_alg);
Steven Cooreman72f736a2021-05-07 14:14:37 +02005009
Gilles Peskine449bd832023-01-11 14:50:10 +01005010 status = psa_driver_wrapper_mac_sign_setup(operation,
5011 &attributes,
5012 hmac_key, hmac_key_length,
5013 PSA_ALG_HMAC(hash_alg));
Steven Cooreman094a77e2021-05-06 17:58:36 +02005014
Gilles Peskine449bd832023-01-11 14:50:10 +01005015 psa_reset_key_attributes(&attributes);
5016 return status;
Steven Cooreman094a77e2021-05-06 17:58:36 +02005017}
5018#endif /* KDF algorithms reliant on HMAC */
John Durkop07cc04a2020-11-16 22:08:34 -08005019
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005020#define HKDF_STATE_INIT 0 /* no input yet */
5021#define HKDF_STATE_STARTED 1 /* got salt */
5022#define HKDF_STATE_KEYED 2 /* got key */
5023#define HKDF_STATE_OUTPUT 3 /* output started */
5024
Gilles Peskinecbe66502019-05-16 16:59:18 +02005025static psa_algorithm_t psa_key_derivation_get_kdf_alg(
Gilles Peskine449bd832023-01-11 14:50:10 +01005026 const psa_key_derivation_operation_t *operation)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005027{
Gilles Peskine449bd832023-01-11 14:50:10 +01005028 if (PSA_ALG_IS_KEY_AGREEMENT(operation->alg)) {
5029 return PSA_ALG_KEY_AGREEMENT_GET_KDF(operation->alg);
5030 } else {
5031 return operation->alg;
5032 }
Gilles Peskine969c5d62019-01-16 15:53:06 +01005033}
5034
Gilles Peskine449bd832023-01-11 14:50:10 +01005035psa_status_t psa_key_derivation_abort(psa_key_derivation_operation_t *operation)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005036{
5037 psa_status_t status = PSA_SUCCESS;
Gilles Peskine449bd832023-01-11 14:50:10 +01005038 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
5039 if (kdf_alg == 0) {
Gilles Peskineeab56e42018-07-12 17:12:33 +02005040 /* The object has (apparently) been initialized but it is not
5041 * in use. It's ok to call abort on such an object, and there's
5042 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005043 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02005044#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01005045 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
5046 mbedtls_free(operation->ctx.hkdf.info);
5047 status = psa_mac_abort(&operation->ctx.hkdf.hmac);
5048 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02005049#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08005050#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5051 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005052 if (PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
5053 /* TLS-1.2 PSK-to-MS KDF uses the same core as TLS-1.2 PRF */
5054 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
5055 if (operation->ctx.tls12_prf.secret != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005056 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.secret,
Gilles Peskine449bd832023-01-11 14:50:10 +01005057 operation->ctx.tls12_prf.secret_length);
Steven Cooremana6df6042021-04-29 19:32:25 +02005058 }
5059
Gilles Peskine449bd832023-01-11 14:50:10 +01005060 if (operation->ctx.tls12_prf.seed != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005061 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.seed,
Gilles Peskine449bd832023-01-11 14:50:10 +01005062 operation->ctx.tls12_prf.seed_length);
Janos Follath6a1d2622019-06-11 10:37:28 +01005063 }
5064
Gilles Peskine449bd832023-01-11 14:50:10 +01005065 if (operation->ctx.tls12_prf.label != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005066 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.label,
Gilles Peskine449bd832023-01-11 14:50:10 +01005067 operation->ctx.tls12_prf.label_length);
Janos Follath6a1d2622019-06-11 10:37:28 +01005068 }
Przemek Stekiel6c764412022-11-22 14:05:12 +01005069#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005070 if (operation->ctx.tls12_prf.other_secret != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005071 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.other_secret,
Gilles Peskine449bd832023-01-11 14:50:10 +01005072 operation->ctx.tls12_prf.other_secret_length);
Przemek Stekiele3ee2212022-04-07 14:29:56 +02005073 }
Przemek Stekiel6c764412022-11-22 14:05:12 +01005074#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Steven Cooremana6df6042021-04-29 19:32:25 +02005075 status = PSA_SUCCESS;
Janos Follath6a1d2622019-06-11 10:37:28 +01005076
5077 /* We leave the fields Ai and output_block to be erased safely by the
5078 * mbedtls_platform_zeroize() in the end of this function. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005079 } else
John Durkop07cc04a2020-11-16 22:08:34 -08005080#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
5081 * defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005082#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005083 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
5084 mbedtls_platform_zeroize(operation->ctx.tls12_ecjpake_to_pms.data,
5085 sizeof(operation->ctx.tls12_ecjpake_to_pms.data));
5086 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005087#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS) */
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305088#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05305089 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305090 if (operation->ctx.pbkdf2.salt != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005091 mbedtls_zeroize_and_free(operation->ctx.pbkdf2.salt,
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305092 operation->ctx.pbkdf2.salt_length);
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305093 }
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305094
5095 status = PSA_SUCCESS;
5096 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305097#endif /* defined(PSA_HAVE_SOFT_PBKDF2) */
Gilles Peskineeab56e42018-07-12 17:12:33 +02005098 {
5099 status = PSA_ERROR_BAD_STATE;
5100 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005101 mbedtls_platform_zeroize(operation, sizeof(*operation));
5102 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005103}
5104
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005105psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskine449bd832023-01-11 14:50:10 +01005106 size_t *capacity)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005107{
Gilles Peskine449bd832023-01-11 14:50:10 +01005108 if (operation->alg == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005109 /* This is a blank key derivation operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005110 return PSA_ERROR_BAD_STATE;
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005111 }
5112
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005113 *capacity = operation->capacity;
Gilles Peskine449bd832023-01-11 14:50:10 +01005114 return PSA_SUCCESS;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005115}
5116
Gilles Peskine449bd832023-01-11 14:50:10 +01005117psa_status_t psa_key_derivation_set_capacity(psa_key_derivation_operation_t *operation,
5118 size_t capacity)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005119{
Gilles Peskine449bd832023-01-11 14:50:10 +01005120 if (operation->alg == 0) {
5121 return PSA_ERROR_BAD_STATE;
5122 }
5123 if (capacity > operation->capacity) {
5124 return PSA_ERROR_INVALID_ARGUMENT;
5125 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005126 operation->capacity = capacity;
Gilles Peskine449bd832023-01-11 14:50:10 +01005127 return PSA_SUCCESS;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005128}
5129
Przemek Stekiel69c46792022-06-10 12:59:51 +02005130#if defined(BUILTIN_ALG_ANY_HKDF)
Przemek Stekiel03d948c2022-05-19 11:45:20 +02005131/* Read some bytes from an HKDF-based operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005132static psa_status_t psa_key_derivation_hkdf_read(psa_hkdf_key_derivation_t *hkdf,
5133 psa_algorithm_t kdf_alg,
5134 uint8_t *output,
5135 size_t output_length)
Gilles Peskinebef7f142018-07-12 17:22:21 +02005136{
Gilles Peskine449bd832023-01-11 14:50:10 +01005137 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
5138 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Steven Cooremand1ed1d92021-04-29 19:11:25 +02005139 size_t hmac_output_length;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005140 psa_status_t status;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005141#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01005142 const uint8_t last_block = PSA_ALG_IS_HKDF_EXTRACT(kdf_alg) ? 0 : 0xff;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005143#else
5144 const uint8_t last_block = 0xff;
5145#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskinebef7f142018-07-12 17:22:21 +02005146
Gilles Peskine449bd832023-01-11 14:50:10 +01005147 if (hkdf->state < HKDF_STATE_KEYED ||
5148 (!hkdf->info_set
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005149#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01005150 && !PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005151#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01005152 )) {
5153 return PSA_ERROR_BAD_STATE;
5154 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005155 hkdf->state = HKDF_STATE_OUTPUT;
5156
Gilles Peskine449bd832023-01-11 14:50:10 +01005157 while (output_length != 0) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005158 /* Copy what remains of the current block */
5159 uint8_t n = hash_length - hkdf->offset_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005160 if (n > output_length) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005161 n = (uint8_t) output_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01005162 }
5163 memcpy(output, hkdf->output_block + hkdf->offset_in_block, n);
Gilles Peskinebef7f142018-07-12 17:22:21 +02005164 output += n;
5165 output_length -= n;
5166 hkdf->offset_in_block += n;
Gilles Peskine449bd832023-01-11 14:50:10 +01005167 if (output_length == 0) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005168 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01005169 }
Przemek Stekiel03d948c2022-05-19 11:45:20 +02005170 /* We can't be wanting more output after the last block, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005171 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005172 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02005173 * object was corrupted or if this function is called directly
5174 * inside the library. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005175 if (hkdf->block_number == last_block) {
5176 return PSA_ERROR_BAD_STATE;
5177 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02005178
5179 /* We need a new block */
5180 ++hkdf->block_number;
5181 hkdf->offset_in_block = 0;
Steven Cooremand1ed1d92021-04-29 19:11:25 +02005182
Gilles Peskine449bd832023-01-11 14:50:10 +01005183 status = psa_key_derivation_start_hmac(&hkdf->hmac,
5184 hash_alg,
5185 hkdf->prk,
5186 hash_length);
5187 if (status != PSA_SUCCESS) {
5188 return status;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005189 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005190
5191 if (hkdf->block_number != 1) {
5192 status = psa_mac_update(&hkdf->hmac,
5193 hkdf->output_block,
5194 hash_length);
5195 if (status != PSA_SUCCESS) {
5196 return status;
5197 }
5198 }
5199 status = psa_mac_update(&hkdf->hmac,
5200 hkdf->info,
5201 hkdf->info_length);
5202 if (status != PSA_SUCCESS) {
5203 return status;
5204 }
5205 status = psa_mac_update(&hkdf->hmac,
5206 &hkdf->block_number, 1);
5207 if (status != PSA_SUCCESS) {
5208 return status;
5209 }
5210 status = psa_mac_sign_finish(&hkdf->hmac,
5211 hkdf->output_block,
5212 sizeof(hkdf->output_block),
5213 &hmac_output_length);
5214 if (status != PSA_SUCCESS) {
5215 return status;
5216 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02005217 }
5218
Gilles Peskine449bd832023-01-11 14:50:10 +01005219 return PSA_SUCCESS;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005220}
Przemek Stekiel69c46792022-06-10 12:59:51 +02005221#endif /* BUILTIN_ALG_ANY_HKDF */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005222
John Durkop07cc04a2020-11-16 22:08:34 -08005223#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5224 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follath7742fee2019-06-17 12:58:10 +01005225static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
5226 psa_tls12_prf_key_derivation_t *tls12_prf,
Gilles Peskine449bd832023-01-11 14:50:10 +01005227 psa_algorithm_t alg)
Janos Follath7742fee2019-06-17 12:58:10 +01005228{
Gilles Peskine449bd832023-01-11 14:50:10 +01005229 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(alg);
5230 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Steven Cooremana6df6042021-04-29 19:32:25 +02005231 psa_mac_operation_t hmac = PSA_MAC_OPERATION_INIT;
5232 size_t hmac_output_length;
Janos Follathea29bfb2019-06-19 12:21:20 +01005233 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005234
Janos Follath7742fee2019-06-17 12:58:10 +01005235 /* We can't be wanting more output after block 0xff, otherwise
5236 * the capacity check in psa_key_derivation_output_bytes() would have
5237 * prevented this call. It could happen only if the operation
5238 * object was corrupted or if this function is called directly
5239 * inside the library. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005240 if (tls12_prf->block_number == 0xff) {
5241 return PSA_ERROR_CORRUPTION_DETECTED;
5242 }
Janos Follath7742fee2019-06-17 12:58:10 +01005243
5244 /* We need a new block */
5245 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01005246 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01005247
5248 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
5249 *
5250 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
5251 *
5252 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
5253 * HMAC_hash(secret, A(2) + seed) +
5254 * HMAC_hash(secret, A(3) + seed) + ...
5255 *
5256 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01005257 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01005258 *
Janos Follathea29bfb2019-06-19 12:21:20 +01005259 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01005260 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01005261 * is currently extracted as `output_block` and where i is
5262 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01005263 */
5264
Gilles Peskine449bd832023-01-11 14:50:10 +01005265 status = psa_key_derivation_start_hmac(&hmac,
5266 hash_alg,
5267 tls12_prf->secret,
5268 tls12_prf->secret_length);
5269 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005270 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005271 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005272
5273 /* Calculate A(i) where i = tls12_prf->block_number. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005274 if (tls12_prf->block_number == 1) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005275 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
5276 * the variable seed and in this instance means it in the context of the
5277 * P_hash function, where seed = label + seed.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01005278 status = psa_mac_update(&hmac,
5279 tls12_prf->label,
5280 tls12_prf->label_length);
5281 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005282 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005283 }
5284 status = psa_mac_update(&hmac,
5285 tls12_prf->seed,
5286 tls12_prf->seed_length);
5287 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005288 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005289 }
5290 } else {
Janos Follathea29bfb2019-06-19 12:21:20 +01005291 /* A(i) = HMAC_hash(secret, A(i-1)) */
Gilles Peskine449bd832023-01-11 14:50:10 +01005292 status = psa_mac_update(&hmac, tls12_prf->Ai, hash_length);
5293 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005294 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005295 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005296 }
5297
Gilles Peskine449bd832023-01-11 14:50:10 +01005298 status = psa_mac_sign_finish(&hmac,
5299 tls12_prf->Ai, hash_length,
5300 &hmac_output_length);
5301 if (hmac_output_length != hash_length) {
Steven Cooremana6df6042021-04-29 19:32:25 +02005302 status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01005303 }
5304 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005305 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005306 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005307
5308 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
Gilles Peskine449bd832023-01-11 14:50:10 +01005309 status = psa_key_derivation_start_hmac(&hmac,
5310 hash_alg,
5311 tls12_prf->secret,
5312 tls12_prf->secret_length);
5313 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005314 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005315 }
5316 status = psa_mac_update(&hmac, tls12_prf->Ai, hash_length);
5317 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005318 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005319 }
5320 status = psa_mac_update(&hmac, tls12_prf->label, tls12_prf->label_length);
5321 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005322 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005323 }
5324 status = psa_mac_update(&hmac, tls12_prf->seed, tls12_prf->seed_length);
5325 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005326 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005327 }
5328 status = psa_mac_sign_finish(&hmac,
5329 tls12_prf->output_block, hash_length,
5330 &hmac_output_length);
5331 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005332 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005333 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005334
Janos Follath7742fee2019-06-17 12:58:10 +01005335
5336cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01005337 cleanup_status = psa_mac_abort(&hmac);
5338 if (status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005339 status = cleanup_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01005340 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005341
Gilles Peskine449bd832023-01-11 14:50:10 +01005342 return status;
Janos Follath7742fee2019-06-17 12:58:10 +01005343}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005344
Janos Follath844eb0e2019-06-19 12:10:49 +01005345static psa_status_t psa_key_derivation_tls12_prf_read(
5346 psa_tls12_prf_key_derivation_t *tls12_prf,
5347 psa_algorithm_t alg,
5348 uint8_t *output,
Gilles Peskine449bd832023-01-11 14:50:10 +01005349 size_t output_length)
Janos Follath844eb0e2019-06-19 12:10:49 +01005350{
Gilles Peskine449bd832023-01-11 14:50:10 +01005351 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH(alg);
5352 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Janos Follath844eb0e2019-06-19 12:10:49 +01005353 psa_status_t status;
5354 uint8_t offset, length;
5355
Gilles Peskine449bd832023-01-11 14:50:10 +01005356 switch (tls12_prf->state) {
Gilles Peskineb1edaec2021-06-11 22:41:46 +02005357 case PSA_TLS12_PRF_STATE_LABEL_SET:
5358 tls12_prf->state = PSA_TLS12_PRF_STATE_OUTPUT;
5359 break;
5360 case PSA_TLS12_PRF_STATE_OUTPUT:
5361 break;
5362 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005363 return PSA_ERROR_BAD_STATE;
Gilles Peskineb1edaec2021-06-11 22:41:46 +02005364 }
5365
Gilles Peskine449bd832023-01-11 14:50:10 +01005366 while (output_length != 0) {
Janos Follath844eb0e2019-06-19 12:10:49 +01005367 /* Check if we have fully processed the current block. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005368 if (tls12_prf->left_in_block == 0) {
5369 status = psa_key_derivation_tls12_prf_generate_next_block(tls12_prf,
5370 alg);
5371 if (status != PSA_SUCCESS) {
5372 return status;
5373 }
Janos Follath844eb0e2019-06-19 12:10:49 +01005374
5375 continue;
5376 }
5377
Gilles Peskine449bd832023-01-11 14:50:10 +01005378 if (tls12_prf->left_in_block > output_length) {
Janos Follath844eb0e2019-06-19 12:10:49 +01005379 length = (uint8_t) output_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01005380 } else {
Janos Follath844eb0e2019-06-19 12:10:49 +01005381 length = tls12_prf->left_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005382 }
Janos Follath844eb0e2019-06-19 12:10:49 +01005383
5384 offset = hash_length - tls12_prf->left_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005385 memcpy(output, tls12_prf->output_block + offset, length);
Janos Follath844eb0e2019-06-19 12:10:49 +01005386 output += length;
5387 output_length -= length;
5388 tls12_prf->left_in_block -= length;
5389 }
5390
Gilles Peskine449bd832023-01-11 14:50:10 +01005391 return PSA_SUCCESS;
Janos Follath844eb0e2019-06-19 12:10:49 +01005392}
John Durkop07cc04a2020-11-16 22:08:34 -08005393#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
5394 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskinebef7f142018-07-12 17:22:21 +02005395
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005396#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
5397static psa_status_t psa_key_derivation_tls12_ecjpake_to_pms_read(
5398 psa_tls12_ecjpake_to_pms_t *ecjpake,
5399 uint8_t *output,
Gilles Peskine449bd832023-01-11 14:50:10 +01005400 size_t output_length)
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005401{
5402 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Andrzej Kurek5603efd2022-09-26 10:49:16 -04005403 size_t output_size = 0;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005404
Gilles Peskine449bd832023-01-11 14:50:10 +01005405 if (output_length != 32) {
5406 return PSA_ERROR_INVALID_ARGUMENT;
5407 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005408
Gilles Peskine449bd832023-01-11 14:50:10 +01005409 status = psa_hash_compute(PSA_ALG_SHA_256, ecjpake->data,
5410 PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE, output, output_length,
5411 &output_size);
5412 if (status != PSA_SUCCESS) {
5413 return status;
5414 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005415
Gilles Peskine449bd832023-01-11 14:50:10 +01005416 if (output_size != output_length) {
5417 return PSA_ERROR_GENERIC_ERROR;
5418 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005419
Gilles Peskine449bd832023-01-11 14:50:10 +01005420 return PSA_SUCCESS;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005421}
5422#endif
5423
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305424#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305425static psa_status_t psa_key_derivation_pbkdf2_generate_block(
5426 psa_pbkdf2_key_derivation_t *pbkdf2,
5427 psa_algorithm_t prf_alg,
5428 uint8_t prf_output_length,
5429 psa_key_attributes_t *attributes)
5430{
5431 psa_status_t status;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305432 psa_mac_operation_t mac_operation = PSA_MAC_OPERATION_INIT;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305433 size_t mac_output_length;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305434 uint8_t U_i[PSA_MAC_MAX_SIZE];
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305435 uint8_t *U_accumulator = pbkdf2->output_block;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305436 uint64_t i;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305437 uint8_t block_counter[4];
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305438
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305439 mac_operation.is_sign = 1;
5440 mac_operation.mac_size = prf_output_length;
5441 MBEDTLS_PUT_UINT32_BE(pbkdf2->block_number, block_counter, 0);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305442
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305443 status = psa_driver_wrapper_mac_sign_setup(&mac_operation,
5444 attributes,
5445 pbkdf2->password,
5446 pbkdf2->password_length,
5447 prf_alg);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305448 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305449 goto cleanup;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305450 }
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305451 status = psa_mac_update(&mac_operation, pbkdf2->salt, pbkdf2->salt_length);
5452 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305453 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305454 }
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305455 status = psa_mac_update(&mac_operation, block_counter, sizeof(block_counter));
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305456 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305457 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305458 }
5459 status = psa_mac_sign_finish(&mac_operation, U_i, sizeof(U_i),
5460 &mac_output_length);
5461 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305462 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305463 }
5464
5465 if (mac_output_length != prf_output_length) {
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305466 status = PSA_ERROR_CORRUPTION_DETECTED;
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305467 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305468 }
5469
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305470 memcpy(U_accumulator, U_i, prf_output_length);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305471
5472 for (i = 1; i < pbkdf2->input_cost; i++) {
Kusumit Ghoderao4536bb62023-06-22 15:42:59 +05305473 /* We are passing prf_output_length as mac_size because the driver
5474 * function directly sets mac_output_length as mac_size upon success.
Kusumit Ghoderao5f3345a2023-07-27 21:21:38 +05305475 * See https://github.com/Mbed-TLS/mbedtls/issues/7801 */
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305476 status = psa_driver_wrapper_mac_compute(attributes,
5477 pbkdf2->password,
5478 pbkdf2->password_length,
5479 prf_alg, U_i, prf_output_length,
Kusumit Ghoderao4536bb62023-06-22 15:42:59 +05305480 U_i, prf_output_length,
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305481 &mac_output_length);
5482 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305483 goto cleanup;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305484 }
5485
Kusumit Ghoderao109ee3d2023-06-08 16:36:45 +05305486 mbedtls_xor(U_accumulator, U_accumulator, U_i, prf_output_length);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305487 }
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305488
5489cleanup:
5490 /* Zeroise buffers to clear sensitive data from memory. */
5491 mbedtls_platform_zeroize(U_i, PSA_MAC_MAX_SIZE);
5492 return status;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305493}
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05305494
5495static psa_status_t psa_key_derivation_pbkdf2_read(
5496 psa_pbkdf2_key_derivation_t *pbkdf2,
5497 psa_algorithm_t kdf_alg,
5498 uint8_t *output,
5499 size_t output_length)
5500{
5501 psa_status_t status;
5502 psa_algorithm_t prf_alg;
5503 uint8_t prf_output_length;
5504 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
5505 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(pbkdf2->password_length));
5506 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
5507
5508 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
5509 prf_alg = PSA_ALG_HMAC(PSA_ALG_PBKDF2_HMAC_GET_HASH(kdf_alg));
5510 prf_output_length = PSA_HASH_LENGTH(prf_alg);
5511 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
Kusumit Ghoderaoa2520a52023-06-22 15:42:19 +05305512 } else if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
5513 prf_alg = PSA_ALG_CMAC;
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05305514 prf_output_length = PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC);
Kusumit Ghoderaoa2520a52023-06-22 15:42:19 +05305515 psa_set_key_type(&attributes, PSA_KEY_TYPE_AES);
Kusumit Ghoderaod9ec1af2023-06-08 20:19:51 +05305516 } else {
5517 return PSA_ERROR_INVALID_ARGUMENT;
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05305518 }
5519
5520 switch (pbkdf2->state) {
5521 case PSA_PBKDF2_STATE_PASSWORD_SET:
5522 /* Initially we need a new block so bytes_used is equal to block size*/
5523 pbkdf2->bytes_used = prf_output_length;
5524 pbkdf2->state = PSA_PBKDF2_STATE_OUTPUT;
5525 break;
5526 case PSA_PBKDF2_STATE_OUTPUT:
5527 break;
5528 default:
5529 return PSA_ERROR_BAD_STATE;
5530 }
5531
5532 while (output_length != 0) {
5533 uint8_t n = prf_output_length - pbkdf2->bytes_used;
5534 if (n > output_length) {
5535 n = (uint8_t) output_length;
5536 }
5537 memcpy(output, pbkdf2->output_block + pbkdf2->bytes_used, n);
5538 output += n;
5539 output_length -= n;
5540 pbkdf2->bytes_used += n;
5541
5542 if (output_length == 0) {
5543 break;
5544 }
5545
5546 /* We need a new block */
5547 pbkdf2->bytes_used = 0;
5548 pbkdf2->block_number++;
5549
5550 status = psa_key_derivation_pbkdf2_generate_block(pbkdf2, prf_alg,
5551 prf_output_length,
5552 &attributes);
5553 if (status != PSA_SUCCESS) {
5554 return status;
5555 }
5556 }
5557
5558 return PSA_SUCCESS;
5559}
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305560#endif /* PSA_HAVE_SOFT_PBKDF2 */
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305561
Janos Follath6c6c8fc2019-06-17 12:38:20 +01005562psa_status_t psa_key_derivation_output_bytes(
5563 psa_key_derivation_operation_t *operation,
5564 uint8_t *output,
Gilles Peskine449bd832023-01-11 14:50:10 +01005565 size_t output_length)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005566{
5567 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01005568 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
Gilles Peskineeab56e42018-07-12 17:12:33 +02005569
Gilles Peskine449bd832023-01-11 14:50:10 +01005570 if (operation->alg == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005571 /* This is a blank operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005572 return PSA_ERROR_BAD_STATE;
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005573 }
5574
Gilles Peskine449bd832023-01-11 14:50:10 +01005575 if (output_length > operation->capacity) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005576 operation->capacity = 0;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005577 /* Go through the error path to wipe all confidential data now
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005578 * that the operation object is useless. */
David Saadab4ecc272019-02-14 13:48:10 +02005579 status = PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005580 goto exit;
5581 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005582 if (output_length == 0 && operation->capacity == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005583 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005584 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02005585 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
5586 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005587 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02005588 * output_length > 0. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005589 return PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005590 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005591 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005592
Przemek Stekiel69c46792022-06-10 12:59:51 +02005593#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01005594 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
5595 status = psa_key_derivation_hkdf_read(&operation->ctx.hkdf, kdf_alg,
5596 output, output_length);
5597 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02005598#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08005599#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5600 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005601 if (PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
5602 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
5603 status = psa_key_derivation_tls12_prf_read(&operation->ctx.tls12_prf,
5604 kdf_alg, output,
5605 output_length);
5606 } else
John Durkop07cc04a2020-11-16 22:08:34 -08005607#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
5608 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005609#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005610 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005611 status = psa_key_derivation_tls12_ecjpake_to_pms_read(
Gilles Peskine449bd832023-01-11 14:50:10 +01005612 &operation->ctx.tls12_ecjpake_to_pms, output, output_length);
5613 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005614#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305615#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05305616 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05305617 status = psa_key_derivation_pbkdf2_read(&operation->ctx.pbkdf2, kdf_alg,
5618 output, output_length);
Kusumit Ghoderao056f0c52023-05-03 15:58:34 +05305619 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305620#endif /* PSA_HAVE_SOFT_PBKDF2 */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005621
Gilles Peskineeab56e42018-07-12 17:12:33 +02005622 {
Steven Cooreman74afe472021-02-10 17:19:22 +01005623 (void) kdf_alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01005624 return PSA_ERROR_BAD_STATE;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005625 }
5626
5627exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005628 if (status != PSA_SUCCESS) {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005629 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005630 * This allows us to differentiate between exhausted operations and
5631 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
5632 * operations. */
5633 psa_algorithm_t alg = operation->alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01005634 psa_key_derivation_abort(operation);
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005635 operation->alg = alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01005636 memset(output, '!', output_length);
Gilles Peskineeab56e42018-07-12 17:12:33 +02005637 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005638 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005639}
5640
David Brown7807bf72021-02-09 16:28:23 -07005641#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01005642static void psa_des_set_key_parity(uint8_t *data, size_t data_size)
Gilles Peskine08542d82018-07-19 17:05:42 +02005643{
Gilles Peskine449bd832023-01-11 14:50:10 +01005644 if (data_size >= 8) {
5645 mbedtls_des_key_set_parity(data);
5646 }
5647 if (data_size >= 16) {
5648 mbedtls_des_key_set_parity(data + 8);
5649 }
5650 if (data_size >= 24) {
5651 mbedtls_des_key_set_parity(data + 16);
5652 }
Gilles Peskine08542d82018-07-19 17:05:42 +02005653}
David Brown7807bf72021-02-09 16:28:23 -07005654#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine08542d82018-07-19 17:05:42 +02005655
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005656/*
Gilles Peskine449bd832023-01-11 14:50:10 +01005657 * ECC keys on a Weierstrass elliptic curve require the generation
5658 * of a private key which is an integer
5659 * in the range [1, N - 1], where N is the boundary of the private key domain:
5660 * N is the prime p for Diffie-Hellman, or the order of the
5661 * curve’s base point for ECC.
5662 *
5663 * Let m be the bit size of N, such that 2^m > N >= 2^(m-1).
5664 * This function generates the private key using the following process:
5665 *
5666 * 1. Draw a byte string of length ceiling(m/8) bytes.
5667 * 2. If m is not a multiple of 8, set the most significant
5668 * (8 * ceiling(m/8) - m) bits of the first byte in the string to zero.
5669 * 3. Convert the string to integer k by decoding it as a big-endian byte string.
5670 * 4. If k > N - 2, discard the result and return to step 1.
5671 * 5. Output k + 1 as the private key.
5672 *
5673 * This method allows compliance to NIST standards, specifically the methods titled
5674 * Key-Pair Generation by Testing Candidates in the following publications:
5675 * - NIST Special Publication 800-56A: Recommendation for Pair-Wise Key-Establishment
5676 * Schemes Using Discrete Logarithm Cryptography [SP800-56A] §5.6.1.1.4 for
5677 * Diffie-Hellman keys.
5678 *
5679 * - [SP800-56A] §5.6.1.2.2 or FIPS Publication 186-4: Digital Signature
5680 * Standard (DSS) [FIPS186-4] §B.4.2 for elliptic curve keys.
5681 *
5682 * Note: Function allocates memory for *data buffer, so given *data should be
5683 * always NULL.
5684 */
Valerio Setti86587ab2023-06-27 13:09:30 +02005685#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE)
5686#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE)
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01005687static psa_status_t psa_generate_derived_ecc_key_weierstrass_helper(
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005688 psa_key_slot_t *slot,
5689 size_t bits,
5690 psa_key_derivation_operation_t *operation,
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005691 uint8_t **data
5692 )
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005693{
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005694 unsigned key_out_of_range = 1;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005695 mbedtls_mpi k;
5696 mbedtls_mpi diff_N_2;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005697 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Przemek Stekiela81aed22022-03-01 15:13:30 +01005698 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01005699 size_t m;
5700 size_t m_bytes;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005701
Gilles Peskine449bd832023-01-11 14:50:10 +01005702 mbedtls_mpi_init(&k);
5703 mbedtls_mpi_init(&diff_N_2);
Przemyslaw Stekiel1dfd1222021-11-18 13:35:00 +01005704
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005705 psa_ecc_family_t curve = PSA_KEY_TYPE_ECC_GET_FAMILY(
Gilles Peskine449bd832023-01-11 14:50:10 +01005706 slot->attr.type);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005707 mbedtls_ecp_group_id grp_id =
Gilles Peskine449bd832023-01-11 14:50:10 +01005708 mbedtls_ecc_group_of_psa(curve, bits, 0);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005709
Gilles Peskine449bd832023-01-11 14:50:10 +01005710 if (grp_id == MBEDTLS_ECP_DP_NONE) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005711 ret = MBEDTLS_ERR_ASN1_INVALID_DATA;
Przemyslaw Stekiel871a3362021-12-02 08:46:39 +01005712 goto cleanup;
5713 }
5714
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005715 mbedtls_ecp_group ecp_group;
Gilles Peskine449bd832023-01-11 14:50:10 +01005716 mbedtls_ecp_group_init(&ecp_group);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005717
Gilles Peskine449bd832023-01-11 14:50:10 +01005718 MBEDTLS_MPI_CHK(mbedtls_ecp_group_load(&ecp_group, grp_id));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005719
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005720 /* N is the boundary of the private key domain (ecp_group.N). */
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005721 /* Let m be the bit size of N. */
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01005722 m = ecp_group.nbits;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005723
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01005724 m_bytes = PSA_BITS_TO_BYTES(m);
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005725
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005726 /* Calculate N - 2 - it will be needed later. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005727 MBEDTLS_MPI_CHK(mbedtls_mpi_sub_int(&diff_N_2, &ecp_group.N, 2));
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005728
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005729 /* Note: This function is always called with *data == NULL and it
5730 * allocates memory for the data buffer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005731 *data = mbedtls_calloc(1, m_bytes);
5732 if (*data == NULL) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005733 ret = MBEDTLS_ERR_ASN1_ALLOC_FAILED;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005734 goto cleanup;
5735 }
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005736
Gilles Peskine449bd832023-01-11 14:50:10 +01005737 while (key_out_of_range) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005738 /* 1. Draw a byte string of length ceiling(m/8) bytes. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005739 if ((status = psa_key_derivation_output_bytes(operation, *data, m_bytes)) != 0) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005740 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005741 }
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005742
5743 /* 2. If m is not a multiple of 8 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005744 if (m % 8 != 0) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005745 /* Set the most significant
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005746 * (8 * ceiling(m/8) - m) bits of the first byte in
5747 * the string to zero.
5748 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005749 uint8_t clear_bit_mask = (1 << (m % 8)) - 1;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005750 (*data)[0] &= clear_bit_mask;
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005751 }
5752
5753 /* 3. Convert the string to integer k by decoding it as a
Gilles Peskine449bd832023-01-11 14:50:10 +01005754 * big-endian byte string.
5755 */
5756 MBEDTLS_MPI_CHK(mbedtls_mpi_read_binary(&k, *data, m_bytes));
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005757
5758 /* 4. If k > N - 2, discard the result and return to step 1.
Gilles Peskine449bd832023-01-11 14:50:10 +01005759 * Result of comparison is returned. When it indicates error
5760 * then this function is called again.
5761 */
5762 MBEDTLS_MPI_CHK(mbedtls_mpi_lt_mpi_ct(&diff_N_2, &k, &key_out_of_range));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005763 }
5764
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005765 /* 5. Output k + 1 as the private key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005766 MBEDTLS_MPI_CHK(mbedtls_mpi_add_int(&k, &k, 1));
5767 MBEDTLS_MPI_CHK(mbedtls_mpi_write_binary(&k, *data, m_bytes));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005768cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01005769 if (ret != 0) {
5770 status = mbedtls_to_psa_error(ret);
5771 }
5772 if (status != PSA_SUCCESS) {
5773 mbedtls_free(*data);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005774 *data = NULL;
5775 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005776 mbedtls_mpi_free(&k);
5777 mbedtls_mpi_free(&diff_N_2);
5778 return status;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005779}
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005780
5781/* ECC keys on a Montgomery elliptic curve draws a byte string whose length
5782 * is determined by the curve, and sets the mandatory bits accordingly. That is:
5783 *
5784 * - Curve25519 (PSA_ECC_FAMILY_MONTGOMERY, 255 bits):
5785 * draw a 32-byte string and process it as specified in
5786 * Elliptic Curves for Security [RFC7748] §5.
5787 *
5788 * - Curve448 (PSA_ECC_FAMILY_MONTGOMERY, 448 bits):
5789 * draw a 56-byte string and process it as specified in [RFC7748] §5.
5790 *
5791 * Note: Function allocates memory for *data buffer, so given *data should be
5792 * always NULL.
5793 */
5794
5795static psa_status_t psa_generate_derived_ecc_key_montgomery_helper(
5796 size_t bits,
5797 psa_key_derivation_operation_t *operation,
5798 uint8_t **data
5799 )
5800{
5801 size_t output_length;
Przemek Stekiela81aed22022-03-01 15:13:30 +01005802 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005803
Gilles Peskine449bd832023-01-11 14:50:10 +01005804 switch (bits) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005805 case 255:
5806 output_length = 32;
5807 break;
5808 case 448:
5809 output_length = 56;
5810 break;
5811 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005812 return PSA_ERROR_INVALID_ARGUMENT;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005813 break;
5814 }
5815
Gilles Peskine449bd832023-01-11 14:50:10 +01005816 *data = mbedtls_calloc(1, output_length);
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005817
Gilles Peskine449bd832023-01-11 14:50:10 +01005818 if (*data == NULL) {
5819 return PSA_ERROR_INSUFFICIENT_MEMORY;
5820 }
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005821
Gilles Peskine449bd832023-01-11 14:50:10 +01005822 status = psa_key_derivation_output_bytes(operation, *data, output_length);
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005823
Gilles Peskine449bd832023-01-11 14:50:10 +01005824 if (status != PSA_SUCCESS) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005825 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01005826 }
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005827
Gilles Peskine449bd832023-01-11 14:50:10 +01005828 switch (bits) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005829 case 255:
5830 (*data)[0] &= 248;
5831 (*data)[31] &= 127;
5832 (*data)[31] |= 64;
5833 break;
5834 case 448:
5835 (*data)[0] &= 252;
5836 (*data)[55] |= 128;
5837 break;
5838 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005839 return PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005840 break;
5841 }
5842
5843 return status;
5844}
Valerio Setti86587ab2023-06-27 13:09:30 +02005845#else /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE */
5846static psa_status_t psa_generate_derived_ecc_key_weierstrass_helper(
5847 psa_key_slot_t *slot, size_t bits,
5848 psa_key_derivation_operation_t *operation, uint8_t **data)
5849{
5850 (void) slot;
5851 (void) bits;
5852 (void) operation;
5853 (void) data;
5854 return PSA_ERROR_NOT_SUPPORTED;
5855}
5856
5857static psa_status_t psa_generate_derived_ecc_key_montgomery_helper(
5858 size_t bits, psa_key_derivation_operation_t *operation, uint8_t **data)
5859{
5860 (void) bits;
5861 (void) operation;
5862 (void) data;
5863 return PSA_ERROR_NOT_SUPPORTED;
5864}
5865#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE */
5866#endif /* PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE */
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005867
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01005868static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005869 psa_key_slot_t *slot,
5870 size_t bits,
Gilles Peskine449bd832023-01-11 14:50:10 +01005871 psa_key_derivation_operation_t *operation)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005872{
5873 uint8_t *data = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01005874 size_t bytes = PSA_BITS_TO_BYTES(bits);
Archanad8a83dc2021-06-14 10:04:16 +05305875 size_t storage_size = bytes;
Przemek Stekiela81aed22022-03-01 15:13:30 +01005876 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01005877 psa_key_attributes_t attributes;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005878
Gilles Peskine449bd832023-01-11 14:50:10 +01005879 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(slot->attr.type)) {
5880 return PSA_ERROR_INVALID_ARGUMENT;
5881 }
Gilles Peskineeab56e42018-07-12 17:12:33 +02005882
Valerio Setti8ffdb5d2023-06-20 13:14:08 +02005883#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE) || \
Valerio Settidd24f292023-06-26 12:21:17 +02005884 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE)
Gilles Peskine449bd832023-01-11 14:50:10 +01005885 if (PSA_KEY_TYPE_IS_ECC(slot->attr.type)) {
5886 psa_ecc_family_t curve = PSA_KEY_TYPE_ECC_GET_FAMILY(slot->attr.type);
5887 if (PSA_ECC_FAMILY_IS_WEIERSTRASS(curve)) {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01005888 /* Weierstrass elliptic curve */
Gilles Peskine449bd832023-01-11 14:50:10 +01005889 status = psa_generate_derived_ecc_key_weierstrass_helper(slot, bits, operation, &data);
5890 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005891 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005892 }
5893 } else {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01005894 /* Montgomery elliptic curve */
Gilles Peskine449bd832023-01-11 14:50:10 +01005895 status = psa_generate_derived_ecc_key_montgomery_helper(bits, operation, &data);
5896 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01005897 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005898 }
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01005899 }
Przemyslaw Stekiel1dfd1222021-11-18 13:35:00 +01005900 } else
Valerio Setti8ffdb5d2023-06-20 13:14:08 +02005901#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE) ||
Valerio Settidd24f292023-06-26 12:21:17 +02005902 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE) */
Gilles Peskine449bd832023-01-11 14:50:10 +01005903 if (key_type_is_raw_bytes(slot->attr.type)) {
5904 if (bits % 8 != 0) {
5905 return PSA_ERROR_INVALID_ARGUMENT;
5906 }
5907 data = mbedtls_calloc(1, bytes);
5908 if (data == NULL) {
5909 return PSA_ERROR_INSUFFICIENT_MEMORY;
5910 }
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01005911
Gilles Peskine449bd832023-01-11 14:50:10 +01005912 status = psa_key_derivation_output_bytes(operation, data, bytes);
5913 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01005914 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005915 }
David Brown12ca5032021-02-11 11:02:00 -07005916#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01005917 if (slot->attr.type == PSA_KEY_TYPE_DES) {
5918 psa_des_set_key_parity(data, bytes);
5919 }
Przemek Stekielf110dc02022-03-01 14:48:05 +01005920#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES) */
Gilles Peskine449bd832023-01-11 14:50:10 +01005921 } else {
5922 return PSA_ERROR_NOT_SUPPORTED;
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01005923 }
Ronald Crondd04d422020-11-28 15:14:42 +01005924
Ronald Cronbf33c932020-11-28 18:06:53 +01005925 slot->attr.bits = (psa_key_bits_t) bits;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01005926 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01005927 .core = slot->attr
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01005928 };
5929
Gilles Peskine449bd832023-01-11 14:50:10 +01005930 if (psa_key_lifetime_is_external(attributes.core.lifetime)) {
5931 status = psa_driver_wrapper_get_key_buffer_size(&attributes,
5932 &storage_size);
5933 if (status != PSA_SUCCESS) {
Archanad8a83dc2021-06-14 10:04:16 +05305934 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005935 }
Archanad8a83dc2021-06-14 10:04:16 +05305936 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005937 status = psa_allocate_buffer_to_slot(slot, storage_size);
5938 if (status != PSA_SUCCESS) {
Archanad8a83dc2021-06-14 10:04:16 +05305939 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005940 }
Archanad8a83dc2021-06-14 10:04:16 +05305941
Gilles Peskine449bd832023-01-11 14:50:10 +01005942 status = psa_driver_wrapper_import_key(&attributes,
5943 data, bytes,
5944 slot->key.data,
5945 slot->key.bytes,
5946 &slot->key.bytes, &bits);
5947 if (bits != slot->attr.bits) {
Ronald Cronbf33c932020-11-28 18:06:53 +01005948 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine449bd832023-01-11 14:50:10 +01005949 }
Gilles Peskineeab56e42018-07-12 17:12:33 +02005950
5951exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005952 mbedtls_free(data);
5953 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005954}
5955
Gilles Peskine449bd832023-01-11 14:50:10 +01005956psa_status_t psa_key_derivation_output_key(const psa_key_attributes_t *attributes,
5957 psa_key_derivation_operation_t *operation,
5958 mbedtls_svc_key_id_t *key)
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005959{
5960 psa_status_t status;
5961 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02005962 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine0f84d622019-09-12 19:03:13 +02005963
Ronald Cron81709fc2020-11-14 12:10:32 +01005964 *key = MBEDTLS_SVC_KEY_ID_INIT;
5965
Gilles Peskine0f84d622019-09-12 19:03:13 +02005966 /* Reject any attempt to create a zero-length key so that we don't
5967 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005968 if (psa_get_key_bits(attributes) == 0) {
5969 return PSA_ERROR_INVALID_ARGUMENT;
5970 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02005971
Gilles Peskine449bd832023-01-11 14:50:10 +01005972 if (operation->alg == PSA_ALG_NONE) {
5973 return PSA_ERROR_BAD_STATE;
5974 }
Dave Rodgmand69da6c2021-11-16 10:32:48 +00005975
Gilles Peskine449bd832023-01-11 14:50:10 +01005976 if (!operation->can_output_key) {
5977 return PSA_ERROR_NOT_PERMITTED;
5978 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02005979
Gilles Peskine449bd832023-01-11 14:50:10 +01005980 status = psa_start_key_creation(PSA_KEY_CREATION_DERIVE, attributes,
5981 &slot, &driver);
Gilles Peskinef4ee6622019-07-24 13:44:30 +02005982#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005983 if (driver != NULL) {
Gilles Peskinef4ee6622019-07-24 13:44:30 +02005984 /* Deriving a key in a secure element is not implemented yet. */
5985 status = PSA_ERROR_NOT_SUPPORTED;
5986 }
5987#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine449bd832023-01-11 14:50:10 +01005988 if (status == PSA_SUCCESS) {
5989 status = psa_generate_derived_key_internal(slot,
5990 attributes->core.bits,
5991 operation);
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005992 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005993 if (status == PSA_SUCCESS) {
5994 status = psa_finish_key_creation(slot, driver, key);
5995 }
5996 if (status != PSA_SUCCESS) {
5997 psa_fail_key_creation(slot, driver);
5998 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02005999
Gilles Peskine449bd832023-01-11 14:50:10 +01006000 return status;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006001}
6002
Gilles Peskineeab56e42018-07-12 17:12:33 +02006003
6004
6005/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02006006/* Key derivation */
6007/****************************************************************/
6008
Steven Cooreman932ffb72021-02-15 12:14:32 +01006009#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006010static int is_kdf_alg_supported(psa_algorithm_t kdf_alg)
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006011{
6012#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006013 if (PSA_ALG_IS_HKDF(kdf_alg)) {
6014 return 1;
6015 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006016#endif
Przemek Stekielb57a44b2022-06-06 08:33:45 +02006017#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006018 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6019 return 1;
6020 }
Przemek Stekielb57a44b2022-06-06 08:33:45 +02006021#endif
6022#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006023 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
6024 return 1;
6025 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006026#endif
6027#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006028 if (PSA_ALG_IS_TLS12_PRF(kdf_alg)) {
6029 return 1;
6030 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006031#endif
6032#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006033 if (PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
6034 return 1;
6035 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006036#endif
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006037#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006038 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
6039 return 1;
6040 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006041#endif
Kusumit Ghoderaod132cac2023-05-03 12:00:27 +05306042#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
6043 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
6044 return 1;
6045 }
6046#endif
Kusumit Ghoderao2cd64962023-06-22 15:38:57 +05306047#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128)
6048 if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
6049 return 1;
6050 }
6051#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006052 return 0;
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006053}
6054
Gilles Peskine449bd832023-01-11 14:50:10 +01006055static psa_status_t psa_hash_try_support(psa_algorithm_t alg)
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006056{
6057 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01006058 psa_status_t status = psa_hash_setup(&operation, alg);
6059 psa_hash_abort(&operation);
6060 return status;
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006061}
6062
Gilles Peskine969c5d62019-01-16 15:53:06 +01006063static psa_status_t psa_key_derivation_setup_kdf(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006064 psa_key_derivation_operation_t *operation,
Gilles Peskine449bd832023-01-11 14:50:10 +01006065 psa_algorithm_t kdf_alg)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006066{
Janos Follath5fe19732019-06-20 15:09:30 +01006067 /* Make sure that operation->ctx is properly zero-initialised. (Macro
6068 * initialisers for this union leave some bytes unspecified.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01006069 memset(&operation->ctx, 0, sizeof(operation->ctx));
Janos Follath5fe19732019-06-20 15:09:30 +01006070
Gilles Peskine969c5d62019-01-16 15:53:06 +01006071 /* Make sure that kdf_alg is a supported key derivation algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006072 if (!is_kdf_alg_supported(kdf_alg)) {
6073 return PSA_ERROR_NOT_SUPPORTED;
6074 }
John Durkop07cc04a2020-11-16 22:08:34 -08006075
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006076 /* All currently supported key derivation algorithms (apart from
Kusumit Ghoderao2cd64962023-06-22 15:38:57 +05306077 * ecjpake to pms and pbkdf2_aes_cmac_128) are based on a hash algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006078 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
6079 size_t hash_size = PSA_HASH_LENGTH(hash_alg);
Kusumit Ghoderao2cd64962023-06-22 15:38:57 +05306080 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
6081 hash_size = PSA_HASH_LENGTH(PSA_ALG_SHA_256);
6082 } else if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306083 hash_size = PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC);
Kusumit Ghoderao2cd64962023-06-22 15:38:57 +05306084 } else {
Gilles Peskine449bd832023-01-11 14:50:10 +01006085 if (hash_size == 0) {
6086 return PSA_ERROR_NOT_SUPPORTED;
6087 }
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006088
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006089 /* Make sure that hash_alg is a supported hash algorithm. Otherwise
6090 * we might fail later, which is somewhat unfriendly and potentially
6091 * risk-prone. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006092 psa_status_t status = psa_hash_try_support(hash_alg);
6093 if (status != PSA_SUCCESS) {
6094 return status;
6095 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006096 }
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006097
Gilles Peskine449bd832023-01-11 14:50:10 +01006098 if ((PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
6099 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) &&
6100 !(hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384)) {
6101 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006102 }
Andrzej Kurek77638292022-09-16 12:24:52 -04006103#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT) || \
Andrzej Kurekb510cd22022-09-26 10:50:22 -04006104 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006105 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg) ||
6106 (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS)) {
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006107 operation->capacity = hash_size;
Gilles Peskine449bd832023-01-11 14:50:10 +01006108 } else
Andrzej Kurekb510cd22022-09-26 10:50:22 -04006109#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT ||
6110 MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Gilles Peskine449bd832023-01-11 14:50:10 +01006111 operation->capacity = 255 * hash_size;
6112 return PSA_SUCCESS;
Gilles Peskine969c5d62019-01-16 15:53:06 +01006113}
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006114
Gilles Peskine449bd832023-01-11 14:50:10 +01006115static psa_status_t psa_key_agreement_try_support(psa_algorithm_t alg)
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006116{
6117#if defined(PSA_WANT_ALG_ECDH)
Gilles Peskine449bd832023-01-11 14:50:10 +01006118 if (alg == PSA_ALG_ECDH) {
6119 return PSA_SUCCESS;
6120 }
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006121#endif
Przemek Stekielfb3dd542022-12-01 14:59:15 +01006122#if defined(PSA_WANT_ALG_FFDH)
6123 if (alg == PSA_ALG_FFDH) {
6124 return PSA_SUCCESS;
6125 }
6126#endif
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006127 (void) alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01006128 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006129}
Gilles Peskinebb3814c2022-12-16 01:12:12 +01006130
6131static int psa_key_derivation_allows_free_form_secret_input(
6132 psa_algorithm_t kdf_alg)
6133{
6134#if defined(PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS)
6135 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
6136 return 0;
6137 }
6138#endif
6139 (void) kdf_alg;
6140 return 1;
6141}
John Durkop07cc04a2020-11-16 22:08:34 -08006142#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01006143
Gilles Peskine449bd832023-01-11 14:50:10 +01006144psa_status_t psa_key_derivation_setup(psa_key_derivation_operation_t *operation,
6145 psa_algorithm_t alg)
Gilles Peskine969c5d62019-01-16 15:53:06 +01006146{
6147 psa_status_t status;
6148
Gilles Peskine449bd832023-01-11 14:50:10 +01006149 if (operation->alg != 0) {
6150 return PSA_ERROR_BAD_STATE;
Gilles Peskine969c5d62019-01-16 15:53:06 +01006151 }
Gilles Peskine969c5d62019-01-16 15:53:06 +01006152
Gilles Peskine449bd832023-01-11 14:50:10 +01006153 if (PSA_ALG_IS_RAW_KEY_AGREEMENT(alg)) {
6154 return PSA_ERROR_INVALID_ARGUMENT;
6155 } else if (PSA_ALG_IS_KEY_AGREEMENT(alg)) {
6156#if defined(AT_LEAST_ONE_BUILTIN_KDF)
6157 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF(alg);
6158 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE(alg);
6159 status = psa_key_agreement_try_support(ka_alg);
6160 if (status != PSA_SUCCESS) {
6161 return status;
6162 }
Gilles Peskinebb3814c2022-12-16 01:12:12 +01006163 if (!psa_key_derivation_allows_free_form_secret_input(kdf_alg)) {
6164 return PSA_ERROR_INVALID_ARGUMENT;
6165 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006166 status = psa_key_derivation_setup_kdf(operation, kdf_alg);
6167#else
6168 return PSA_ERROR_NOT_SUPPORTED;
6169#endif /* AT_LEAST_ONE_BUILTIN_KDF */
6170 } else if (PSA_ALG_IS_KEY_DERIVATION(alg)) {
6171#if defined(AT_LEAST_ONE_BUILTIN_KDF)
6172 status = psa_key_derivation_setup_kdf(operation, alg);
6173#else
6174 return PSA_ERROR_NOT_SUPPORTED;
6175#endif /* AT_LEAST_ONE_BUILTIN_KDF */
6176 } else {
6177 return PSA_ERROR_INVALID_ARGUMENT;
6178 }
6179
6180 if (status == PSA_SUCCESS) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006181 operation->alg = alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01006182 }
6183 return status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006184}
6185
Przemek Stekiel69c46792022-06-10 12:59:51 +02006186#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006187static psa_status_t psa_hkdf_input(psa_hkdf_key_derivation_t *hkdf,
6188 psa_algorithm_t kdf_alg,
6189 psa_key_derivation_step_t step,
6190 const uint8_t *data,
6191 size_t data_length)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006192{
Gilles Peskine449bd832023-01-11 14:50:10 +01006193 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006194 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006195 switch (step) {
Gilles Peskine03410b52019-05-16 16:05:19 +02006196 case PSA_KEY_DERIVATION_INPUT_SALT:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006197#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006198 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
6199 return PSA_ERROR_INVALID_ARGUMENT;
6200 }
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006201#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND */
Gilles Peskine449bd832023-01-11 14:50:10 +01006202 if (hkdf->state != HKDF_STATE_INIT) {
6203 return PSA_ERROR_BAD_STATE;
6204 } else {
6205 status = psa_key_derivation_start_hmac(&hkdf->hmac,
6206 hash_alg,
6207 data, data_length);
6208 if (status != PSA_SUCCESS) {
6209 return status;
6210 }
Steven Cooremand1ed1d92021-04-29 19:11:25 +02006211 hkdf->state = HKDF_STATE_STARTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01006212 return PSA_SUCCESS;
Steven Cooremand1ed1d92021-04-29 19:11:25 +02006213 }
Gilles Peskine03410b52019-05-16 16:05:19 +02006214 case PSA_KEY_DERIVATION_INPUT_SECRET:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006215#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006216 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
Przemek Stekiel2fb0dcd2022-05-19 10:34:37 +02006217 /* We shouldn't be in different state as HKDF_EXPAND only allows
6218 * two inputs: SECRET (this case) and INFO which does not modify
6219 * the state. It could happen only if the hkdf
6220 * object was corrupted. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006221 if (hkdf->state != HKDF_STATE_INIT) {
6222 return PSA_ERROR_BAD_STATE;
6223 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006224
Przemek Stekiel2fb0dcd2022-05-19 10:34:37 +02006225 /* Allow only input that fits expected prk size */
Gilles Peskine449bd832023-01-11 14:50:10 +01006226 if (data_length != PSA_HASH_LENGTH(hash_alg)) {
6227 return PSA_ERROR_INVALID_ARGUMENT;
6228 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006229
Gilles Peskine449bd832023-01-11 14:50:10 +01006230 memcpy(hkdf->prk, data, data_length);
6231 } else
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006232#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND */
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006233 {
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006234 /* HKDF: If no salt was provided, use an empty salt.
6235 * HKDF-EXTRACT: salt is mandatory. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006236 if (hkdf->state == HKDF_STATE_INIT) {
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006237#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006238 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6239 return PSA_ERROR_BAD_STATE;
6240 }
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006241#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01006242 status = psa_key_derivation_start_hmac(&hkdf->hmac,
6243 hash_alg,
6244 NULL, 0);
6245 if (status != PSA_SUCCESS) {
6246 return status;
6247 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006248 hkdf->state = HKDF_STATE_STARTED;
6249 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006250 if (hkdf->state != HKDF_STATE_STARTED) {
6251 return PSA_ERROR_BAD_STATE;
6252 }
6253 status = psa_mac_update(&hkdf->hmac,
6254 data, data_length);
6255 if (status != PSA_SUCCESS) {
6256 return status;
6257 }
6258 status = psa_mac_sign_finish(&hkdf->hmac,
6259 hkdf->prk,
6260 sizeof(hkdf->prk),
6261 &data_length);
6262 if (status != PSA_SUCCESS) {
6263 return status;
6264 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006265 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006266
Gilles Peskine2b522db2019-04-12 15:11:49 +02006267 hkdf->state = HKDF_STATE_KEYED;
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006268 hkdf->block_number = 0;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006269#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006270 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006271 /* The only block of output is the PRK. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006272 memcpy(hkdf->output_block, hkdf->prk, PSA_HASH_LENGTH(hash_alg));
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006273 hkdf->offset_in_block = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01006274 } else
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006275#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006276 {
6277 /* Block 0 is empty, and the next block will be
6278 * generated by psa_key_derivation_hkdf_read(). */
Gilles Peskine449bd832023-01-11 14:50:10 +01006279 hkdf->offset_in_block = PSA_HASH_LENGTH(hash_alg);
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006280 }
6281
Gilles Peskine449bd832023-01-11 14:50:10 +01006282 return PSA_SUCCESS;
Gilles Peskine03410b52019-05-16 16:05:19 +02006283 case PSA_KEY_DERIVATION_INPUT_INFO:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006284#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006285 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6286 return PSA_ERROR_INVALID_ARGUMENT;
6287 }
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006288#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Przemek Stekielcde3f782022-06-03 16:12:27 +02006289#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006290 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg) &&
6291 hkdf->state == HKDF_STATE_INIT) {
6292 return PSA_ERROR_BAD_STATE;
6293 }
Przemek Stekielcde3f782022-06-03 16:12:27 +02006294#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01006295 if (hkdf->state == HKDF_STATE_OUTPUT) {
6296 return PSA_ERROR_BAD_STATE;
6297 }
6298 if (hkdf->info_set) {
6299 return PSA_ERROR_BAD_STATE;
6300 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006301 hkdf->info_length = data_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01006302 if (data_length != 0) {
6303 hkdf->info = mbedtls_calloc(1, data_length);
6304 if (hkdf->info == NULL) {
6305 return PSA_ERROR_INSUFFICIENT_MEMORY;
6306 }
6307 memcpy(hkdf->info, data, data_length);
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006308 }
6309 hkdf->info_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01006310 return PSA_SUCCESS;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006311 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006312 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006313 }
6314}
Przemek Stekiel69c46792022-06-10 12:59:51 +02006315#endif /* BUILTIN_ALG_ANY_HKDF */
Janos Follathb03233e2019-06-11 15:30:30 +01006316
John Durkop07cc04a2020-11-16 22:08:34 -08006317#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
6318 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006319static psa_status_t psa_tls12_prf_set_seed(psa_tls12_prf_key_derivation_t *prf,
6320 const uint8_t *data,
6321 size_t data_length)
Janos Follathf08e2652019-06-13 09:05:41 +01006322{
Gilles Peskine449bd832023-01-11 14:50:10 +01006323 if (prf->state != PSA_TLS12_PRF_STATE_INIT) {
6324 return PSA_ERROR_BAD_STATE;
6325 }
Janos Follathf08e2652019-06-13 09:05:41 +01006326
Gilles Peskine449bd832023-01-11 14:50:10 +01006327 if (data_length != 0) {
6328 prf->seed = mbedtls_calloc(1, data_length);
6329 if (prf->seed == NULL) {
6330 return PSA_ERROR_INSUFFICIENT_MEMORY;
6331 }
Janos Follathf08e2652019-06-13 09:05:41 +01006332
Gilles Peskine449bd832023-01-11 14:50:10 +01006333 memcpy(prf->seed, data, data_length);
Janos Follathd6dce9f2019-07-04 09:11:38 +01006334 prf->seed_length = data_length;
6335 }
Janos Follathf08e2652019-06-13 09:05:41 +01006336
Gilles Peskine43f958b2020-12-13 14:55:14 +01006337 prf->state = PSA_TLS12_PRF_STATE_SEED_SET;
Janos Follathf08e2652019-06-13 09:05:41 +01006338
Gilles Peskine449bd832023-01-11 14:50:10 +01006339 return PSA_SUCCESS;
Janos Follathf08e2652019-06-13 09:05:41 +01006340}
6341
Gilles Peskine449bd832023-01-11 14:50:10 +01006342static psa_status_t psa_tls12_prf_set_key(psa_tls12_prf_key_derivation_t *prf,
6343 const uint8_t *data,
6344 size_t data_length)
Janos Follath81550542019-06-13 14:26:34 +01006345{
Gilles Peskine449bd832023-01-11 14:50:10 +01006346 if (prf->state != PSA_TLS12_PRF_STATE_SEED_SET &&
6347 prf->state != PSA_TLS12_PRF_STATE_OTHER_KEY_SET) {
6348 return PSA_ERROR_BAD_STATE;
6349 }
Janos Follath81550542019-06-13 14:26:34 +01006350
Gilles Peskine449bd832023-01-11 14:50:10 +01006351 if (data_length != 0) {
6352 prf->secret = mbedtls_calloc(1, data_length);
6353 if (prf->secret == NULL) {
6354 return PSA_ERROR_INSUFFICIENT_MEMORY;
6355 }
Steven Cooremana6df6042021-04-29 19:32:25 +02006356
Gilles Peskine449bd832023-01-11 14:50:10 +01006357 memcpy(prf->secret, data, data_length);
Steven Cooremana6df6042021-04-29 19:32:25 +02006358 prf->secret_length = data_length;
6359 }
Janos Follath81550542019-06-13 14:26:34 +01006360
Gilles Peskine43f958b2020-12-13 14:55:14 +01006361 prf->state = PSA_TLS12_PRF_STATE_KEY_SET;
Janos Follath81550542019-06-13 14:26:34 +01006362
Gilles Peskine449bd832023-01-11 14:50:10 +01006363 return PSA_SUCCESS;
Janos Follath81550542019-06-13 14:26:34 +01006364}
6365
Gilles Peskine449bd832023-01-11 14:50:10 +01006366static psa_status_t psa_tls12_prf_set_label(psa_tls12_prf_key_derivation_t *prf,
6367 const uint8_t *data,
6368 size_t data_length)
Janos Follath63028dd2019-06-13 09:15:47 +01006369{
Gilles Peskine449bd832023-01-11 14:50:10 +01006370 if (prf->state != PSA_TLS12_PRF_STATE_KEY_SET) {
6371 return PSA_ERROR_BAD_STATE;
6372 }
Janos Follath63028dd2019-06-13 09:15:47 +01006373
Gilles Peskine449bd832023-01-11 14:50:10 +01006374 if (data_length != 0) {
6375 prf->label = mbedtls_calloc(1, data_length);
6376 if (prf->label == NULL) {
6377 return PSA_ERROR_INSUFFICIENT_MEMORY;
6378 }
Janos Follath63028dd2019-06-13 09:15:47 +01006379
Gilles Peskine449bd832023-01-11 14:50:10 +01006380 memcpy(prf->label, data, data_length);
Janos Follathd6dce9f2019-07-04 09:11:38 +01006381 prf->label_length = data_length;
6382 }
Janos Follath63028dd2019-06-13 09:15:47 +01006383
Gilles Peskine43f958b2020-12-13 14:55:14 +01006384 prf->state = PSA_TLS12_PRF_STATE_LABEL_SET;
Janos Follath63028dd2019-06-13 09:15:47 +01006385
Gilles Peskine449bd832023-01-11 14:50:10 +01006386 return PSA_SUCCESS;
Janos Follath63028dd2019-06-13 09:15:47 +01006387}
6388
Gilles Peskine449bd832023-01-11 14:50:10 +01006389static psa_status_t psa_tls12_prf_input(psa_tls12_prf_key_derivation_t *prf,
6390 psa_key_derivation_step_t step,
6391 const uint8_t *data,
6392 size_t data_length)
Janos Follathb03233e2019-06-11 15:30:30 +01006393{
Gilles Peskine449bd832023-01-11 14:50:10 +01006394 switch (step) {
Janos Follathf08e2652019-06-13 09:05:41 +01006395 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskine449bd832023-01-11 14:50:10 +01006396 return psa_tls12_prf_set_seed(prf, data, data_length);
Janos Follath81550542019-06-13 14:26:34 +01006397 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006398 return psa_tls12_prf_set_key(prf, data, data_length);
Janos Follath63028dd2019-06-13 09:15:47 +01006399 case PSA_KEY_DERIVATION_INPUT_LABEL:
Gilles Peskine449bd832023-01-11 14:50:10 +01006400 return psa_tls12_prf_set_label(prf, data, data_length);
Janos Follathb03233e2019-06-11 15:30:30 +01006401 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006402 return PSA_ERROR_INVALID_ARGUMENT;
Janos Follathb03233e2019-06-11 15:30:30 +01006403 }
6404}
John Durkop07cc04a2020-11-16 22:08:34 -08006405#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
6406 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
6407
6408#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
6409static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
6410 psa_tls12_prf_key_derivation_t *prf,
John Durkop07cc04a2020-11-16 22:08:34 -08006411 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006412 size_t data_length)
John Durkop07cc04a2020-11-16 22:08:34 -08006413{
6414 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006415 const size_t pms_len = (prf->state == PSA_TLS12_PRF_STATE_OTHER_KEY_SET ?
6416 4 + data_length + prf->other_secret_length :
6417 4 + 2 * data_length);
John Durkop07cc04a2020-11-16 22:08:34 -08006418
Gilles Peskine449bd832023-01-11 14:50:10 +01006419 if (data_length > PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE) {
6420 return PSA_ERROR_INVALID_ARGUMENT;
6421 }
John Durkop07cc04a2020-11-16 22:08:34 -08006422
Gilles Peskine449bd832023-01-11 14:50:10 +01006423 uint8_t *pms = mbedtls_calloc(1, pms_len);
6424 if (pms == NULL) {
6425 return PSA_ERROR_INSUFFICIENT_MEMORY;
6426 }
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02006427 uint8_t *cur = pms;
6428
6429 /* pure-PSK:
6430 * Quoting RFC 4279, Section 2:
John Durkop07cc04a2020-11-16 22:08:34 -08006431 *
6432 * The premaster secret is formed as follows: if the PSK is N octets
6433 * long, concatenate a uint16 with the value N, N zero octets, a second
6434 * uint16 with the value N, and the PSK itself.
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02006435 *
6436 * mixed-PSK:
6437 * In a DHE-PSK, RSA-PSK, ECDHE-PSK the premaster secret is formed as
6438 * follows: concatenate a uint16 with the length of the other secret,
6439 * the other secret itself, uint16 with the length of PSK, and the
6440 * PSK itself.
6441 * For details please check:
6442 * - RFC 4279, Section 4 for the definition of RSA-PSK,
6443 * - RFC 4279, Section 3 for the definition of DHE-PSK,
6444 * - RFC 5489 for the definition of ECDHE-PSK.
John Durkop07cc04a2020-11-16 22:08:34 -08006445 */
6446
Gilles Peskine449bd832023-01-11 14:50:10 +01006447 if (prf->state == PSA_TLS12_PRF_STATE_OTHER_KEY_SET) {
6448 *cur++ = MBEDTLS_BYTE_1(prf->other_secret_length);
6449 *cur++ = MBEDTLS_BYTE_0(prf->other_secret_length);
6450 if (prf->other_secret_length != 0) {
6451 memcpy(cur, prf->other_secret, prf->other_secret_length);
6452 mbedtls_platform_zeroize(prf->other_secret, prf->other_secret_length);
Przemek Stekiel2503f7e2022-04-12 12:08:01 +02006453 cur += prf->other_secret_length;
6454 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006455 } else {
6456 *cur++ = MBEDTLS_BYTE_1(data_length);
6457 *cur++ = MBEDTLS_BYTE_0(data_length);
6458 memset(cur, 0, data_length);
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02006459 cur += data_length;
6460 }
6461
Gilles Peskine449bd832023-01-11 14:50:10 +01006462 *cur++ = MBEDTLS_BYTE_1(data_length);
6463 *cur++ = MBEDTLS_BYTE_0(data_length);
6464 memcpy(cur, data, data_length);
John Durkop07cc04a2020-11-16 22:08:34 -08006465 cur += data_length;
6466
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00006467 status = psa_tls12_prf_set_key(prf, pms, (size_t) (cur - pms));
John Durkop07cc04a2020-11-16 22:08:34 -08006468
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01006469 mbedtls_zeroize_and_free(pms, pms_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01006470 return status;
John Durkop07cc04a2020-11-16 22:08:34 -08006471}
Janos Follath6660f0e2019-06-17 08:44:03 +01006472
Przemek Stekiele47201b2022-04-19 13:53:28 +02006473static psa_status_t psa_tls12_prf_psk_to_ms_set_other_key(
6474 psa_tls12_prf_key_derivation_t *prf,
6475 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006476 size_t data_length)
Przemek Stekiele47201b2022-04-19 13:53:28 +02006477{
Gilles Peskine449bd832023-01-11 14:50:10 +01006478 if (prf->state != PSA_TLS12_PRF_STATE_SEED_SET) {
6479 return PSA_ERROR_BAD_STATE;
Przemek Stekiele47201b2022-04-19 13:53:28 +02006480 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006481
6482 if (data_length != 0) {
6483 prf->other_secret = mbedtls_calloc(1, data_length);
6484 if (prf->other_secret == NULL) {
6485 return PSA_ERROR_INSUFFICIENT_MEMORY;
6486 }
6487
6488 memcpy(prf->other_secret, data, data_length);
6489 prf->other_secret_length = data_length;
6490 } else {
Przemek Stekiele47201b2022-04-19 13:53:28 +02006491 prf->other_secret_length = 0;
6492 }
6493
6494 prf->state = PSA_TLS12_PRF_STATE_OTHER_KEY_SET;
6495
Gilles Peskine449bd832023-01-11 14:50:10 +01006496 return PSA_SUCCESS;
Przemek Stekiele47201b2022-04-19 13:53:28 +02006497}
6498
Janos Follath6660f0e2019-06-17 08:44:03 +01006499static psa_status_t psa_tls12_prf_psk_to_ms_input(
6500 psa_tls12_prf_key_derivation_t *prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01006501 psa_key_derivation_step_t step,
6502 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006503 size_t data_length)
Janos Follath6660f0e2019-06-17 08:44:03 +01006504{
Gilles Peskine449bd832023-01-11 14:50:10 +01006505 switch (step) {
Przemek Stekiele47201b2022-04-19 13:53:28 +02006506 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006507 return psa_tls12_prf_psk_to_ms_set_key(prf,
6508 data, data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02006509 break;
6510 case PSA_KEY_DERIVATION_INPUT_OTHER_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006511 return psa_tls12_prf_psk_to_ms_set_other_key(prf,
6512 data,
6513 data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02006514 break;
6515 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006516 return psa_tls12_prf_input(prf, step, data, data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02006517 break;
Janos Follath6660f0e2019-06-17 08:44:03 +01006518
Przemek Stekiele47201b2022-04-19 13:53:28 +02006519 }
Janos Follath6660f0e2019-06-17 08:44:03 +01006520}
John Durkop07cc04a2020-11-16 22:08:34 -08006521#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006522
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006523#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
6524static psa_status_t psa_tls12_ecjpake_to_pms_input(
6525 psa_tls12_ecjpake_to_pms_t *ecjpake,
Andrzej Kurek702776f2022-09-16 06:22:44 -04006526 psa_key_derivation_step_t step,
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006527 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006528 size_t data_length)
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006529{
Gilles Peskine449bd832023-01-11 14:50:10 +01006530 if (data_length != PSA_TLS12_ECJPAKE_TO_PMS_INPUT_SIZE ||
6531 step != PSA_KEY_DERIVATION_INPUT_SECRET) {
6532 return PSA_ERROR_INVALID_ARGUMENT;
Andrzej Kurek5603efd2022-09-26 10:49:16 -04006533 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006534
6535 /* Check if the passed point is in an uncompressed form */
Gilles Peskine449bd832023-01-11 14:50:10 +01006536 if (data[0] != 0x04) {
6537 return PSA_ERROR_INVALID_ARGUMENT;
6538 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006539
6540 /* Only K.X has to be extracted - bytes 1 to 32 inclusive. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006541 memcpy(ecjpake->data, data + 1, PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE);
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006542
Gilles Peskine449bd832023-01-11 14:50:10 +01006543 return PSA_SUCCESS;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006544}
6545#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306546
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306547#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306548static psa_status_t psa_pbkdf2_set_input_cost(
6549 psa_pbkdf2_key_derivation_t *pbkdf2,
6550 psa_key_derivation_step_t step,
6551 uint64_t data)
6552{
6553 if (step != PSA_KEY_DERIVATION_INPUT_COST) {
6554 return PSA_ERROR_INVALID_ARGUMENT;
6555 }
6556
6557 if (pbkdf2->state != PSA_PBKDF2_STATE_INIT) {
6558 return PSA_ERROR_BAD_STATE;
6559 }
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05306560
Kusumit Ghoderaoe66a8ad2023-05-24 12:30:43 +05306561 if (data > PSA_VENDOR_PBKDF2_MAX_ITERATIONS) {
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05306562 return PSA_ERROR_NOT_SUPPORTED;
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306563 }
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05306564
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306565 if (data == 0) {
6566 return PSA_ERROR_INVALID_ARGUMENT;
6567 }
Kusumit Ghoderaoe66a8ad2023-05-24 12:30:43 +05306568
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306569 pbkdf2->input_cost = data;
6570 pbkdf2->state = PSA_PBKDF2_STATE_INPUT_COST_SET;
6571
6572 return PSA_SUCCESS;
6573}
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306574
6575static psa_status_t psa_pbkdf2_set_salt(psa_pbkdf2_key_derivation_t *pbkdf2,
6576 const uint8_t *data,
6577 size_t data_length)
6578{
Gilles Peskineead17662023-08-20 22:02:51 +02006579 if (pbkdf2->state == PSA_PBKDF2_STATE_INPUT_COST_SET) {
6580 pbkdf2->state = PSA_PBKDF2_STATE_SALT_SET;
6581 } else if (pbkdf2->state == PSA_PBKDF2_STATE_SALT_SET) {
6582 /* Appending to existing salt. No state change. */
6583 } else {
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306584 return PSA_ERROR_BAD_STATE;
6585 }
6586
Gilles Peskineca57d782023-07-20 19:08:06 +02006587 if (data_length == 0) {
Gilles Peskineead17662023-08-20 22:02:51 +02006588 /* Appending an empty string, nothing to do. */
6589 } else {
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306590 uint8_t *next_salt;
Kusumit Ghoderaob538bb72023-05-24 12:32:14 +05306591
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306592 next_salt = mbedtls_calloc(1, data_length + pbkdf2->salt_length);
6593 if (next_salt == NULL) {
Kusumit Ghoderaod0422f32023-05-08 15:56:19 +05306594 return PSA_ERROR_INSUFFICIENT_MEMORY;
6595 }
6596
Gilles Peskineead17662023-08-20 22:02:51 +02006597 if (pbkdf2->salt_length != 0) {
6598 memcpy(next_salt, pbkdf2->salt, pbkdf2->salt_length);
6599 }
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306600 memcpy(next_salt + pbkdf2->salt_length, data, data_length);
Kusumit Ghoderaod0422f32023-05-08 15:56:19 +05306601 pbkdf2->salt_length += data_length;
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306602 mbedtls_free(pbkdf2->salt);
6603 pbkdf2->salt = next_salt;
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306604 }
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306605 return PSA_SUCCESS;
6606}
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306607
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05306608#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306609static psa_status_t psa_pbkdf2_hmac_set_password(psa_algorithm_t hash_alg,
Kusumit Ghoderaoaac9a582023-05-24 14:19:17 +05306610 const uint8_t *input,
6611 size_t input_len,
6612 uint8_t *output,
Kusumit Ghoderao91f99f52023-05-24 22:21:48 +05306613 size_t *output_len)
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306614{
6615 psa_status_t status = PSA_SUCCESS;
6616 if (input_len > PSA_HASH_BLOCK_LENGTH(hash_alg)) {
6617 status = psa_hash_compute(hash_alg, input, input_len, output,
Kusumit Ghoderao91f99f52023-05-24 22:21:48 +05306618 PSA_HMAC_MAX_HASH_BLOCK_SIZE, output_len);
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306619 } else {
6620 memcpy(output, input, input_len);
Kusumit Ghoderao91f99f52023-05-24 22:21:48 +05306621 *output_len = PSA_HASH_BLOCK_LENGTH(hash_alg);
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306622 }
6623 return status;
6624}
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05306625#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC */
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306626
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05306627#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128)
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306628static psa_status_t psa_pbkdf2_cmac_set_password(const uint8_t *input,
6629 size_t input_len,
6630 uint8_t *output,
6631 size_t *output_len)
6632{
6633 psa_status_t status = PSA_SUCCESS;
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306634 if (input_len != PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC)) {
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306635 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Kusumit Ghoderao3fde8fe2023-06-27 10:41:43 +05306636 uint8_t zeros[16] = { 0 };
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306637 psa_set_key_type(&attributes, PSA_KEY_TYPE_AES);
6638 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(sizeof(zeros)));
6639 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306640 /* Passing PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC) as
Kusumit Ghoderao5f3345a2023-07-27 21:21:38 +05306641 * mac_size as the driver function sets mac_output_length = mac_size
6642 * on success. See https://github.com/Mbed-TLS/mbedtls/issues/7801 */
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306643 status = psa_driver_wrapper_mac_compute(&attributes,
6644 zeros, sizeof(zeros),
6645 PSA_ALG_CMAC, input, input_len,
6646 output,
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306647 PSA_MAC_LENGTH(PSA_KEY_TYPE_AES,
6648 128U,
6649 PSA_ALG_CMAC),
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306650 output_len);
6651 } else {
6652 memcpy(output, input, input_len);
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306653 *output_len = PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC);
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306654 }
6655 return status;
6656}
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05306657#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128 */
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306658
6659static psa_status_t psa_pbkdf2_set_password(psa_pbkdf2_key_derivation_t *pbkdf2,
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306660 psa_algorithm_t kdf_alg,
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306661 const uint8_t *data,
6662 size_t data_length)
6663{
Kusumit Ghoderaoaac9a582023-05-24 14:19:17 +05306664 psa_status_t status = PSA_SUCCESS;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306665 if (pbkdf2->state != PSA_PBKDF2_STATE_SALT_SET) {
6666 return PSA_ERROR_BAD_STATE;
6667 }
6668
Kusumit Ghoderaof3e696d2023-07-28 13:30:50 +05306669#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306670 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
6671 psa_algorithm_t hash_alg = PSA_ALG_PBKDF2_HMAC_GET_HASH(kdf_alg);
6672 status = psa_pbkdf2_hmac_set_password(hash_alg, data, data_length,
6673 pbkdf2->password,
6674 &pbkdf2->password_length);
Kusumit Ghoderaof3e696d2023-07-28 13:30:50 +05306675 } else
6676#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC */
6677#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128)
6678 if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306679 status = psa_pbkdf2_cmac_set_password(data, data_length,
6680 pbkdf2->password,
6681 &pbkdf2->password_length);
Kusumit Ghoderaof3e696d2023-07-28 13:30:50 +05306682 } else
6683#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128 */
6684 {
6685 return PSA_ERROR_INVALID_ARGUMENT;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306686 }
6687
6688 pbkdf2->state = PSA_PBKDF2_STATE_PASSWORD_SET;
6689
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306690 return status;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306691}
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05306692
6693static psa_status_t psa_pbkdf2_input(psa_pbkdf2_key_derivation_t *pbkdf2,
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306694 psa_algorithm_t kdf_alg,
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05306695 psa_key_derivation_step_t step,
6696 const uint8_t *data,
6697 size_t data_length)
6698{
6699 switch (step) {
6700 case PSA_KEY_DERIVATION_INPUT_SALT:
6701 return psa_pbkdf2_set_salt(pbkdf2, data, data_length);
6702 case PSA_KEY_DERIVATION_INPUT_PASSWORD:
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306703 return psa_pbkdf2_set_password(pbkdf2, kdf_alg, data, data_length);
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05306704 default:
6705 return PSA_ERROR_INVALID_ARGUMENT;
6706 }
6707}
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306708#endif /* PSA_HAVE_SOFT_PBKDF2 */
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306709
Gilles Peskineb8965192019-09-24 16:21:10 +02006710/** Check whether the given key type is acceptable for the given
6711 * input step of a key derivation.
6712 *
6713 * Secret inputs must have the type #PSA_KEY_TYPE_DERIVE.
6714 * Non-secret inputs must have the type #PSA_KEY_TYPE_RAW_DATA.
6715 * Both secret and non-secret inputs can alternatively have the type
6716 * #PSA_KEY_TYPE_NONE, which is never the type of a key object, meaning
6717 * that the input was passed as a buffer rather than via a key object.
6718 */
Gilles Peskine224b0d62019-09-23 18:13:17 +02006719static int psa_key_derivation_check_input_type(
6720 psa_key_derivation_step_t step,
Gilles Peskine449bd832023-01-11 14:50:10 +01006721 psa_key_type_t key_type)
Gilles Peskine224b0d62019-09-23 18:13:17 +02006722{
Gilles Peskine449bd832023-01-11 14:50:10 +01006723 switch (step) {
Gilles Peskine224b0d62019-09-23 18:13:17 +02006724 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006725 if (key_type == PSA_KEY_TYPE_DERIVE) {
6726 return PSA_SUCCESS;
6727 }
6728 if (key_type == PSA_KEY_TYPE_NONE) {
6729 return PSA_SUCCESS;
6730 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02006731 break;
Przemek Stekiela7695a22022-04-07 15:39:01 +02006732 case PSA_KEY_DERIVATION_INPUT_OTHER_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006733 if (key_type == PSA_KEY_TYPE_DERIVE) {
6734 return PSA_SUCCESS;
6735 }
6736 if (key_type == PSA_KEY_TYPE_NONE) {
6737 return PSA_SUCCESS;
6738 }
Przemek Stekiela7695a22022-04-07 15:39:01 +02006739 break;
Gilles Peskine224b0d62019-09-23 18:13:17 +02006740 case PSA_KEY_DERIVATION_INPUT_LABEL:
6741 case PSA_KEY_DERIVATION_INPUT_SALT:
6742 case PSA_KEY_DERIVATION_INPUT_INFO:
6743 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskine449bd832023-01-11 14:50:10 +01006744 if (key_type == PSA_KEY_TYPE_RAW_DATA) {
6745 return PSA_SUCCESS;
6746 }
6747 if (key_type == PSA_KEY_TYPE_NONE) {
6748 return PSA_SUCCESS;
6749 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02006750 break;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306751 case PSA_KEY_DERIVATION_INPUT_PASSWORD:
6752 if (key_type == PSA_KEY_TYPE_PASSWORD) {
6753 return PSA_SUCCESS;
6754 }
6755 if (key_type == PSA_KEY_TYPE_DERIVE) {
6756 return PSA_SUCCESS;
6757 }
6758 if (key_type == PSA_KEY_TYPE_NONE) {
6759 return PSA_SUCCESS;
6760 }
6761 break;
Gilles Peskine224b0d62019-09-23 18:13:17 +02006762 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006763 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine224b0d62019-09-23 18:13:17 +02006764}
6765
Janos Follathb80a94e2019-06-12 15:54:46 +01006766static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006767 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01006768 psa_key_derivation_step_t step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02006769 psa_key_type_t key_type,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01006770 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006771 size_t data_length)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006772{
Gilles Peskine46d7faf2019-09-23 19:22:55 +02006773 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006774 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
Gilles Peskine46d7faf2019-09-23 19:22:55 +02006775
Gilles Peskine449bd832023-01-11 14:50:10 +01006776 status = psa_key_derivation_check_input_type(step, key_type);
6777 if (status != PSA_SUCCESS) {
Gilles Peskine224b0d62019-09-23 18:13:17 +02006778 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006779 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02006780
Przemek Stekiel69c46792022-06-10 12:59:51 +02006781#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006782 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
6783 status = psa_hkdf_input(&operation->ctx.hkdf, kdf_alg,
6784 step, data, data_length);
6785 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02006786#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08006787#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006788 if (PSA_ALG_IS_TLS12_PRF(kdf_alg)) {
6789 status = psa_tls12_prf_input(&operation->ctx.tls12_prf,
6790 step, data, data_length);
6791 } else
John Durkop07cc04a2020-11-16 22:08:34 -08006792#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF */
6793#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006794 if (PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
6795 status = psa_tls12_prf_psk_to_ms_input(&operation->ctx.tls12_prf,
6796 step, data, data_length);
6797 } else
John Durkop07cc04a2020-11-16 22:08:34 -08006798#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006799#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006800 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006801 status = psa_tls12_ecjpake_to_pms_input(
Gilles Peskine449bd832023-01-11 14:50:10 +01006802 &operation->ctx.tls12_ecjpake_to_pms, step, data, data_length);
6803 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006804#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306805#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05306806 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306807 status = psa_pbkdf2_input(&operation->ctx.pbkdf2, kdf_alg,
6808 step, data, data_length);
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05306809 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306810#endif /* PSA_HAVE_SOFT_PBKDF2 */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006811 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006812 /* This can't happen unless the operation object was not initialized */
Steven Cooreman74afe472021-02-10 17:19:22 +01006813 (void) data;
6814 (void) data_length;
6815 (void) kdf_alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01006816 return PSA_ERROR_BAD_STATE;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006817 }
6818
Gilles Peskine224b0d62019-09-23 18:13:17 +02006819exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01006820 if (status != PSA_SUCCESS) {
6821 psa_key_derivation_abort(operation);
6822 }
6823 return status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006824}
6825
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05306826static psa_status_t psa_key_derivation_input_integer_internal(
6827 psa_key_derivation_operation_t *operation,
6828 psa_key_derivation_step_t step,
6829 uint64_t value)
6830{
6831 psa_status_t status;
6832 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
6833
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306834#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05306835 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306836 status = psa_pbkdf2_set_input_cost(
6837 &operation->ctx.pbkdf2, step, value);
6838 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306839#endif /* PSA_HAVE_SOFT_PBKDF2 */
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05306840 {
Kusumit Ghoderao3a18dee2023-04-07 16:16:27 +05306841 (void) step;
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05306842 (void) value;
6843 (void) kdf_alg;
Kusumit Ghoderaoa14ae5a2023-04-19 14:16:26 +05306844 status = PSA_ERROR_INVALID_ARGUMENT;
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05306845 }
6846
6847 if (status != PSA_SUCCESS) {
6848 psa_key_derivation_abort(operation);
6849 }
6850 return status;
6851}
6852
Janos Follath51f4a0f2019-06-14 11:35:55 +01006853psa_status_t psa_key_derivation_input_bytes(
6854 psa_key_derivation_operation_t *operation,
6855 psa_key_derivation_step_t step,
6856 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006857 size_t data_length)
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01006858{
Gilles Peskine449bd832023-01-11 14:50:10 +01006859 return psa_key_derivation_input_internal(operation, step,
6860 PSA_KEY_TYPE_NONE,
6861 data, data_length);
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01006862}
6863
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05306864psa_status_t psa_key_derivation_input_integer(
6865 psa_key_derivation_operation_t *operation,
6866 psa_key_derivation_step_t step,
6867 uint64_t value)
6868{
6869 return psa_key_derivation_input_integer_internal(operation, step, value);
6870}
6871
Janos Follath51f4a0f2019-06-14 11:35:55 +01006872psa_status_t psa_key_derivation_input_key(
6873 psa_key_derivation_operation_t *operation,
6874 psa_key_derivation_step_t step,
Gilles Peskine449bd832023-01-11 14:50:10 +01006875 mbedtls_svc_key_id_t key)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006876{
Ronald Cronf95a2b12020-10-22 15:24:49 +02006877 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01006878 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006879 psa_key_slot_t *slot;
Gilles Peskine178c9aa2019-09-24 18:21:06 +02006880
Ronald Cron5c522922020-11-14 16:35:34 +01006881 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01006882 key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg);
6883 if (status != PSA_SUCCESS) {
6884 psa_key_derivation_abort(operation);
6885 return status;
Gilles Peskine593773d2019-09-23 18:17:40 +02006886 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02006887
Kusumit Ghoderao3128c5d2023-05-03 12:27:57 +05306888 /* Passing a key object as a SECRET or PASSWORD input unlocks the
6889 * permission to output to a key object. */
6890 if (step == PSA_KEY_DERIVATION_INPUT_SECRET ||
6891 step == PSA_KEY_DERIVATION_INPUT_PASSWORD) {
Gilles Peskine178c9aa2019-09-24 18:21:06 +02006892 operation->can_output_key = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01006893 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02006894
Gilles Peskine449bd832023-01-11 14:50:10 +01006895 status = psa_key_derivation_input_internal(operation,
6896 step, slot->attr.type,
6897 slot->key.data,
6898 slot->key.bytes);
Ronald Cronf95a2b12020-10-22 15:24:49 +02006899
Gilles Peskine449bd832023-01-11 14:50:10 +01006900 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02006901
Gilles Peskine449bd832023-01-11 14:50:10 +01006902 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006903}
Gilles Peskineea0fb492018-07-12 17:17:20 +02006904
6905
6906
6907/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02006908/* Key agreement */
6909/****************************************************************/
6910
Gilles Peskine449bd832023-01-11 14:50:10 +01006911psa_status_t psa_key_agreement_raw_builtin(const psa_key_attributes_t *attributes,
6912 const uint8_t *key_buffer,
6913 size_t key_buffer_size,
6914 psa_algorithm_t alg,
6915 const uint8_t *peer_key,
6916 size_t peer_key_length,
6917 uint8_t *shared_secret,
6918 size_t shared_secret_size,
6919 size_t *shared_secret_length)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02006920{
Gilles Peskine449bd832023-01-11 14:50:10 +01006921 switch (alg) {
John Durkop6ba40d12020-11-10 08:50:04 -08006922#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskine0216fe12019-04-11 21:23:21 +02006923 case PSA_ALG_ECDH:
Gilles Peskine449bd832023-01-11 14:50:10 +01006924 return mbedtls_psa_key_agreement_ecdh(attributes, key_buffer,
6925 key_buffer_size, alg,
6926 peer_key, peer_key_length,
6927 shared_secret,
6928 shared_secret_size,
6929 shared_secret_length);
Gilles Peskine01d718c2018-09-18 12:01:02 +02006930#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Przemek Stekielfb3dd542022-12-01 14:59:15 +01006931
6932#if defined(MBEDTLS_PSA_BUILTIN_ALG_FFDH)
6933 case PSA_ALG_FFDH:
Przemek Stekiel152bb462023-06-01 11:52:39 +02006934 return mbedtls_psa_ffdh_key_agreement(attributes,
Przemek Stekiel359f4622022-12-05 14:11:55 +01006935 peer_key,
6936 peer_key_length,
6937 key_buffer,
6938 key_buffer_size,
6939 shared_secret,
6940 shared_secret_size,
6941 shared_secret_length);
Przemek Stekielfb3dd542022-12-01 14:59:15 +01006942#endif /* MBEDTLS_PSA_BUILTIN_ALG_FFDH */
6943
Gilles Peskine01d718c2018-09-18 12:01:02 +02006944 default:
Aditya Deshpande17845b82022-10-13 17:21:01 +01006945 (void) attributes;
6946 (void) key_buffer;
6947 (void) key_buffer_size;
Gilles Peskine93f85002018-11-16 16:43:31 +01006948 (void) peer_key;
6949 (void) peer_key_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02006950 (void) shared_secret;
6951 (void) shared_secret_size;
6952 (void) shared_secret_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01006953 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine01d718c2018-09-18 12:01:02 +02006954 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02006955}
Gilles Peskine01d718c2018-09-18 12:01:02 +02006956
Aditya Deshpande17845b82022-10-13 17:21:01 +01006957/** Internal function for raw key agreement
6958 * Calls the driver wrapper which will hand off key agreement task
Aditya Deshpande40c05cc2022-10-14 16:41:40 +01006959 * to the driver's implementation if a driver is present.
6960 * Fallback specified in the driver wrapper is built-in raw key agreement
Aditya Deshpande17845b82022-10-13 17:21:01 +01006961 * (psa_key_agreement_raw_builtin).
6962 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006963static psa_status_t psa_key_agreement_raw_internal(psa_algorithm_t alg,
6964 psa_key_slot_t *private_key,
6965 const uint8_t *peer_key,
6966 size_t peer_key_length,
6967 uint8_t *shared_secret,
6968 size_t shared_secret_size,
6969 size_t *shared_secret_length)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006970{
Gilles Peskine449bd832023-01-11 14:50:10 +01006971 if (!PSA_ALG_IS_RAW_KEY_AGREEMENT(alg)) {
6972 return PSA_ERROR_NOT_SUPPORTED;
6973 }
Aditya Deshpande17845b82022-10-13 17:21:01 +01006974
6975 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01006976 .core = private_key->attr
Aditya Deshpande17845b82022-10-13 17:21:01 +01006977 };
6978
Gilles Peskine449bd832023-01-11 14:50:10 +01006979 return psa_driver_wrapper_key_agreement(&attributes,
6980 private_key->key.data,
6981 private_key->key.bytes, alg,
6982 peer_key, peer_key_length,
6983 shared_secret,
6984 shared_secret_size,
6985 shared_secret_length);
Gilles Peskine0216fe12019-04-11 21:23:21 +02006986}
6987
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02006988/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine01d718c2018-09-18 12:01:02 +02006989 * to potentially free embedded data structures and wipe confidential data.
6990 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006991static psa_status_t psa_key_agreement_internal(psa_key_derivation_operation_t *operation,
6992 psa_key_derivation_step_t step,
6993 psa_key_slot_t *private_key,
6994 const uint8_t *peer_key,
6995 size_t peer_key_length)
Gilles Peskine01d718c2018-09-18 12:01:02 +02006996{
6997 psa_status_t status;
Aditya Deshpande2f7fd762022-11-22 11:10:34 +00006998 uint8_t shared_secret[PSA_RAW_KEY_AGREEMENT_OUTPUT_MAX_SIZE];
Gilles Peskine01d718c2018-09-18 12:01:02 +02006999 size_t shared_secret_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007000 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE(operation->alg);
Gilles Peskine01d718c2018-09-18 12:01:02 +02007001
7002 /* Step 1: run the secret agreement algorithm to generate the shared
7003 * secret. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007004 status = psa_key_agreement_raw_internal(ka_alg,
7005 private_key,
7006 peer_key, peer_key_length,
7007 shared_secret,
7008 sizeof(shared_secret),
7009 &shared_secret_length);
7010 if (status != PSA_SUCCESS) {
Gilles Peskine12313cd2018-06-20 00:20:32 +02007011 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007012 }
Gilles Peskine12313cd2018-06-20 00:20:32 +02007013
Gilles Peskineb0b255c2018-07-06 17:01:38 +02007014 /* Step 2: set up the key derivation to generate key material from
Gilles Peskine224b0d62019-09-23 18:13:17 +02007015 * the shared secret. A shared secret is permitted wherever a key
7016 * of type DERIVE is permitted. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007017 status = psa_key_derivation_input_internal(operation, step,
7018 PSA_KEY_TYPE_DERIVE,
7019 shared_secret,
7020 shared_secret_length);
Gilles Peskine12313cd2018-06-20 00:20:32 +02007021exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007022 mbedtls_platform_zeroize(shared_secret, shared_secret_length);
7023 return status;
Gilles Peskine12313cd2018-06-20 00:20:32 +02007024}
7025
Gilles Peskine449bd832023-01-11 14:50:10 +01007026psa_status_t psa_key_derivation_key_agreement(psa_key_derivation_operation_t *operation,
7027 psa_key_derivation_step_t step,
7028 mbedtls_svc_key_id_t private_key,
7029 const uint8_t *peer_key,
7030 size_t peer_key_length)
Gilles Peskine12313cd2018-06-20 00:20:32 +02007031{
Ronald Cronf95a2b12020-10-22 15:24:49 +02007032 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01007033 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01007034 psa_key_slot_t *slot;
Ronald Cronf95a2b12020-10-22 15:24:49 +02007035
Gilles Peskine449bd832023-01-11 14:50:10 +01007036 if (!PSA_ALG_IS_KEY_AGREEMENT(operation->alg)) {
7037 return PSA_ERROR_INVALID_ARGUMENT;
7038 }
Ronald Cron5c522922020-11-14 16:35:34 +01007039 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01007040 private_key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg);
7041 if (status != PSA_SUCCESS) {
7042 return status;
7043 }
7044 status = psa_key_agreement_internal(operation, step,
7045 slot,
7046 peer_key, peer_key_length);
7047 if (status != PSA_SUCCESS) {
7048 psa_key_derivation_abort(operation);
7049 } else {
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007050 /* If a private key has been added as SECRET, we allow the derived
7051 * key material to be used as a key in PSA Crypto. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007052 if (step == PSA_KEY_DERIVATION_INPUT_SECRET) {
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007053 operation->can_output_key = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01007054 }
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007055 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007056
Gilles Peskine449bd832023-01-11 14:50:10 +01007057 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007058
Gilles Peskine449bd832023-01-11 14:50:10 +01007059 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskineaf3baab2018-06-27 22:55:52 +02007060}
7061
Gilles Peskine449bd832023-01-11 14:50:10 +01007062psa_status_t psa_raw_key_agreement(psa_algorithm_t alg,
7063 mbedtls_svc_key_id_t private_key,
7064 const uint8_t *peer_key,
7065 size_t peer_key_length,
7066 uint8_t *output,
7067 size_t output_size,
7068 size_t *output_length)
Gilles Peskine0216fe12019-04-11 21:23:21 +02007069{
Ronald Cronf95a2b12020-10-22 15:24:49 +02007070 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01007071 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +02007072 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007073 size_t expected_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02007074
Gilles Peskine449bd832023-01-11 14:50:10 +01007075 if (!PSA_ALG_IS_KEY_AGREEMENT(alg)) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007076 status = PSA_ERROR_INVALID_ARGUMENT;
7077 goto exit;
7078 }
Ronald Cron5c522922020-11-14 16:35:34 +01007079 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01007080 private_key, &slot, PSA_KEY_USAGE_DERIVE, alg);
7081 if (status != PSA_SUCCESS) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007082 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007083 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02007084
Gilles Peskine3e561302022-04-14 00:17:15 +02007085 /* PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() is in general an upper bound
7086 * for the output size. The PSA specification only guarantees that this
7087 * function works if output_size >= PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE(...),
7088 * but it might be nice to allow smaller buffers if the output fits.
7089 * At the time of writing this comment, with only ECDH implemented,
7090 * PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() is exact so the point is moot.
7091 * If FFDH is implemented, PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() can easily
7092 * be exact for it as well. */
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007093 expected_length =
Gilles Peskine449bd832023-01-11 14:50:10 +01007094 PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE(slot->attr.type, slot->attr.bits);
7095 if (output_size < expected_length) {
Gilles Peskine3e561302022-04-14 00:17:15 +02007096 status = PSA_ERROR_BUFFER_TOO_SMALL;
7097 goto exit;
7098 }
7099
Gilles Peskine449bd832023-01-11 14:50:10 +01007100 status = psa_key_agreement_raw_internal(alg, slot,
7101 peer_key, peer_key_length,
7102 output, output_size,
7103 output_length);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007104
7105exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007106 if (status != PSA_SUCCESS) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007107 /* If an error happens and is not handled properly, the output
7108 * may be used as a key to protect sensitive data. Arrange for such
7109 * a key to be random, which is likely to result in decryption or
7110 * verification errors. This is better than filling the buffer with
7111 * some constant data such as zeros, which would result in the data
7112 * being protected with a reproducible, easily knowable key.
7113 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007114 psa_generate_random(output, output_size);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007115 *output_length = output_size;
7116 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007117
Gilles Peskine449bd832023-01-11 14:50:10 +01007118 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007119
Gilles Peskine449bd832023-01-11 14:50:10 +01007120 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine0216fe12019-04-11 21:23:21 +02007121}
Gilles Peskine86a440b2018-11-12 18:39:40 +01007122
7123
Gilles Peskine30524eb2020-11-13 17:02:26 +01007124
Gilles Peskine86a440b2018-11-12 18:39:40 +01007125/****************************************************************/
7126/* Random generation */
Gilles Peskine53d991e2018-07-12 01:14:59 +02007127/****************************************************************/
Gilles Peskine12313cd2018-06-20 00:20:32 +02007128
Gilles Peskine672a7712023-04-28 21:00:28 +02007129#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
7130#include "entropy_poll.h"
7131#endif
7132
Gilles Peskine30524eb2020-11-13 17:02:26 +01007133/** Initialize the PSA random generator.
7134 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007135static void mbedtls_psa_random_init(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01007136{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007137#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine449bd832023-01-11 14:50:10 +01007138 memset(rng, 0, sizeof(*rng));
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007139#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
7140
Gilles Peskine30524eb2020-11-13 17:02:26 +01007141 /* Set default configuration if
7142 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007143 if (rng->entropy_init == NULL) {
Gilles Peskine30524eb2020-11-13 17:02:26 +01007144 rng->entropy_init = mbedtls_entropy_init;
Gilles Peskine449bd832023-01-11 14:50:10 +01007145 }
7146 if (rng->entropy_free == NULL) {
Gilles Peskine30524eb2020-11-13 17:02:26 +01007147 rng->entropy_free = mbedtls_entropy_free;
Gilles Peskine449bd832023-01-11 14:50:10 +01007148 }
Gilles Peskine30524eb2020-11-13 17:02:26 +01007149
Gilles Peskine449bd832023-01-11 14:50:10 +01007150 rng->entropy_init(&rng->entropy);
Gilles Peskine30524eb2020-11-13 17:02:26 +01007151#if defined(MBEDTLS_PSA_INJECT_ENTROPY) && \
7152 defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
7153 /* The PSA entropy injection feature depends on using NV seed as an entropy
7154 * source. Add NV seed as an entropy source for PSA entropy injection. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007155 mbedtls_entropy_add_source(&rng->entropy,
7156 mbedtls_nv_seed_poll, NULL,
7157 MBEDTLS_ENTROPY_BLOCK_SIZE,
7158 MBEDTLS_ENTROPY_SOURCE_STRONG);
Gilles Peskine30524eb2020-11-13 17:02:26 +01007159#endif
7160
Gilles Peskine449bd832023-01-11 14:50:10 +01007161 mbedtls_psa_drbg_init(MBEDTLS_PSA_RANDOM_STATE);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007162#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007163}
7164
7165/** Deinitialize the PSA random generator.
7166 */
Valerio Setti83e0de82023-11-24 12:13:05 +01007167static void mbedtls_psa_random_free(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01007168{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007169#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Valerio Setti83e0de82023-11-24 12:13:05 +01007170 memset(rng, 0, sizeof(*rng));
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007171#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Valerio Setti83e0de82023-11-24 12:13:05 +01007172 mbedtls_psa_drbg_free(MBEDTLS_PSA_RANDOM_STATE);
7173 rng->entropy_free(&rng->entropy);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007174#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007175}
7176
7177/** Seed the PSA random generator.
7178 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007179static psa_status_t mbedtls_psa_random_seed(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01007180{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007181#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
7182 /* Do nothing: the external RNG seeds itself. */
7183 (void) rng;
Gilles Peskine449bd832023-01-11 14:50:10 +01007184 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007185#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007186 const unsigned char drbg_seed[] = "PSA";
Gilles Peskine449bd832023-01-11 14:50:10 +01007187 int ret = mbedtls_psa_drbg_seed(&rng->entropy,
7188 drbg_seed, sizeof(drbg_seed) - 1);
7189 return mbedtls_to_psa_error(ret);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007190#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007191}
7192
Gilles Peskine449bd832023-01-11 14:50:10 +01007193psa_status_t psa_generate_random(uint8_t *output,
7194 size_t output_size)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007195{
Gilles Peskinee59236f2018-01-27 23:32:46 +01007196 GUARD_MODULE_INITIALIZED;
7197
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007198#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
7199
7200 size_t output_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007201 psa_status_t status = mbedtls_psa_external_get_random(&global_data.rng,
7202 output, output_size,
7203 &output_length);
7204 if (status != PSA_SUCCESS) {
7205 return status;
7206 }
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007207 /* Breaking up a request into smaller chunks is currently not supported
Tom Cosgrove1797b052022-12-04 17:19:59 +00007208 * for the external RNG interface. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007209 if (output_length != output_size) {
7210 return PSA_ERROR_INSUFFICIENT_ENTROPY;
7211 }
7212 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007213
7214#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
7215
Gilles Peskine449bd832023-01-11 14:50:10 +01007216 while (output_size > 0) {
Gilles Peskine71ddab92021-01-04 21:01:07 +01007217 size_t request_size =
Gilles Peskine449bd832023-01-11 14:50:10 +01007218 (output_size > MBEDTLS_PSA_RANDOM_MAX_REQUEST ?
7219 MBEDTLS_PSA_RANDOM_MAX_REQUEST :
7220 output_size);
7221 int ret = mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE,
7222 output, request_size);
7223 if (ret != 0) {
7224 return mbedtls_to_psa_error(ret);
7225 }
Gilles Peskine71ddab92021-01-04 21:01:07 +01007226 output_size -= request_size;
7227 output += request_size;
Gilles Peskinef181eca2019-08-07 13:49:00 +02007228 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007229 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007230#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskinee59236f2018-01-27 23:32:46 +01007231}
7232
Gilles Peskine8814fc42020-12-14 15:33:44 +01007233/* Wrapper function allowing the classic API to use the PSA RNG.
Gilles Peskine9c3e0602021-01-05 16:03:55 +01007234 *
7235 * `mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE, ...)` calls
7236 * `psa_generate_random(...)`. The state parameter is ignored since the
7237 * PSA API doesn't support passing an explicit state.
7238 *
7239 * In the non-external case, psa_generate_random() calls an
7240 * `mbedtls_xxx_drbg_random` function which has exactly the same signature
7241 * and semantics as mbedtls_psa_get_random(). As an optimization,
7242 * instead of doing this back-and-forth between the PSA API and the
7243 * classic API, psa_crypto_random_impl.h defines `mbedtls_psa_get_random`
7244 * as a constant function pointer to `mbedtls_xxx_drbg_random`.
Gilles Peskine8814fc42020-12-14 15:33:44 +01007245 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007246#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
7247int mbedtls_psa_get_random(void *p_rng,
7248 unsigned char *output,
7249 size_t output_size)
Gilles Peskine8814fc42020-12-14 15:33:44 +01007250{
Gilles Peskine9c3e0602021-01-05 16:03:55 +01007251 /* This function takes a pointer to the RNG state because that's what
7252 * classic mbedtls functions using an RNG expect. The PSA RNG manages
7253 * its own state internally and doesn't let the caller access that state.
7254 * So we just ignore the state parameter, and in practice we'll pass
7255 * NULL. */
Gilles Peskine8814fc42020-12-14 15:33:44 +01007256 (void) p_rng;
Gilles Peskine449bd832023-01-11 14:50:10 +01007257 psa_status_t status = psa_generate_random(output, output_size);
7258 if (status == PSA_SUCCESS) {
7259 return 0;
7260 } else {
7261 return MBEDTLS_ERR_ENTROPY_SOURCE_FAILED;
7262 }
Gilles Peskine8814fc42020-12-14 15:33:44 +01007263}
7264#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
7265
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01007266#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
Gilles Peskine449bd832023-01-11 14:50:10 +01007267psa_status_t mbedtls_psa_inject_entropy(const uint8_t *seed,
7268 size_t seed_size)
Netanel Gonen2bcd3122018-11-19 11:53:02 +02007269{
Gilles Peskine449bd832023-01-11 14:50:10 +01007270 if (global_data.initialized) {
7271 return PSA_ERROR_NOT_PERMITTED;
7272 }
Netanel Gonen21f37cb2018-11-19 11:53:55 +02007273
Gilles Peskine449bd832023-01-11 14:50:10 +01007274 if (((seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM) ||
7275 (seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE)) ||
7276 (seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE)) {
7277 return PSA_ERROR_INVALID_ARGUMENT;
7278 }
Netanel Gonen21f37cb2018-11-19 11:53:55 +02007279
Gilles Peskine449bd832023-01-11 14:50:10 +01007280 return mbedtls_psa_storage_inject_entropy(seed, seed_size);
Netanel Gonen2bcd3122018-11-19 11:53:02 +02007281}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01007282#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02007283
Ronald Cron3772afe2021-02-08 16:10:05 +01007284/** Validate the key type and size for key generation
Ronald Cron01b2aba2020-10-05 09:42:02 +02007285 *
Ronald Cron3772afe2021-02-08 16:10:05 +01007286 * \param type The key type
7287 * \param bits The number of bits of the key
Ronald Cron01b2aba2020-10-05 09:42:02 +02007288 *
7289 * \retval #PSA_SUCCESS
Ronald Cron3772afe2021-02-08 16:10:05 +01007290 * The key type and size are valid.
Ronald Cron01b2aba2020-10-05 09:42:02 +02007291 * \retval #PSA_ERROR_INVALID_ARGUMENT
7292 * The size in bits of the key is not valid.
7293 * \retval #PSA_ERROR_NOT_SUPPORTED
7294 * The type and/or the size in bits of the key or the combination of
7295 * the two is not supported.
7296 */
Ronald Cron3772afe2021-02-08 16:10:05 +01007297static psa_status_t psa_validate_key_type_and_size_for_key_generation(
Gilles Peskine449bd832023-01-11 14:50:10 +01007298 psa_key_type_t type, size_t bits)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007299{
Ronald Cronf3bb7612020-10-02 20:11:59 +02007300 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007301
Gilles Peskine449bd832023-01-11 14:50:10 +01007302 if (key_type_is_raw_bytes(type)) {
7303 status = psa_validate_unstructured_key_bit_size(type, bits);
7304 if (status != PSA_SUCCESS) {
7305 return status;
7306 }
7307 } else
Valerio Settif6d4dfb2023-07-10 10:55:12 +02007308#if defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007309 if (PSA_KEY_TYPE_IS_RSA(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
7310 if (bits > PSA_VENDOR_RSA_MAX_KEY_BITS) {
7311 return PSA_ERROR_NOT_SUPPORTED;
7312 }
Waleed Elmelegyd7bdbbe2023-07-20 16:26:58 +00007313 if (bits < PSA_VENDOR_RSA_GENERATE_MIN_KEY_BITS) {
Waleed Elmelegyab570712023-07-05 16:40:58 +00007314 return PSA_ERROR_NOT_SUPPORTED;
7315 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +02007316
Ronald Cron01b2aba2020-10-05 09:42:02 +02007317 /* Accept only byte-aligned keys, for the same reasons as
7318 * in psa_import_rsa_key(). */
Gilles Peskine449bd832023-01-11 14:50:10 +01007319 if (bits % 8 != 0) {
7320 return PSA_ERROR_NOT_SUPPORTED;
7321 }
7322 } else
Valerio Settif6d4dfb2023-07-10 10:55:12 +02007323#endif /* defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02007324
Valerio Setti6a9d0ee2023-06-21 10:07:21 +02007325#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007326 if (PSA_KEY_TYPE_IS_ECC(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
Ronald Crond81ab562021-02-16 09:01:16 +01007327 /* To avoid empty block, return successfully here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007328 return PSA_SUCCESS;
7329 } else
Valerio Setti6a9d0ee2023-06-21 10:07:21 +02007330#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_GENERATE) */
Przemek Stekielfedd1342022-12-01 15:00:02 +01007331
Valerio Settia55f0422023-07-10 15:34:41 +02007332#if defined(PSA_WANT_KEY_TYPE_DH_KEY_PAIR_GENERATE)
Przemek Stekielfedd1342022-12-01 15:00:02 +01007333 if (PSA_KEY_TYPE_IS_DH(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
Przemek Stekield1cf1ba2023-04-27 12:04:21 +02007334 if (psa_is_dh_key_size_valid(bits) == 0) {
Przemek Stekielfedd1342022-12-01 15:00:02 +01007335 return PSA_ERROR_NOT_SUPPORTED;
7336 }
7337 } else
Valerio Settia55f0422023-07-10 15:34:41 +02007338#endif /* defined(PSA_WANT_KEY_TYPE_DH_KEY_PAIR_GENERATE) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02007339 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007340 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007341 }
7342
Gilles Peskine449bd832023-01-11 14:50:10 +01007343 return PSA_SUCCESS;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007344}
7345
Ronald Cron55ed0592020-10-05 10:30:40 +02007346psa_status_t psa_generate_key_internal(
Ronald Cron2a38a6b2020-10-02 20:02:04 +02007347 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01007348 uint8_t *key_buffer, size_t key_buffer_size, size_t *key_buffer_length)
Ronald Cron01b2aba2020-10-05 09:42:02 +02007349{
7350 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2a38a6b2020-10-02 20:02:04 +02007351 psa_key_type_t type = attributes->core.type;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007352
Gilles Peskine449bd832023-01-11 14:50:10 +01007353 if ((attributes->domain_parameters == NULL) &&
7354 (attributes->domain_parameters_size != 0)) {
7355 return PSA_ERROR_INVALID_ARGUMENT;
7356 }
Ronald Cron01b2aba2020-10-05 09:42:02 +02007357
Gilles Peskine449bd832023-01-11 14:50:10 +01007358 if (key_type_is_raw_bytes(type)) {
7359 status = psa_generate_random(key_buffer, key_buffer_size);
7360 if (status != PSA_SUCCESS) {
7361 return status;
7362 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +02007363
David Brown12ca5032021-02-11 11:02:00 -07007364#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01007365 if (type == PSA_KEY_TYPE_DES) {
7366 psa_des_set_key_parity(key_buffer, key_buffer_size);
7367 }
David Brown8107e312021-02-12 08:08:46 -07007368#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine449bd832023-01-11 14:50:10 +01007369 } else
Gilles Peskinee59236f2018-01-27 23:32:46 +01007370
Valerio Setti76df8c12023-07-11 14:11:28 +02007371#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007372 if (type == PSA_KEY_TYPE_RSA_KEY_PAIR) {
7373 return mbedtls_psa_rsa_generate_key(attributes,
7374 key_buffer,
7375 key_buffer_size,
7376 key_buffer_length);
7377 } else
Valerio Setti76df8c12023-07-11 14:11:28 +02007378#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_GENERATE) */
Gilles Peskinee59236f2018-01-27 23:32:46 +01007379
Valerio Settibfeaf5b2023-06-20 13:27:46 +02007380#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007381 if (PSA_KEY_TYPE_IS_ECC(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
7382 return mbedtls_psa_ecp_generate_key(attributes,
7383 key_buffer,
7384 key_buffer_size,
7385 key_buffer_length);
7386 } else
Valerio Settibfeaf5b2023-06-20 13:27:46 +02007387#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_GENERATE) */
Przemek Stekielfedd1342022-12-01 15:00:02 +01007388
Valerio Settia55f0422023-07-10 15:34:41 +02007389#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_GENERATE)
Przemek Stekielfedd1342022-12-01 15:00:02 +01007390 if (PSA_KEY_TYPE_IS_DH(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
7391 return mbedtls_psa_ffdh_generate_key(attributes,
7392 key_buffer,
7393 key_buffer_size,
7394 key_buffer_length);
7395 } else
Valerio Settia55f0422023-07-10 15:34:41 +02007396#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_GENERATE) */
Steven Cooreman29149862020-08-05 15:43:42 +02007397 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007398 (void) key_buffer_length;
7399 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman29149862020-08-05 15:43:42 +02007400 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01007401
Gilles Peskine449bd832023-01-11 14:50:10 +01007402 return PSA_SUCCESS;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02007403}
Darryl Green0c6575a2018-11-07 16:05:30 +00007404
Gilles Peskine449bd832023-01-11 14:50:10 +01007405psa_status_t psa_generate_key(const psa_key_attributes_t *attributes,
7406 mbedtls_svc_key_id_t *key)
Gilles Peskineff5f0e72019-04-18 12:53:30 +02007407{
7408 psa_status_t status;
7409 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02007410 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cron2b56bc82020-10-05 10:02:26 +02007411 size_t key_buffer_size;
Gilles Peskine11792082019-08-06 18:36:36 +02007412
Ronald Cron81709fc2020-11-14 12:10:32 +01007413 *key = MBEDTLS_SVC_KEY_ID_INIT;
7414
Gilles Peskine0f84d622019-09-12 19:03:13 +02007415 /* Reject any attempt to create a zero-length key so that we don't
7416 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007417 if (psa_get_key_bits(attributes) == 0) {
7418 return PSA_ERROR_INVALID_ARGUMENT;
7419 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02007420
Przemyslaw Stekielc0fe8202021-10-07 11:08:56 +02007421 /* Reject any attempt to create a public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007422 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(attributes->core.type)) {
7423 return PSA_ERROR_INVALID_ARGUMENT;
7424 }
Przemyslaw Stekielc0fe8202021-10-07 11:08:56 +02007425
Gilles Peskine449bd832023-01-11 14:50:10 +01007426 status = psa_start_key_creation(PSA_KEY_CREATION_GENERATE, attributes,
7427 &slot, &driver);
7428 if (status != PSA_SUCCESS) {
Gilles Peskine11792082019-08-06 18:36:36 +02007429 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007430 }
Gilles Peskine11792082019-08-06 18:36:36 +02007431
Ronald Cron977c2472020-10-13 08:32:21 +02007432 /* In the case of a transparent key or an opaque key stored in local
Archana449608b2021-09-08 15:36:05 +05307433 * storage ( thus not in the case of generating a key in a secure element
7434 * with storage ( MBEDTLS_PSA_CRYPTO_SE_C ) ),we have to allocate a
7435 * buffer to hold the generated key material. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007436 if (slot->key.data == NULL) {
7437 if (PSA_KEY_LIFETIME_GET_LOCATION(attributes->core.lifetime) ==
7438 PSA_KEY_LOCATION_LOCAL_STORAGE) {
Ronald Cron3772afe2021-02-08 16:10:05 +01007439 status = psa_validate_key_type_and_size_for_key_generation(
Gilles Peskine449bd832023-01-11 14:50:10 +01007440 attributes->core.type, attributes->core.bits);
7441 if (status != PSA_SUCCESS) {
Ronald Cron3772afe2021-02-08 16:10:05 +01007442 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007443 }
Ronald Cron3772afe2021-02-08 16:10:05 +01007444
7445 key_buffer_size = PSA_EXPORT_KEY_OUTPUT_SIZE(
Gilles Peskine449bd832023-01-11 14:50:10 +01007446 attributes->core.type,
7447 attributes->core.bits);
7448 } else {
Ronald Cron977c2472020-10-13 08:32:21 +02007449 status = psa_driver_wrapper_get_key_buffer_size(
Gilles Peskine449bd832023-01-11 14:50:10 +01007450 attributes, &key_buffer_size);
7451 if (status != PSA_SUCCESS) {
Ronald Cron3772afe2021-02-08 16:10:05 +01007452 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007453 }
Ronald Cron977c2472020-10-13 08:32:21 +02007454 }
Ronald Cron977c2472020-10-13 08:32:21 +02007455
Gilles Peskine449bd832023-01-11 14:50:10 +01007456 status = psa_allocate_buffer_to_slot(slot, key_buffer_size);
7457 if (status != PSA_SUCCESS) {
Ronald Cron977c2472020-10-13 08:32:21 +02007458 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007459 }
Ronald Cron977c2472020-10-13 08:32:21 +02007460 }
7461
Gilles Peskine449bd832023-01-11 14:50:10 +01007462 status = psa_driver_wrapper_generate_key(attributes,
7463 slot->key.data, slot->key.bytes, &slot->key.bytes);
Gilles Peskine11792082019-08-06 18:36:36 +02007464
Gilles Peskine449bd832023-01-11 14:50:10 +01007465 if (status != PSA_SUCCESS) {
7466 psa_remove_key_data_from_memory(slot);
7467 }
Ronald Cron2b56bc82020-10-05 10:02:26 +02007468
Gilles Peskine11792082019-08-06 18:36:36 +02007469exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007470 if (status == PSA_SUCCESS) {
7471 status = psa_finish_key_creation(slot, driver, key);
7472 }
7473 if (status != PSA_SUCCESS) {
7474 psa_fail_key_creation(slot, driver);
7475 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007476
Gilles Peskine449bd832023-01-11 14:50:10 +01007477 return status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007478}
7479
Gilles Peskinee59236f2018-01-27 23:32:46 +01007480/****************************************************************/
7481/* Module setup */
7482/****************************************************************/
7483
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007484#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine5e769522018-11-20 21:59:56 +01007485psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
Gilles Peskine449bd832023-01-11 14:50:10 +01007486 void (* entropy_init)(mbedtls_entropy_context *ctx),
7487 void (* entropy_free)(mbedtls_entropy_context *ctx))
Gilles Peskine5e769522018-11-20 21:59:56 +01007488{
Gilles Peskine449bd832023-01-11 14:50:10 +01007489 if (global_data.rng_state != RNG_NOT_INITIALIZED) {
7490 return PSA_ERROR_BAD_STATE;
7491 }
Gilles Peskine30524eb2020-11-13 17:02:26 +01007492 global_data.rng.entropy_init = entropy_init;
7493 global_data.rng.entropy_free = entropy_free;
Gilles Peskine449bd832023-01-11 14:50:10 +01007494 return PSA_SUCCESS;
Gilles Peskine5e769522018-11-20 21:59:56 +01007495}
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007496#endif /* !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) */
Gilles Peskine5e769522018-11-20 21:59:56 +01007497
Gilles Peskine449bd832023-01-11 14:50:10 +01007498void mbedtls_psa_crypto_free(void)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007499{
Gilles Peskine449bd832023-01-11 14:50:10 +01007500 psa_wipe_all_key_slots();
Valerio Setti83e0de82023-11-24 12:13:05 +01007501 if (global_data.rng_state != RNG_NOT_INITIALIZED) {
7502 mbedtls_psa_random_free(&global_data.rng);
7503 }
Gilles Peskinec6b69072018-11-20 21:42:52 +01007504 /* Wipe all remaining data, including configuration.
7505 * In particular, this sets all state indicator to the value
7506 * indicating "uninitialized". */
Gilles Peskine449bd832023-01-11 14:50:10 +01007507 mbedtls_platform_zeroize(&global_data, sizeof(global_data));
Ronald Cron9ba76912021-04-10 16:57:30 +02007508
7509 /* Terminate drivers */
Gilles Peskine449bd832023-01-11 14:50:10 +01007510 psa_driver_wrapper_free();
Gilles Peskinee59236f2018-01-27 23:32:46 +01007511}
7512
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007513#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
7514/** Recover a transaction that was interrupted by a power failure.
7515 *
7516 * This function is called during initialization, before psa_crypto_init()
7517 * returns. If this function returns a failure status, the initialization
7518 * fails.
7519 */
7520static psa_status_t psa_crypto_recover_transaction(
Gilles Peskine449bd832023-01-11 14:50:10 +01007521 const psa_crypto_transaction_t *transaction)
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007522{
Gilles Peskine449bd832023-01-11 14:50:10 +01007523 switch (transaction->unknown.type) {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007524 case PSA_CRYPTO_TRANSACTION_CREATE_KEY:
7525 case PSA_CRYPTO_TRANSACTION_DESTROY_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01007526 /* TODO - fall through to the failure case until this
7527 * is implemented.
7528 * https://github.com/ARMmbed/mbed-crypto/issues/218
7529 */
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007530 default:
7531 /* We found an unsupported transaction in the storage.
7532 * We don't know what state the storage is in. Give up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007533 return PSA_ERROR_DATA_INVALID;
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007534 }
7535}
7536#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
7537
Gilles Peskine449bd832023-01-11 14:50:10 +01007538psa_status_t psa_crypto_init(void)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007539{
Gilles Peskine66fb1262018-12-10 16:29:04 +01007540 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007541
Gilles Peskinec6b69072018-11-20 21:42:52 +01007542 /* Double initialization is explicitly allowed. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007543 if (global_data.initialized != 0) {
7544 return PSA_SUCCESS;
7545 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01007546
Manuel Pégourié-Gonnard7abdf7e2023-03-09 11:17:43 +01007547 /* Init drivers */
7548 status = psa_driver_wrapper_init();
7549 if (status != PSA_SUCCESS) {
7550 goto exit;
7551 }
7552 global_data.drivers_initialized = 1;
7553
Valerio Setti402cfba2023-11-13 10:24:32 +01007554 status = psa_initialize_key_slots();
7555 if (status != PSA_SUCCESS) {
7556 goto exit;
7557 }
7558
Gilles Peskine30524eb2020-11-13 17:02:26 +01007559 /* Initialize and seed the random generator. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007560 mbedtls_psa_random_init(&global_data.rng);
Gilles Peskinec6b69072018-11-20 21:42:52 +01007561 global_data.rng_state = RNG_INITIALIZED;
Gilles Peskine449bd832023-01-11 14:50:10 +01007562 status = mbedtls_psa_random_seed(&global_data.rng);
7563 if (status != PSA_SUCCESS) {
Gilles Peskinee59236f2018-01-27 23:32:46 +01007564 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007565 }
Gilles Peskinec6b69072018-11-20 21:42:52 +01007566 global_data.rng_state = RNG_SEEDED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007567
Gilles Peskine4b734222019-07-24 15:56:31 +02007568#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007569 status = psa_crypto_load_transaction();
7570 if (status == PSA_SUCCESS) {
7571 status = psa_crypto_recover_transaction(&psa_crypto_transaction);
7572 if (status != PSA_SUCCESS) {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007573 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007574 }
7575 status = psa_crypto_stop_transaction();
7576 } else if (status == PSA_ERROR_DOES_NOT_EXIST) {
Gilles Peskinefc762652019-07-22 19:30:34 +02007577 /* There's no transaction to complete. It's all good. */
7578 status = PSA_SUCCESS;
7579 }
Gilles Peskine4b734222019-07-24 15:56:31 +02007580#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
Gilles Peskinefc762652019-07-22 19:30:34 +02007581
Gilles Peskinec6b69072018-11-20 21:42:52 +01007582 /* All done. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01007583 global_data.initialized = 1;
7584
7585exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007586 if (status != PSA_SUCCESS) {
7587 mbedtls_psa_crypto_free();
7588 }
7589 return status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007590}
7591
Yanray Wangffc3c482023-07-11 12:01:04 +08007592#if defined(PSA_WANT_ALG_SOME_PAKE)
Przemek Stekielca8d2b22023-01-17 16:21:33 +01007593psa_status_t psa_crypto_driver_pake_get_password_len(
7594 const psa_crypto_driver_pake_inputs_t *inputs,
7595 size_t *password_len)
7596{
7597 if (inputs->password_len == 0) {
7598 return PSA_ERROR_BAD_STATE;
7599 }
7600
7601 *password_len = inputs->password_len;
7602
7603 return PSA_SUCCESS;
7604}
7605
7606psa_status_t psa_crypto_driver_pake_get_password(
7607 const psa_crypto_driver_pake_inputs_t *inputs,
7608 uint8_t *buffer, size_t buffer_size, size_t *buffer_length)
7609{
7610 if (inputs->password_len == 0) {
7611 return PSA_ERROR_BAD_STATE;
7612 }
7613
7614 if (buffer_size < inputs->password_len) {
7615 return PSA_ERROR_BUFFER_TOO_SMALL;
7616 }
7617
7618 memcpy(buffer, inputs->password, inputs->password_len);
7619 *buffer_length = inputs->password_len;
7620
7621 return PSA_SUCCESS;
7622}
7623
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007624psa_status_t psa_crypto_driver_pake_get_user_len(
7625 const psa_crypto_driver_pake_inputs_t *inputs,
7626 size_t *user_len)
7627{
7628 if (inputs->user_len == 0) {
7629 return PSA_ERROR_BAD_STATE;
7630 }
7631
7632 *user_len = inputs->user_len;
7633
7634 return PSA_SUCCESS;
7635}
7636
7637psa_status_t psa_crypto_driver_pake_get_user(
7638 const psa_crypto_driver_pake_inputs_t *inputs,
Przemek Stekielc0e62502023-03-14 11:49:36 +01007639 uint8_t *user_id, size_t user_id_size, size_t *user_id_len)
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007640{
7641 if (inputs->user_len == 0) {
7642 return PSA_ERROR_BAD_STATE;
7643 }
7644
Przemek Stekielc0e62502023-03-14 11:49:36 +01007645 if (user_id_size < inputs->user_len) {
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007646 return PSA_ERROR_BUFFER_TOO_SMALL;
7647 }
7648
Przemek Stekielc0e62502023-03-14 11:49:36 +01007649 memcpy(user_id, inputs->user, inputs->user_len);
7650 *user_id_len = inputs->user_len;
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007651
7652 return PSA_SUCCESS;
7653}
7654
7655psa_status_t psa_crypto_driver_pake_get_peer_len(
7656 const psa_crypto_driver_pake_inputs_t *inputs,
7657 size_t *peer_len)
7658{
7659 if (inputs->peer_len == 0) {
7660 return PSA_ERROR_BAD_STATE;
7661 }
7662
7663 *peer_len = inputs->peer_len;
7664
7665 return PSA_SUCCESS;
7666}
7667
7668psa_status_t psa_crypto_driver_pake_get_peer(
7669 const psa_crypto_driver_pake_inputs_t *inputs,
Przemek Stekielc0e62502023-03-14 11:49:36 +01007670 uint8_t *peer_id, size_t peer_id_size, size_t *peer_id_length)
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007671{
7672 if (inputs->peer_len == 0) {
7673 return PSA_ERROR_BAD_STATE;
7674 }
7675
Przemek Stekielc0e62502023-03-14 11:49:36 +01007676 if (peer_id_size < inputs->peer_len) {
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007677 return PSA_ERROR_BUFFER_TOO_SMALL;
7678 }
7679
Przemek Stekielc0e62502023-03-14 11:49:36 +01007680 memcpy(peer_id, inputs->peer, inputs->peer_len);
7681 *peer_id_length = inputs->peer_len;
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007682
7683 return PSA_SUCCESS;
7684}
7685
Przemek Stekielca8d2b22023-01-17 16:21:33 +01007686psa_status_t psa_crypto_driver_pake_get_cipher_suite(
7687 const psa_crypto_driver_pake_inputs_t *inputs,
7688 psa_pake_cipher_suite_t *cipher_suite)
7689{
7690 if (inputs->cipher_suite.algorithm == PSA_ALG_NONE) {
7691 return PSA_ERROR_BAD_STATE;
7692 }
7693
7694 *cipher_suite = inputs->cipher_suite;
7695
7696 return PSA_SUCCESS;
7697}
7698
Neil Armstronga7d08c32022-06-01 18:21:20 +02007699psa_status_t psa_pake_setup(
7700 psa_pake_operation_t *operation,
7701 const psa_pake_cipher_suite_t *cipher_suite)
7702{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007703 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007704
Przemek Stekiel1c3cfb42023-01-26 10:35:02 +01007705 if (operation->stage != PSA_PAKE_OPERATION_STAGE_SETUP) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007706 status = PSA_ERROR_BAD_STATE;
7707 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007708 }
7709
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01007710 if (PSA_ALG_IS_PAKE(cipher_suite->algorithm) == 0 ||
Przemek Stekiel51eac532022-12-07 11:04:51 +01007711 PSA_ALG_IS_HASH(cipher_suite->hash) == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007712 status = PSA_ERROR_INVALID_ARGUMENT;
7713 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007714 }
7715
Przemek Stekiel51eac532022-12-07 11:04:51 +01007716 memset(&operation->data.inputs, 0, sizeof(operation->data.inputs));
7717
Przemek Stekiele12ed362022-12-21 12:54:46 +01007718 operation->alg = cipher_suite->algorithm;
Przemek Stekiel656b2592023-03-22 13:15:33 +01007719 operation->primitive = PSA_PAKE_PRIMITIVE(cipher_suite->type,
7720 cipher_suite->family, cipher_suite->bits);
Przemek Stekiel51eac532022-12-07 11:04:51 +01007721 operation->data.inputs.cipher_suite = *cipher_suite;
7722
Przemek Stekiel4aa99402023-02-27 13:00:57 +01007723#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01007724 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01007725 psa_jpake_computation_stage_t *computation_stage =
Przemek Stekieldde6a912023-01-26 08:46:37 +01007726 &operation->computation_stage.jpake;
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01007727
David Horstmann16f01512023-06-14 17:21:07 +01007728 memset(computation_stage, 0, sizeof(*computation_stage));
David Horstmanne7f21e62023-05-12 18:17:21 +01007729 computation_stage->step = PSA_PAKE_STEP_KEY_SHARE;
Przemek Stekiel80a88492023-02-20 13:32:22 +01007730 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007731#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01007732 {
7733 status = PSA_ERROR_NOT_SUPPORTED;
7734 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01007735 }
7736
Przemek Stekiel1c3cfb42023-01-26 10:35:02 +01007737 operation->stage = PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS;
7738
Przemek Stekiel51eac532022-12-07 11:04:51 +01007739 return PSA_SUCCESS;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007740exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007741 psa_pake_abort(operation);
7742 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02007743}
7744
7745psa_status_t psa_pake_set_password_key(
7746 psa_pake_operation_t *operation,
7747 mbedtls_svc_key_id_t password)
7748{
Neil Armstrong5ae60962022-09-15 11:29:46 +02007749 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel6c764412022-11-22 14:05:12 +01007750 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
7751 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007752 psa_key_attributes_t attributes;
7753 psa_key_type_t type;
Neil Armstrong5ae60962022-09-15 11:29:46 +02007754
Przemek Stekiel51eac532022-12-07 11:04:51 +01007755 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007756 status = PSA_ERROR_BAD_STATE;
7757 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007758 }
7759
Przemek Stekiel6c764412022-11-22 14:05:12 +01007760 status = psa_get_and_lock_key_slot_with_policy(password, &slot,
7761 PSA_KEY_USAGE_DERIVE,
Przemek Stekield5d28a22023-01-26 10:46:05 +01007762 operation->alg);
Neil Armstrong5ae60962022-09-15 11:29:46 +02007763 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007764 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02007765 }
7766
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007767 attributes = (psa_key_attributes_t) {
Przemek Stekiel6c764412022-11-22 14:05:12 +01007768 .core = slot->attr
7769 };
Neil Armstrong5ae60962022-09-15 11:29:46 +02007770
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007771 type = psa_get_key_type(&attributes);
Neil Armstrong5ae60962022-09-15 11:29:46 +02007772
Przemek Stekiel51eac532022-12-07 11:04:51 +01007773 if (type != PSA_KEY_TYPE_PASSWORD &&
7774 type != PSA_KEY_TYPE_PASSWORD_HASH) {
7775 status = PSA_ERROR_INVALID_ARGUMENT;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007776 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007777 }
7778
Przemek Stekiel51eac532022-12-07 11:04:51 +01007779 operation->data.inputs.password = mbedtls_calloc(1, slot->key.bytes);
7780 if (operation->data.inputs.password == NULL) {
Przemek Stekiele12ed362022-12-21 12:54:46 +01007781 status = PSA_ERROR_INSUFFICIENT_MEMORY;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007782 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007783 }
7784
7785 memcpy(operation->data.inputs.password, slot->key.data, slot->key.bytes);
7786 operation->data.inputs.password_len = slot->key.bytes;
Przemek Stekiel9dd24402023-01-26 15:06:09 +01007787 operation->data.inputs.attributes = attributes;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007788exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007789 if (status != PSA_SUCCESS) {
7790 psa_pake_abort(operation);
7791 }
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007792 unlock_status = psa_unlock_key_slot(slot);
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007793 return (status == PSA_SUCCESS) ? unlock_status : status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02007794}
7795
7796psa_status_t psa_pake_set_user(
7797 psa_pake_operation_t *operation,
7798 const uint8_t *user_id,
7799 size_t user_id_len)
7800{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007801 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007802
7803 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007804 status = PSA_ERROR_BAD_STATE;
7805 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02007806 }
7807
Przemek Stekiel51eac532022-12-07 11:04:51 +01007808 if (user_id_len == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007809 status = PSA_ERROR_INVALID_ARGUMENT;
7810 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02007811 }
7812
Przemek Stekielf309d6b2023-03-10 09:54:45 +01007813 if (operation->data.inputs.user_len != 0) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007814 status = PSA_ERROR_BAD_STATE;
7815 goto exit;
7816 }
7817
Przemek Stekielf309d6b2023-03-10 09:54:45 +01007818 operation->data.inputs.user = mbedtls_calloc(1, user_id_len);
7819 if (operation->data.inputs.user == NULL) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007820 status = PSA_ERROR_INSUFFICIENT_MEMORY;
7821 goto exit;
7822 }
7823
Przemek Stekielf309d6b2023-03-10 09:54:45 +01007824 memcpy(operation->data.inputs.user, user_id, user_id_len);
7825 operation->data.inputs.user_len = user_id_len;
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007826
7827 return PSA_SUCCESS;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007828exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007829 psa_pake_abort(operation);
7830 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02007831}
7832
7833psa_status_t psa_pake_set_peer(
7834 psa_pake_operation_t *operation,
7835 const uint8_t *peer_id,
7836 size_t peer_id_len)
7837{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007838 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007839
7840 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007841 status = PSA_ERROR_BAD_STATE;
7842 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02007843 }
7844
Przemek Stekiel51eac532022-12-07 11:04:51 +01007845 if (peer_id_len == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007846 status = PSA_ERROR_INVALID_ARGUMENT;
7847 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02007848 }
7849
Przemek Stekielf309d6b2023-03-10 09:54:45 +01007850 if (operation->data.inputs.peer_len != 0) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007851 status = PSA_ERROR_BAD_STATE;
7852 goto exit;
7853 }
7854
Przemek Stekielf309d6b2023-03-10 09:54:45 +01007855 operation->data.inputs.peer = mbedtls_calloc(1, peer_id_len);
7856 if (operation->data.inputs.peer == NULL) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007857 status = PSA_ERROR_INSUFFICIENT_MEMORY;
7858 goto exit;
7859 }
7860
Przemek Stekielf309d6b2023-03-10 09:54:45 +01007861 memcpy(operation->data.inputs.peer, peer_id, peer_id_len);
7862 operation->data.inputs.peer_len = peer_id_len;
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007863
7864 return PSA_SUCCESS;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007865exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007866 psa_pake_abort(operation);
7867 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02007868}
7869
7870psa_status_t psa_pake_set_role(
7871 psa_pake_operation_t *operation,
7872 psa_pake_role_t role)
7873{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007874 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007875
Przemek Stekiel51eac532022-12-07 11:04:51 +01007876 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007877 status = PSA_ERROR_BAD_STATE;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007878 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007879 }
7880
Przemek Stekiel09104b82023-03-06 14:11:51 +01007881 switch (operation->alg) {
7882#if defined(PSA_WANT_ALG_JPAKE)
7883 case PSA_ALG_JPAKE:
7884 if (role == PSA_PAKE_ROLE_NONE) {
7885 return PSA_SUCCESS;
7886 }
7887 status = PSA_ERROR_INVALID_ARGUMENT;
7888 break;
7889#endif
7890 default:
7891 (void) role;
7892 status = PSA_ERROR_NOT_SUPPORTED;
7893 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02007894 }
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007895exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007896 psa_pake_abort(operation);
7897 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02007898}
7899
David Horstmanne7f21e62023-05-12 18:17:21 +01007900/* Auxiliary function to convert core computation stage to single driver step. */
Przemek Stekiel4aa99402023-02-27 13:00:57 +01007901#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiel251e86a2023-02-17 14:30:50 +01007902static psa_crypto_driver_pake_step_t convert_jpake_computation_stage_to_driver_step(
Przemek Stekieldde6a912023-01-26 08:46:37 +01007903 psa_jpake_computation_stage_t *stage)
Przemek Stekielb09c4872023-01-17 12:05:38 +01007904{
David Horstmann74a3d8c2023-06-14 18:28:19 +01007905 psa_crypto_driver_pake_step_t key_share_step;
David Horstmann5da95602023-06-08 15:37:12 +01007906 if (stage->round == PSA_JPAKE_FIRST) {
David Horstmanne7f21e62023-05-12 18:17:21 +01007907 int is_x1;
David Horstmann74a3d8c2023-06-14 18:28:19 +01007908
David Horstmann024e5c52023-06-14 15:48:21 +01007909 if (stage->io_mode == PSA_JPAKE_OUTPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01007910 is_x1 = (stage->outputs < 1);
7911 } else {
7912 is_x1 = (stage->inputs < 1);
7913 }
7914
David Horstmann74a3d8c2023-06-14 18:28:19 +01007915 key_share_step = is_x1 ?
7916 PSA_JPAKE_X1_STEP_KEY_SHARE :
7917 PSA_JPAKE_X2_STEP_KEY_SHARE;
David Horstmann5da95602023-06-08 15:37:12 +01007918 } else if (stage->round == PSA_JPAKE_SECOND) {
David Horstmann74a3d8c2023-06-14 18:28:19 +01007919 key_share_step = (stage->io_mode == PSA_JPAKE_OUTPUT) ?
7920 PSA_JPAKE_X2S_STEP_KEY_SHARE :
7921 PSA_JPAKE_X4S_STEP_KEY_SHARE;
7922 } else {
7923 return PSA_JPAKE_STEP_INVALID;
Przemek Stekielb09c4872023-01-17 12:05:38 +01007924 }
Agathiyan Bragadeesh387bfa52023-07-17 17:01:33 +01007925 return (psa_crypto_driver_pake_step_t) (key_share_step + stage->step - PSA_PAKE_STEP_KEY_SHARE);
Przemek Stekielb09c4872023-01-17 12:05:38 +01007926}
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007927#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekielb09c4872023-01-17 12:05:38 +01007928
Przemek Stekiel2797d372022-12-22 11:19:22 +01007929static psa_status_t psa_pake_complete_inputs(
7930 psa_pake_operation_t *operation)
7931{
Przemek Stekiel2797d372022-12-22 11:19:22 +01007932 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel18620a32023-01-17 16:34:52 +01007933 /* Create copy of the inputs on stack as inputs share memory
7934 with the driver context which will be setup by the driver. */
7935 psa_crypto_driver_pake_inputs_t inputs = operation->data.inputs;
Przemek Stekiel2797d372022-12-22 11:19:22 +01007936
Przemek Stekielfde11282023-03-13 16:06:09 +01007937 if (inputs.password_len == 0) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01007938 return PSA_ERROR_BAD_STATE;
7939 }
7940
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007941 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekielfde11282023-03-13 16:06:09 +01007942 if (inputs.user_len == 0 || inputs.peer_len == 0) {
7943 return PSA_ERROR_BAD_STATE;
7944 }
Przemek Stekieldff21d32023-02-14 20:09:10 +01007945 }
7946
Przemek Stekiel18620a32023-01-17 16:34:52 +01007947 /* Clear driver context */
7948 mbedtls_platform_zeroize(&operation->data, sizeof(operation->data));
7949
7950 status = psa_driver_wrapper_pake_setup(operation, &inputs);
Przemek Stekiel2797d372022-12-22 11:19:22 +01007951
7952 /* Driver is responsible for creating its own copy of the password. */
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01007953 mbedtls_zeroize_and_free(inputs.password, inputs.password_len);
Przemek Stekiel2797d372022-12-22 11:19:22 +01007954
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007955 /* User and peer are translated to role. */
7956 mbedtls_free(inputs.user);
7957 mbedtls_free(inputs.peer);
7958
Przemek Stekiel2797d372022-12-22 11:19:22 +01007959 if (status == PSA_SUCCESS) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01007960#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiel2797d372022-12-22 11:19:22 +01007961 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekield93de322023-02-24 08:39:04 +01007962 operation->stage = PSA_PAKE_OPERATION_STAGE_COMPUTATION;
Przemek Stekiel80a88492023-02-20 13:32:22 +01007963 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007964#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01007965 {
7966 status = PSA_ERROR_NOT_SUPPORTED;
Przemek Stekiel2797d372022-12-22 11:19:22 +01007967 }
Przemek Stekiel2797d372022-12-22 11:19:22 +01007968 }
Przemek Stekiel2797d372022-12-22 11:19:22 +01007969 return status;
7970}
7971
Przemek Stekiel4aa99402023-02-27 13:00:57 +01007972#if defined(PSA_WANT_ALG_JPAKE)
David Horstmanne7f21e62023-05-12 18:17:21 +01007973static psa_status_t psa_jpake_prologue(
Przemek Stekiele12ed362022-12-21 12:54:46 +01007974 psa_pake_operation_t *operation,
David Horstmanne7f21e62023-05-12 18:17:21 +01007975 psa_pake_step_t step,
David Horstmann00ad6bf2023-06-14 15:44:24 +01007976 psa_jpake_io_mode_t io_mode)
Przemek Stekiele12ed362022-12-21 12:54:46 +01007977{
Przemek Stekiele12ed362022-12-21 12:54:46 +01007978 if (step != PSA_PAKE_STEP_KEY_SHARE &&
7979 step != PSA_PAKE_STEP_ZK_PUBLIC &&
7980 step != PSA_PAKE_STEP_ZK_PROOF) {
7981 return PSA_ERROR_INVALID_ARGUMENT;
7982 }
7983
Przemek Stekiel5eff1032023-02-21 19:10:36 +01007984 psa_jpake_computation_stage_t *computation_stage =
7985 &operation->computation_stage.jpake;
Przemek Stekiele12ed362022-12-21 12:54:46 +01007986
David Horstmann5da95602023-06-08 15:37:12 +01007987 if (computation_stage->round != PSA_JPAKE_FIRST &&
7988 computation_stage->round != PSA_JPAKE_SECOND) {
Przemek Stekiel5eff1032023-02-21 19:10:36 +01007989 return PSA_ERROR_BAD_STATE;
7990 }
7991
David Horstmanne7f21e62023-05-12 18:17:21 +01007992 /* Check that the step we are given is the one we were expecting */
7993 if (step != computation_stage->step) {
Przemek Stekiel5eff1032023-02-21 19:10:36 +01007994 return PSA_ERROR_BAD_STATE;
7995 }
7996
David Horstmanne7f21e62023-05-12 18:17:21 +01007997 if (step == PSA_PAKE_STEP_KEY_SHARE &&
7998 computation_stage->inputs == 0 &&
7999 computation_stage->outputs == 0) {
8000 /* Start of the round, so function decides whether we are inputting
8001 * or outputting */
David Horstmann024e5c52023-06-14 15:48:21 +01008002 computation_stage->io_mode = io_mode;
8003 } else if (computation_stage->io_mode != io_mode) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008004 /* Middle of the round so the mode we are in must match the function
8005 * called by the user */
8006 return PSA_ERROR_BAD_STATE;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008007 }
8008
8009 return PSA_SUCCESS;
8010}
8011
David Horstmanne7f21e62023-05-12 18:17:21 +01008012static psa_status_t psa_jpake_epilogue(
8013 psa_pake_operation_t *operation,
David Horstmann00ad6bf2023-06-14 15:44:24 +01008014 psa_jpake_io_mode_t io_mode)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008015{
David Horstmanne7f21e62023-05-12 18:17:21 +01008016 psa_jpake_computation_stage_t *stage =
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008017 &operation->computation_stage.jpake;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008018
David Horstmanne7f21e62023-05-12 18:17:21 +01008019 if (stage->step == PSA_PAKE_STEP_ZK_PROOF) {
8020 /* End of an input/output */
David Horstmann00ad6bf2023-06-14 15:44:24 +01008021 if (io_mode == PSA_JPAKE_INPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008022 stage->inputs++;
David Horstmann246ec5a2023-06-27 10:33:06 +01008023 if (stage->inputs == PSA_JPAKE_EXPECTED_INPUTS(stage->round)) {
David Horstmann024e5c52023-06-14 15:48:21 +01008024 stage->io_mode = PSA_JPAKE_OUTPUT;
David Horstmanne7f21e62023-05-12 18:17:21 +01008025 }
8026 }
David Horstmann00ad6bf2023-06-14 15:44:24 +01008027 if (io_mode == PSA_JPAKE_OUTPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008028 stage->outputs++;
David Horstmann246ec5a2023-06-27 10:33:06 +01008029 if (stage->outputs == PSA_JPAKE_EXPECTED_OUTPUTS(stage->round)) {
David Horstmann024e5c52023-06-14 15:48:21 +01008030 stage->io_mode = PSA_JPAKE_INPUT;
David Horstmanne7f21e62023-05-12 18:17:21 +01008031 }
8032 }
David Horstmann246ec5a2023-06-27 10:33:06 +01008033 if (stage->inputs == PSA_JPAKE_EXPECTED_INPUTS(stage->round) &&
8034 stage->outputs == PSA_JPAKE_EXPECTED_OUTPUTS(stage->round)) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008035 /* End of a round, move to the next round */
8036 stage->inputs = 0;
8037 stage->outputs = 0;
8038 stage->round++;
8039 }
8040 stage->step = PSA_PAKE_STEP_KEY_SHARE;
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008041 } else {
David Horstmanne7f21e62023-05-12 18:17:21 +01008042 stage->step++;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008043 }
Przemek Stekiele12ed362022-12-21 12:54:46 +01008044 return PSA_SUCCESS;
8045}
David Horstmanne7f21e62023-05-12 18:17:21 +01008046
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008047#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008048
Neil Armstronga7d08c32022-06-01 18:21:20 +02008049psa_status_t psa_pake_output(
8050 psa_pake_operation_t *operation,
8051 psa_pake_step_t step,
8052 uint8_t *output,
8053 size_t output_size,
8054 size_t *output_length)
8055{
Przemek Stekiel51eac532022-12-07 11:04:51 +01008056 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008057 psa_crypto_driver_pake_step_t driver_step = PSA_JPAKE_STEP_INVALID;
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008058 *output_length = 0;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008059
8060 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01008061 status = psa_pake_complete_inputs(operation);
8062 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008063 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008064 }
8065 }
8066
8067 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008068 status = PSA_ERROR_BAD_STATE;
8069 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008070 }
8071
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008072 if (output_size == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008073 status = PSA_ERROR_INVALID_ARGUMENT;
8074 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008075 }
8076
Przemek Stekiele12ed362022-12-21 12:54:46 +01008077 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008078#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008079 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008080 status = psa_jpake_prologue(operation, step, PSA_JPAKE_OUTPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008081 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008082 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008083 }
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008084 driver_step = convert_jpake_computation_stage_to_driver_step(
8085 &operation->computation_stage.jpake);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008086 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008087#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008088 default:
Przemek Stekiel80a88492023-02-20 13:32:22 +01008089 (void) step;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008090 status = PSA_ERROR_NOT_SUPPORTED;
8091 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008092 }
8093
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008094 status = psa_driver_wrapper_pake_output(operation, driver_step,
8095 output, output_size, output_length);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008096
8097 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008098 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008099 }
8100
8101 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008102#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008103 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008104 status = psa_jpake_epilogue(operation, PSA_JPAKE_OUTPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008105 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008106 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008107 }
8108 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008109#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008110 default:
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008111 status = PSA_ERROR_NOT_SUPPORTED;
8112 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008113 }
8114
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008115 return PSA_SUCCESS;
8116exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008117 psa_pake_abort(operation);
8118 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008119}
8120
8121psa_status_t psa_pake_input(
8122 psa_pake_operation_t *operation,
8123 psa_pake_step_t step,
8124 const uint8_t *input,
8125 size_t input_length)
8126{
Przemek Stekiel51eac532022-12-07 11:04:51 +01008127 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008128 psa_crypto_driver_pake_step_t driver_step = PSA_JPAKE_STEP_INVALID;
Przemek Stekiel256c75d2023-03-23 14:09:34 +01008129 const size_t max_input_length = (size_t) PSA_PAKE_INPUT_SIZE(operation->alg,
8130 operation->primitive,
8131 step);
Przemek Stekiel51eac532022-12-07 11:04:51 +01008132
8133 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01008134 status = psa_pake_complete_inputs(operation);
8135 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008136 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008137 }
8138 }
8139
8140 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008141 status = PSA_ERROR_BAD_STATE;
8142 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008143 }
8144
Przemek Stekiel256c75d2023-03-23 14:09:34 +01008145 if (input_length == 0 || input_length > max_input_length) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008146 status = PSA_ERROR_INVALID_ARGUMENT;
8147 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008148 }
8149
Przemek Stekiele12ed362022-12-21 12:54:46 +01008150 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008151#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008152 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008153 status = psa_jpake_prologue(operation, step, PSA_JPAKE_INPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008154 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008155 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008156 }
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008157 driver_step = convert_jpake_computation_stage_to_driver_step(
8158 &operation->computation_stage.jpake);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008159 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008160#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008161 default:
Przemek Stekiel80a88492023-02-20 13:32:22 +01008162 (void) step;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008163 status = PSA_ERROR_NOT_SUPPORTED;
8164 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008165 }
8166
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008167 status = psa_driver_wrapper_pake_input(operation, driver_step,
8168 input, input_length);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008169
8170 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008171 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008172 }
8173
8174 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008175#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008176 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008177 status = psa_jpake_epilogue(operation, PSA_JPAKE_INPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008178 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008179 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008180 }
8181 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008182#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008183 default:
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008184 status = PSA_ERROR_NOT_SUPPORTED;
8185 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008186 }
8187
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008188 return PSA_SUCCESS;
8189exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008190 psa_pake_abort(operation);
8191 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008192}
8193
8194psa_status_t psa_pake_get_implicit_key(
8195 psa_pake_operation_t *operation,
8196 psa_key_derivation_operation_t *output)
8197{
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008198 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008199 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel251e86a2023-02-17 14:30:50 +01008200 uint8_t shared_key[MBEDTLS_PSA_JPAKE_BUFFER_SIZE];
Przemek Stekiel0c781802022-11-29 14:53:13 +01008201 size_t shared_key_len = 0;
8202
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008203 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008204 status = PSA_ERROR_BAD_STATE;
8205 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008206 }
8207
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008208#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008209 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008210 psa_jpake_computation_stage_t *computation_stage =
Przemek Stekiel083745e2023-02-23 17:28:23 +01008211 &operation->computation_stage.jpake;
David Horstmann5da95602023-06-08 15:37:12 +01008212 if (computation_stage->round != PSA_JPAKE_FINISHED) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008213 status = PSA_ERROR_BAD_STATE;
8214 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008215 }
Przemek Stekiel80a88492023-02-20 13:32:22 +01008216 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008217#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01008218 {
8219 status = PSA_ERROR_NOT_SUPPORTED;
8220 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008221 }
8222
Przemek Stekiel0c781802022-11-29 14:53:13 +01008223 status = psa_driver_wrapper_pake_get_implicit_key(operation,
8224 shared_key,
Przemek Stekiel6b648622023-02-19 22:55:33 +01008225 sizeof(shared_key),
Przemek Stekiel0c781802022-11-29 14:53:13 +01008226 &shared_key_len);
8227
8228 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008229 goto exit;
Przemek Stekiel0c781802022-11-29 14:53:13 +01008230 }
8231
8232 status = psa_key_derivation_input_bytes(output,
8233 PSA_KEY_DERIVATION_INPUT_SECRET,
8234 shared_key,
8235 shared_key_len);
8236
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008237 mbedtls_platform_zeroize(shared_key, sizeof(shared_key));
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008238exit:
8239 abort_status = psa_pake_abort(operation);
8240 return status == PSA_SUCCESS ? abort_status : status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008241}
8242
8243psa_status_t psa_pake_abort(
8244 psa_pake_operation_t *operation)
8245{
Przemek Stekield69dca92023-01-31 19:59:20 +01008246 psa_status_t status = PSA_SUCCESS;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008247
Przemek Stekield69dca92023-01-31 19:59:20 +01008248 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008249 status = psa_driver_wrapper_pake_abort(operation);
Neil Armstrong5ae60962022-09-15 11:29:46 +02008250 }
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008251
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008252 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
8253 if (operation->data.inputs.password != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01008254 mbedtls_zeroize_and_free(operation->data.inputs.password,
Przemek Stekielaa183422023-03-06 14:21:44 +01008255 operation->data.inputs.password_len);
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008256 }
8257 if (operation->data.inputs.user != NULL) {
8258 mbedtls_free(operation->data.inputs.user);
8259 }
8260 if (operation->data.inputs.peer != NULL) {
8261 mbedtls_free(operation->data.inputs.peer);
8262 }
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008263 }
Przemek Stekield69dca92023-01-31 19:59:20 +01008264 memset(operation, 0, sizeof(psa_pake_operation_t));
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008265
Przemek Stekield69dca92023-01-31 19:59:20 +01008266 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008267}
Tom Cosgrove6d62fac2023-05-10 14:40:05 +01008268#endif /* PSA_WANT_ALG_SOME_PAKE */
Neil Armstronga7d08c32022-06-01 18:21:20 +02008269
Gilles Peskinee59236f2018-01-27 23:32:46 +01008270#endif /* MBEDTLS_PSA_CRYPTO_C */