blob: 10d17b6df5e9e1c2be4128c57af62a6c3a4e529f [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{
Gilles Peskine449bd832023-01-11 14:50:10 +0100984 psa_status_t status = psa_remove_key_data_from_memory(slot);
Ronald Cronddd3d052020-10-30 14:07:07 +0100985
Gilles Peskine449bd832023-01-11 14:50:10 +0100986 /*
987 * As the return error code may not be handled in case of multiple errors,
988 * do our best to report an unexpected lock counter. Assert with
989 * MBEDTLS_TEST_HOOK_TEST_ASSERT that the lock counter is equal to one:
990 * if the MBEDTLS_TEST_HOOKS configuration option is enabled and the
991 * function is called as part of the execution of a test suite, the
992 * execution of the test suite is stopped in error if the assertion fails.
993 */
994 if (slot->lock_count != 1) {
995 MBEDTLS_TEST_HOOK_TEST_ASSERT(slot->lock_count == 1);
Ronald Cronddd3d052020-10-30 14:07:07 +0100996 status = PSA_ERROR_CORRUPTION_DETECTED;
997 }
998
Gilles Peskine3f7cd622019-08-13 15:01:08 +0200999 /* Multipart operations may still be using the key. This is safe
1000 * because all multipart operation objects are independent from
1001 * the key slot: if they need to access the key after the setup
1002 * phase, they have a copy of the key. Note that this means that
1003 * key material can linger until all operations are completed. */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001004 /* At this point, key material and other type-specific content has
1005 * been wiped. Clear remaining metadata. We can call memset and not
1006 * zeroize because the metadata is not particularly sensitive. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001007 memset(slot, 0, sizeof(*slot));
1008 return status;
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001009}
1010
Gilles Peskine449bd832023-01-11 14:50:10 +01001011psa_status_t psa_destroy_key(mbedtls_svc_key_id_t key)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001012{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001013 psa_key_slot_t *slot;
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001014 psa_status_t status; /* status of the last operation */
1015 psa_status_t overall_status = PSA_SUCCESS;
Gilles Peskine354f7672019-07-12 23:46:38 +02001016#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1017 psa_se_drv_table_entry_t *driver;
1018#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001019
Gilles Peskine449bd832023-01-11 14:50:10 +01001020 if (mbedtls_svc_key_id_is_null(key)) {
1021 return PSA_SUCCESS;
1022 }
Gilles Peskine1841cf42019-10-08 15:48:25 +02001023
Ronald Cronf2911112020-10-29 17:51:10 +01001024 /*
Ronald Cron19daca92020-11-10 18:08:03 +01001025 * Get the description of the key in a key slot. In case of a persistent
Ronald Cronf2911112020-10-29 17:51:10 +01001026 * key, this will load the key description from persistent memory if not
1027 * done yet. We cannot avoid this loading as without it we don't know if
1028 * the key is operated by an SE or not and this information is needed by
1029 * the current implementation.
1030 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001031 status = psa_get_and_lock_key_slot(key, &slot);
1032 if (status != PSA_SUCCESS) {
1033 return status;
1034 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001035
Ronald Cronf2911112020-10-29 17:51:10 +01001036 /*
1037 * If the key slot containing the key description is under access by the
1038 * library (apart from the present access), the key cannot be destroyed
1039 * yet. For the time being, just return in error. Eventually (to be
1040 * implemented), the key should be destroyed when all accesses have
1041 * stopped.
1042 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001043 if (slot->lock_count > 1) {
1044 psa_unlock_key_slot(slot);
1045 return PSA_ERROR_GENERIC_ERROR;
Ronald Cronf2911112020-10-29 17:51:10 +01001046 }
1047
Gilles Peskine449bd832023-01-11 14:50:10 +01001048 if (PSA_KEY_LIFETIME_IS_READ_ONLY(slot->attr.lifetime)) {
Gilles Peskine6687cd02021-04-21 22:32:05 +02001049 /* Refuse the destruction of a read-only key (which may or may not work
1050 * if we attempt it, depending on whether the key is merely read-only
1051 * by policy or actually physically read-only).
Gilles Peskinef9a046e2021-06-07 23:27:54 +02001052 * Just do the best we can, which is to wipe the copy in memory
1053 * (done in this function's cleanup code). */
1054 overall_status = PSA_ERROR_NOT_PERMITTED;
1055 goto exit;
Gilles Peskine6687cd02021-04-21 22:32:05 +02001056 }
1057
Gilles Peskine354f7672019-07-12 23:46:38 +02001058#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001059 driver = psa_get_se_driver_entry(slot->attr.lifetime);
1060 if (driver != NULL) {
Gilles Peskine60450a42019-07-25 11:32:45 +02001061 /* For a key in a secure element, we need to do three things:
1062 * remove the key file in internal storage, destroy the
1063 * key inside the secure element, and update the driver's
1064 * persistent data. Start a transaction that will encompass these
1065 * three actions. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001066 psa_crypto_prepare_transaction(PSA_CRYPTO_TRANSACTION_DESTROY_KEY);
Gilles Peskine8e338702019-07-30 20:06:31 +02001067 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Gilles Peskine449bd832023-01-11 14:50:10 +01001068 psa_crypto_transaction.key.slot = psa_key_slot_get_slot_number(slot);
Gilles Peskine8e338702019-07-30 20:06:31 +02001069 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskine449bd832023-01-11 14:50:10 +01001070 status = psa_crypto_save_transaction();
1071 if (status != PSA_SUCCESS) {
1072 (void) psa_crypto_stop_transaction();
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001073 /* We should still try to destroy the key in the secure
1074 * element and the key metadata in storage. This is especially
1075 * important if the error is that the storage is full.
1076 * But how to do it exactly without risking an inconsistent
1077 * state after a reset?
1078 * https://github.com/ARMmbed/mbed-crypto/issues/215
1079 */
1080 overall_status = status;
1081 goto exit;
Gilles Peskinefc762652019-07-22 19:30:34 +02001082 }
1083
Gilles Peskine449bd832023-01-11 14:50:10 +01001084 status = psa_destroy_se_key(driver,
1085 psa_key_slot_get_slot_number(slot));
1086 if (overall_status == PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001087 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001088 }
Gilles Peskinefc762652019-07-22 19:30:34 +02001089 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001090#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1091
Darryl Greend49a4992018-06-18 17:27:26 +01001092#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001093 if (!PSA_KEY_LIFETIME_IS_VOLATILE(slot->attr.lifetime)) {
1094 status = psa_destroy_persistent_key(slot->attr.id);
1095 if (overall_status == PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001096 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001097 }
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001098
Gilles Peskine9ce31c42019-08-13 15:14:20 +02001099 /* TODO: other slots may have a copy of the same key. We should
1100 * invalidate them.
1101 * https://github.com/ARMmbed/mbed-crypto/issues/214
1102 */
Darryl Greend49a4992018-06-18 17:27:26 +01001103 }
1104#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
Gilles Peskine354f7672019-07-12 23:46:38 +02001105
Gilles Peskinefc762652019-07-22 19:30:34 +02001106#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001107 if (driver != NULL) {
1108 status = psa_save_se_persistent_data(driver);
1109 if (overall_status == PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001110 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001111 }
1112 status = psa_crypto_stop_transaction();
1113 if (overall_status == PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001114 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001115 }
Gilles Peskinefc762652019-07-22 19:30:34 +02001116 }
1117#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1118
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001119exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01001120 status = psa_wipe_key_slot(slot);
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001121 /* Prioritize CORRUPTION_DETECTED from wiping over a storage error */
Gilles Peskine449bd832023-01-11 14:50:10 +01001122 if (status != PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001123 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001124 }
1125 return overall_status;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001126}
1127
Valerio Settib2bcedb2023-07-10 11:24:00 +02001128#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT) || \
John Durkop0e005192020-10-31 22:06:54 -07001129 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskineb699f072019-04-26 16:06:02 +02001130static psa_status_t psa_get_rsa_public_exponent(
1131 const mbedtls_rsa_context *rsa,
Gilles Peskine449bd832023-01-11 14:50:10 +01001132 psa_key_attributes_t *attributes)
Gilles Peskineb699f072019-04-26 16:06:02 +02001133{
1134 mbedtls_mpi mpi;
Janos Follath24eed8d2019-11-22 13:21:35 +00001135 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb699f072019-04-26 16:06:02 +02001136 uint8_t *buffer = NULL;
1137 size_t buflen;
Gilles Peskine449bd832023-01-11 14:50:10 +01001138 mbedtls_mpi_init(&mpi);
Gilles Peskineb699f072019-04-26 16:06:02 +02001139
Gilles Peskine449bd832023-01-11 14:50:10 +01001140 ret = mbedtls_rsa_export(rsa, NULL, NULL, NULL, NULL, &mpi);
1141 if (ret != 0) {
Gilles Peskineb699f072019-04-26 16:06:02 +02001142 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001143 }
1144 if (mbedtls_mpi_cmp_int(&mpi, 65537) == 0) {
Gilles Peskine772c8b12019-04-26 17:37:21 +02001145 /* It's the default value, which is reported as an empty string,
1146 * so there's nothing to do. */
1147 goto exit;
1148 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001149
Gilles Peskine449bd832023-01-11 14:50:10 +01001150 buflen = mbedtls_mpi_size(&mpi);
1151 buffer = mbedtls_calloc(1, buflen);
1152 if (buffer == NULL) {
Gilles Peskineb699f072019-04-26 16:06:02 +02001153 ret = MBEDTLS_ERR_MPI_ALLOC_FAILED;
1154 goto exit;
1155 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001156 ret = mbedtls_mpi_write_binary(&mpi, buffer, buflen);
1157 if (ret != 0) {
Gilles Peskineb699f072019-04-26 16:06:02 +02001158 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001159 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001160 attributes->domain_parameters = buffer;
1161 attributes->domain_parameters_size = buflen;
1162
1163exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01001164 mbedtls_mpi_free(&mpi);
1165 if (ret != 0) {
1166 mbedtls_free(buffer);
1167 }
1168 return mbedtls_to_psa_error(ret);
Gilles Peskineb699f072019-04-26 16:06:02 +02001169}
Valerio Settib2bcedb2023-07-10 11:24:00 +02001170#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT) ||
John Durkop9814fa22020-11-04 12:28:15 -08001171 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001172
Gilles Peskinebfd322f2019-07-23 11:58:03 +02001173/** Retrieve all the publicly-accessible attributes of a key.
1174 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001175psa_status_t psa_get_key_attributes(mbedtls_svc_key_id_t key,
1176 psa_key_attributes_t *attributes)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001177{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001178 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001179 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001180 psa_key_slot_t *slot;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001181
Gilles Peskine449bd832023-01-11 14:50:10 +01001182 psa_reset_key_attributes(attributes);
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001183
Gilles Peskine449bd832023-01-11 14:50:10 +01001184 status = psa_get_and_lock_key_slot_with_policy(key, &slot, 0, 0);
1185 if (status != PSA_SUCCESS) {
1186 return status;
1187 }
Gilles Peskineb870b182018-07-06 16:02:09 +02001188
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001189 attributes->core = slot->attr;
Gilles Peskine449bd832023-01-11 14:50:10 +01001190 attributes->core.flags &= (MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1191 MBEDTLS_PSA_KA_MASK_DUAL_USE);
Gilles Peskinec8000c02019-08-02 20:15:51 +02001192
1193#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001194 if (psa_get_se_driver_entry(slot->attr.lifetime) != NULL) {
1195 psa_set_key_slot_number(attributes,
1196 psa_key_slot_get_slot_number(slot));
1197 }
Gilles Peskinec8000c02019-08-02 20:15:51 +02001198#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineb699f072019-04-26 16:06:02 +02001199
Gilles Peskine449bd832023-01-11 14:50:10 +01001200 switch (slot->attr.type) {
Valerio Settib2bcedb2023-07-10 11:24:00 +02001201#if (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) && \
1202 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) || \
John Durkop0e005192020-10-31 22:06:54 -07001203 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02001204 case PSA_KEY_TYPE_RSA_KEY_PAIR:
Gilles Peskineb699f072019-04-26 16:06:02 +02001205 case PSA_KEY_TYPE_RSA_PUBLIC_KEY:
Pengyu Lvf75893b2023-12-08 17:21:39 +08001206 /* TODO: This is a temporary situation where domain parameters are deprecated,
1207 * but we need it for namely generating an RSA key with a non-default exponent.
1208 * This would be improved after https://github.com/Mbed-TLS/mbedtls/issues/6494.
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001209 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001210 if (!psa_key_lifetime_is_external(slot->attr.lifetime)) {
Steven Cooremana2371e52020-07-28 14:30:39 +02001211 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02001212
Ronald Cron90857082020-11-25 14:58:33 +01001213 status = mbedtls_psa_rsa_load_representation(
Gilles Peskine449bd832023-01-11 14:50:10 +01001214 slot->attr.type,
1215 slot->key.data,
1216 slot->key.bytes,
1217 &rsa);
1218 if (status != PSA_SUCCESS) {
Steven Cooremana01795d2020-07-24 22:48:15 +02001219 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01001220 }
Steven Cooremana01795d2020-07-24 22:48:15 +02001221
Gilles Peskine449bd832023-01-11 14:50:10 +01001222 status = psa_get_rsa_public_exponent(rsa,
1223 attributes);
1224 mbedtls_rsa_free(rsa);
1225 mbedtls_free(rsa);
Steven Cooremana01795d2020-07-24 22:48:15 +02001226 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001227 break;
Pengyu Lve9efbc22023-12-08 16:59:08 +08001228#else
1229 case PSA_KEY_TYPE_RSA_KEY_PAIR:
1230 case PSA_KEY_TYPE_RSA_PUBLIC_KEY:
1231 attributes->domain_parameters = NULL;
1232 attributes->domain_parameters_size = SIZE_MAX;
1233 break;
Valerio Settib2bcedb2023-07-10 11:24:00 +02001234#endif /* (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) && \
1235 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) ||
John Durkop9814fa22020-11-04 12:28:15 -08001236 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001237 default:
1238 /* Nothing else to do. */
1239 break;
1240 }
1241
Gilles Peskine449bd832023-01-11 14:50:10 +01001242 if (status != PSA_SUCCESS) {
1243 psa_reset_key_attributes(attributes);
1244 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001245
Gilles Peskine449bd832023-01-11 14:50:10 +01001246 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02001247
Gilles Peskine449bd832023-01-11 14:50:10 +01001248 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001249}
1250
Gilles Peskinec8000c02019-08-02 20:15:51 +02001251#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1252psa_status_t psa_get_key_slot_number(
1253 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01001254 psa_key_slot_number_t *slot_number)
Gilles Peskinec8000c02019-08-02 20:15:51 +02001255{
Gilles Peskine449bd832023-01-11 14:50:10 +01001256 if (attributes->core.flags & MBEDTLS_PSA_KA_FLAG_HAS_SLOT_NUMBER) {
Gilles Peskinec8000c02019-08-02 20:15:51 +02001257 *slot_number = attributes->slot_number;
Gilles Peskine449bd832023-01-11 14:50:10 +01001258 return PSA_SUCCESS;
1259 } else {
1260 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinec8000c02019-08-02 20:15:51 +02001261 }
Gilles Peskinec8000c02019-08-02 20:15:51 +02001262}
1263#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1264
Gilles Peskine449bd832023-01-11 14:50:10 +01001265static psa_status_t psa_export_key_buffer_internal(const uint8_t *key_buffer,
1266 size_t key_buffer_size,
1267 uint8_t *data,
1268 size_t data_size,
1269 size_t *data_length)
Steven Cooremana01795d2020-07-24 22:48:15 +02001270{
Gilles Peskine449bd832023-01-11 14:50:10 +01001271 if (key_buffer_size > data_size) {
1272 return PSA_ERROR_BUFFER_TOO_SMALL;
1273 }
1274 memcpy(data, key_buffer, key_buffer_size);
1275 memset(data + key_buffer_size, 0,
1276 data_size - key_buffer_size);
Ronald Crond18b5f82020-11-25 16:46:05 +01001277 *data_length = key_buffer_size;
Gilles Peskine449bd832023-01-11 14:50:10 +01001278 return PSA_SUCCESS;
Steven Cooremana01795d2020-07-24 22:48:15 +02001279}
1280
Ronald Cron7285cda2020-11-26 14:46:37 +01001281psa_status_t psa_export_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001282 const psa_key_attributes_t *attributes,
1283 const uint8_t *key_buffer, size_t key_buffer_size,
Gilles Peskine449bd832023-01-11 14:50:10 +01001284 uint8_t *data, size_t data_size, size_t *data_length)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001285{
Ronald Crond18b5f82020-11-25 16:46:05 +01001286 psa_key_type_t type = attributes->core.type;
1287
Gilles Peskine449bd832023-01-11 14:50:10 +01001288 if (key_type_is_raw_bytes(type) ||
1289 PSA_KEY_TYPE_IS_RSA(type) ||
Przemek Stekiel472b3f32022-12-01 14:38:49 +01001290 PSA_KEY_TYPE_IS_ECC(type) ||
1291 PSA_KEY_TYPE_IS_DH(type)) {
Gilles Peskine449bd832023-01-11 14:50:10 +01001292 return psa_export_key_buffer_internal(
1293 key_buffer, key_buffer_size,
1294 data, data_size, data_length);
1295 } else {
Ronald Cron9486f9d2020-11-26 13:36:23 +01001296 /* This shouldn't happen in the reference implementation, but
1297 it is valid for a special-purpose implementation to omit
1298 support for exporting certain key types. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001299 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron9486f9d2020-11-26 13:36:23 +01001300 }
1301}
1302
Gilles Peskine449bd832023-01-11 14:50:10 +01001303psa_status_t psa_export_key(mbedtls_svc_key_id_t key,
1304 uint8_t *data,
1305 size_t data_size,
1306 size_t *data_length)
Ronald Cron9486f9d2020-11-26 13:36:23 +01001307{
1308 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
1309 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
1310 psa_key_slot_t *slot;
1311
Ronald Crone907e552021-01-18 13:22:38 +01001312 /* Reject a zero-length output buffer now, since this can never be a
1313 * valid key representation. This way we know that data must be a valid
1314 * pointer and we can do things like memset(data, ..., data_size). */
Gilles Peskine449bd832023-01-11 14:50:10 +01001315 if (data_size == 0) {
1316 return PSA_ERROR_BUFFER_TOO_SMALL;
1317 }
Ronald Crone907e552021-01-18 13:22:38 +01001318
Ronald Cron9486f9d2020-11-26 13:36:23 +01001319 /* Set the key to empty now, so that even when there are errors, we always
1320 * set data_length to a value between 0 and data_size. On error, setting
1321 * the key to empty is a good choice because an empty key representation is
1322 * unlikely to be accepted anywhere. */
Jaeden Amerof24c7f82018-06-27 17:20:43 +01001323 *data_length = 0;
1324
Ronald Cron9486f9d2020-11-26 13:36:23 +01001325 /* Export requires the EXPORT flag. There is an exception for public keys,
1326 * which don't require any flag, but
1327 * psa_get_and_lock_key_slot_with_policy() takes care of this.
1328 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001329 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
1330 PSA_KEY_USAGE_EXPORT, 0);
1331 if (status != PSA_SUCCESS) {
1332 return status;
1333 }
mohammad160306e79202018-03-28 13:17:44 +03001334
Ronald Crond18b5f82020-11-25 16:46:05 +01001335 psa_key_attributes_t attributes = {
1336 .core = slot->attr
1337 };
Gilles Peskine449bd832023-01-11 14:50:10 +01001338 status = psa_driver_wrapper_export_key(&attributes,
1339 slot->key.data, slot->key.bytes,
1340 data, data_size, data_length);
Ronald Cron9486f9d2020-11-26 13:36:23 +01001341
Gilles Peskine449bd832023-01-11 14:50:10 +01001342 unlock_status = psa_unlock_key_slot(slot);
Ronald Cron9486f9d2020-11-26 13:36:23 +01001343
Gilles Peskine449bd832023-01-11 14:50:10 +01001344 return (status == PSA_SUCCESS) ? unlock_status : status;
Ronald Cron9486f9d2020-11-26 13:36:23 +01001345}
1346
Ronald Cron7285cda2020-11-26 14:46:37 +01001347psa_status_t psa_export_public_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001348 const psa_key_attributes_t *attributes,
1349 const uint8_t *key_buffer,
1350 size_t key_buffer_size,
1351 uint8_t *data,
1352 size_t data_size,
Gilles Peskine449bd832023-01-11 14:50:10 +01001353 size_t *data_length)
Ronald Cron9486f9d2020-11-26 13:36:23 +01001354{
Ronald Crond18b5f82020-11-25 16:46:05 +01001355 psa_key_type_t type = attributes->core.type;
Ronald Crond18b5f82020-11-25 16:46:05 +01001356
Przemek Stekiel6fd72b62023-04-27 10:20:56 +02001357 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(type) &&
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001358 (PSA_KEY_TYPE_IS_RSA(type) || PSA_KEY_TYPE_IS_ECC(type) ||
1359 PSA_KEY_TYPE_IS_DH(type))) {
Przemek Stekiel6fd72b62023-04-27 10:20:56 +02001360 /* Exporting public -> public */
1361 return psa_export_key_buffer_internal(
1362 key_buffer, key_buffer_size,
1363 data, data_size, data_length);
1364 } else if (PSA_KEY_TYPE_IS_RSA(type)) {
Valerio Settib2bcedb2023-07-10 11:24:00 +02001365#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT) || \
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001366 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
1367 return mbedtls_psa_rsa_export_public_key(attributes,
1368 key_buffer,
1369 key_buffer_size,
1370 data,
1371 data_size,
1372 data_length);
Darryl Green9e2d7a02018-07-24 16:33:30 +01001373#else
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001374 /* We don't know how to convert a private RSA key to public. */
1375 return PSA_ERROR_NOT_SUPPORTED;
Valerio Settib2bcedb2023-07-10 11:24:00 +02001376#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT) ||
John Durkop9814fa22020-11-04 12:28:15 -08001377 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Przemek Stekiel6fd72b62023-04-27 10:20:56 +02001378 } else if (PSA_KEY_TYPE_IS_ECC(type)) {
Valerio Setti27c501a2023-06-27 16:58:52 +02001379#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_EXPORT) || \
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001380 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
1381 return mbedtls_psa_ecp_export_public_key(attributes,
1382 key_buffer,
1383 key_buffer_size,
1384 data,
1385 data_size,
1386 data_length);
Steven Cooreman560c28a2020-07-24 23:20:24 +02001387#else
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001388 /* We don't know how to convert a private ECC key to public */
1389 return PSA_ERROR_NOT_SUPPORTED;
Valerio Setti27c501a2023-06-27 16:58:52 +02001390#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_EXPORT) ||
John Durkop9814fa22020-11-04 12:28:15 -08001391 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
Przemek Stekiel6fd72b62023-04-27 10:20:56 +02001392 } else if (PSA_KEY_TYPE_IS_DH(type)) {
Valerio Settia55f0422023-07-10 15:34:41 +02001393#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_EXPORT) || \
Przemek Stekiel6d85afa2023-04-28 11:42:17 +02001394 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY)
Przemek Stekiel152bb462023-06-01 11:52:39 +02001395 return mbedtls_psa_ffdh_export_public_key(attributes,
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001396 key_buffer,
1397 key_buffer_size,
1398 data, data_size,
1399 data_length);
Przemek Stekiel472b3f32022-12-01 14:38:49 +01001400#else
Przemek Stekiel472b3f32022-12-01 14:38:49 +01001401 return PSA_ERROR_NOT_SUPPORTED;
Valerio Settia55f0422023-07-10 15:34:41 +02001402#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_EXPORT) ||
Przemek Stekiel6d85afa2023-04-28 11:42:17 +02001403 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY) */
Gilles Peskine449bd832023-01-11 14:50:10 +01001404 } else {
Przemek Stekiel0b11ee02023-05-16 13:26:06 +02001405 (void) key_buffer;
1406 (void) key_buffer_size;
1407 (void) data;
1408 (void) data_size;
1409 (void) data_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01001410 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman560c28a2020-07-24 23:20:24 +02001411 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001412}
Ronald Crond18b5f82020-11-25 16:46:05 +01001413
Gilles Peskine449bd832023-01-11 14:50:10 +01001414psa_status_t psa_export_public_key(mbedtls_svc_key_id_t key,
1415 uint8_t *data,
1416 size_t data_size,
1417 size_t *data_length)
Moran Pekerdd4ea382018-04-03 15:30:03 +03001418{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001419 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001420 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001421 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01001422 psa_key_attributes_t attributes;
Darryl Greendd8fb772018-11-07 16:00:44 +00001423
Ronald Crone907e552021-01-18 13:22:38 +01001424 /* Reject a zero-length output buffer now, since this can never be a
1425 * valid key representation. This way we know that data must be a valid
1426 * pointer and we can do things like memset(data, ..., data_size). */
Gilles Peskine449bd832023-01-11 14:50:10 +01001427 if (data_size == 0) {
1428 return PSA_ERROR_BUFFER_TOO_SMALL;
1429 }
Ronald Crone907e552021-01-18 13:22:38 +01001430
Darryl Greendd8fb772018-11-07 16:00:44 +00001431 /* Set the key to empty now, so that even when there are errors, we always
1432 * set data_length to a value between 0 and data_size. On error, setting
1433 * the key to empty is a good choice because an empty key representation is
1434 * unlikely to be accepted anywhere. */
1435 *data_length = 0;
1436
1437 /* Exporting a public key doesn't require a usage flag. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001438 status = psa_get_and_lock_key_slot_with_policy(key, &slot, 0, 0);
1439 if (status != PSA_SUCCESS) {
1440 return status;
1441 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001442
Gilles Peskine449bd832023-01-11 14:50:10 +01001443 if (!PSA_KEY_TYPE_IS_ASYMMETRIC(slot->attr.type)) {
1444 status = PSA_ERROR_INVALID_ARGUMENT;
1445 goto exit;
Ronald Cron9486f9d2020-11-26 13:36:23 +01001446 }
1447
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01001448 attributes = (psa_key_attributes_t) {
Ronald Crond18b5f82020-11-25 16:46:05 +01001449 .core = slot->attr
1450 };
Ronald Cron67227982020-11-26 15:16:05 +01001451 status = psa_driver_wrapper_export_public_key(
Ronald Crond18b5f82020-11-25 16:46:05 +01001452 &attributes, slot->key.data, slot->key.bytes,
Gilles Peskine449bd832023-01-11 14:50:10 +01001453 data, data_size, data_length);
Ronald Cron9486f9d2020-11-26 13:36:23 +01001454
1455exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01001456 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02001457
Gilles Peskine449bd832023-01-11 14:50:10 +01001458 return (status == PSA_SUCCESS) ? unlock_status : status;
Moran Pekerdd4ea382018-04-03 15:30:03 +03001459}
1460
Tom Cosgrove6ef9bb32023-03-08 14:19:51 +00001461MBEDTLS_STATIC_ASSERT(
1462 (MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE) == 0,
1463 "One or more key attribute flag is listed as both external-only and dual-use")
1464MBEDTLS_STATIC_ASSERT(
1465 (PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE) == 0,
1466 "One or more key attribute flag is listed as both internal-only and dual-use")
1467MBEDTLS_STATIC_ASSERT(
1468 (PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY) == 0,
1469 "One or more key attribute flag is listed as both internal-only and external-only")
Gilles Peskine91e8c332019-08-02 19:19:39 +02001470
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001471/** Validate that a key policy is internally well-formed.
1472 *
1473 * This function only rejects invalid policies. It does not validate the
1474 * consistency of the policy with respect to other attributes of the key
1475 * such as the key type.
1476 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001477static psa_status_t psa_validate_key_policy(const psa_key_policy_t *policy)
Gilles Peskine4747d192019-04-17 15:05:45 +02001478{
Gilles Peskine449bd832023-01-11 14:50:10 +01001479 if ((policy->usage & ~(PSA_KEY_USAGE_EXPORT |
1480 PSA_KEY_USAGE_COPY |
1481 PSA_KEY_USAGE_ENCRYPT |
1482 PSA_KEY_USAGE_DECRYPT |
1483 PSA_KEY_USAGE_SIGN_MESSAGE |
1484 PSA_KEY_USAGE_VERIFY_MESSAGE |
1485 PSA_KEY_USAGE_SIGN_HASH |
1486 PSA_KEY_USAGE_VERIFY_HASH |
1487 PSA_KEY_USAGE_VERIFY_DERIVATION |
1488 PSA_KEY_USAGE_DERIVE)) != 0) {
1489 return PSA_ERROR_INVALID_ARGUMENT;
1490 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001491
Gilles Peskine449bd832023-01-11 14:50:10 +01001492 return PSA_SUCCESS;
Gilles Peskine4747d192019-04-17 15:05:45 +02001493}
1494
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001495/** Validate the internal consistency of key attributes.
1496 *
1497 * This function only rejects invalid attribute values. If does not
1498 * validate the consistency of the attributes with any key data that may
1499 * be involved in the creation of the key.
1500 *
1501 * Call this function early in the key creation process.
1502 *
1503 * \param[in] attributes Key attributes for the new key.
1504 * \param[out] p_drv On any return, the driver for the key, if any.
1505 * NULL for a transparent key.
1506 *
1507 */
1508static psa_status_t psa_validate_key_attributes(
1509 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01001510 psa_se_drv_table_entry_t **p_drv)
Darryl Green0c6575a2018-11-07 16:05:30 +00001511{
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001512 psa_status_t status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine449bd832023-01-11 14:50:10 +01001513 psa_key_lifetime_t lifetime = psa_get_key_lifetime(attributes);
1514 mbedtls_svc_key_id_t key = psa_get_key_id(attributes);
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001515
Gilles Peskine449bd832023-01-11 14:50:10 +01001516 status = psa_validate_key_location(lifetime, p_drv);
1517 if (status != PSA_SUCCESS) {
1518 return status;
Ronald Crond2ed4812020-07-17 16:11:30 +02001519 }
1520
Gilles Peskine449bd832023-01-11 14:50:10 +01001521 status = psa_validate_key_persistence(lifetime);
1522 if (status != PSA_SUCCESS) {
1523 return status;
1524 }
1525
1526 if (PSA_KEY_LIFETIME_IS_VOLATILE(lifetime)) {
1527 if (MBEDTLS_SVC_KEY_ID_GET_KEY_ID(key) != 0) {
1528 return PSA_ERROR_INVALID_ARGUMENT;
1529 }
1530 } else {
1531 if (!psa_is_valid_key_id(psa_get_key_id(attributes), 0)) {
1532 return PSA_ERROR_INVALID_ARGUMENT;
1533 }
1534 }
1535
1536 status = psa_validate_key_policy(&attributes->core.policy);
1537 if (status != PSA_SUCCESS) {
1538 return status;
1539 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001540
1541 /* Refuse to create overly large keys.
1542 * Note that this doesn't trigger on import if the attributes don't
1543 * explicitly specify a size (so psa_get_key_bits returns 0), so
1544 * psa_import_key() needs its own checks. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001545 if (psa_get_key_bits(attributes) > PSA_MAX_KEY_BITS) {
1546 return PSA_ERROR_NOT_SUPPORTED;
1547 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001548
Gilles Peskine91e8c332019-08-02 19:19:39 +02001549 /* Reject invalid flags. These should not be reachable through the API. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001550 if (attributes->core.flags & ~(MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1551 MBEDTLS_PSA_KA_MASK_DUAL_USE)) {
1552 return PSA_ERROR_INVALID_ARGUMENT;
1553 }
Gilles Peskine91e8c332019-08-02 19:19:39 +02001554
Gilles Peskine449bd832023-01-11 14:50:10 +01001555 return PSA_SUCCESS;
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001556}
1557
Gilles Peskine4747d192019-04-17 15:05:45 +02001558/** Prepare a key slot to receive key material.
1559 *
1560 * This function allocates a key slot and sets its metadata.
1561 *
1562 * If this function fails, call psa_fail_key_creation().
1563 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001564 * This function is intended to be used as follows:
1565 * -# Call psa_start_key_creation() to allocate a key slot, prepare
Ronald Croncf56a0a2020-08-04 09:51:30 +02001566 * it with the specified attributes, and in case of a volatile key assign it
1567 * a volatile key identifier.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001568 * -# Populate the slot with the key material.
1569 * -# Call psa_finish_key_creation() to finalize the creation of the slot.
1570 * In case of failure at any step, stop the sequence and call
1571 * psa_fail_key_creation().
1572 *
Ronald Cron5c522922020-11-14 16:35:34 +01001573 * On success, the key slot is locked. It is the responsibility of the caller
1574 * to unlock the key slot when it does not access it anymore.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001575 *
Gilles Peskinedf179142019-07-15 22:02:14 +02001576 * \param method An identification of the calling function.
Gilles Peskine011e4282019-06-26 18:34:38 +02001577 * \param[in] attributes Key attributes for the new key.
Gilles Peskine011e4282019-06-26 18:34:38 +02001578 * \param[out] p_slot On success, a pointer to the prepared slot.
1579 * \param[out] p_drv On any return, the driver for the key, if any.
1580 * NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001581 *
1582 * \retval #PSA_SUCCESS
1583 * The key slot is ready to receive key material.
1584 * \return If this function fails, the key slot is an invalid state.
1585 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001586 */
1587static psa_status_t psa_start_key_creation(
Gilles Peskinedf179142019-07-15 22:02:14 +02001588 psa_key_creation_method_t method,
Gilles Peskine4747d192019-04-17 15:05:45 +02001589 const psa_key_attributes_t *attributes,
Gilles Peskine011e4282019-06-26 18:34:38 +02001590 psa_key_slot_t **p_slot,
Gilles Peskine449bd832023-01-11 14:50:10 +01001591 psa_se_drv_table_entry_t **p_drv)
Gilles Peskine4747d192019-04-17 15:05:45 +02001592{
1593 psa_status_t status;
Ronald Cron2a993152020-07-17 14:13:26 +02001594 psa_key_id_t volatile_key_id;
Gilles Peskine4747d192019-04-17 15:05:45 +02001595 psa_key_slot_t *slot;
1596
Gilles Peskinedf179142019-07-15 22:02:14 +02001597 (void) method;
Gilles Peskine011e4282019-06-26 18:34:38 +02001598 *p_drv = NULL;
1599
Gilles Peskine449bd832023-01-11 14:50:10 +01001600 status = psa_validate_key_attributes(attributes, p_drv);
1601 if (status != PSA_SUCCESS) {
1602 return status;
1603 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001604
Gilles Peskine449bd832023-01-11 14:50:10 +01001605 status = psa_get_empty_key_slot(&volatile_key_id, p_slot);
1606 if (status != PSA_SUCCESS) {
1607 return status;
1608 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001609 slot = *p_slot;
1610
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001611 /* We're storing the declared bit-size of the key. It's up to each
1612 * creation mechanism to verify that this information is correct.
1613 * It's automatically correct for mechanisms that use the bit-size as
Gilles Peskineb46bef22019-07-30 21:32:04 +02001614 * an input (generate, device) but not for those where the bit-size
Ronald Cronc4d1b512020-07-31 11:26:37 +02001615 * is optional (import, copy). In case of a volatile key, assign it the
1616 * volatile key identifier associated to the slot returned to contain its
1617 * definition. */
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001618
1619 slot->attr = attributes->core;
Gilles Peskine449bd832023-01-11 14:50:10 +01001620 if (PSA_KEY_LIFETIME_IS_VOLATILE(slot->attr.lifetime)) {
Ronald Cronc4d1b512020-07-31 11:26:37 +02001621#if !defined(MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER)
1622 slot->attr.id = volatile_key_id;
1623#else
1624 slot->attr.id.key_id = volatile_key_id;
1625#endif
1626 }
Gilles Peskinec744d992019-07-30 17:26:54 +02001627
Gilles Peskine91e8c332019-08-02 19:19:39 +02001628 /* Erase external-only flags from the internal copy. To access
Gilles Peskine013f5472019-08-07 15:42:14 +02001629 * external-only flags, query `attributes`. Thanks to the check
1630 * in psa_validate_key_attributes(), this leaves the dual-use
Gilles Peskineedbed562019-08-07 18:19:59 +02001631 * flags and any internal flag that psa_get_empty_key_slot()
Gilles Peskine013f5472019-08-07 15:42:14 +02001632 * may have set. */
1633 slot->attr.flags &= ~MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY;
Gilles Peskine91e8c332019-08-02 19:19:39 +02001634
Gilles Peskinecbaff462019-07-12 23:46:04 +02001635#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001636 /* For a key in a secure element, we need to do three things
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001637 * when creating or registering a persistent key:
Gilles Peskine60450a42019-07-25 11:32:45 +02001638 * create the key file in internal storage, create the
1639 * key inside the secure element, and update the driver's
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001640 * persistent data. This is done by starting a transaction that will
1641 * encompass these three actions.
1642 * For registering a volatile key, we just need to find an appropriate
1643 * slot number inside the SE. Since the key is designated volatile, creating
1644 * a transaction is not required. */
Gilles Peskine60450a42019-07-25 11:32:45 +02001645 /* The first thing to do is to find a slot number for the new key.
1646 * We save the slot number in persistent storage as part of the
1647 * transaction data. It will be needed to recover if the power
1648 * fails during the key creation process, to clean up on the secure
1649 * element side after restarting. Obtaining a slot number from the
1650 * secure element driver updates its persistent state, but we do not yet
1651 * save the driver's persistent state, so that if the power fails,
Gilles Peskinefc762652019-07-22 19:30:34 +02001652 * we can roll back to a state where the key doesn't exist. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001653 if (*p_drv != NULL) {
Ronald Cronea0f8a62020-11-25 17:52:23 +01001654 psa_key_slot_number_t slot_number;
Gilles Peskine449bd832023-01-11 14:50:10 +01001655 status = psa_find_se_slot_for_key(attributes, method, *p_drv,
1656 &slot_number);
1657 if (status != PSA_SUCCESS) {
1658 return status;
1659 }
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001660
Gilles Peskine449bd832023-01-11 14:50:10 +01001661 if (!PSA_KEY_LIFETIME_IS_VOLATILE(attributes->core.lifetime)) {
1662 psa_crypto_prepare_transaction(PSA_CRYPTO_TRANSACTION_CREATE_KEY);
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001663 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001664 psa_crypto_transaction.key.slot = slot_number;
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001665 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskine449bd832023-01-11 14:50:10 +01001666 status = psa_crypto_save_transaction();
1667 if (status != PSA_SUCCESS) {
1668 (void) psa_crypto_stop_transaction();
1669 return status;
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001670 }
Gilles Peskine66be51c2019-07-25 18:02:52 +02001671 }
Ronald Cronea0f8a62020-11-25 17:52:23 +01001672
1673 status = psa_copy_key_material_into_slot(
Gilles Peskine449bd832023-01-11 14:50:10 +01001674 slot, (uint8_t *) (&slot_number), sizeof(slot_number));
Darryl Green0c6575a2018-11-07 16:05:30 +00001675 }
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001676
Gilles Peskine449bd832023-01-11 14:50:10 +01001677 if (*p_drv == NULL && method == PSA_KEY_CREATION_REGISTER) {
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001678 /* Key registration only makes sense with a secure element. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001679 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001680 }
Gilles Peskinecbaff462019-07-12 23:46:04 +02001681#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1682
Ryan Everett975d4112023-11-16 13:37:51 +00001683 slot->status = PSA_SLOT_OCCUPIED;
1684
Gilles Peskine449bd832023-01-11 14:50:10 +01001685 return PSA_SUCCESS;
Darryl Green0c6575a2018-11-07 16:05:30 +00001686}
Gilles Peskine4747d192019-04-17 15:05:45 +02001687
1688/** Finalize the creation of a key once its key material has been set.
1689 *
1690 * This entails writing the key to persistent storage.
1691 *
1692 * If this function fails, call psa_fail_key_creation().
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001693 * See the documentation of psa_start_key_creation() for the intended use
1694 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001695 *
Ronald Cron5c522922020-11-14 16:35:34 +01001696 * If the finalization succeeds, the function unlocks the key slot (it was
1697 * locked by psa_start_key_creation()) and the key slot cannot be accessed
1698 * anymore as part of the key creation process.
Ronald Cron50972942020-11-14 11:28:25 +01001699 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001700 * \param[in,out] slot Pointer to the slot with key material.
1701 * \param[in] driver The secure element driver for the key,
1702 * or NULL for a transparent key.
Ronald Cron81709fc2020-11-14 12:10:32 +01001703 * \param[out] key On success, identifier of the key. Note that the
1704 * key identifier is also stored in the key slot.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001705 *
1706 * \retval #PSA_SUCCESS
Ronald Croncf56a0a2020-08-04 09:51:30 +02001707 * The key was successfully created.
Gilles Peskineed733552023-02-14 19:21:09 +01001708 * \retval #PSA_ERROR_INSUFFICIENT_MEMORY \emptydescription
1709 * \retval #PSA_ERROR_INSUFFICIENT_STORAGE \emptydescription
1710 * \retval #PSA_ERROR_ALREADY_EXISTS \emptydescription
1711 * \retval #PSA_ERROR_DATA_INVALID \emptydescription
1712 * \retval #PSA_ERROR_DATA_CORRUPT \emptydescription
1713 * \retval #PSA_ERROR_STORAGE_FAILURE \emptydescription
gabor-mezei-arm452b0a32020-11-09 17:42:55 +01001714 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001715 * \return If this function fails, the key slot is an invalid state.
1716 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001717 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001718static psa_status_t psa_finish_key_creation(
1719 psa_key_slot_t *slot,
Ronald Cron81709fc2020-11-14 12:10:32 +01001720 psa_se_drv_table_entry_t *driver,
1721 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02001722{
1723 psa_status_t status = PSA_SUCCESS;
Gilles Peskine30afafd2019-04-25 13:47:40 +02001724 (void) slot;
Gilles Peskine011e4282019-06-26 18:34:38 +02001725 (void) driver;
Gilles Peskine4747d192019-04-17 15:05:45 +02001726
1727#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001728 if (!PSA_KEY_LIFETIME_IS_VOLATILE(slot->attr.lifetime)) {
Gilles Peskine1df83d42019-07-23 16:13:14 +02001729#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001730 if (driver != NULL) {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001731 psa_se_key_data_storage_t data;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001732 psa_key_slot_number_t slot_number =
Gilles Peskine449bd832023-01-11 14:50:10 +01001733 psa_key_slot_get_slot_number(slot);
Ronald Cronea0f8a62020-11-25 17:52:23 +01001734
Tom Cosgrove6ef9bb32023-03-08 14:19:51 +00001735 MBEDTLS_STATIC_ASSERT(sizeof(slot_number) ==
1736 sizeof(data.slot_number),
1737 "Slot number size does not match psa_se_key_data_storage_t");
1738
Gilles Peskine449bd832023-01-11 14:50:10 +01001739 memcpy(&data.slot_number, &slot_number, sizeof(slot_number));
1740 status = psa_save_persistent_key(&slot->attr,
1741 (uint8_t *) &data,
1742 sizeof(data));
1743 } else
Gilles Peskine1df83d42019-07-23 16:13:14 +02001744#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1745 {
Steven Cooreman40120f62020-10-29 11:42:22 +01001746 /* Key material is saved in export representation in the slot, so
1747 * just pass the slot buffer for storage. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001748 status = psa_save_persistent_key(&slot->attr,
1749 slot->key.data,
1750 slot->key.bytes);
Gilles Peskine1df83d42019-07-23 16:13:14 +02001751 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001752 }
Darryl Green0c6575a2018-11-07 16:05:30 +00001753#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
1754
Gilles Peskinecbaff462019-07-12 23:46:04 +02001755#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001756 /* Finish the transaction for a key creation. This does not
1757 * happen when registering an existing key. Detect this case
1758 * by checking whether a transaction is in progress (actual
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001759 * creation of a persistent key in a secure element requires a transaction,
1760 * but registration or volatile key creation doesn't use one). */
Gilles Peskine449bd832023-01-11 14:50:10 +01001761 if (driver != NULL &&
1762 psa_crypto_transaction.unknown.type == PSA_CRYPTO_TRANSACTION_CREATE_KEY) {
1763 status = psa_save_se_persistent_data(driver);
1764 if (status != PSA_SUCCESS) {
1765 psa_destroy_persistent_key(slot->attr.id);
1766 return status;
Gilles Peskinecbaff462019-07-12 23:46:04 +02001767 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001768 status = psa_crypto_stop_transaction();
Gilles Peskinecbaff462019-07-12 23:46:04 +02001769 }
1770#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1771
Gilles Peskine449bd832023-01-11 14:50:10 +01001772 if (status == PSA_SUCCESS) {
Ronald Cron81709fc2020-11-14 12:10:32 +01001773 *key = slot->attr.id;
Gilles Peskine449bd832023-01-11 14:50:10 +01001774 status = psa_unlock_key_slot(slot);
1775 if (status != PSA_SUCCESS) {
Ronald Cron81709fc2020-11-14 12:10:32 +01001776 *key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01001777 }
Ronald Cron81709fc2020-11-14 12:10:32 +01001778 }
Ronald Cron50972942020-11-14 11:28:25 +01001779
Gilles Peskine449bd832023-01-11 14:50:10 +01001780 return status;
Gilles Peskine4747d192019-04-17 15:05:45 +02001781}
1782
1783/** Abort the creation of a key.
1784 *
1785 * You may call this function after calling psa_start_key_creation(),
1786 * or after psa_finish_key_creation() fails. In other circumstances, this
1787 * function may not clean up persistent storage.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001788 * See the documentation of psa_start_key_creation() for the intended use
1789 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001790 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001791 * \param[in,out] slot Pointer to the slot with key material.
1792 * \param[in] driver The secure element driver for the key,
1793 * or NULL for a transparent key.
Gilles Peskine4747d192019-04-17 15:05:45 +02001794 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001795static void psa_fail_key_creation(psa_key_slot_t *slot,
1796 psa_se_drv_table_entry_t *driver)
Gilles Peskine4747d192019-04-17 15:05:45 +02001797{
Gilles Peskine011e4282019-06-26 18:34:38 +02001798 (void) driver;
1799
Gilles Peskine449bd832023-01-11 14:50:10 +01001800 if (slot == NULL) {
Gilles Peskine4747d192019-04-17 15:05:45 +02001801 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01001802 }
Gilles Peskine011e4282019-06-26 18:34:38 +02001803
1804#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001805 /* TODO: If the key has already been created in the secure
Gilles Peskine011e4282019-06-26 18:34:38 +02001806 * element, and the failure happened later (when saving metadata
1807 * to internal storage), we need to destroy the key in the secure
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001808 * element.
1809 * https://github.com/ARMmbed/mbed-crypto/issues/217
1810 */
Gilles Peskinefc762652019-07-22 19:30:34 +02001811
Gilles Peskined7729582019-08-05 15:55:54 +02001812 /* Abort the ongoing transaction if any (there may not be one if
1813 * the creation process failed before starting one, or if the
1814 * key creation is a registration of a key in a secure element).
1815 * Earlier functions must already have done what it takes to undo any
1816 * partial creation. All that's left is to update the transaction data
1817 * itself. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001818 (void) psa_crypto_stop_transaction();
Gilles Peskine011e4282019-06-26 18:34:38 +02001819#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1820
Gilles Peskine449bd832023-01-11 14:50:10 +01001821 psa_wipe_key_slot(slot);
Gilles Peskine4747d192019-04-17 15:05:45 +02001822}
1823
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001824/** Validate optional attributes during key creation.
1825 *
1826 * Some key attributes are optional during key creation. If they are
1827 * specified in the attributes structure, check that they are consistent
1828 * with the data in the slot.
1829 *
1830 * This function should be called near the end of key creation, after
1831 * the slot in memory is fully populated but before saving persistent data.
1832 */
1833static psa_status_t psa_validate_optional_attributes(
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001834 const psa_key_slot_t *slot,
Gilles Peskine449bd832023-01-11 14:50:10 +01001835 const psa_key_attributes_t *attributes)
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001836{
Gilles Peskine449bd832023-01-11 14:50:10 +01001837 if (attributes->core.type != 0) {
1838 if (attributes->core.type != slot->attr.type) {
1839 return PSA_ERROR_INVALID_ARGUMENT;
1840 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001841 }
1842
Gilles Peskine449bd832023-01-11 14:50:10 +01001843 if (attributes->domain_parameters_size != 0) {
Valerio Settib2bcedb2023-07-10 11:24:00 +02001844#if (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) && \
1845 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01001846 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
1847 if (PSA_KEY_TYPE_IS_RSA(slot->attr.type)) {
Steven Cooremana2371e52020-07-28 14:30:39 +02001848 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman75b74362020-07-28 14:30:13 +02001849 mbedtls_mpi actual, required;
Steven Cooreman6d839f02020-07-30 11:36:45 +02001850 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooremana01795d2020-07-24 22:48:15 +02001851
Ronald Cron90857082020-11-25 14:58:33 +01001852 psa_status_t status = mbedtls_psa_rsa_load_representation(
Gilles Peskine449bd832023-01-11 14:50:10 +01001853 slot->attr.type,
1854 slot->key.data,
1855 slot->key.bytes,
1856 &rsa);
1857 if (status != PSA_SUCCESS) {
1858 return status;
1859 }
Steven Cooreman75b74362020-07-28 14:30:13 +02001860
Gilles Peskine449bd832023-01-11 14:50:10 +01001861 mbedtls_mpi_init(&actual);
1862 mbedtls_mpi_init(&required);
1863 ret = mbedtls_rsa_export(rsa,
1864 NULL, NULL, NULL, NULL, &actual);
1865 mbedtls_rsa_free(rsa);
1866 mbedtls_free(rsa);
1867 if (ret != 0) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001868 goto rsa_exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001869 }
1870 ret = mbedtls_mpi_read_binary(&required,
1871 attributes->domain_parameters,
1872 attributes->domain_parameters_size);
1873 if (ret != 0) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001874 goto rsa_exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001875 }
1876 if (mbedtls_mpi_cmp_mpi(&actual, &required) != 0) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001877 ret = MBEDTLS_ERR_RSA_BAD_INPUT_DATA;
Gilles Peskine449bd832023-01-11 14:50:10 +01001878 }
1879rsa_exit:
1880 mbedtls_mpi_free(&actual);
1881 mbedtls_mpi_free(&required);
1882 if (ret != 0) {
1883 return mbedtls_to_psa_error(ret);
1884 }
1885 } else
Valerio Settib2bcedb2023-07-10 11:24:00 +02001886#endif /* (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) &&
1887 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) ||
John Durkop9814fa22020-11-04 12:28:15 -08001888 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001889 {
Gilles Peskine449bd832023-01-11 14:50:10 +01001890 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001891 }
1892 }
1893
Gilles Peskine449bd832023-01-11 14:50:10 +01001894 if (attributes->core.bits != 0) {
1895 if (attributes->core.bits != slot->attr.bits) {
1896 return PSA_ERROR_INVALID_ARGUMENT;
1897 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001898 }
1899
Gilles Peskine449bd832023-01-11 14:50:10 +01001900 return PSA_SUCCESS;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001901}
1902
Gilles Peskine449bd832023-01-11 14:50:10 +01001903psa_status_t psa_import_key(const psa_key_attributes_t *attributes,
1904 const uint8_t *data,
1905 size_t data_length,
1906 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02001907{
1908 psa_status_t status;
1909 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001910 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001911 size_t bits;
Archanad8a83dc2021-06-14 10:04:16 +05301912 size_t storage_size = data_length;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001913
Ronald Cron81709fc2020-11-14 12:10:32 +01001914 *key = MBEDTLS_SVC_KEY_ID_INIT;
1915
Gilles Peskine0f84d622019-09-12 19:03:13 +02001916 /* Reject zero-length symmetric keys (including raw data key objects).
1917 * This also rejects any key which might be encoded as an empty string,
1918 * which is never valid. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001919 if (data_length == 0) {
1920 return PSA_ERROR_INVALID_ARGUMENT;
1921 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02001922
Archana449608b2021-09-08 15:36:05 +05301923 /* Ensure that the bytes-to-bits conversion cannot overflow. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001924 if (data_length > SIZE_MAX / 8) {
1925 return PSA_ERROR_NOT_SUPPORTED;
1926 }
Archana6ed4bda2021-08-04 10:47:15 +05301927
Gilles Peskine449bd832023-01-11 14:50:10 +01001928 status = psa_start_key_creation(PSA_KEY_CREATION_IMPORT, attributes,
1929 &slot, &driver);
1930 if (status != PSA_SUCCESS) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001931 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001932 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001933
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001934 /* In the case of a transparent key or an opaque key stored in local
Archana449608b2021-09-08 15:36:05 +05301935 * storage ( thus not in the case of importing a key in a secure element
1936 * with storage ( MBEDTLS_PSA_CRYPTO_SE_C ) ),we have to allocate a
1937 * buffer to hold the imported key material. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001938 if (slot->key.data == NULL) {
1939 if (psa_key_lifetime_is_external(attributes->core.lifetime)) {
Archana449608b2021-09-08 15:36:05 +05301940 status = psa_driver_wrapper_get_key_buffer_size_from_key_data(
Gilles Peskine449bd832023-01-11 14:50:10 +01001941 attributes, data, data_length, &storage_size);
1942 if (status != PSA_SUCCESS) {
Archanad8a83dc2021-06-14 10:04:16 +05301943 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001944 }
Archanad8a83dc2021-06-14 10:04:16 +05301945 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001946 status = psa_allocate_buffer_to_slot(slot, storage_size);
1947 if (status != PSA_SUCCESS) {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001948 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001949 }
Gilles Peskine5d309672019-07-12 23:47:28 +02001950 }
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001951
1952 bits = slot->attr.bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01001953 status = psa_driver_wrapper_import_key(attributes,
1954 data, data_length,
1955 slot->key.data,
1956 slot->key.bytes,
1957 &slot->key.bytes, &bits);
1958 if (status != PSA_SUCCESS) {
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001959 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001960 }
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001961
Gilles Peskine449bd832023-01-11 14:50:10 +01001962 if (slot->attr.bits == 0) {
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001963 slot->attr.bits = (psa_key_bits_t) bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01001964 } else if (bits != slot->attr.bits) {
Steven Cooremanac3434f2021-01-15 17:36:02 +01001965 status = PSA_ERROR_INVALID_ARGUMENT;
1966 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02001967 }
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01001968
Archana6ed4bda2021-08-04 10:47:15 +05301969 /* Enforce a size limit, and in particular ensure that the bit
1970 * size fits in its representation type.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01001971 if (bits > PSA_MAX_KEY_BITS) {
Archana6ed4bda2021-08-04 10:47:15 +05301972 status = PSA_ERROR_NOT_SUPPORTED;
1973 goto exit;
1974 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001975 status = psa_validate_optional_attributes(slot, attributes);
1976 if (status != PSA_SUCCESS) {
Gilles Peskine18017402019-07-24 20:25:59 +02001977 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001978 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001979
Gilles Peskine449bd832023-01-11 14:50:10 +01001980 status = psa_finish_key_creation(slot, driver, key);
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001981exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01001982 if (status != PSA_SUCCESS) {
1983 psa_fail_key_creation(slot, driver);
1984 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001985
Gilles Peskine449bd832023-01-11 14:50:10 +01001986 return status;
Gilles Peskine4747d192019-04-17 15:05:45 +02001987}
1988
Gilles Peskined7729582019-08-05 15:55:54 +02001989#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1990psa_status_t mbedtls_psa_register_se_key(
Gilles Peskine449bd832023-01-11 14:50:10 +01001991 const psa_key_attributes_t *attributes)
Gilles Peskined7729582019-08-05 15:55:54 +02001992{
1993 psa_status_t status;
1994 psa_key_slot_t *slot = NULL;
1995 psa_se_drv_table_entry_t *driver = NULL;
Ronald Croncf56a0a2020-08-04 09:51:30 +02001996 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskined7729582019-08-05 15:55:54 +02001997
1998 /* Leaving attributes unspecified is not currently supported.
1999 * It could make sense to query the key type and size from the
2000 * secure element, but not all secure elements support this
2001 * and the driver HAL doesn't currently support it. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002002 if (psa_get_key_type(attributes) == PSA_KEY_TYPE_NONE) {
2003 return PSA_ERROR_NOT_SUPPORTED;
2004 }
2005 if (psa_get_key_bits(attributes) == 0) {
2006 return PSA_ERROR_NOT_SUPPORTED;
2007 }
Gilles Peskined7729582019-08-05 15:55:54 +02002008
Gilles Peskine449bd832023-01-11 14:50:10 +01002009 status = psa_start_key_creation(PSA_KEY_CREATION_REGISTER, attributes,
2010 &slot, &driver);
2011 if (status != PSA_SUCCESS) {
Gilles Peskined7729582019-08-05 15:55:54 +02002012 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002013 }
Gilles Peskined7729582019-08-05 15:55:54 +02002014
Gilles Peskine449bd832023-01-11 14:50:10 +01002015 status = psa_finish_key_creation(slot, driver, &key);
Gilles Peskined7729582019-08-05 15:55:54 +02002016
2017exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002018 if (status != PSA_SUCCESS) {
2019 psa_fail_key_creation(slot, driver);
2020 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002021
Gilles Peskined7729582019-08-05 15:55:54 +02002022 /* Registration doesn't keep the key in RAM. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002023 psa_close_key(key);
2024 return status;
Gilles Peskined7729582019-08-05 15:55:54 +02002025}
2026#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2027
Gilles Peskine449bd832023-01-11 14:50:10 +01002028psa_status_t psa_copy_key(mbedtls_svc_key_id_t source_key,
2029 const psa_key_attributes_t *specified_attributes,
2030 mbedtls_svc_key_id_t *target_key)
Gilles Peskinef603c712019-01-19 13:40:11 +01002031{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002032 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01002033 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinef603c712019-01-19 13:40:11 +01002034 psa_key_slot_t *source_slot = NULL;
2035 psa_key_slot_t *target_slot = NULL;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002036 psa_key_attributes_t actual_attributes = *specified_attributes;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002037 psa_se_drv_table_entry_t *driver = NULL;
Archana8a180362021-07-05 02:18:48 +05302038 size_t storage_size = 0;
Gilles Peskinef603c712019-01-19 13:40:11 +01002039
Ronald Cron81709fc2020-11-14 12:10:32 +01002040 *target_key = MBEDTLS_SVC_KEY_ID_INIT;
2041
Archana8a180362021-07-05 02:18:48 +05302042 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002043 source_key, &source_slot, PSA_KEY_USAGE_COPY, 0);
2044 if (status != PSA_SUCCESS) {
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002045 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002046 }
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002047
Gilles Peskine449bd832023-01-11 14:50:10 +01002048 status = psa_validate_optional_attributes(source_slot,
2049 specified_attributes);
2050 if (status != PSA_SUCCESS) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002051 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002052 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002053
Archana9d17bf42021-09-10 06:22:44 +05302054 /* The target key type and number of bits have been validated by
2055 * psa_validate_optional_attributes() to be either equal to zero or
2056 * equal to the ones of the source key. So it is safe to inherit
2057 * them from the source key now."
Archana374fe5b2021-09-08 15:50:28 +05302058 * */
Archana9d17bf42021-09-10 06:22:44 +05302059 actual_attributes.core.bits = source_slot->attr.bits;
2060 actual_attributes.core.type = source_slot->attr.type;
Archana374fe5b2021-09-08 15:50:28 +05302061
2062
Gilles Peskine449bd832023-01-11 14:50:10 +01002063 status = psa_restrict_key_policy(source_slot->attr.type,
2064 &actual_attributes.core.policy,
2065 &source_slot->attr.policy);
2066 if (status != PSA_SUCCESS) {
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002067 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002068 }
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002069
Gilles Peskine449bd832023-01-11 14:50:10 +01002070 status = psa_start_key_creation(PSA_KEY_CREATION_COPY, &actual_attributes,
2071 &target_slot, &driver);
2072 if (status != PSA_SUCCESS) {
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002073 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002074 }
2075 if (PSA_KEY_LIFETIME_GET_LOCATION(target_slot->attr.lifetime) !=
2076 PSA_KEY_LIFETIME_GET_LOCATION(source_slot->attr.lifetime)) {
Archana8a180362021-07-05 02:18:48 +05302077 /*
Archana9d17bf42021-09-10 06:22:44 +05302078 * If the source and target keys are stored in different locations,
Archana8a180362021-07-05 02:18:48 +05302079 * the source key would need to be exported as plaintext and re-imported
2080 * in the other location. This has security implications which have not
Archana449608b2021-09-08 15:36:05 +05302081 * been fully mapped. For now, this can be achieved through
Archana8a180362021-07-05 02:18:48 +05302082 * appropriate API invocations from the application, if needed.
2083 * */
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002084 status = PSA_ERROR_NOT_SUPPORTED;
2085 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002086 }
Archana8a180362021-07-05 02:18:48 +05302087 /*
2088 * When the source and target keys are within the same location,
Archana449608b2021-09-08 15:36:05 +05302089 * - For transparent keys it is a blind copy without any driver invocation,
Archana8a180362021-07-05 02:18:48 +05302090 * - For opaque keys this translates to an invocation of the drivers'
2091 * copy_key entry point through the dispatch layer.
2092 * */
Gilles Peskine449bd832023-01-11 14:50:10 +01002093 if (psa_key_lifetime_is_external(actual_attributes.core.lifetime)) {
2094 status = psa_driver_wrapper_get_key_buffer_size(&actual_attributes,
2095 &storage_size);
2096 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302097 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002098 }
Archana374fe5b2021-09-08 15:50:28 +05302099
Gilles Peskine449bd832023-01-11 14:50:10 +01002100 status = psa_allocate_buffer_to_slot(target_slot, storage_size);
2101 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302102 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002103 }
Archana374fe5b2021-09-08 15:50:28 +05302104
Gilles Peskine449bd832023-01-11 14:50:10 +01002105 status = psa_driver_wrapper_copy_key(&actual_attributes,
2106 source_slot->key.data,
2107 source_slot->key.bytes,
2108 target_slot->key.data,
2109 target_slot->key.bytes,
2110 &target_slot->key.bytes);
2111 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302112 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002113 }
2114 } else {
2115 status = psa_copy_key_material_into_slot(target_slot,
Archana9d17bf42021-09-10 06:22:44 +05302116 source_slot->key.data,
Gilles Peskine449bd832023-01-11 14:50:10 +01002117 source_slot->key.bytes);
2118 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302119 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002120 }
Archana8a180362021-07-05 02:18:48 +05302121 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002122 status = psa_finish_key_creation(target_slot, driver, target_key);
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002123exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002124 if (status != PSA_SUCCESS) {
2125 psa_fail_key_creation(target_slot, driver);
2126 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002127
Gilles Peskine449bd832023-01-11 14:50:10 +01002128 unlock_status = psa_unlock_key_slot(source_slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02002129
Gilles Peskine449bd832023-01-11 14:50:10 +01002130 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskinef603c712019-01-19 13:40:11 +01002131}
2132
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02002133
2134
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01002135/****************************************************************/
Gilles Peskine20035e32018-02-03 22:44:14 +01002136/* Message digests */
2137/****************************************************************/
2138
Gilles Peskine449bd832023-01-11 14:50:10 +01002139psa_status_t psa_hash_abort(psa_hash_operation_t *operation)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002140{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002141 /* Aborting a non-active operation is allowed */
Gilles Peskine449bd832023-01-11 14:50:10 +01002142 if (operation->id == 0) {
2143 return PSA_SUCCESS;
2144 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002145
Gilles Peskine449bd832023-01-11 14:50:10 +01002146 psa_status_t status = psa_driver_wrapper_hash_abort(operation);
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002147 operation->id = 0;
2148
Gilles Peskine449bd832023-01-11 14:50:10 +01002149 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002150}
2151
Gilles Peskine449bd832023-01-11 14:50:10 +01002152psa_status_t psa_hash_setup(psa_hash_operation_t *operation,
2153 psa_algorithm_t alg)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002154{
Dave Rodgman685b6a72021-06-24 11:49:14 +01002155 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002156
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002157 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002158 if (operation->id != 0) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002159 status = PSA_ERROR_BAD_STATE;
2160 goto exit;
2161 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002162
Gilles Peskine449bd832023-01-11 14:50:10 +01002163 if (!PSA_ALG_IS_HASH(alg)) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002164 status = PSA_ERROR_INVALID_ARGUMENT;
2165 goto exit;
2166 }
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002167
Steven Cooremanb6bf4bb2021-03-15 19:00:14 +01002168 /* Ensure all of the context is zeroized, since PSA_HASH_OPERATION_INIT only
2169 * directly zeroes the int-sized dummy member of the context union. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002170 memset(&operation->ctx, 0, sizeof(operation->ctx));
Steven Cooreman893232f2021-03-15 12:23:37 +01002171
Gilles Peskine449bd832023-01-11 14:50:10 +01002172 status = psa_driver_wrapper_hash_setup(operation, alg);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002173
2174exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002175 if (status != PSA_SUCCESS) {
2176 psa_hash_abort(operation);
2177 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002178
2179 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002180}
2181
Gilles Peskine449bd832023-01-11 14:50:10 +01002182psa_status_t psa_hash_update(psa_hash_operation_t *operation,
2183 const uint8_t *input,
2184 size_t input_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002185{
Dave Rodgman685b6a72021-06-24 11:49:14 +01002186 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2187
Gilles Peskine449bd832023-01-11 14:50:10 +01002188 if (operation->id == 0) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002189 status = PSA_ERROR_BAD_STATE;
2190 goto exit;
2191 }
Gilles Peskine94e44542018-07-12 16:58:43 +02002192
Steven Cooremanc8288352021-03-04 14:02:19 +01002193 /* Don't require hash implementations to behave correctly on a
2194 * zero-length input, which may have an invalid pointer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002195 if (input_length == 0) {
2196 return PSA_SUCCESS;
2197 }
Steven Cooremanc8288352021-03-04 14:02:19 +01002198
Gilles Peskine449bd832023-01-11 14:50:10 +01002199 status = psa_driver_wrapper_hash_update(operation, input, input_length);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002200
2201exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002202 if (status != PSA_SUCCESS) {
2203 psa_hash_abort(operation);
2204 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002205
Gilles Peskine449bd832023-01-11 14:50:10 +01002206 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002207}
2208
Gilles Peskine449bd832023-01-11 14:50:10 +01002209psa_status_t psa_hash_finish(psa_hash_operation_t *operation,
2210 uint8_t *hash,
2211 size_t hash_size,
2212 size_t *hash_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002213{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002214 *hash_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002215 if (operation->id == 0) {
2216 return PSA_ERROR_BAD_STATE;
2217 }
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002218
Steven Cooreman1e582352021-02-18 17:24:37 +01002219 psa_status_t status = psa_driver_wrapper_hash_finish(
Gilles Peskine449bd832023-01-11 14:50:10 +01002220 operation, hash, hash_size, hash_length);
2221 psa_hash_abort(operation);
2222 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002223}
2224
Gilles Peskine449bd832023-01-11 14:50:10 +01002225psa_status_t psa_hash_verify(psa_hash_operation_t *operation,
2226 const uint8_t *hash,
2227 size_t hash_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002228{
Ronald Cron69a63422021-10-18 09:47:58 +02002229 uint8_t actual_hash[PSA_HASH_MAX_SIZE];
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002230 size_t actual_hash_length;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002231 psa_status_t status = psa_hash_finish(
Gilles Peskine449bd832023-01-11 14:50:10 +01002232 operation,
2233 actual_hash, sizeof(actual_hash),
2234 &actual_hash_length);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002235
Gilles Peskine449bd832023-01-11 14:50:10 +01002236 if (status != PSA_SUCCESS) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002237 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002238 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002239
Gilles Peskine449bd832023-01-11 14:50:10 +01002240 if (actual_hash_length != hash_length) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002241 status = PSA_ERROR_INVALID_SIGNATURE;
2242 goto exit;
2243 }
2244
Dave Rodgman78701152023-08-29 14:20:18 +01002245 if (mbedtls_ct_memcmp(hash, actual_hash, actual_hash_length) != 0) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002246 status = PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01002247 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002248
2249exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002250 mbedtls_platform_zeroize(actual_hash, sizeof(actual_hash));
2251 if (status != PSA_SUCCESS) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002252 psa_hash_abort(operation);
Gilles Peskine449bd832023-01-11 14:50:10 +01002253 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002254
Gilles Peskine449bd832023-01-11 14:50:10 +01002255 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002256}
2257
Gilles Peskine449bd832023-01-11 14:50:10 +01002258psa_status_t psa_hash_compute(psa_algorithm_t alg,
2259 const uint8_t *input, size_t input_length,
2260 uint8_t *hash, size_t hash_size,
2261 size_t *hash_length)
Gilles Peskine0a749c82019-11-28 19:33:58 +01002262{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002263 *hash_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002264 if (!PSA_ALG_IS_HASH(alg)) {
2265 return PSA_ERROR_INVALID_ARGUMENT;
2266 }
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002267
Gilles Peskine449bd832023-01-11 14:50:10 +01002268 return psa_driver_wrapper_hash_compute(alg, input, input_length,
2269 hash, hash_size, hash_length);
Gilles Peskine0a749c82019-11-28 19:33:58 +01002270}
2271
Gilles Peskine449bd832023-01-11 14:50:10 +01002272psa_status_t psa_hash_compare(psa_algorithm_t alg,
2273 const uint8_t *input, size_t input_length,
2274 const uint8_t *hash, size_t hash_length)
Gilles Peskine0a749c82019-11-28 19:33:58 +01002275{
Ronald Cron69a63422021-10-18 09:47:58 +02002276 uint8_t actual_hash[PSA_HASH_MAX_SIZE];
Steven Cooreman84d670d2021-02-18 16:22:53 +01002277 size_t actual_hash_length;
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002278
Gilles Peskine449bd832023-01-11 14:50:10 +01002279 if (!PSA_ALG_IS_HASH(alg)) {
2280 return PSA_ERROR_INVALID_ARGUMENT;
2281 }
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002282
Steven Cooreman1e582352021-02-18 17:24:37 +01002283 psa_status_t status = psa_driver_wrapper_hash_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01002284 alg, input, input_length,
2285 actual_hash, sizeof(actual_hash),
2286 &actual_hash_length);
2287 if (status != PSA_SUCCESS) {
Gilles Peskine60aebec2021-12-13 12:33:18 +01002288 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002289 }
2290 if (actual_hash_length != hash_length) {
Gilles Peskine60aebec2021-12-13 12:33:18 +01002291 status = PSA_ERROR_INVALID_SIGNATURE;
2292 goto exit;
2293 }
Dave Rodgman78701152023-08-29 14:20:18 +01002294 if (mbedtls_ct_memcmp(hash, actual_hash, actual_hash_length) != 0) {
Gilles Peskine60aebec2021-12-13 12:33:18 +01002295 status = PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01002296 }
Gilles Peskine60aebec2021-12-13 12:33:18 +01002297
2298exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002299 mbedtls_platform_zeroize(actual_hash, sizeof(actual_hash));
2300 return status;
Gilles Peskine0a749c82019-11-28 19:33:58 +01002301}
2302
Gilles Peskine449bd832023-01-11 14:50:10 +01002303psa_status_t psa_hash_clone(const psa_hash_operation_t *source_operation,
2304 psa_hash_operation_t *target_operation)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002305{
Gilles Peskine449bd832023-01-11 14:50:10 +01002306 if (source_operation->id == 0 ||
2307 target_operation->id != 0) {
2308 return PSA_ERROR_BAD_STATE;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002309 }
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002310
Gilles Peskine449bd832023-01-11 14:50:10 +01002311 psa_status_t status = psa_driver_wrapper_hash_clone(source_operation,
2312 target_operation);
2313 if (status != PSA_SUCCESS) {
2314 psa_hash_abort(target_operation);
2315 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002316
Gilles Peskine449bd832023-01-11 14:50:10 +01002317 return status;
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002318}
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002319
2320
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002321/****************************************************************/
Gilles Peskine8c9def32018-02-08 10:02:12 +01002322/* MAC */
2323/****************************************************************/
2324
Gilles Peskine449bd832023-01-11 14:50:10 +01002325psa_status_t psa_mac_abort(psa_mac_operation_t *operation)
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002326{
Steven Cooremane6804192021-03-19 18:28:56 +01002327 /* Aborting a non-active operation is allowed */
Gilles Peskine449bd832023-01-11 14:50:10 +01002328 if (operation->id == 0) {
2329 return PSA_SUCCESS;
2330 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002331
Gilles Peskine449bd832023-01-11 14:50:10 +01002332 psa_status_t status = psa_driver_wrapper_mac_abort(operation);
Steven Cooreman72f736a2021-05-07 14:14:37 +02002333 operation->mac_size = 0;
2334 operation->is_sign = 0;
Steven Cooremane6804192021-03-19 18:28:56 +01002335 operation->id = 0;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002336
Gilles Peskine449bd832023-01-11 14:50:10 +01002337 return status;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002338}
2339
Ronald Cron2dff3b22021-06-17 16:33:22 +02002340static psa_status_t psa_mac_finalize_alg_and_key_validation(
2341 psa_algorithm_t alg,
Ronald Cron79bdd822021-06-17 16:46:44 +02002342 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01002343 uint8_t *mac_size)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002344{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002345 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002346 psa_key_type_t key_type = psa_get_key_type(attributes);
2347 size_t key_bits = psa_get_key_bits(attributes);
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002348
Gilles Peskine449bd832023-01-11 14:50:10 +01002349 if (!PSA_ALG_IS_MAC(alg)) {
2350 return PSA_ERROR_INVALID_ARGUMENT;
2351 }
Steven Cooremane6804192021-03-19 18:28:56 +01002352
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002353 /* Validate the combination of key type and algorithm */
Gilles Peskine449bd832023-01-11 14:50:10 +01002354 status = psa_mac_key_can_do(alg, key_type);
2355 if (status != PSA_SUCCESS) {
2356 return status;
2357 }
Steven Cooreman15472f82021-03-02 16:16:22 +01002358
Steven Cooremand1a68f12021-05-10 11:13:41 +02002359 /* Get the output length for the algorithm and key combination */
Gilles Peskine449bd832023-01-11 14:50:10 +01002360 *mac_size = PSA_MAC_LENGTH(key_type, key_bits, alg);
Steven Cooreman15472f82021-03-02 16:16:22 +01002361
Gilles Peskine449bd832023-01-11 14:50:10 +01002362 if (*mac_size < 4) {
Steven Cooreman15472f82021-03-02 16:16:22 +01002363 /* A very short MAC is too short for security since it can be
2364 * brute-forced. Ancient protocols with 32-bit MACs do exist,
2365 * so we make this our minimum, even though 32 bits is still
2366 * too small for security. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002367 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman15472f82021-03-02 16:16:22 +01002368 }
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02002369
Gilles Peskine449bd832023-01-11 14:50:10 +01002370 if (*mac_size > PSA_MAC_LENGTH(key_type, key_bits,
2371 PSA_ALG_FULL_LENGTH_MAC(alg))) {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002372 /* It's impossible to "truncate" to a larger length than the full length
2373 * of the algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002374 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002375 }
2376
Gilles Peskine449bd832023-01-11 14:50:10 +01002377 if (*mac_size > PSA_MAC_MAX_SIZE) {
Gilles Peskinea9b6c802022-03-16 13:54:49 +01002378 /* PSA_MAC_LENGTH returns the correct length even for a MAC algorithm
2379 * that is disabled in the compile-time configuration. The result can
2380 * therefore be larger than PSA_MAC_MAX_SIZE, which does take the
2381 * configuration into account. In this case, force a return of
2382 * PSA_ERROR_NOT_SUPPORTED here. Otherwise psa_mac_verify(), or
2383 * psa_mac_compute(mac_size=PSA_MAC_MAX_SIZE), would return
2384 * PSA_ERROR_BUFFER_TOO_SMALL for an unsupported algorithm whose MAC size
2385 * is larger than PSA_MAC_MAX_SIZE, which is misleading and which breaks
2386 * systematically generated tests. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002387 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea9b6c802022-03-16 13:54:49 +01002388 }
2389
Gilles Peskine449bd832023-01-11 14:50:10 +01002390 return PSA_SUCCESS;
Ronald Cron2dff3b22021-06-17 16:33:22 +02002391}
2392
Gilles Peskine449bd832023-01-11 14:50:10 +01002393static psa_status_t psa_mac_setup(psa_mac_operation_t *operation,
2394 mbedtls_svc_key_id_t key,
2395 psa_algorithm_t alg,
2396 int is_sign)
Gilles Peskinee59236f2018-01-27 23:32:46 +01002397{
2398 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2399 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman54648242021-06-24 11:49:45 +01002400 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002401 psa_key_attributes_t attributes;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002402
2403 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002404 if (operation->id != 0) {
Dave Rodgman54648242021-06-24 11:49:45 +01002405 status = PSA_ERROR_BAD_STATE;
2406 goto exit;
2407 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002408
2409 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002410 key,
2411 &slot,
2412 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
2413 alg);
2414 if (status != PSA_SUCCESS) {
Dave Rodgman54648242021-06-24 11:49:45 +01002415 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002416 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002417
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002418 attributes = (psa_key_attributes_t) {
Gilles Peskine8c9def32018-02-08 10:02:12 +01002419 .core = slot->attr
2420 };
2421
Gilles Peskine449bd832023-01-11 14:50:10 +01002422 status = psa_mac_finalize_alg_and_key_validation(alg, &attributes,
2423 &operation->mac_size);
2424 if (status != PSA_SUCCESS) {
Gilles Peskine8c9def32018-02-08 10:02:12 +01002425 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002426 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002427
2428 operation->is_sign = is_sign;
Steven Cooremane6804192021-03-19 18:28:56 +01002429 /* Dispatch the MAC setup call with validated input */
Gilles Peskine449bd832023-01-11 14:50:10 +01002430 if (is_sign) {
2431 status = psa_driver_wrapper_mac_sign_setup(operation,
2432 &attributes,
2433 slot->key.data,
2434 slot->key.bytes,
2435 alg);
2436 } else {
2437 status = psa_driver_wrapper_mac_verify_setup(operation,
2438 &attributes,
2439 slot->key.data,
2440 slot->key.bytes,
2441 alg);
Gilles Peskine8c9def32018-02-08 10:02:12 +01002442 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002443
Gilles Peskinefbfac682018-07-08 20:51:54 +02002444exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002445 if (status != PSA_SUCCESS) {
2446 psa_mac_abort(operation);
2447 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002448
Gilles Peskine449bd832023-01-11 14:50:10 +01002449 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02002450
Gilles Peskine449bd832023-01-11 14:50:10 +01002451 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002452}
2453
Gilles Peskine449bd832023-01-11 14:50:10 +01002454psa_status_t psa_mac_sign_setup(psa_mac_operation_t *operation,
2455 mbedtls_svc_key_id_t key,
2456 psa_algorithm_t alg)
Gilles Peskine89167cb2018-07-08 20:12:23 +02002457{
Gilles Peskine449bd832023-01-11 14:50:10 +01002458 return psa_mac_setup(operation, key, alg, 1);
Gilles Peskine89167cb2018-07-08 20:12:23 +02002459}
2460
Gilles Peskine449bd832023-01-11 14:50:10 +01002461psa_status_t psa_mac_verify_setup(psa_mac_operation_t *operation,
2462 mbedtls_svc_key_id_t key,
2463 psa_algorithm_t alg)
Gilles Peskine89167cb2018-07-08 20:12:23 +02002464{
Gilles Peskine449bd832023-01-11 14:50:10 +01002465 return psa_mac_setup(operation, key, alg, 0);
Gilles Peskine89167cb2018-07-08 20:12:23 +02002466}
2467
Gilles Peskine449bd832023-01-11 14:50:10 +01002468psa_status_t psa_mac_update(psa_mac_operation_t *operation,
2469 const uint8_t *input,
2470 size_t input_length)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002471{
Gilles Peskine449bd832023-01-11 14:50:10 +01002472 if (operation->id == 0) {
2473 return PSA_ERROR_BAD_STATE;
2474 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002475
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002476 /* Don't require hash implementations to behave correctly on a
2477 * zero-length input, which may have an invalid pointer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002478 if (input_length == 0) {
2479 return PSA_SUCCESS;
2480 }
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03002481
Gilles Peskine449bd832023-01-11 14:50:10 +01002482 psa_status_t status = psa_driver_wrapper_mac_update(operation,
2483 input, input_length);
2484 if (status != PSA_SUCCESS) {
2485 psa_mac_abort(operation);
2486 }
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002487
Gilles Peskine449bd832023-01-11 14:50:10 +01002488 return status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002489}
2490
Gilles Peskine449bd832023-01-11 14:50:10 +01002491psa_status_t psa_mac_sign_finish(psa_mac_operation_t *operation,
2492 uint8_t *mac,
2493 size_t mac_size,
2494 size_t *mac_length)
mohammad16036df908f2018-04-02 08:34:15 -07002495{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002496 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2497 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002498
Gilles Peskine449bd832023-01-11 14:50:10 +01002499 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002500 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002501 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002502 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002503
Gilles Peskine449bd832023-01-11 14:50:10 +01002504 if (!operation->is_sign) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002505 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002506 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002507 }
Steven Cooreman72f736a2021-05-07 14:14:37 +02002508
Steven Cooreman8af5c5c2021-05-11 11:09:13 +02002509 /* Sanity check. This will guarantee that mac_size != 0 (and so mac != NULL)
2510 * once all the error checks are done. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002511 if (operation->mac_size == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002512 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002513 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002514 }
Steven Cooreman8af5c5c2021-05-11 11:09:13 +02002515
Gilles Peskine449bd832023-01-11 14:50:10 +01002516 if (mac_size < operation->mac_size) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002517 status = PSA_ERROR_BUFFER_TOO_SMALL;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002518 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002519 }
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002520
Gilles Peskine449bd832023-01-11 14:50:10 +01002521 status = psa_driver_wrapper_mac_sign_finish(operation,
2522 mac, operation->mac_size,
2523 mac_length);
Steven Cooreman72f736a2021-05-07 14:14:37 +02002524
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002525exit:
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002526 /* In case of success, set the potential excess room in the output buffer
2527 * to an invalid value, to avoid potentially leaking a longer MAC.
2528 * In case of error, set the output length and content to a safe default,
2529 * such that in case the caller misses an error check, the output would be
2530 * an unachievable MAC.
2531 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002532 if (status != PSA_SUCCESS) {
Steven Cooreman72f736a2021-05-07 14:14:37 +02002533 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002534 operation->mac_size = 0;
Steven Cooreman72f736a2021-05-07 14:14:37 +02002535 }
mohammad16036df908f2018-04-02 08:34:15 -07002536
Paul Elliottdc42ca82023-02-24 18:11:59 +00002537 psa_wipe_tag_output_buffer(mac, status, mac_size, *mac_length);
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002538
Gilles Peskine449bd832023-01-11 14:50:10 +01002539 abort_status = psa_mac_abort(operation);
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002540
Gilles Peskine449bd832023-01-11 14:50:10 +01002541 return status == PSA_SUCCESS ? abort_status : status;
mohammad16036df908f2018-04-02 08:34:15 -07002542}
2543
Gilles Peskine449bd832023-01-11 14:50:10 +01002544psa_status_t psa_mac_verify_finish(psa_mac_operation_t *operation,
2545 const uint8_t *mac,
2546 size_t mac_length)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002547{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002548 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2549 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002550
Gilles Peskine449bd832023-01-11 14:50:10 +01002551 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002552 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002553 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002554 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002555
Gilles Peskine449bd832023-01-11 14:50:10 +01002556 if (operation->is_sign) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002557 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002558 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002559 }
Steven Cooreman72f736a2021-05-07 14:14:37 +02002560
Gilles Peskine449bd832023-01-11 14:50:10 +01002561 if (operation->mac_size != mac_length) {
Steven Cooreman72f736a2021-05-07 14:14:37 +02002562 status = PSA_ERROR_INVALID_SIGNATURE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002563 goto exit;
Steven Cooreman72f736a2021-05-07 14:14:37 +02002564 }
2565
Gilles Peskine449bd832023-01-11 14:50:10 +01002566 status = psa_driver_wrapper_mac_verify_finish(operation,
2567 mac, mac_length);
Steven Cooreman72f736a2021-05-07 14:14:37 +02002568
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002569exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002570 abort_status = psa_mac_abort(operation);
mohammad16036df908f2018-04-02 08:34:15 -07002571
Gilles Peskine449bd832023-01-11 14:50:10 +01002572 return status == PSA_SUCCESS ? abort_status : status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002573}
2574
Gilles Peskine449bd832023-01-11 14:50:10 +01002575static psa_status_t psa_mac_compute_internal(mbedtls_svc_key_id_t key,
2576 psa_algorithm_t alg,
2577 const uint8_t *input,
2578 size_t input_length,
2579 uint8_t *mac,
2580 size_t mac_size,
2581 size_t *mac_length,
2582 int is_sign)
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002583{
2584 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron51131b52021-06-17 17:17:20 +02002585 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2586 psa_key_slot_t *slot;
2587 uint8_t operation_mac_size = 0;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002588 psa_key_attributes_t attributes;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002589
Ronald Cron51131b52021-06-17 17:17:20 +02002590 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002591 key,
2592 &slot,
2593 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
2594 alg);
2595 if (status != PSA_SUCCESS) {
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002596 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002597 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002598
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002599 attributes = (psa_key_attributes_t) {
Ronald Cron51131b52021-06-17 17:17:20 +02002600 .core = slot->attr
2601 };
2602
Gilles Peskine449bd832023-01-11 14:50:10 +01002603 status = psa_mac_finalize_alg_and_key_validation(alg, &attributes,
2604 &operation_mac_size);
2605 if (status != PSA_SUCCESS) {
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002606 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002607 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002608
Gilles Peskine449bd832023-01-11 14:50:10 +01002609 if (mac_size < operation_mac_size) {
Ronald Cron51131b52021-06-17 17:17:20 +02002610 status = PSA_ERROR_BUFFER_TOO_SMALL;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002611 goto exit;
Ronald Cron51131b52021-06-17 17:17:20 +02002612 }
2613
2614 status = psa_driver_wrapper_mac_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01002615 &attributes,
2616 slot->key.data, slot->key.bytes,
2617 alg,
2618 input, input_length,
2619 mac, operation_mac_size, mac_length);
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002620
2621exit:
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002622 /* In case of success, set the potential excess room in the output buffer
2623 * to an invalid value, to avoid potentially leaking a longer MAC.
2624 * In case of error, set the output length and content to a safe default,
2625 * such that in case the caller misses an error check, the output would be
2626 * an unachievable MAC.
2627 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002628 if (status != PSA_SUCCESS) {
Ronald Cron51131b52021-06-17 17:17:20 +02002629 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002630 operation_mac_size = 0;
Ronald Cron51131b52021-06-17 17:17:20 +02002631 }
Paul Elliottdc42ca82023-02-24 18:11:59 +00002632
2633 psa_wipe_tag_output_buffer(mac, status, mac_size, *mac_length);
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002634
Gilles Peskine449bd832023-01-11 14:50:10 +01002635 unlock_status = psa_unlock_key_slot(slot);
Ronald Cron51131b52021-06-17 17:17:20 +02002636
Gilles Peskine449bd832023-01-11 14:50:10 +01002637 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002638}
2639
Gilles Peskine449bd832023-01-11 14:50:10 +01002640psa_status_t psa_mac_compute(mbedtls_svc_key_id_t key,
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002641 psa_algorithm_t alg,
2642 const uint8_t *input,
2643 size_t input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002644 uint8_t *mac,
2645 size_t mac_size,
2646 size_t *mac_length)
2647{
2648 return psa_mac_compute_internal(key, alg,
2649 input, input_length,
2650 mac, mac_size, mac_length, 1);
2651}
2652
2653psa_status_t psa_mac_verify(mbedtls_svc_key_id_t key,
2654 psa_algorithm_t alg,
2655 const uint8_t *input,
2656 size_t input_length,
2657 const uint8_t *mac,
2658 size_t mac_length)
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002659{
2660 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Crona587cbc2021-06-18 14:51:29 +02002661 uint8_t actual_mac[PSA_MAC_MAX_SIZE];
2662 size_t actual_mac_length;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002663
Gilles Peskine449bd832023-01-11 14:50:10 +01002664 status = psa_mac_compute_internal(key, alg,
2665 input, input_length,
2666 actual_mac, sizeof(actual_mac),
2667 &actual_mac_length, 0);
2668 if (status != PSA_SUCCESS) {
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002669 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002670 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002671
Gilles Peskine449bd832023-01-11 14:50:10 +01002672 if (mac_length != actual_mac_length) {
Ronald Crona587cbc2021-06-18 14:51:29 +02002673 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002674 goto exit;
Ronald Crona587cbc2021-06-18 14:51:29 +02002675 }
Dave Rodgman78701152023-08-29 14:20:18 +01002676 if (mbedtls_ct_memcmp(mac, actual_mac, actual_mac_length) != 0) {
Ronald Crona587cbc2021-06-18 14:51:29 +02002677 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002678 goto exit;
Ronald Crona587cbc2021-06-18 14:51:29 +02002679 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002680
2681exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002682 mbedtls_platform_zeroize(actual_mac, sizeof(actual_mac));
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002683
Gilles Peskine449bd832023-01-11 14:50:10 +01002684 return status;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002685}
Gilles Peskinee59236f2018-01-27 23:32:46 +01002686
Gilles Peskinee59236f2018-01-27 23:32:46 +01002687/****************************************************************/
2688/* Asymmetric cryptography */
2689/****************************************************************/
2690
Gilles Peskine449bd832023-01-11 14:50:10 +01002691static psa_status_t psa_sign_verify_check_alg(int input_is_message,
2692 psa_algorithm_t alg)
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002693{
Gilles Peskine449bd832023-01-11 14:50:10 +01002694 if (input_is_message) {
2695 if (!PSA_ALG_IS_SIGN_MESSAGE(alg)) {
2696 return PSA_ERROR_INVALID_ARGUMENT;
2697 }
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002698
Gilles Peskine449bd832023-01-11 14:50:10 +01002699 if (PSA_ALG_IS_SIGN_HASH(alg)) {
2700 if (!PSA_ALG_IS_HASH(PSA_ALG_SIGN_GET_HASH(alg))) {
2701 return PSA_ERROR_INVALID_ARGUMENT;
2702 }
2703 }
2704 } else {
2705 if (!PSA_ALG_IS_SIGN_HASH(alg)) {
2706 return PSA_ERROR_INVALID_ARGUMENT;
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002707 }
2708 }
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002709
Gilles Peskine449bd832023-01-11 14:50:10 +01002710 return PSA_SUCCESS;
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002711}
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002712
Gilles Peskine449bd832023-01-11 14:50:10 +01002713static psa_status_t psa_sign_internal(mbedtls_svc_key_id_t key,
2714 int input_is_message,
2715 psa_algorithm_t alg,
2716 const uint8_t *input,
2717 size_t input_length,
2718 uint8_t *signature,
2719 size_t signature_size,
2720 size_t *signature_length)
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002721{
2722 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2723 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2724 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002725 psa_key_attributes_t attributes;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002726
2727 *signature_length = 0;
2728
Gilles Peskine449bd832023-01-11 14:50:10 +01002729 status = psa_sign_verify_check_alg(input_is_message, alg);
2730 if (status != PSA_SUCCESS) {
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002731 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002732 }
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002733
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002734 /* Immediately reject a zero-length signature buffer. This guarantees
gabor-mezei-arm12b4f342021-05-05 13:54:55 +02002735 * that signature must be a valid pointer. (On the other hand, the input
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002736 * buffer can in principle be empty since it doesn't actually have
2737 * to be a hash.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01002738 if (signature_size == 0) {
2739 return PSA_ERROR_BUFFER_TOO_SMALL;
2740 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002741
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002742 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002743 key, &slot,
2744 input_is_message ? PSA_KEY_USAGE_SIGN_MESSAGE :
2745 PSA_KEY_USAGE_SIGN_HASH,
2746 alg);
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002747
Gilles Peskine449bd832023-01-11 14:50:10 +01002748 if (status != PSA_SUCCESS) {
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002749 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002750 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002751
Gilles Peskine449bd832023-01-11 14:50:10 +01002752 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002753 status = PSA_ERROR_INVALID_ARGUMENT;
2754 goto exit;
2755 }
2756
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002757 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01002758 .core = slot->attr
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002759 };
2760
Gilles Peskine449bd832023-01-11 14:50:10 +01002761 if (input_is_message) {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002762 status = psa_driver_wrapper_sign_message(
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002763 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002764 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002765 signature, signature_size, signature_length);
2766 } else {
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002767
2768 status = psa_driver_wrapper_sign_hash(
2769 &attributes, slot->key.data, slot->key.bytes,
2770 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002771 signature, signature_size, signature_length);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002772 }
2773
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002774
2775exit:
Paul Elliott59200a22023-02-21 15:07:40 +00002776 psa_wipe_tag_output_buffer(signature, status, signature_size,
2777 *signature_length);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002778
Gilles Peskine449bd832023-01-11 14:50:10 +01002779 unlock_status = psa_unlock_key_slot(slot);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002780
Gilles Peskine449bd832023-01-11 14:50:10 +01002781 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002782}
2783
Gilles Peskine449bd832023-01-11 14:50:10 +01002784static psa_status_t psa_verify_internal(mbedtls_svc_key_id_t key,
2785 int input_is_message,
2786 psa_algorithm_t alg,
2787 const uint8_t *input,
2788 size_t input_length,
2789 const uint8_t *signature,
2790 size_t signature_length)
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002791{
2792 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2793 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2794 psa_key_slot_t *slot;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002795
Gilles Peskine449bd832023-01-11 14:50:10 +01002796 status = psa_sign_verify_check_alg(input_is_message, alg);
2797 if (status != PSA_SUCCESS) {
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002798 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002799 }
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002800
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002801 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002802 key, &slot,
2803 input_is_message ? PSA_KEY_USAGE_VERIFY_MESSAGE :
2804 PSA_KEY_USAGE_VERIFY_HASH,
2805 alg);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002806
Gilles Peskine449bd832023-01-11 14:50:10 +01002807 if (status != PSA_SUCCESS) {
2808 return status;
2809 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002810
2811 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01002812 .core = slot->attr
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002813 };
2814
Gilles Peskine449bd832023-01-11 14:50:10 +01002815 if (input_is_message) {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002816 status = psa_driver_wrapper_verify_message(
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002817 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002818 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002819 signature, signature_length);
2820 } else {
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002821 status = psa_driver_wrapper_verify_hash(
2822 &attributes, slot->key.data, slot->key.bytes,
2823 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002824 signature, signature_length);
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002825 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002826
Gilles Peskine449bd832023-01-11 14:50:10 +01002827 unlock_status = psa_unlock_key_slot(slot);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002828
Gilles Peskine449bd832023-01-11 14:50:10 +01002829 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002830
2831}
2832
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002833psa_status_t psa_sign_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002834 const psa_key_attributes_t *attributes,
2835 const uint8_t *key_buffer,
2836 size_t key_buffer_size,
2837 psa_algorithm_t alg,
2838 const uint8_t *input,
2839 size_t input_length,
2840 uint8_t *signature,
2841 size_t signature_size,
Gilles Peskine449bd832023-01-11 14:50:10 +01002842 size_t *signature_length)
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002843{
2844 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002845
Gilles Peskine449bd832023-01-11 14:50:10 +01002846 if (PSA_ALG_IS_SIGN_HASH(alg)) {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002847 size_t hash_length;
2848 uint8_t hash[PSA_HASH_MAX_SIZE];
2849
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002850 status = psa_driver_wrapper_hash_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01002851 PSA_ALG_SIGN_GET_HASH(alg),
2852 input, input_length,
2853 hash, sizeof(hash), &hash_length);
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002854
Gilles Peskine449bd832023-01-11 14:50:10 +01002855 if (status != PSA_SUCCESS) {
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002856 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002857 }
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002858
2859 return psa_driver_wrapper_sign_hash(
Gilles Peskine449bd832023-01-11 14:50:10 +01002860 attributes, key_buffer, key_buffer_size,
2861 alg, hash, hash_length,
2862 signature, signature_size, signature_length);
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002863 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002864
Gilles Peskine449bd832023-01-11 14:50:10 +01002865 return PSA_ERROR_NOT_SUPPORTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002866}
2867
Gilles Peskine449bd832023-01-11 14:50:10 +01002868psa_status_t psa_sign_message(mbedtls_svc_key_id_t key,
2869 psa_algorithm_t alg,
2870 const uint8_t *input,
2871 size_t input_length,
2872 uint8_t *signature,
2873 size_t signature_size,
2874 size_t *signature_length)
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002875{
2876 return psa_sign_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002877 key, 1, alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002878 signature, signature_size, signature_length);
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002879}
2880
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002881psa_status_t psa_verify_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002882 const psa_key_attributes_t *attributes,
2883 const uint8_t *key_buffer,
2884 size_t key_buffer_size,
2885 psa_algorithm_t alg,
2886 const uint8_t *input,
2887 size_t input_length,
2888 const uint8_t *signature,
Gilles Peskine449bd832023-01-11 14:50:10 +01002889 size_t signature_length)
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002890{
2891 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002892
Gilles Peskine449bd832023-01-11 14:50:10 +01002893 if (PSA_ALG_IS_SIGN_HASH(alg)) {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002894 size_t hash_length;
2895 uint8_t hash[PSA_HASH_MAX_SIZE];
2896
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002897 status = psa_driver_wrapper_hash_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01002898 PSA_ALG_SIGN_GET_HASH(alg),
2899 input, input_length,
2900 hash, sizeof(hash), &hash_length);
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002901
Gilles Peskine449bd832023-01-11 14:50:10 +01002902 if (status != PSA_SUCCESS) {
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002903 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002904 }
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002905
2906 return psa_driver_wrapper_verify_hash(
Gilles Peskine449bd832023-01-11 14:50:10 +01002907 attributes, key_buffer, key_buffer_size,
2908 alg, hash, hash_length,
2909 signature, signature_length);
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002910 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002911
Gilles Peskine449bd832023-01-11 14:50:10 +01002912 return PSA_ERROR_NOT_SUPPORTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002913}
2914
Gilles Peskine449bd832023-01-11 14:50:10 +01002915psa_status_t psa_verify_message(mbedtls_svc_key_id_t key,
2916 psa_algorithm_t alg,
2917 const uint8_t *input,
2918 size_t input_length,
2919 const uint8_t *signature,
2920 size_t signature_length)
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002921{
2922 return psa_verify_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002923 key, 1, alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002924 signature, signature_length);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002925}
2926
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002927psa_status_t psa_sign_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01002928 const psa_key_attributes_t *attributes,
2929 const uint8_t *key_buffer, size_t key_buffer_size,
2930 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002931 uint8_t *signature, size_t signature_size, size_t *signature_length)
Gilles Peskinee59236f2018-01-27 23:32:46 +01002932{
Gilles Peskine449bd832023-01-11 14:50:10 +01002933 if (attributes->core.type == PSA_KEY_TYPE_RSA_KEY_PAIR) {
2934 if (PSA_ALG_IS_RSA_PKCS1V15_SIGN(alg) ||
2935 PSA_ALG_IS_RSA_PSS(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01002936#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01002937 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
2938 return mbedtls_psa_rsa_sign_hash(
2939 attributes,
2940 key_buffer, key_buffer_size,
2941 alg, hash, hash_length,
2942 signature, signature_size, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01002943#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
2944 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine449bd832023-01-11 14:50:10 +01002945 } else {
2946 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanacda8342020-07-24 23:09:52 +02002947 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002948 } else if (PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
2949 if (PSA_ALG_IS_ECDSA(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01002950#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01002951 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
2952 return mbedtls_psa_ecdsa_sign_hash(
2953 attributes,
2954 key_buffer, key_buffer_size,
2955 alg, hash, hash_length,
2956 signature, signature_size, signature_length);
Gilles Peskinee59236f2018-01-27 23:32:46 +01002957#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
2958 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskine449bd832023-01-11 14:50:10 +01002959 } else {
2960 return PSA_ERROR_INVALID_ARGUMENT;
Ronald Cron4501c982021-03-19 20:09:32 +01002961 }
Ronald Cron8a494f32021-02-17 09:49:51 +01002962 }
Ronald Cron4501c982021-03-19 20:09:32 +01002963
Gilles Peskine449bd832023-01-11 14:50:10 +01002964 (void) key_buffer;
2965 (void) key_buffer_size;
2966 (void) hash;
2967 (void) hash_length;
2968 (void) signature;
2969 (void) signature_size;
2970 (void) signature_length;
Ronald Cron4501c982021-03-19 20:09:32 +01002971
Gilles Peskine449bd832023-01-11 14:50:10 +01002972 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron18659932020-12-08 16:32:23 +01002973}
Gilles Peskinee59236f2018-01-27 23:32:46 +01002974
Gilles Peskine449bd832023-01-11 14:50:10 +01002975psa_status_t psa_sign_hash(mbedtls_svc_key_id_t key,
2976 psa_algorithm_t alg,
2977 const uint8_t *hash,
2978 size_t hash_length,
2979 uint8_t *signature,
2980 size_t signature_size,
2981 size_t *signature_length)
Gilles Peskinee59236f2018-01-27 23:32:46 +01002982{
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002983 return psa_sign_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002984 key, 0, alg, hash, hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002985 signature, signature_size, signature_length);
itayzafrir5c753392018-05-08 11:18:38 +03002986}
2987
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002988psa_status_t psa_verify_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01002989 const psa_key_attributes_t *attributes,
2990 const uint8_t *key_buffer, size_t key_buffer_size,
2991 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002992 const uint8_t *signature, size_t signature_length)
itayzafrir5c753392018-05-08 11:18:38 +03002993{
Gilles Peskine449bd832023-01-11 14:50:10 +01002994 if (PSA_KEY_TYPE_IS_RSA(attributes->core.type)) {
2995 if (PSA_ALG_IS_RSA_PKCS1V15_SIGN(alg) ||
2996 PSA_ALG_IS_RSA_PSS(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01002997#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01002998 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
2999 return mbedtls_psa_rsa_verify_hash(
3000 attributes,
3001 key_buffer, key_buffer_size,
3002 alg, hash, hash_length,
3003 signature, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01003004#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
3005 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003006 } else {
3007 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanacda8342020-07-24 23:09:52 +02003008 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003009 } else if (PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3010 if (PSA_ALG_IS_ECDSA(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003011#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003012 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3013 return mbedtls_psa_ecdsa_verify_hash(
3014 attributes,
3015 key_buffer, key_buffer_size,
3016 alg, hash, hash_length,
3017 signature, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01003018#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3019 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003020 } else {
3021 return PSA_ERROR_INVALID_ARGUMENT;
Ronald Cron4501c982021-03-19 20:09:32 +01003022 }
Ronald Cron8a494f32021-02-17 09:49:51 +01003023 }
Ronald Cron4501c982021-03-19 20:09:32 +01003024
Gilles Peskine449bd832023-01-11 14:50:10 +01003025 (void) key_buffer;
3026 (void) key_buffer_size;
3027 (void) hash;
3028 (void) hash_length;
3029 (void) signature;
3030 (void) signature_length;
Ronald Cron4501c982021-03-19 20:09:32 +01003031
Gilles Peskine449bd832023-01-11 14:50:10 +01003032 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron18659932020-12-08 16:32:23 +01003033}
3034
Gilles Peskine449bd832023-01-11 14:50:10 +01003035psa_status_t psa_verify_hash(mbedtls_svc_key_id_t key,
3036 psa_algorithm_t alg,
3037 const uint8_t *hash,
3038 size_t hash_length,
3039 const uint8_t *signature,
3040 size_t signature_length)
itayzafrir5c753392018-05-08 11:18:38 +03003041{
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003042 return psa_verify_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02003043 key, 0, alg, hash, hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003044 signature, signature_length);
Gilles Peskinee59236f2018-01-27 23:32:46 +01003045}
3046
Gilles Peskine449bd832023-01-11 14:50:10 +01003047psa_status_t psa_asymmetric_encrypt(mbedtls_svc_key_id_t key,
3048 psa_algorithm_t alg,
3049 const uint8_t *input,
3050 size_t input_length,
3051 const uint8_t *salt,
3052 size_t salt_length,
3053 uint8_t *output,
3054 size_t output_size,
3055 size_t *output_length)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003056{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003057 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003058 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003059 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003060 psa_key_attributes_t attributes;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003061
Darryl Green5cc689a2018-07-24 15:34:10 +01003062 (void) input;
3063 (void) input_length;
3064 (void) salt;
3065 (void) output;
3066 (void) output_size;
3067
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003068 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003069
Gilles Peskine449bd832023-01-11 14:50:10 +01003070 if (!PSA_ALG_IS_RSA_OAEP(alg) && salt_length != 0) {
3071 return PSA_ERROR_INVALID_ARGUMENT;
3072 }
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003073
Ronald Cron5c522922020-11-14 16:35:34 +01003074 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01003075 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg);
3076 if (status != PSA_SUCCESS) {
3077 return status;
3078 }
3079 if (!(PSA_KEY_TYPE_IS_PUBLIC_KEY(slot->attr.type) ||
3080 PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type))) {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003081 status = PSA_ERROR_INVALID_ARGUMENT;
3082 goto exit;
3083 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003084
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003085 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01003086 .core = slot->attr
Przemyslaw Stekiel19e61422021-12-09 11:09:11 +01003087 };
Steven Cooremana2371e52020-07-28 14:30:39 +02003088
Przemyslaw Stekiel19e61422021-12-09 11:09:11 +01003089 status = psa_driver_wrapper_asymmetric_encrypt(
3090 &attributes, slot->key.data, slot->key.bytes,
3091 alg, input, input_length, salt, salt_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003092 output, output_size, output_length);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003093exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01003094 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003095
Gilles Peskine449bd832023-01-11 14:50:10 +01003096 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003097}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003098
Gilles Peskine449bd832023-01-11 14:50:10 +01003099psa_status_t psa_asymmetric_decrypt(mbedtls_svc_key_id_t key,
3100 psa_algorithm_t alg,
3101 const uint8_t *input,
3102 size_t input_length,
3103 const uint8_t *salt,
3104 size_t salt_length,
3105 uint8_t *output,
3106 size_t output_size,
3107 size_t *output_length)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003108{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003109 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003110 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003111 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003112 psa_key_attributes_t attributes;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003113
Darryl Green5cc689a2018-07-24 15:34:10 +01003114 (void) input;
3115 (void) input_length;
3116 (void) salt;
3117 (void) output;
3118 (void) output_size;
3119
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003120 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003121
Gilles Peskine449bd832023-01-11 14:50:10 +01003122 if (!PSA_ALG_IS_RSA_OAEP(alg) && salt_length != 0) {
3123 return PSA_ERROR_INVALID_ARGUMENT;
3124 }
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003125
Ronald Cron5c522922020-11-14 16:35:34 +01003126 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01003127 key, &slot, PSA_KEY_USAGE_DECRYPT, alg);
3128 if (status != PSA_SUCCESS) {
3129 return status;
3130 }
3131 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003132 status = PSA_ERROR_INVALID_ARGUMENT;
3133 goto exit;
3134 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003135
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003136 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01003137 .core = slot->attr
Przemyslaw Stekiel8d45c002021-12-13 08:58:19 +01003138 };
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003139
Przemyslaw Stekiel8d45c002021-12-13 08:58:19 +01003140 status = psa_driver_wrapper_asymmetric_decrypt(
3141 &attributes, slot->key.data, slot->key.bytes,
3142 alg, input, input_length, salt, salt_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003143 output, output_size, output_length);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003144
3145exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01003146 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003147
Gilles Peskine449bd832023-01-11 14:50:10 +01003148 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003149}
Gilles Peskinee59236f2018-01-27 23:32:46 +01003150
Paul Elliott9fe12f62022-11-30 19:16:02 +00003151/****************************************************************/
3152/* Asymmetric interruptible cryptography */
3153/****************************************************************/
3154
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003155static uint32_t psa_interruptible_max_ops = PSA_INTERRUPTIBLE_MAX_OPS_UNLIMITED;
3156
Paul Elliott9fe12f62022-11-30 19:16:02 +00003157void psa_interruptible_set_max_ops(uint32_t max_ops)
3158{
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003159 psa_interruptible_max_ops = max_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003160}
3161
3162uint32_t psa_interruptible_get_max_ops(void)
3163{
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003164 return psa_interruptible_max_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003165}
3166
Paul Elliott9fe12f62022-11-30 19:16:02 +00003167uint32_t psa_sign_hash_get_num_ops(
3168 const psa_sign_hash_interruptible_operation_t *operation)
3169{
Paul Elliott296ede92022-12-15 17:00:30 +00003170 return operation->num_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003171}
3172
3173uint32_t psa_verify_hash_get_num_ops(
3174 const psa_verify_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
Paul Elliott59ad9452022-12-18 15:09:02 +00003179static psa_status_t psa_sign_hash_abort_internal(
3180 psa_sign_hash_interruptible_operation_t *operation)
3181{
3182 if (operation->id == 0) {
3183 /* The object has (apparently) been initialized but it is not (yet)
3184 * in use. It's ok to call abort on such an object, and there's
3185 * nothing to do. */
3186 return PSA_SUCCESS;
3187 }
3188
3189 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3190
3191 status = psa_driver_wrapper_sign_hash_abort(operation);
3192
3193 operation->id = 0;
3194
Paul Elliotte6145dc2023-02-07 12:51:21 +00003195 /* Do not clear either the error_occurred or num_ops elements here as they
3196 * only want to be cleared by the application calling abort, not by abort
3197 * being called at completion of an operation. */
3198
Paul Elliott59ad9452022-12-18 15:09:02 +00003199 return status;
3200}
3201
Paul Elliott9fe12f62022-11-30 19:16:02 +00003202psa_status_t psa_sign_hash_start(
3203 psa_sign_hash_interruptible_operation_t *operation,
3204 mbedtls_svc_key_id_t key, psa_algorithm_t alg,
3205 const uint8_t *hash, size_t hash_length)
3206{
3207 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3208 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3209 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003210 psa_key_attributes_t attributes;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003211
Paul Elliottc9774412023-02-06 15:14:07 +00003212 /* Check that start has not been previously called, or operation has not
3213 * previously errored. */
3214 if (operation->id != 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003215 return PSA_ERROR_BAD_STATE;
3216 }
3217
Paul Elliott9fe12f62022-11-30 19:16:02 +00003218 status = psa_sign_verify_check_alg(0, alg);
3219 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003220 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003221 return status;
3222 }
3223
3224 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
3225 PSA_KEY_USAGE_SIGN_HASH,
3226 alg);
3227
3228 if (status != PSA_SUCCESS) {
3229 goto exit;
3230 }
3231
3232 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
3233 status = PSA_ERROR_INVALID_ARGUMENT;
3234 goto exit;
3235 }
3236
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003237 attributes = (psa_key_attributes_t) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003238 .core = slot->attr
3239 };
3240
Paul Elliott296ede92022-12-15 17:00:30 +00003241 /* Ensure ops count gets reset, in case of operation re-use. */
3242 operation->num_ops = 0;
3243
Paul Elliott9fe12f62022-11-30 19:16:02 +00003244 status = psa_driver_wrapper_sign_hash_start(operation, &attributes,
3245 slot->key.data,
3246 slot->key.bytes, alg,
3247 hash, hash_length);
3248exit:
3249
3250 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003251 operation->error_occurred = 1;
Paul Elliott59ad9452022-12-18 15:09:02 +00003252 psa_sign_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003253 }
3254
3255 unlock_status = psa_unlock_key_slot(slot);
3256
Paul Elliottc9774412023-02-06 15:14:07 +00003257 if (unlock_status != PSA_SUCCESS) {
3258 operation->error_occurred = 1;
3259 }
Paul Elliott9fe12f62022-11-30 19:16:02 +00003260
Paul Elliottc9774412023-02-06 15:14:07 +00003261 return (status == PSA_SUCCESS) ? unlock_status : status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003262}
3263
3264
3265psa_status_t psa_sign_hash_complete(
3266 psa_sign_hash_interruptible_operation_t *operation,
3267 uint8_t *signature, size_t signature_size,
3268 size_t *signature_length)
3269{
3270 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3271
3272 *signature_length = 0;
3273
Paul Elliottc9774412023-02-06 15:14:07 +00003274 /* Check that start has been called first, and that operation has not
3275 * previously errored. */
3276 if (operation->id == 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003277 status = PSA_ERROR_BAD_STATE;
3278 goto exit;
3279 }
3280
Paul Elliott096abc42023-02-03 18:33:23 +00003281 /* Immediately reject a zero-length signature buffer. This guarantees that
3282 * signature must be a valid pointer. */
Paul Elliott9fe12f62022-11-30 19:16:02 +00003283 if (signature_size == 0) {
3284 status = PSA_ERROR_BUFFER_TOO_SMALL;
3285 goto exit;
3286 }
3287
3288 status = psa_driver_wrapper_sign_hash_complete(operation, signature,
3289 signature_size,
3290 signature_length);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003291
Paul Elliott296ede92022-12-15 17:00:30 +00003292 /* Update ops count with work done. */
Paul Elliottde1114c2023-02-07 12:43:11 +00003293 operation->num_ops = psa_driver_wrapper_sign_hash_get_num_ops(operation);
Paul Elliott296ede92022-12-15 17:00:30 +00003294
Paul Elliottebe225c2023-02-10 14:32:53 +00003295exit:
3296
Paul Elliott59200a22023-02-21 15:07:40 +00003297 psa_wipe_tag_output_buffer(signature, status, signature_size,
3298 *signature_length);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003299
Paul Elliott53bb3122023-02-10 14:22:22 +00003300 if (status != PSA_OPERATION_INCOMPLETE) {
Paul Elliottc9774412023-02-06 15:14:07 +00003301 if (status != PSA_SUCCESS) {
3302 operation->error_occurred = 1;
3303 }
3304
Paul Elliott59ad9452022-12-18 15:09:02 +00003305 psa_sign_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003306 }
3307
3308 return status;
3309}
3310
3311psa_status_t psa_sign_hash_abort(
3312 psa_sign_hash_interruptible_operation_t *operation)
3313{
Paul Elliott59ad9452022-12-18 15:09:02 +00003314 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3315
3316 status = psa_sign_hash_abort_internal(operation);
3317
3318 /* We clear the number of ops done here, so that it is not cleared when
3319 * the operation fails or succeeds, only on manual abort. */
3320 operation->num_ops = 0;
3321
Paul Elliottc9774412023-02-06 15:14:07 +00003322 /* Likewise, failure state. */
3323 operation->error_occurred = 0;
3324
Paul Elliott59ad9452022-12-18 15:09:02 +00003325 return status;
3326}
3327
3328static psa_status_t psa_verify_hash_abort_internal(
3329 psa_verify_hash_interruptible_operation_t *operation)
3330{
Paul Elliott9fe12f62022-11-30 19:16:02 +00003331 if (operation->id == 0) {
3332 /* The object has (apparently) been initialized but it is not (yet)
3333 * in use. It's ok to call abort on such an object, and there's
3334 * nothing to do. */
3335 return PSA_SUCCESS;
3336 }
3337
Paul Elliott59ad9452022-12-18 15:09:02 +00003338 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3339
3340 status = psa_driver_wrapper_verify_hash_abort(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003341
3342 operation->id = 0;
3343
Paul Elliotte6145dc2023-02-07 12:51:21 +00003344 /* Do not clear either the error_occurred or num_ops elements here as they
3345 * only want to be cleared by the application calling abort, not by abort
3346 * being called at completion of an operation. */
3347
Paul Elliott59ad9452022-12-18 15:09:02 +00003348 return status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003349}
3350
3351psa_status_t psa_verify_hash_start(
3352 psa_verify_hash_interruptible_operation_t *operation,
3353 mbedtls_svc_key_id_t key, psa_algorithm_t alg,
3354 const uint8_t *hash, size_t hash_length,
3355 const uint8_t *signature, size_t signature_length)
3356{
3357 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3358 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3359 psa_key_slot_t *slot;
3360
Paul Elliottc9774412023-02-06 15:14:07 +00003361 /* Check that start has not been previously called, or operation has not
3362 * previously errored. */
3363 if (operation->id != 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003364 return PSA_ERROR_BAD_STATE;
3365 }
3366
3367 status = psa_sign_verify_check_alg(0, alg);
3368 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003369 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003370 return status;
3371 }
3372
3373 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
3374 PSA_KEY_USAGE_VERIFY_HASH,
3375 alg);
3376
3377 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003378 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003379 return status;
3380 }
3381
3382 psa_key_attributes_t attributes = {
3383 .core = slot->attr
3384 };
3385
Paul Elliott296ede92022-12-15 17:00:30 +00003386 /* Ensure ops count gets reset, in case of operation re-use. */
3387 operation->num_ops = 0;
3388
Paul Elliott9fe12f62022-11-30 19:16:02 +00003389 status = psa_driver_wrapper_verify_hash_start(operation, &attributes,
3390 slot->key.data,
3391 slot->key.bytes,
3392 alg, hash, hash_length,
3393 signature, signature_length);
3394
3395 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003396 operation->error_occurred = 1;
Paul Elliott59ad9452022-12-18 15:09:02 +00003397 psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003398 }
3399
3400 unlock_status = psa_unlock_key_slot(slot);
3401
Paul Elliottc9774412023-02-06 15:14:07 +00003402 if (unlock_status != PSA_SUCCESS) {
3403 operation->error_occurred = 1;
3404 }
Paul Elliott9fe12f62022-11-30 19:16:02 +00003405
Paul Elliottc9774412023-02-06 15:14:07 +00003406 return (status == PSA_SUCCESS) ? unlock_status : status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003407}
3408
3409psa_status_t psa_verify_hash_complete(
3410 psa_verify_hash_interruptible_operation_t *operation)
3411{
3412 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3413
Paul Elliottc9774412023-02-06 15:14:07 +00003414 /* Check that start has been called first, and that operation has not
3415 * previously errored. */
3416 if (operation->id == 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003417 status = PSA_ERROR_BAD_STATE;
3418 goto exit;
3419 }
3420
3421 status = psa_driver_wrapper_verify_hash_complete(operation);
3422
Paul Elliott296ede92022-12-15 17:00:30 +00003423 /* Update ops count with work done. */
Paul Elliottde1114c2023-02-07 12:43:11 +00003424 operation->num_ops = psa_driver_wrapper_verify_hash_get_num_ops(
Paul Elliott296ede92022-12-15 17:00:30 +00003425 operation);
3426
Paul Elliottebe225c2023-02-10 14:32:53 +00003427exit:
3428
Paul Elliott9fe12f62022-11-30 19:16:02 +00003429 if (status != PSA_OPERATION_INCOMPLETE) {
Paul Elliottc9774412023-02-06 15:14:07 +00003430 if (status != PSA_SUCCESS) {
3431 operation->error_occurred = 1;
3432 }
3433
Paul Elliott59ad9452022-12-18 15:09:02 +00003434 psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003435 }
3436
3437 return status;
3438}
3439
3440psa_status_t psa_verify_hash_abort(
3441 psa_verify_hash_interruptible_operation_t *operation)
3442{
Paul Elliott59ad9452022-12-18 15:09:02 +00003443 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003444
Paul Elliott59ad9452022-12-18 15:09:02 +00003445 status = psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003446
Paul Elliott59ad9452022-12-18 15:09:02 +00003447 /* We clear the number of ops done here, so that it is not cleared when
3448 * the operation fails or succeeds, only on manual abort. */
3449 operation->num_ops = 0;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003450
Paul Elliottc9774412023-02-06 15:14:07 +00003451 /* Likewise, failure state. */
3452 operation->error_occurred = 0;
3453
Paul Elliott59ad9452022-12-18 15:09:02 +00003454 return status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003455}
3456
Paul Elliott588f8ed2022-12-02 18:10:26 +00003457/****************************************************************/
3458/* Asymmetric interruptible cryptography internal */
3459/* implementations */
3460/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003461
Paul Elliott588f8ed2022-12-02 18:10:26 +00003462void mbedtls_psa_interruptible_set_max_ops(uint32_t max_ops)
3463{
Paul Elliott7cc4e812023-01-10 17:14:11 +00003464
Paul Elliott588f8ed2022-12-02 18:10:26 +00003465#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3466 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3467 defined(MBEDTLS_ECP_RESTARTABLE)
3468
3469 /* Internal implementation uses zero to indicate infinite number max ops,
3470 * therefore avoid this value, and set to minimum possible. */
3471 if (max_ops == 0) {
3472 max_ops = 1;
3473 }
3474
Paul Elliott588f8ed2022-12-02 18:10:26 +00003475 mbedtls_ecp_set_max_ops(max_ops);
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003476#else
3477 (void) max_ops;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003478#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3479 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3480 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3481}
3482
Paul Elliott588f8ed2022-12-02 18:10:26 +00003483uint32_t mbedtls_psa_sign_hash_get_num_ops(
Paul Elliottf8e5b562023-02-19 18:43:45 +00003484 const mbedtls_psa_sign_hash_interruptible_operation_t *operation)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003485{
3486#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3487 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3488 defined(MBEDTLS_ECP_RESTARTABLE)
3489
Paul Elliott93d9ca82023-02-15 18:14:21 +00003490 return operation->num_ops;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003491#else
3492 (void) operation;
3493 return 0;
3494#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3495 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3496 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3497}
3498
3499uint32_t mbedtls_psa_verify_hash_get_num_ops(
Paul Elliottf8e5b562023-02-19 18:43:45 +00003500 const mbedtls_psa_verify_hash_interruptible_operation_t *operation)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003501{
3502 #if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3503 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3504 defined(MBEDTLS_ECP_RESTARTABLE)
3505
Paul Elliott93d9ca82023-02-15 18:14:21 +00003506 return operation->num_ops;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003507#else
3508 (void) operation;
3509 return 0;
3510#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3511 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3512 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3513}
3514
3515psa_status_t mbedtls_psa_sign_hash_start(
3516 mbedtls_psa_sign_hash_interruptible_operation_t *operation,
3517 const psa_key_attributes_t *attributes, const uint8_t *key_buffer,
3518 size_t key_buffer_size, psa_algorithm_t alg,
3519 const uint8_t *hash, size_t hash_length)
3520{
3521 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott0290a762023-02-09 14:30:24 +00003522 size_t required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003523
Paul Elliott068fe072023-01-16 13:59:15 +00003524 if (!PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3525 return PSA_ERROR_NOT_SUPPORTED;
3526 }
3527
3528 if (!PSA_ALG_IS_ECDSA(alg)) {
Paul Elliott813f9cd2023-02-05 15:28:46 +00003529 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott068fe072023-01-16 13:59:15 +00003530 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003531
3532#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Paul Elliott068fe072023-01-16 13:59:15 +00003533 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3534 defined(MBEDTLS_ECP_RESTARTABLE)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003535
Paul Elliotta1c94092023-02-15 16:38:04 +00003536 mbedtls_ecdsa_restart_init(&operation->restart_ctx);
3537
Paul Elliott93d9ca82023-02-15 18:14:21 +00003538 /* Ensure num_ops is zero'ed in case of context re-use. */
3539 operation->num_ops = 0;
3540
Paul Elliott068fe072023-01-16 13:59:15 +00003541 status = mbedtls_psa_ecp_load_representation(attributes->core.type,
3542 attributes->core.bits,
3543 key_buffer,
3544 key_buffer_size,
3545 &operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003546
Paul Elliott068fe072023-01-16 13:59:15 +00003547 if (status != PSA_SUCCESS) {
3548 return status;
3549 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003550
Paul Elliott1bc59df2023-02-05 13:41:57 +00003551 operation->coordinate_bytes = PSA_BITS_TO_BYTES(
Paul Elliottc569fc22023-02-10 13:02:54 +00003552 operation->ctx->grp.nbits);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003553
Paul Elliott068fe072023-01-16 13:59:15 +00003554 psa_algorithm_t hash_alg = PSA_ALG_SIGN_GET_HASH(alg);
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02003555 operation->md_alg = mbedtls_md_type_from_psa_alg(hash_alg);
Paul Elliott068fe072023-01-16 13:59:15 +00003556 operation->alg = alg;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003557
Paul Elliott0290a762023-02-09 14:30:24 +00003558 /* We only need to store the same length of hash as the private key size
3559 * here, it would be truncated by the internal implementation anyway. */
3560 required_hash_length = (hash_length < operation->coordinate_bytes ?
3561 hash_length : operation->coordinate_bytes);
3562
Paul Elliottba70ad42023-02-15 18:23:53 +00003563 if (required_hash_length > sizeof(operation->hash)) {
3564 /* Shouldn't happen, but better safe than sorry. */
3565 return PSA_ERROR_CORRUPTION_DETECTED;
3566 }
3567
Paul Elliott0290a762023-02-09 14:30:24 +00003568 memcpy(operation->hash, hash, required_hash_length);
3569 operation->hash_length = required_hash_length;
Paul Elliott068fe072023-01-16 13:59:15 +00003570
3571 return PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003572
3573#else
Paul Elliott068fe072023-01-16 13:59:15 +00003574 (void) operation;
3575 (void) key_buffer;
3576 (void) key_buffer_size;
3577 (void) alg;
3578 (void) hash;
3579 (void) hash_length;
3580 (void) status;
Paul Elliott0290a762023-02-09 14:30:24 +00003581 (void) required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003582
Paul Elliott068fe072023-01-16 13:59:15 +00003583 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003584#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3585 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3586 * defined( MBEDTLS_ECP_RESTARTABLE ) */
Paul Elliott588f8ed2022-12-02 18:10:26 +00003587}
3588
3589psa_status_t mbedtls_psa_sign_hash_complete(
3590 mbedtls_psa_sign_hash_interruptible_operation_t *operation,
3591 uint8_t *signature, size_t signature_size,
3592 size_t *signature_length)
3593{
Paul Elliott588f8ed2022-12-02 18:10:26 +00003594#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3595 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3596 defined(MBEDTLS_ECP_RESTARTABLE)
3597
Paul Elliotta1c94092023-02-15 16:38:04 +00003598 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott1243f932023-02-07 11:21:10 +00003599 mbedtls_mpi r;
3600 mbedtls_mpi s;
3601
Paul Elliott46845252023-02-03 14:59:11 +00003602 mbedtls_mpi_init(&r);
3603 mbedtls_mpi_init(&s);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003604
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003605 /* Ensure max_ops is set to the current value (or default). */
3606 mbedtls_psa_interruptible_set_max_ops(psa_interruptible_get_max_ops());
3607
Paul Elliotta1c94092023-02-15 16:38:04 +00003608 if (signature_size < 2 * operation->coordinate_bytes) {
3609 status = PSA_ERROR_BUFFER_TOO_SMALL;
3610 goto exit;
3611 }
3612
Paul Elliott588f8ed2022-12-02 18:10:26 +00003613 if (PSA_ALG_ECDSA_IS_DETERMINISTIC(operation->alg)) {
Paul Elliott46845252023-02-03 14:59:11 +00003614
Paul Elliott588f8ed2022-12-02 18:10:26 +00003615#if defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3616 status = mbedtls_to_psa_error(
3617 mbedtls_ecdsa_sign_det_restartable(&operation->ctx->grp,
Paul Elliott46845252023-02-03 14:59:11 +00003618 &r,
3619 &s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003620 &operation->ctx->d,
3621 operation->hash,
3622 operation->hash_length,
3623 operation->md_alg,
3624 mbedtls_psa_get_random,
3625 MBEDTLS_PSA_RANDOM_STATE,
3626 &operation->restart_ctx));
3627#else /* defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Paul Elliott724bd252023-02-08 12:35:08 +00003628 status = PSA_ERROR_NOT_SUPPORTED;
3629 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003630#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
3631 } else {
Paul Elliott588f8ed2022-12-02 18:10:26 +00003632 status = mbedtls_to_psa_error(
3633 mbedtls_ecdsa_sign_restartable(&operation->ctx->grp,
Paul Elliott46845252023-02-03 14:59:11 +00003634 &r,
3635 &s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003636 &operation->ctx->d,
3637 operation->hash,
3638 operation->hash_length,
3639 mbedtls_psa_get_random,
3640 MBEDTLS_PSA_RANDOM_STATE,
3641 mbedtls_psa_get_random,
3642 MBEDTLS_PSA_RANDOM_STATE,
3643 &operation->restart_ctx));
3644 }
3645
Paul Elliottf8e5b562023-02-19 18:43:45 +00003646 /* Hide the fact that the restart context only holds a delta of number of
3647 * ops done during the last operation, not an absolute value. */
3648 operation->num_ops += operation->restart_ctx.ecp.ops_done;
3649
Paul Elliott724bd252023-02-08 12:35:08 +00003650 if (status == PSA_SUCCESS) {
Paul Elliott588f8ed2022-12-02 18:10:26 +00003651 status = mbedtls_to_psa_error(
Paul Elliott46845252023-02-03 14:59:11 +00003652 mbedtls_mpi_write_binary(&r,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003653 signature,
Paul Elliott1bc59df2023-02-05 13:41:57 +00003654 operation->coordinate_bytes)
3655 );
Paul Elliott588f8ed2022-12-02 18:10:26 +00003656
3657 if (status != PSA_SUCCESS) {
Paul Elliott724bd252023-02-08 12:35:08 +00003658 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003659 }
3660
3661 status = mbedtls_to_psa_error(
Paul Elliott46845252023-02-03 14:59:11 +00003662 mbedtls_mpi_write_binary(&s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003663 signature +
Paul Elliott1bc59df2023-02-05 13:41:57 +00003664 operation->coordinate_bytes,
3665 operation->coordinate_bytes)
3666 );
Paul Elliott588f8ed2022-12-02 18:10:26 +00003667
3668 if (status != PSA_SUCCESS) {
Paul Elliott724bd252023-02-08 12:35:08 +00003669 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003670 }
3671
Paul Elliott1bc59df2023-02-05 13:41:57 +00003672 *signature_length = operation->coordinate_bytes * 2;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003673
Paul Elliott724bd252023-02-08 12:35:08 +00003674 status = PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003675 }
Paul Elliott724bd252023-02-08 12:35:08 +00003676
3677exit:
3678
3679 mbedtls_mpi_free(&r);
3680 mbedtls_mpi_free(&s);
3681 return status;
3682
Paul Elliott588f8ed2022-12-02 18:10:26 +00003683 #else
3684
3685 (void) operation;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003686 (void) signature;
3687 (void) signature_size;
3688 (void) signature_length;
3689
3690 return PSA_ERROR_NOT_SUPPORTED;
3691
3692#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3693 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3694 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3695}
3696
3697psa_status_t mbedtls_psa_sign_hash_abort(
3698 mbedtls_psa_sign_hash_interruptible_operation_t *operation)
3699{
3700
3701#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3702 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3703 defined(MBEDTLS_ECP_RESTARTABLE)
3704
3705 if (operation->ctx) {
3706 mbedtls_ecdsa_free(operation->ctx);
3707 mbedtls_free(operation->ctx);
Paul Elliottf9c91a72023-02-05 18:06:38 +00003708 operation->ctx = NULL;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003709 }
3710
3711 mbedtls_ecdsa_restart_free(&operation->restart_ctx);
3712
Paul Elliott93d9ca82023-02-15 18:14:21 +00003713 operation->num_ops = 0;
3714
Paul Elliott588f8ed2022-12-02 18:10:26 +00003715 return PSA_SUCCESS;
3716
3717#else
3718
3719 (void) operation;
3720
3721 return PSA_ERROR_NOT_SUPPORTED;
3722
3723#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3724 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3725 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3726}
3727
3728psa_status_t mbedtls_psa_verify_hash_start(
3729 mbedtls_psa_verify_hash_interruptible_operation_t *operation,
3730 const psa_key_attributes_t *attributes,
3731 const uint8_t *key_buffer, size_t key_buffer_size,
3732 psa_algorithm_t alg,
3733 const uint8_t *hash, size_t hash_length,
3734 const uint8_t *signature, size_t signature_length)
3735{
3736 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott1bc59df2023-02-05 13:41:57 +00003737 size_t coordinate_bytes = 0;
Paul Elliott0290a762023-02-09 14:30:24 +00003738 size_t required_hash_length = 0;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003739
Paul Elliott068fe072023-01-16 13:59:15 +00003740 if (!PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3741 return PSA_ERROR_NOT_SUPPORTED;
3742 }
3743
3744 if (!PSA_ALG_IS_ECDSA(alg)) {
Paul Elliott813f9cd2023-02-05 15:28:46 +00003745 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott068fe072023-01-16 13:59:15 +00003746 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003747
3748#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Paul Elliott068fe072023-01-16 13:59:15 +00003749 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3750 defined(MBEDTLS_ECP_RESTARTABLE)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003751
Paul Elliotta1c94092023-02-15 16:38:04 +00003752 mbedtls_ecdsa_restart_init(&operation->restart_ctx);
3753 mbedtls_mpi_init(&operation->r);
3754 mbedtls_mpi_init(&operation->s);
3755
Paul Elliott93d9ca82023-02-15 18:14:21 +00003756 /* Ensure num_ops is zero'ed in case of context re-use. */
3757 operation->num_ops = 0;
3758
Paul Elliott068fe072023-01-16 13:59:15 +00003759 status = mbedtls_psa_ecp_load_representation(attributes->core.type,
3760 attributes->core.bits,
3761 key_buffer,
3762 key_buffer_size,
3763 &operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003764
Paul Elliott068fe072023-01-16 13:59:15 +00003765 if (status != PSA_SUCCESS) {
3766 return status;
3767 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003768
Paul Elliottc569fc22023-02-10 13:02:54 +00003769 coordinate_bytes = PSA_BITS_TO_BYTES(operation->ctx->grp.nbits);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003770
Paul Elliott1bc59df2023-02-05 13:41:57 +00003771 if (signature_length != 2 * coordinate_bytes) {
Paul Elliott068fe072023-01-16 13:59:15 +00003772 return PSA_ERROR_INVALID_SIGNATURE;
3773 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003774
Paul Elliott068fe072023-01-16 13:59:15 +00003775 status = mbedtls_to_psa_error(
3776 mbedtls_mpi_read_binary(&operation->r,
3777 signature,
Paul Elliott1bc59df2023-02-05 13:41:57 +00003778 coordinate_bytes));
Paul Elliott588f8ed2022-12-02 18:10:26 +00003779
Paul Elliott068fe072023-01-16 13:59:15 +00003780 if (status != PSA_SUCCESS) {
3781 return status;
3782 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003783
Paul Elliott068fe072023-01-16 13:59:15 +00003784 status = mbedtls_to_psa_error(
3785 mbedtls_mpi_read_binary(&operation->s,
3786 signature +
Paul Elliott1bc59df2023-02-05 13:41:57 +00003787 coordinate_bytes,
3788 coordinate_bytes));
Paul Elliott588f8ed2022-12-02 18:10:26 +00003789
Paul Elliott068fe072023-01-16 13:59:15 +00003790 if (status != PSA_SUCCESS) {
3791 return status;
3792 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003793
Paul Elliott2c9843f2023-02-15 17:32:42 +00003794 status = mbedtls_psa_ecp_load_public_part(operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003795
Paul Elliott2c9843f2023-02-15 17:32:42 +00003796 if (status != PSA_SUCCESS) {
3797 return status;
Paul Elliott068fe072023-01-16 13:59:15 +00003798 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003799
Paul Elliott0290a762023-02-09 14:30:24 +00003800 /* We only need to store the same length of hash as the private key size
3801 * here, it would be truncated by the internal implementation anyway. */
3802 required_hash_length = (hash_length < coordinate_bytes ? hash_length :
3803 coordinate_bytes);
3804
Paul Elliottba70ad42023-02-15 18:23:53 +00003805 if (required_hash_length > sizeof(operation->hash)) {
3806 /* Shouldn't happen, but better safe than sorry. */
3807 return PSA_ERROR_CORRUPTION_DETECTED;
3808 }
3809
Paul Elliott0290a762023-02-09 14:30:24 +00003810 memcpy(operation->hash, hash, required_hash_length);
3811 operation->hash_length = required_hash_length;
Paul Elliott068fe072023-01-16 13:59:15 +00003812
3813 return PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003814#else
Paul Elliott068fe072023-01-16 13:59:15 +00003815 (void) operation;
3816 (void) key_buffer;
3817 (void) key_buffer_size;
3818 (void) alg;
3819 (void) hash;
3820 (void) hash_length;
3821 (void) signature;
3822 (void) signature_length;
3823 (void) status;
Paul Elliott1243f932023-02-07 11:21:10 +00003824 (void) coordinate_bytes;
Paul Elliott0290a762023-02-09 14:30:24 +00003825 (void) required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003826
Paul Elliott068fe072023-01-16 13:59:15 +00003827 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003828#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3829 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3830 * defined( MBEDTLS_ECP_RESTARTABLE ) */
Paul Elliott588f8ed2022-12-02 18:10:26 +00003831}
3832
3833psa_status_t mbedtls_psa_verify_hash_complete(
3834 mbedtls_psa_verify_hash_interruptible_operation_t *operation)
3835{
3836
3837#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3838 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3839 defined(MBEDTLS_ECP_RESTARTABLE)
3840
Paul Elliottf8e5b562023-02-19 18:43:45 +00003841 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3842
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003843 /* Ensure max_ops is set to the current value (or default). */
3844 mbedtls_psa_interruptible_set_max_ops(psa_interruptible_get_max_ops());
3845
Paul Elliottf8e5b562023-02-19 18:43:45 +00003846 status = mbedtls_to_psa_error(
Paul Elliott588f8ed2022-12-02 18:10:26 +00003847 mbedtls_ecdsa_verify_restartable(&operation->ctx->grp,
3848 operation->hash,
3849 operation->hash_length,
3850 &operation->ctx->Q,
3851 &operation->r,
3852 &operation->s,
3853 &operation->restart_ctx));
3854
Paul Elliottf8e5b562023-02-19 18:43:45 +00003855 /* Hide the fact that the restart context only holds a delta of number of
3856 * ops done during the last operation, not an absolute value. */
3857 operation->num_ops += operation->restart_ctx.ecp.ops_done;
3858
3859 return status;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003860#else
3861 (void) operation;
3862
3863 return PSA_ERROR_NOT_SUPPORTED;
3864
3865#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3866 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3867 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3868}
3869
3870psa_status_t mbedtls_psa_verify_hash_abort(
3871 mbedtls_psa_verify_hash_interruptible_operation_t *operation)
3872{
3873
3874#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3875 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3876 defined(MBEDTLS_ECP_RESTARTABLE)
3877
3878 if (operation->ctx) {
3879 mbedtls_ecdsa_free(operation->ctx);
3880 mbedtls_free(operation->ctx);
Paul Elliottf9c91a72023-02-05 18:06:38 +00003881 operation->ctx = NULL;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003882 }
3883
3884 mbedtls_ecdsa_restart_free(&operation->restart_ctx);
3885
Paul Elliott93d9ca82023-02-15 18:14:21 +00003886 operation->num_ops = 0;
3887
Paul Elliott588f8ed2022-12-02 18:10:26 +00003888 mbedtls_mpi_free(&operation->r);
3889 mbedtls_mpi_free(&operation->s);
3890
3891 return PSA_SUCCESS;
3892
3893#else
3894 (void) operation;
3895
3896 return PSA_ERROR_NOT_SUPPORTED;
3897
3898#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3899 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3900 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3901}
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003902
mohammad1603503973b2018-03-12 15:59:30 +02003903/****************************************************************/
3904/* Symmetric cryptography */
3905/****************************************************************/
3906
Gilles Peskine449bd832023-01-11 14:50:10 +01003907static psa_status_t psa_cipher_setup(psa_cipher_operation_t *operation,
3908 mbedtls_svc_key_id_t key,
3909 psa_algorithm_t alg,
3910 mbedtls_operation_t cipher_operation)
Ronald Cronab99ac22020-10-01 16:38:28 +02003911{
3912 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3913 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman54648242021-06-24 11:49:45 +01003914 psa_key_slot_t *slot = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01003915 psa_key_usage_t usage = (cipher_operation == MBEDTLS_ENCRYPT ?
3916 PSA_KEY_USAGE_ENCRYPT :
3917 PSA_KEY_USAGE_DECRYPT);
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003918 psa_key_attributes_t attributes;
Ronald Cronab99ac22020-10-01 16:38:28 +02003919
3920 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003921 if (operation->id != 0) {
Dave Rodgman54648242021-06-24 11:49:45 +01003922 status = PSA_ERROR_BAD_STATE;
3923 goto exit;
3924 }
Ronald Cronab99ac22020-10-01 16:38:28 +02003925
Gilles Peskine449bd832023-01-11 14:50:10 +01003926 if (!PSA_ALG_IS_CIPHER(alg)) {
Dave Rodgman54648242021-06-24 11:49:45 +01003927 status = PSA_ERROR_INVALID_ARGUMENT;
3928 goto exit;
3929 }
Ronald Cronab99ac22020-10-01 16:38:28 +02003930
Gilles Peskine449bd832023-01-11 14:50:10 +01003931 status = psa_get_and_lock_key_slot_with_policy(key, &slot, usage, alg);
3932 if (status != PSA_SUCCESS) {
Ronald Cronab99ac22020-10-01 16:38:28 +02003933 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01003934 }
Ronald Cronab99ac22020-10-01 16:38:28 +02003935
Ronald Cron49fafa92021-03-10 08:34:23 +01003936 /* Initialize the operation struct members, except for id. The id member
Ronald Cronab99ac22020-10-01 16:38:28 +02003937 * is used to indicate to psa_cipher_abort that there are resources to free,
Ronald Cron49fafa92021-03-10 08:34:23 +01003938 * so we only set it (in the driver wrapper) after resources have been
3939 * allocated/initialized. */
Ronald Cronab99ac22020-10-01 16:38:28 +02003940 operation->iv_set = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01003941 if (alg == PSA_ALG_ECB_NO_PADDING) {
Ronald Cronab99ac22020-10-01 16:38:28 +02003942 operation->iv_required = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01003943 } else {
Ronald Cronab99ac22020-10-01 16:38:28 +02003944 operation->iv_required = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003945 }
3946 operation->default_iv_length = PSA_CIPHER_IV_LENGTH(slot->attr.type, alg);
Ronald Cronab99ac22020-10-01 16:38:28 +02003947
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003948 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01003949 .core = slot->attr
Ronald Crona4af55f2020-12-14 14:36:06 +01003950 };
3951
Ronald Cronab99ac22020-10-01 16:38:28 +02003952 /* Try doing the operation through a driver before using software fallback. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003953 if (cipher_operation == MBEDTLS_ENCRYPT) {
3954 status = psa_driver_wrapper_cipher_encrypt_setup(operation,
3955 &attributes,
3956 slot->key.data,
3957 slot->key.bytes,
3958 alg);
3959 } else {
3960 status = psa_driver_wrapper_cipher_decrypt_setup(operation,
3961 &attributes,
3962 slot->key.data,
3963 slot->key.bytes,
3964 alg);
3965 }
Ronald Cronab99ac22020-10-01 16:38:28 +02003966
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003967exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01003968 if (status != PSA_SUCCESS) {
3969 psa_cipher_abort(operation);
3970 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003971
Gilles Peskine449bd832023-01-11 14:50:10 +01003972 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003973
Gilles Peskine449bd832023-01-11 14:50:10 +01003974 return (status == PSA_SUCCESS) ? unlock_status : status;
mohammad1603503973b2018-03-12 15:59:30 +02003975}
3976
Gilles Peskine449bd832023-01-11 14:50:10 +01003977psa_status_t psa_cipher_encrypt_setup(psa_cipher_operation_t *operation,
3978 mbedtls_svc_key_id_t key,
3979 psa_algorithm_t alg)
mohammad16038481e742018-03-18 13:57:31 +02003980{
Gilles Peskine449bd832023-01-11 14:50:10 +01003981 return psa_cipher_setup(operation, key, alg, MBEDTLS_ENCRYPT);
mohammad16038481e742018-03-18 13:57:31 +02003982}
3983
Gilles Peskine449bd832023-01-11 14:50:10 +01003984psa_status_t psa_cipher_decrypt_setup(psa_cipher_operation_t *operation,
3985 mbedtls_svc_key_id_t key,
3986 psa_algorithm_t alg)
mohammad16038481e742018-03-18 13:57:31 +02003987{
Gilles Peskine449bd832023-01-11 14:50:10 +01003988 return psa_cipher_setup(operation, key, alg, MBEDTLS_DECRYPT);
mohammad16038481e742018-03-18 13:57:31 +02003989}
3990
Gilles Peskine449bd832023-01-11 14:50:10 +01003991psa_status_t psa_cipher_generate_iv(psa_cipher_operation_t *operation,
3992 uint8_t *iv,
3993 size_t iv_size,
3994 size_t *iv_length)
mohammad1603503973b2018-03-12 15:59:30 +02003995{
Ronald Cron6d051732020-10-01 14:10:20 +02003996 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2fb90522021-07-05 12:31:44 +02003997 uint8_t local_iv[PSA_CIPHER_IV_MAX_SIZE];
Sergeybef1f632023-03-06 15:25:06 -07003998 size_t default_iv_length = 0;
Ronald Cron5618a392021-03-26 09:52:26 +01003999
Gilles Peskine449bd832023-01-11 14:50:10 +01004000 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004001 status = PSA_ERROR_BAD_STATE;
4002 goto exit;
Ronald Cronc45b4af2020-09-29 16:18:05 +02004003 }
4004
Gilles Peskine449bd832023-01-11 14:50:10 +01004005 if (operation->iv_set || !operation->iv_required) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004006 status = PSA_ERROR_BAD_STATE;
4007 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004008 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004009
Ronald Cron2fb90522021-07-05 12:31:44 +02004010 default_iv_length = operation->default_iv_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01004011 if (iv_size < default_iv_length) {
Ronald Cron5618a392021-03-26 09:52:26 +01004012 status = PSA_ERROR_BUFFER_TOO_SMALL;
4013 goto exit;
4014 }
Gilles Peskinee553c652018-06-04 16:22:46 +02004015
Gilles Peskine449bd832023-01-11 14:50:10 +01004016 if (default_iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Ronald Cron2fb90522021-07-05 12:31:44 +02004017 status = PSA_ERROR_GENERIC_ERROR;
4018 goto exit;
4019 }
4020
Gilles Peskine449bd832023-01-11 14:50:10 +01004021 status = psa_generate_random(local_iv, default_iv_length);
4022 if (status != PSA_SUCCESS) {
Ronald Cron5618a392021-03-26 09:52:26 +01004023 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004024 }
Ronald Cron5618a392021-03-26 09:52:26 +01004025
Gilles Peskine449bd832023-01-11 14:50:10 +01004026 status = psa_driver_wrapper_cipher_set_iv(operation,
4027 local_iv, default_iv_length);
Ronald Cron5618a392021-03-26 09:52:26 +01004028
4029exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004030 if (status == PSA_SUCCESS) {
4031 memcpy(iv, local_iv, default_iv_length);
Ronald Cron2fb90522021-07-05 12:31:44 +02004032 *iv_length = default_iv_length;
Steven Cooreman7df02922020-09-09 15:28:49 +02004033 operation->iv_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004034 } else {
Ronald Cron2fb90522021-07-05 12:31:44 +02004035 *iv_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004036 psa_cipher_abort(operation);
Ronald Cron2fb90522021-07-05 12:31:44 +02004037 }
Ronald Cron6d051732020-10-01 14:10:20 +02004038
Gilles Peskine449bd832023-01-11 14:50:10 +01004039 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004040}
4041
Gilles Peskine449bd832023-01-11 14:50:10 +01004042psa_status_t psa_cipher_set_iv(psa_cipher_operation_t *operation,
4043 const uint8_t *iv,
4044 size_t iv_length)
mohammad1603503973b2018-03-12 15:59:30 +02004045{
Ronald Cron6d051732020-10-01 14:10:20 +02004046 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronc45b4af2020-09-29 16:18:05 +02004047
Gilles Peskine449bd832023-01-11 14:50:10 +01004048 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004049 status = PSA_ERROR_BAD_STATE;
4050 goto exit;
4051 }
Ronald Cronc45b4af2020-09-29 16:18:05 +02004052
Gilles Peskine449bd832023-01-11 14:50:10 +01004053 if (operation->iv_set || !operation->iv_required) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004054 status = PSA_ERROR_BAD_STATE;
4055 goto exit;
4056 }
Ronald Crona0d68172021-03-26 10:15:08 +01004057
Gilles Peskine449bd832023-01-11 14:50:10 +01004058 if (iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004059 status = PSA_ERROR_INVALID_ARGUMENT;
4060 goto exit;
4061 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004062
Gilles Peskine449bd832023-01-11 14:50:10 +01004063 status = psa_driver_wrapper_cipher_set_iv(operation,
4064 iv,
4065 iv_length);
Steven Cooremand3feccd2020-09-01 15:56:14 +02004066
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004067exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004068 if (status == PSA_SUCCESS) {
itayzafrir534bd7c2018-08-02 13:56:32 +03004069 operation->iv_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004070 } else {
4071 psa_cipher_abort(operation);
4072 }
4073 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004074}
4075
Gilles Peskine449bd832023-01-11 14:50:10 +01004076psa_status_t psa_cipher_update(psa_cipher_operation_t *operation,
4077 const uint8_t *input,
4078 size_t input_length,
4079 uint8_t *output,
4080 size_t output_size,
4081 size_t *output_length)
mohammad1603503973b2018-03-12 15:59:30 +02004082{
Steven Cooremanffecb7b2020-08-25 15:13:13 +02004083 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron6d051732020-10-01 14:10:20 +02004084
Gilles Peskine449bd832023-01-11 14:50:10 +01004085 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004086 status = PSA_ERROR_BAD_STATE;
4087 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004088 }
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004089
Gilles Peskine449bd832023-01-11 14:50:10 +01004090 if (operation->iv_required && !operation->iv_set) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004091 status = PSA_ERROR_BAD_STATE;
4092 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004093 }
Jaeden Ameroab439972019-02-15 14:12:05 +00004094
Gilles Peskine449bd832023-01-11 14:50:10 +01004095 status = psa_driver_wrapper_cipher_update(operation,
4096 input,
4097 input_length,
4098 output,
4099 output_size,
4100 output_length);
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004101
4102exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004103 if (status != PSA_SUCCESS) {
4104 psa_cipher_abort(operation);
4105 }
Ronald Cron6d051732020-10-01 14:10:20 +02004106
Gilles Peskine449bd832023-01-11 14:50:10 +01004107 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004108}
4109
Gilles Peskine449bd832023-01-11 14:50:10 +01004110psa_status_t psa_cipher_finish(psa_cipher_operation_t *operation,
4111 uint8_t *output,
4112 size_t output_size,
4113 size_t *output_length)
mohammad1603503973b2018-03-12 15:59:30 +02004114{
David Saadab4ecc272019-02-14 13:48:10 +02004115 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Ronald Cron6d051732020-10-01 14:10:20 +02004116
Gilles Peskine449bd832023-01-11 14:50:10 +01004117 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004118 status = PSA_ERROR_BAD_STATE;
4119 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004120 }
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004121
Gilles Peskine449bd832023-01-11 14:50:10 +01004122 if (operation->iv_required && !operation->iv_set) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004123 status = PSA_ERROR_BAD_STATE;
4124 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004125 }
Moran Pekerbed71a22018-04-22 20:19:20 +03004126
Gilles Peskine449bd832023-01-11 14:50:10 +01004127 status = psa_driver_wrapper_cipher_finish(operation,
4128 output,
4129 output_size,
4130 output_length);
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004131
4132exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004133 if (status == PSA_SUCCESS) {
4134 return psa_cipher_abort(operation);
4135 } else {
Steven Cooremanef8575e2020-09-11 11:44:50 +02004136 *output_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004137 (void) psa_cipher_abort(operation);
Janos Follath315b51c2018-07-09 16:04:51 +01004138
Gilles Peskine449bd832023-01-11 14:50:10 +01004139 return status;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004140 }
mohammad1603503973b2018-03-12 15:59:30 +02004141}
4142
Gilles Peskine449bd832023-01-11 14:50:10 +01004143psa_status_t psa_cipher_abort(psa_cipher_operation_t *operation)
Gilles Peskinee553c652018-06-04 16:22:46 +02004144{
Gilles Peskine449bd832023-01-11 14:50:10 +01004145 if (operation->id == 0) {
Steven Cooremana07b9972020-09-10 14:54:14 +02004146 /* The object has (apparently) been initialized but it is not (yet)
Gilles Peskine81736312018-06-26 15:04:31 +02004147 * in use. It's ok to call abort on such an object, and there's
4148 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004149 return PSA_SUCCESS;
Gilles Peskine81736312018-06-26 15:04:31 +02004150 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004151
Gilles Peskine449bd832023-01-11 14:50:10 +01004152 psa_driver_wrapper_cipher_abort(operation);
Gilles Peskinee553c652018-06-04 16:22:46 +02004153
Ronald Cron49fafa92021-03-10 08:34:23 +01004154 operation->id = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004155 operation->iv_set = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004156 operation->iv_required = 0;
Moran Peker41deec42018-04-04 15:43:05 +03004157
Gilles Peskine449bd832023-01-11 14:50:10 +01004158 return PSA_SUCCESS;
mohammad1603503973b2018-03-12 15:59:30 +02004159}
4160
Gilles Peskine449bd832023-01-11 14:50:10 +01004161psa_status_t psa_cipher_encrypt(mbedtls_svc_key_id_t key,
4162 psa_algorithm_t alg,
4163 const uint8_t *input,
4164 size_t input_length,
4165 uint8_t *output,
4166 size_t output_size,
4167 size_t *output_length)
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004168{
4169 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004170 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron23919522021-07-08 19:00:07 +02004171 psa_key_slot_t *slot = NULL;
Ronald Cronc6e6f502021-07-09 18:44:58 +02004172 uint8_t local_iv[PSA_CIPHER_IV_MAX_SIZE];
4173 size_t default_iv_length = 0;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004174 psa_key_attributes_t attributes;
gabor-mezei-arm6f4e5bb2021-06-25 15:21:11 +02004175
Gilles Peskine449bd832023-01-11 14:50:10 +01004176 if (!PSA_ALG_IS_CIPHER(alg)) {
Ronald Cron23919522021-07-08 19:00:07 +02004177 status = PSA_ERROR_INVALID_ARGUMENT;
4178 goto exit;
4179 }
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004180
Gilles Peskine449bd832023-01-11 14:50:10 +01004181 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
4182 PSA_KEY_USAGE_ENCRYPT,
4183 alg);
4184 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004185 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004186 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004187
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004188 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004189 .core = slot->attr
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004190 };
4191
Gilles Peskine449bd832023-01-11 14:50:10 +01004192 default_iv_length = PSA_CIPHER_IV_LENGTH(slot->attr.type, alg);
4193 if (default_iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Ronald Cronc6e6f502021-07-09 18:44:58 +02004194 status = PSA_ERROR_GENERIC_ERROR;
4195 goto exit;
4196 }
4197
Gilles Peskine449bd832023-01-11 14:50:10 +01004198 if (default_iv_length > 0) {
4199 if (output_size < default_iv_length) {
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004200 status = PSA_ERROR_BUFFER_TOO_SMALL;
4201 goto exit;
4202 }
4203
Gilles Peskine449bd832023-01-11 14:50:10 +01004204 status = psa_generate_random(local_iv, default_iv_length);
4205 if (status != PSA_SUCCESS) {
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004206 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004207 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004208 }
4209
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004210 status = psa_driver_wrapper_cipher_encrypt(
4211 &attributes, slot->key.data, slot->key.bytes,
Ronald Cronc6e6f502021-07-09 18:44:58 +02004212 alg, local_iv, default_iv_length, input, input_length,
Ronald Cronafbc7ed2023-01-24 16:02:04 +01004213 psa_crypto_buffer_offset(output, default_iv_length),
Gilles Peskine449bd832023-01-11 14:50:10 +01004214 output_size - default_iv_length, output_length);
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004215
4216exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004217 unlock_status = psa_unlock_key_slot(slot);
4218 if (status == PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004219 status = unlock_status;
Ronald Cronc6e6f502021-07-09 18:44:58 +02004220 }
Ronald Cron23919522021-07-08 19:00:07 +02004221
Gilles Peskine449bd832023-01-11 14:50:10 +01004222 if (status == PSA_SUCCESS) {
4223 if (default_iv_length > 0) {
4224 memcpy(output, local_iv, default_iv_length);
4225 }
4226 *output_length += default_iv_length;
4227 } else {
4228 *output_length = 0;
4229 }
4230
4231 return status;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004232}
4233
Gilles Peskine449bd832023-01-11 14:50:10 +01004234psa_status_t psa_cipher_decrypt(mbedtls_svc_key_id_t key,
4235 psa_algorithm_t alg,
4236 const uint8_t *input,
4237 size_t input_length,
4238 uint8_t *output,
4239 size_t output_size,
4240 size_t *output_length)
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004241{
4242 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004243 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron23919522021-07-08 19:00:07 +02004244 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004245 psa_key_attributes_t attributes;
gabor-mezei-arm6f4e5bb2021-06-25 15:21:11 +02004246
Gilles Peskine449bd832023-01-11 14:50:10 +01004247 if (!PSA_ALG_IS_CIPHER(alg)) {
Ronald Cron23919522021-07-08 19:00:07 +02004248 status = PSA_ERROR_INVALID_ARGUMENT;
4249 goto exit;
4250 }
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004251
Gilles Peskine449bd832023-01-11 14:50:10 +01004252 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
4253 PSA_KEY_USAGE_DECRYPT,
4254 alg);
4255 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004256 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004257 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004258
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004259 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004260 .core = slot->attr
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004261 };
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004262
Gilles Peskine449bd832023-01-11 14:50:10 +01004263 if (alg == PSA_ALG_CCM_STAR_NO_TAG &&
4264 input_length < PSA_BLOCK_CIPHER_BLOCK_LENGTH(slot->attr.type)) {
Mateusz Starzyk594215b2021-10-14 12:23:06 +02004265 status = PSA_ERROR_INVALID_ARGUMENT;
4266 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004267 } else if (input_length < PSA_CIPHER_IV_LENGTH(slot->attr.type, alg)) {
gabor-mezei-arm258ae072021-06-25 15:25:38 +02004268 status = PSA_ERROR_INVALID_ARGUMENT;
4269 goto exit;
4270 }
4271
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004272 status = psa_driver_wrapper_cipher_decrypt(
4273 &attributes, slot->key.data, slot->key.bytes,
4274 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004275 output, output_size, output_length);
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004276
gabor-mezei-arm258ae072021-06-25 15:25:38 +02004277exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004278 unlock_status = psa_unlock_key_slot(slot);
4279 if (status == PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004280 status = unlock_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01004281 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004282
Gilles Peskine449bd832023-01-11 14:50:10 +01004283 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004284 *output_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004285 }
Ronald Cron23919522021-07-08 19:00:07 +02004286
Gilles Peskine449bd832023-01-11 14:50:10 +01004287 return status;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004288}
4289
4290
mohammad16035955c982018-04-26 00:53:03 +03004291/****************************************************************/
4292/* AEAD */
4293/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004294
Paul Elliottbaff51c2021-09-28 17:44:45 +01004295/* Helper function to get the base algorithm from its variants. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004296static psa_algorithm_t psa_aead_get_base_algorithm(psa_algorithm_t alg)
Paul Elliottbaff51c2021-09-28 17:44:45 +01004297{
Gilles Peskine449bd832023-01-11 14:50:10 +01004298 return PSA_ALG_AEAD_WITH_DEFAULT_LENGTH_TAG(alg);
Paul Elliottbaff51c2021-09-28 17:44:45 +01004299}
4300
4301/* Helper function to perform common nonce length checks. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004302static psa_status_t psa_aead_check_nonce_length(psa_algorithm_t alg,
4303 size_t nonce_length)
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004304{
Gilles Peskine449bd832023-01-11 14:50:10 +01004305 psa_algorithm_t base_alg = psa_aead_get_base_algorithm(alg);
Paul Elliottbaff51c2021-09-28 17:44:45 +01004306
Gilles Peskine449bd832023-01-11 14:50:10 +01004307 switch (base_alg) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004308#if defined(PSA_WANT_ALG_GCM)
4309 case PSA_ALG_GCM:
4310 /* Not checking max nonce size here as GCM spec allows almost
Gilles Peskine449bd832023-01-11 14:50:10 +01004311 * arbitrarily large nonces. Please note that we do not generally
4312 * recommend the usage of nonces of greater length than
4313 * PSA_AEAD_NONCE_MAX_SIZE, as large nonces are hashed to a shorter
4314 * size, which can then lead to collisions if you encrypt a very
4315 * large number of messages.*/
4316 if (nonce_length != 0) {
4317 return PSA_SUCCESS;
4318 }
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004319 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004320#endif /* PSA_WANT_ALG_GCM */
4321#if defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004322 case PSA_ALG_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01004323 if (nonce_length >= 7 && nonce_length <= 13) {
4324 return PSA_SUCCESS;
4325 }
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004326 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004327#endif /* PSA_WANT_ALG_CCM */
4328#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004329 case PSA_ALG_CHACHA20_POLY1305:
Gilles Peskine449bd832023-01-11 14:50:10 +01004330 if (nonce_length == 12) {
4331 return PSA_SUCCESS;
4332 } else if (nonce_length == 8) {
4333 return PSA_ERROR_NOT_SUPPORTED;
4334 }
Bence Szépkúti6d48e202021-11-15 20:04:15 +01004335 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004336#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004337 default:
Przemek Stekiel4c499272022-09-27 13:55:37 +02004338 (void) nonce_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01004339 return PSA_ERROR_NOT_SUPPORTED;
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004340 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004341
Gilles Peskine449bd832023-01-11 14:50:10 +01004342 return PSA_ERROR_INVALID_ARGUMENT;
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004343}
4344
Gilles Peskine449bd832023-01-11 14:50:10 +01004345static psa_status_t psa_aead_check_algorithm(psa_algorithm_t alg)
Bence Szépkútiaa3a6e42022-01-13 16:26:03 +01004346{
Gilles Peskine449bd832023-01-11 14:50:10 +01004347 if (!PSA_ALG_IS_AEAD(alg) || PSA_ALG_IS_WILDCARD(alg)) {
4348 return PSA_ERROR_INVALID_ARGUMENT;
4349 }
Bence Szépkúti08f34652021-12-08 21:07:13 +01004350
Gilles Peskine449bd832023-01-11 14:50:10 +01004351 return PSA_SUCCESS;
Bence Szépkúti08f34652021-12-08 21:07:13 +01004352}
4353
Gilles Peskine449bd832023-01-11 14:50:10 +01004354psa_status_t psa_aead_encrypt(mbedtls_svc_key_id_t key,
4355 psa_algorithm_t alg,
4356 const uint8_t *nonce,
4357 size_t nonce_length,
4358 const uint8_t *additional_data,
4359 size_t additional_data_length,
4360 const uint8_t *plaintext,
4361 size_t plaintext_length,
4362 uint8_t *ciphertext,
4363 size_t ciphertext_size,
4364 size_t *ciphertext_length)
mohammad16035955c982018-04-26 00:53:03 +03004365{
Ronald Cron215633c2021-03-16 17:15:37 +01004366 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4367 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02004368
mohammad1603f08a5502018-06-03 15:05:47 +03004369 *ciphertext_length = 0;
mohammad1603e58e6842018-05-09 04:58:32 -07004370
Gilles Peskine449bd832023-01-11 14:50:10 +01004371 status = psa_aead_check_algorithm(alg);
4372 if (status != PSA_SUCCESS) {
4373 return status;
4374 }
Steven Cooremanea7ab132021-03-17 16:28:00 +01004375
Ronald Cron9a986162021-03-26 12:40:07 +01004376 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01004377 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg);
4378 if (status != PSA_SUCCESS) {
4379 return status;
4380 }
mohammad16035955c982018-04-26 00:53:03 +03004381
Ronald Cron215633c2021-03-16 17:15:37 +01004382 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01004383 .core = slot->attr
Ronald Cron215633c2021-03-16 17:15:37 +01004384 };
mohammad16035955c982018-04-26 00:53:03 +03004385
Gilles Peskine449bd832023-01-11 14:50:10 +01004386 status = psa_aead_check_nonce_length(alg, nonce_length);
4387 if (status != PSA_SUCCESS) {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004388 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004389 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004390
Ronald Cronde822812021-03-17 16:08:20 +01004391 status = psa_driver_wrapper_aead_encrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01004392 &attributes, slot->key.data, slot->key.bytes,
4393 alg,
4394 nonce, nonce_length,
4395 additional_data, additional_data_length,
4396 plaintext, plaintext_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004397 ciphertext, ciphertext_size, ciphertext_length);
Gilles Peskine2d277862018-06-18 15:41:12 +02004398
Gilles Peskine449bd832023-01-11 14:50:10 +01004399 if (status != PSA_SUCCESS && ciphertext_size != 0) {
4400 memset(ciphertext, 0, ciphertext_size);
4401 }
Gilles Peskine2d277862018-06-18 15:41:12 +02004402
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004403exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004404 psa_unlock_key_slot(slot);
mohammad16035955c982018-04-26 00:53:03 +03004405
Gilles Peskine449bd832023-01-11 14:50:10 +01004406 return status;
Gilles Peskineee652a32018-06-01 19:23:52 +02004407}
4408
Gilles Peskine449bd832023-01-11 14:50:10 +01004409psa_status_t psa_aead_decrypt(mbedtls_svc_key_id_t key,
4410 psa_algorithm_t alg,
4411 const uint8_t *nonce,
4412 size_t nonce_length,
4413 const uint8_t *additional_data,
4414 size_t additional_data_length,
4415 const uint8_t *ciphertext,
4416 size_t ciphertext_length,
4417 uint8_t *plaintext,
4418 size_t plaintext_size,
4419 size_t *plaintext_length)
mohammad16035955c982018-04-26 00:53:03 +03004420{
Ronald Cron215633c2021-03-16 17:15:37 +01004421 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4422 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02004423
Gilles Peskineee652a32018-06-01 19:23:52 +02004424 *plaintext_length = 0;
mohammad16039e5a5152018-04-26 12:07:35 +03004425
Gilles Peskine449bd832023-01-11 14:50:10 +01004426 status = psa_aead_check_algorithm(alg);
4427 if (status != PSA_SUCCESS) {
4428 return status;
4429 }
Steven Cooremanea7ab132021-03-17 16:28:00 +01004430
Ronald Cron9a986162021-03-26 12:40:07 +01004431 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01004432 key, &slot, PSA_KEY_USAGE_DECRYPT, alg);
4433 if (status != PSA_SUCCESS) {
4434 return status;
4435 }
mohammad16035955c982018-04-26 00:53:03 +03004436
Ronald Cron215633c2021-03-16 17:15:37 +01004437 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01004438 .core = slot->attr
Ronald Cron215633c2021-03-16 17:15:37 +01004439 };
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004440
Gilles Peskine449bd832023-01-11 14:50:10 +01004441 status = psa_aead_check_nonce_length(alg, nonce_length);
4442 if (status != PSA_SUCCESS) {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004443 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004444 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004445
Ronald Cronde822812021-03-17 16:08:20 +01004446 status = psa_driver_wrapper_aead_decrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01004447 &attributes, slot->key.data, slot->key.bytes,
4448 alg,
4449 nonce, nonce_length,
4450 additional_data, additional_data_length,
4451 ciphertext, ciphertext_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004452 plaintext, plaintext_size, plaintext_length);
Gilles Peskinea40d7742018-06-01 16:28:30 +02004453
Gilles Peskine449bd832023-01-11 14:50:10 +01004454 if (status != PSA_SUCCESS && plaintext_size != 0) {
4455 memset(plaintext, 0, plaintext_size);
4456 }
mohammad160360a64d02018-06-03 17:20:42 +03004457
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004458exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004459 psa_unlock_key_slot(slot);
Ronald Cron215633c2021-03-16 17:15:37 +01004460
Gilles Peskine449bd832023-01-11 14:50:10 +01004461 return status;
mohammad16035955c982018-04-26 00:53:03 +03004462}
4463
Gilles Peskine449bd832023-01-11 14:50:10 +01004464static psa_status_t psa_validate_tag_length(psa_algorithm_t alg)
4465{
4466 const uint8_t tag_len = PSA_ALG_AEAD_GET_TAG_LENGTH(alg);
Andrzej Kurekf8816012021-12-19 17:00:12 +01004467
Gilles Peskine449bd832023-01-11 14:50:10 +01004468 switch (PSA_ALG_AEAD_WITH_SHORTENED_TAG(alg, 0)) {
Przemek Stekiel86679c72022-10-06 17:06:56 +02004469#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004470 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004471 /* CCM allows the following tag lengths: 4, 6, 8, 10, 12, 14, 16.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004472 if (tag_len < 4 || tag_len > 16 || tag_len % 2) {
4473 return PSA_ERROR_INVALID_ARGUMENT;
4474 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01004475 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02004476#endif /* PSA_WANT_ALG_CCM */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004477
Przemek Stekiel86679c72022-10-06 17:06:56 +02004478#if defined(PSA_WANT_ALG_GCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004479 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_GCM, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004480 /* GCM allows the following tag lengths: 4, 8, 12, 13, 14, 15, 16. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004481 if (tag_len != 4 && tag_len != 8 && (tag_len < 12 || tag_len > 16)) {
4482 return PSA_ERROR_INVALID_ARGUMENT;
4483 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01004484 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02004485#endif /* PSA_WANT_ALG_GCM */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004486
Przemek Stekiel86679c72022-10-06 17:06:56 +02004487#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Gilles Peskine449bd832023-01-11 14:50:10 +01004488 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CHACHA20_POLY1305, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004489 /* We only support the default tag length. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004490 if (tag_len != 16) {
4491 return PSA_ERROR_INVALID_ARGUMENT;
4492 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01004493 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02004494#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004495
4496 default:
4497 (void) tag_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004498 return PSA_ERROR_NOT_SUPPORTED;
Andrzej Kurekf8816012021-12-19 17:00:12 +01004499 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004500 return PSA_SUCCESS;
Andrzej Kurekf8816012021-12-19 17:00:12 +01004501}
4502
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004503/* Set the key for a multipart authenticated operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004504static psa_status_t psa_aead_setup(psa_aead_operation_t *operation,
4505 int is_encrypt,
4506 mbedtls_svc_key_id_t key,
4507 psa_algorithm_t alg)
Paul Elliottc2b71442021-06-24 18:17:52 +01004508{
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004509 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4510 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
4511 psa_key_slot_t *slot = NULL;
4512 psa_key_usage_t key_usage = 0;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004513 psa_key_attributes_t attributes;
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004514
Gilles Peskine449bd832023-01-11 14:50:10 +01004515 status = psa_aead_check_algorithm(alg);
4516 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004517 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004518 }
Paul Elliottc2b71442021-06-24 18:17:52 +01004519
Gilles Peskine449bd832023-01-11 14:50:10 +01004520 if (operation->id != 0) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004521 status = PSA_ERROR_BAD_STATE;
4522 goto exit;
Paul Elliottc2b71442021-06-24 18:17:52 +01004523 }
4524
Gilles Peskine449bd832023-01-11 14:50:10 +01004525 if (operation->nonce_set || operation->lengths_set ||
4526 operation->ad_started || operation->body_started) {
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 (is_encrypt) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004532 key_usage = PSA_KEY_USAGE_ENCRYPT;
Gilles Peskine449bd832023-01-11 14:50:10 +01004533 } else {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004534 key_usage = PSA_KEY_USAGE_DECRYPT;
Gilles Peskine449bd832023-01-11 14:50:10 +01004535 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004536
Gilles Peskine449bd832023-01-11 14:50:10 +01004537 status = psa_get_and_lock_key_slot_with_policy(key, &slot, key_usage,
4538 alg);
4539 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004540 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004541 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004542
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004543 attributes = (psa_key_attributes_t) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004544 .core = slot->attr
4545 };
4546
Gilles Peskine449bd832023-01-11 14:50:10 +01004547 if ((status = psa_validate_tag_length(alg)) != PSA_SUCCESS) {
Przemek Stekiel6ab50762022-10-08 17:54:30 +02004548 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004549 }
Przemek Stekiel6ab50762022-10-08 17:54:30 +02004550
Gilles Peskine449bd832023-01-11 14:50:10 +01004551 if (is_encrypt) {
4552 status = psa_driver_wrapper_aead_encrypt_setup(operation,
4553 &attributes,
4554 slot->key.data,
4555 slot->key.bytes,
4556 alg);
4557 } else {
4558 status = psa_driver_wrapper_aead_decrypt_setup(operation,
4559 &attributes,
4560 slot->key.data,
4561 slot->key.bytes,
4562 alg);
4563 }
4564 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004565 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004566 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004567
Gilles Peskine449bd832023-01-11 14:50:10 +01004568 operation->key_type = psa_get_key_type(&attributes);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004569
4570exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004571 unlock_status = psa_unlock_key_slot(slot);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004572
Gilles Peskine449bd832023-01-11 14:50:10 +01004573 if (status == PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004574 status = unlock_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01004575 operation->alg = psa_aead_get_base_algorithm(alg);
Paul Elliottd9343f22021-08-23 18:59:49 +01004576 operation->is_encrypt = is_encrypt;
Gilles Peskine449bd832023-01-11 14:50:10 +01004577 } else {
4578 psa_aead_abort(operation);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004579 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004580
Gilles Peskine449bd832023-01-11 14:50:10 +01004581 return status;
Paul Elliottc2b71442021-06-24 18:17:52 +01004582}
4583
Paul Elliott302ff6b2021-04-20 18:10:30 +01004584/* Set the key for a multipart authenticated encryption operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004585psa_status_t psa_aead_encrypt_setup(psa_aead_operation_t *operation,
4586 mbedtls_svc_key_id_t key,
4587 psa_algorithm_t alg)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004588{
Gilles Peskine449bd832023-01-11 14:50:10 +01004589 return psa_aead_setup(operation, 1, key, alg);
Paul Elliott302ff6b2021-04-20 18:10:30 +01004590}
4591
4592/* Set the key for a multipart authenticated decryption operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004593psa_status_t psa_aead_decrypt_setup(psa_aead_operation_t *operation,
4594 mbedtls_svc_key_id_t key,
4595 psa_algorithm_t alg)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004596{
Gilles Peskine449bd832023-01-11 14:50:10 +01004597 return psa_aead_setup(operation, 0, key, alg);
Paul Elliott302ff6b2021-04-20 18:10:30 +01004598}
4599
4600/* Generate a random nonce / IV for multipart AEAD operation */
Gilles Peskine449bd832023-01-11 14:50:10 +01004601psa_status_t psa_aead_generate_nonce(psa_aead_operation_t *operation,
4602 uint8_t *nonce,
4603 size_t nonce_size,
4604 size_t *nonce_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004605{
4606 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Croncae59092021-11-26 18:53:58 +01004607 uint8_t local_nonce[PSA_AEAD_NONCE_MAX_SIZE];
Sergeybef1f632023-03-06 15:25:06 -07004608 size_t required_nonce_size = 0;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004609
Paul Elliott8eb9daf2021-06-04 16:42:21 +01004610 *nonce_length = 0;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004611
Gilles Peskine449bd832023-01-11 14:50:10 +01004612 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004613 status = PSA_ERROR_BAD_STATE;
4614 goto exit;
4615 }
4616
Gilles Peskine449bd832023-01-11 14:50:10 +01004617 if (operation->nonce_set || !operation->is_encrypt) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004618 status = PSA_ERROR_BAD_STATE;
4619 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004620 }
4621
Paul Elliotte193ea82021-10-01 13:00:16 +01004622 /* For CCM, this size may not be correct according to the PSA
4623 * specification. The PSA Crypto 1.0.1 specification states:
4624 *
4625 * CCM encodes the plaintext length pLen in L octets, with L the smallest
4626 * integer >= 2 where pLen < 2^(8L). The nonce length is then 15 - L bytes.
4627 *
4628 * However this restriction that L has to be the smallest integer is not
4629 * applied in practice, and it is not implementable here since the
4630 * plaintext length may or may not be known at this time. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004631 required_nonce_size = PSA_AEAD_NONCE_LENGTH(operation->key_type,
4632 operation->alg);
4633 if (nonce_size < required_nonce_size) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004634 status = PSA_ERROR_BUFFER_TOO_SMALL;
4635 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004636 }
4637
Gilles Peskine449bd832023-01-11 14:50:10 +01004638 status = psa_generate_random(local_nonce, required_nonce_size);
4639 if (status != PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004640 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004641 }
Paul Elliott302ff6b2021-04-20 18:10:30 +01004642
Gilles Peskine449bd832023-01-11 14:50:10 +01004643 status = psa_aead_set_nonce(operation, local_nonce, required_nonce_size);
Paul Elliott302ff6b2021-04-20 18:10:30 +01004644
Paul Elliott39dc6b82021-05-11 19:16:09 +01004645exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004646 if (status == PSA_SUCCESS) {
4647 memcpy(nonce, local_nonce, required_nonce_size);
Paul Elliott39dc6b82021-05-11 19:16:09 +01004648 *nonce_length = required_nonce_size;
Gilles Peskine449bd832023-01-11 14:50:10 +01004649 } else {
4650 psa_aead_abort(operation);
Ronald Croncae59092021-11-26 18:53:58 +01004651 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01004652
Gilles Peskine449bd832023-01-11 14:50:10 +01004653 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004654}
4655
4656/* Set the nonce for a multipart authenticated encryption or decryption
4657 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004658psa_status_t psa_aead_set_nonce(psa_aead_operation_t *operation,
4659 const uint8_t *nonce,
4660 size_t nonce_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004661{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004662 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4663
Gilles Peskine449bd832023-01-11 14:50:10 +01004664 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004665 status = PSA_ERROR_BAD_STATE;
4666 goto exit;
4667 }
4668
Gilles Peskine449bd832023-01-11 14:50:10 +01004669 if (operation->nonce_set) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004670 status = PSA_ERROR_BAD_STATE;
4671 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004672 }
4673
Gilles Peskine449bd832023-01-11 14:50:10 +01004674 status = psa_aead_check_nonce_length(operation->alg, nonce_length);
4675 if (status != PSA_SUCCESS) {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004676 status = PSA_ERROR_INVALID_ARGUMENT;
4677 goto exit;
Paul Elliott4ed1ed12021-09-27 18:09:28 +01004678 }
Paul Elliott1a98aca2021-05-20 18:24:07 +01004679
Gilles Peskine449bd832023-01-11 14:50:10 +01004680 status = psa_driver_wrapper_aead_set_nonce(operation, nonce,
4681 nonce_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004682
Paul Elliott39dc6b82021-05-11 19:16:09 +01004683exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004684 if (status == PSA_SUCCESS) {
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004685 operation->nonce_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004686 } else {
4687 psa_aead_abort(operation);
4688 }
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004689
Gilles Peskine449bd832023-01-11 14:50:10 +01004690 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004691}
4692
4693/* Declare the lengths of the message and additional data for multipart AEAD. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004694psa_status_t psa_aead_set_lengths(psa_aead_operation_t *operation,
4695 size_t ad_length,
4696 size_t plaintext_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004697{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004698 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4699
Gilles Peskine449bd832023-01-11 14:50:10 +01004700 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004701 status = PSA_ERROR_BAD_STATE;
4702 goto exit;
4703 }
4704
Gilles Peskine449bd832023-01-11 14:50:10 +01004705 if (operation->lengths_set || operation->ad_started ||
4706 operation->body_started) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004707 status = PSA_ERROR_BAD_STATE;
4708 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004709 }
4710
Gilles Peskine449bd832023-01-11 14:50:10 +01004711 switch (operation->alg) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004712#if defined(PSA_WANT_ALG_GCM)
4713 case PSA_ALG_GCM:
4714 /* Lengths can only be too large for GCM if size_t is bigger than 32
Gilles Peskine449bd832023-01-11 14:50:10 +01004715 * bits. Without the guard this code will generate warnings on 32bit
4716 * builds. */
Paul Elliott325d3742021-09-27 17:56:28 +01004717#if SIZE_MAX > UINT32_MAX
Gilles Peskine449bd832023-01-11 14:50:10 +01004718 if (((uint64_t) ad_length) >> 61 != 0 ||
4719 ((uint64_t) plaintext_length) > 0xFFFFFFFE0ull) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004720 status = PSA_ERROR_INVALID_ARGUMENT;
4721 goto exit;
4722 }
Paul Elliott325d3742021-09-27 17:56:28 +01004723#endif
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004724 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004725#endif /* PSA_WANT_ALG_GCM */
4726#if defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004727 case PSA_ALG_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01004728 if (ad_length > 0xFF00) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004729 status = PSA_ERROR_INVALID_ARGUMENT;
4730 goto exit;
4731 }
4732 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004733#endif /* PSA_WANT_ALG_CCM */
4734#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004735 case PSA_ALG_CHACHA20_POLY1305:
4736 /* No length restrictions for ChaChaPoly. */
4737 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004738#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004739 default:
4740 break;
4741 }
Paul Elliott325d3742021-09-27 17:56:28 +01004742
Gilles Peskine449bd832023-01-11 14:50:10 +01004743 status = psa_driver_wrapper_aead_set_lengths(operation, ad_length,
4744 plaintext_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004745
Paul Elliott39dc6b82021-05-11 19:16:09 +01004746exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004747 if (status == PSA_SUCCESS) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01004748 operation->ad_remaining = ad_length;
4749 operation->body_remaining = plaintext_length;
Paul Elliott39dc6b82021-05-11 19:16:09 +01004750 operation->lengths_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004751 } else {
4752 psa_aead_abort(operation);
Paul Elliottee4ffe02021-05-20 17:25:06 +01004753 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01004754
Gilles Peskine449bd832023-01-11 14:50:10 +01004755 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004756}
Paul Elliott3d7d52c2021-09-01 10:33:14 +01004757
4758/* Pass additional data to an active multipart AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004759psa_status_t psa_aead_update_ad(psa_aead_operation_t *operation,
4760 const uint8_t *input,
4761 size_t input_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004762{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004763 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4764
Gilles Peskine449bd832023-01-11 14:50:10 +01004765 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004766 status = PSA_ERROR_BAD_STATE;
4767 goto exit;
4768 }
4769
Gilles Peskine449bd832023-01-11 14:50:10 +01004770 if (!operation->nonce_set || operation->body_started) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004771 status = PSA_ERROR_BAD_STATE;
4772 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004773 }
4774
Gilles Peskine449bd832023-01-11 14:50:10 +01004775 if (operation->lengths_set) {
4776 if (operation->ad_remaining < input_length) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01004777 status = PSA_ERROR_INVALID_ARGUMENT;
4778 goto exit;
4779 }
4780
4781 operation->ad_remaining -= input_length;
4782 }
Paul Elliotte193ea82021-10-01 13:00:16 +01004783#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004784 else if (operation->alg == PSA_ALG_CCM) {
Paul Elliotte193ea82021-10-01 13:00:16 +01004785 status = PSA_ERROR_BAD_STATE;
4786 goto exit;
4787 }
4788#endif /* PSA_WANT_ALG_CCM */
Paul Elliottee4ffe02021-05-20 17:25:06 +01004789
Gilles Peskine449bd832023-01-11 14:50:10 +01004790 status = psa_driver_wrapper_aead_update_ad(operation, input,
4791 input_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004792
Paul Elliott39dc6b82021-05-11 19:16:09 +01004793exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004794 if (status == PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004795 operation->ad_started = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004796 } else {
4797 psa_aead_abort(operation);
4798 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01004799
Gilles Peskine449bd832023-01-11 14:50:10 +01004800 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004801}
4802
4803/* Encrypt or decrypt a message fragment in an active multipart AEAD
4804 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004805psa_status_t psa_aead_update(psa_aead_operation_t *operation,
4806 const uint8_t *input,
4807 size_t input_length,
4808 uint8_t *output,
4809 size_t output_size,
4810 size_t *output_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004811{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004812 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004813
4814 *output_length = 0;
4815
Gilles Peskine449bd832023-01-11 14:50:10 +01004816 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004817 status = PSA_ERROR_BAD_STATE;
4818 goto exit;
4819 }
4820
Gilles Peskine449bd832023-01-11 14:50:10 +01004821 if (!operation->nonce_set) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004822 status = PSA_ERROR_BAD_STATE;
4823 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004824 }
4825
Gilles Peskine449bd832023-01-11 14:50:10 +01004826 if (operation->lengths_set) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01004827 /* Additional data length was supplied, but not all the additional
4828 data was supplied.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004829 if (operation->ad_remaining != 0) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01004830 status = PSA_ERROR_INVALID_ARGUMENT;
4831 goto exit;
4832 }
4833
4834 /* Too much data provided. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004835 if (operation->body_remaining < input_length) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01004836 status = PSA_ERROR_INVALID_ARGUMENT;
4837 goto exit;
4838 }
4839
4840 operation->body_remaining -= input_length;
4841 }
Paul Elliotte193ea82021-10-01 13:00:16 +01004842#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004843 else if (operation->alg == PSA_ALG_CCM) {
Paul Elliotte193ea82021-10-01 13:00:16 +01004844 status = PSA_ERROR_BAD_STATE;
4845 goto exit;
4846 }
4847#endif /* PSA_WANT_ALG_CCM */
Paul Elliottee4ffe02021-05-20 17:25:06 +01004848
Gilles Peskine449bd832023-01-11 14:50:10 +01004849 status = psa_driver_wrapper_aead_update(operation, input, input_length,
4850 output, output_size,
4851 output_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004852
Paul Elliott39dc6b82021-05-11 19:16:09 +01004853exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004854 if (status == PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004855 operation->body_started = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004856 } else {
4857 psa_aead_abort(operation);
4858 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01004859
Gilles Peskine449bd832023-01-11 14:50:10 +01004860 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004861}
4862
Gilles Peskine449bd832023-01-11 14:50:10 +01004863static psa_status_t psa_aead_final_checks(const psa_aead_operation_t *operation)
Paul Elliottad53dcc2021-06-23 08:50:14 +01004864{
Gilles Peskine449bd832023-01-11 14:50:10 +01004865 if (operation->id == 0 || !operation->nonce_set) {
4866 return PSA_ERROR_BAD_STATE;
4867 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01004868
Gilles Peskine449bd832023-01-11 14:50:10 +01004869 if (operation->lengths_set && (operation->ad_remaining != 0 ||
4870 operation->body_remaining != 0)) {
4871 return PSA_ERROR_INVALID_ARGUMENT;
4872 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01004873
Gilles Peskine449bd832023-01-11 14:50:10 +01004874 return PSA_SUCCESS;
Paul Elliottad53dcc2021-06-23 08:50:14 +01004875}
4876
Paul Elliott302ff6b2021-04-20 18:10:30 +01004877/* Finish encrypting a message in a multipart AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004878psa_status_t psa_aead_finish(psa_aead_operation_t *operation,
4879 uint8_t *ciphertext,
4880 size_t ciphertext_size,
4881 size_t *ciphertext_length,
4882 uint8_t *tag,
4883 size_t tag_size,
4884 size_t *tag_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004885{
Paul Elliott39dc6b82021-05-11 19:16:09 +01004886 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4887
Paul Elliott302ff6b2021-04-20 18:10:30 +01004888 *ciphertext_length = 0;
Paul Elliottf88a5652021-06-22 17:53:45 +01004889 *tag_length = tag_size;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004890
Gilles Peskine449bd832023-01-11 14:50:10 +01004891 status = psa_aead_final_checks(operation);
4892 if (status != PSA_SUCCESS) {
Paul Elliottad53dcc2021-06-23 08:50:14 +01004893 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004894 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01004895
Gilles Peskine449bd832023-01-11 14:50:10 +01004896 if (!operation->is_encrypt) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004897 status = PSA_ERROR_BAD_STATE;
4898 goto exit;
4899 }
4900
Gilles Peskine449bd832023-01-11 14:50:10 +01004901 status = psa_driver_wrapper_aead_finish(operation, ciphertext,
4902 ciphertext_size,
4903 ciphertext_length,
4904 tag, tag_size, tag_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004905
Paul Elliott39dc6b82021-05-11 19:16:09 +01004906exit:
Paul Elliottdc42ca82023-02-24 18:11:59 +00004907
4908
Paul Elliottf47b0952021-05-21 18:02:33 +01004909 /* In case the operation fails and the user fails to check for failure or
Paul Elliott4c916e82021-09-19 18:34:50 +01004910 * the zero tag size, make sure the tag is set to something implausible.
4911 * Even if the operation succeeds, make sure we clear the rest of the
4912 * buffer to prevent potential leakage of anything previously placed in
4913 * the same buffer.*/
Paul Elliottdc42ca82023-02-24 18:11:59 +00004914 psa_wipe_tag_output_buffer(tag, status, tag_size, *tag_length);
Paul Elliottf47b0952021-05-21 18:02:33 +01004915
Gilles Peskine449bd832023-01-11 14:50:10 +01004916 psa_aead_abort(operation);
Paul Elliott39dc6b82021-05-11 19:16:09 +01004917
Gilles Peskine449bd832023-01-11 14:50:10 +01004918 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004919}
4920
4921/* Finish authenticating and decrypting a message in a multipart AEAD
4922 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004923psa_status_t psa_aead_verify(psa_aead_operation_t *operation,
4924 uint8_t *plaintext,
4925 size_t plaintext_size,
4926 size_t *plaintext_length,
4927 const uint8_t *tag,
4928 size_t tag_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004929{
Paul Elliott39dc6b82021-05-11 19:16:09 +01004930 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4931
Paul Elliott302ff6b2021-04-20 18:10:30 +01004932 *plaintext_length = 0;
4933
Gilles Peskine449bd832023-01-11 14:50:10 +01004934 status = psa_aead_final_checks(operation);
4935 if (status != PSA_SUCCESS) {
Paul Elliottad53dcc2021-06-23 08:50:14 +01004936 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004937 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01004938
Gilles Peskine449bd832023-01-11 14:50:10 +01004939 if (operation->is_encrypt) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004940 status = PSA_ERROR_BAD_STATE;
4941 goto exit;
4942 }
4943
Gilles Peskine449bd832023-01-11 14:50:10 +01004944 status = psa_driver_wrapper_aead_verify(operation, plaintext,
4945 plaintext_size,
4946 plaintext_length,
4947 tag, tag_length);
Paul Elliott39dc6b82021-05-11 19:16:09 +01004948
4949exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004950 psa_aead_abort(operation);
Paul Elliott39dc6b82021-05-11 19:16:09 +01004951
Gilles Peskine449bd832023-01-11 14:50:10 +01004952 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004953}
4954
4955/* Abort an AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004956psa_status_t psa_aead_abort(psa_aead_operation_t *operation)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004957{
4958 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4959
Gilles Peskine449bd832023-01-11 14:50:10 +01004960 if (operation->id == 0) {
Paul Elliott302ff6b2021-04-20 18:10:30 +01004961 /* The object has (apparently) been initialized but it is not (yet)
4962 * in use. It's ok to call abort on such an object, and there's
4963 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004964 return PSA_SUCCESS;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004965 }
4966
Gilles Peskine449bd832023-01-11 14:50:10 +01004967 status = psa_driver_wrapper_aead_abort(operation);
Paul Elliott302ff6b2021-04-20 18:10:30 +01004968
Gilles Peskine449bd832023-01-11 14:50:10 +01004969 memset(operation, 0, sizeof(*operation));
Paul Elliott302ff6b2021-04-20 18:10:30 +01004970
Gilles Peskine449bd832023-01-11 14:50:10 +01004971 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004972}
4973
Gilles Peskinee59236f2018-01-27 23:32:46 +01004974/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02004975/* Generators */
4976/****************************************************************/
4977
Przemek Stekiel69c46792022-06-10 12:59:51 +02004978#if defined(BUILTIN_ALG_ANY_HKDF) || \
John Durkop07cc04a2020-11-16 22:08:34 -08004979 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
Andrzej Kurek08d34b82022-07-29 10:00:16 -04004980 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) || \
Kusumit Ghoderaoaf0b5342023-05-03 11:58:46 +05304981 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS) || \
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05304982 defined(PSA_HAVE_SOFT_PBKDF2)
John Durkop07cc04a2020-11-16 22:08:34 -08004983#define AT_LEAST_ONE_BUILTIN_KDF
Steven Cooreman094a77e2021-05-06 17:58:36 +02004984#endif /* At least one builtin KDF */
4985
Przemek Stekiel69c46792022-06-10 12:59:51 +02004986#if defined(BUILTIN_ALG_ANY_HKDF) || \
Steven Cooreman094a77e2021-05-06 17:58:36 +02004987 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4988 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4989static psa_status_t psa_key_derivation_start_hmac(
4990 psa_mac_operation_t *operation,
4991 psa_algorithm_t hash_alg,
4992 const uint8_t *hmac_key,
Gilles Peskine449bd832023-01-11 14:50:10 +01004993 size_t hmac_key_length)
Steven Cooreman094a77e2021-05-06 17:58:36 +02004994{
4995 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4996 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01004997 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
4998 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(hmac_key_length));
4999 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_HASH);
Steven Cooreman094a77e2021-05-06 17:58:36 +02005000
Steven Cooreman72f736a2021-05-07 14:14:37 +02005001 operation->is_sign = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005002 operation->mac_size = PSA_HASH_LENGTH(hash_alg);
Steven Cooreman72f736a2021-05-07 14:14:37 +02005003
Gilles Peskine449bd832023-01-11 14:50:10 +01005004 status = psa_driver_wrapper_mac_sign_setup(operation,
5005 &attributes,
5006 hmac_key, hmac_key_length,
5007 PSA_ALG_HMAC(hash_alg));
Steven Cooreman094a77e2021-05-06 17:58:36 +02005008
Gilles Peskine449bd832023-01-11 14:50:10 +01005009 psa_reset_key_attributes(&attributes);
5010 return status;
Steven Cooreman094a77e2021-05-06 17:58:36 +02005011}
5012#endif /* KDF algorithms reliant on HMAC */
John Durkop07cc04a2020-11-16 22:08:34 -08005013
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005014#define HKDF_STATE_INIT 0 /* no input yet */
5015#define HKDF_STATE_STARTED 1 /* got salt */
5016#define HKDF_STATE_KEYED 2 /* got key */
5017#define HKDF_STATE_OUTPUT 3 /* output started */
5018
Gilles Peskinecbe66502019-05-16 16:59:18 +02005019static psa_algorithm_t psa_key_derivation_get_kdf_alg(
Gilles Peskine449bd832023-01-11 14:50:10 +01005020 const psa_key_derivation_operation_t *operation)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005021{
Gilles Peskine449bd832023-01-11 14:50:10 +01005022 if (PSA_ALG_IS_KEY_AGREEMENT(operation->alg)) {
5023 return PSA_ALG_KEY_AGREEMENT_GET_KDF(operation->alg);
5024 } else {
5025 return operation->alg;
5026 }
Gilles Peskine969c5d62019-01-16 15:53:06 +01005027}
5028
Gilles Peskine449bd832023-01-11 14:50:10 +01005029psa_status_t psa_key_derivation_abort(psa_key_derivation_operation_t *operation)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005030{
5031 psa_status_t status = PSA_SUCCESS;
Gilles Peskine449bd832023-01-11 14:50:10 +01005032 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
5033 if (kdf_alg == 0) {
Gilles Peskineeab56e42018-07-12 17:12:33 +02005034 /* The object has (apparently) been initialized but it is not
5035 * in use. It's ok to call abort on such an object, and there's
5036 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005037 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02005038#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01005039 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
5040 mbedtls_free(operation->ctx.hkdf.info);
5041 status = psa_mac_abort(&operation->ctx.hkdf.hmac);
5042 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02005043#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08005044#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5045 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005046 if (PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
5047 /* TLS-1.2 PSK-to-MS KDF uses the same core as TLS-1.2 PRF */
5048 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
5049 if (operation->ctx.tls12_prf.secret != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005050 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.secret,
Gilles Peskine449bd832023-01-11 14:50:10 +01005051 operation->ctx.tls12_prf.secret_length);
Steven Cooremana6df6042021-04-29 19:32:25 +02005052 }
5053
Gilles Peskine449bd832023-01-11 14:50:10 +01005054 if (operation->ctx.tls12_prf.seed != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005055 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.seed,
Gilles Peskine449bd832023-01-11 14:50:10 +01005056 operation->ctx.tls12_prf.seed_length);
Janos Follath6a1d2622019-06-11 10:37:28 +01005057 }
5058
Gilles Peskine449bd832023-01-11 14:50:10 +01005059 if (operation->ctx.tls12_prf.label != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005060 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.label,
Gilles Peskine449bd832023-01-11 14:50:10 +01005061 operation->ctx.tls12_prf.label_length);
Janos Follath6a1d2622019-06-11 10:37:28 +01005062 }
Przemek Stekiel6c764412022-11-22 14:05:12 +01005063#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005064 if (operation->ctx.tls12_prf.other_secret != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005065 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.other_secret,
Gilles Peskine449bd832023-01-11 14:50:10 +01005066 operation->ctx.tls12_prf.other_secret_length);
Przemek Stekiele3ee2212022-04-07 14:29:56 +02005067 }
Przemek Stekiel6c764412022-11-22 14:05:12 +01005068#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Steven Cooremana6df6042021-04-29 19:32:25 +02005069 status = PSA_SUCCESS;
Janos Follath6a1d2622019-06-11 10:37:28 +01005070
5071 /* We leave the fields Ai and output_block to be erased safely by the
5072 * mbedtls_platform_zeroize() in the end of this function. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005073 } else
John Durkop07cc04a2020-11-16 22:08:34 -08005074#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
5075 * defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005076#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005077 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
5078 mbedtls_platform_zeroize(operation->ctx.tls12_ecjpake_to_pms.data,
5079 sizeof(operation->ctx.tls12_ecjpake_to_pms.data));
5080 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005081#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS) */
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305082#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05305083 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305084 if (operation->ctx.pbkdf2.salt != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005085 mbedtls_zeroize_and_free(operation->ctx.pbkdf2.salt,
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305086 operation->ctx.pbkdf2.salt_length);
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305087 }
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305088
5089 status = PSA_SUCCESS;
5090 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305091#endif /* defined(PSA_HAVE_SOFT_PBKDF2) */
Gilles Peskineeab56e42018-07-12 17:12:33 +02005092 {
5093 status = PSA_ERROR_BAD_STATE;
5094 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005095 mbedtls_platform_zeroize(operation, sizeof(*operation));
5096 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005097}
5098
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005099psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskine449bd832023-01-11 14:50:10 +01005100 size_t *capacity)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005101{
Gilles Peskine449bd832023-01-11 14:50:10 +01005102 if (operation->alg == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005103 /* This is a blank key derivation operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005104 return PSA_ERROR_BAD_STATE;
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005105 }
5106
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005107 *capacity = operation->capacity;
Gilles Peskine449bd832023-01-11 14:50:10 +01005108 return PSA_SUCCESS;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005109}
5110
Gilles Peskine449bd832023-01-11 14:50:10 +01005111psa_status_t psa_key_derivation_set_capacity(psa_key_derivation_operation_t *operation,
5112 size_t capacity)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005113{
Gilles Peskine449bd832023-01-11 14:50:10 +01005114 if (operation->alg == 0) {
5115 return PSA_ERROR_BAD_STATE;
5116 }
5117 if (capacity > operation->capacity) {
5118 return PSA_ERROR_INVALID_ARGUMENT;
5119 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005120 operation->capacity = capacity;
Gilles Peskine449bd832023-01-11 14:50:10 +01005121 return PSA_SUCCESS;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005122}
5123
Przemek Stekiel69c46792022-06-10 12:59:51 +02005124#if defined(BUILTIN_ALG_ANY_HKDF)
Przemek Stekiel03d948c2022-05-19 11:45:20 +02005125/* Read some bytes from an HKDF-based operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005126static psa_status_t psa_key_derivation_hkdf_read(psa_hkdf_key_derivation_t *hkdf,
5127 psa_algorithm_t kdf_alg,
5128 uint8_t *output,
5129 size_t output_length)
Gilles Peskinebef7f142018-07-12 17:22:21 +02005130{
Gilles Peskine449bd832023-01-11 14:50:10 +01005131 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
5132 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Steven Cooremand1ed1d92021-04-29 19:11:25 +02005133 size_t hmac_output_length;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005134 psa_status_t status;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005135#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01005136 const uint8_t last_block = PSA_ALG_IS_HKDF_EXTRACT(kdf_alg) ? 0 : 0xff;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005137#else
5138 const uint8_t last_block = 0xff;
5139#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskinebef7f142018-07-12 17:22:21 +02005140
Gilles Peskine449bd832023-01-11 14:50:10 +01005141 if (hkdf->state < HKDF_STATE_KEYED ||
5142 (!hkdf->info_set
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005143#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01005144 && !PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005145#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01005146 )) {
5147 return PSA_ERROR_BAD_STATE;
5148 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005149 hkdf->state = HKDF_STATE_OUTPUT;
5150
Gilles Peskine449bd832023-01-11 14:50:10 +01005151 while (output_length != 0) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005152 /* Copy what remains of the current block */
5153 uint8_t n = hash_length - hkdf->offset_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005154 if (n > output_length) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005155 n = (uint8_t) output_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01005156 }
5157 memcpy(output, hkdf->output_block + hkdf->offset_in_block, n);
Gilles Peskinebef7f142018-07-12 17:22:21 +02005158 output += n;
5159 output_length -= n;
5160 hkdf->offset_in_block += n;
Gilles Peskine449bd832023-01-11 14:50:10 +01005161 if (output_length == 0) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005162 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01005163 }
Przemek Stekiel03d948c2022-05-19 11:45:20 +02005164 /* We can't be wanting more output after the last block, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005165 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005166 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02005167 * object was corrupted or if this function is called directly
5168 * inside the library. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005169 if (hkdf->block_number == last_block) {
5170 return PSA_ERROR_BAD_STATE;
5171 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02005172
5173 /* We need a new block */
5174 ++hkdf->block_number;
5175 hkdf->offset_in_block = 0;
Steven Cooremand1ed1d92021-04-29 19:11:25 +02005176
Gilles Peskine449bd832023-01-11 14:50:10 +01005177 status = psa_key_derivation_start_hmac(&hkdf->hmac,
5178 hash_alg,
5179 hkdf->prk,
5180 hash_length);
5181 if (status != PSA_SUCCESS) {
5182 return status;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005183 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005184
5185 if (hkdf->block_number != 1) {
5186 status = psa_mac_update(&hkdf->hmac,
5187 hkdf->output_block,
5188 hash_length);
5189 if (status != PSA_SUCCESS) {
5190 return status;
5191 }
5192 }
5193 status = psa_mac_update(&hkdf->hmac,
5194 hkdf->info,
5195 hkdf->info_length);
5196 if (status != PSA_SUCCESS) {
5197 return status;
5198 }
5199 status = psa_mac_update(&hkdf->hmac,
5200 &hkdf->block_number, 1);
5201 if (status != PSA_SUCCESS) {
5202 return status;
5203 }
5204 status = psa_mac_sign_finish(&hkdf->hmac,
5205 hkdf->output_block,
5206 sizeof(hkdf->output_block),
5207 &hmac_output_length);
5208 if (status != PSA_SUCCESS) {
5209 return status;
5210 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02005211 }
5212
Gilles Peskine449bd832023-01-11 14:50:10 +01005213 return PSA_SUCCESS;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005214}
Przemek Stekiel69c46792022-06-10 12:59:51 +02005215#endif /* BUILTIN_ALG_ANY_HKDF */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005216
John Durkop07cc04a2020-11-16 22:08:34 -08005217#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5218 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follath7742fee2019-06-17 12:58:10 +01005219static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
5220 psa_tls12_prf_key_derivation_t *tls12_prf,
Gilles Peskine449bd832023-01-11 14:50:10 +01005221 psa_algorithm_t alg)
Janos Follath7742fee2019-06-17 12:58:10 +01005222{
Gilles Peskine449bd832023-01-11 14:50:10 +01005223 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(alg);
5224 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Steven Cooremana6df6042021-04-29 19:32:25 +02005225 psa_mac_operation_t hmac = PSA_MAC_OPERATION_INIT;
5226 size_t hmac_output_length;
Janos Follathea29bfb2019-06-19 12:21:20 +01005227 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005228
Janos Follath7742fee2019-06-17 12:58:10 +01005229 /* We can't be wanting more output after block 0xff, otherwise
5230 * the capacity check in psa_key_derivation_output_bytes() would have
5231 * prevented this call. It could happen only if the operation
5232 * object was corrupted or if this function is called directly
5233 * inside the library. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005234 if (tls12_prf->block_number == 0xff) {
5235 return PSA_ERROR_CORRUPTION_DETECTED;
5236 }
Janos Follath7742fee2019-06-17 12:58:10 +01005237
5238 /* We need a new block */
5239 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01005240 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01005241
5242 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
5243 *
5244 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
5245 *
5246 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
5247 * HMAC_hash(secret, A(2) + seed) +
5248 * HMAC_hash(secret, A(3) + seed) + ...
5249 *
5250 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01005251 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01005252 *
Janos Follathea29bfb2019-06-19 12:21:20 +01005253 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01005254 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01005255 * is currently extracted as `output_block` and where i is
5256 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01005257 */
5258
Gilles Peskine449bd832023-01-11 14:50:10 +01005259 status = psa_key_derivation_start_hmac(&hmac,
5260 hash_alg,
5261 tls12_prf->secret,
5262 tls12_prf->secret_length);
5263 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005264 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005265 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005266
5267 /* Calculate A(i) where i = tls12_prf->block_number. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005268 if (tls12_prf->block_number == 1) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005269 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
5270 * the variable seed and in this instance means it in the context of the
5271 * P_hash function, where seed = label + seed.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01005272 status = psa_mac_update(&hmac,
5273 tls12_prf->label,
5274 tls12_prf->label_length);
5275 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005276 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005277 }
5278 status = psa_mac_update(&hmac,
5279 tls12_prf->seed,
5280 tls12_prf->seed_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 } else {
Janos Follathea29bfb2019-06-19 12:21:20 +01005285 /* A(i) = HMAC_hash(secret, A(i-1)) */
Gilles Peskine449bd832023-01-11 14:50:10 +01005286 status = psa_mac_update(&hmac, tls12_prf->Ai, hash_length);
5287 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005288 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005289 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005290 }
5291
Gilles Peskine449bd832023-01-11 14:50:10 +01005292 status = psa_mac_sign_finish(&hmac,
5293 tls12_prf->Ai, hash_length,
5294 &hmac_output_length);
5295 if (hmac_output_length != hash_length) {
Steven Cooremana6df6042021-04-29 19:32:25 +02005296 status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01005297 }
5298 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005299 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005300 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005301
5302 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
Gilles Peskine449bd832023-01-11 14:50:10 +01005303 status = psa_key_derivation_start_hmac(&hmac,
5304 hash_alg,
5305 tls12_prf->secret,
5306 tls12_prf->secret_length);
5307 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005308 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005309 }
5310 status = psa_mac_update(&hmac, tls12_prf->Ai, hash_length);
5311 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005312 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005313 }
5314 status = psa_mac_update(&hmac, tls12_prf->label, tls12_prf->label_length);
5315 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005316 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005317 }
5318 status = psa_mac_update(&hmac, tls12_prf->seed, tls12_prf->seed_length);
5319 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005320 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005321 }
5322 status = psa_mac_sign_finish(&hmac,
5323 tls12_prf->output_block, hash_length,
5324 &hmac_output_length);
5325 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005326 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005327 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005328
Janos Follath7742fee2019-06-17 12:58:10 +01005329
5330cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01005331 cleanup_status = psa_mac_abort(&hmac);
5332 if (status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005333 status = cleanup_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01005334 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005335
Gilles Peskine449bd832023-01-11 14:50:10 +01005336 return status;
Janos Follath7742fee2019-06-17 12:58:10 +01005337}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005338
Janos Follath844eb0e2019-06-19 12:10:49 +01005339static psa_status_t psa_key_derivation_tls12_prf_read(
5340 psa_tls12_prf_key_derivation_t *tls12_prf,
5341 psa_algorithm_t alg,
5342 uint8_t *output,
Gilles Peskine449bd832023-01-11 14:50:10 +01005343 size_t output_length)
Janos Follath844eb0e2019-06-19 12:10:49 +01005344{
Gilles Peskine449bd832023-01-11 14:50:10 +01005345 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH(alg);
5346 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Janos Follath844eb0e2019-06-19 12:10:49 +01005347 psa_status_t status;
5348 uint8_t offset, length;
5349
Gilles Peskine449bd832023-01-11 14:50:10 +01005350 switch (tls12_prf->state) {
Gilles Peskineb1edaec2021-06-11 22:41:46 +02005351 case PSA_TLS12_PRF_STATE_LABEL_SET:
5352 tls12_prf->state = PSA_TLS12_PRF_STATE_OUTPUT;
5353 break;
5354 case PSA_TLS12_PRF_STATE_OUTPUT:
5355 break;
5356 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005357 return PSA_ERROR_BAD_STATE;
Gilles Peskineb1edaec2021-06-11 22:41:46 +02005358 }
5359
Gilles Peskine449bd832023-01-11 14:50:10 +01005360 while (output_length != 0) {
Janos Follath844eb0e2019-06-19 12:10:49 +01005361 /* Check if we have fully processed the current block. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005362 if (tls12_prf->left_in_block == 0) {
5363 status = psa_key_derivation_tls12_prf_generate_next_block(tls12_prf,
5364 alg);
5365 if (status != PSA_SUCCESS) {
5366 return status;
5367 }
Janos Follath844eb0e2019-06-19 12:10:49 +01005368
5369 continue;
5370 }
5371
Gilles Peskine449bd832023-01-11 14:50:10 +01005372 if (tls12_prf->left_in_block > output_length) {
Janos Follath844eb0e2019-06-19 12:10:49 +01005373 length = (uint8_t) output_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01005374 } else {
Janos Follath844eb0e2019-06-19 12:10:49 +01005375 length = tls12_prf->left_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005376 }
Janos Follath844eb0e2019-06-19 12:10:49 +01005377
5378 offset = hash_length - tls12_prf->left_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005379 memcpy(output, tls12_prf->output_block + offset, length);
Janos Follath844eb0e2019-06-19 12:10:49 +01005380 output += length;
5381 output_length -= length;
5382 tls12_prf->left_in_block -= length;
5383 }
5384
Gilles Peskine449bd832023-01-11 14:50:10 +01005385 return PSA_SUCCESS;
Janos Follath844eb0e2019-06-19 12:10:49 +01005386}
John Durkop07cc04a2020-11-16 22:08:34 -08005387#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
5388 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskinebef7f142018-07-12 17:22:21 +02005389
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005390#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
5391static psa_status_t psa_key_derivation_tls12_ecjpake_to_pms_read(
5392 psa_tls12_ecjpake_to_pms_t *ecjpake,
5393 uint8_t *output,
Gilles Peskine449bd832023-01-11 14:50:10 +01005394 size_t output_length)
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005395{
5396 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Andrzej Kurek5603efd2022-09-26 10:49:16 -04005397 size_t output_size = 0;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005398
Gilles Peskine449bd832023-01-11 14:50:10 +01005399 if (output_length != 32) {
5400 return PSA_ERROR_INVALID_ARGUMENT;
5401 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005402
Gilles Peskine449bd832023-01-11 14:50:10 +01005403 status = psa_hash_compute(PSA_ALG_SHA_256, ecjpake->data,
5404 PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE, output, output_length,
5405 &output_size);
5406 if (status != PSA_SUCCESS) {
5407 return status;
5408 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005409
Gilles Peskine449bd832023-01-11 14:50:10 +01005410 if (output_size != output_length) {
5411 return PSA_ERROR_GENERIC_ERROR;
5412 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005413
Gilles Peskine449bd832023-01-11 14:50:10 +01005414 return PSA_SUCCESS;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005415}
5416#endif
5417
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305418#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305419static psa_status_t psa_key_derivation_pbkdf2_generate_block(
5420 psa_pbkdf2_key_derivation_t *pbkdf2,
5421 psa_algorithm_t prf_alg,
5422 uint8_t prf_output_length,
5423 psa_key_attributes_t *attributes)
5424{
5425 psa_status_t status;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305426 psa_mac_operation_t mac_operation = PSA_MAC_OPERATION_INIT;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305427 size_t mac_output_length;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305428 uint8_t U_i[PSA_MAC_MAX_SIZE];
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305429 uint8_t *U_accumulator = pbkdf2->output_block;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305430 uint64_t i;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305431 uint8_t block_counter[4];
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305432
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305433 mac_operation.is_sign = 1;
5434 mac_operation.mac_size = prf_output_length;
5435 MBEDTLS_PUT_UINT32_BE(pbkdf2->block_number, block_counter, 0);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305436
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305437 status = psa_driver_wrapper_mac_sign_setup(&mac_operation,
5438 attributes,
5439 pbkdf2->password,
5440 pbkdf2->password_length,
5441 prf_alg);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305442 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305443 goto cleanup;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305444 }
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305445 status = psa_mac_update(&mac_operation, pbkdf2->salt, pbkdf2->salt_length);
5446 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305447 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305448 }
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305449 status = psa_mac_update(&mac_operation, block_counter, sizeof(block_counter));
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305450 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305451 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305452 }
5453 status = psa_mac_sign_finish(&mac_operation, U_i, sizeof(U_i),
5454 &mac_output_length);
5455 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305456 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305457 }
5458
5459 if (mac_output_length != prf_output_length) {
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305460 status = PSA_ERROR_CORRUPTION_DETECTED;
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305461 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305462 }
5463
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305464 memcpy(U_accumulator, U_i, prf_output_length);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305465
5466 for (i = 1; i < pbkdf2->input_cost; i++) {
Kusumit Ghoderao4536bb62023-06-22 15:42:59 +05305467 /* We are passing prf_output_length as mac_size because the driver
5468 * function directly sets mac_output_length as mac_size upon success.
Kusumit Ghoderao5f3345a2023-07-27 21:21:38 +05305469 * See https://github.com/Mbed-TLS/mbedtls/issues/7801 */
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305470 status = psa_driver_wrapper_mac_compute(attributes,
5471 pbkdf2->password,
5472 pbkdf2->password_length,
5473 prf_alg, U_i, prf_output_length,
Kusumit Ghoderao4536bb62023-06-22 15:42:59 +05305474 U_i, prf_output_length,
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305475 &mac_output_length);
5476 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305477 goto cleanup;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305478 }
5479
Kusumit Ghoderao109ee3d2023-06-08 16:36:45 +05305480 mbedtls_xor(U_accumulator, U_accumulator, U_i, prf_output_length);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305481 }
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305482
5483cleanup:
5484 /* Zeroise buffers to clear sensitive data from memory. */
5485 mbedtls_platform_zeroize(U_i, PSA_MAC_MAX_SIZE);
5486 return status;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305487}
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05305488
5489static psa_status_t psa_key_derivation_pbkdf2_read(
5490 psa_pbkdf2_key_derivation_t *pbkdf2,
5491 psa_algorithm_t kdf_alg,
5492 uint8_t *output,
5493 size_t output_length)
5494{
5495 psa_status_t status;
5496 psa_algorithm_t prf_alg;
5497 uint8_t prf_output_length;
5498 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
5499 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(pbkdf2->password_length));
5500 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
5501
5502 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
5503 prf_alg = PSA_ALG_HMAC(PSA_ALG_PBKDF2_HMAC_GET_HASH(kdf_alg));
5504 prf_output_length = PSA_HASH_LENGTH(prf_alg);
5505 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
Kusumit Ghoderaoa2520a52023-06-22 15:42:19 +05305506 } else if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
5507 prf_alg = PSA_ALG_CMAC;
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05305508 prf_output_length = PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC);
Kusumit Ghoderaoa2520a52023-06-22 15:42:19 +05305509 psa_set_key_type(&attributes, PSA_KEY_TYPE_AES);
Kusumit Ghoderaod9ec1af2023-06-08 20:19:51 +05305510 } else {
5511 return PSA_ERROR_INVALID_ARGUMENT;
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05305512 }
5513
5514 switch (pbkdf2->state) {
5515 case PSA_PBKDF2_STATE_PASSWORD_SET:
5516 /* Initially we need a new block so bytes_used is equal to block size*/
5517 pbkdf2->bytes_used = prf_output_length;
5518 pbkdf2->state = PSA_PBKDF2_STATE_OUTPUT;
5519 break;
5520 case PSA_PBKDF2_STATE_OUTPUT:
5521 break;
5522 default:
5523 return PSA_ERROR_BAD_STATE;
5524 }
5525
5526 while (output_length != 0) {
5527 uint8_t n = prf_output_length - pbkdf2->bytes_used;
5528 if (n > output_length) {
5529 n = (uint8_t) output_length;
5530 }
5531 memcpy(output, pbkdf2->output_block + pbkdf2->bytes_used, n);
5532 output += n;
5533 output_length -= n;
5534 pbkdf2->bytes_used += n;
5535
5536 if (output_length == 0) {
5537 break;
5538 }
5539
5540 /* We need a new block */
5541 pbkdf2->bytes_used = 0;
5542 pbkdf2->block_number++;
5543
5544 status = psa_key_derivation_pbkdf2_generate_block(pbkdf2, prf_alg,
5545 prf_output_length,
5546 &attributes);
5547 if (status != PSA_SUCCESS) {
5548 return status;
5549 }
5550 }
5551
5552 return PSA_SUCCESS;
5553}
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305554#endif /* PSA_HAVE_SOFT_PBKDF2 */
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305555
Janos Follath6c6c8fc2019-06-17 12:38:20 +01005556psa_status_t psa_key_derivation_output_bytes(
5557 psa_key_derivation_operation_t *operation,
5558 uint8_t *output,
Gilles Peskine449bd832023-01-11 14:50:10 +01005559 size_t output_length)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005560{
5561 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01005562 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
Gilles Peskineeab56e42018-07-12 17:12:33 +02005563
Gilles Peskine449bd832023-01-11 14:50:10 +01005564 if (operation->alg == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005565 /* This is a blank operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005566 return PSA_ERROR_BAD_STATE;
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005567 }
5568
Gilles Peskine449bd832023-01-11 14:50:10 +01005569 if (output_length > operation->capacity) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005570 operation->capacity = 0;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005571 /* Go through the error path to wipe all confidential data now
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005572 * that the operation object is useless. */
David Saadab4ecc272019-02-14 13:48:10 +02005573 status = PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005574 goto exit;
5575 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005576 if (output_length == 0 && operation->capacity == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005577 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005578 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02005579 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
5580 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005581 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02005582 * output_length > 0. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005583 return PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005584 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005585 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005586
Przemek Stekiel69c46792022-06-10 12:59:51 +02005587#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01005588 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
5589 status = psa_key_derivation_hkdf_read(&operation->ctx.hkdf, kdf_alg,
5590 output, output_length);
5591 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02005592#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08005593#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5594 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005595 if (PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
5596 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
5597 status = psa_key_derivation_tls12_prf_read(&operation->ctx.tls12_prf,
5598 kdf_alg, output,
5599 output_length);
5600 } else
John Durkop07cc04a2020-11-16 22:08:34 -08005601#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
5602 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005603#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005604 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005605 status = psa_key_derivation_tls12_ecjpake_to_pms_read(
Gilles Peskine449bd832023-01-11 14:50:10 +01005606 &operation->ctx.tls12_ecjpake_to_pms, output, output_length);
5607 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005608#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305609#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05305610 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05305611 status = psa_key_derivation_pbkdf2_read(&operation->ctx.pbkdf2, kdf_alg,
5612 output, output_length);
Kusumit Ghoderao056f0c52023-05-03 15:58:34 +05305613 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305614#endif /* PSA_HAVE_SOFT_PBKDF2 */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005615
Gilles Peskineeab56e42018-07-12 17:12:33 +02005616 {
Steven Cooreman74afe472021-02-10 17:19:22 +01005617 (void) kdf_alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01005618 return PSA_ERROR_BAD_STATE;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005619 }
5620
5621exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005622 if (status != PSA_SUCCESS) {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005623 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005624 * This allows us to differentiate between exhausted operations and
5625 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
5626 * operations. */
5627 psa_algorithm_t alg = operation->alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01005628 psa_key_derivation_abort(operation);
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005629 operation->alg = alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01005630 memset(output, '!', output_length);
Gilles Peskineeab56e42018-07-12 17:12:33 +02005631 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005632 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005633}
5634
David Brown7807bf72021-02-09 16:28:23 -07005635#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01005636static void psa_des_set_key_parity(uint8_t *data, size_t data_size)
Gilles Peskine08542d82018-07-19 17:05:42 +02005637{
Gilles Peskine449bd832023-01-11 14:50:10 +01005638 if (data_size >= 8) {
5639 mbedtls_des_key_set_parity(data);
5640 }
5641 if (data_size >= 16) {
5642 mbedtls_des_key_set_parity(data + 8);
5643 }
5644 if (data_size >= 24) {
5645 mbedtls_des_key_set_parity(data + 16);
5646 }
Gilles Peskine08542d82018-07-19 17:05:42 +02005647}
David Brown7807bf72021-02-09 16:28:23 -07005648#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine08542d82018-07-19 17:05:42 +02005649
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005650/*
Gilles Peskine449bd832023-01-11 14:50:10 +01005651 * ECC keys on a Weierstrass elliptic curve require the generation
5652 * of a private key which is an integer
5653 * in the range [1, N - 1], where N is the boundary of the private key domain:
5654 * N is the prime p for Diffie-Hellman, or the order of the
5655 * curve’s base point for ECC.
5656 *
5657 * Let m be the bit size of N, such that 2^m > N >= 2^(m-1).
5658 * This function generates the private key using the following process:
5659 *
5660 * 1. Draw a byte string of length ceiling(m/8) bytes.
5661 * 2. If m is not a multiple of 8, set the most significant
5662 * (8 * ceiling(m/8) - m) bits of the first byte in the string to zero.
5663 * 3. Convert the string to integer k by decoding it as a big-endian byte string.
5664 * 4. If k > N - 2, discard the result and return to step 1.
5665 * 5. Output k + 1 as the private key.
5666 *
5667 * This method allows compliance to NIST standards, specifically the methods titled
5668 * Key-Pair Generation by Testing Candidates in the following publications:
5669 * - NIST Special Publication 800-56A: Recommendation for Pair-Wise Key-Establishment
5670 * Schemes Using Discrete Logarithm Cryptography [SP800-56A] §5.6.1.1.4 for
5671 * Diffie-Hellman keys.
5672 *
5673 * - [SP800-56A] §5.6.1.2.2 or FIPS Publication 186-4: Digital Signature
5674 * Standard (DSS) [FIPS186-4] §B.4.2 for elliptic curve keys.
5675 *
5676 * Note: Function allocates memory for *data buffer, so given *data should be
5677 * always NULL.
5678 */
Valerio Setti86587ab2023-06-27 13:09:30 +02005679#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE)
5680#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE)
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01005681static psa_status_t psa_generate_derived_ecc_key_weierstrass_helper(
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005682 psa_key_slot_t *slot,
5683 size_t bits,
5684 psa_key_derivation_operation_t *operation,
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005685 uint8_t **data
5686 )
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005687{
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005688 unsigned key_out_of_range = 1;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005689 mbedtls_mpi k;
5690 mbedtls_mpi diff_N_2;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005691 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Przemek Stekiela81aed22022-03-01 15:13:30 +01005692 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01005693 size_t m;
5694 size_t m_bytes;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005695
Gilles Peskine449bd832023-01-11 14:50:10 +01005696 mbedtls_mpi_init(&k);
5697 mbedtls_mpi_init(&diff_N_2);
Przemyslaw Stekiel1dfd1222021-11-18 13:35:00 +01005698
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005699 psa_ecc_family_t curve = PSA_KEY_TYPE_ECC_GET_FAMILY(
Gilles Peskine449bd832023-01-11 14:50:10 +01005700 slot->attr.type);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005701 mbedtls_ecp_group_id grp_id =
Gilles Peskine449bd832023-01-11 14:50:10 +01005702 mbedtls_ecc_group_of_psa(curve, bits, 0);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005703
Gilles Peskine449bd832023-01-11 14:50:10 +01005704 if (grp_id == MBEDTLS_ECP_DP_NONE) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005705 ret = MBEDTLS_ERR_ASN1_INVALID_DATA;
Przemyslaw Stekiel871a3362021-12-02 08:46:39 +01005706 goto cleanup;
5707 }
5708
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005709 mbedtls_ecp_group ecp_group;
Gilles Peskine449bd832023-01-11 14:50:10 +01005710 mbedtls_ecp_group_init(&ecp_group);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005711
Gilles Peskine449bd832023-01-11 14:50:10 +01005712 MBEDTLS_MPI_CHK(mbedtls_ecp_group_load(&ecp_group, grp_id));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005713
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005714 /* N is the boundary of the private key domain (ecp_group.N). */
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005715 /* Let m be the bit size of N. */
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01005716 m = ecp_group.nbits;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005717
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01005718 m_bytes = PSA_BITS_TO_BYTES(m);
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005719
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005720 /* Calculate N - 2 - it will be needed later. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005721 MBEDTLS_MPI_CHK(mbedtls_mpi_sub_int(&diff_N_2, &ecp_group.N, 2));
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005722
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005723 /* Note: This function is always called with *data == NULL and it
5724 * allocates memory for the data buffer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005725 *data = mbedtls_calloc(1, m_bytes);
5726 if (*data == NULL) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005727 ret = MBEDTLS_ERR_ASN1_ALLOC_FAILED;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005728 goto cleanup;
5729 }
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005730
Gilles Peskine449bd832023-01-11 14:50:10 +01005731 while (key_out_of_range) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005732 /* 1. Draw a byte string of length ceiling(m/8) bytes. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005733 if ((status = psa_key_derivation_output_bytes(operation, *data, m_bytes)) != 0) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005734 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005735 }
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005736
5737 /* 2. If m is not a multiple of 8 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005738 if (m % 8 != 0) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005739 /* Set the most significant
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005740 * (8 * ceiling(m/8) - m) bits of the first byte in
5741 * the string to zero.
5742 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005743 uint8_t clear_bit_mask = (1 << (m % 8)) - 1;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005744 (*data)[0] &= clear_bit_mask;
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005745 }
5746
5747 /* 3. Convert the string to integer k by decoding it as a
Gilles Peskine449bd832023-01-11 14:50:10 +01005748 * big-endian byte string.
5749 */
5750 MBEDTLS_MPI_CHK(mbedtls_mpi_read_binary(&k, *data, m_bytes));
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005751
5752 /* 4. If k > N - 2, discard the result and return to step 1.
Gilles Peskine449bd832023-01-11 14:50:10 +01005753 * Result of comparison is returned. When it indicates error
5754 * then this function is called again.
5755 */
5756 MBEDTLS_MPI_CHK(mbedtls_mpi_lt_mpi_ct(&diff_N_2, &k, &key_out_of_range));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005757 }
5758
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005759 /* 5. Output k + 1 as the private key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005760 MBEDTLS_MPI_CHK(mbedtls_mpi_add_int(&k, &k, 1));
5761 MBEDTLS_MPI_CHK(mbedtls_mpi_write_binary(&k, *data, m_bytes));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005762cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01005763 if (ret != 0) {
5764 status = mbedtls_to_psa_error(ret);
5765 }
5766 if (status != PSA_SUCCESS) {
5767 mbedtls_free(*data);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005768 *data = NULL;
5769 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005770 mbedtls_mpi_free(&k);
5771 mbedtls_mpi_free(&diff_N_2);
5772 return status;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005773}
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005774
5775/* ECC keys on a Montgomery elliptic curve draws a byte string whose length
5776 * is determined by the curve, and sets the mandatory bits accordingly. That is:
5777 *
5778 * - Curve25519 (PSA_ECC_FAMILY_MONTGOMERY, 255 bits):
5779 * draw a 32-byte string and process it as specified in
5780 * Elliptic Curves for Security [RFC7748] §5.
5781 *
5782 * - Curve448 (PSA_ECC_FAMILY_MONTGOMERY, 448 bits):
5783 * draw a 56-byte string and process it as specified in [RFC7748] §5.
5784 *
5785 * Note: Function allocates memory for *data buffer, so given *data should be
5786 * always NULL.
5787 */
5788
5789static psa_status_t psa_generate_derived_ecc_key_montgomery_helper(
5790 size_t bits,
5791 psa_key_derivation_operation_t *operation,
5792 uint8_t **data
5793 )
5794{
5795 size_t output_length;
Przemek Stekiela81aed22022-03-01 15:13:30 +01005796 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005797
Gilles Peskine449bd832023-01-11 14:50:10 +01005798 switch (bits) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005799 case 255:
5800 output_length = 32;
5801 break;
5802 case 448:
5803 output_length = 56;
5804 break;
5805 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005806 return PSA_ERROR_INVALID_ARGUMENT;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005807 break;
5808 }
5809
Gilles Peskine449bd832023-01-11 14:50:10 +01005810 *data = mbedtls_calloc(1, output_length);
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005811
Gilles Peskine449bd832023-01-11 14:50:10 +01005812 if (*data == NULL) {
5813 return PSA_ERROR_INSUFFICIENT_MEMORY;
5814 }
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005815
Gilles Peskine449bd832023-01-11 14:50:10 +01005816 status = psa_key_derivation_output_bytes(operation, *data, output_length);
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005817
Gilles Peskine449bd832023-01-11 14:50:10 +01005818 if (status != PSA_SUCCESS) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005819 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01005820 }
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005821
Gilles Peskine449bd832023-01-11 14:50:10 +01005822 switch (bits) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005823 case 255:
5824 (*data)[0] &= 248;
5825 (*data)[31] &= 127;
5826 (*data)[31] |= 64;
5827 break;
5828 case 448:
5829 (*data)[0] &= 252;
5830 (*data)[55] |= 128;
5831 break;
5832 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005833 return PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005834 break;
5835 }
5836
5837 return status;
5838}
Valerio Setti86587ab2023-06-27 13:09:30 +02005839#else /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE */
5840static psa_status_t psa_generate_derived_ecc_key_weierstrass_helper(
5841 psa_key_slot_t *slot, size_t bits,
5842 psa_key_derivation_operation_t *operation, uint8_t **data)
5843{
5844 (void) slot;
5845 (void) bits;
5846 (void) operation;
5847 (void) data;
5848 return PSA_ERROR_NOT_SUPPORTED;
5849}
5850
5851static psa_status_t psa_generate_derived_ecc_key_montgomery_helper(
5852 size_t bits, psa_key_derivation_operation_t *operation, uint8_t **data)
5853{
5854 (void) bits;
5855 (void) operation;
5856 (void) data;
5857 return PSA_ERROR_NOT_SUPPORTED;
5858}
5859#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE */
5860#endif /* PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE */
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005861
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01005862static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005863 psa_key_slot_t *slot,
5864 size_t bits,
Gilles Peskine449bd832023-01-11 14:50:10 +01005865 psa_key_derivation_operation_t *operation)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005866{
5867 uint8_t *data = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01005868 size_t bytes = PSA_BITS_TO_BYTES(bits);
Archanad8a83dc2021-06-14 10:04:16 +05305869 size_t storage_size = bytes;
Przemek Stekiela81aed22022-03-01 15:13:30 +01005870 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01005871 psa_key_attributes_t attributes;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005872
Gilles Peskine449bd832023-01-11 14:50:10 +01005873 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(slot->attr.type)) {
5874 return PSA_ERROR_INVALID_ARGUMENT;
5875 }
Gilles Peskineeab56e42018-07-12 17:12:33 +02005876
Valerio Setti8ffdb5d2023-06-20 13:14:08 +02005877#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE) || \
Valerio Settidd24f292023-06-26 12:21:17 +02005878 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE)
Gilles Peskine449bd832023-01-11 14:50:10 +01005879 if (PSA_KEY_TYPE_IS_ECC(slot->attr.type)) {
5880 psa_ecc_family_t curve = PSA_KEY_TYPE_ECC_GET_FAMILY(slot->attr.type);
5881 if (PSA_ECC_FAMILY_IS_WEIERSTRASS(curve)) {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01005882 /* Weierstrass elliptic curve */
Gilles Peskine449bd832023-01-11 14:50:10 +01005883 status = psa_generate_derived_ecc_key_weierstrass_helper(slot, bits, operation, &data);
5884 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005885 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005886 }
5887 } else {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01005888 /* Montgomery elliptic curve */
Gilles Peskine449bd832023-01-11 14:50:10 +01005889 status = psa_generate_derived_ecc_key_montgomery_helper(bits, operation, &data);
5890 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01005891 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005892 }
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01005893 }
Przemyslaw Stekiel1dfd1222021-11-18 13:35:00 +01005894 } else
Valerio Setti8ffdb5d2023-06-20 13:14:08 +02005895#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE) ||
Valerio Settidd24f292023-06-26 12:21:17 +02005896 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE) */
Gilles Peskine449bd832023-01-11 14:50:10 +01005897 if (key_type_is_raw_bytes(slot->attr.type)) {
5898 if (bits % 8 != 0) {
5899 return PSA_ERROR_INVALID_ARGUMENT;
5900 }
5901 data = mbedtls_calloc(1, bytes);
5902 if (data == NULL) {
5903 return PSA_ERROR_INSUFFICIENT_MEMORY;
5904 }
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01005905
Gilles Peskine449bd832023-01-11 14:50:10 +01005906 status = psa_key_derivation_output_bytes(operation, data, bytes);
5907 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01005908 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005909 }
David Brown12ca5032021-02-11 11:02:00 -07005910#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01005911 if (slot->attr.type == PSA_KEY_TYPE_DES) {
5912 psa_des_set_key_parity(data, bytes);
5913 }
Przemek Stekielf110dc02022-03-01 14:48:05 +01005914#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES) */
Gilles Peskine449bd832023-01-11 14:50:10 +01005915 } else {
5916 return PSA_ERROR_NOT_SUPPORTED;
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01005917 }
Ronald Crondd04d422020-11-28 15:14:42 +01005918
Ronald Cronbf33c932020-11-28 18:06:53 +01005919 slot->attr.bits = (psa_key_bits_t) bits;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01005920 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01005921 .core = slot->attr
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01005922 };
5923
Gilles Peskine449bd832023-01-11 14:50:10 +01005924 if (psa_key_lifetime_is_external(attributes.core.lifetime)) {
5925 status = psa_driver_wrapper_get_key_buffer_size(&attributes,
5926 &storage_size);
5927 if (status != PSA_SUCCESS) {
Archanad8a83dc2021-06-14 10:04:16 +05305928 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005929 }
Archanad8a83dc2021-06-14 10:04:16 +05305930 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005931 status = psa_allocate_buffer_to_slot(slot, storage_size);
5932 if (status != PSA_SUCCESS) {
Archanad8a83dc2021-06-14 10:04:16 +05305933 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005934 }
Archanad8a83dc2021-06-14 10:04:16 +05305935
Gilles Peskine449bd832023-01-11 14:50:10 +01005936 status = psa_driver_wrapper_import_key(&attributes,
5937 data, bytes,
5938 slot->key.data,
5939 slot->key.bytes,
5940 &slot->key.bytes, &bits);
5941 if (bits != slot->attr.bits) {
Ronald Cronbf33c932020-11-28 18:06:53 +01005942 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine449bd832023-01-11 14:50:10 +01005943 }
Gilles Peskineeab56e42018-07-12 17:12:33 +02005944
5945exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005946 mbedtls_free(data);
5947 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005948}
5949
Gilles Peskine449bd832023-01-11 14:50:10 +01005950psa_status_t psa_key_derivation_output_key(const psa_key_attributes_t *attributes,
5951 psa_key_derivation_operation_t *operation,
5952 mbedtls_svc_key_id_t *key)
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005953{
5954 psa_status_t status;
5955 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02005956 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine0f84d622019-09-12 19:03:13 +02005957
Ronald Cron81709fc2020-11-14 12:10:32 +01005958 *key = MBEDTLS_SVC_KEY_ID_INIT;
5959
Gilles Peskine0f84d622019-09-12 19:03:13 +02005960 /* Reject any attempt to create a zero-length key so that we don't
5961 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005962 if (psa_get_key_bits(attributes) == 0) {
5963 return PSA_ERROR_INVALID_ARGUMENT;
5964 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02005965
Gilles Peskine449bd832023-01-11 14:50:10 +01005966 if (operation->alg == PSA_ALG_NONE) {
5967 return PSA_ERROR_BAD_STATE;
5968 }
Dave Rodgmand69da6c2021-11-16 10:32:48 +00005969
Gilles Peskine449bd832023-01-11 14:50:10 +01005970 if (!operation->can_output_key) {
5971 return PSA_ERROR_NOT_PERMITTED;
5972 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02005973
Gilles Peskine449bd832023-01-11 14:50:10 +01005974 status = psa_start_key_creation(PSA_KEY_CREATION_DERIVE, attributes,
5975 &slot, &driver);
Gilles Peskinef4ee6622019-07-24 13:44:30 +02005976#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005977 if (driver != NULL) {
Gilles Peskinef4ee6622019-07-24 13:44:30 +02005978 /* Deriving a key in a secure element is not implemented yet. */
5979 status = PSA_ERROR_NOT_SUPPORTED;
5980 }
5981#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine449bd832023-01-11 14:50:10 +01005982 if (status == PSA_SUCCESS) {
5983 status = psa_generate_derived_key_internal(slot,
5984 attributes->core.bits,
5985 operation);
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005986 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005987 if (status == PSA_SUCCESS) {
5988 status = psa_finish_key_creation(slot, driver, key);
5989 }
5990 if (status != PSA_SUCCESS) {
5991 psa_fail_key_creation(slot, driver);
5992 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02005993
Gilles Peskine449bd832023-01-11 14:50:10 +01005994 return status;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005995}
5996
Gilles Peskineeab56e42018-07-12 17:12:33 +02005997
5998
5999/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02006000/* Key derivation */
6001/****************************************************************/
6002
Steven Cooreman932ffb72021-02-15 12:14:32 +01006003#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006004static int is_kdf_alg_supported(psa_algorithm_t kdf_alg)
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006005{
6006#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006007 if (PSA_ALG_IS_HKDF(kdf_alg)) {
6008 return 1;
6009 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006010#endif
Przemek Stekielb57a44b2022-06-06 08:33:45 +02006011#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006012 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6013 return 1;
6014 }
Przemek Stekielb57a44b2022-06-06 08:33:45 +02006015#endif
6016#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006017 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
6018 return 1;
6019 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006020#endif
6021#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006022 if (PSA_ALG_IS_TLS12_PRF(kdf_alg)) {
6023 return 1;
6024 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006025#endif
6026#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006027 if (PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
6028 return 1;
6029 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006030#endif
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006031#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006032 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
6033 return 1;
6034 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006035#endif
Kusumit Ghoderaod132cac2023-05-03 12:00:27 +05306036#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
6037 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
6038 return 1;
6039 }
6040#endif
Kusumit Ghoderao2cd64962023-06-22 15:38:57 +05306041#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128)
6042 if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
6043 return 1;
6044 }
6045#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006046 return 0;
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006047}
6048
Gilles Peskine449bd832023-01-11 14:50:10 +01006049static psa_status_t psa_hash_try_support(psa_algorithm_t alg)
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006050{
6051 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01006052 psa_status_t status = psa_hash_setup(&operation, alg);
6053 psa_hash_abort(&operation);
6054 return status;
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006055}
6056
Gilles Peskine969c5d62019-01-16 15:53:06 +01006057static psa_status_t psa_key_derivation_setup_kdf(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006058 psa_key_derivation_operation_t *operation,
Gilles Peskine449bd832023-01-11 14:50:10 +01006059 psa_algorithm_t kdf_alg)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006060{
Janos Follath5fe19732019-06-20 15:09:30 +01006061 /* Make sure that operation->ctx is properly zero-initialised. (Macro
6062 * initialisers for this union leave some bytes unspecified.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01006063 memset(&operation->ctx, 0, sizeof(operation->ctx));
Janos Follath5fe19732019-06-20 15:09:30 +01006064
Gilles Peskine969c5d62019-01-16 15:53:06 +01006065 /* Make sure that kdf_alg is a supported key derivation algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006066 if (!is_kdf_alg_supported(kdf_alg)) {
6067 return PSA_ERROR_NOT_SUPPORTED;
6068 }
John Durkop07cc04a2020-11-16 22:08:34 -08006069
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006070 /* All currently supported key derivation algorithms (apart from
Kusumit Ghoderao2cd64962023-06-22 15:38:57 +05306071 * ecjpake to pms and pbkdf2_aes_cmac_128) are based on a hash algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006072 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
6073 size_t hash_size = PSA_HASH_LENGTH(hash_alg);
Kusumit Ghoderao2cd64962023-06-22 15:38:57 +05306074 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
6075 hash_size = PSA_HASH_LENGTH(PSA_ALG_SHA_256);
6076 } else if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306077 hash_size = PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC);
Kusumit Ghoderao2cd64962023-06-22 15:38:57 +05306078 } else {
Gilles Peskine449bd832023-01-11 14:50:10 +01006079 if (hash_size == 0) {
6080 return PSA_ERROR_NOT_SUPPORTED;
6081 }
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006082
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006083 /* Make sure that hash_alg is a supported hash algorithm. Otherwise
6084 * we might fail later, which is somewhat unfriendly and potentially
6085 * risk-prone. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006086 psa_status_t status = psa_hash_try_support(hash_alg);
6087 if (status != PSA_SUCCESS) {
6088 return status;
6089 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006090 }
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006091
Gilles Peskine449bd832023-01-11 14:50:10 +01006092 if ((PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
6093 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) &&
6094 !(hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384)) {
6095 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006096 }
Andrzej Kurek77638292022-09-16 12:24:52 -04006097#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT) || \
Andrzej Kurekb510cd22022-09-26 10:50:22 -04006098 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006099 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg) ||
6100 (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS)) {
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006101 operation->capacity = hash_size;
Gilles Peskine449bd832023-01-11 14:50:10 +01006102 } else
Andrzej Kurekb510cd22022-09-26 10:50:22 -04006103#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT ||
6104 MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Gilles Peskine449bd832023-01-11 14:50:10 +01006105 operation->capacity = 255 * hash_size;
6106 return PSA_SUCCESS;
Gilles Peskine969c5d62019-01-16 15:53:06 +01006107}
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006108
Gilles Peskine449bd832023-01-11 14:50:10 +01006109static psa_status_t psa_key_agreement_try_support(psa_algorithm_t alg)
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006110{
6111#if defined(PSA_WANT_ALG_ECDH)
Gilles Peskine449bd832023-01-11 14:50:10 +01006112 if (alg == PSA_ALG_ECDH) {
6113 return PSA_SUCCESS;
6114 }
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006115#endif
Przemek Stekielfb3dd542022-12-01 14:59:15 +01006116#if defined(PSA_WANT_ALG_FFDH)
6117 if (alg == PSA_ALG_FFDH) {
6118 return PSA_SUCCESS;
6119 }
6120#endif
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006121 (void) alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01006122 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006123}
Gilles Peskinebb3814c2022-12-16 01:12:12 +01006124
6125static int psa_key_derivation_allows_free_form_secret_input(
6126 psa_algorithm_t kdf_alg)
6127{
6128#if defined(PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS)
6129 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
6130 return 0;
6131 }
6132#endif
6133 (void) kdf_alg;
6134 return 1;
6135}
John Durkop07cc04a2020-11-16 22:08:34 -08006136#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01006137
Gilles Peskine449bd832023-01-11 14:50:10 +01006138psa_status_t psa_key_derivation_setup(psa_key_derivation_operation_t *operation,
6139 psa_algorithm_t alg)
Gilles Peskine969c5d62019-01-16 15:53:06 +01006140{
6141 psa_status_t status;
6142
Gilles Peskine449bd832023-01-11 14:50:10 +01006143 if (operation->alg != 0) {
6144 return PSA_ERROR_BAD_STATE;
Gilles Peskine969c5d62019-01-16 15:53:06 +01006145 }
Gilles Peskine969c5d62019-01-16 15:53:06 +01006146
Gilles Peskine449bd832023-01-11 14:50:10 +01006147 if (PSA_ALG_IS_RAW_KEY_AGREEMENT(alg)) {
6148 return PSA_ERROR_INVALID_ARGUMENT;
6149 } else if (PSA_ALG_IS_KEY_AGREEMENT(alg)) {
6150#if defined(AT_LEAST_ONE_BUILTIN_KDF)
6151 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF(alg);
6152 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE(alg);
6153 status = psa_key_agreement_try_support(ka_alg);
6154 if (status != PSA_SUCCESS) {
6155 return status;
6156 }
Gilles Peskinebb3814c2022-12-16 01:12:12 +01006157 if (!psa_key_derivation_allows_free_form_secret_input(kdf_alg)) {
6158 return PSA_ERROR_INVALID_ARGUMENT;
6159 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006160 status = psa_key_derivation_setup_kdf(operation, kdf_alg);
6161#else
6162 return PSA_ERROR_NOT_SUPPORTED;
6163#endif /* AT_LEAST_ONE_BUILTIN_KDF */
6164 } else if (PSA_ALG_IS_KEY_DERIVATION(alg)) {
6165#if defined(AT_LEAST_ONE_BUILTIN_KDF)
6166 status = psa_key_derivation_setup_kdf(operation, alg);
6167#else
6168 return PSA_ERROR_NOT_SUPPORTED;
6169#endif /* AT_LEAST_ONE_BUILTIN_KDF */
6170 } else {
6171 return PSA_ERROR_INVALID_ARGUMENT;
6172 }
6173
6174 if (status == PSA_SUCCESS) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006175 operation->alg = alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01006176 }
6177 return status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006178}
6179
Przemek Stekiel69c46792022-06-10 12:59:51 +02006180#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006181static psa_status_t psa_hkdf_input(psa_hkdf_key_derivation_t *hkdf,
6182 psa_algorithm_t kdf_alg,
6183 psa_key_derivation_step_t step,
6184 const uint8_t *data,
6185 size_t data_length)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006186{
Gilles Peskine449bd832023-01-11 14:50:10 +01006187 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006188 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006189 switch (step) {
Gilles Peskine03410b52019-05-16 16:05:19 +02006190 case PSA_KEY_DERIVATION_INPUT_SALT:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006191#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006192 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
6193 return PSA_ERROR_INVALID_ARGUMENT;
6194 }
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006195#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND */
Gilles Peskine449bd832023-01-11 14:50:10 +01006196 if (hkdf->state != HKDF_STATE_INIT) {
6197 return PSA_ERROR_BAD_STATE;
6198 } else {
6199 status = psa_key_derivation_start_hmac(&hkdf->hmac,
6200 hash_alg,
6201 data, data_length);
6202 if (status != PSA_SUCCESS) {
6203 return status;
6204 }
Steven Cooremand1ed1d92021-04-29 19:11:25 +02006205 hkdf->state = HKDF_STATE_STARTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01006206 return PSA_SUCCESS;
Steven Cooremand1ed1d92021-04-29 19:11:25 +02006207 }
Gilles Peskine03410b52019-05-16 16:05:19 +02006208 case PSA_KEY_DERIVATION_INPUT_SECRET:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006209#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006210 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
Przemek Stekiel2fb0dcd2022-05-19 10:34:37 +02006211 /* We shouldn't be in different state as HKDF_EXPAND only allows
6212 * two inputs: SECRET (this case) and INFO which does not modify
6213 * the state. It could happen only if the hkdf
6214 * object was corrupted. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006215 if (hkdf->state != HKDF_STATE_INIT) {
6216 return PSA_ERROR_BAD_STATE;
6217 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006218
Przemek Stekiel2fb0dcd2022-05-19 10:34:37 +02006219 /* Allow only input that fits expected prk size */
Gilles Peskine449bd832023-01-11 14:50:10 +01006220 if (data_length != PSA_HASH_LENGTH(hash_alg)) {
6221 return PSA_ERROR_INVALID_ARGUMENT;
6222 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006223
Gilles Peskine449bd832023-01-11 14:50:10 +01006224 memcpy(hkdf->prk, data, data_length);
6225 } else
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006226#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND */
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006227 {
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006228 /* HKDF: If no salt was provided, use an empty salt.
6229 * HKDF-EXTRACT: salt is mandatory. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006230 if (hkdf->state == HKDF_STATE_INIT) {
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006231#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006232 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6233 return PSA_ERROR_BAD_STATE;
6234 }
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006235#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01006236 status = psa_key_derivation_start_hmac(&hkdf->hmac,
6237 hash_alg,
6238 NULL, 0);
6239 if (status != PSA_SUCCESS) {
6240 return status;
6241 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006242 hkdf->state = HKDF_STATE_STARTED;
6243 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006244 if (hkdf->state != HKDF_STATE_STARTED) {
6245 return PSA_ERROR_BAD_STATE;
6246 }
6247 status = psa_mac_update(&hkdf->hmac,
6248 data, data_length);
6249 if (status != PSA_SUCCESS) {
6250 return status;
6251 }
6252 status = psa_mac_sign_finish(&hkdf->hmac,
6253 hkdf->prk,
6254 sizeof(hkdf->prk),
6255 &data_length);
6256 if (status != PSA_SUCCESS) {
6257 return status;
6258 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006259 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006260
Gilles Peskine2b522db2019-04-12 15:11:49 +02006261 hkdf->state = HKDF_STATE_KEYED;
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006262 hkdf->block_number = 0;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006263#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006264 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006265 /* The only block of output is the PRK. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006266 memcpy(hkdf->output_block, hkdf->prk, PSA_HASH_LENGTH(hash_alg));
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006267 hkdf->offset_in_block = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01006268 } else
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006269#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006270 {
6271 /* Block 0 is empty, and the next block will be
6272 * generated by psa_key_derivation_hkdf_read(). */
Gilles Peskine449bd832023-01-11 14:50:10 +01006273 hkdf->offset_in_block = PSA_HASH_LENGTH(hash_alg);
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006274 }
6275
Gilles Peskine449bd832023-01-11 14:50:10 +01006276 return PSA_SUCCESS;
Gilles Peskine03410b52019-05-16 16:05:19 +02006277 case PSA_KEY_DERIVATION_INPUT_INFO:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006278#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006279 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6280 return PSA_ERROR_INVALID_ARGUMENT;
6281 }
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006282#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Przemek Stekielcde3f782022-06-03 16:12:27 +02006283#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006284 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg) &&
6285 hkdf->state == HKDF_STATE_INIT) {
6286 return PSA_ERROR_BAD_STATE;
6287 }
Przemek Stekielcde3f782022-06-03 16:12:27 +02006288#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01006289 if (hkdf->state == HKDF_STATE_OUTPUT) {
6290 return PSA_ERROR_BAD_STATE;
6291 }
6292 if (hkdf->info_set) {
6293 return PSA_ERROR_BAD_STATE;
6294 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006295 hkdf->info_length = data_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01006296 if (data_length != 0) {
6297 hkdf->info = mbedtls_calloc(1, data_length);
6298 if (hkdf->info == NULL) {
6299 return PSA_ERROR_INSUFFICIENT_MEMORY;
6300 }
6301 memcpy(hkdf->info, data, data_length);
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006302 }
6303 hkdf->info_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01006304 return PSA_SUCCESS;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006305 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006306 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006307 }
6308}
Przemek Stekiel69c46792022-06-10 12:59:51 +02006309#endif /* BUILTIN_ALG_ANY_HKDF */
Janos Follathb03233e2019-06-11 15:30:30 +01006310
John Durkop07cc04a2020-11-16 22:08:34 -08006311#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
6312 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006313static psa_status_t psa_tls12_prf_set_seed(psa_tls12_prf_key_derivation_t *prf,
6314 const uint8_t *data,
6315 size_t data_length)
Janos Follathf08e2652019-06-13 09:05:41 +01006316{
Gilles Peskine449bd832023-01-11 14:50:10 +01006317 if (prf->state != PSA_TLS12_PRF_STATE_INIT) {
6318 return PSA_ERROR_BAD_STATE;
6319 }
Janos Follathf08e2652019-06-13 09:05:41 +01006320
Gilles Peskine449bd832023-01-11 14:50:10 +01006321 if (data_length != 0) {
6322 prf->seed = mbedtls_calloc(1, data_length);
6323 if (prf->seed == NULL) {
6324 return PSA_ERROR_INSUFFICIENT_MEMORY;
6325 }
Janos Follathf08e2652019-06-13 09:05:41 +01006326
Gilles Peskine449bd832023-01-11 14:50:10 +01006327 memcpy(prf->seed, data, data_length);
Janos Follathd6dce9f2019-07-04 09:11:38 +01006328 prf->seed_length = data_length;
6329 }
Janos Follathf08e2652019-06-13 09:05:41 +01006330
Gilles Peskine43f958b2020-12-13 14:55:14 +01006331 prf->state = PSA_TLS12_PRF_STATE_SEED_SET;
Janos Follathf08e2652019-06-13 09:05:41 +01006332
Gilles Peskine449bd832023-01-11 14:50:10 +01006333 return PSA_SUCCESS;
Janos Follathf08e2652019-06-13 09:05:41 +01006334}
6335
Gilles Peskine449bd832023-01-11 14:50:10 +01006336static psa_status_t psa_tls12_prf_set_key(psa_tls12_prf_key_derivation_t *prf,
6337 const uint8_t *data,
6338 size_t data_length)
Janos Follath81550542019-06-13 14:26:34 +01006339{
Gilles Peskine449bd832023-01-11 14:50:10 +01006340 if (prf->state != PSA_TLS12_PRF_STATE_SEED_SET &&
6341 prf->state != PSA_TLS12_PRF_STATE_OTHER_KEY_SET) {
6342 return PSA_ERROR_BAD_STATE;
6343 }
Janos Follath81550542019-06-13 14:26:34 +01006344
Gilles Peskine449bd832023-01-11 14:50:10 +01006345 if (data_length != 0) {
6346 prf->secret = mbedtls_calloc(1, data_length);
6347 if (prf->secret == NULL) {
6348 return PSA_ERROR_INSUFFICIENT_MEMORY;
6349 }
Steven Cooremana6df6042021-04-29 19:32:25 +02006350
Gilles Peskine449bd832023-01-11 14:50:10 +01006351 memcpy(prf->secret, data, data_length);
Steven Cooremana6df6042021-04-29 19:32:25 +02006352 prf->secret_length = data_length;
6353 }
Janos Follath81550542019-06-13 14:26:34 +01006354
Gilles Peskine43f958b2020-12-13 14:55:14 +01006355 prf->state = PSA_TLS12_PRF_STATE_KEY_SET;
Janos Follath81550542019-06-13 14:26:34 +01006356
Gilles Peskine449bd832023-01-11 14:50:10 +01006357 return PSA_SUCCESS;
Janos Follath81550542019-06-13 14:26:34 +01006358}
6359
Gilles Peskine449bd832023-01-11 14:50:10 +01006360static psa_status_t psa_tls12_prf_set_label(psa_tls12_prf_key_derivation_t *prf,
6361 const uint8_t *data,
6362 size_t data_length)
Janos Follath63028dd2019-06-13 09:15:47 +01006363{
Gilles Peskine449bd832023-01-11 14:50:10 +01006364 if (prf->state != PSA_TLS12_PRF_STATE_KEY_SET) {
6365 return PSA_ERROR_BAD_STATE;
6366 }
Janos Follath63028dd2019-06-13 09:15:47 +01006367
Gilles Peskine449bd832023-01-11 14:50:10 +01006368 if (data_length != 0) {
6369 prf->label = mbedtls_calloc(1, data_length);
6370 if (prf->label == NULL) {
6371 return PSA_ERROR_INSUFFICIENT_MEMORY;
6372 }
Janos Follath63028dd2019-06-13 09:15:47 +01006373
Gilles Peskine449bd832023-01-11 14:50:10 +01006374 memcpy(prf->label, data, data_length);
Janos Follathd6dce9f2019-07-04 09:11:38 +01006375 prf->label_length = data_length;
6376 }
Janos Follath63028dd2019-06-13 09:15:47 +01006377
Gilles Peskine43f958b2020-12-13 14:55:14 +01006378 prf->state = PSA_TLS12_PRF_STATE_LABEL_SET;
Janos Follath63028dd2019-06-13 09:15:47 +01006379
Gilles Peskine449bd832023-01-11 14:50:10 +01006380 return PSA_SUCCESS;
Janos Follath63028dd2019-06-13 09:15:47 +01006381}
6382
Gilles Peskine449bd832023-01-11 14:50:10 +01006383static psa_status_t psa_tls12_prf_input(psa_tls12_prf_key_derivation_t *prf,
6384 psa_key_derivation_step_t step,
6385 const uint8_t *data,
6386 size_t data_length)
Janos Follathb03233e2019-06-11 15:30:30 +01006387{
Gilles Peskine449bd832023-01-11 14:50:10 +01006388 switch (step) {
Janos Follathf08e2652019-06-13 09:05:41 +01006389 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskine449bd832023-01-11 14:50:10 +01006390 return psa_tls12_prf_set_seed(prf, data, data_length);
Janos Follath81550542019-06-13 14:26:34 +01006391 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006392 return psa_tls12_prf_set_key(prf, data, data_length);
Janos Follath63028dd2019-06-13 09:15:47 +01006393 case PSA_KEY_DERIVATION_INPUT_LABEL:
Gilles Peskine449bd832023-01-11 14:50:10 +01006394 return psa_tls12_prf_set_label(prf, data, data_length);
Janos Follathb03233e2019-06-11 15:30:30 +01006395 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006396 return PSA_ERROR_INVALID_ARGUMENT;
Janos Follathb03233e2019-06-11 15:30:30 +01006397 }
6398}
John Durkop07cc04a2020-11-16 22:08:34 -08006399#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
6400 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
6401
6402#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
6403static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
6404 psa_tls12_prf_key_derivation_t *prf,
John Durkop07cc04a2020-11-16 22:08:34 -08006405 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006406 size_t data_length)
John Durkop07cc04a2020-11-16 22:08:34 -08006407{
6408 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006409 const size_t pms_len = (prf->state == PSA_TLS12_PRF_STATE_OTHER_KEY_SET ?
6410 4 + data_length + prf->other_secret_length :
6411 4 + 2 * data_length);
John Durkop07cc04a2020-11-16 22:08:34 -08006412
Gilles Peskine449bd832023-01-11 14:50:10 +01006413 if (data_length > PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE) {
6414 return PSA_ERROR_INVALID_ARGUMENT;
6415 }
John Durkop07cc04a2020-11-16 22:08:34 -08006416
Gilles Peskine449bd832023-01-11 14:50:10 +01006417 uint8_t *pms = mbedtls_calloc(1, pms_len);
6418 if (pms == NULL) {
6419 return PSA_ERROR_INSUFFICIENT_MEMORY;
6420 }
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02006421 uint8_t *cur = pms;
6422
6423 /* pure-PSK:
6424 * Quoting RFC 4279, Section 2:
John Durkop07cc04a2020-11-16 22:08:34 -08006425 *
6426 * The premaster secret is formed as follows: if the PSK is N octets
6427 * long, concatenate a uint16 with the value N, N zero octets, a second
6428 * uint16 with the value N, and the PSK itself.
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02006429 *
6430 * mixed-PSK:
6431 * In a DHE-PSK, RSA-PSK, ECDHE-PSK the premaster secret is formed as
6432 * follows: concatenate a uint16 with the length of the other secret,
6433 * the other secret itself, uint16 with the length of PSK, and the
6434 * PSK itself.
6435 * For details please check:
6436 * - RFC 4279, Section 4 for the definition of RSA-PSK,
6437 * - RFC 4279, Section 3 for the definition of DHE-PSK,
6438 * - RFC 5489 for the definition of ECDHE-PSK.
John Durkop07cc04a2020-11-16 22:08:34 -08006439 */
6440
Gilles Peskine449bd832023-01-11 14:50:10 +01006441 if (prf->state == PSA_TLS12_PRF_STATE_OTHER_KEY_SET) {
6442 *cur++ = MBEDTLS_BYTE_1(prf->other_secret_length);
6443 *cur++ = MBEDTLS_BYTE_0(prf->other_secret_length);
6444 if (prf->other_secret_length != 0) {
6445 memcpy(cur, prf->other_secret, prf->other_secret_length);
6446 mbedtls_platform_zeroize(prf->other_secret, prf->other_secret_length);
Przemek Stekiel2503f7e2022-04-12 12:08:01 +02006447 cur += prf->other_secret_length;
6448 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006449 } else {
6450 *cur++ = MBEDTLS_BYTE_1(data_length);
6451 *cur++ = MBEDTLS_BYTE_0(data_length);
6452 memset(cur, 0, data_length);
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02006453 cur += data_length;
6454 }
6455
Gilles Peskine449bd832023-01-11 14:50:10 +01006456 *cur++ = MBEDTLS_BYTE_1(data_length);
6457 *cur++ = MBEDTLS_BYTE_0(data_length);
6458 memcpy(cur, data, data_length);
John Durkop07cc04a2020-11-16 22:08:34 -08006459 cur += data_length;
6460
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00006461 status = psa_tls12_prf_set_key(prf, pms, (size_t) (cur - pms));
John Durkop07cc04a2020-11-16 22:08:34 -08006462
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01006463 mbedtls_zeroize_and_free(pms, pms_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01006464 return status;
John Durkop07cc04a2020-11-16 22:08:34 -08006465}
Janos Follath6660f0e2019-06-17 08:44:03 +01006466
Przemek Stekiele47201b2022-04-19 13:53:28 +02006467static psa_status_t psa_tls12_prf_psk_to_ms_set_other_key(
6468 psa_tls12_prf_key_derivation_t *prf,
6469 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006470 size_t data_length)
Przemek Stekiele47201b2022-04-19 13:53:28 +02006471{
Gilles Peskine449bd832023-01-11 14:50:10 +01006472 if (prf->state != PSA_TLS12_PRF_STATE_SEED_SET) {
6473 return PSA_ERROR_BAD_STATE;
Przemek Stekiele47201b2022-04-19 13:53:28 +02006474 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006475
6476 if (data_length != 0) {
6477 prf->other_secret = mbedtls_calloc(1, data_length);
6478 if (prf->other_secret == NULL) {
6479 return PSA_ERROR_INSUFFICIENT_MEMORY;
6480 }
6481
6482 memcpy(prf->other_secret, data, data_length);
6483 prf->other_secret_length = data_length;
6484 } else {
Przemek Stekiele47201b2022-04-19 13:53:28 +02006485 prf->other_secret_length = 0;
6486 }
6487
6488 prf->state = PSA_TLS12_PRF_STATE_OTHER_KEY_SET;
6489
Gilles Peskine449bd832023-01-11 14:50:10 +01006490 return PSA_SUCCESS;
Przemek Stekiele47201b2022-04-19 13:53:28 +02006491}
6492
Janos Follath6660f0e2019-06-17 08:44:03 +01006493static psa_status_t psa_tls12_prf_psk_to_ms_input(
6494 psa_tls12_prf_key_derivation_t *prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01006495 psa_key_derivation_step_t step,
6496 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006497 size_t data_length)
Janos Follath6660f0e2019-06-17 08:44:03 +01006498{
Gilles Peskine449bd832023-01-11 14:50:10 +01006499 switch (step) {
Przemek Stekiele47201b2022-04-19 13:53:28 +02006500 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006501 return psa_tls12_prf_psk_to_ms_set_key(prf,
6502 data, data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02006503 break;
6504 case PSA_KEY_DERIVATION_INPUT_OTHER_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006505 return psa_tls12_prf_psk_to_ms_set_other_key(prf,
6506 data,
6507 data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02006508 break;
6509 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006510 return psa_tls12_prf_input(prf, step, data, data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02006511 break;
Janos Follath6660f0e2019-06-17 08:44:03 +01006512
Przemek Stekiele47201b2022-04-19 13:53:28 +02006513 }
Janos Follath6660f0e2019-06-17 08:44:03 +01006514}
John Durkop07cc04a2020-11-16 22:08:34 -08006515#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006516
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006517#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
6518static psa_status_t psa_tls12_ecjpake_to_pms_input(
6519 psa_tls12_ecjpake_to_pms_t *ecjpake,
Andrzej Kurek702776f2022-09-16 06:22:44 -04006520 psa_key_derivation_step_t step,
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006521 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006522 size_t data_length)
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006523{
Gilles Peskine449bd832023-01-11 14:50:10 +01006524 if (data_length != PSA_TLS12_ECJPAKE_TO_PMS_INPUT_SIZE ||
6525 step != PSA_KEY_DERIVATION_INPUT_SECRET) {
6526 return PSA_ERROR_INVALID_ARGUMENT;
Andrzej Kurek5603efd2022-09-26 10:49:16 -04006527 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006528
6529 /* Check if the passed point is in an uncompressed form */
Gilles Peskine449bd832023-01-11 14:50:10 +01006530 if (data[0] != 0x04) {
6531 return PSA_ERROR_INVALID_ARGUMENT;
6532 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006533
6534 /* Only K.X has to be extracted - bytes 1 to 32 inclusive. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006535 memcpy(ecjpake->data, data + 1, PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE);
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006536
Gilles Peskine449bd832023-01-11 14:50:10 +01006537 return PSA_SUCCESS;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006538}
6539#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306540
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306541#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306542static psa_status_t psa_pbkdf2_set_input_cost(
6543 psa_pbkdf2_key_derivation_t *pbkdf2,
6544 psa_key_derivation_step_t step,
6545 uint64_t data)
6546{
6547 if (step != PSA_KEY_DERIVATION_INPUT_COST) {
6548 return PSA_ERROR_INVALID_ARGUMENT;
6549 }
6550
6551 if (pbkdf2->state != PSA_PBKDF2_STATE_INIT) {
6552 return PSA_ERROR_BAD_STATE;
6553 }
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05306554
Kusumit Ghoderaoe66a8ad2023-05-24 12:30:43 +05306555 if (data > PSA_VENDOR_PBKDF2_MAX_ITERATIONS) {
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05306556 return PSA_ERROR_NOT_SUPPORTED;
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306557 }
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05306558
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306559 if (data == 0) {
6560 return PSA_ERROR_INVALID_ARGUMENT;
6561 }
Kusumit Ghoderaoe66a8ad2023-05-24 12:30:43 +05306562
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306563 pbkdf2->input_cost = data;
6564 pbkdf2->state = PSA_PBKDF2_STATE_INPUT_COST_SET;
6565
6566 return PSA_SUCCESS;
6567}
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306568
6569static psa_status_t psa_pbkdf2_set_salt(psa_pbkdf2_key_derivation_t *pbkdf2,
6570 const uint8_t *data,
6571 size_t data_length)
6572{
Gilles Peskineead17662023-08-20 22:02:51 +02006573 if (pbkdf2->state == PSA_PBKDF2_STATE_INPUT_COST_SET) {
6574 pbkdf2->state = PSA_PBKDF2_STATE_SALT_SET;
6575 } else if (pbkdf2->state == PSA_PBKDF2_STATE_SALT_SET) {
6576 /* Appending to existing salt. No state change. */
6577 } else {
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306578 return PSA_ERROR_BAD_STATE;
6579 }
6580
Gilles Peskineca57d782023-07-20 19:08:06 +02006581 if (data_length == 0) {
Gilles Peskineead17662023-08-20 22:02:51 +02006582 /* Appending an empty string, nothing to do. */
6583 } else {
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306584 uint8_t *next_salt;
Kusumit Ghoderaob538bb72023-05-24 12:32:14 +05306585
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306586 next_salt = mbedtls_calloc(1, data_length + pbkdf2->salt_length);
6587 if (next_salt == NULL) {
Kusumit Ghoderaod0422f32023-05-08 15:56:19 +05306588 return PSA_ERROR_INSUFFICIENT_MEMORY;
6589 }
6590
Gilles Peskineead17662023-08-20 22:02:51 +02006591 if (pbkdf2->salt_length != 0) {
6592 memcpy(next_salt, pbkdf2->salt, pbkdf2->salt_length);
6593 }
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306594 memcpy(next_salt + pbkdf2->salt_length, data, data_length);
Kusumit Ghoderaod0422f32023-05-08 15:56:19 +05306595 pbkdf2->salt_length += data_length;
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306596 mbedtls_free(pbkdf2->salt);
6597 pbkdf2->salt = next_salt;
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306598 }
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306599 return PSA_SUCCESS;
6600}
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306601
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05306602#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306603static psa_status_t psa_pbkdf2_hmac_set_password(psa_algorithm_t hash_alg,
Kusumit Ghoderaoaac9a582023-05-24 14:19:17 +05306604 const uint8_t *input,
6605 size_t input_len,
6606 uint8_t *output,
Kusumit Ghoderao91f99f52023-05-24 22:21:48 +05306607 size_t *output_len)
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306608{
6609 psa_status_t status = PSA_SUCCESS;
6610 if (input_len > PSA_HASH_BLOCK_LENGTH(hash_alg)) {
6611 status = psa_hash_compute(hash_alg, input, input_len, output,
Kusumit Ghoderao91f99f52023-05-24 22:21:48 +05306612 PSA_HMAC_MAX_HASH_BLOCK_SIZE, output_len);
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306613 } else {
6614 memcpy(output, input, input_len);
Kusumit Ghoderao91f99f52023-05-24 22:21:48 +05306615 *output_len = PSA_HASH_BLOCK_LENGTH(hash_alg);
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306616 }
6617 return status;
6618}
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05306619#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC */
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306620
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05306621#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128)
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306622static psa_status_t psa_pbkdf2_cmac_set_password(const uint8_t *input,
6623 size_t input_len,
6624 uint8_t *output,
6625 size_t *output_len)
6626{
6627 psa_status_t status = PSA_SUCCESS;
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306628 if (input_len != PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC)) {
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306629 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Kusumit Ghoderao3fde8fe2023-06-27 10:41:43 +05306630 uint8_t zeros[16] = { 0 };
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306631 psa_set_key_type(&attributes, PSA_KEY_TYPE_AES);
6632 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(sizeof(zeros)));
6633 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306634 /* Passing PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC) as
Kusumit Ghoderao5f3345a2023-07-27 21:21:38 +05306635 * mac_size as the driver function sets mac_output_length = mac_size
6636 * on success. See https://github.com/Mbed-TLS/mbedtls/issues/7801 */
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306637 status = psa_driver_wrapper_mac_compute(&attributes,
6638 zeros, sizeof(zeros),
6639 PSA_ALG_CMAC, input, input_len,
6640 output,
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306641 PSA_MAC_LENGTH(PSA_KEY_TYPE_AES,
6642 128U,
6643 PSA_ALG_CMAC),
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306644 output_len);
6645 } else {
6646 memcpy(output, input, input_len);
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306647 *output_len = PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC);
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306648 }
6649 return status;
6650}
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05306651#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128 */
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306652
6653static psa_status_t psa_pbkdf2_set_password(psa_pbkdf2_key_derivation_t *pbkdf2,
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306654 psa_algorithm_t kdf_alg,
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306655 const uint8_t *data,
6656 size_t data_length)
6657{
Kusumit Ghoderaoaac9a582023-05-24 14:19:17 +05306658 psa_status_t status = PSA_SUCCESS;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306659 if (pbkdf2->state != PSA_PBKDF2_STATE_SALT_SET) {
6660 return PSA_ERROR_BAD_STATE;
6661 }
6662
Kusumit Ghoderaof3e696d2023-07-28 13:30:50 +05306663#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306664 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
6665 psa_algorithm_t hash_alg = PSA_ALG_PBKDF2_HMAC_GET_HASH(kdf_alg);
6666 status = psa_pbkdf2_hmac_set_password(hash_alg, data, data_length,
6667 pbkdf2->password,
6668 &pbkdf2->password_length);
Kusumit Ghoderaof3e696d2023-07-28 13:30:50 +05306669 } else
6670#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC */
6671#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128)
6672 if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306673 status = psa_pbkdf2_cmac_set_password(data, data_length,
6674 pbkdf2->password,
6675 &pbkdf2->password_length);
Kusumit Ghoderaof3e696d2023-07-28 13:30:50 +05306676 } else
6677#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128 */
6678 {
6679 return PSA_ERROR_INVALID_ARGUMENT;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306680 }
6681
6682 pbkdf2->state = PSA_PBKDF2_STATE_PASSWORD_SET;
6683
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306684 return status;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306685}
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05306686
6687static psa_status_t psa_pbkdf2_input(psa_pbkdf2_key_derivation_t *pbkdf2,
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306688 psa_algorithm_t kdf_alg,
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05306689 psa_key_derivation_step_t step,
6690 const uint8_t *data,
6691 size_t data_length)
6692{
6693 switch (step) {
6694 case PSA_KEY_DERIVATION_INPUT_SALT:
6695 return psa_pbkdf2_set_salt(pbkdf2, data, data_length);
6696 case PSA_KEY_DERIVATION_INPUT_PASSWORD:
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306697 return psa_pbkdf2_set_password(pbkdf2, kdf_alg, data, data_length);
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05306698 default:
6699 return PSA_ERROR_INVALID_ARGUMENT;
6700 }
6701}
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306702#endif /* PSA_HAVE_SOFT_PBKDF2 */
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306703
Gilles Peskineb8965192019-09-24 16:21:10 +02006704/** Check whether the given key type is acceptable for the given
6705 * input step of a key derivation.
6706 *
6707 * Secret inputs must have the type #PSA_KEY_TYPE_DERIVE.
6708 * Non-secret inputs must have the type #PSA_KEY_TYPE_RAW_DATA.
6709 * Both secret and non-secret inputs can alternatively have the type
6710 * #PSA_KEY_TYPE_NONE, which is never the type of a key object, meaning
6711 * that the input was passed as a buffer rather than via a key object.
6712 */
Gilles Peskine224b0d62019-09-23 18:13:17 +02006713static int psa_key_derivation_check_input_type(
6714 psa_key_derivation_step_t step,
Gilles Peskine449bd832023-01-11 14:50:10 +01006715 psa_key_type_t key_type)
Gilles Peskine224b0d62019-09-23 18:13:17 +02006716{
Gilles Peskine449bd832023-01-11 14:50:10 +01006717 switch (step) {
Gilles Peskine224b0d62019-09-23 18:13:17 +02006718 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006719 if (key_type == PSA_KEY_TYPE_DERIVE) {
6720 return PSA_SUCCESS;
6721 }
6722 if (key_type == PSA_KEY_TYPE_NONE) {
6723 return PSA_SUCCESS;
6724 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02006725 break;
Przemek Stekiela7695a22022-04-07 15:39:01 +02006726 case PSA_KEY_DERIVATION_INPUT_OTHER_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006727 if (key_type == PSA_KEY_TYPE_DERIVE) {
6728 return PSA_SUCCESS;
6729 }
6730 if (key_type == PSA_KEY_TYPE_NONE) {
6731 return PSA_SUCCESS;
6732 }
Przemek Stekiela7695a22022-04-07 15:39:01 +02006733 break;
Gilles Peskine224b0d62019-09-23 18:13:17 +02006734 case PSA_KEY_DERIVATION_INPUT_LABEL:
6735 case PSA_KEY_DERIVATION_INPUT_SALT:
6736 case PSA_KEY_DERIVATION_INPUT_INFO:
6737 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskine449bd832023-01-11 14:50:10 +01006738 if (key_type == PSA_KEY_TYPE_RAW_DATA) {
6739 return PSA_SUCCESS;
6740 }
6741 if (key_type == PSA_KEY_TYPE_NONE) {
6742 return PSA_SUCCESS;
6743 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02006744 break;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306745 case PSA_KEY_DERIVATION_INPUT_PASSWORD:
6746 if (key_type == PSA_KEY_TYPE_PASSWORD) {
6747 return PSA_SUCCESS;
6748 }
6749 if (key_type == PSA_KEY_TYPE_DERIVE) {
6750 return PSA_SUCCESS;
6751 }
6752 if (key_type == PSA_KEY_TYPE_NONE) {
6753 return PSA_SUCCESS;
6754 }
6755 break;
Gilles Peskine224b0d62019-09-23 18:13:17 +02006756 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006757 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine224b0d62019-09-23 18:13:17 +02006758}
6759
Janos Follathb80a94e2019-06-12 15:54:46 +01006760static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006761 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01006762 psa_key_derivation_step_t step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02006763 psa_key_type_t key_type,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01006764 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006765 size_t data_length)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006766{
Gilles Peskine46d7faf2019-09-23 19:22:55 +02006767 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006768 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
Gilles Peskine46d7faf2019-09-23 19:22:55 +02006769
Gilles Peskine449bd832023-01-11 14:50:10 +01006770 status = psa_key_derivation_check_input_type(step, key_type);
6771 if (status != PSA_SUCCESS) {
Gilles Peskine224b0d62019-09-23 18:13:17 +02006772 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006773 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02006774
Przemek Stekiel69c46792022-06-10 12:59:51 +02006775#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006776 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
6777 status = psa_hkdf_input(&operation->ctx.hkdf, kdf_alg,
6778 step, data, data_length);
6779 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02006780#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08006781#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006782 if (PSA_ALG_IS_TLS12_PRF(kdf_alg)) {
6783 status = psa_tls12_prf_input(&operation->ctx.tls12_prf,
6784 step, data, data_length);
6785 } else
John Durkop07cc04a2020-11-16 22:08:34 -08006786#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF */
6787#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006788 if (PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
6789 status = psa_tls12_prf_psk_to_ms_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_PSK_TO_MS */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006793#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006794 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006795 status = psa_tls12_ecjpake_to_pms_input(
Gilles Peskine449bd832023-01-11 14:50:10 +01006796 &operation->ctx.tls12_ecjpake_to_pms, step, data, data_length);
6797 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006798#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306799#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05306800 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306801 status = psa_pbkdf2_input(&operation->ctx.pbkdf2, kdf_alg,
6802 step, data, data_length);
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05306803 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306804#endif /* PSA_HAVE_SOFT_PBKDF2 */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006805 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006806 /* This can't happen unless the operation object was not initialized */
Steven Cooreman74afe472021-02-10 17:19:22 +01006807 (void) data;
6808 (void) data_length;
6809 (void) kdf_alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01006810 return PSA_ERROR_BAD_STATE;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006811 }
6812
Gilles Peskine224b0d62019-09-23 18:13:17 +02006813exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01006814 if (status != PSA_SUCCESS) {
6815 psa_key_derivation_abort(operation);
6816 }
6817 return status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006818}
6819
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05306820static psa_status_t psa_key_derivation_input_integer_internal(
6821 psa_key_derivation_operation_t *operation,
6822 psa_key_derivation_step_t step,
6823 uint64_t value)
6824{
6825 psa_status_t status;
6826 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
6827
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306828#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05306829 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306830 status = psa_pbkdf2_set_input_cost(
6831 &operation->ctx.pbkdf2, step, value);
6832 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306833#endif /* PSA_HAVE_SOFT_PBKDF2 */
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05306834 {
Kusumit Ghoderao3a18dee2023-04-07 16:16:27 +05306835 (void) step;
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05306836 (void) value;
6837 (void) kdf_alg;
Kusumit Ghoderaoa14ae5a2023-04-19 14:16:26 +05306838 status = PSA_ERROR_INVALID_ARGUMENT;
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05306839 }
6840
6841 if (status != PSA_SUCCESS) {
6842 psa_key_derivation_abort(operation);
6843 }
6844 return status;
6845}
6846
Janos Follath51f4a0f2019-06-14 11:35:55 +01006847psa_status_t psa_key_derivation_input_bytes(
6848 psa_key_derivation_operation_t *operation,
6849 psa_key_derivation_step_t step,
6850 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006851 size_t data_length)
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01006852{
Gilles Peskine449bd832023-01-11 14:50:10 +01006853 return psa_key_derivation_input_internal(operation, step,
6854 PSA_KEY_TYPE_NONE,
6855 data, data_length);
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01006856}
6857
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05306858psa_status_t psa_key_derivation_input_integer(
6859 psa_key_derivation_operation_t *operation,
6860 psa_key_derivation_step_t step,
6861 uint64_t value)
6862{
6863 return psa_key_derivation_input_integer_internal(operation, step, value);
6864}
6865
Janos Follath51f4a0f2019-06-14 11:35:55 +01006866psa_status_t psa_key_derivation_input_key(
6867 psa_key_derivation_operation_t *operation,
6868 psa_key_derivation_step_t step,
Gilles Peskine449bd832023-01-11 14:50:10 +01006869 mbedtls_svc_key_id_t key)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006870{
Ronald Cronf95a2b12020-10-22 15:24:49 +02006871 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01006872 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006873 psa_key_slot_t *slot;
Gilles Peskine178c9aa2019-09-24 18:21:06 +02006874
Ronald Cron5c522922020-11-14 16:35:34 +01006875 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01006876 key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg);
6877 if (status != PSA_SUCCESS) {
6878 psa_key_derivation_abort(operation);
6879 return status;
Gilles Peskine593773d2019-09-23 18:17:40 +02006880 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02006881
Kusumit Ghoderao3128c5d2023-05-03 12:27:57 +05306882 /* Passing a key object as a SECRET or PASSWORD input unlocks the
6883 * permission to output to a key object. */
6884 if (step == PSA_KEY_DERIVATION_INPUT_SECRET ||
6885 step == PSA_KEY_DERIVATION_INPUT_PASSWORD) {
Gilles Peskine178c9aa2019-09-24 18:21:06 +02006886 operation->can_output_key = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01006887 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02006888
Gilles Peskine449bd832023-01-11 14:50:10 +01006889 status = psa_key_derivation_input_internal(operation,
6890 step, slot->attr.type,
6891 slot->key.data,
6892 slot->key.bytes);
Ronald Cronf95a2b12020-10-22 15:24:49 +02006893
Gilles Peskine449bd832023-01-11 14:50:10 +01006894 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02006895
Gilles Peskine449bd832023-01-11 14:50:10 +01006896 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006897}
Gilles Peskineea0fb492018-07-12 17:17:20 +02006898
6899
6900
6901/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02006902/* Key agreement */
6903/****************************************************************/
6904
Gilles Peskine449bd832023-01-11 14:50:10 +01006905psa_status_t psa_key_agreement_raw_builtin(const psa_key_attributes_t *attributes,
6906 const uint8_t *key_buffer,
6907 size_t key_buffer_size,
6908 psa_algorithm_t alg,
6909 const uint8_t *peer_key,
6910 size_t peer_key_length,
6911 uint8_t *shared_secret,
6912 size_t shared_secret_size,
6913 size_t *shared_secret_length)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02006914{
Gilles Peskine449bd832023-01-11 14:50:10 +01006915 switch (alg) {
John Durkop6ba40d12020-11-10 08:50:04 -08006916#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskine0216fe12019-04-11 21:23:21 +02006917 case PSA_ALG_ECDH:
Gilles Peskine449bd832023-01-11 14:50:10 +01006918 return mbedtls_psa_key_agreement_ecdh(attributes, key_buffer,
6919 key_buffer_size, alg,
6920 peer_key, peer_key_length,
6921 shared_secret,
6922 shared_secret_size,
6923 shared_secret_length);
Gilles Peskine01d718c2018-09-18 12:01:02 +02006924#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Przemek Stekielfb3dd542022-12-01 14:59:15 +01006925
6926#if defined(MBEDTLS_PSA_BUILTIN_ALG_FFDH)
6927 case PSA_ALG_FFDH:
Przemek Stekiel152bb462023-06-01 11:52:39 +02006928 return mbedtls_psa_ffdh_key_agreement(attributes,
Przemek Stekiel359f4622022-12-05 14:11:55 +01006929 peer_key,
6930 peer_key_length,
6931 key_buffer,
6932 key_buffer_size,
6933 shared_secret,
6934 shared_secret_size,
6935 shared_secret_length);
Przemek Stekielfb3dd542022-12-01 14:59:15 +01006936#endif /* MBEDTLS_PSA_BUILTIN_ALG_FFDH */
6937
Gilles Peskine01d718c2018-09-18 12:01:02 +02006938 default:
Aditya Deshpande17845b82022-10-13 17:21:01 +01006939 (void) attributes;
6940 (void) key_buffer;
6941 (void) key_buffer_size;
Gilles Peskine93f85002018-11-16 16:43:31 +01006942 (void) peer_key;
6943 (void) peer_key_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02006944 (void) shared_secret;
6945 (void) shared_secret_size;
6946 (void) shared_secret_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01006947 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine01d718c2018-09-18 12:01:02 +02006948 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02006949}
Gilles Peskine01d718c2018-09-18 12:01:02 +02006950
Aditya Deshpande17845b82022-10-13 17:21:01 +01006951/** Internal function for raw key agreement
6952 * Calls the driver wrapper which will hand off key agreement task
Aditya Deshpande40c05cc2022-10-14 16:41:40 +01006953 * to the driver's implementation if a driver is present.
6954 * Fallback specified in the driver wrapper is built-in raw key agreement
Aditya Deshpande17845b82022-10-13 17:21:01 +01006955 * (psa_key_agreement_raw_builtin).
6956 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006957static psa_status_t psa_key_agreement_raw_internal(psa_algorithm_t alg,
6958 psa_key_slot_t *private_key,
6959 const uint8_t *peer_key,
6960 size_t peer_key_length,
6961 uint8_t *shared_secret,
6962 size_t shared_secret_size,
6963 size_t *shared_secret_length)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006964{
Gilles Peskine449bd832023-01-11 14:50:10 +01006965 if (!PSA_ALG_IS_RAW_KEY_AGREEMENT(alg)) {
6966 return PSA_ERROR_NOT_SUPPORTED;
6967 }
Aditya Deshpande17845b82022-10-13 17:21:01 +01006968
6969 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01006970 .core = private_key->attr
Aditya Deshpande17845b82022-10-13 17:21:01 +01006971 };
6972
Gilles Peskine449bd832023-01-11 14:50:10 +01006973 return psa_driver_wrapper_key_agreement(&attributes,
6974 private_key->key.data,
6975 private_key->key.bytes, alg,
6976 peer_key, peer_key_length,
6977 shared_secret,
6978 shared_secret_size,
6979 shared_secret_length);
Gilles Peskine0216fe12019-04-11 21:23:21 +02006980}
6981
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02006982/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine01d718c2018-09-18 12:01:02 +02006983 * to potentially free embedded data structures and wipe confidential data.
6984 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006985static psa_status_t psa_key_agreement_internal(psa_key_derivation_operation_t *operation,
6986 psa_key_derivation_step_t step,
6987 psa_key_slot_t *private_key,
6988 const uint8_t *peer_key,
6989 size_t peer_key_length)
Gilles Peskine01d718c2018-09-18 12:01:02 +02006990{
6991 psa_status_t status;
Aditya Deshpande2f7fd762022-11-22 11:10:34 +00006992 uint8_t shared_secret[PSA_RAW_KEY_AGREEMENT_OUTPUT_MAX_SIZE];
Gilles Peskine01d718c2018-09-18 12:01:02 +02006993 size_t shared_secret_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01006994 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE(operation->alg);
Gilles Peskine01d718c2018-09-18 12:01:02 +02006995
6996 /* Step 1: run the secret agreement algorithm to generate the shared
6997 * secret. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006998 status = psa_key_agreement_raw_internal(ka_alg,
6999 private_key,
7000 peer_key, peer_key_length,
7001 shared_secret,
7002 sizeof(shared_secret),
7003 &shared_secret_length);
7004 if (status != PSA_SUCCESS) {
Gilles Peskine12313cd2018-06-20 00:20:32 +02007005 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007006 }
Gilles Peskine12313cd2018-06-20 00:20:32 +02007007
Gilles Peskineb0b255c2018-07-06 17:01:38 +02007008 /* Step 2: set up the key derivation to generate key material from
Gilles Peskine224b0d62019-09-23 18:13:17 +02007009 * the shared secret. A shared secret is permitted wherever a key
7010 * of type DERIVE is permitted. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007011 status = psa_key_derivation_input_internal(operation, step,
7012 PSA_KEY_TYPE_DERIVE,
7013 shared_secret,
7014 shared_secret_length);
Gilles Peskine12313cd2018-06-20 00:20:32 +02007015exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007016 mbedtls_platform_zeroize(shared_secret, shared_secret_length);
7017 return status;
Gilles Peskine12313cd2018-06-20 00:20:32 +02007018}
7019
Gilles Peskine449bd832023-01-11 14:50:10 +01007020psa_status_t psa_key_derivation_key_agreement(psa_key_derivation_operation_t *operation,
7021 psa_key_derivation_step_t step,
7022 mbedtls_svc_key_id_t private_key,
7023 const uint8_t *peer_key,
7024 size_t peer_key_length)
Gilles Peskine12313cd2018-06-20 00:20:32 +02007025{
Ronald Cronf95a2b12020-10-22 15:24:49 +02007026 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01007027 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01007028 psa_key_slot_t *slot;
Ronald Cronf95a2b12020-10-22 15:24:49 +02007029
Gilles Peskine449bd832023-01-11 14:50:10 +01007030 if (!PSA_ALG_IS_KEY_AGREEMENT(operation->alg)) {
7031 return PSA_ERROR_INVALID_ARGUMENT;
7032 }
Ronald Cron5c522922020-11-14 16:35:34 +01007033 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01007034 private_key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg);
7035 if (status != PSA_SUCCESS) {
7036 return status;
7037 }
7038 status = psa_key_agreement_internal(operation, step,
7039 slot,
7040 peer_key, peer_key_length);
7041 if (status != PSA_SUCCESS) {
7042 psa_key_derivation_abort(operation);
7043 } else {
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007044 /* If a private key has been added as SECRET, we allow the derived
7045 * key material to be used as a key in PSA Crypto. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007046 if (step == PSA_KEY_DERIVATION_INPUT_SECRET) {
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007047 operation->can_output_key = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01007048 }
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007049 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007050
Gilles Peskine449bd832023-01-11 14:50:10 +01007051 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007052
Gilles Peskine449bd832023-01-11 14:50:10 +01007053 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskineaf3baab2018-06-27 22:55:52 +02007054}
7055
Gilles Peskine449bd832023-01-11 14:50:10 +01007056psa_status_t psa_raw_key_agreement(psa_algorithm_t alg,
7057 mbedtls_svc_key_id_t private_key,
7058 const uint8_t *peer_key,
7059 size_t peer_key_length,
7060 uint8_t *output,
7061 size_t output_size,
7062 size_t *output_length)
Gilles Peskine0216fe12019-04-11 21:23:21 +02007063{
Ronald Cronf95a2b12020-10-22 15:24:49 +02007064 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01007065 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +02007066 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007067 size_t expected_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02007068
Gilles Peskine449bd832023-01-11 14:50:10 +01007069 if (!PSA_ALG_IS_KEY_AGREEMENT(alg)) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007070 status = PSA_ERROR_INVALID_ARGUMENT;
7071 goto exit;
7072 }
Ronald Cron5c522922020-11-14 16:35:34 +01007073 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01007074 private_key, &slot, PSA_KEY_USAGE_DERIVE, alg);
7075 if (status != PSA_SUCCESS) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007076 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007077 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02007078
Gilles Peskine3e561302022-04-14 00:17:15 +02007079 /* PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() is in general an upper bound
7080 * for the output size. The PSA specification only guarantees that this
7081 * function works if output_size >= PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE(...),
7082 * but it might be nice to allow smaller buffers if the output fits.
7083 * At the time of writing this comment, with only ECDH implemented,
7084 * PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() is exact so the point is moot.
7085 * If FFDH is implemented, PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() can easily
7086 * be exact for it as well. */
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007087 expected_length =
Gilles Peskine449bd832023-01-11 14:50:10 +01007088 PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE(slot->attr.type, slot->attr.bits);
7089 if (output_size < expected_length) {
Gilles Peskine3e561302022-04-14 00:17:15 +02007090 status = PSA_ERROR_BUFFER_TOO_SMALL;
7091 goto exit;
7092 }
7093
Gilles Peskine449bd832023-01-11 14:50:10 +01007094 status = psa_key_agreement_raw_internal(alg, slot,
7095 peer_key, peer_key_length,
7096 output, output_size,
7097 output_length);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007098
7099exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007100 if (status != PSA_SUCCESS) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007101 /* If an error happens and is not handled properly, the output
7102 * may be used as a key to protect sensitive data. Arrange for such
7103 * a key to be random, which is likely to result in decryption or
7104 * verification errors. This is better than filling the buffer with
7105 * some constant data such as zeros, which would result in the data
7106 * being protected with a reproducible, easily knowable key.
7107 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007108 psa_generate_random(output, output_size);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007109 *output_length = output_size;
7110 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007111
Gilles Peskine449bd832023-01-11 14:50:10 +01007112 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007113
Gilles Peskine449bd832023-01-11 14:50:10 +01007114 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine0216fe12019-04-11 21:23:21 +02007115}
Gilles Peskine86a440b2018-11-12 18:39:40 +01007116
7117
Gilles Peskine30524eb2020-11-13 17:02:26 +01007118
Gilles Peskine86a440b2018-11-12 18:39:40 +01007119/****************************************************************/
7120/* Random generation */
Gilles Peskine53d991e2018-07-12 01:14:59 +02007121/****************************************************************/
Gilles Peskine12313cd2018-06-20 00:20:32 +02007122
Gilles Peskine672a7712023-04-28 21:00:28 +02007123#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
7124#include "entropy_poll.h"
7125#endif
7126
Gilles Peskine30524eb2020-11-13 17:02:26 +01007127/** Initialize the PSA random generator.
7128 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007129static void mbedtls_psa_random_init(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01007130{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007131#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine449bd832023-01-11 14:50:10 +01007132 memset(rng, 0, sizeof(*rng));
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007133#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
7134
Gilles Peskine30524eb2020-11-13 17:02:26 +01007135 /* Set default configuration if
7136 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007137 if (rng->entropy_init == NULL) {
Gilles Peskine30524eb2020-11-13 17:02:26 +01007138 rng->entropy_init = mbedtls_entropy_init;
Gilles Peskine449bd832023-01-11 14:50:10 +01007139 }
7140 if (rng->entropy_free == NULL) {
Gilles Peskine30524eb2020-11-13 17:02:26 +01007141 rng->entropy_free = mbedtls_entropy_free;
Gilles Peskine449bd832023-01-11 14:50:10 +01007142 }
Gilles Peskine30524eb2020-11-13 17:02:26 +01007143
Gilles Peskine449bd832023-01-11 14:50:10 +01007144 rng->entropy_init(&rng->entropy);
Gilles Peskine30524eb2020-11-13 17:02:26 +01007145#if defined(MBEDTLS_PSA_INJECT_ENTROPY) && \
7146 defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
7147 /* The PSA entropy injection feature depends on using NV seed as an entropy
7148 * source. Add NV seed as an entropy source for PSA entropy injection. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007149 mbedtls_entropy_add_source(&rng->entropy,
7150 mbedtls_nv_seed_poll, NULL,
7151 MBEDTLS_ENTROPY_BLOCK_SIZE,
7152 MBEDTLS_ENTROPY_SOURCE_STRONG);
Gilles Peskine30524eb2020-11-13 17:02:26 +01007153#endif
7154
Gilles Peskine449bd832023-01-11 14:50:10 +01007155 mbedtls_psa_drbg_init(MBEDTLS_PSA_RANDOM_STATE);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007156#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007157}
7158
7159/** Deinitialize the PSA random generator.
7160 */
Valerio Setti83e0de82023-11-24 12:13:05 +01007161static void mbedtls_psa_random_free(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01007162{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007163#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Valerio Setti83e0de82023-11-24 12:13:05 +01007164 memset(rng, 0, sizeof(*rng));
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007165#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Valerio Setti83e0de82023-11-24 12:13:05 +01007166 mbedtls_psa_drbg_free(MBEDTLS_PSA_RANDOM_STATE);
7167 rng->entropy_free(&rng->entropy);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007168#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007169}
7170
7171/** Seed the PSA random generator.
7172 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007173static psa_status_t mbedtls_psa_random_seed(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01007174{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007175#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
7176 /* Do nothing: the external RNG seeds itself. */
7177 (void) rng;
Gilles Peskine449bd832023-01-11 14:50:10 +01007178 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007179#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007180 const unsigned char drbg_seed[] = "PSA";
Gilles Peskine449bd832023-01-11 14:50:10 +01007181 int ret = mbedtls_psa_drbg_seed(&rng->entropy,
7182 drbg_seed, sizeof(drbg_seed) - 1);
7183 return mbedtls_to_psa_error(ret);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007184#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007185}
7186
Gilles Peskine449bd832023-01-11 14:50:10 +01007187psa_status_t psa_generate_random(uint8_t *output,
7188 size_t output_size)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007189{
Gilles Peskinee59236f2018-01-27 23:32:46 +01007190 GUARD_MODULE_INITIALIZED;
7191
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007192#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
7193
7194 size_t output_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007195 psa_status_t status = mbedtls_psa_external_get_random(&global_data.rng,
7196 output, output_size,
7197 &output_length);
7198 if (status != PSA_SUCCESS) {
7199 return status;
7200 }
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007201 /* Breaking up a request into smaller chunks is currently not supported
Tom Cosgrove1797b052022-12-04 17:19:59 +00007202 * for the external RNG interface. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007203 if (output_length != output_size) {
7204 return PSA_ERROR_INSUFFICIENT_ENTROPY;
7205 }
7206 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007207
7208#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
7209
Gilles Peskine449bd832023-01-11 14:50:10 +01007210 while (output_size > 0) {
Gilles Peskine71ddab92021-01-04 21:01:07 +01007211 size_t request_size =
Gilles Peskine449bd832023-01-11 14:50:10 +01007212 (output_size > MBEDTLS_PSA_RANDOM_MAX_REQUEST ?
7213 MBEDTLS_PSA_RANDOM_MAX_REQUEST :
7214 output_size);
7215 int ret = mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE,
7216 output, request_size);
7217 if (ret != 0) {
7218 return mbedtls_to_psa_error(ret);
7219 }
Gilles Peskine71ddab92021-01-04 21:01:07 +01007220 output_size -= request_size;
7221 output += request_size;
Gilles Peskinef181eca2019-08-07 13:49:00 +02007222 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007223 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007224#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskinee59236f2018-01-27 23:32:46 +01007225}
7226
Gilles Peskine8814fc42020-12-14 15:33:44 +01007227/* Wrapper function allowing the classic API to use the PSA RNG.
Gilles Peskine9c3e0602021-01-05 16:03:55 +01007228 *
7229 * `mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE, ...)` calls
7230 * `psa_generate_random(...)`. The state parameter is ignored since the
7231 * PSA API doesn't support passing an explicit state.
7232 *
7233 * In the non-external case, psa_generate_random() calls an
7234 * `mbedtls_xxx_drbg_random` function which has exactly the same signature
7235 * and semantics as mbedtls_psa_get_random(). As an optimization,
7236 * instead of doing this back-and-forth between the PSA API and the
7237 * classic API, psa_crypto_random_impl.h defines `mbedtls_psa_get_random`
7238 * as a constant function pointer to `mbedtls_xxx_drbg_random`.
Gilles Peskine8814fc42020-12-14 15:33:44 +01007239 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007240#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
7241int mbedtls_psa_get_random(void *p_rng,
7242 unsigned char *output,
7243 size_t output_size)
Gilles Peskine8814fc42020-12-14 15:33:44 +01007244{
Gilles Peskine9c3e0602021-01-05 16:03:55 +01007245 /* This function takes a pointer to the RNG state because that's what
7246 * classic mbedtls functions using an RNG expect. The PSA RNG manages
7247 * its own state internally and doesn't let the caller access that state.
7248 * So we just ignore the state parameter, and in practice we'll pass
7249 * NULL. */
Gilles Peskine8814fc42020-12-14 15:33:44 +01007250 (void) p_rng;
Gilles Peskine449bd832023-01-11 14:50:10 +01007251 psa_status_t status = psa_generate_random(output, output_size);
7252 if (status == PSA_SUCCESS) {
7253 return 0;
7254 } else {
7255 return MBEDTLS_ERR_ENTROPY_SOURCE_FAILED;
7256 }
Gilles Peskine8814fc42020-12-14 15:33:44 +01007257}
7258#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
7259
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01007260#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
Gilles Peskine449bd832023-01-11 14:50:10 +01007261psa_status_t mbedtls_psa_inject_entropy(const uint8_t *seed,
7262 size_t seed_size)
Netanel Gonen2bcd3122018-11-19 11:53:02 +02007263{
Gilles Peskine449bd832023-01-11 14:50:10 +01007264 if (global_data.initialized) {
7265 return PSA_ERROR_NOT_PERMITTED;
7266 }
Netanel Gonen21f37cb2018-11-19 11:53:55 +02007267
Gilles Peskine449bd832023-01-11 14:50:10 +01007268 if (((seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM) ||
7269 (seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE)) ||
7270 (seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE)) {
7271 return PSA_ERROR_INVALID_ARGUMENT;
7272 }
Netanel Gonen21f37cb2018-11-19 11:53:55 +02007273
Gilles Peskine449bd832023-01-11 14:50:10 +01007274 return mbedtls_psa_storage_inject_entropy(seed, seed_size);
Netanel Gonen2bcd3122018-11-19 11:53:02 +02007275}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01007276#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02007277
Ronald Cron3772afe2021-02-08 16:10:05 +01007278/** Validate the key type and size for key generation
Ronald Cron01b2aba2020-10-05 09:42:02 +02007279 *
Ronald Cron3772afe2021-02-08 16:10:05 +01007280 * \param type The key type
7281 * \param bits The number of bits of the key
Ronald Cron01b2aba2020-10-05 09:42:02 +02007282 *
7283 * \retval #PSA_SUCCESS
Ronald Cron3772afe2021-02-08 16:10:05 +01007284 * The key type and size are valid.
Ronald Cron01b2aba2020-10-05 09:42:02 +02007285 * \retval #PSA_ERROR_INVALID_ARGUMENT
7286 * The size in bits of the key is not valid.
7287 * \retval #PSA_ERROR_NOT_SUPPORTED
7288 * The type and/or the size in bits of the key or the combination of
7289 * the two is not supported.
7290 */
Ronald Cron3772afe2021-02-08 16:10:05 +01007291static psa_status_t psa_validate_key_type_and_size_for_key_generation(
Gilles Peskine449bd832023-01-11 14:50:10 +01007292 psa_key_type_t type, size_t bits)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007293{
Ronald Cronf3bb7612020-10-02 20:11:59 +02007294 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007295
Gilles Peskine449bd832023-01-11 14:50:10 +01007296 if (key_type_is_raw_bytes(type)) {
7297 status = psa_validate_unstructured_key_bit_size(type, bits);
7298 if (status != PSA_SUCCESS) {
7299 return status;
7300 }
7301 } else
Valerio Settif6d4dfb2023-07-10 10:55:12 +02007302#if defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007303 if (PSA_KEY_TYPE_IS_RSA(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
7304 if (bits > PSA_VENDOR_RSA_MAX_KEY_BITS) {
7305 return PSA_ERROR_NOT_SUPPORTED;
7306 }
Waleed Elmelegyd7bdbbe2023-07-20 16:26:58 +00007307 if (bits < PSA_VENDOR_RSA_GENERATE_MIN_KEY_BITS) {
Waleed Elmelegyab570712023-07-05 16:40:58 +00007308 return PSA_ERROR_NOT_SUPPORTED;
7309 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +02007310
Ronald Cron01b2aba2020-10-05 09:42:02 +02007311 /* Accept only byte-aligned keys, for the same reasons as
7312 * in psa_import_rsa_key(). */
Gilles Peskine449bd832023-01-11 14:50:10 +01007313 if (bits % 8 != 0) {
7314 return PSA_ERROR_NOT_SUPPORTED;
7315 }
7316 } else
Valerio Settif6d4dfb2023-07-10 10:55:12 +02007317#endif /* defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02007318
Valerio Setti6a9d0ee2023-06-21 10:07:21 +02007319#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007320 if (PSA_KEY_TYPE_IS_ECC(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
Ronald Crond81ab562021-02-16 09:01:16 +01007321 /* To avoid empty block, return successfully here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007322 return PSA_SUCCESS;
7323 } else
Valerio Setti6a9d0ee2023-06-21 10:07:21 +02007324#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_GENERATE) */
Przemek Stekielfedd1342022-12-01 15:00:02 +01007325
Valerio Settia55f0422023-07-10 15:34:41 +02007326#if defined(PSA_WANT_KEY_TYPE_DH_KEY_PAIR_GENERATE)
Przemek Stekielfedd1342022-12-01 15:00:02 +01007327 if (PSA_KEY_TYPE_IS_DH(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
Przemek Stekield1cf1ba2023-04-27 12:04:21 +02007328 if (psa_is_dh_key_size_valid(bits) == 0) {
Przemek Stekielfedd1342022-12-01 15:00:02 +01007329 return PSA_ERROR_NOT_SUPPORTED;
7330 }
7331 } else
Valerio Settia55f0422023-07-10 15:34:41 +02007332#endif /* defined(PSA_WANT_KEY_TYPE_DH_KEY_PAIR_GENERATE) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02007333 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007334 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007335 }
7336
Gilles Peskine449bd832023-01-11 14:50:10 +01007337 return PSA_SUCCESS;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007338}
7339
Ronald Cron55ed0592020-10-05 10:30:40 +02007340psa_status_t psa_generate_key_internal(
Ronald Cron2a38a6b2020-10-02 20:02:04 +02007341 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01007342 uint8_t *key_buffer, size_t key_buffer_size, size_t *key_buffer_length)
Ronald Cron01b2aba2020-10-05 09:42:02 +02007343{
7344 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2a38a6b2020-10-02 20:02:04 +02007345 psa_key_type_t type = attributes->core.type;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007346
Gilles Peskine449bd832023-01-11 14:50:10 +01007347 if ((attributes->domain_parameters == NULL) &&
7348 (attributes->domain_parameters_size != 0)) {
7349 return PSA_ERROR_INVALID_ARGUMENT;
7350 }
Ronald Cron01b2aba2020-10-05 09:42:02 +02007351
Gilles Peskine449bd832023-01-11 14:50:10 +01007352 if (key_type_is_raw_bytes(type)) {
7353 status = psa_generate_random(key_buffer, key_buffer_size);
7354 if (status != PSA_SUCCESS) {
7355 return status;
7356 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +02007357
David Brown12ca5032021-02-11 11:02:00 -07007358#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01007359 if (type == PSA_KEY_TYPE_DES) {
7360 psa_des_set_key_parity(key_buffer, key_buffer_size);
7361 }
David Brown8107e312021-02-12 08:08:46 -07007362#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine449bd832023-01-11 14:50:10 +01007363 } else
Gilles Peskinee59236f2018-01-27 23:32:46 +01007364
Valerio Setti76df8c12023-07-11 14:11:28 +02007365#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007366 if (type == PSA_KEY_TYPE_RSA_KEY_PAIR) {
7367 return mbedtls_psa_rsa_generate_key(attributes,
7368 key_buffer,
7369 key_buffer_size,
7370 key_buffer_length);
7371 } else
Valerio Setti76df8c12023-07-11 14:11:28 +02007372#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_GENERATE) */
Gilles Peskinee59236f2018-01-27 23:32:46 +01007373
Valerio Settibfeaf5b2023-06-20 13:27:46 +02007374#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007375 if (PSA_KEY_TYPE_IS_ECC(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
7376 return mbedtls_psa_ecp_generate_key(attributes,
7377 key_buffer,
7378 key_buffer_size,
7379 key_buffer_length);
7380 } else
Valerio Settibfeaf5b2023-06-20 13:27:46 +02007381#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_GENERATE) */
Przemek Stekielfedd1342022-12-01 15:00:02 +01007382
Valerio Settia55f0422023-07-10 15:34:41 +02007383#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_GENERATE)
Przemek Stekielfedd1342022-12-01 15:00:02 +01007384 if (PSA_KEY_TYPE_IS_DH(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
7385 return mbedtls_psa_ffdh_generate_key(attributes,
7386 key_buffer,
7387 key_buffer_size,
7388 key_buffer_length);
7389 } else
Valerio Settia55f0422023-07-10 15:34:41 +02007390#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_GENERATE) */
Steven Cooreman29149862020-08-05 15:43:42 +02007391 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007392 (void) key_buffer_length;
7393 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman29149862020-08-05 15:43:42 +02007394 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01007395
Gilles Peskine449bd832023-01-11 14:50:10 +01007396 return PSA_SUCCESS;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02007397}
Darryl Green0c6575a2018-11-07 16:05:30 +00007398
Gilles Peskine449bd832023-01-11 14:50:10 +01007399psa_status_t psa_generate_key(const psa_key_attributes_t *attributes,
7400 mbedtls_svc_key_id_t *key)
Gilles Peskineff5f0e72019-04-18 12:53:30 +02007401{
7402 psa_status_t status;
7403 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02007404 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cron2b56bc82020-10-05 10:02:26 +02007405 size_t key_buffer_size;
Gilles Peskine11792082019-08-06 18:36:36 +02007406
Ronald Cron81709fc2020-11-14 12:10:32 +01007407 *key = MBEDTLS_SVC_KEY_ID_INIT;
7408
Gilles Peskine0f84d622019-09-12 19:03:13 +02007409 /* Reject any attempt to create a zero-length key so that we don't
7410 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007411 if (psa_get_key_bits(attributes) == 0) {
7412 return PSA_ERROR_INVALID_ARGUMENT;
7413 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02007414
Przemyslaw Stekielc0fe8202021-10-07 11:08:56 +02007415 /* Reject any attempt to create a public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007416 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(attributes->core.type)) {
7417 return PSA_ERROR_INVALID_ARGUMENT;
7418 }
Przemyslaw Stekielc0fe8202021-10-07 11:08:56 +02007419
Gilles Peskine449bd832023-01-11 14:50:10 +01007420 status = psa_start_key_creation(PSA_KEY_CREATION_GENERATE, attributes,
7421 &slot, &driver);
7422 if (status != PSA_SUCCESS) {
Gilles Peskine11792082019-08-06 18:36:36 +02007423 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007424 }
Gilles Peskine11792082019-08-06 18:36:36 +02007425
Ronald Cron977c2472020-10-13 08:32:21 +02007426 /* In the case of a transparent key or an opaque key stored in local
Archana449608b2021-09-08 15:36:05 +05307427 * storage ( thus not in the case of generating a key in a secure element
7428 * with storage ( MBEDTLS_PSA_CRYPTO_SE_C ) ),we have to allocate a
7429 * buffer to hold the generated key material. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007430 if (slot->key.data == NULL) {
7431 if (PSA_KEY_LIFETIME_GET_LOCATION(attributes->core.lifetime) ==
7432 PSA_KEY_LOCATION_LOCAL_STORAGE) {
Ronald Cron3772afe2021-02-08 16:10:05 +01007433 status = psa_validate_key_type_and_size_for_key_generation(
Gilles Peskine449bd832023-01-11 14:50:10 +01007434 attributes->core.type, attributes->core.bits);
7435 if (status != PSA_SUCCESS) {
Ronald Cron3772afe2021-02-08 16:10:05 +01007436 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007437 }
Ronald Cron3772afe2021-02-08 16:10:05 +01007438
7439 key_buffer_size = PSA_EXPORT_KEY_OUTPUT_SIZE(
Gilles Peskine449bd832023-01-11 14:50:10 +01007440 attributes->core.type,
7441 attributes->core.bits);
7442 } else {
Ronald Cron977c2472020-10-13 08:32:21 +02007443 status = psa_driver_wrapper_get_key_buffer_size(
Gilles Peskine449bd832023-01-11 14:50:10 +01007444 attributes, &key_buffer_size);
7445 if (status != PSA_SUCCESS) {
Ronald Cron3772afe2021-02-08 16:10:05 +01007446 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007447 }
Ronald Cron977c2472020-10-13 08:32:21 +02007448 }
Ronald Cron977c2472020-10-13 08:32:21 +02007449
Gilles Peskine449bd832023-01-11 14:50:10 +01007450 status = psa_allocate_buffer_to_slot(slot, key_buffer_size);
7451 if (status != PSA_SUCCESS) {
Ronald Cron977c2472020-10-13 08:32:21 +02007452 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007453 }
Ronald Cron977c2472020-10-13 08:32:21 +02007454 }
7455
Gilles Peskine449bd832023-01-11 14:50:10 +01007456 status = psa_driver_wrapper_generate_key(attributes,
7457 slot->key.data, slot->key.bytes, &slot->key.bytes);
Gilles Peskine11792082019-08-06 18:36:36 +02007458
Gilles Peskine449bd832023-01-11 14:50:10 +01007459 if (status != PSA_SUCCESS) {
7460 psa_remove_key_data_from_memory(slot);
7461 }
Ronald Cron2b56bc82020-10-05 10:02:26 +02007462
Gilles Peskine11792082019-08-06 18:36:36 +02007463exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007464 if (status == PSA_SUCCESS) {
7465 status = psa_finish_key_creation(slot, driver, key);
7466 }
7467 if (status != PSA_SUCCESS) {
7468 psa_fail_key_creation(slot, driver);
7469 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007470
Gilles Peskine449bd832023-01-11 14:50:10 +01007471 return status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007472}
7473
Gilles Peskinee59236f2018-01-27 23:32:46 +01007474/****************************************************************/
7475/* Module setup */
7476/****************************************************************/
7477
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007478#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine5e769522018-11-20 21:59:56 +01007479psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
Gilles Peskine449bd832023-01-11 14:50:10 +01007480 void (* entropy_init)(mbedtls_entropy_context *ctx),
7481 void (* entropy_free)(mbedtls_entropy_context *ctx))
Gilles Peskine5e769522018-11-20 21:59:56 +01007482{
Gilles Peskine449bd832023-01-11 14:50:10 +01007483 if (global_data.rng_state != RNG_NOT_INITIALIZED) {
7484 return PSA_ERROR_BAD_STATE;
7485 }
Gilles Peskine30524eb2020-11-13 17:02:26 +01007486 global_data.rng.entropy_init = entropy_init;
7487 global_data.rng.entropy_free = entropy_free;
Gilles Peskine449bd832023-01-11 14:50:10 +01007488 return PSA_SUCCESS;
Gilles Peskine5e769522018-11-20 21:59:56 +01007489}
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007490#endif /* !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) */
Gilles Peskine5e769522018-11-20 21:59:56 +01007491
Gilles Peskine449bd832023-01-11 14:50:10 +01007492void mbedtls_psa_crypto_free(void)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007493{
Gilles Peskine449bd832023-01-11 14:50:10 +01007494 psa_wipe_all_key_slots();
Valerio Setti83e0de82023-11-24 12:13:05 +01007495 if (global_data.rng_state != RNG_NOT_INITIALIZED) {
7496 mbedtls_psa_random_free(&global_data.rng);
7497 }
Gilles Peskinec6b69072018-11-20 21:42:52 +01007498 /* Wipe all remaining data, including configuration.
7499 * In particular, this sets all state indicator to the value
7500 * indicating "uninitialized". */
Gilles Peskine449bd832023-01-11 14:50:10 +01007501 mbedtls_platform_zeroize(&global_data, sizeof(global_data));
Ronald Cron9ba76912021-04-10 16:57:30 +02007502
7503 /* Terminate drivers */
Gilles Peskine449bd832023-01-11 14:50:10 +01007504 psa_driver_wrapper_free();
Gilles Peskinee59236f2018-01-27 23:32:46 +01007505}
7506
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007507#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
7508/** Recover a transaction that was interrupted by a power failure.
7509 *
7510 * This function is called during initialization, before psa_crypto_init()
7511 * returns. If this function returns a failure status, the initialization
7512 * fails.
7513 */
7514static psa_status_t psa_crypto_recover_transaction(
Gilles Peskine449bd832023-01-11 14:50:10 +01007515 const psa_crypto_transaction_t *transaction)
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007516{
Gilles Peskine449bd832023-01-11 14:50:10 +01007517 switch (transaction->unknown.type) {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007518 case PSA_CRYPTO_TRANSACTION_CREATE_KEY:
7519 case PSA_CRYPTO_TRANSACTION_DESTROY_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01007520 /* TODO - fall through to the failure case until this
7521 * is implemented.
7522 * https://github.com/ARMmbed/mbed-crypto/issues/218
7523 */
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007524 default:
7525 /* We found an unsupported transaction in the storage.
7526 * We don't know what state the storage is in. Give up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007527 return PSA_ERROR_DATA_INVALID;
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007528 }
7529}
7530#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
7531
Gilles Peskine449bd832023-01-11 14:50:10 +01007532psa_status_t psa_crypto_init(void)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007533{
Gilles Peskine66fb1262018-12-10 16:29:04 +01007534 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007535
Gilles Peskinec6b69072018-11-20 21:42:52 +01007536 /* Double initialization is explicitly allowed. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007537 if (global_data.initialized != 0) {
7538 return PSA_SUCCESS;
7539 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01007540
Manuel Pégourié-Gonnard7abdf7e2023-03-09 11:17:43 +01007541 /* Init drivers */
7542 status = psa_driver_wrapper_init();
7543 if (status != PSA_SUCCESS) {
7544 goto exit;
7545 }
7546 global_data.drivers_initialized = 1;
7547
Valerio Setti402cfba2023-11-13 10:24:32 +01007548 status = psa_initialize_key_slots();
7549 if (status != PSA_SUCCESS) {
7550 goto exit;
7551 }
7552
Gilles Peskine30524eb2020-11-13 17:02:26 +01007553 /* Initialize and seed the random generator. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007554 mbedtls_psa_random_init(&global_data.rng);
Gilles Peskinec6b69072018-11-20 21:42:52 +01007555 global_data.rng_state = RNG_INITIALIZED;
Gilles Peskine449bd832023-01-11 14:50:10 +01007556 status = mbedtls_psa_random_seed(&global_data.rng);
7557 if (status != PSA_SUCCESS) {
Gilles Peskinee59236f2018-01-27 23:32:46 +01007558 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007559 }
Gilles Peskinec6b69072018-11-20 21:42:52 +01007560 global_data.rng_state = RNG_SEEDED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007561
Gilles Peskine4b734222019-07-24 15:56:31 +02007562#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007563 status = psa_crypto_load_transaction();
7564 if (status == PSA_SUCCESS) {
7565 status = psa_crypto_recover_transaction(&psa_crypto_transaction);
7566 if (status != PSA_SUCCESS) {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007567 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007568 }
7569 status = psa_crypto_stop_transaction();
7570 } else if (status == PSA_ERROR_DOES_NOT_EXIST) {
Gilles Peskinefc762652019-07-22 19:30:34 +02007571 /* There's no transaction to complete. It's all good. */
7572 status = PSA_SUCCESS;
7573 }
Gilles Peskine4b734222019-07-24 15:56:31 +02007574#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
Gilles Peskinefc762652019-07-22 19:30:34 +02007575
Gilles Peskinec6b69072018-11-20 21:42:52 +01007576 /* All done. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01007577 global_data.initialized = 1;
7578
7579exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007580 if (status != PSA_SUCCESS) {
7581 mbedtls_psa_crypto_free();
7582 }
7583 return status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007584}
7585
Yanray Wangffc3c482023-07-11 12:01:04 +08007586#if defined(PSA_WANT_ALG_SOME_PAKE)
Przemek Stekielca8d2b22023-01-17 16:21:33 +01007587psa_status_t psa_crypto_driver_pake_get_password_len(
7588 const psa_crypto_driver_pake_inputs_t *inputs,
7589 size_t *password_len)
7590{
7591 if (inputs->password_len == 0) {
7592 return PSA_ERROR_BAD_STATE;
7593 }
7594
7595 *password_len = inputs->password_len;
7596
7597 return PSA_SUCCESS;
7598}
7599
7600psa_status_t psa_crypto_driver_pake_get_password(
7601 const psa_crypto_driver_pake_inputs_t *inputs,
7602 uint8_t *buffer, size_t buffer_size, size_t *buffer_length)
7603{
7604 if (inputs->password_len == 0) {
7605 return PSA_ERROR_BAD_STATE;
7606 }
7607
7608 if (buffer_size < inputs->password_len) {
7609 return PSA_ERROR_BUFFER_TOO_SMALL;
7610 }
7611
7612 memcpy(buffer, inputs->password, inputs->password_len);
7613 *buffer_length = inputs->password_len;
7614
7615 return PSA_SUCCESS;
7616}
7617
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007618psa_status_t psa_crypto_driver_pake_get_user_len(
7619 const psa_crypto_driver_pake_inputs_t *inputs,
7620 size_t *user_len)
7621{
7622 if (inputs->user_len == 0) {
7623 return PSA_ERROR_BAD_STATE;
7624 }
7625
7626 *user_len = inputs->user_len;
7627
7628 return PSA_SUCCESS;
7629}
7630
7631psa_status_t psa_crypto_driver_pake_get_user(
7632 const psa_crypto_driver_pake_inputs_t *inputs,
Przemek Stekielc0e62502023-03-14 11:49:36 +01007633 uint8_t *user_id, size_t user_id_size, size_t *user_id_len)
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007634{
7635 if (inputs->user_len == 0) {
7636 return PSA_ERROR_BAD_STATE;
7637 }
7638
Przemek Stekielc0e62502023-03-14 11:49:36 +01007639 if (user_id_size < inputs->user_len) {
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007640 return PSA_ERROR_BUFFER_TOO_SMALL;
7641 }
7642
Przemek Stekielc0e62502023-03-14 11:49:36 +01007643 memcpy(user_id, inputs->user, inputs->user_len);
7644 *user_id_len = inputs->user_len;
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007645
7646 return PSA_SUCCESS;
7647}
7648
7649psa_status_t psa_crypto_driver_pake_get_peer_len(
7650 const psa_crypto_driver_pake_inputs_t *inputs,
7651 size_t *peer_len)
7652{
7653 if (inputs->peer_len == 0) {
7654 return PSA_ERROR_BAD_STATE;
7655 }
7656
7657 *peer_len = inputs->peer_len;
7658
7659 return PSA_SUCCESS;
7660}
7661
7662psa_status_t psa_crypto_driver_pake_get_peer(
7663 const psa_crypto_driver_pake_inputs_t *inputs,
Przemek Stekielc0e62502023-03-14 11:49:36 +01007664 uint8_t *peer_id, size_t peer_id_size, size_t *peer_id_length)
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007665{
7666 if (inputs->peer_len == 0) {
7667 return PSA_ERROR_BAD_STATE;
7668 }
7669
Przemek Stekielc0e62502023-03-14 11:49:36 +01007670 if (peer_id_size < inputs->peer_len) {
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007671 return PSA_ERROR_BUFFER_TOO_SMALL;
7672 }
7673
Przemek Stekielc0e62502023-03-14 11:49:36 +01007674 memcpy(peer_id, inputs->peer, inputs->peer_len);
7675 *peer_id_length = inputs->peer_len;
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007676
7677 return PSA_SUCCESS;
7678}
7679
Przemek Stekielca8d2b22023-01-17 16:21:33 +01007680psa_status_t psa_crypto_driver_pake_get_cipher_suite(
7681 const psa_crypto_driver_pake_inputs_t *inputs,
7682 psa_pake_cipher_suite_t *cipher_suite)
7683{
7684 if (inputs->cipher_suite.algorithm == PSA_ALG_NONE) {
7685 return PSA_ERROR_BAD_STATE;
7686 }
7687
7688 *cipher_suite = inputs->cipher_suite;
7689
7690 return PSA_SUCCESS;
7691}
7692
Neil Armstronga7d08c32022-06-01 18:21:20 +02007693psa_status_t psa_pake_setup(
7694 psa_pake_operation_t *operation,
7695 const psa_pake_cipher_suite_t *cipher_suite)
7696{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007697 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007698
Przemek Stekiel1c3cfb42023-01-26 10:35:02 +01007699 if (operation->stage != PSA_PAKE_OPERATION_STAGE_SETUP) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007700 status = PSA_ERROR_BAD_STATE;
7701 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007702 }
7703
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01007704 if (PSA_ALG_IS_PAKE(cipher_suite->algorithm) == 0 ||
Przemek Stekiel51eac532022-12-07 11:04:51 +01007705 PSA_ALG_IS_HASH(cipher_suite->hash) == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007706 status = PSA_ERROR_INVALID_ARGUMENT;
7707 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007708 }
7709
Przemek Stekiel51eac532022-12-07 11:04:51 +01007710 memset(&operation->data.inputs, 0, sizeof(operation->data.inputs));
7711
Przemek Stekiele12ed362022-12-21 12:54:46 +01007712 operation->alg = cipher_suite->algorithm;
Przemek Stekiel656b2592023-03-22 13:15:33 +01007713 operation->primitive = PSA_PAKE_PRIMITIVE(cipher_suite->type,
7714 cipher_suite->family, cipher_suite->bits);
Przemek Stekiel51eac532022-12-07 11:04:51 +01007715 operation->data.inputs.cipher_suite = *cipher_suite;
7716
Przemek Stekiel4aa99402023-02-27 13:00:57 +01007717#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01007718 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01007719 psa_jpake_computation_stage_t *computation_stage =
Przemek Stekieldde6a912023-01-26 08:46:37 +01007720 &operation->computation_stage.jpake;
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01007721
David Horstmann16f01512023-06-14 17:21:07 +01007722 memset(computation_stage, 0, sizeof(*computation_stage));
David Horstmanne7f21e62023-05-12 18:17:21 +01007723 computation_stage->step = PSA_PAKE_STEP_KEY_SHARE;
Przemek Stekiel80a88492023-02-20 13:32:22 +01007724 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007725#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01007726 {
7727 status = PSA_ERROR_NOT_SUPPORTED;
7728 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01007729 }
7730
Przemek Stekiel1c3cfb42023-01-26 10:35:02 +01007731 operation->stage = PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS;
7732
Przemek Stekiel51eac532022-12-07 11:04:51 +01007733 return PSA_SUCCESS;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007734exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007735 psa_pake_abort(operation);
7736 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02007737}
7738
7739psa_status_t psa_pake_set_password_key(
7740 psa_pake_operation_t *operation,
7741 mbedtls_svc_key_id_t password)
7742{
Neil Armstrong5ae60962022-09-15 11:29:46 +02007743 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel6c764412022-11-22 14:05:12 +01007744 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
7745 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007746 psa_key_attributes_t attributes;
7747 psa_key_type_t type;
Neil Armstrong5ae60962022-09-15 11:29:46 +02007748
Przemek Stekiel51eac532022-12-07 11:04:51 +01007749 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007750 status = PSA_ERROR_BAD_STATE;
7751 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007752 }
7753
Przemek Stekiel6c764412022-11-22 14:05:12 +01007754 status = psa_get_and_lock_key_slot_with_policy(password, &slot,
7755 PSA_KEY_USAGE_DERIVE,
Przemek Stekield5d28a22023-01-26 10:46:05 +01007756 operation->alg);
Neil Armstrong5ae60962022-09-15 11:29:46 +02007757 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007758 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02007759 }
7760
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007761 attributes = (psa_key_attributes_t) {
Przemek Stekiel6c764412022-11-22 14:05:12 +01007762 .core = slot->attr
7763 };
Neil Armstrong5ae60962022-09-15 11:29:46 +02007764
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007765 type = psa_get_key_type(&attributes);
Neil Armstrong5ae60962022-09-15 11:29:46 +02007766
Przemek Stekiel51eac532022-12-07 11:04:51 +01007767 if (type != PSA_KEY_TYPE_PASSWORD &&
7768 type != PSA_KEY_TYPE_PASSWORD_HASH) {
7769 status = PSA_ERROR_INVALID_ARGUMENT;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007770 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007771 }
7772
Przemek Stekiel51eac532022-12-07 11:04:51 +01007773 operation->data.inputs.password = mbedtls_calloc(1, slot->key.bytes);
7774 if (operation->data.inputs.password == NULL) {
Przemek Stekiele12ed362022-12-21 12:54:46 +01007775 status = PSA_ERROR_INSUFFICIENT_MEMORY;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007776 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007777 }
7778
7779 memcpy(operation->data.inputs.password, slot->key.data, slot->key.bytes);
7780 operation->data.inputs.password_len = slot->key.bytes;
Przemek Stekiel9dd24402023-01-26 15:06:09 +01007781 operation->data.inputs.attributes = attributes;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007782exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007783 if (status != PSA_SUCCESS) {
7784 psa_pake_abort(operation);
7785 }
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007786 unlock_status = psa_unlock_key_slot(slot);
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007787 return (status == PSA_SUCCESS) ? unlock_status : status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02007788}
7789
7790psa_status_t psa_pake_set_user(
7791 psa_pake_operation_t *operation,
7792 const uint8_t *user_id,
7793 size_t user_id_len)
7794{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007795 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007796
7797 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007798 status = PSA_ERROR_BAD_STATE;
7799 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02007800 }
7801
Przemek Stekiel51eac532022-12-07 11:04:51 +01007802 if (user_id_len == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007803 status = PSA_ERROR_INVALID_ARGUMENT;
7804 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02007805 }
7806
Przemek Stekielf309d6b2023-03-10 09:54:45 +01007807 if (operation->data.inputs.user_len != 0) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007808 status = PSA_ERROR_BAD_STATE;
7809 goto exit;
7810 }
7811
Przemek Stekielf309d6b2023-03-10 09:54:45 +01007812 operation->data.inputs.user = mbedtls_calloc(1, user_id_len);
7813 if (operation->data.inputs.user == NULL) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007814 status = PSA_ERROR_INSUFFICIENT_MEMORY;
7815 goto exit;
7816 }
7817
Przemek Stekielf309d6b2023-03-10 09:54:45 +01007818 memcpy(operation->data.inputs.user, user_id, user_id_len);
7819 operation->data.inputs.user_len = user_id_len;
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007820
7821 return PSA_SUCCESS;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007822exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007823 psa_pake_abort(operation);
7824 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02007825}
7826
7827psa_status_t psa_pake_set_peer(
7828 psa_pake_operation_t *operation,
7829 const uint8_t *peer_id,
7830 size_t peer_id_len)
7831{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007832 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007833
7834 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007835 status = PSA_ERROR_BAD_STATE;
7836 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02007837 }
7838
Przemek Stekiel51eac532022-12-07 11:04:51 +01007839 if (peer_id_len == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007840 status = PSA_ERROR_INVALID_ARGUMENT;
7841 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02007842 }
7843
Przemek Stekielf309d6b2023-03-10 09:54:45 +01007844 if (operation->data.inputs.peer_len != 0) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007845 status = PSA_ERROR_BAD_STATE;
7846 goto exit;
7847 }
7848
Przemek Stekielf309d6b2023-03-10 09:54:45 +01007849 operation->data.inputs.peer = mbedtls_calloc(1, peer_id_len);
7850 if (operation->data.inputs.peer == NULL) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007851 status = PSA_ERROR_INSUFFICIENT_MEMORY;
7852 goto exit;
7853 }
7854
Przemek Stekielf309d6b2023-03-10 09:54:45 +01007855 memcpy(operation->data.inputs.peer, peer_id, peer_id_len);
7856 operation->data.inputs.peer_len = peer_id_len;
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007857
7858 return PSA_SUCCESS;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007859exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007860 psa_pake_abort(operation);
7861 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02007862}
7863
7864psa_status_t psa_pake_set_role(
7865 psa_pake_operation_t *operation,
7866 psa_pake_role_t role)
7867{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007868 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007869
Przemek Stekiel51eac532022-12-07 11:04:51 +01007870 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007871 status = PSA_ERROR_BAD_STATE;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007872 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007873 }
7874
Przemek Stekiel09104b82023-03-06 14:11:51 +01007875 switch (operation->alg) {
7876#if defined(PSA_WANT_ALG_JPAKE)
7877 case PSA_ALG_JPAKE:
7878 if (role == PSA_PAKE_ROLE_NONE) {
7879 return PSA_SUCCESS;
7880 }
7881 status = PSA_ERROR_INVALID_ARGUMENT;
7882 break;
7883#endif
7884 default:
7885 (void) role;
7886 status = PSA_ERROR_NOT_SUPPORTED;
7887 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02007888 }
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007889exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007890 psa_pake_abort(operation);
7891 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02007892}
7893
David Horstmanne7f21e62023-05-12 18:17:21 +01007894/* Auxiliary function to convert core computation stage to single driver step. */
Przemek Stekiel4aa99402023-02-27 13:00:57 +01007895#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiel251e86a2023-02-17 14:30:50 +01007896static psa_crypto_driver_pake_step_t convert_jpake_computation_stage_to_driver_step(
Przemek Stekieldde6a912023-01-26 08:46:37 +01007897 psa_jpake_computation_stage_t *stage)
Przemek Stekielb09c4872023-01-17 12:05:38 +01007898{
David Horstmann74a3d8c2023-06-14 18:28:19 +01007899 psa_crypto_driver_pake_step_t key_share_step;
David Horstmann5da95602023-06-08 15:37:12 +01007900 if (stage->round == PSA_JPAKE_FIRST) {
David Horstmanne7f21e62023-05-12 18:17:21 +01007901 int is_x1;
David Horstmann74a3d8c2023-06-14 18:28:19 +01007902
David Horstmann024e5c52023-06-14 15:48:21 +01007903 if (stage->io_mode == PSA_JPAKE_OUTPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01007904 is_x1 = (stage->outputs < 1);
7905 } else {
7906 is_x1 = (stage->inputs < 1);
7907 }
7908
David Horstmann74a3d8c2023-06-14 18:28:19 +01007909 key_share_step = is_x1 ?
7910 PSA_JPAKE_X1_STEP_KEY_SHARE :
7911 PSA_JPAKE_X2_STEP_KEY_SHARE;
David Horstmann5da95602023-06-08 15:37:12 +01007912 } else if (stage->round == PSA_JPAKE_SECOND) {
David Horstmann74a3d8c2023-06-14 18:28:19 +01007913 key_share_step = (stage->io_mode == PSA_JPAKE_OUTPUT) ?
7914 PSA_JPAKE_X2S_STEP_KEY_SHARE :
7915 PSA_JPAKE_X4S_STEP_KEY_SHARE;
7916 } else {
7917 return PSA_JPAKE_STEP_INVALID;
Przemek Stekielb09c4872023-01-17 12:05:38 +01007918 }
Agathiyan Bragadeesh387bfa52023-07-17 17:01:33 +01007919 return (psa_crypto_driver_pake_step_t) (key_share_step + stage->step - PSA_PAKE_STEP_KEY_SHARE);
Przemek Stekielb09c4872023-01-17 12:05:38 +01007920}
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007921#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekielb09c4872023-01-17 12:05:38 +01007922
Przemek Stekiel2797d372022-12-22 11:19:22 +01007923static psa_status_t psa_pake_complete_inputs(
7924 psa_pake_operation_t *operation)
7925{
Przemek Stekiel2797d372022-12-22 11:19:22 +01007926 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel18620a32023-01-17 16:34:52 +01007927 /* Create copy of the inputs on stack as inputs share memory
7928 with the driver context which will be setup by the driver. */
7929 psa_crypto_driver_pake_inputs_t inputs = operation->data.inputs;
Przemek Stekiel2797d372022-12-22 11:19:22 +01007930
Przemek Stekielfde11282023-03-13 16:06:09 +01007931 if (inputs.password_len == 0) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01007932 return PSA_ERROR_BAD_STATE;
7933 }
7934
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007935 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekielfde11282023-03-13 16:06:09 +01007936 if (inputs.user_len == 0 || inputs.peer_len == 0) {
7937 return PSA_ERROR_BAD_STATE;
7938 }
Przemek Stekieldff21d32023-02-14 20:09:10 +01007939 }
7940
Przemek Stekiel18620a32023-01-17 16:34:52 +01007941 /* Clear driver context */
7942 mbedtls_platform_zeroize(&operation->data, sizeof(operation->data));
7943
7944 status = psa_driver_wrapper_pake_setup(operation, &inputs);
Przemek Stekiel2797d372022-12-22 11:19:22 +01007945
7946 /* Driver is responsible for creating its own copy of the password. */
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01007947 mbedtls_zeroize_and_free(inputs.password, inputs.password_len);
Przemek Stekiel2797d372022-12-22 11:19:22 +01007948
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007949 /* User and peer are translated to role. */
7950 mbedtls_free(inputs.user);
7951 mbedtls_free(inputs.peer);
7952
Przemek Stekiel2797d372022-12-22 11:19:22 +01007953 if (status == PSA_SUCCESS) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01007954#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiel2797d372022-12-22 11:19:22 +01007955 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekield93de322023-02-24 08:39:04 +01007956 operation->stage = PSA_PAKE_OPERATION_STAGE_COMPUTATION;
Przemek Stekiel80a88492023-02-20 13:32:22 +01007957 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007958#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01007959 {
7960 status = PSA_ERROR_NOT_SUPPORTED;
Przemek Stekiel2797d372022-12-22 11:19:22 +01007961 }
Przemek Stekiel2797d372022-12-22 11:19:22 +01007962 }
Przemek Stekiel2797d372022-12-22 11:19:22 +01007963 return status;
7964}
7965
Przemek Stekiel4aa99402023-02-27 13:00:57 +01007966#if defined(PSA_WANT_ALG_JPAKE)
David Horstmanne7f21e62023-05-12 18:17:21 +01007967static psa_status_t psa_jpake_prologue(
Przemek Stekiele12ed362022-12-21 12:54:46 +01007968 psa_pake_operation_t *operation,
David Horstmanne7f21e62023-05-12 18:17:21 +01007969 psa_pake_step_t step,
David Horstmann00ad6bf2023-06-14 15:44:24 +01007970 psa_jpake_io_mode_t io_mode)
Przemek Stekiele12ed362022-12-21 12:54:46 +01007971{
Przemek Stekiele12ed362022-12-21 12:54:46 +01007972 if (step != PSA_PAKE_STEP_KEY_SHARE &&
7973 step != PSA_PAKE_STEP_ZK_PUBLIC &&
7974 step != PSA_PAKE_STEP_ZK_PROOF) {
7975 return PSA_ERROR_INVALID_ARGUMENT;
7976 }
7977
Przemek Stekiel5eff1032023-02-21 19:10:36 +01007978 psa_jpake_computation_stage_t *computation_stage =
7979 &operation->computation_stage.jpake;
Przemek Stekiele12ed362022-12-21 12:54:46 +01007980
David Horstmann5da95602023-06-08 15:37:12 +01007981 if (computation_stage->round != PSA_JPAKE_FIRST &&
7982 computation_stage->round != PSA_JPAKE_SECOND) {
Przemek Stekiel5eff1032023-02-21 19:10:36 +01007983 return PSA_ERROR_BAD_STATE;
7984 }
7985
David Horstmanne7f21e62023-05-12 18:17:21 +01007986 /* Check that the step we are given is the one we were expecting */
7987 if (step != computation_stage->step) {
Przemek Stekiel5eff1032023-02-21 19:10:36 +01007988 return PSA_ERROR_BAD_STATE;
7989 }
7990
David Horstmanne7f21e62023-05-12 18:17:21 +01007991 if (step == PSA_PAKE_STEP_KEY_SHARE &&
7992 computation_stage->inputs == 0 &&
7993 computation_stage->outputs == 0) {
7994 /* Start of the round, so function decides whether we are inputting
7995 * or outputting */
David Horstmann024e5c52023-06-14 15:48:21 +01007996 computation_stage->io_mode = io_mode;
7997 } else if (computation_stage->io_mode != io_mode) {
David Horstmanne7f21e62023-05-12 18:17:21 +01007998 /* Middle of the round so the mode we are in must match the function
7999 * called by the user */
8000 return PSA_ERROR_BAD_STATE;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008001 }
8002
8003 return PSA_SUCCESS;
8004}
8005
David Horstmanne7f21e62023-05-12 18:17:21 +01008006static psa_status_t psa_jpake_epilogue(
8007 psa_pake_operation_t *operation,
David Horstmann00ad6bf2023-06-14 15:44:24 +01008008 psa_jpake_io_mode_t io_mode)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008009{
David Horstmanne7f21e62023-05-12 18:17:21 +01008010 psa_jpake_computation_stage_t *stage =
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008011 &operation->computation_stage.jpake;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008012
David Horstmanne7f21e62023-05-12 18:17:21 +01008013 if (stage->step == PSA_PAKE_STEP_ZK_PROOF) {
8014 /* End of an input/output */
David Horstmann00ad6bf2023-06-14 15:44:24 +01008015 if (io_mode == PSA_JPAKE_INPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008016 stage->inputs++;
David Horstmann246ec5a2023-06-27 10:33:06 +01008017 if (stage->inputs == PSA_JPAKE_EXPECTED_INPUTS(stage->round)) {
David Horstmann024e5c52023-06-14 15:48:21 +01008018 stage->io_mode = PSA_JPAKE_OUTPUT;
David Horstmanne7f21e62023-05-12 18:17:21 +01008019 }
8020 }
David Horstmann00ad6bf2023-06-14 15:44:24 +01008021 if (io_mode == PSA_JPAKE_OUTPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008022 stage->outputs++;
David Horstmann246ec5a2023-06-27 10:33:06 +01008023 if (stage->outputs == PSA_JPAKE_EXPECTED_OUTPUTS(stage->round)) {
David Horstmann024e5c52023-06-14 15:48:21 +01008024 stage->io_mode = PSA_JPAKE_INPUT;
David Horstmanne7f21e62023-05-12 18:17:21 +01008025 }
8026 }
David Horstmann246ec5a2023-06-27 10:33:06 +01008027 if (stage->inputs == PSA_JPAKE_EXPECTED_INPUTS(stage->round) &&
8028 stage->outputs == PSA_JPAKE_EXPECTED_OUTPUTS(stage->round)) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008029 /* End of a round, move to the next round */
8030 stage->inputs = 0;
8031 stage->outputs = 0;
8032 stage->round++;
8033 }
8034 stage->step = PSA_PAKE_STEP_KEY_SHARE;
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008035 } else {
David Horstmanne7f21e62023-05-12 18:17:21 +01008036 stage->step++;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008037 }
Przemek Stekiele12ed362022-12-21 12:54:46 +01008038 return PSA_SUCCESS;
8039}
David Horstmanne7f21e62023-05-12 18:17:21 +01008040
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008041#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008042
Neil Armstronga7d08c32022-06-01 18:21:20 +02008043psa_status_t psa_pake_output(
8044 psa_pake_operation_t *operation,
8045 psa_pake_step_t step,
8046 uint8_t *output,
8047 size_t output_size,
8048 size_t *output_length)
8049{
Przemek Stekiel51eac532022-12-07 11:04:51 +01008050 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008051 psa_crypto_driver_pake_step_t driver_step = PSA_JPAKE_STEP_INVALID;
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008052 *output_length = 0;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008053
8054 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01008055 status = psa_pake_complete_inputs(operation);
8056 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008057 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008058 }
8059 }
8060
8061 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008062 status = PSA_ERROR_BAD_STATE;
8063 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008064 }
8065
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008066 if (output_size == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008067 status = PSA_ERROR_INVALID_ARGUMENT;
8068 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008069 }
8070
Przemek Stekiele12ed362022-12-21 12:54:46 +01008071 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008072#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008073 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008074 status = psa_jpake_prologue(operation, step, PSA_JPAKE_OUTPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008075 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008076 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008077 }
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008078 driver_step = convert_jpake_computation_stage_to_driver_step(
8079 &operation->computation_stage.jpake);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008080 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008081#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008082 default:
Przemek Stekiel80a88492023-02-20 13:32:22 +01008083 (void) step;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008084 status = PSA_ERROR_NOT_SUPPORTED;
8085 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008086 }
8087
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008088 status = psa_driver_wrapper_pake_output(operation, driver_step,
8089 output, output_size, output_length);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008090
8091 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008092 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008093 }
8094
8095 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008096#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008097 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008098 status = psa_jpake_epilogue(operation, PSA_JPAKE_OUTPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008099 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008100 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008101 }
8102 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008103#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008104 default:
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008105 status = PSA_ERROR_NOT_SUPPORTED;
8106 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008107 }
8108
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008109 return PSA_SUCCESS;
8110exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008111 psa_pake_abort(operation);
8112 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008113}
8114
8115psa_status_t psa_pake_input(
8116 psa_pake_operation_t *operation,
8117 psa_pake_step_t step,
8118 const uint8_t *input,
8119 size_t input_length)
8120{
Przemek Stekiel51eac532022-12-07 11:04:51 +01008121 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008122 psa_crypto_driver_pake_step_t driver_step = PSA_JPAKE_STEP_INVALID;
Przemek Stekiel256c75d2023-03-23 14:09:34 +01008123 const size_t max_input_length = (size_t) PSA_PAKE_INPUT_SIZE(operation->alg,
8124 operation->primitive,
8125 step);
Przemek Stekiel51eac532022-12-07 11:04:51 +01008126
8127 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01008128 status = psa_pake_complete_inputs(operation);
8129 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008130 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008131 }
8132 }
8133
8134 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008135 status = PSA_ERROR_BAD_STATE;
8136 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008137 }
8138
Przemek Stekiel256c75d2023-03-23 14:09:34 +01008139 if (input_length == 0 || input_length > max_input_length) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008140 status = PSA_ERROR_INVALID_ARGUMENT;
8141 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008142 }
8143
Przemek Stekiele12ed362022-12-21 12:54:46 +01008144 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008145#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008146 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008147 status = psa_jpake_prologue(operation, step, PSA_JPAKE_INPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008148 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008149 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008150 }
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008151 driver_step = convert_jpake_computation_stage_to_driver_step(
8152 &operation->computation_stage.jpake);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008153 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008154#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008155 default:
Przemek Stekiel80a88492023-02-20 13:32:22 +01008156 (void) step;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008157 status = PSA_ERROR_NOT_SUPPORTED;
8158 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008159 }
8160
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008161 status = psa_driver_wrapper_pake_input(operation, driver_step,
8162 input, input_length);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008163
8164 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008165 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008166 }
8167
8168 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008169#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008170 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008171 status = psa_jpake_epilogue(operation, PSA_JPAKE_INPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008172 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008173 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008174 }
8175 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008176#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008177 default:
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008178 status = PSA_ERROR_NOT_SUPPORTED;
8179 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008180 }
8181
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008182 return PSA_SUCCESS;
8183exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008184 psa_pake_abort(operation);
8185 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008186}
8187
8188psa_status_t psa_pake_get_implicit_key(
8189 psa_pake_operation_t *operation,
8190 psa_key_derivation_operation_t *output)
8191{
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008192 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008193 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel251e86a2023-02-17 14:30:50 +01008194 uint8_t shared_key[MBEDTLS_PSA_JPAKE_BUFFER_SIZE];
Przemek Stekiel0c781802022-11-29 14:53:13 +01008195 size_t shared_key_len = 0;
8196
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008197 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008198 status = PSA_ERROR_BAD_STATE;
8199 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008200 }
8201
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008202#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008203 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008204 psa_jpake_computation_stage_t *computation_stage =
Przemek Stekiel083745e2023-02-23 17:28:23 +01008205 &operation->computation_stage.jpake;
David Horstmann5da95602023-06-08 15:37:12 +01008206 if (computation_stage->round != PSA_JPAKE_FINISHED) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008207 status = PSA_ERROR_BAD_STATE;
8208 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008209 }
Przemek Stekiel80a88492023-02-20 13:32:22 +01008210 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008211#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01008212 {
8213 status = PSA_ERROR_NOT_SUPPORTED;
8214 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008215 }
8216
Przemek Stekiel0c781802022-11-29 14:53:13 +01008217 status = psa_driver_wrapper_pake_get_implicit_key(operation,
8218 shared_key,
Przemek Stekiel6b648622023-02-19 22:55:33 +01008219 sizeof(shared_key),
Przemek Stekiel0c781802022-11-29 14:53:13 +01008220 &shared_key_len);
8221
8222 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008223 goto exit;
Przemek Stekiel0c781802022-11-29 14:53:13 +01008224 }
8225
8226 status = psa_key_derivation_input_bytes(output,
8227 PSA_KEY_DERIVATION_INPUT_SECRET,
8228 shared_key,
8229 shared_key_len);
8230
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008231 mbedtls_platform_zeroize(shared_key, sizeof(shared_key));
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008232exit:
8233 abort_status = psa_pake_abort(operation);
8234 return status == PSA_SUCCESS ? abort_status : status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008235}
8236
8237psa_status_t psa_pake_abort(
8238 psa_pake_operation_t *operation)
8239{
Przemek Stekield69dca92023-01-31 19:59:20 +01008240 psa_status_t status = PSA_SUCCESS;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008241
Przemek Stekield69dca92023-01-31 19:59:20 +01008242 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008243 status = psa_driver_wrapper_pake_abort(operation);
Neil Armstrong5ae60962022-09-15 11:29:46 +02008244 }
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008245
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008246 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
8247 if (operation->data.inputs.password != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01008248 mbedtls_zeroize_and_free(operation->data.inputs.password,
Przemek Stekielaa183422023-03-06 14:21:44 +01008249 operation->data.inputs.password_len);
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008250 }
8251 if (operation->data.inputs.user != NULL) {
8252 mbedtls_free(operation->data.inputs.user);
8253 }
8254 if (operation->data.inputs.peer != NULL) {
8255 mbedtls_free(operation->data.inputs.peer);
8256 }
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008257 }
Przemek Stekield69dca92023-01-31 19:59:20 +01008258 memset(operation, 0, sizeof(psa_pake_operation_t));
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008259
Przemek Stekield69dca92023-01-31 19:59:20 +01008260 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008261}
Tom Cosgrove6d62fac2023-05-10 14:40:05 +01008262#endif /* PSA_WANT_ALG_SOME_PAKE */
Neil Armstronga7d08c32022-06-01 18:21:20 +02008263
Gilles Peskinee59236f2018-01-27 23:32:46 +01008264#endif /* MBEDTLS_PSA_CRYPTO_C */