blob: 692da9f558ef2b1da426964ef30eaf5b27e1c5c7 [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:
Janos Follath1d57a202019-08-13 12:15:34 +01001206 /* TODO: reporting the public exponent for opaque keys
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001207 * is not yet implemented.
1208 * https://github.com/ARMmbed/mbed-crypto/issues/216
1209 */
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;
Valerio Settib2bcedb2023-07-10 11:24:00 +02001228#endif /* (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) && \
1229 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) ||
John Durkop9814fa22020-11-04 12:28:15 -08001230 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001231 default:
1232 /* Nothing else to do. */
1233 break;
1234 }
1235
Gilles Peskine449bd832023-01-11 14:50:10 +01001236 if (status != PSA_SUCCESS) {
1237 psa_reset_key_attributes(attributes);
1238 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001239
Gilles Peskine449bd832023-01-11 14:50:10 +01001240 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02001241
Gilles Peskine449bd832023-01-11 14:50:10 +01001242 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001243}
1244
Gilles Peskinec8000c02019-08-02 20:15:51 +02001245#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1246psa_status_t psa_get_key_slot_number(
1247 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01001248 psa_key_slot_number_t *slot_number)
Gilles Peskinec8000c02019-08-02 20:15:51 +02001249{
Gilles Peskine449bd832023-01-11 14:50:10 +01001250 if (attributes->core.flags & MBEDTLS_PSA_KA_FLAG_HAS_SLOT_NUMBER) {
Gilles Peskinec8000c02019-08-02 20:15:51 +02001251 *slot_number = attributes->slot_number;
Gilles Peskine449bd832023-01-11 14:50:10 +01001252 return PSA_SUCCESS;
1253 } else {
1254 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinec8000c02019-08-02 20:15:51 +02001255 }
Gilles Peskinec8000c02019-08-02 20:15:51 +02001256}
1257#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1258
Gilles Peskine449bd832023-01-11 14:50:10 +01001259static psa_status_t psa_export_key_buffer_internal(const uint8_t *key_buffer,
1260 size_t key_buffer_size,
1261 uint8_t *data,
1262 size_t data_size,
1263 size_t *data_length)
Steven Cooremana01795d2020-07-24 22:48:15 +02001264{
Gilles Peskine449bd832023-01-11 14:50:10 +01001265 if (key_buffer_size > data_size) {
1266 return PSA_ERROR_BUFFER_TOO_SMALL;
1267 }
1268 memcpy(data, key_buffer, key_buffer_size);
1269 memset(data + key_buffer_size, 0,
1270 data_size - key_buffer_size);
Ronald Crond18b5f82020-11-25 16:46:05 +01001271 *data_length = key_buffer_size;
Gilles Peskine449bd832023-01-11 14:50:10 +01001272 return PSA_SUCCESS;
Steven Cooremana01795d2020-07-24 22:48:15 +02001273}
1274
Ronald Cron7285cda2020-11-26 14:46:37 +01001275psa_status_t psa_export_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001276 const psa_key_attributes_t *attributes,
1277 const uint8_t *key_buffer, size_t key_buffer_size,
Gilles Peskine449bd832023-01-11 14:50:10 +01001278 uint8_t *data, size_t data_size, size_t *data_length)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001279{
Ronald Crond18b5f82020-11-25 16:46:05 +01001280 psa_key_type_t type = attributes->core.type;
1281
Gilles Peskine449bd832023-01-11 14:50:10 +01001282 if (key_type_is_raw_bytes(type) ||
1283 PSA_KEY_TYPE_IS_RSA(type) ||
Przemek Stekiel472b3f32022-12-01 14:38:49 +01001284 PSA_KEY_TYPE_IS_ECC(type) ||
1285 PSA_KEY_TYPE_IS_DH(type)) {
Gilles Peskine449bd832023-01-11 14:50:10 +01001286 return psa_export_key_buffer_internal(
1287 key_buffer, key_buffer_size,
1288 data, data_size, data_length);
1289 } else {
Ronald Cron9486f9d2020-11-26 13:36:23 +01001290 /* This shouldn't happen in the reference implementation, but
1291 it is valid for a special-purpose implementation to omit
1292 support for exporting certain key types. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001293 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron9486f9d2020-11-26 13:36:23 +01001294 }
1295}
1296
Gilles Peskine449bd832023-01-11 14:50:10 +01001297psa_status_t psa_export_key(mbedtls_svc_key_id_t key,
1298 uint8_t *data,
1299 size_t data_size,
1300 size_t *data_length)
Ronald Cron9486f9d2020-11-26 13:36:23 +01001301{
1302 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
1303 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
1304 psa_key_slot_t *slot;
1305
Ronald Crone907e552021-01-18 13:22:38 +01001306 /* Reject a zero-length output buffer now, since this can never be a
1307 * valid key representation. This way we know that data must be a valid
1308 * pointer and we can do things like memset(data, ..., data_size). */
Gilles Peskine449bd832023-01-11 14:50:10 +01001309 if (data_size == 0) {
1310 return PSA_ERROR_BUFFER_TOO_SMALL;
1311 }
Ronald Crone907e552021-01-18 13:22:38 +01001312
Ronald Cron9486f9d2020-11-26 13:36:23 +01001313 /* Set the key to empty now, so that even when there are errors, we always
1314 * set data_length to a value between 0 and data_size. On error, setting
1315 * the key to empty is a good choice because an empty key representation is
1316 * unlikely to be accepted anywhere. */
Jaeden Amerof24c7f82018-06-27 17:20:43 +01001317 *data_length = 0;
1318
Ronald Cron9486f9d2020-11-26 13:36:23 +01001319 /* Export requires the EXPORT flag. There is an exception for public keys,
1320 * which don't require any flag, but
1321 * psa_get_and_lock_key_slot_with_policy() takes care of this.
1322 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001323 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
1324 PSA_KEY_USAGE_EXPORT, 0);
1325 if (status != PSA_SUCCESS) {
1326 return status;
1327 }
mohammad160306e79202018-03-28 13:17:44 +03001328
Ronald Crond18b5f82020-11-25 16:46:05 +01001329 psa_key_attributes_t attributes = {
1330 .core = slot->attr
1331 };
Gilles Peskine449bd832023-01-11 14:50:10 +01001332 status = psa_driver_wrapper_export_key(&attributes,
1333 slot->key.data, slot->key.bytes,
1334 data, data_size, data_length);
Ronald Cron9486f9d2020-11-26 13:36:23 +01001335
Gilles Peskine449bd832023-01-11 14:50:10 +01001336 unlock_status = psa_unlock_key_slot(slot);
Ronald Cron9486f9d2020-11-26 13:36:23 +01001337
Gilles Peskine449bd832023-01-11 14:50:10 +01001338 return (status == PSA_SUCCESS) ? unlock_status : status;
Ronald Cron9486f9d2020-11-26 13:36:23 +01001339}
1340
Ronald Cron7285cda2020-11-26 14:46:37 +01001341psa_status_t psa_export_public_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001342 const psa_key_attributes_t *attributes,
1343 const uint8_t *key_buffer,
1344 size_t key_buffer_size,
1345 uint8_t *data,
1346 size_t data_size,
Gilles Peskine449bd832023-01-11 14:50:10 +01001347 size_t *data_length)
Ronald Cron9486f9d2020-11-26 13:36:23 +01001348{
Ronald Crond18b5f82020-11-25 16:46:05 +01001349 psa_key_type_t type = attributes->core.type;
Ronald Crond18b5f82020-11-25 16:46:05 +01001350
Przemek Stekiel6fd72b62023-04-27 10:20:56 +02001351 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(type) &&
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001352 (PSA_KEY_TYPE_IS_RSA(type) || PSA_KEY_TYPE_IS_ECC(type) ||
1353 PSA_KEY_TYPE_IS_DH(type))) {
Przemek Stekiel6fd72b62023-04-27 10:20:56 +02001354 /* Exporting public -> public */
1355 return psa_export_key_buffer_internal(
1356 key_buffer, key_buffer_size,
1357 data, data_size, data_length);
1358 } else if (PSA_KEY_TYPE_IS_RSA(type)) {
Valerio Settib2bcedb2023-07-10 11:24:00 +02001359#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT) || \
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001360 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
1361 return mbedtls_psa_rsa_export_public_key(attributes,
1362 key_buffer,
1363 key_buffer_size,
1364 data,
1365 data_size,
1366 data_length);
Darryl Green9e2d7a02018-07-24 16:33:30 +01001367#else
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001368 /* We don't know how to convert a private RSA key to public. */
1369 return PSA_ERROR_NOT_SUPPORTED;
Valerio Settib2bcedb2023-07-10 11:24:00 +02001370#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT) ||
John Durkop9814fa22020-11-04 12:28:15 -08001371 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Przemek Stekiel6fd72b62023-04-27 10:20:56 +02001372 } else if (PSA_KEY_TYPE_IS_ECC(type)) {
Valerio Setti27c501a2023-06-27 16:58:52 +02001373#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_EXPORT) || \
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001374 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
1375 return mbedtls_psa_ecp_export_public_key(attributes,
1376 key_buffer,
1377 key_buffer_size,
1378 data,
1379 data_size,
1380 data_length);
Steven Cooreman560c28a2020-07-24 23:20:24 +02001381#else
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001382 /* We don't know how to convert a private ECC key to public */
1383 return PSA_ERROR_NOT_SUPPORTED;
Valerio Setti27c501a2023-06-27 16:58:52 +02001384#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_EXPORT) ||
John Durkop9814fa22020-11-04 12:28:15 -08001385 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
Przemek Stekiel6fd72b62023-04-27 10:20:56 +02001386 } else if (PSA_KEY_TYPE_IS_DH(type)) {
Valerio Settia55f0422023-07-10 15:34:41 +02001387#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_EXPORT) || \
Przemek Stekiel6d85afa2023-04-28 11:42:17 +02001388 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY)
Przemek Stekiel152bb462023-06-01 11:52:39 +02001389 return mbedtls_psa_ffdh_export_public_key(attributes,
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001390 key_buffer,
1391 key_buffer_size,
1392 data, data_size,
1393 data_length);
Przemek Stekiel472b3f32022-12-01 14:38:49 +01001394#else
Przemek Stekiel472b3f32022-12-01 14:38:49 +01001395 return PSA_ERROR_NOT_SUPPORTED;
Valerio Settia55f0422023-07-10 15:34:41 +02001396#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_EXPORT) ||
Przemek Stekiel6d85afa2023-04-28 11:42:17 +02001397 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY) */
Gilles Peskine449bd832023-01-11 14:50:10 +01001398 } else {
Przemek Stekiel0b11ee02023-05-16 13:26:06 +02001399 (void) key_buffer;
1400 (void) key_buffer_size;
1401 (void) data;
1402 (void) data_size;
1403 (void) data_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01001404 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman560c28a2020-07-24 23:20:24 +02001405 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001406}
Ronald Crond18b5f82020-11-25 16:46:05 +01001407
Gilles Peskine449bd832023-01-11 14:50:10 +01001408psa_status_t psa_export_public_key(mbedtls_svc_key_id_t key,
1409 uint8_t *data,
1410 size_t data_size,
1411 size_t *data_length)
Moran Pekerdd4ea382018-04-03 15:30:03 +03001412{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001413 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001414 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001415 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01001416 psa_key_attributes_t attributes;
Darryl Greendd8fb772018-11-07 16:00:44 +00001417
Ronald Crone907e552021-01-18 13:22:38 +01001418 /* Reject a zero-length output buffer now, since this can never be a
1419 * valid key representation. This way we know that data must be a valid
1420 * pointer and we can do things like memset(data, ..., data_size). */
Gilles Peskine449bd832023-01-11 14:50:10 +01001421 if (data_size == 0) {
1422 return PSA_ERROR_BUFFER_TOO_SMALL;
1423 }
Ronald Crone907e552021-01-18 13:22:38 +01001424
Darryl Greendd8fb772018-11-07 16:00:44 +00001425 /* Set the key to empty now, so that even when there are errors, we always
1426 * set data_length to a value between 0 and data_size. On error, setting
1427 * the key to empty is a good choice because an empty key representation is
1428 * unlikely to be accepted anywhere. */
1429 *data_length = 0;
1430
1431 /* Exporting a public key doesn't require a usage flag. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001432 status = psa_get_and_lock_key_slot_with_policy(key, &slot, 0, 0);
1433 if (status != PSA_SUCCESS) {
1434 return status;
1435 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001436
Gilles Peskine449bd832023-01-11 14:50:10 +01001437 if (!PSA_KEY_TYPE_IS_ASYMMETRIC(slot->attr.type)) {
1438 status = PSA_ERROR_INVALID_ARGUMENT;
1439 goto exit;
Ronald Cron9486f9d2020-11-26 13:36:23 +01001440 }
1441
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01001442 attributes = (psa_key_attributes_t) {
Ronald Crond18b5f82020-11-25 16:46:05 +01001443 .core = slot->attr
1444 };
Ronald Cron67227982020-11-26 15:16:05 +01001445 status = psa_driver_wrapper_export_public_key(
Ronald Crond18b5f82020-11-25 16:46:05 +01001446 &attributes, slot->key.data, slot->key.bytes,
Gilles Peskine449bd832023-01-11 14:50:10 +01001447 data, data_size, data_length);
Ronald Cron9486f9d2020-11-26 13:36:23 +01001448
1449exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01001450 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02001451
Gilles Peskine449bd832023-01-11 14:50:10 +01001452 return (status == PSA_SUCCESS) ? unlock_status : status;
Moran Pekerdd4ea382018-04-03 15:30:03 +03001453}
1454
Tom Cosgrove6ef9bb32023-03-08 14:19:51 +00001455MBEDTLS_STATIC_ASSERT(
1456 (MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE) == 0,
1457 "One or more key attribute flag is listed as both external-only and dual-use")
1458MBEDTLS_STATIC_ASSERT(
1459 (PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE) == 0,
1460 "One or more key attribute flag is listed as both internal-only and dual-use")
1461MBEDTLS_STATIC_ASSERT(
1462 (PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY) == 0,
1463 "One or more key attribute flag is listed as both internal-only and external-only")
Gilles Peskine91e8c332019-08-02 19:19:39 +02001464
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001465/** Validate that a key policy is internally well-formed.
1466 *
1467 * This function only rejects invalid policies. It does not validate the
1468 * consistency of the policy with respect to other attributes of the key
1469 * such as the key type.
1470 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001471static psa_status_t psa_validate_key_policy(const psa_key_policy_t *policy)
Gilles Peskine4747d192019-04-17 15:05:45 +02001472{
Gilles Peskine449bd832023-01-11 14:50:10 +01001473 if ((policy->usage & ~(PSA_KEY_USAGE_EXPORT |
1474 PSA_KEY_USAGE_COPY |
1475 PSA_KEY_USAGE_ENCRYPT |
1476 PSA_KEY_USAGE_DECRYPT |
1477 PSA_KEY_USAGE_SIGN_MESSAGE |
1478 PSA_KEY_USAGE_VERIFY_MESSAGE |
1479 PSA_KEY_USAGE_SIGN_HASH |
1480 PSA_KEY_USAGE_VERIFY_HASH |
1481 PSA_KEY_USAGE_VERIFY_DERIVATION |
1482 PSA_KEY_USAGE_DERIVE)) != 0) {
1483 return PSA_ERROR_INVALID_ARGUMENT;
1484 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001485
Gilles Peskine449bd832023-01-11 14:50:10 +01001486 return PSA_SUCCESS;
Gilles Peskine4747d192019-04-17 15:05:45 +02001487}
1488
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001489/** Validate the internal consistency of key attributes.
1490 *
1491 * This function only rejects invalid attribute values. If does not
1492 * validate the consistency of the attributes with any key data that may
1493 * be involved in the creation of the key.
1494 *
1495 * Call this function early in the key creation process.
1496 *
1497 * \param[in] attributes Key attributes for the new key.
1498 * \param[out] p_drv On any return, the driver for the key, if any.
1499 * NULL for a transparent key.
1500 *
1501 */
1502static psa_status_t psa_validate_key_attributes(
1503 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01001504 psa_se_drv_table_entry_t **p_drv)
Darryl Green0c6575a2018-11-07 16:05:30 +00001505{
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001506 psa_status_t status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine449bd832023-01-11 14:50:10 +01001507 psa_key_lifetime_t lifetime = psa_get_key_lifetime(attributes);
1508 mbedtls_svc_key_id_t key = psa_get_key_id(attributes);
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001509
Gilles Peskine449bd832023-01-11 14:50:10 +01001510 status = psa_validate_key_location(lifetime, p_drv);
1511 if (status != PSA_SUCCESS) {
1512 return status;
Ronald Crond2ed4812020-07-17 16:11:30 +02001513 }
1514
Gilles Peskine449bd832023-01-11 14:50:10 +01001515 status = psa_validate_key_persistence(lifetime);
1516 if (status != PSA_SUCCESS) {
1517 return status;
1518 }
1519
1520 if (PSA_KEY_LIFETIME_IS_VOLATILE(lifetime)) {
1521 if (MBEDTLS_SVC_KEY_ID_GET_KEY_ID(key) != 0) {
1522 return PSA_ERROR_INVALID_ARGUMENT;
1523 }
1524 } else {
1525 if (!psa_is_valid_key_id(psa_get_key_id(attributes), 0)) {
1526 return PSA_ERROR_INVALID_ARGUMENT;
1527 }
1528 }
1529
1530 status = psa_validate_key_policy(&attributes->core.policy);
1531 if (status != PSA_SUCCESS) {
1532 return status;
1533 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001534
1535 /* Refuse to create overly large keys.
1536 * Note that this doesn't trigger on import if the attributes don't
1537 * explicitly specify a size (so psa_get_key_bits returns 0), so
1538 * psa_import_key() needs its own checks. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001539 if (psa_get_key_bits(attributes) > PSA_MAX_KEY_BITS) {
1540 return PSA_ERROR_NOT_SUPPORTED;
1541 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001542
Gilles Peskine91e8c332019-08-02 19:19:39 +02001543 /* Reject invalid flags. These should not be reachable through the API. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001544 if (attributes->core.flags & ~(MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1545 MBEDTLS_PSA_KA_MASK_DUAL_USE)) {
1546 return PSA_ERROR_INVALID_ARGUMENT;
1547 }
Gilles Peskine91e8c332019-08-02 19:19:39 +02001548
Gilles Peskine449bd832023-01-11 14:50:10 +01001549 return PSA_SUCCESS;
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001550}
1551
Gilles Peskine4747d192019-04-17 15:05:45 +02001552/** Prepare a key slot to receive key material.
1553 *
1554 * This function allocates a key slot and sets its metadata.
1555 *
1556 * If this function fails, call psa_fail_key_creation().
1557 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001558 * This function is intended to be used as follows:
1559 * -# Call psa_start_key_creation() to allocate a key slot, prepare
Ronald Croncf56a0a2020-08-04 09:51:30 +02001560 * it with the specified attributes, and in case of a volatile key assign it
1561 * a volatile key identifier.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001562 * -# Populate the slot with the key material.
1563 * -# Call psa_finish_key_creation() to finalize the creation of the slot.
1564 * In case of failure at any step, stop the sequence and call
1565 * psa_fail_key_creation().
1566 *
Ronald Cron5c522922020-11-14 16:35:34 +01001567 * On success, the key slot is locked. It is the responsibility of the caller
1568 * to unlock the key slot when it does not access it anymore.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001569 *
Gilles Peskinedf179142019-07-15 22:02:14 +02001570 * \param method An identification of the calling function.
Gilles Peskine011e4282019-06-26 18:34:38 +02001571 * \param[in] attributes Key attributes for the new key.
Gilles Peskine011e4282019-06-26 18:34:38 +02001572 * \param[out] p_slot On success, a pointer to the prepared slot.
1573 * \param[out] p_drv On any return, the driver for the key, if any.
1574 * NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001575 *
1576 * \retval #PSA_SUCCESS
1577 * The key slot is ready to receive key material.
1578 * \return If this function fails, the key slot is an invalid state.
1579 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001580 */
1581static psa_status_t psa_start_key_creation(
Gilles Peskinedf179142019-07-15 22:02:14 +02001582 psa_key_creation_method_t method,
Gilles Peskine4747d192019-04-17 15:05:45 +02001583 const psa_key_attributes_t *attributes,
Gilles Peskine011e4282019-06-26 18:34:38 +02001584 psa_key_slot_t **p_slot,
Gilles Peskine449bd832023-01-11 14:50:10 +01001585 psa_se_drv_table_entry_t **p_drv)
Gilles Peskine4747d192019-04-17 15:05:45 +02001586{
1587 psa_status_t status;
Ronald Cron2a993152020-07-17 14:13:26 +02001588 psa_key_id_t volatile_key_id;
Gilles Peskine4747d192019-04-17 15:05:45 +02001589 psa_key_slot_t *slot;
1590
Gilles Peskinedf179142019-07-15 22:02:14 +02001591 (void) method;
Gilles Peskine011e4282019-06-26 18:34:38 +02001592 *p_drv = NULL;
1593
Gilles Peskine449bd832023-01-11 14:50:10 +01001594 status = psa_validate_key_attributes(attributes, p_drv);
1595 if (status != PSA_SUCCESS) {
1596 return status;
1597 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001598
Gilles Peskine449bd832023-01-11 14:50:10 +01001599 status = psa_get_empty_key_slot(&volatile_key_id, p_slot);
1600 if (status != PSA_SUCCESS) {
1601 return status;
1602 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001603 slot = *p_slot;
1604
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001605 /* We're storing the declared bit-size of the key. It's up to each
1606 * creation mechanism to verify that this information is correct.
1607 * It's automatically correct for mechanisms that use the bit-size as
Gilles Peskineb46bef22019-07-30 21:32:04 +02001608 * an input (generate, device) but not for those where the bit-size
Ronald Cronc4d1b512020-07-31 11:26:37 +02001609 * is optional (import, copy). In case of a volatile key, assign it the
1610 * volatile key identifier associated to the slot returned to contain its
1611 * definition. */
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001612
1613 slot->attr = attributes->core;
Gilles Peskine449bd832023-01-11 14:50:10 +01001614 if (PSA_KEY_LIFETIME_IS_VOLATILE(slot->attr.lifetime)) {
Ronald Cronc4d1b512020-07-31 11:26:37 +02001615#if !defined(MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER)
1616 slot->attr.id = volatile_key_id;
1617#else
1618 slot->attr.id.key_id = volatile_key_id;
1619#endif
1620 }
Gilles Peskinec744d992019-07-30 17:26:54 +02001621
Gilles Peskine91e8c332019-08-02 19:19:39 +02001622 /* Erase external-only flags from the internal copy. To access
Gilles Peskine013f5472019-08-07 15:42:14 +02001623 * external-only flags, query `attributes`. Thanks to the check
1624 * in psa_validate_key_attributes(), this leaves the dual-use
Gilles Peskineedbed562019-08-07 18:19:59 +02001625 * flags and any internal flag that psa_get_empty_key_slot()
Gilles Peskine013f5472019-08-07 15:42:14 +02001626 * may have set. */
1627 slot->attr.flags &= ~MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY;
Gilles Peskine91e8c332019-08-02 19:19:39 +02001628
Gilles Peskinecbaff462019-07-12 23:46:04 +02001629#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001630 /* For a key in a secure element, we need to do three things
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001631 * when creating or registering a persistent key:
Gilles Peskine60450a42019-07-25 11:32:45 +02001632 * create the key file in internal storage, create the
1633 * key inside the secure element, and update the driver's
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001634 * persistent data. This is done by starting a transaction that will
1635 * encompass these three actions.
1636 * For registering a volatile key, we just need to find an appropriate
1637 * slot number inside the SE. Since the key is designated volatile, creating
1638 * a transaction is not required. */
Gilles Peskine60450a42019-07-25 11:32:45 +02001639 /* The first thing to do is to find a slot number for the new key.
1640 * We save the slot number in persistent storage as part of the
1641 * transaction data. It will be needed to recover if the power
1642 * fails during the key creation process, to clean up on the secure
1643 * element side after restarting. Obtaining a slot number from the
1644 * secure element driver updates its persistent state, but we do not yet
1645 * save the driver's persistent state, so that if the power fails,
Gilles Peskinefc762652019-07-22 19:30:34 +02001646 * we can roll back to a state where the key doesn't exist. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001647 if (*p_drv != NULL) {
Ronald Cronea0f8a62020-11-25 17:52:23 +01001648 psa_key_slot_number_t slot_number;
Gilles Peskine449bd832023-01-11 14:50:10 +01001649 status = psa_find_se_slot_for_key(attributes, method, *p_drv,
1650 &slot_number);
1651 if (status != PSA_SUCCESS) {
1652 return status;
1653 }
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001654
Gilles Peskine449bd832023-01-11 14:50:10 +01001655 if (!PSA_KEY_LIFETIME_IS_VOLATILE(attributes->core.lifetime)) {
1656 psa_crypto_prepare_transaction(PSA_CRYPTO_TRANSACTION_CREATE_KEY);
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001657 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001658 psa_crypto_transaction.key.slot = slot_number;
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001659 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskine449bd832023-01-11 14:50:10 +01001660 status = psa_crypto_save_transaction();
1661 if (status != PSA_SUCCESS) {
1662 (void) psa_crypto_stop_transaction();
1663 return status;
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001664 }
Gilles Peskine66be51c2019-07-25 18:02:52 +02001665 }
Ronald Cronea0f8a62020-11-25 17:52:23 +01001666
1667 status = psa_copy_key_material_into_slot(
Gilles Peskine449bd832023-01-11 14:50:10 +01001668 slot, (uint8_t *) (&slot_number), sizeof(slot_number));
Darryl Green0c6575a2018-11-07 16:05:30 +00001669 }
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001670
Gilles Peskine449bd832023-01-11 14:50:10 +01001671 if (*p_drv == NULL && method == PSA_KEY_CREATION_REGISTER) {
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001672 /* Key registration only makes sense with a secure element. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001673 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001674 }
Gilles Peskinecbaff462019-07-12 23:46:04 +02001675#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1676
Ryan Everett975d4112023-11-16 13:37:51 +00001677 slot->status = PSA_SLOT_OCCUPIED;
1678
Gilles Peskine449bd832023-01-11 14:50:10 +01001679 return PSA_SUCCESS;
Darryl Green0c6575a2018-11-07 16:05:30 +00001680}
Gilles Peskine4747d192019-04-17 15:05:45 +02001681
1682/** Finalize the creation of a key once its key material has been set.
1683 *
1684 * This entails writing the key to persistent storage.
1685 *
1686 * If this function fails, call psa_fail_key_creation().
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001687 * See the documentation of psa_start_key_creation() for the intended use
1688 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001689 *
Ronald Cron5c522922020-11-14 16:35:34 +01001690 * If the finalization succeeds, the function unlocks the key slot (it was
1691 * locked by psa_start_key_creation()) and the key slot cannot be accessed
1692 * anymore as part of the key creation process.
Ronald Cron50972942020-11-14 11:28:25 +01001693 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001694 * \param[in,out] slot Pointer to the slot with key material.
1695 * \param[in] driver The secure element driver for the key,
1696 * or NULL for a transparent key.
Ronald Cron81709fc2020-11-14 12:10:32 +01001697 * \param[out] key On success, identifier of the key. Note that the
1698 * key identifier is also stored in the key slot.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001699 *
1700 * \retval #PSA_SUCCESS
Ronald Croncf56a0a2020-08-04 09:51:30 +02001701 * The key was successfully created.
Gilles Peskineed733552023-02-14 19:21:09 +01001702 * \retval #PSA_ERROR_INSUFFICIENT_MEMORY \emptydescription
1703 * \retval #PSA_ERROR_INSUFFICIENT_STORAGE \emptydescription
1704 * \retval #PSA_ERROR_ALREADY_EXISTS \emptydescription
1705 * \retval #PSA_ERROR_DATA_INVALID \emptydescription
1706 * \retval #PSA_ERROR_DATA_CORRUPT \emptydescription
1707 * \retval #PSA_ERROR_STORAGE_FAILURE \emptydescription
gabor-mezei-arm452b0a32020-11-09 17:42:55 +01001708 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001709 * \return If this function fails, the key slot is an invalid state.
1710 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001711 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001712static psa_status_t psa_finish_key_creation(
1713 psa_key_slot_t *slot,
Ronald Cron81709fc2020-11-14 12:10:32 +01001714 psa_se_drv_table_entry_t *driver,
1715 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02001716{
1717 psa_status_t status = PSA_SUCCESS;
Gilles Peskine30afafd2019-04-25 13:47:40 +02001718 (void) slot;
Gilles Peskine011e4282019-06-26 18:34:38 +02001719 (void) driver;
Gilles Peskine4747d192019-04-17 15:05:45 +02001720
1721#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001722 if (!PSA_KEY_LIFETIME_IS_VOLATILE(slot->attr.lifetime)) {
Gilles Peskine1df83d42019-07-23 16:13:14 +02001723#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001724 if (driver != NULL) {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001725 psa_se_key_data_storage_t data;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001726 psa_key_slot_number_t slot_number =
Gilles Peskine449bd832023-01-11 14:50:10 +01001727 psa_key_slot_get_slot_number(slot);
Ronald Cronea0f8a62020-11-25 17:52:23 +01001728
Tom Cosgrove6ef9bb32023-03-08 14:19:51 +00001729 MBEDTLS_STATIC_ASSERT(sizeof(slot_number) ==
1730 sizeof(data.slot_number),
1731 "Slot number size does not match psa_se_key_data_storage_t");
1732
Gilles Peskine449bd832023-01-11 14:50:10 +01001733 memcpy(&data.slot_number, &slot_number, sizeof(slot_number));
1734 status = psa_save_persistent_key(&slot->attr,
1735 (uint8_t *) &data,
1736 sizeof(data));
1737 } else
Gilles Peskine1df83d42019-07-23 16:13:14 +02001738#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1739 {
Steven Cooreman40120f62020-10-29 11:42:22 +01001740 /* Key material is saved in export representation in the slot, so
1741 * just pass the slot buffer for storage. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001742 status = psa_save_persistent_key(&slot->attr,
1743 slot->key.data,
1744 slot->key.bytes);
Gilles Peskine1df83d42019-07-23 16:13:14 +02001745 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001746 }
Darryl Green0c6575a2018-11-07 16:05:30 +00001747#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
1748
Gilles Peskinecbaff462019-07-12 23:46:04 +02001749#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001750 /* Finish the transaction for a key creation. This does not
1751 * happen when registering an existing key. Detect this case
1752 * by checking whether a transaction is in progress (actual
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001753 * creation of a persistent key in a secure element requires a transaction,
1754 * but registration or volatile key creation doesn't use one). */
Gilles Peskine449bd832023-01-11 14:50:10 +01001755 if (driver != NULL &&
1756 psa_crypto_transaction.unknown.type == PSA_CRYPTO_TRANSACTION_CREATE_KEY) {
1757 status = psa_save_se_persistent_data(driver);
1758 if (status != PSA_SUCCESS) {
1759 psa_destroy_persistent_key(slot->attr.id);
1760 return status;
Gilles Peskinecbaff462019-07-12 23:46:04 +02001761 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001762 status = psa_crypto_stop_transaction();
Gilles Peskinecbaff462019-07-12 23:46:04 +02001763 }
1764#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1765
Gilles Peskine449bd832023-01-11 14:50:10 +01001766 if (status == PSA_SUCCESS) {
Ronald Cron81709fc2020-11-14 12:10:32 +01001767 *key = slot->attr.id;
Gilles Peskine449bd832023-01-11 14:50:10 +01001768 status = psa_unlock_key_slot(slot);
1769 if (status != PSA_SUCCESS) {
Ronald Cron81709fc2020-11-14 12:10:32 +01001770 *key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01001771 }
Ronald Cron81709fc2020-11-14 12:10:32 +01001772 }
Ronald Cron50972942020-11-14 11:28:25 +01001773
Gilles Peskine449bd832023-01-11 14:50:10 +01001774 return status;
Gilles Peskine4747d192019-04-17 15:05:45 +02001775}
1776
1777/** Abort the creation of a key.
1778 *
1779 * You may call this function after calling psa_start_key_creation(),
1780 * or after psa_finish_key_creation() fails. In other circumstances, this
1781 * function may not clean up persistent storage.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001782 * See the documentation of psa_start_key_creation() for the intended use
1783 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001784 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001785 * \param[in,out] slot Pointer to the slot with key material.
1786 * \param[in] driver The secure element driver for the key,
1787 * or NULL for a transparent key.
Gilles Peskine4747d192019-04-17 15:05:45 +02001788 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001789static void psa_fail_key_creation(psa_key_slot_t *slot,
1790 psa_se_drv_table_entry_t *driver)
Gilles Peskine4747d192019-04-17 15:05:45 +02001791{
Gilles Peskine011e4282019-06-26 18:34:38 +02001792 (void) driver;
1793
Gilles Peskine449bd832023-01-11 14:50:10 +01001794 if (slot == NULL) {
Gilles Peskine4747d192019-04-17 15:05:45 +02001795 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01001796 }
Gilles Peskine011e4282019-06-26 18:34:38 +02001797
1798#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001799 /* TODO: If the key has already been created in the secure
Gilles Peskine011e4282019-06-26 18:34:38 +02001800 * element, and the failure happened later (when saving metadata
1801 * to internal storage), we need to destroy the key in the secure
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001802 * element.
1803 * https://github.com/ARMmbed/mbed-crypto/issues/217
1804 */
Gilles Peskinefc762652019-07-22 19:30:34 +02001805
Gilles Peskined7729582019-08-05 15:55:54 +02001806 /* Abort the ongoing transaction if any (there may not be one if
1807 * the creation process failed before starting one, or if the
1808 * key creation is a registration of a key in a secure element).
1809 * Earlier functions must already have done what it takes to undo any
1810 * partial creation. All that's left is to update the transaction data
1811 * itself. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001812 (void) psa_crypto_stop_transaction();
Gilles Peskine011e4282019-06-26 18:34:38 +02001813#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1814
Gilles Peskine449bd832023-01-11 14:50:10 +01001815 psa_wipe_key_slot(slot);
Gilles Peskine4747d192019-04-17 15:05:45 +02001816}
1817
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001818/** Validate optional attributes during key creation.
1819 *
1820 * Some key attributes are optional during key creation. If they are
1821 * specified in the attributes structure, check that they are consistent
1822 * with the data in the slot.
1823 *
1824 * This function should be called near the end of key creation, after
1825 * the slot in memory is fully populated but before saving persistent data.
1826 */
1827static psa_status_t psa_validate_optional_attributes(
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001828 const psa_key_slot_t *slot,
Gilles Peskine449bd832023-01-11 14:50:10 +01001829 const psa_key_attributes_t *attributes)
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001830{
Gilles Peskine449bd832023-01-11 14:50:10 +01001831 if (attributes->core.type != 0) {
1832 if (attributes->core.type != slot->attr.type) {
1833 return PSA_ERROR_INVALID_ARGUMENT;
1834 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001835 }
1836
Gilles Peskine449bd832023-01-11 14:50:10 +01001837 if (attributes->domain_parameters_size != 0) {
Valerio Settib2bcedb2023-07-10 11:24:00 +02001838#if (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) && \
1839 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01001840 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
1841 if (PSA_KEY_TYPE_IS_RSA(slot->attr.type)) {
Steven Cooremana2371e52020-07-28 14:30:39 +02001842 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman75b74362020-07-28 14:30:13 +02001843 mbedtls_mpi actual, required;
Steven Cooreman6d839f02020-07-30 11:36:45 +02001844 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooremana01795d2020-07-24 22:48:15 +02001845
Ronald Cron90857082020-11-25 14:58:33 +01001846 psa_status_t status = mbedtls_psa_rsa_load_representation(
Gilles Peskine449bd832023-01-11 14:50:10 +01001847 slot->attr.type,
1848 slot->key.data,
1849 slot->key.bytes,
1850 &rsa);
1851 if (status != PSA_SUCCESS) {
1852 return status;
1853 }
Steven Cooreman75b74362020-07-28 14:30:13 +02001854
Gilles Peskine449bd832023-01-11 14:50:10 +01001855 mbedtls_mpi_init(&actual);
1856 mbedtls_mpi_init(&required);
1857 ret = mbedtls_rsa_export(rsa,
1858 NULL, NULL, NULL, NULL, &actual);
1859 mbedtls_rsa_free(rsa);
1860 mbedtls_free(rsa);
1861 if (ret != 0) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001862 goto rsa_exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001863 }
1864 ret = mbedtls_mpi_read_binary(&required,
1865 attributes->domain_parameters,
1866 attributes->domain_parameters_size);
1867 if (ret != 0) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001868 goto rsa_exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001869 }
1870 if (mbedtls_mpi_cmp_mpi(&actual, &required) != 0) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001871 ret = MBEDTLS_ERR_RSA_BAD_INPUT_DATA;
Gilles Peskine449bd832023-01-11 14:50:10 +01001872 }
1873rsa_exit:
1874 mbedtls_mpi_free(&actual);
1875 mbedtls_mpi_free(&required);
1876 if (ret != 0) {
1877 return mbedtls_to_psa_error(ret);
1878 }
1879 } else
Valerio Settib2bcedb2023-07-10 11:24:00 +02001880#endif /* (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) &&
1881 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) ||
John Durkop9814fa22020-11-04 12:28:15 -08001882 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001883 {
Gilles Peskine449bd832023-01-11 14:50:10 +01001884 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001885 }
1886 }
1887
Gilles Peskine449bd832023-01-11 14:50:10 +01001888 if (attributes->core.bits != 0) {
1889 if (attributes->core.bits != slot->attr.bits) {
1890 return PSA_ERROR_INVALID_ARGUMENT;
1891 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001892 }
1893
Gilles Peskine449bd832023-01-11 14:50:10 +01001894 return PSA_SUCCESS;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001895}
1896
Gilles Peskine449bd832023-01-11 14:50:10 +01001897psa_status_t psa_import_key(const psa_key_attributes_t *attributes,
1898 const uint8_t *data,
1899 size_t data_length,
1900 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02001901{
1902 psa_status_t status;
1903 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001904 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001905 size_t bits;
Archanad8a83dc2021-06-14 10:04:16 +05301906 size_t storage_size = data_length;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001907
Ronald Cron81709fc2020-11-14 12:10:32 +01001908 *key = MBEDTLS_SVC_KEY_ID_INIT;
1909
Gilles Peskine0f84d622019-09-12 19:03:13 +02001910 /* Reject zero-length symmetric keys (including raw data key objects).
1911 * This also rejects any key which might be encoded as an empty string,
1912 * which is never valid. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001913 if (data_length == 0) {
1914 return PSA_ERROR_INVALID_ARGUMENT;
1915 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02001916
Archana449608b2021-09-08 15:36:05 +05301917 /* Ensure that the bytes-to-bits conversion cannot overflow. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001918 if (data_length > SIZE_MAX / 8) {
1919 return PSA_ERROR_NOT_SUPPORTED;
1920 }
Archana6ed4bda2021-08-04 10:47:15 +05301921
Gilles Peskine449bd832023-01-11 14:50:10 +01001922 status = psa_start_key_creation(PSA_KEY_CREATION_IMPORT, attributes,
1923 &slot, &driver);
1924 if (status != PSA_SUCCESS) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001925 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001926 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001927
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001928 /* In the case of a transparent key or an opaque key stored in local
Archana449608b2021-09-08 15:36:05 +05301929 * storage ( thus not in the case of importing a key in a secure element
1930 * with storage ( MBEDTLS_PSA_CRYPTO_SE_C ) ),we have to allocate a
1931 * buffer to hold the imported key material. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001932 if (slot->key.data == NULL) {
1933 if (psa_key_lifetime_is_external(attributes->core.lifetime)) {
Archana449608b2021-09-08 15:36:05 +05301934 status = psa_driver_wrapper_get_key_buffer_size_from_key_data(
Gilles Peskine449bd832023-01-11 14:50:10 +01001935 attributes, data, data_length, &storage_size);
1936 if (status != PSA_SUCCESS) {
Archanad8a83dc2021-06-14 10:04:16 +05301937 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001938 }
Archanad8a83dc2021-06-14 10:04:16 +05301939 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001940 status = psa_allocate_buffer_to_slot(slot, storage_size);
1941 if (status != PSA_SUCCESS) {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001942 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001943 }
Gilles Peskine5d309672019-07-12 23:47:28 +02001944 }
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001945
1946 bits = slot->attr.bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01001947 status = psa_driver_wrapper_import_key(attributes,
1948 data, data_length,
1949 slot->key.data,
1950 slot->key.bytes,
1951 &slot->key.bytes, &bits);
1952 if (status != PSA_SUCCESS) {
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001953 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001954 }
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001955
Gilles Peskine449bd832023-01-11 14:50:10 +01001956 if (slot->attr.bits == 0) {
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001957 slot->attr.bits = (psa_key_bits_t) bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01001958 } else if (bits != slot->attr.bits) {
Steven Cooremanac3434f2021-01-15 17:36:02 +01001959 status = PSA_ERROR_INVALID_ARGUMENT;
1960 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02001961 }
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01001962
Archana6ed4bda2021-08-04 10:47:15 +05301963 /* Enforce a size limit, and in particular ensure that the bit
1964 * size fits in its representation type.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01001965 if (bits > PSA_MAX_KEY_BITS) {
Archana6ed4bda2021-08-04 10:47:15 +05301966 status = PSA_ERROR_NOT_SUPPORTED;
1967 goto exit;
1968 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001969 status = psa_validate_optional_attributes(slot, attributes);
1970 if (status != PSA_SUCCESS) {
Gilles Peskine18017402019-07-24 20:25:59 +02001971 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001972 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001973
Gilles Peskine449bd832023-01-11 14:50:10 +01001974 status = psa_finish_key_creation(slot, driver, key);
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001975exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01001976 if (status != PSA_SUCCESS) {
1977 psa_fail_key_creation(slot, driver);
1978 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001979
Gilles Peskine449bd832023-01-11 14:50:10 +01001980 return status;
Gilles Peskine4747d192019-04-17 15:05:45 +02001981}
1982
Gilles Peskined7729582019-08-05 15:55:54 +02001983#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1984psa_status_t mbedtls_psa_register_se_key(
Gilles Peskine449bd832023-01-11 14:50:10 +01001985 const psa_key_attributes_t *attributes)
Gilles Peskined7729582019-08-05 15:55:54 +02001986{
1987 psa_status_t status;
1988 psa_key_slot_t *slot = NULL;
1989 psa_se_drv_table_entry_t *driver = NULL;
Ronald Croncf56a0a2020-08-04 09:51:30 +02001990 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskined7729582019-08-05 15:55:54 +02001991
1992 /* Leaving attributes unspecified is not currently supported.
1993 * It could make sense to query the key type and size from the
1994 * secure element, but not all secure elements support this
1995 * and the driver HAL doesn't currently support it. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001996 if (psa_get_key_type(attributes) == PSA_KEY_TYPE_NONE) {
1997 return PSA_ERROR_NOT_SUPPORTED;
1998 }
1999 if (psa_get_key_bits(attributes) == 0) {
2000 return PSA_ERROR_NOT_SUPPORTED;
2001 }
Gilles Peskined7729582019-08-05 15:55:54 +02002002
Gilles Peskine449bd832023-01-11 14:50:10 +01002003 status = psa_start_key_creation(PSA_KEY_CREATION_REGISTER, attributes,
2004 &slot, &driver);
2005 if (status != PSA_SUCCESS) {
Gilles Peskined7729582019-08-05 15:55:54 +02002006 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002007 }
Gilles Peskined7729582019-08-05 15:55:54 +02002008
Gilles Peskine449bd832023-01-11 14:50:10 +01002009 status = psa_finish_key_creation(slot, driver, &key);
Gilles Peskined7729582019-08-05 15:55:54 +02002010
2011exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002012 if (status != PSA_SUCCESS) {
2013 psa_fail_key_creation(slot, driver);
2014 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002015
Gilles Peskined7729582019-08-05 15:55:54 +02002016 /* Registration doesn't keep the key in RAM. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002017 psa_close_key(key);
2018 return status;
Gilles Peskined7729582019-08-05 15:55:54 +02002019}
2020#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2021
Gilles Peskine449bd832023-01-11 14:50:10 +01002022psa_status_t psa_copy_key(mbedtls_svc_key_id_t source_key,
2023 const psa_key_attributes_t *specified_attributes,
2024 mbedtls_svc_key_id_t *target_key)
Gilles Peskinef603c712019-01-19 13:40:11 +01002025{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002026 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01002027 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinef603c712019-01-19 13:40:11 +01002028 psa_key_slot_t *source_slot = NULL;
2029 psa_key_slot_t *target_slot = NULL;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002030 psa_key_attributes_t actual_attributes = *specified_attributes;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002031 psa_se_drv_table_entry_t *driver = NULL;
Archana8a180362021-07-05 02:18:48 +05302032 size_t storage_size = 0;
Gilles Peskinef603c712019-01-19 13:40:11 +01002033
Ronald Cron81709fc2020-11-14 12:10:32 +01002034 *target_key = MBEDTLS_SVC_KEY_ID_INIT;
2035
Archana8a180362021-07-05 02:18:48 +05302036 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002037 source_key, &source_slot, PSA_KEY_USAGE_COPY, 0);
2038 if (status != PSA_SUCCESS) {
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002039 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002040 }
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002041
Gilles Peskine449bd832023-01-11 14:50:10 +01002042 status = psa_validate_optional_attributes(source_slot,
2043 specified_attributes);
2044 if (status != PSA_SUCCESS) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002045 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002046 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002047
Archana9d17bf42021-09-10 06:22:44 +05302048 /* The target key type and number of bits have been validated by
2049 * psa_validate_optional_attributes() to be either equal to zero or
2050 * equal to the ones of the source key. So it is safe to inherit
2051 * them from the source key now."
Archana374fe5b2021-09-08 15:50:28 +05302052 * */
Archana9d17bf42021-09-10 06:22:44 +05302053 actual_attributes.core.bits = source_slot->attr.bits;
2054 actual_attributes.core.type = source_slot->attr.type;
Archana374fe5b2021-09-08 15:50:28 +05302055
2056
Gilles Peskine449bd832023-01-11 14:50:10 +01002057 status = psa_restrict_key_policy(source_slot->attr.type,
2058 &actual_attributes.core.policy,
2059 &source_slot->attr.policy);
2060 if (status != PSA_SUCCESS) {
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002061 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002062 }
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002063
Gilles Peskine449bd832023-01-11 14:50:10 +01002064 status = psa_start_key_creation(PSA_KEY_CREATION_COPY, &actual_attributes,
2065 &target_slot, &driver);
2066 if (status != PSA_SUCCESS) {
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002067 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002068 }
2069 if (PSA_KEY_LIFETIME_GET_LOCATION(target_slot->attr.lifetime) !=
2070 PSA_KEY_LIFETIME_GET_LOCATION(source_slot->attr.lifetime)) {
Archana8a180362021-07-05 02:18:48 +05302071 /*
Archana9d17bf42021-09-10 06:22:44 +05302072 * If the source and target keys are stored in different locations,
Archana8a180362021-07-05 02:18:48 +05302073 * the source key would need to be exported as plaintext and re-imported
2074 * in the other location. This has security implications which have not
Archana449608b2021-09-08 15:36:05 +05302075 * been fully mapped. For now, this can be achieved through
Archana8a180362021-07-05 02:18:48 +05302076 * appropriate API invocations from the application, if needed.
2077 * */
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002078 status = PSA_ERROR_NOT_SUPPORTED;
2079 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002080 }
Archana8a180362021-07-05 02:18:48 +05302081 /*
2082 * When the source and target keys are within the same location,
Archana449608b2021-09-08 15:36:05 +05302083 * - For transparent keys it is a blind copy without any driver invocation,
Archana8a180362021-07-05 02:18:48 +05302084 * - For opaque keys this translates to an invocation of the drivers'
2085 * copy_key entry point through the dispatch layer.
2086 * */
Gilles Peskine449bd832023-01-11 14:50:10 +01002087 if (psa_key_lifetime_is_external(actual_attributes.core.lifetime)) {
2088 status = psa_driver_wrapper_get_key_buffer_size(&actual_attributes,
2089 &storage_size);
2090 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302091 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002092 }
Archana374fe5b2021-09-08 15:50:28 +05302093
Gilles Peskine449bd832023-01-11 14:50:10 +01002094 status = psa_allocate_buffer_to_slot(target_slot, storage_size);
2095 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302096 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002097 }
Archana374fe5b2021-09-08 15:50:28 +05302098
Gilles Peskine449bd832023-01-11 14:50:10 +01002099 status = psa_driver_wrapper_copy_key(&actual_attributes,
2100 source_slot->key.data,
2101 source_slot->key.bytes,
2102 target_slot->key.data,
2103 target_slot->key.bytes,
2104 &target_slot->key.bytes);
2105 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302106 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002107 }
2108 } else {
2109 status = psa_copy_key_material_into_slot(target_slot,
Archana9d17bf42021-09-10 06:22:44 +05302110 source_slot->key.data,
Gilles Peskine449bd832023-01-11 14:50:10 +01002111 source_slot->key.bytes);
2112 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302113 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002114 }
Archana8a180362021-07-05 02:18:48 +05302115 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002116 status = psa_finish_key_creation(target_slot, driver, target_key);
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002117exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002118 if (status != PSA_SUCCESS) {
2119 psa_fail_key_creation(target_slot, driver);
2120 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002121
Gilles Peskine449bd832023-01-11 14:50:10 +01002122 unlock_status = psa_unlock_key_slot(source_slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02002123
Gilles Peskine449bd832023-01-11 14:50:10 +01002124 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskinef603c712019-01-19 13:40:11 +01002125}
2126
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02002127
2128
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01002129/****************************************************************/
Gilles Peskine20035e32018-02-03 22:44:14 +01002130/* Message digests */
2131/****************************************************************/
2132
Gilles Peskine449bd832023-01-11 14:50:10 +01002133psa_status_t psa_hash_abort(psa_hash_operation_t *operation)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002134{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002135 /* Aborting a non-active operation is allowed */
Gilles Peskine449bd832023-01-11 14:50:10 +01002136 if (operation->id == 0) {
2137 return PSA_SUCCESS;
2138 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002139
Gilles Peskine449bd832023-01-11 14:50:10 +01002140 psa_status_t status = psa_driver_wrapper_hash_abort(operation);
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002141 operation->id = 0;
2142
Gilles Peskine449bd832023-01-11 14:50:10 +01002143 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002144}
2145
Gilles Peskine449bd832023-01-11 14:50:10 +01002146psa_status_t psa_hash_setup(psa_hash_operation_t *operation,
2147 psa_algorithm_t alg)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002148{
Dave Rodgman685b6a72021-06-24 11:49:14 +01002149 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002150
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002151 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002152 if (operation->id != 0) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002153 status = PSA_ERROR_BAD_STATE;
2154 goto exit;
2155 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002156
Gilles Peskine449bd832023-01-11 14:50:10 +01002157 if (!PSA_ALG_IS_HASH(alg)) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002158 status = PSA_ERROR_INVALID_ARGUMENT;
2159 goto exit;
2160 }
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002161
Steven Cooremanb6bf4bb2021-03-15 19:00:14 +01002162 /* Ensure all of the context is zeroized, since PSA_HASH_OPERATION_INIT only
2163 * directly zeroes the int-sized dummy member of the context union. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002164 memset(&operation->ctx, 0, sizeof(operation->ctx));
Steven Cooreman893232f2021-03-15 12:23:37 +01002165
Gilles Peskine449bd832023-01-11 14:50:10 +01002166 status = psa_driver_wrapper_hash_setup(operation, alg);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002167
2168exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002169 if (status != PSA_SUCCESS) {
2170 psa_hash_abort(operation);
2171 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002172
2173 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002174}
2175
Gilles Peskine449bd832023-01-11 14:50:10 +01002176psa_status_t psa_hash_update(psa_hash_operation_t *operation,
2177 const uint8_t *input,
2178 size_t input_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002179{
Dave Rodgman685b6a72021-06-24 11:49:14 +01002180 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2181
Gilles Peskine449bd832023-01-11 14:50:10 +01002182 if (operation->id == 0) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002183 status = PSA_ERROR_BAD_STATE;
2184 goto exit;
2185 }
Gilles Peskine94e44542018-07-12 16:58:43 +02002186
Steven Cooremanc8288352021-03-04 14:02:19 +01002187 /* Don't require hash implementations to behave correctly on a
2188 * zero-length input, which may have an invalid pointer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002189 if (input_length == 0) {
2190 return PSA_SUCCESS;
2191 }
Steven Cooremanc8288352021-03-04 14:02:19 +01002192
Gilles Peskine449bd832023-01-11 14:50:10 +01002193 status = psa_driver_wrapper_hash_update(operation, input, input_length);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002194
2195exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002196 if (status != PSA_SUCCESS) {
2197 psa_hash_abort(operation);
2198 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002199
Gilles Peskine449bd832023-01-11 14:50:10 +01002200 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002201}
2202
Gilles Peskine449bd832023-01-11 14:50:10 +01002203psa_status_t psa_hash_finish(psa_hash_operation_t *operation,
2204 uint8_t *hash,
2205 size_t hash_size,
2206 size_t *hash_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002207{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002208 *hash_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002209 if (operation->id == 0) {
2210 return PSA_ERROR_BAD_STATE;
2211 }
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002212
Steven Cooreman1e582352021-02-18 17:24:37 +01002213 psa_status_t status = psa_driver_wrapper_hash_finish(
Gilles Peskine449bd832023-01-11 14:50:10 +01002214 operation, hash, hash_size, hash_length);
2215 psa_hash_abort(operation);
2216 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002217}
2218
Gilles Peskine449bd832023-01-11 14:50:10 +01002219psa_status_t psa_hash_verify(psa_hash_operation_t *operation,
2220 const uint8_t *hash,
2221 size_t hash_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002222{
Ronald Cron69a63422021-10-18 09:47:58 +02002223 uint8_t actual_hash[PSA_HASH_MAX_SIZE];
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002224 size_t actual_hash_length;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002225 psa_status_t status = psa_hash_finish(
Gilles Peskine449bd832023-01-11 14:50:10 +01002226 operation,
2227 actual_hash, sizeof(actual_hash),
2228 &actual_hash_length);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002229
Gilles Peskine449bd832023-01-11 14:50:10 +01002230 if (status != PSA_SUCCESS) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002231 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002232 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002233
Gilles Peskine449bd832023-01-11 14:50:10 +01002234 if (actual_hash_length != hash_length) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002235 status = PSA_ERROR_INVALID_SIGNATURE;
2236 goto exit;
2237 }
2238
Dave Rodgman78701152023-08-29 14:20:18 +01002239 if (mbedtls_ct_memcmp(hash, actual_hash, actual_hash_length) != 0) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002240 status = PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01002241 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002242
2243exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002244 mbedtls_platform_zeroize(actual_hash, sizeof(actual_hash));
2245 if (status != PSA_SUCCESS) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002246 psa_hash_abort(operation);
Gilles Peskine449bd832023-01-11 14:50:10 +01002247 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002248
Gilles Peskine449bd832023-01-11 14:50:10 +01002249 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002250}
2251
Gilles Peskine449bd832023-01-11 14:50:10 +01002252psa_status_t psa_hash_compute(psa_algorithm_t alg,
2253 const uint8_t *input, size_t input_length,
2254 uint8_t *hash, size_t hash_size,
2255 size_t *hash_length)
Gilles Peskine0a749c82019-11-28 19:33:58 +01002256{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002257 *hash_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002258 if (!PSA_ALG_IS_HASH(alg)) {
2259 return PSA_ERROR_INVALID_ARGUMENT;
2260 }
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002261
Gilles Peskine449bd832023-01-11 14:50:10 +01002262 return psa_driver_wrapper_hash_compute(alg, input, input_length,
2263 hash, hash_size, hash_length);
Gilles Peskine0a749c82019-11-28 19:33:58 +01002264}
2265
Gilles Peskine449bd832023-01-11 14:50:10 +01002266psa_status_t psa_hash_compare(psa_algorithm_t alg,
2267 const uint8_t *input, size_t input_length,
2268 const uint8_t *hash, size_t hash_length)
Gilles Peskine0a749c82019-11-28 19:33:58 +01002269{
Ronald Cron69a63422021-10-18 09:47:58 +02002270 uint8_t actual_hash[PSA_HASH_MAX_SIZE];
Steven Cooreman84d670d2021-02-18 16:22:53 +01002271 size_t actual_hash_length;
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002272
Gilles Peskine449bd832023-01-11 14:50:10 +01002273 if (!PSA_ALG_IS_HASH(alg)) {
2274 return PSA_ERROR_INVALID_ARGUMENT;
2275 }
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002276
Steven Cooreman1e582352021-02-18 17:24:37 +01002277 psa_status_t status = psa_driver_wrapper_hash_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01002278 alg, input, input_length,
2279 actual_hash, sizeof(actual_hash),
2280 &actual_hash_length);
2281 if (status != PSA_SUCCESS) {
Gilles Peskine60aebec2021-12-13 12:33:18 +01002282 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002283 }
2284 if (actual_hash_length != hash_length) {
Gilles Peskine60aebec2021-12-13 12:33:18 +01002285 status = PSA_ERROR_INVALID_SIGNATURE;
2286 goto exit;
2287 }
Dave Rodgman78701152023-08-29 14:20:18 +01002288 if (mbedtls_ct_memcmp(hash, actual_hash, actual_hash_length) != 0) {
Gilles Peskine60aebec2021-12-13 12:33:18 +01002289 status = PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01002290 }
Gilles Peskine60aebec2021-12-13 12:33:18 +01002291
2292exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002293 mbedtls_platform_zeroize(actual_hash, sizeof(actual_hash));
2294 return status;
Gilles Peskine0a749c82019-11-28 19:33:58 +01002295}
2296
Gilles Peskine449bd832023-01-11 14:50:10 +01002297psa_status_t psa_hash_clone(const psa_hash_operation_t *source_operation,
2298 psa_hash_operation_t *target_operation)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002299{
Gilles Peskine449bd832023-01-11 14:50:10 +01002300 if (source_operation->id == 0 ||
2301 target_operation->id != 0) {
2302 return PSA_ERROR_BAD_STATE;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002303 }
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002304
Gilles Peskine449bd832023-01-11 14:50:10 +01002305 psa_status_t status = psa_driver_wrapper_hash_clone(source_operation,
2306 target_operation);
2307 if (status != PSA_SUCCESS) {
2308 psa_hash_abort(target_operation);
2309 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002310
Gilles Peskine449bd832023-01-11 14:50:10 +01002311 return status;
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002312}
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002313
2314
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002315/****************************************************************/
Gilles Peskine8c9def32018-02-08 10:02:12 +01002316/* MAC */
2317/****************************************************************/
2318
Gilles Peskine449bd832023-01-11 14:50:10 +01002319psa_status_t psa_mac_abort(psa_mac_operation_t *operation)
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002320{
Steven Cooremane6804192021-03-19 18:28:56 +01002321 /* Aborting a non-active operation is allowed */
Gilles Peskine449bd832023-01-11 14:50:10 +01002322 if (operation->id == 0) {
2323 return PSA_SUCCESS;
2324 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002325
Gilles Peskine449bd832023-01-11 14:50:10 +01002326 psa_status_t status = psa_driver_wrapper_mac_abort(operation);
Steven Cooreman72f736a2021-05-07 14:14:37 +02002327 operation->mac_size = 0;
2328 operation->is_sign = 0;
Steven Cooremane6804192021-03-19 18:28:56 +01002329 operation->id = 0;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002330
Gilles Peskine449bd832023-01-11 14:50:10 +01002331 return status;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002332}
2333
Ronald Cron2dff3b22021-06-17 16:33:22 +02002334static psa_status_t psa_mac_finalize_alg_and_key_validation(
2335 psa_algorithm_t alg,
Ronald Cron79bdd822021-06-17 16:46:44 +02002336 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01002337 uint8_t *mac_size)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002338{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002339 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002340 psa_key_type_t key_type = psa_get_key_type(attributes);
2341 size_t key_bits = psa_get_key_bits(attributes);
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002342
Gilles Peskine449bd832023-01-11 14:50:10 +01002343 if (!PSA_ALG_IS_MAC(alg)) {
2344 return PSA_ERROR_INVALID_ARGUMENT;
2345 }
Steven Cooremane6804192021-03-19 18:28:56 +01002346
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002347 /* Validate the combination of key type and algorithm */
Gilles Peskine449bd832023-01-11 14:50:10 +01002348 status = psa_mac_key_can_do(alg, key_type);
2349 if (status != PSA_SUCCESS) {
2350 return status;
2351 }
Steven Cooreman15472f82021-03-02 16:16:22 +01002352
Steven Cooremand1a68f12021-05-10 11:13:41 +02002353 /* Get the output length for the algorithm and key combination */
Gilles Peskine449bd832023-01-11 14:50:10 +01002354 *mac_size = PSA_MAC_LENGTH(key_type, key_bits, alg);
Steven Cooreman15472f82021-03-02 16:16:22 +01002355
Gilles Peskine449bd832023-01-11 14:50:10 +01002356 if (*mac_size < 4) {
Steven Cooreman15472f82021-03-02 16:16:22 +01002357 /* A very short MAC is too short for security since it can be
2358 * brute-forced. Ancient protocols with 32-bit MACs do exist,
2359 * so we make this our minimum, even though 32 bits is still
2360 * too small for security. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002361 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman15472f82021-03-02 16:16:22 +01002362 }
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02002363
Gilles Peskine449bd832023-01-11 14:50:10 +01002364 if (*mac_size > PSA_MAC_LENGTH(key_type, key_bits,
2365 PSA_ALG_FULL_LENGTH_MAC(alg))) {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002366 /* It's impossible to "truncate" to a larger length than the full length
2367 * of the algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002368 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002369 }
2370
Gilles Peskine449bd832023-01-11 14:50:10 +01002371 if (*mac_size > PSA_MAC_MAX_SIZE) {
Gilles Peskinea9b6c802022-03-16 13:54:49 +01002372 /* PSA_MAC_LENGTH returns the correct length even for a MAC algorithm
2373 * that is disabled in the compile-time configuration. The result can
2374 * therefore be larger than PSA_MAC_MAX_SIZE, which does take the
2375 * configuration into account. In this case, force a return of
2376 * PSA_ERROR_NOT_SUPPORTED here. Otherwise psa_mac_verify(), or
2377 * psa_mac_compute(mac_size=PSA_MAC_MAX_SIZE), would return
2378 * PSA_ERROR_BUFFER_TOO_SMALL for an unsupported algorithm whose MAC size
2379 * is larger than PSA_MAC_MAX_SIZE, which is misleading and which breaks
2380 * systematically generated tests. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002381 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea9b6c802022-03-16 13:54:49 +01002382 }
2383
Gilles Peskine449bd832023-01-11 14:50:10 +01002384 return PSA_SUCCESS;
Ronald Cron2dff3b22021-06-17 16:33:22 +02002385}
2386
Gilles Peskine449bd832023-01-11 14:50:10 +01002387static psa_status_t psa_mac_setup(psa_mac_operation_t *operation,
2388 mbedtls_svc_key_id_t key,
2389 psa_algorithm_t alg,
2390 int is_sign)
Gilles Peskinee59236f2018-01-27 23:32:46 +01002391{
2392 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2393 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman54648242021-06-24 11:49:45 +01002394 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002395 psa_key_attributes_t attributes;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002396
2397 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002398 if (operation->id != 0) {
Dave Rodgman54648242021-06-24 11:49:45 +01002399 status = PSA_ERROR_BAD_STATE;
2400 goto exit;
2401 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002402
2403 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002404 key,
2405 &slot,
2406 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
2407 alg);
2408 if (status != PSA_SUCCESS) {
Dave Rodgman54648242021-06-24 11:49:45 +01002409 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002410 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002411
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002412 attributes = (psa_key_attributes_t) {
Gilles Peskine8c9def32018-02-08 10:02:12 +01002413 .core = slot->attr
2414 };
2415
Gilles Peskine449bd832023-01-11 14:50:10 +01002416 status = psa_mac_finalize_alg_and_key_validation(alg, &attributes,
2417 &operation->mac_size);
2418 if (status != PSA_SUCCESS) {
Gilles Peskine8c9def32018-02-08 10:02:12 +01002419 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002420 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002421
2422 operation->is_sign = is_sign;
Steven Cooremane6804192021-03-19 18:28:56 +01002423 /* Dispatch the MAC setup call with validated input */
Gilles Peskine449bd832023-01-11 14:50:10 +01002424 if (is_sign) {
2425 status = psa_driver_wrapper_mac_sign_setup(operation,
2426 &attributes,
2427 slot->key.data,
2428 slot->key.bytes,
2429 alg);
2430 } else {
2431 status = psa_driver_wrapper_mac_verify_setup(operation,
2432 &attributes,
2433 slot->key.data,
2434 slot->key.bytes,
2435 alg);
Gilles Peskine8c9def32018-02-08 10:02:12 +01002436 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002437
Gilles Peskinefbfac682018-07-08 20:51:54 +02002438exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002439 if (status != PSA_SUCCESS) {
2440 psa_mac_abort(operation);
2441 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002442
Gilles Peskine449bd832023-01-11 14:50:10 +01002443 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02002444
Gilles Peskine449bd832023-01-11 14:50:10 +01002445 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002446}
2447
Gilles Peskine449bd832023-01-11 14:50:10 +01002448psa_status_t psa_mac_sign_setup(psa_mac_operation_t *operation,
2449 mbedtls_svc_key_id_t key,
2450 psa_algorithm_t alg)
Gilles Peskine89167cb2018-07-08 20:12:23 +02002451{
Gilles Peskine449bd832023-01-11 14:50:10 +01002452 return psa_mac_setup(operation, key, alg, 1);
Gilles Peskine89167cb2018-07-08 20:12:23 +02002453}
2454
Gilles Peskine449bd832023-01-11 14:50:10 +01002455psa_status_t psa_mac_verify_setup(psa_mac_operation_t *operation,
2456 mbedtls_svc_key_id_t key,
2457 psa_algorithm_t alg)
Gilles Peskine89167cb2018-07-08 20:12:23 +02002458{
Gilles Peskine449bd832023-01-11 14:50:10 +01002459 return psa_mac_setup(operation, key, alg, 0);
Gilles Peskine89167cb2018-07-08 20:12:23 +02002460}
2461
Gilles Peskine449bd832023-01-11 14:50:10 +01002462psa_status_t psa_mac_update(psa_mac_operation_t *operation,
2463 const uint8_t *input,
2464 size_t input_length)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002465{
Gilles Peskine449bd832023-01-11 14:50:10 +01002466 if (operation->id == 0) {
2467 return PSA_ERROR_BAD_STATE;
2468 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002469
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002470 /* Don't require hash implementations to behave correctly on a
2471 * zero-length input, which may have an invalid pointer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002472 if (input_length == 0) {
2473 return PSA_SUCCESS;
2474 }
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03002475
Gilles Peskine449bd832023-01-11 14:50:10 +01002476 psa_status_t status = psa_driver_wrapper_mac_update(operation,
2477 input, input_length);
2478 if (status != PSA_SUCCESS) {
2479 psa_mac_abort(operation);
2480 }
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002481
Gilles Peskine449bd832023-01-11 14:50:10 +01002482 return status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002483}
2484
Gilles Peskine449bd832023-01-11 14:50:10 +01002485psa_status_t psa_mac_sign_finish(psa_mac_operation_t *operation,
2486 uint8_t *mac,
2487 size_t mac_size,
2488 size_t *mac_length)
mohammad16036df908f2018-04-02 08:34:15 -07002489{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002490 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2491 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002492
Gilles Peskine449bd832023-01-11 14:50:10 +01002493 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002494 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002495 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002496 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002497
Gilles Peskine449bd832023-01-11 14:50:10 +01002498 if (!operation->is_sign) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002499 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002500 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002501 }
Steven Cooreman72f736a2021-05-07 14:14:37 +02002502
Steven Cooreman8af5c5c2021-05-11 11:09:13 +02002503 /* Sanity check. This will guarantee that mac_size != 0 (and so mac != NULL)
2504 * once all the error checks are done. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002505 if (operation->mac_size == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002506 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002507 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002508 }
Steven Cooreman8af5c5c2021-05-11 11:09:13 +02002509
Gilles Peskine449bd832023-01-11 14:50:10 +01002510 if (mac_size < operation->mac_size) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002511 status = PSA_ERROR_BUFFER_TOO_SMALL;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002512 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002513 }
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002514
Gilles Peskine449bd832023-01-11 14:50:10 +01002515 status = psa_driver_wrapper_mac_sign_finish(operation,
2516 mac, operation->mac_size,
2517 mac_length);
Steven Cooreman72f736a2021-05-07 14:14:37 +02002518
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002519exit:
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002520 /* In case of success, set the potential excess room in the output buffer
2521 * to an invalid value, to avoid potentially leaking a longer MAC.
2522 * In case of error, set the output length and content to a safe default,
2523 * such that in case the caller misses an error check, the output would be
2524 * an unachievable MAC.
2525 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002526 if (status != PSA_SUCCESS) {
Steven Cooreman72f736a2021-05-07 14:14:37 +02002527 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002528 operation->mac_size = 0;
Steven Cooreman72f736a2021-05-07 14:14:37 +02002529 }
mohammad16036df908f2018-04-02 08:34:15 -07002530
Paul Elliottdc42ca82023-02-24 18:11:59 +00002531 psa_wipe_tag_output_buffer(mac, status, mac_size, *mac_length);
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002532
Gilles Peskine449bd832023-01-11 14:50:10 +01002533 abort_status = psa_mac_abort(operation);
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002534
Gilles Peskine449bd832023-01-11 14:50:10 +01002535 return status == PSA_SUCCESS ? abort_status : status;
mohammad16036df908f2018-04-02 08:34:15 -07002536}
2537
Gilles Peskine449bd832023-01-11 14:50:10 +01002538psa_status_t psa_mac_verify_finish(psa_mac_operation_t *operation,
2539 const uint8_t *mac,
2540 size_t mac_length)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002541{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002542 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2543 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002544
Gilles Peskine449bd832023-01-11 14:50:10 +01002545 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002546 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002547 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002548 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002549
Gilles Peskine449bd832023-01-11 14:50:10 +01002550 if (operation->is_sign) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002551 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002552 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002553 }
Steven Cooreman72f736a2021-05-07 14:14:37 +02002554
Gilles Peskine449bd832023-01-11 14:50:10 +01002555 if (operation->mac_size != mac_length) {
Steven Cooreman72f736a2021-05-07 14:14:37 +02002556 status = PSA_ERROR_INVALID_SIGNATURE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002557 goto exit;
Steven Cooreman72f736a2021-05-07 14:14:37 +02002558 }
2559
Gilles Peskine449bd832023-01-11 14:50:10 +01002560 status = psa_driver_wrapper_mac_verify_finish(operation,
2561 mac, mac_length);
Steven Cooreman72f736a2021-05-07 14:14:37 +02002562
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002563exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002564 abort_status = psa_mac_abort(operation);
mohammad16036df908f2018-04-02 08:34:15 -07002565
Gilles Peskine449bd832023-01-11 14:50:10 +01002566 return status == PSA_SUCCESS ? abort_status : status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002567}
2568
Gilles Peskine449bd832023-01-11 14:50:10 +01002569static psa_status_t psa_mac_compute_internal(mbedtls_svc_key_id_t key,
2570 psa_algorithm_t alg,
2571 const uint8_t *input,
2572 size_t input_length,
2573 uint8_t *mac,
2574 size_t mac_size,
2575 size_t *mac_length,
2576 int is_sign)
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002577{
2578 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron51131b52021-06-17 17:17:20 +02002579 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2580 psa_key_slot_t *slot;
2581 uint8_t operation_mac_size = 0;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002582 psa_key_attributes_t attributes;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002583
Ronald Cron51131b52021-06-17 17:17:20 +02002584 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002585 key,
2586 &slot,
2587 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
2588 alg);
2589 if (status != PSA_SUCCESS) {
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002590 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002591 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002592
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002593 attributes = (psa_key_attributes_t) {
Ronald Cron51131b52021-06-17 17:17:20 +02002594 .core = slot->attr
2595 };
2596
Gilles Peskine449bd832023-01-11 14:50:10 +01002597 status = psa_mac_finalize_alg_and_key_validation(alg, &attributes,
2598 &operation_mac_size);
2599 if (status != PSA_SUCCESS) {
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002600 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002601 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002602
Gilles Peskine449bd832023-01-11 14:50:10 +01002603 if (mac_size < operation_mac_size) {
Ronald Cron51131b52021-06-17 17:17:20 +02002604 status = PSA_ERROR_BUFFER_TOO_SMALL;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002605 goto exit;
Ronald Cron51131b52021-06-17 17:17:20 +02002606 }
2607
2608 status = psa_driver_wrapper_mac_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01002609 &attributes,
2610 slot->key.data, slot->key.bytes,
2611 alg,
2612 input, input_length,
2613 mac, operation_mac_size, mac_length);
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002614
2615exit:
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002616 /* In case of success, set the potential excess room in the output buffer
2617 * to an invalid value, to avoid potentially leaking a longer MAC.
2618 * In case of error, set the output length and content to a safe default,
2619 * such that in case the caller misses an error check, the output would be
2620 * an unachievable MAC.
2621 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002622 if (status != PSA_SUCCESS) {
Ronald Cron51131b52021-06-17 17:17:20 +02002623 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002624 operation_mac_size = 0;
Ronald Cron51131b52021-06-17 17:17:20 +02002625 }
Paul Elliottdc42ca82023-02-24 18:11:59 +00002626
2627 psa_wipe_tag_output_buffer(mac, status, mac_size, *mac_length);
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002628
Gilles Peskine449bd832023-01-11 14:50:10 +01002629 unlock_status = psa_unlock_key_slot(slot);
Ronald Cron51131b52021-06-17 17:17:20 +02002630
Gilles Peskine449bd832023-01-11 14:50:10 +01002631 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002632}
2633
Gilles Peskine449bd832023-01-11 14:50:10 +01002634psa_status_t psa_mac_compute(mbedtls_svc_key_id_t key,
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002635 psa_algorithm_t alg,
2636 const uint8_t *input,
2637 size_t input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002638 uint8_t *mac,
2639 size_t mac_size,
2640 size_t *mac_length)
2641{
2642 return psa_mac_compute_internal(key, alg,
2643 input, input_length,
2644 mac, mac_size, mac_length, 1);
2645}
2646
2647psa_status_t psa_mac_verify(mbedtls_svc_key_id_t key,
2648 psa_algorithm_t alg,
2649 const uint8_t *input,
2650 size_t input_length,
2651 const uint8_t *mac,
2652 size_t mac_length)
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002653{
2654 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Crona587cbc2021-06-18 14:51:29 +02002655 uint8_t actual_mac[PSA_MAC_MAX_SIZE];
2656 size_t actual_mac_length;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002657
Gilles Peskine449bd832023-01-11 14:50:10 +01002658 status = psa_mac_compute_internal(key, alg,
2659 input, input_length,
2660 actual_mac, sizeof(actual_mac),
2661 &actual_mac_length, 0);
2662 if (status != PSA_SUCCESS) {
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002663 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002664 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002665
Gilles Peskine449bd832023-01-11 14:50:10 +01002666 if (mac_length != actual_mac_length) {
Ronald Crona587cbc2021-06-18 14:51:29 +02002667 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002668 goto exit;
Ronald Crona587cbc2021-06-18 14:51:29 +02002669 }
Dave Rodgman78701152023-08-29 14:20:18 +01002670 if (mbedtls_ct_memcmp(mac, actual_mac, actual_mac_length) != 0) {
Ronald Crona587cbc2021-06-18 14:51:29 +02002671 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002672 goto exit;
Ronald Crona587cbc2021-06-18 14:51:29 +02002673 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002674
2675exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002676 mbedtls_platform_zeroize(actual_mac, sizeof(actual_mac));
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002677
Gilles Peskine449bd832023-01-11 14:50:10 +01002678 return status;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002679}
Gilles Peskinee59236f2018-01-27 23:32:46 +01002680
Gilles Peskinee59236f2018-01-27 23:32:46 +01002681/****************************************************************/
2682/* Asymmetric cryptography */
2683/****************************************************************/
2684
Gilles Peskine449bd832023-01-11 14:50:10 +01002685static psa_status_t psa_sign_verify_check_alg(int input_is_message,
2686 psa_algorithm_t alg)
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002687{
Gilles Peskine449bd832023-01-11 14:50:10 +01002688 if (input_is_message) {
2689 if (!PSA_ALG_IS_SIGN_MESSAGE(alg)) {
2690 return PSA_ERROR_INVALID_ARGUMENT;
2691 }
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002692
Gilles Peskine449bd832023-01-11 14:50:10 +01002693 if (PSA_ALG_IS_SIGN_HASH(alg)) {
2694 if (!PSA_ALG_IS_HASH(PSA_ALG_SIGN_GET_HASH(alg))) {
2695 return PSA_ERROR_INVALID_ARGUMENT;
2696 }
2697 }
2698 } else {
2699 if (!PSA_ALG_IS_SIGN_HASH(alg)) {
2700 return PSA_ERROR_INVALID_ARGUMENT;
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002701 }
2702 }
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002703
Gilles Peskine449bd832023-01-11 14:50:10 +01002704 return PSA_SUCCESS;
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002705}
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002706
Gilles Peskine449bd832023-01-11 14:50:10 +01002707static psa_status_t psa_sign_internal(mbedtls_svc_key_id_t key,
2708 int input_is_message,
2709 psa_algorithm_t alg,
2710 const uint8_t *input,
2711 size_t input_length,
2712 uint8_t *signature,
2713 size_t signature_size,
2714 size_t *signature_length)
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002715{
2716 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2717 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2718 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002719 psa_key_attributes_t attributes;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002720
2721 *signature_length = 0;
2722
Gilles Peskine449bd832023-01-11 14:50:10 +01002723 status = psa_sign_verify_check_alg(input_is_message, alg);
2724 if (status != PSA_SUCCESS) {
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002725 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002726 }
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002727
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002728 /* Immediately reject a zero-length signature buffer. This guarantees
gabor-mezei-arm12b4f342021-05-05 13:54:55 +02002729 * that signature must be a valid pointer. (On the other hand, the input
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002730 * buffer can in principle be empty since it doesn't actually have
2731 * to be a hash.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01002732 if (signature_size == 0) {
2733 return PSA_ERROR_BUFFER_TOO_SMALL;
2734 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002735
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002736 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002737 key, &slot,
2738 input_is_message ? PSA_KEY_USAGE_SIGN_MESSAGE :
2739 PSA_KEY_USAGE_SIGN_HASH,
2740 alg);
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002741
Gilles Peskine449bd832023-01-11 14:50:10 +01002742 if (status != PSA_SUCCESS) {
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002743 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002744 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002745
Gilles Peskine449bd832023-01-11 14:50:10 +01002746 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002747 status = PSA_ERROR_INVALID_ARGUMENT;
2748 goto exit;
2749 }
2750
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002751 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01002752 .core = slot->attr
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002753 };
2754
Gilles Peskine449bd832023-01-11 14:50:10 +01002755 if (input_is_message) {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002756 status = psa_driver_wrapper_sign_message(
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002757 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002758 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002759 signature, signature_size, signature_length);
2760 } else {
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002761
2762 status = psa_driver_wrapper_sign_hash(
2763 &attributes, slot->key.data, slot->key.bytes,
2764 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002765 signature, signature_size, signature_length);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002766 }
2767
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002768
2769exit:
Paul Elliott59200a22023-02-21 15:07:40 +00002770 psa_wipe_tag_output_buffer(signature, status, signature_size,
2771 *signature_length);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002772
Gilles Peskine449bd832023-01-11 14:50:10 +01002773 unlock_status = psa_unlock_key_slot(slot);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002774
Gilles Peskine449bd832023-01-11 14:50:10 +01002775 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002776}
2777
Gilles Peskine449bd832023-01-11 14:50:10 +01002778static psa_status_t psa_verify_internal(mbedtls_svc_key_id_t key,
2779 int input_is_message,
2780 psa_algorithm_t alg,
2781 const uint8_t *input,
2782 size_t input_length,
2783 const uint8_t *signature,
2784 size_t signature_length)
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002785{
2786 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2787 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2788 psa_key_slot_t *slot;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002789
Gilles Peskine449bd832023-01-11 14:50:10 +01002790 status = psa_sign_verify_check_alg(input_is_message, alg);
2791 if (status != PSA_SUCCESS) {
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002792 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002793 }
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002794
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002795 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002796 key, &slot,
2797 input_is_message ? PSA_KEY_USAGE_VERIFY_MESSAGE :
2798 PSA_KEY_USAGE_VERIFY_HASH,
2799 alg);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002800
Gilles Peskine449bd832023-01-11 14:50:10 +01002801 if (status != PSA_SUCCESS) {
2802 return status;
2803 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002804
2805 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01002806 .core = slot->attr
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002807 };
2808
Gilles Peskine449bd832023-01-11 14:50:10 +01002809 if (input_is_message) {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002810 status = psa_driver_wrapper_verify_message(
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002811 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002812 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002813 signature, signature_length);
2814 } else {
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002815 status = psa_driver_wrapper_verify_hash(
2816 &attributes, slot->key.data, slot->key.bytes,
2817 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002818 signature, signature_length);
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002819 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002820
Gilles Peskine449bd832023-01-11 14:50:10 +01002821 unlock_status = psa_unlock_key_slot(slot);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002822
Gilles Peskine449bd832023-01-11 14:50:10 +01002823 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002824
2825}
2826
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002827psa_status_t psa_sign_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002828 const psa_key_attributes_t *attributes,
2829 const uint8_t *key_buffer,
2830 size_t key_buffer_size,
2831 psa_algorithm_t alg,
2832 const uint8_t *input,
2833 size_t input_length,
2834 uint8_t *signature,
2835 size_t signature_size,
Gilles Peskine449bd832023-01-11 14:50:10 +01002836 size_t *signature_length)
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002837{
2838 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002839
Gilles Peskine449bd832023-01-11 14:50:10 +01002840 if (PSA_ALG_IS_SIGN_HASH(alg)) {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002841 size_t hash_length;
2842 uint8_t hash[PSA_HASH_MAX_SIZE];
2843
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002844 status = psa_driver_wrapper_hash_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01002845 PSA_ALG_SIGN_GET_HASH(alg),
2846 input, input_length,
2847 hash, sizeof(hash), &hash_length);
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002848
Gilles Peskine449bd832023-01-11 14:50:10 +01002849 if (status != PSA_SUCCESS) {
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002850 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002851 }
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002852
2853 return psa_driver_wrapper_sign_hash(
Gilles Peskine449bd832023-01-11 14:50:10 +01002854 attributes, key_buffer, key_buffer_size,
2855 alg, hash, hash_length,
2856 signature, signature_size, signature_length);
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002857 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002858
Gilles Peskine449bd832023-01-11 14:50:10 +01002859 return PSA_ERROR_NOT_SUPPORTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002860}
2861
Gilles Peskine449bd832023-01-11 14:50:10 +01002862psa_status_t psa_sign_message(mbedtls_svc_key_id_t key,
2863 psa_algorithm_t alg,
2864 const uint8_t *input,
2865 size_t input_length,
2866 uint8_t *signature,
2867 size_t signature_size,
2868 size_t *signature_length)
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002869{
2870 return psa_sign_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002871 key, 1, alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002872 signature, signature_size, signature_length);
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002873}
2874
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002875psa_status_t psa_verify_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002876 const psa_key_attributes_t *attributes,
2877 const uint8_t *key_buffer,
2878 size_t key_buffer_size,
2879 psa_algorithm_t alg,
2880 const uint8_t *input,
2881 size_t input_length,
2882 const uint8_t *signature,
Gilles Peskine449bd832023-01-11 14:50:10 +01002883 size_t signature_length)
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002884{
2885 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002886
Gilles Peskine449bd832023-01-11 14:50:10 +01002887 if (PSA_ALG_IS_SIGN_HASH(alg)) {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002888 size_t hash_length;
2889 uint8_t hash[PSA_HASH_MAX_SIZE];
2890
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002891 status = psa_driver_wrapper_hash_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01002892 PSA_ALG_SIGN_GET_HASH(alg),
2893 input, input_length,
2894 hash, sizeof(hash), &hash_length);
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002895
Gilles Peskine449bd832023-01-11 14:50:10 +01002896 if (status != PSA_SUCCESS) {
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002897 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002898 }
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002899
2900 return psa_driver_wrapper_verify_hash(
Gilles Peskine449bd832023-01-11 14:50:10 +01002901 attributes, key_buffer, key_buffer_size,
2902 alg, hash, hash_length,
2903 signature, signature_length);
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002904 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002905
Gilles Peskine449bd832023-01-11 14:50:10 +01002906 return PSA_ERROR_NOT_SUPPORTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002907}
2908
Gilles Peskine449bd832023-01-11 14:50:10 +01002909psa_status_t psa_verify_message(mbedtls_svc_key_id_t key,
2910 psa_algorithm_t alg,
2911 const uint8_t *input,
2912 size_t input_length,
2913 const uint8_t *signature,
2914 size_t signature_length)
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002915{
2916 return psa_verify_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002917 key, 1, alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002918 signature, signature_length);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002919}
2920
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002921psa_status_t psa_sign_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01002922 const psa_key_attributes_t *attributes,
2923 const uint8_t *key_buffer, size_t key_buffer_size,
2924 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002925 uint8_t *signature, size_t signature_size, size_t *signature_length)
Gilles Peskinee59236f2018-01-27 23:32:46 +01002926{
Gilles Peskine449bd832023-01-11 14:50:10 +01002927 if (attributes->core.type == PSA_KEY_TYPE_RSA_KEY_PAIR) {
2928 if (PSA_ALG_IS_RSA_PKCS1V15_SIGN(alg) ||
2929 PSA_ALG_IS_RSA_PSS(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01002930#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01002931 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
2932 return mbedtls_psa_rsa_sign_hash(
2933 attributes,
2934 key_buffer, key_buffer_size,
2935 alg, hash, hash_length,
2936 signature, signature_size, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01002937#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
2938 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine449bd832023-01-11 14:50:10 +01002939 } else {
2940 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanacda8342020-07-24 23:09:52 +02002941 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002942 } else if (PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
2943 if (PSA_ALG_IS_ECDSA(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01002944#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01002945 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
2946 return mbedtls_psa_ecdsa_sign_hash(
2947 attributes,
2948 key_buffer, key_buffer_size,
2949 alg, hash, hash_length,
2950 signature, signature_size, signature_length);
Gilles Peskinee59236f2018-01-27 23:32:46 +01002951#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
2952 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskine449bd832023-01-11 14:50:10 +01002953 } else {
2954 return PSA_ERROR_INVALID_ARGUMENT;
Ronald Cron4501c982021-03-19 20:09:32 +01002955 }
Ronald Cron8a494f32021-02-17 09:49:51 +01002956 }
Ronald Cron4501c982021-03-19 20:09:32 +01002957
Gilles Peskine449bd832023-01-11 14:50:10 +01002958 (void) key_buffer;
2959 (void) key_buffer_size;
2960 (void) hash;
2961 (void) hash_length;
2962 (void) signature;
2963 (void) signature_size;
2964 (void) signature_length;
Ronald Cron4501c982021-03-19 20:09:32 +01002965
Gilles Peskine449bd832023-01-11 14:50:10 +01002966 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron18659932020-12-08 16:32:23 +01002967}
Gilles Peskinee59236f2018-01-27 23:32:46 +01002968
Gilles Peskine449bd832023-01-11 14:50:10 +01002969psa_status_t psa_sign_hash(mbedtls_svc_key_id_t key,
2970 psa_algorithm_t alg,
2971 const uint8_t *hash,
2972 size_t hash_length,
2973 uint8_t *signature,
2974 size_t signature_size,
2975 size_t *signature_length)
Gilles Peskinee59236f2018-01-27 23:32:46 +01002976{
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002977 return psa_sign_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002978 key, 0, alg, hash, hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002979 signature, signature_size, signature_length);
itayzafrir5c753392018-05-08 11:18:38 +03002980}
2981
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002982psa_status_t psa_verify_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01002983 const psa_key_attributes_t *attributes,
2984 const uint8_t *key_buffer, size_t key_buffer_size,
2985 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002986 const uint8_t *signature, size_t signature_length)
itayzafrir5c753392018-05-08 11:18:38 +03002987{
Gilles Peskine449bd832023-01-11 14:50:10 +01002988 if (PSA_KEY_TYPE_IS_RSA(attributes->core.type)) {
2989 if (PSA_ALG_IS_RSA_PKCS1V15_SIGN(alg) ||
2990 PSA_ALG_IS_RSA_PSS(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01002991#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01002992 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
2993 return mbedtls_psa_rsa_verify_hash(
2994 attributes,
2995 key_buffer, key_buffer_size,
2996 alg, hash, hash_length,
2997 signature, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01002998#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
2999 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003000 } else {
3001 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanacda8342020-07-24 23:09:52 +02003002 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003003 } else if (PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3004 if (PSA_ALG_IS_ECDSA(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003005#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003006 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3007 return mbedtls_psa_ecdsa_verify_hash(
3008 attributes,
3009 key_buffer, key_buffer_size,
3010 alg, hash, hash_length,
3011 signature, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01003012#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3013 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003014 } else {
3015 return PSA_ERROR_INVALID_ARGUMENT;
Ronald Cron4501c982021-03-19 20:09:32 +01003016 }
Ronald Cron8a494f32021-02-17 09:49:51 +01003017 }
Ronald Cron4501c982021-03-19 20:09:32 +01003018
Gilles Peskine449bd832023-01-11 14:50:10 +01003019 (void) key_buffer;
3020 (void) key_buffer_size;
3021 (void) hash;
3022 (void) hash_length;
3023 (void) signature;
3024 (void) signature_length;
Ronald Cron4501c982021-03-19 20:09:32 +01003025
Gilles Peskine449bd832023-01-11 14:50:10 +01003026 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron18659932020-12-08 16:32:23 +01003027}
3028
Gilles Peskine449bd832023-01-11 14:50:10 +01003029psa_status_t psa_verify_hash(mbedtls_svc_key_id_t key,
3030 psa_algorithm_t alg,
3031 const uint8_t *hash,
3032 size_t hash_length,
3033 const uint8_t *signature,
3034 size_t signature_length)
itayzafrir5c753392018-05-08 11:18:38 +03003035{
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003036 return psa_verify_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02003037 key, 0, alg, hash, hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003038 signature, signature_length);
Gilles Peskinee59236f2018-01-27 23:32:46 +01003039}
3040
Gilles Peskine449bd832023-01-11 14:50:10 +01003041psa_status_t psa_asymmetric_encrypt(mbedtls_svc_key_id_t key,
3042 psa_algorithm_t alg,
3043 const uint8_t *input,
3044 size_t input_length,
3045 const uint8_t *salt,
3046 size_t salt_length,
3047 uint8_t *output,
3048 size_t output_size,
3049 size_t *output_length)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003050{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003051 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003052 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003053 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003054 psa_key_attributes_t attributes;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003055
Darryl Green5cc689a2018-07-24 15:34:10 +01003056 (void) input;
3057 (void) input_length;
3058 (void) salt;
3059 (void) output;
3060 (void) output_size;
3061
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003062 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003063
Gilles Peskine449bd832023-01-11 14:50:10 +01003064 if (!PSA_ALG_IS_RSA_OAEP(alg) && salt_length != 0) {
3065 return PSA_ERROR_INVALID_ARGUMENT;
3066 }
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003067
Ronald Cron5c522922020-11-14 16:35:34 +01003068 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01003069 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg);
3070 if (status != PSA_SUCCESS) {
3071 return status;
3072 }
3073 if (!(PSA_KEY_TYPE_IS_PUBLIC_KEY(slot->attr.type) ||
3074 PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type))) {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003075 status = PSA_ERROR_INVALID_ARGUMENT;
3076 goto exit;
3077 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003078
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003079 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01003080 .core = slot->attr
Przemyslaw Stekiel19e61422021-12-09 11:09:11 +01003081 };
Steven Cooremana2371e52020-07-28 14:30:39 +02003082
Przemyslaw Stekiel19e61422021-12-09 11:09:11 +01003083 status = psa_driver_wrapper_asymmetric_encrypt(
3084 &attributes, slot->key.data, slot->key.bytes,
3085 alg, input, input_length, salt, salt_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003086 output, output_size, output_length);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003087exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01003088 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003089
Gilles Peskine449bd832023-01-11 14:50:10 +01003090 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003091}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003092
Gilles Peskine449bd832023-01-11 14:50:10 +01003093psa_status_t psa_asymmetric_decrypt(mbedtls_svc_key_id_t key,
3094 psa_algorithm_t alg,
3095 const uint8_t *input,
3096 size_t input_length,
3097 const uint8_t *salt,
3098 size_t salt_length,
3099 uint8_t *output,
3100 size_t output_size,
3101 size_t *output_length)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003102{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003103 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003104 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003105 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003106 psa_key_attributes_t attributes;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003107
Darryl Green5cc689a2018-07-24 15:34:10 +01003108 (void) input;
3109 (void) input_length;
3110 (void) salt;
3111 (void) output;
3112 (void) output_size;
3113
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003114 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003115
Gilles Peskine449bd832023-01-11 14:50:10 +01003116 if (!PSA_ALG_IS_RSA_OAEP(alg) && salt_length != 0) {
3117 return PSA_ERROR_INVALID_ARGUMENT;
3118 }
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003119
Ronald Cron5c522922020-11-14 16:35:34 +01003120 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01003121 key, &slot, PSA_KEY_USAGE_DECRYPT, alg);
3122 if (status != PSA_SUCCESS) {
3123 return status;
3124 }
3125 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003126 status = PSA_ERROR_INVALID_ARGUMENT;
3127 goto exit;
3128 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003129
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003130 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01003131 .core = slot->attr
Przemyslaw Stekiel8d45c002021-12-13 08:58:19 +01003132 };
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003133
Przemyslaw Stekiel8d45c002021-12-13 08:58:19 +01003134 status = psa_driver_wrapper_asymmetric_decrypt(
3135 &attributes, slot->key.data, slot->key.bytes,
3136 alg, input, input_length, salt, salt_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003137 output, output_size, output_length);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003138
3139exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01003140 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003141
Gilles Peskine449bd832023-01-11 14:50:10 +01003142 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003143}
Gilles Peskinee59236f2018-01-27 23:32:46 +01003144
Paul Elliott9fe12f62022-11-30 19:16:02 +00003145/****************************************************************/
3146/* Asymmetric interruptible cryptography */
3147/****************************************************************/
3148
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003149static uint32_t psa_interruptible_max_ops = PSA_INTERRUPTIBLE_MAX_OPS_UNLIMITED;
3150
Paul Elliott9fe12f62022-11-30 19:16:02 +00003151void psa_interruptible_set_max_ops(uint32_t max_ops)
3152{
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003153 psa_interruptible_max_ops = max_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003154}
3155
3156uint32_t psa_interruptible_get_max_ops(void)
3157{
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003158 return psa_interruptible_max_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003159}
3160
Paul Elliott9fe12f62022-11-30 19:16:02 +00003161uint32_t psa_sign_hash_get_num_ops(
3162 const psa_sign_hash_interruptible_operation_t *operation)
3163{
Paul Elliott296ede92022-12-15 17:00:30 +00003164 return operation->num_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003165}
3166
3167uint32_t psa_verify_hash_get_num_ops(
3168 const psa_verify_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
Paul Elliott59ad9452022-12-18 15:09:02 +00003173static psa_status_t psa_sign_hash_abort_internal(
3174 psa_sign_hash_interruptible_operation_t *operation)
3175{
3176 if (operation->id == 0) {
3177 /* The object has (apparently) been initialized but it is not (yet)
3178 * in use. It's ok to call abort on such an object, and there's
3179 * nothing to do. */
3180 return PSA_SUCCESS;
3181 }
3182
3183 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3184
3185 status = psa_driver_wrapper_sign_hash_abort(operation);
3186
3187 operation->id = 0;
3188
Paul Elliotte6145dc2023-02-07 12:51:21 +00003189 /* Do not clear either the error_occurred or num_ops elements here as they
3190 * only want to be cleared by the application calling abort, not by abort
3191 * being called at completion of an operation. */
3192
Paul Elliott59ad9452022-12-18 15:09:02 +00003193 return status;
3194}
3195
Paul Elliott9fe12f62022-11-30 19:16:02 +00003196psa_status_t psa_sign_hash_start(
3197 psa_sign_hash_interruptible_operation_t *operation,
3198 mbedtls_svc_key_id_t key, psa_algorithm_t alg,
3199 const uint8_t *hash, size_t hash_length)
3200{
3201 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3202 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3203 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003204 psa_key_attributes_t attributes;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003205
Paul Elliottc9774412023-02-06 15:14:07 +00003206 /* Check that start has not been previously called, or operation has not
3207 * previously errored. */
3208 if (operation->id != 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003209 return PSA_ERROR_BAD_STATE;
3210 }
3211
Paul Elliott9fe12f62022-11-30 19:16:02 +00003212 status = psa_sign_verify_check_alg(0, alg);
3213 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003214 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003215 return status;
3216 }
3217
3218 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
3219 PSA_KEY_USAGE_SIGN_HASH,
3220 alg);
3221
3222 if (status != PSA_SUCCESS) {
3223 goto exit;
3224 }
3225
3226 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
3227 status = PSA_ERROR_INVALID_ARGUMENT;
3228 goto exit;
3229 }
3230
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003231 attributes = (psa_key_attributes_t) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003232 .core = slot->attr
3233 };
3234
Paul Elliott296ede92022-12-15 17:00:30 +00003235 /* Ensure ops count gets reset, in case of operation re-use. */
3236 operation->num_ops = 0;
3237
Paul Elliott9fe12f62022-11-30 19:16:02 +00003238 status = psa_driver_wrapper_sign_hash_start(operation, &attributes,
3239 slot->key.data,
3240 slot->key.bytes, alg,
3241 hash, hash_length);
3242exit:
3243
3244 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003245 operation->error_occurred = 1;
Paul Elliott59ad9452022-12-18 15:09:02 +00003246 psa_sign_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003247 }
3248
3249 unlock_status = psa_unlock_key_slot(slot);
3250
Paul Elliottc9774412023-02-06 15:14:07 +00003251 if (unlock_status != PSA_SUCCESS) {
3252 operation->error_occurred = 1;
3253 }
Paul Elliott9fe12f62022-11-30 19:16:02 +00003254
Paul Elliottc9774412023-02-06 15:14:07 +00003255 return (status == PSA_SUCCESS) ? unlock_status : status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003256}
3257
3258
3259psa_status_t psa_sign_hash_complete(
3260 psa_sign_hash_interruptible_operation_t *operation,
3261 uint8_t *signature, size_t signature_size,
3262 size_t *signature_length)
3263{
3264 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3265
3266 *signature_length = 0;
3267
Paul Elliottc9774412023-02-06 15:14:07 +00003268 /* Check that start has been called first, and that operation has not
3269 * previously errored. */
3270 if (operation->id == 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003271 status = PSA_ERROR_BAD_STATE;
3272 goto exit;
3273 }
3274
Paul Elliott096abc42023-02-03 18:33:23 +00003275 /* Immediately reject a zero-length signature buffer. This guarantees that
3276 * signature must be a valid pointer. */
Paul Elliott9fe12f62022-11-30 19:16:02 +00003277 if (signature_size == 0) {
3278 status = PSA_ERROR_BUFFER_TOO_SMALL;
3279 goto exit;
3280 }
3281
3282 status = psa_driver_wrapper_sign_hash_complete(operation, signature,
3283 signature_size,
3284 signature_length);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003285
Paul Elliott296ede92022-12-15 17:00:30 +00003286 /* Update ops count with work done. */
Paul Elliottde1114c2023-02-07 12:43:11 +00003287 operation->num_ops = psa_driver_wrapper_sign_hash_get_num_ops(operation);
Paul Elliott296ede92022-12-15 17:00:30 +00003288
Paul Elliottebe225c2023-02-10 14:32:53 +00003289exit:
3290
Paul Elliott59200a22023-02-21 15:07:40 +00003291 psa_wipe_tag_output_buffer(signature, status, signature_size,
3292 *signature_length);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003293
Paul Elliott53bb3122023-02-10 14:22:22 +00003294 if (status != PSA_OPERATION_INCOMPLETE) {
Paul Elliottc9774412023-02-06 15:14:07 +00003295 if (status != PSA_SUCCESS) {
3296 operation->error_occurred = 1;
3297 }
3298
Paul Elliott59ad9452022-12-18 15:09:02 +00003299 psa_sign_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003300 }
3301
3302 return status;
3303}
3304
3305psa_status_t psa_sign_hash_abort(
3306 psa_sign_hash_interruptible_operation_t *operation)
3307{
Paul Elliott59ad9452022-12-18 15:09:02 +00003308 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3309
3310 status = psa_sign_hash_abort_internal(operation);
3311
3312 /* We clear the number of ops done here, so that it is not cleared when
3313 * the operation fails or succeeds, only on manual abort. */
3314 operation->num_ops = 0;
3315
Paul Elliottc9774412023-02-06 15:14:07 +00003316 /* Likewise, failure state. */
3317 operation->error_occurred = 0;
3318
Paul Elliott59ad9452022-12-18 15:09:02 +00003319 return status;
3320}
3321
3322static psa_status_t psa_verify_hash_abort_internal(
3323 psa_verify_hash_interruptible_operation_t *operation)
3324{
Paul Elliott9fe12f62022-11-30 19:16:02 +00003325 if (operation->id == 0) {
3326 /* The object has (apparently) been initialized but it is not (yet)
3327 * in use. It's ok to call abort on such an object, and there's
3328 * nothing to do. */
3329 return PSA_SUCCESS;
3330 }
3331
Paul Elliott59ad9452022-12-18 15:09:02 +00003332 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3333
3334 status = psa_driver_wrapper_verify_hash_abort(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003335
3336 operation->id = 0;
3337
Paul Elliotte6145dc2023-02-07 12:51:21 +00003338 /* Do not clear either the error_occurred or num_ops elements here as they
3339 * only want to be cleared by the application calling abort, not by abort
3340 * being called at completion of an operation. */
3341
Paul Elliott59ad9452022-12-18 15:09:02 +00003342 return status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003343}
3344
3345psa_status_t psa_verify_hash_start(
3346 psa_verify_hash_interruptible_operation_t *operation,
3347 mbedtls_svc_key_id_t key, psa_algorithm_t alg,
3348 const uint8_t *hash, size_t hash_length,
3349 const uint8_t *signature, size_t signature_length)
3350{
3351 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3352 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3353 psa_key_slot_t *slot;
3354
Paul Elliottc9774412023-02-06 15:14:07 +00003355 /* Check that start has not been previously called, or operation has not
3356 * previously errored. */
3357 if (operation->id != 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003358 return PSA_ERROR_BAD_STATE;
3359 }
3360
3361 status = psa_sign_verify_check_alg(0, alg);
3362 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003363 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003364 return status;
3365 }
3366
3367 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
3368 PSA_KEY_USAGE_VERIFY_HASH,
3369 alg);
3370
3371 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003372 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003373 return status;
3374 }
3375
3376 psa_key_attributes_t attributes = {
3377 .core = slot->attr
3378 };
3379
Paul Elliott296ede92022-12-15 17:00:30 +00003380 /* Ensure ops count gets reset, in case of operation re-use. */
3381 operation->num_ops = 0;
3382
Paul Elliott9fe12f62022-11-30 19:16:02 +00003383 status = psa_driver_wrapper_verify_hash_start(operation, &attributes,
3384 slot->key.data,
3385 slot->key.bytes,
3386 alg, hash, hash_length,
3387 signature, signature_length);
3388
3389 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003390 operation->error_occurred = 1;
Paul Elliott59ad9452022-12-18 15:09:02 +00003391 psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003392 }
3393
3394 unlock_status = psa_unlock_key_slot(slot);
3395
Paul Elliottc9774412023-02-06 15:14:07 +00003396 if (unlock_status != PSA_SUCCESS) {
3397 operation->error_occurred = 1;
3398 }
Paul Elliott9fe12f62022-11-30 19:16:02 +00003399
Paul Elliottc9774412023-02-06 15:14:07 +00003400 return (status == PSA_SUCCESS) ? unlock_status : status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003401}
3402
3403psa_status_t psa_verify_hash_complete(
3404 psa_verify_hash_interruptible_operation_t *operation)
3405{
3406 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3407
Paul Elliottc9774412023-02-06 15:14:07 +00003408 /* Check that start has been called first, and that operation has not
3409 * previously errored. */
3410 if (operation->id == 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003411 status = PSA_ERROR_BAD_STATE;
3412 goto exit;
3413 }
3414
3415 status = psa_driver_wrapper_verify_hash_complete(operation);
3416
Paul Elliott296ede92022-12-15 17:00:30 +00003417 /* Update ops count with work done. */
Paul Elliottde1114c2023-02-07 12:43:11 +00003418 operation->num_ops = psa_driver_wrapper_verify_hash_get_num_ops(
Paul Elliott296ede92022-12-15 17:00:30 +00003419 operation);
3420
Paul Elliottebe225c2023-02-10 14:32:53 +00003421exit:
3422
Paul Elliott9fe12f62022-11-30 19:16:02 +00003423 if (status != PSA_OPERATION_INCOMPLETE) {
Paul Elliottc9774412023-02-06 15:14:07 +00003424 if (status != PSA_SUCCESS) {
3425 operation->error_occurred = 1;
3426 }
3427
Paul Elliott59ad9452022-12-18 15:09:02 +00003428 psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003429 }
3430
3431 return status;
3432}
3433
3434psa_status_t psa_verify_hash_abort(
3435 psa_verify_hash_interruptible_operation_t *operation)
3436{
Paul Elliott59ad9452022-12-18 15:09:02 +00003437 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003438
Paul Elliott59ad9452022-12-18 15:09:02 +00003439 status = psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003440
Paul Elliott59ad9452022-12-18 15:09:02 +00003441 /* We clear the number of ops done here, so that it is not cleared when
3442 * the operation fails or succeeds, only on manual abort. */
3443 operation->num_ops = 0;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003444
Paul Elliottc9774412023-02-06 15:14:07 +00003445 /* Likewise, failure state. */
3446 operation->error_occurred = 0;
3447
Paul Elliott59ad9452022-12-18 15:09:02 +00003448 return status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003449}
3450
Paul Elliott588f8ed2022-12-02 18:10:26 +00003451/****************************************************************/
3452/* Asymmetric interruptible cryptography internal */
3453/* implementations */
3454/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003455
Paul Elliott588f8ed2022-12-02 18:10:26 +00003456void mbedtls_psa_interruptible_set_max_ops(uint32_t max_ops)
3457{
Paul Elliott7cc4e812023-01-10 17:14:11 +00003458
Paul Elliott588f8ed2022-12-02 18:10:26 +00003459#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3460 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3461 defined(MBEDTLS_ECP_RESTARTABLE)
3462
3463 /* Internal implementation uses zero to indicate infinite number max ops,
3464 * therefore avoid this value, and set to minimum possible. */
3465 if (max_ops == 0) {
3466 max_ops = 1;
3467 }
3468
Paul Elliott588f8ed2022-12-02 18:10:26 +00003469 mbedtls_ecp_set_max_ops(max_ops);
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003470#else
3471 (void) max_ops;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003472#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3473 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3474 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3475}
3476
Paul Elliott588f8ed2022-12-02 18:10:26 +00003477uint32_t mbedtls_psa_sign_hash_get_num_ops(
Paul Elliottf8e5b562023-02-19 18:43:45 +00003478 const mbedtls_psa_sign_hash_interruptible_operation_t *operation)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003479{
3480#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3481 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3482 defined(MBEDTLS_ECP_RESTARTABLE)
3483
Paul Elliott93d9ca82023-02-15 18:14:21 +00003484 return operation->num_ops;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003485#else
3486 (void) operation;
3487 return 0;
3488#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3489 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3490 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3491}
3492
3493uint32_t mbedtls_psa_verify_hash_get_num_ops(
Paul Elliottf8e5b562023-02-19 18:43:45 +00003494 const mbedtls_psa_verify_hash_interruptible_operation_t *operation)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003495{
3496 #if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3497 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3498 defined(MBEDTLS_ECP_RESTARTABLE)
3499
Paul Elliott93d9ca82023-02-15 18:14:21 +00003500 return operation->num_ops;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003501#else
3502 (void) operation;
3503 return 0;
3504#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3505 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3506 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3507}
3508
3509psa_status_t mbedtls_psa_sign_hash_start(
3510 mbedtls_psa_sign_hash_interruptible_operation_t *operation,
3511 const psa_key_attributes_t *attributes, const uint8_t *key_buffer,
3512 size_t key_buffer_size, psa_algorithm_t alg,
3513 const uint8_t *hash, size_t hash_length)
3514{
3515 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott0290a762023-02-09 14:30:24 +00003516 size_t required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003517
Paul Elliott068fe072023-01-16 13:59:15 +00003518 if (!PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3519 return PSA_ERROR_NOT_SUPPORTED;
3520 }
3521
3522 if (!PSA_ALG_IS_ECDSA(alg)) {
Paul Elliott813f9cd2023-02-05 15:28:46 +00003523 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott068fe072023-01-16 13:59:15 +00003524 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003525
3526#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Paul Elliott068fe072023-01-16 13:59:15 +00003527 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3528 defined(MBEDTLS_ECP_RESTARTABLE)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003529
Paul Elliotta1c94092023-02-15 16:38:04 +00003530 mbedtls_ecdsa_restart_init(&operation->restart_ctx);
3531
Paul Elliott93d9ca82023-02-15 18:14:21 +00003532 /* Ensure num_ops is zero'ed in case of context re-use. */
3533 operation->num_ops = 0;
3534
Paul Elliott068fe072023-01-16 13:59:15 +00003535 status = mbedtls_psa_ecp_load_representation(attributes->core.type,
3536 attributes->core.bits,
3537 key_buffer,
3538 key_buffer_size,
3539 &operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003540
Paul Elliott068fe072023-01-16 13:59:15 +00003541 if (status != PSA_SUCCESS) {
3542 return status;
3543 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003544
Paul Elliott1bc59df2023-02-05 13:41:57 +00003545 operation->coordinate_bytes = PSA_BITS_TO_BYTES(
Paul Elliottc569fc22023-02-10 13:02:54 +00003546 operation->ctx->grp.nbits);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003547
Paul Elliott068fe072023-01-16 13:59:15 +00003548 psa_algorithm_t hash_alg = PSA_ALG_SIGN_GET_HASH(alg);
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02003549 operation->md_alg = mbedtls_md_type_from_psa_alg(hash_alg);
Paul Elliott068fe072023-01-16 13:59:15 +00003550 operation->alg = alg;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003551
Paul Elliott0290a762023-02-09 14:30:24 +00003552 /* We only need to store the same length of hash as the private key size
3553 * here, it would be truncated by the internal implementation anyway. */
3554 required_hash_length = (hash_length < operation->coordinate_bytes ?
3555 hash_length : operation->coordinate_bytes);
3556
Paul Elliottba70ad42023-02-15 18:23:53 +00003557 if (required_hash_length > sizeof(operation->hash)) {
3558 /* Shouldn't happen, but better safe than sorry. */
3559 return PSA_ERROR_CORRUPTION_DETECTED;
3560 }
3561
Paul Elliott0290a762023-02-09 14:30:24 +00003562 memcpy(operation->hash, hash, required_hash_length);
3563 operation->hash_length = required_hash_length;
Paul Elliott068fe072023-01-16 13:59:15 +00003564
3565 return PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003566
3567#else
Paul Elliott068fe072023-01-16 13:59:15 +00003568 (void) operation;
3569 (void) key_buffer;
3570 (void) key_buffer_size;
3571 (void) alg;
3572 (void) hash;
3573 (void) hash_length;
3574 (void) status;
Paul Elliott0290a762023-02-09 14:30:24 +00003575 (void) required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003576
Paul Elliott068fe072023-01-16 13:59:15 +00003577 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003578#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3579 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3580 * defined( MBEDTLS_ECP_RESTARTABLE ) */
Paul Elliott588f8ed2022-12-02 18:10:26 +00003581}
3582
3583psa_status_t mbedtls_psa_sign_hash_complete(
3584 mbedtls_psa_sign_hash_interruptible_operation_t *operation,
3585 uint8_t *signature, size_t signature_size,
3586 size_t *signature_length)
3587{
Paul Elliott588f8ed2022-12-02 18:10:26 +00003588#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3589 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3590 defined(MBEDTLS_ECP_RESTARTABLE)
3591
Paul Elliotta1c94092023-02-15 16:38:04 +00003592 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott1243f932023-02-07 11:21:10 +00003593 mbedtls_mpi r;
3594 mbedtls_mpi s;
3595
Paul Elliott46845252023-02-03 14:59:11 +00003596 mbedtls_mpi_init(&r);
3597 mbedtls_mpi_init(&s);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003598
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003599 /* Ensure max_ops is set to the current value (or default). */
3600 mbedtls_psa_interruptible_set_max_ops(psa_interruptible_get_max_ops());
3601
Paul Elliotta1c94092023-02-15 16:38:04 +00003602 if (signature_size < 2 * operation->coordinate_bytes) {
3603 status = PSA_ERROR_BUFFER_TOO_SMALL;
3604 goto exit;
3605 }
3606
Paul Elliott588f8ed2022-12-02 18:10:26 +00003607 if (PSA_ALG_ECDSA_IS_DETERMINISTIC(operation->alg)) {
Paul Elliott46845252023-02-03 14:59:11 +00003608
Paul Elliott588f8ed2022-12-02 18:10:26 +00003609#if defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3610 status = mbedtls_to_psa_error(
3611 mbedtls_ecdsa_sign_det_restartable(&operation->ctx->grp,
Paul Elliott46845252023-02-03 14:59:11 +00003612 &r,
3613 &s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003614 &operation->ctx->d,
3615 operation->hash,
3616 operation->hash_length,
3617 operation->md_alg,
3618 mbedtls_psa_get_random,
3619 MBEDTLS_PSA_RANDOM_STATE,
3620 &operation->restart_ctx));
3621#else /* defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Paul Elliott724bd252023-02-08 12:35:08 +00003622 status = PSA_ERROR_NOT_SUPPORTED;
3623 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003624#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
3625 } else {
Paul Elliott588f8ed2022-12-02 18:10:26 +00003626 status = mbedtls_to_psa_error(
3627 mbedtls_ecdsa_sign_restartable(&operation->ctx->grp,
Paul Elliott46845252023-02-03 14:59:11 +00003628 &r,
3629 &s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003630 &operation->ctx->d,
3631 operation->hash,
3632 operation->hash_length,
3633 mbedtls_psa_get_random,
3634 MBEDTLS_PSA_RANDOM_STATE,
3635 mbedtls_psa_get_random,
3636 MBEDTLS_PSA_RANDOM_STATE,
3637 &operation->restart_ctx));
3638 }
3639
Paul Elliottf8e5b562023-02-19 18:43:45 +00003640 /* Hide the fact that the restart context only holds a delta of number of
3641 * ops done during the last operation, not an absolute value. */
3642 operation->num_ops += operation->restart_ctx.ecp.ops_done;
3643
Paul Elliott724bd252023-02-08 12:35:08 +00003644 if (status == PSA_SUCCESS) {
Paul Elliott588f8ed2022-12-02 18:10:26 +00003645 status = mbedtls_to_psa_error(
Paul Elliott46845252023-02-03 14:59:11 +00003646 mbedtls_mpi_write_binary(&r,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003647 signature,
Paul Elliott1bc59df2023-02-05 13:41:57 +00003648 operation->coordinate_bytes)
3649 );
Paul Elliott588f8ed2022-12-02 18:10:26 +00003650
3651 if (status != PSA_SUCCESS) {
Paul Elliott724bd252023-02-08 12:35:08 +00003652 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003653 }
3654
3655 status = mbedtls_to_psa_error(
Paul Elliott46845252023-02-03 14:59:11 +00003656 mbedtls_mpi_write_binary(&s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003657 signature +
Paul Elliott1bc59df2023-02-05 13:41:57 +00003658 operation->coordinate_bytes,
3659 operation->coordinate_bytes)
3660 );
Paul Elliott588f8ed2022-12-02 18:10:26 +00003661
3662 if (status != PSA_SUCCESS) {
Paul Elliott724bd252023-02-08 12:35:08 +00003663 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003664 }
3665
Paul Elliott1bc59df2023-02-05 13:41:57 +00003666 *signature_length = operation->coordinate_bytes * 2;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003667
Paul Elliott724bd252023-02-08 12:35:08 +00003668 status = PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003669 }
Paul Elliott724bd252023-02-08 12:35:08 +00003670
3671exit:
3672
3673 mbedtls_mpi_free(&r);
3674 mbedtls_mpi_free(&s);
3675 return status;
3676
Paul Elliott588f8ed2022-12-02 18:10:26 +00003677 #else
3678
3679 (void) operation;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003680 (void) signature;
3681 (void) signature_size;
3682 (void) signature_length;
3683
3684 return PSA_ERROR_NOT_SUPPORTED;
3685
3686#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3687 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3688 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3689}
3690
3691psa_status_t mbedtls_psa_sign_hash_abort(
3692 mbedtls_psa_sign_hash_interruptible_operation_t *operation)
3693{
3694
3695#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3696 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3697 defined(MBEDTLS_ECP_RESTARTABLE)
3698
3699 if (operation->ctx) {
3700 mbedtls_ecdsa_free(operation->ctx);
3701 mbedtls_free(operation->ctx);
Paul Elliottf9c91a72023-02-05 18:06:38 +00003702 operation->ctx = NULL;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003703 }
3704
3705 mbedtls_ecdsa_restart_free(&operation->restart_ctx);
3706
Paul Elliott93d9ca82023-02-15 18:14:21 +00003707 operation->num_ops = 0;
3708
Paul Elliott588f8ed2022-12-02 18:10:26 +00003709 return PSA_SUCCESS;
3710
3711#else
3712
3713 (void) operation;
3714
3715 return PSA_ERROR_NOT_SUPPORTED;
3716
3717#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3718 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3719 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3720}
3721
3722psa_status_t mbedtls_psa_verify_hash_start(
3723 mbedtls_psa_verify_hash_interruptible_operation_t *operation,
3724 const psa_key_attributes_t *attributes,
3725 const uint8_t *key_buffer, size_t key_buffer_size,
3726 psa_algorithm_t alg,
3727 const uint8_t *hash, size_t hash_length,
3728 const uint8_t *signature, size_t signature_length)
3729{
3730 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott1bc59df2023-02-05 13:41:57 +00003731 size_t coordinate_bytes = 0;
Paul Elliott0290a762023-02-09 14:30:24 +00003732 size_t required_hash_length = 0;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003733
Paul Elliott068fe072023-01-16 13:59:15 +00003734 if (!PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3735 return PSA_ERROR_NOT_SUPPORTED;
3736 }
3737
3738 if (!PSA_ALG_IS_ECDSA(alg)) {
Paul Elliott813f9cd2023-02-05 15:28:46 +00003739 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott068fe072023-01-16 13:59:15 +00003740 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003741
3742#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Paul Elliott068fe072023-01-16 13:59:15 +00003743 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3744 defined(MBEDTLS_ECP_RESTARTABLE)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003745
Paul Elliotta1c94092023-02-15 16:38:04 +00003746 mbedtls_ecdsa_restart_init(&operation->restart_ctx);
3747 mbedtls_mpi_init(&operation->r);
3748 mbedtls_mpi_init(&operation->s);
3749
Paul Elliott93d9ca82023-02-15 18:14:21 +00003750 /* Ensure num_ops is zero'ed in case of context re-use. */
3751 operation->num_ops = 0;
3752
Paul Elliott068fe072023-01-16 13:59:15 +00003753 status = mbedtls_psa_ecp_load_representation(attributes->core.type,
3754 attributes->core.bits,
3755 key_buffer,
3756 key_buffer_size,
3757 &operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003758
Paul Elliott068fe072023-01-16 13:59:15 +00003759 if (status != PSA_SUCCESS) {
3760 return status;
3761 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003762
Paul Elliottc569fc22023-02-10 13:02:54 +00003763 coordinate_bytes = PSA_BITS_TO_BYTES(operation->ctx->grp.nbits);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003764
Paul Elliott1bc59df2023-02-05 13:41:57 +00003765 if (signature_length != 2 * coordinate_bytes) {
Paul Elliott068fe072023-01-16 13:59:15 +00003766 return PSA_ERROR_INVALID_SIGNATURE;
3767 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003768
Paul Elliott068fe072023-01-16 13:59:15 +00003769 status = mbedtls_to_psa_error(
3770 mbedtls_mpi_read_binary(&operation->r,
3771 signature,
Paul Elliott1bc59df2023-02-05 13:41:57 +00003772 coordinate_bytes));
Paul Elliott588f8ed2022-12-02 18:10:26 +00003773
Paul Elliott068fe072023-01-16 13:59:15 +00003774 if (status != PSA_SUCCESS) {
3775 return status;
3776 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003777
Paul Elliott068fe072023-01-16 13:59:15 +00003778 status = mbedtls_to_psa_error(
3779 mbedtls_mpi_read_binary(&operation->s,
3780 signature +
Paul Elliott1bc59df2023-02-05 13:41:57 +00003781 coordinate_bytes,
3782 coordinate_bytes));
Paul Elliott588f8ed2022-12-02 18:10:26 +00003783
Paul Elliott068fe072023-01-16 13:59:15 +00003784 if (status != PSA_SUCCESS) {
3785 return status;
3786 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003787
Paul Elliott2c9843f2023-02-15 17:32:42 +00003788 status = mbedtls_psa_ecp_load_public_part(operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003789
Paul Elliott2c9843f2023-02-15 17:32:42 +00003790 if (status != PSA_SUCCESS) {
3791 return status;
Paul Elliott068fe072023-01-16 13:59:15 +00003792 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003793
Paul Elliott0290a762023-02-09 14:30:24 +00003794 /* We only need to store the same length of hash as the private key size
3795 * here, it would be truncated by the internal implementation anyway. */
3796 required_hash_length = (hash_length < coordinate_bytes ? hash_length :
3797 coordinate_bytes);
3798
Paul Elliottba70ad42023-02-15 18:23:53 +00003799 if (required_hash_length > sizeof(operation->hash)) {
3800 /* Shouldn't happen, but better safe than sorry. */
3801 return PSA_ERROR_CORRUPTION_DETECTED;
3802 }
3803
Paul Elliott0290a762023-02-09 14:30:24 +00003804 memcpy(operation->hash, hash, required_hash_length);
3805 operation->hash_length = required_hash_length;
Paul Elliott068fe072023-01-16 13:59:15 +00003806
3807 return PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003808#else
Paul Elliott068fe072023-01-16 13:59:15 +00003809 (void) operation;
3810 (void) key_buffer;
3811 (void) key_buffer_size;
3812 (void) alg;
3813 (void) hash;
3814 (void) hash_length;
3815 (void) signature;
3816 (void) signature_length;
3817 (void) status;
Paul Elliott1243f932023-02-07 11:21:10 +00003818 (void) coordinate_bytes;
Paul Elliott0290a762023-02-09 14:30:24 +00003819 (void) required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003820
Paul Elliott068fe072023-01-16 13:59:15 +00003821 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003822#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3823 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3824 * defined( MBEDTLS_ECP_RESTARTABLE ) */
Paul Elliott588f8ed2022-12-02 18:10:26 +00003825}
3826
3827psa_status_t mbedtls_psa_verify_hash_complete(
3828 mbedtls_psa_verify_hash_interruptible_operation_t *operation)
3829{
3830
3831#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3832 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3833 defined(MBEDTLS_ECP_RESTARTABLE)
3834
Paul Elliottf8e5b562023-02-19 18:43:45 +00003835 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3836
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003837 /* Ensure max_ops is set to the current value (or default). */
3838 mbedtls_psa_interruptible_set_max_ops(psa_interruptible_get_max_ops());
3839
Paul Elliottf8e5b562023-02-19 18:43:45 +00003840 status = mbedtls_to_psa_error(
Paul Elliott588f8ed2022-12-02 18:10:26 +00003841 mbedtls_ecdsa_verify_restartable(&operation->ctx->grp,
3842 operation->hash,
3843 operation->hash_length,
3844 &operation->ctx->Q,
3845 &operation->r,
3846 &operation->s,
3847 &operation->restart_ctx));
3848
Paul Elliottf8e5b562023-02-19 18:43:45 +00003849 /* Hide the fact that the restart context only holds a delta of number of
3850 * ops done during the last operation, not an absolute value. */
3851 operation->num_ops += operation->restart_ctx.ecp.ops_done;
3852
3853 return status;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003854#else
3855 (void) operation;
3856
3857 return PSA_ERROR_NOT_SUPPORTED;
3858
3859#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3860 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3861 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3862}
3863
3864psa_status_t mbedtls_psa_verify_hash_abort(
3865 mbedtls_psa_verify_hash_interruptible_operation_t *operation)
3866{
3867
3868#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3869 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3870 defined(MBEDTLS_ECP_RESTARTABLE)
3871
3872 if (operation->ctx) {
3873 mbedtls_ecdsa_free(operation->ctx);
3874 mbedtls_free(operation->ctx);
Paul Elliottf9c91a72023-02-05 18:06:38 +00003875 operation->ctx = NULL;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003876 }
3877
3878 mbedtls_ecdsa_restart_free(&operation->restart_ctx);
3879
Paul Elliott93d9ca82023-02-15 18:14:21 +00003880 operation->num_ops = 0;
3881
Paul Elliott588f8ed2022-12-02 18:10:26 +00003882 mbedtls_mpi_free(&operation->r);
3883 mbedtls_mpi_free(&operation->s);
3884
3885 return PSA_SUCCESS;
3886
3887#else
3888 (void) operation;
3889
3890 return PSA_ERROR_NOT_SUPPORTED;
3891
3892#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3893 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3894 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3895}
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003896
mohammad1603503973b2018-03-12 15:59:30 +02003897/****************************************************************/
3898/* Symmetric cryptography */
3899/****************************************************************/
3900
Gilles Peskine449bd832023-01-11 14:50:10 +01003901static psa_status_t psa_cipher_setup(psa_cipher_operation_t *operation,
3902 mbedtls_svc_key_id_t key,
3903 psa_algorithm_t alg,
3904 mbedtls_operation_t cipher_operation)
Ronald Cronab99ac22020-10-01 16:38:28 +02003905{
3906 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3907 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman54648242021-06-24 11:49:45 +01003908 psa_key_slot_t *slot = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01003909 psa_key_usage_t usage = (cipher_operation == MBEDTLS_ENCRYPT ?
3910 PSA_KEY_USAGE_ENCRYPT :
3911 PSA_KEY_USAGE_DECRYPT);
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003912 psa_key_attributes_t attributes;
Ronald Cronab99ac22020-10-01 16:38:28 +02003913
3914 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003915 if (operation->id != 0) {
Dave Rodgman54648242021-06-24 11:49:45 +01003916 status = PSA_ERROR_BAD_STATE;
3917 goto exit;
3918 }
Ronald Cronab99ac22020-10-01 16:38:28 +02003919
Gilles Peskine449bd832023-01-11 14:50:10 +01003920 if (!PSA_ALG_IS_CIPHER(alg)) {
Dave Rodgman54648242021-06-24 11:49:45 +01003921 status = PSA_ERROR_INVALID_ARGUMENT;
3922 goto exit;
3923 }
Ronald Cronab99ac22020-10-01 16:38:28 +02003924
Gilles Peskine449bd832023-01-11 14:50:10 +01003925 status = psa_get_and_lock_key_slot_with_policy(key, &slot, usage, alg);
3926 if (status != PSA_SUCCESS) {
Ronald Cronab99ac22020-10-01 16:38:28 +02003927 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01003928 }
Ronald Cronab99ac22020-10-01 16:38:28 +02003929
Ronald Cron49fafa92021-03-10 08:34:23 +01003930 /* Initialize the operation struct members, except for id. The id member
Ronald Cronab99ac22020-10-01 16:38:28 +02003931 * is used to indicate to psa_cipher_abort that there are resources to free,
Ronald Cron49fafa92021-03-10 08:34:23 +01003932 * so we only set it (in the driver wrapper) after resources have been
3933 * allocated/initialized. */
Ronald Cronab99ac22020-10-01 16:38:28 +02003934 operation->iv_set = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01003935 if (alg == PSA_ALG_ECB_NO_PADDING) {
Ronald Cronab99ac22020-10-01 16:38:28 +02003936 operation->iv_required = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01003937 } else {
Ronald Cronab99ac22020-10-01 16:38:28 +02003938 operation->iv_required = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003939 }
3940 operation->default_iv_length = PSA_CIPHER_IV_LENGTH(slot->attr.type, alg);
Ronald Cronab99ac22020-10-01 16:38:28 +02003941
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003942 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01003943 .core = slot->attr
Ronald Crona4af55f2020-12-14 14:36:06 +01003944 };
3945
Ronald Cronab99ac22020-10-01 16:38:28 +02003946 /* Try doing the operation through a driver before using software fallback. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003947 if (cipher_operation == MBEDTLS_ENCRYPT) {
3948 status = psa_driver_wrapper_cipher_encrypt_setup(operation,
3949 &attributes,
3950 slot->key.data,
3951 slot->key.bytes,
3952 alg);
3953 } else {
3954 status = psa_driver_wrapper_cipher_decrypt_setup(operation,
3955 &attributes,
3956 slot->key.data,
3957 slot->key.bytes,
3958 alg);
3959 }
Ronald Cronab99ac22020-10-01 16:38:28 +02003960
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003961exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01003962 if (status != PSA_SUCCESS) {
3963 psa_cipher_abort(operation);
3964 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003965
Gilles Peskine449bd832023-01-11 14:50:10 +01003966 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003967
Gilles Peskine449bd832023-01-11 14:50:10 +01003968 return (status == PSA_SUCCESS) ? unlock_status : status;
mohammad1603503973b2018-03-12 15:59:30 +02003969}
3970
Gilles Peskine449bd832023-01-11 14:50:10 +01003971psa_status_t psa_cipher_encrypt_setup(psa_cipher_operation_t *operation,
3972 mbedtls_svc_key_id_t key,
3973 psa_algorithm_t alg)
mohammad16038481e742018-03-18 13:57:31 +02003974{
Gilles Peskine449bd832023-01-11 14:50:10 +01003975 return psa_cipher_setup(operation, key, alg, MBEDTLS_ENCRYPT);
mohammad16038481e742018-03-18 13:57:31 +02003976}
3977
Gilles Peskine449bd832023-01-11 14:50:10 +01003978psa_status_t psa_cipher_decrypt_setup(psa_cipher_operation_t *operation,
3979 mbedtls_svc_key_id_t key,
3980 psa_algorithm_t alg)
mohammad16038481e742018-03-18 13:57:31 +02003981{
Gilles Peskine449bd832023-01-11 14:50:10 +01003982 return psa_cipher_setup(operation, key, alg, MBEDTLS_DECRYPT);
mohammad16038481e742018-03-18 13:57:31 +02003983}
3984
Gilles Peskine449bd832023-01-11 14:50:10 +01003985psa_status_t psa_cipher_generate_iv(psa_cipher_operation_t *operation,
3986 uint8_t *iv,
3987 size_t iv_size,
3988 size_t *iv_length)
mohammad1603503973b2018-03-12 15:59:30 +02003989{
Ronald Cron6d051732020-10-01 14:10:20 +02003990 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2fb90522021-07-05 12:31:44 +02003991 uint8_t local_iv[PSA_CIPHER_IV_MAX_SIZE];
Sergeybef1f632023-03-06 15:25:06 -07003992 size_t default_iv_length = 0;
Ronald Cron5618a392021-03-26 09:52:26 +01003993
Gilles Peskine449bd832023-01-11 14:50:10 +01003994 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003995 status = PSA_ERROR_BAD_STATE;
3996 goto exit;
Ronald Cronc45b4af2020-09-29 16:18:05 +02003997 }
3998
Gilles Peskine449bd832023-01-11 14:50:10 +01003999 if (operation->iv_set || !operation->iv_required) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004000 status = PSA_ERROR_BAD_STATE;
4001 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004002 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004003
Ronald Cron2fb90522021-07-05 12:31:44 +02004004 default_iv_length = operation->default_iv_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01004005 if (iv_size < default_iv_length) {
Ronald Cron5618a392021-03-26 09:52:26 +01004006 status = PSA_ERROR_BUFFER_TOO_SMALL;
4007 goto exit;
4008 }
Gilles Peskinee553c652018-06-04 16:22:46 +02004009
Gilles Peskine449bd832023-01-11 14:50:10 +01004010 if (default_iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Ronald Cron2fb90522021-07-05 12:31:44 +02004011 status = PSA_ERROR_GENERIC_ERROR;
4012 goto exit;
4013 }
4014
Gilles Peskine449bd832023-01-11 14:50:10 +01004015 status = psa_generate_random(local_iv, default_iv_length);
4016 if (status != PSA_SUCCESS) {
Ronald Cron5618a392021-03-26 09:52:26 +01004017 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004018 }
Ronald Cron5618a392021-03-26 09:52:26 +01004019
Gilles Peskine449bd832023-01-11 14:50:10 +01004020 status = psa_driver_wrapper_cipher_set_iv(operation,
4021 local_iv, default_iv_length);
Ronald Cron5618a392021-03-26 09:52:26 +01004022
4023exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004024 if (status == PSA_SUCCESS) {
4025 memcpy(iv, local_iv, default_iv_length);
Ronald Cron2fb90522021-07-05 12:31:44 +02004026 *iv_length = default_iv_length;
Steven Cooreman7df02922020-09-09 15:28:49 +02004027 operation->iv_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004028 } else {
Ronald Cron2fb90522021-07-05 12:31:44 +02004029 *iv_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004030 psa_cipher_abort(operation);
Ronald Cron2fb90522021-07-05 12:31:44 +02004031 }
Ronald Cron6d051732020-10-01 14:10:20 +02004032
Gilles Peskine449bd832023-01-11 14:50:10 +01004033 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004034}
4035
Gilles Peskine449bd832023-01-11 14:50:10 +01004036psa_status_t psa_cipher_set_iv(psa_cipher_operation_t *operation,
4037 const uint8_t *iv,
4038 size_t iv_length)
mohammad1603503973b2018-03-12 15:59:30 +02004039{
Ronald Cron6d051732020-10-01 14:10:20 +02004040 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronc45b4af2020-09-29 16:18:05 +02004041
Gilles Peskine449bd832023-01-11 14:50:10 +01004042 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004043 status = PSA_ERROR_BAD_STATE;
4044 goto exit;
4045 }
Ronald Cronc45b4af2020-09-29 16:18:05 +02004046
Gilles Peskine449bd832023-01-11 14:50:10 +01004047 if (operation->iv_set || !operation->iv_required) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004048 status = PSA_ERROR_BAD_STATE;
4049 goto exit;
4050 }
Ronald Crona0d68172021-03-26 10:15:08 +01004051
Gilles Peskine449bd832023-01-11 14:50:10 +01004052 if (iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004053 status = PSA_ERROR_INVALID_ARGUMENT;
4054 goto exit;
4055 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004056
Gilles Peskine449bd832023-01-11 14:50:10 +01004057 status = psa_driver_wrapper_cipher_set_iv(operation,
4058 iv,
4059 iv_length);
Steven Cooremand3feccd2020-09-01 15:56:14 +02004060
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004061exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004062 if (status == PSA_SUCCESS) {
itayzafrir534bd7c2018-08-02 13:56:32 +03004063 operation->iv_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004064 } else {
4065 psa_cipher_abort(operation);
4066 }
4067 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004068}
4069
Gilles Peskine449bd832023-01-11 14:50:10 +01004070psa_status_t psa_cipher_update(psa_cipher_operation_t *operation,
4071 const uint8_t *input,
4072 size_t input_length,
4073 uint8_t *output,
4074 size_t output_size,
4075 size_t *output_length)
mohammad1603503973b2018-03-12 15:59:30 +02004076{
Steven Cooremanffecb7b2020-08-25 15:13:13 +02004077 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron6d051732020-10-01 14:10:20 +02004078
Gilles Peskine449bd832023-01-11 14:50:10 +01004079 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004080 status = PSA_ERROR_BAD_STATE;
4081 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004082 }
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004083
Gilles Peskine449bd832023-01-11 14:50:10 +01004084 if (operation->iv_required && !operation->iv_set) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004085 status = PSA_ERROR_BAD_STATE;
4086 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004087 }
Jaeden Ameroab439972019-02-15 14:12:05 +00004088
Gilles Peskine449bd832023-01-11 14:50:10 +01004089 status = psa_driver_wrapper_cipher_update(operation,
4090 input,
4091 input_length,
4092 output,
4093 output_size,
4094 output_length);
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004095
4096exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004097 if (status != PSA_SUCCESS) {
4098 psa_cipher_abort(operation);
4099 }
Ronald Cron6d051732020-10-01 14:10:20 +02004100
Gilles Peskine449bd832023-01-11 14:50:10 +01004101 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004102}
4103
Gilles Peskine449bd832023-01-11 14:50:10 +01004104psa_status_t psa_cipher_finish(psa_cipher_operation_t *operation,
4105 uint8_t *output,
4106 size_t output_size,
4107 size_t *output_length)
mohammad1603503973b2018-03-12 15:59:30 +02004108{
David Saadab4ecc272019-02-14 13:48:10 +02004109 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Ronald Cron6d051732020-10-01 14:10:20 +02004110
Gilles Peskine449bd832023-01-11 14:50:10 +01004111 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004112 status = PSA_ERROR_BAD_STATE;
4113 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004114 }
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004115
Gilles Peskine449bd832023-01-11 14:50:10 +01004116 if (operation->iv_required && !operation->iv_set) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004117 status = PSA_ERROR_BAD_STATE;
4118 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004119 }
Moran Pekerbed71a22018-04-22 20:19:20 +03004120
Gilles Peskine449bd832023-01-11 14:50:10 +01004121 status = psa_driver_wrapper_cipher_finish(operation,
4122 output,
4123 output_size,
4124 output_length);
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004125
4126exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004127 if (status == PSA_SUCCESS) {
4128 return psa_cipher_abort(operation);
4129 } else {
Steven Cooremanef8575e2020-09-11 11:44:50 +02004130 *output_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004131 (void) psa_cipher_abort(operation);
Janos Follath315b51c2018-07-09 16:04:51 +01004132
Gilles Peskine449bd832023-01-11 14:50:10 +01004133 return status;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004134 }
mohammad1603503973b2018-03-12 15:59:30 +02004135}
4136
Gilles Peskine449bd832023-01-11 14:50:10 +01004137psa_status_t psa_cipher_abort(psa_cipher_operation_t *operation)
Gilles Peskinee553c652018-06-04 16:22:46 +02004138{
Gilles Peskine449bd832023-01-11 14:50:10 +01004139 if (operation->id == 0) {
Steven Cooremana07b9972020-09-10 14:54:14 +02004140 /* The object has (apparently) been initialized but it is not (yet)
Gilles Peskine81736312018-06-26 15:04:31 +02004141 * in use. It's ok to call abort on such an object, and there's
4142 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004143 return PSA_SUCCESS;
Gilles Peskine81736312018-06-26 15:04:31 +02004144 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004145
Gilles Peskine449bd832023-01-11 14:50:10 +01004146 psa_driver_wrapper_cipher_abort(operation);
Gilles Peskinee553c652018-06-04 16:22:46 +02004147
Ronald Cron49fafa92021-03-10 08:34:23 +01004148 operation->id = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004149 operation->iv_set = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004150 operation->iv_required = 0;
Moran Peker41deec42018-04-04 15:43:05 +03004151
Gilles Peskine449bd832023-01-11 14:50:10 +01004152 return PSA_SUCCESS;
mohammad1603503973b2018-03-12 15:59:30 +02004153}
4154
Gilles Peskine449bd832023-01-11 14:50:10 +01004155psa_status_t psa_cipher_encrypt(mbedtls_svc_key_id_t key,
4156 psa_algorithm_t alg,
4157 const uint8_t *input,
4158 size_t input_length,
4159 uint8_t *output,
4160 size_t output_size,
4161 size_t *output_length)
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004162{
4163 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004164 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron23919522021-07-08 19:00:07 +02004165 psa_key_slot_t *slot = NULL;
Ronald Cronc6e6f502021-07-09 18:44:58 +02004166 uint8_t local_iv[PSA_CIPHER_IV_MAX_SIZE];
4167 size_t default_iv_length = 0;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004168 psa_key_attributes_t attributes;
gabor-mezei-arm6f4e5bb2021-06-25 15:21:11 +02004169
Gilles Peskine449bd832023-01-11 14:50:10 +01004170 if (!PSA_ALG_IS_CIPHER(alg)) {
Ronald Cron23919522021-07-08 19:00:07 +02004171 status = PSA_ERROR_INVALID_ARGUMENT;
4172 goto exit;
4173 }
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004174
Gilles Peskine449bd832023-01-11 14:50:10 +01004175 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
4176 PSA_KEY_USAGE_ENCRYPT,
4177 alg);
4178 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004179 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004180 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004181
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004182 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004183 .core = slot->attr
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004184 };
4185
Gilles Peskine449bd832023-01-11 14:50:10 +01004186 default_iv_length = PSA_CIPHER_IV_LENGTH(slot->attr.type, alg);
4187 if (default_iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Ronald Cronc6e6f502021-07-09 18:44:58 +02004188 status = PSA_ERROR_GENERIC_ERROR;
4189 goto exit;
4190 }
4191
Gilles Peskine449bd832023-01-11 14:50:10 +01004192 if (default_iv_length > 0) {
4193 if (output_size < default_iv_length) {
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004194 status = PSA_ERROR_BUFFER_TOO_SMALL;
4195 goto exit;
4196 }
4197
Gilles Peskine449bd832023-01-11 14:50:10 +01004198 status = psa_generate_random(local_iv, default_iv_length);
4199 if (status != PSA_SUCCESS) {
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004200 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004201 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004202 }
4203
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004204 status = psa_driver_wrapper_cipher_encrypt(
4205 &attributes, slot->key.data, slot->key.bytes,
Ronald Cronc6e6f502021-07-09 18:44:58 +02004206 alg, local_iv, default_iv_length, input, input_length,
Ronald Cronafbc7ed2023-01-24 16:02:04 +01004207 psa_crypto_buffer_offset(output, default_iv_length),
Gilles Peskine449bd832023-01-11 14:50:10 +01004208 output_size - default_iv_length, output_length);
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004209
4210exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004211 unlock_status = psa_unlock_key_slot(slot);
4212 if (status == PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004213 status = unlock_status;
Ronald Cronc6e6f502021-07-09 18:44:58 +02004214 }
Ronald Cron23919522021-07-08 19:00:07 +02004215
Gilles Peskine449bd832023-01-11 14:50:10 +01004216 if (status == PSA_SUCCESS) {
4217 if (default_iv_length > 0) {
4218 memcpy(output, local_iv, default_iv_length);
4219 }
4220 *output_length += default_iv_length;
4221 } else {
4222 *output_length = 0;
4223 }
4224
4225 return status;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004226}
4227
Gilles Peskine449bd832023-01-11 14:50:10 +01004228psa_status_t psa_cipher_decrypt(mbedtls_svc_key_id_t key,
4229 psa_algorithm_t alg,
4230 const uint8_t *input,
4231 size_t input_length,
4232 uint8_t *output,
4233 size_t output_size,
4234 size_t *output_length)
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004235{
4236 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004237 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron23919522021-07-08 19:00:07 +02004238 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004239 psa_key_attributes_t attributes;
gabor-mezei-arm6f4e5bb2021-06-25 15:21:11 +02004240
Gilles Peskine449bd832023-01-11 14:50:10 +01004241 if (!PSA_ALG_IS_CIPHER(alg)) {
Ronald Cron23919522021-07-08 19:00:07 +02004242 status = PSA_ERROR_INVALID_ARGUMENT;
4243 goto exit;
4244 }
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004245
Gilles Peskine449bd832023-01-11 14:50:10 +01004246 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
4247 PSA_KEY_USAGE_DECRYPT,
4248 alg);
4249 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004250 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004251 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004252
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004253 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004254 .core = slot->attr
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004255 };
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004256
Gilles Peskine449bd832023-01-11 14:50:10 +01004257 if (alg == PSA_ALG_CCM_STAR_NO_TAG &&
4258 input_length < PSA_BLOCK_CIPHER_BLOCK_LENGTH(slot->attr.type)) {
Mateusz Starzyk594215b2021-10-14 12:23:06 +02004259 status = PSA_ERROR_INVALID_ARGUMENT;
4260 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004261 } else if (input_length < PSA_CIPHER_IV_LENGTH(slot->attr.type, alg)) {
gabor-mezei-arm258ae072021-06-25 15:25:38 +02004262 status = PSA_ERROR_INVALID_ARGUMENT;
4263 goto exit;
4264 }
4265
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004266 status = psa_driver_wrapper_cipher_decrypt(
4267 &attributes, slot->key.data, slot->key.bytes,
4268 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004269 output, output_size, output_length);
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004270
gabor-mezei-arm258ae072021-06-25 15:25:38 +02004271exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004272 unlock_status = psa_unlock_key_slot(slot);
4273 if (status == PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004274 status = unlock_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01004275 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004276
Gilles Peskine449bd832023-01-11 14:50:10 +01004277 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004278 *output_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004279 }
Ronald Cron23919522021-07-08 19:00:07 +02004280
Gilles Peskine449bd832023-01-11 14:50:10 +01004281 return status;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004282}
4283
4284
mohammad16035955c982018-04-26 00:53:03 +03004285/****************************************************************/
4286/* AEAD */
4287/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004288
Paul Elliottbaff51c2021-09-28 17:44:45 +01004289/* Helper function to get the base algorithm from its variants. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004290static psa_algorithm_t psa_aead_get_base_algorithm(psa_algorithm_t alg)
Paul Elliottbaff51c2021-09-28 17:44:45 +01004291{
Gilles Peskine449bd832023-01-11 14:50:10 +01004292 return PSA_ALG_AEAD_WITH_DEFAULT_LENGTH_TAG(alg);
Paul Elliottbaff51c2021-09-28 17:44:45 +01004293}
4294
4295/* Helper function to perform common nonce length checks. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004296static psa_status_t psa_aead_check_nonce_length(psa_algorithm_t alg,
4297 size_t nonce_length)
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004298{
Gilles Peskine449bd832023-01-11 14:50:10 +01004299 psa_algorithm_t base_alg = psa_aead_get_base_algorithm(alg);
Paul Elliottbaff51c2021-09-28 17:44:45 +01004300
Gilles Peskine449bd832023-01-11 14:50:10 +01004301 switch (base_alg) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004302#if defined(PSA_WANT_ALG_GCM)
4303 case PSA_ALG_GCM:
4304 /* Not checking max nonce size here as GCM spec allows almost
Gilles Peskine449bd832023-01-11 14:50:10 +01004305 * arbitrarily large nonces. Please note that we do not generally
4306 * recommend the usage of nonces of greater length than
4307 * PSA_AEAD_NONCE_MAX_SIZE, as large nonces are hashed to a shorter
4308 * size, which can then lead to collisions if you encrypt a very
4309 * large number of messages.*/
4310 if (nonce_length != 0) {
4311 return PSA_SUCCESS;
4312 }
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004313 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004314#endif /* PSA_WANT_ALG_GCM */
4315#if defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004316 case PSA_ALG_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01004317 if (nonce_length >= 7 && nonce_length <= 13) {
4318 return PSA_SUCCESS;
4319 }
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004320 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004321#endif /* PSA_WANT_ALG_CCM */
4322#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004323 case PSA_ALG_CHACHA20_POLY1305:
Gilles Peskine449bd832023-01-11 14:50:10 +01004324 if (nonce_length == 12) {
4325 return PSA_SUCCESS;
4326 } else if (nonce_length == 8) {
4327 return PSA_ERROR_NOT_SUPPORTED;
4328 }
Bence Szépkúti6d48e202021-11-15 20:04:15 +01004329 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004330#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004331 default:
Przemek Stekiel4c499272022-09-27 13:55:37 +02004332 (void) nonce_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01004333 return PSA_ERROR_NOT_SUPPORTED;
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004334 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004335
Gilles Peskine449bd832023-01-11 14:50:10 +01004336 return PSA_ERROR_INVALID_ARGUMENT;
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004337}
4338
Gilles Peskine449bd832023-01-11 14:50:10 +01004339static psa_status_t psa_aead_check_algorithm(psa_algorithm_t alg)
Bence Szépkútiaa3a6e42022-01-13 16:26:03 +01004340{
Gilles Peskine449bd832023-01-11 14:50:10 +01004341 if (!PSA_ALG_IS_AEAD(alg) || PSA_ALG_IS_WILDCARD(alg)) {
4342 return PSA_ERROR_INVALID_ARGUMENT;
4343 }
Bence Szépkúti08f34652021-12-08 21:07:13 +01004344
Gilles Peskine449bd832023-01-11 14:50:10 +01004345 return PSA_SUCCESS;
Bence Szépkúti08f34652021-12-08 21:07:13 +01004346}
4347
Gilles Peskine449bd832023-01-11 14:50:10 +01004348psa_status_t psa_aead_encrypt(mbedtls_svc_key_id_t key,
4349 psa_algorithm_t alg,
4350 const uint8_t *nonce,
4351 size_t nonce_length,
4352 const uint8_t *additional_data,
4353 size_t additional_data_length,
4354 const uint8_t *plaintext,
4355 size_t plaintext_length,
4356 uint8_t *ciphertext,
4357 size_t ciphertext_size,
4358 size_t *ciphertext_length)
mohammad16035955c982018-04-26 00:53:03 +03004359{
Ronald Cron215633c2021-03-16 17:15:37 +01004360 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4361 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02004362
mohammad1603f08a5502018-06-03 15:05:47 +03004363 *ciphertext_length = 0;
mohammad1603e58e6842018-05-09 04:58:32 -07004364
Gilles Peskine449bd832023-01-11 14:50:10 +01004365 status = psa_aead_check_algorithm(alg);
4366 if (status != PSA_SUCCESS) {
4367 return status;
4368 }
Steven Cooremanea7ab132021-03-17 16:28:00 +01004369
Ronald Cron9a986162021-03-26 12:40:07 +01004370 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01004371 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg);
4372 if (status != PSA_SUCCESS) {
4373 return status;
4374 }
mohammad16035955c982018-04-26 00:53:03 +03004375
Ronald Cron215633c2021-03-16 17:15:37 +01004376 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01004377 .core = slot->attr
Ronald Cron215633c2021-03-16 17:15:37 +01004378 };
mohammad16035955c982018-04-26 00:53:03 +03004379
Gilles Peskine449bd832023-01-11 14:50:10 +01004380 status = psa_aead_check_nonce_length(alg, nonce_length);
4381 if (status != PSA_SUCCESS) {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004382 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004383 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004384
Ronald Cronde822812021-03-17 16:08:20 +01004385 status = psa_driver_wrapper_aead_encrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01004386 &attributes, slot->key.data, slot->key.bytes,
4387 alg,
4388 nonce, nonce_length,
4389 additional_data, additional_data_length,
4390 plaintext, plaintext_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004391 ciphertext, ciphertext_size, ciphertext_length);
Gilles Peskine2d277862018-06-18 15:41:12 +02004392
Gilles Peskine449bd832023-01-11 14:50:10 +01004393 if (status != PSA_SUCCESS && ciphertext_size != 0) {
4394 memset(ciphertext, 0, ciphertext_size);
4395 }
Gilles Peskine2d277862018-06-18 15:41:12 +02004396
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004397exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004398 psa_unlock_key_slot(slot);
mohammad16035955c982018-04-26 00:53:03 +03004399
Gilles Peskine449bd832023-01-11 14:50:10 +01004400 return status;
Gilles Peskineee652a32018-06-01 19:23:52 +02004401}
4402
Gilles Peskine449bd832023-01-11 14:50:10 +01004403psa_status_t psa_aead_decrypt(mbedtls_svc_key_id_t key,
4404 psa_algorithm_t alg,
4405 const uint8_t *nonce,
4406 size_t nonce_length,
4407 const uint8_t *additional_data,
4408 size_t additional_data_length,
4409 const uint8_t *ciphertext,
4410 size_t ciphertext_length,
4411 uint8_t *plaintext,
4412 size_t plaintext_size,
4413 size_t *plaintext_length)
mohammad16035955c982018-04-26 00:53:03 +03004414{
Ronald Cron215633c2021-03-16 17:15:37 +01004415 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4416 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02004417
Gilles Peskineee652a32018-06-01 19:23:52 +02004418 *plaintext_length = 0;
mohammad16039e5a5152018-04-26 12:07:35 +03004419
Gilles Peskine449bd832023-01-11 14:50:10 +01004420 status = psa_aead_check_algorithm(alg);
4421 if (status != PSA_SUCCESS) {
4422 return status;
4423 }
Steven Cooremanea7ab132021-03-17 16:28:00 +01004424
Ronald Cron9a986162021-03-26 12:40:07 +01004425 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01004426 key, &slot, PSA_KEY_USAGE_DECRYPT, alg);
4427 if (status != PSA_SUCCESS) {
4428 return status;
4429 }
mohammad16035955c982018-04-26 00:53:03 +03004430
Ronald Cron215633c2021-03-16 17:15:37 +01004431 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01004432 .core = slot->attr
Ronald Cron215633c2021-03-16 17:15:37 +01004433 };
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004434
Gilles Peskine449bd832023-01-11 14:50:10 +01004435 status = psa_aead_check_nonce_length(alg, nonce_length);
4436 if (status != PSA_SUCCESS) {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004437 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004438 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004439
Ronald Cronde822812021-03-17 16:08:20 +01004440 status = psa_driver_wrapper_aead_decrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01004441 &attributes, slot->key.data, slot->key.bytes,
4442 alg,
4443 nonce, nonce_length,
4444 additional_data, additional_data_length,
4445 ciphertext, ciphertext_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004446 plaintext, plaintext_size, plaintext_length);
Gilles Peskinea40d7742018-06-01 16:28:30 +02004447
Gilles Peskine449bd832023-01-11 14:50:10 +01004448 if (status != PSA_SUCCESS && plaintext_size != 0) {
4449 memset(plaintext, 0, plaintext_size);
4450 }
mohammad160360a64d02018-06-03 17:20:42 +03004451
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004452exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004453 psa_unlock_key_slot(slot);
Ronald Cron215633c2021-03-16 17:15:37 +01004454
Gilles Peskine449bd832023-01-11 14:50:10 +01004455 return status;
mohammad16035955c982018-04-26 00:53:03 +03004456}
4457
Gilles Peskine449bd832023-01-11 14:50:10 +01004458static psa_status_t psa_validate_tag_length(psa_algorithm_t alg)
4459{
4460 const uint8_t tag_len = PSA_ALG_AEAD_GET_TAG_LENGTH(alg);
Andrzej Kurekf8816012021-12-19 17:00:12 +01004461
Gilles Peskine449bd832023-01-11 14:50:10 +01004462 switch (PSA_ALG_AEAD_WITH_SHORTENED_TAG(alg, 0)) {
Przemek Stekiel86679c72022-10-06 17:06:56 +02004463#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004464 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004465 /* CCM allows the following tag lengths: 4, 6, 8, 10, 12, 14, 16.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004466 if (tag_len < 4 || tag_len > 16 || tag_len % 2) {
4467 return PSA_ERROR_INVALID_ARGUMENT;
4468 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01004469 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02004470#endif /* PSA_WANT_ALG_CCM */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004471
Przemek Stekiel86679c72022-10-06 17:06:56 +02004472#if defined(PSA_WANT_ALG_GCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004473 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_GCM, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004474 /* GCM allows the following tag lengths: 4, 8, 12, 13, 14, 15, 16. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004475 if (tag_len != 4 && tag_len != 8 && (tag_len < 12 || tag_len > 16)) {
4476 return PSA_ERROR_INVALID_ARGUMENT;
4477 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01004478 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02004479#endif /* PSA_WANT_ALG_GCM */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004480
Przemek Stekiel86679c72022-10-06 17:06:56 +02004481#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Gilles Peskine449bd832023-01-11 14:50:10 +01004482 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CHACHA20_POLY1305, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004483 /* We only support the default tag length. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004484 if (tag_len != 16) {
4485 return PSA_ERROR_INVALID_ARGUMENT;
4486 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01004487 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02004488#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004489
4490 default:
4491 (void) tag_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004492 return PSA_ERROR_NOT_SUPPORTED;
Andrzej Kurekf8816012021-12-19 17:00:12 +01004493 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004494 return PSA_SUCCESS;
Andrzej Kurekf8816012021-12-19 17:00:12 +01004495}
4496
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004497/* Set the key for a multipart authenticated operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004498static psa_status_t psa_aead_setup(psa_aead_operation_t *operation,
4499 int is_encrypt,
4500 mbedtls_svc_key_id_t key,
4501 psa_algorithm_t alg)
Paul Elliottc2b71442021-06-24 18:17:52 +01004502{
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004503 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4504 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
4505 psa_key_slot_t *slot = NULL;
4506 psa_key_usage_t key_usage = 0;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004507 psa_key_attributes_t attributes;
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004508
Gilles Peskine449bd832023-01-11 14:50:10 +01004509 status = psa_aead_check_algorithm(alg);
4510 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004511 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004512 }
Paul Elliottc2b71442021-06-24 18:17:52 +01004513
Gilles Peskine449bd832023-01-11 14:50:10 +01004514 if (operation->id != 0) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004515 status = PSA_ERROR_BAD_STATE;
4516 goto exit;
Paul Elliottc2b71442021-06-24 18:17:52 +01004517 }
4518
Gilles Peskine449bd832023-01-11 14:50:10 +01004519 if (operation->nonce_set || operation->lengths_set ||
4520 operation->ad_started || operation->body_started) {
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 (is_encrypt) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004526 key_usage = PSA_KEY_USAGE_ENCRYPT;
Gilles Peskine449bd832023-01-11 14:50:10 +01004527 } else {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004528 key_usage = PSA_KEY_USAGE_DECRYPT;
Gilles Peskine449bd832023-01-11 14:50:10 +01004529 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004530
Gilles Peskine449bd832023-01-11 14:50:10 +01004531 status = psa_get_and_lock_key_slot_with_policy(key, &slot, key_usage,
4532 alg);
4533 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004534 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004535 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004536
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004537 attributes = (psa_key_attributes_t) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004538 .core = slot->attr
4539 };
4540
Gilles Peskine449bd832023-01-11 14:50:10 +01004541 if ((status = psa_validate_tag_length(alg)) != PSA_SUCCESS) {
Przemek Stekiel6ab50762022-10-08 17:54:30 +02004542 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004543 }
Przemek Stekiel6ab50762022-10-08 17:54:30 +02004544
Gilles Peskine449bd832023-01-11 14:50:10 +01004545 if (is_encrypt) {
4546 status = psa_driver_wrapper_aead_encrypt_setup(operation,
4547 &attributes,
4548 slot->key.data,
4549 slot->key.bytes,
4550 alg);
4551 } else {
4552 status = psa_driver_wrapper_aead_decrypt_setup(operation,
4553 &attributes,
4554 slot->key.data,
4555 slot->key.bytes,
4556 alg);
4557 }
4558 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004559 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004560 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004561
Gilles Peskine449bd832023-01-11 14:50:10 +01004562 operation->key_type = psa_get_key_type(&attributes);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004563
4564exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004565 unlock_status = psa_unlock_key_slot(slot);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004566
Gilles Peskine449bd832023-01-11 14:50:10 +01004567 if (status == PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004568 status = unlock_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01004569 operation->alg = psa_aead_get_base_algorithm(alg);
Paul Elliottd9343f22021-08-23 18:59:49 +01004570 operation->is_encrypt = is_encrypt;
Gilles Peskine449bd832023-01-11 14:50:10 +01004571 } else {
4572 psa_aead_abort(operation);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004573 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004574
Gilles Peskine449bd832023-01-11 14:50:10 +01004575 return status;
Paul Elliottc2b71442021-06-24 18:17:52 +01004576}
4577
Paul Elliott302ff6b2021-04-20 18:10:30 +01004578/* Set the key for a multipart authenticated encryption operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004579psa_status_t psa_aead_encrypt_setup(psa_aead_operation_t *operation,
4580 mbedtls_svc_key_id_t key,
4581 psa_algorithm_t alg)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004582{
Gilles Peskine449bd832023-01-11 14:50:10 +01004583 return psa_aead_setup(operation, 1, key, alg);
Paul Elliott302ff6b2021-04-20 18:10:30 +01004584}
4585
4586/* Set the key for a multipart authenticated decryption operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004587psa_status_t psa_aead_decrypt_setup(psa_aead_operation_t *operation,
4588 mbedtls_svc_key_id_t key,
4589 psa_algorithm_t alg)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004590{
Gilles Peskine449bd832023-01-11 14:50:10 +01004591 return psa_aead_setup(operation, 0, key, alg);
Paul Elliott302ff6b2021-04-20 18:10:30 +01004592}
4593
4594/* Generate a random nonce / IV for multipart AEAD operation */
Gilles Peskine449bd832023-01-11 14:50:10 +01004595psa_status_t psa_aead_generate_nonce(psa_aead_operation_t *operation,
4596 uint8_t *nonce,
4597 size_t nonce_size,
4598 size_t *nonce_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004599{
4600 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Croncae59092021-11-26 18:53:58 +01004601 uint8_t local_nonce[PSA_AEAD_NONCE_MAX_SIZE];
Sergeybef1f632023-03-06 15:25:06 -07004602 size_t required_nonce_size = 0;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004603
Paul Elliott8eb9daf2021-06-04 16:42:21 +01004604 *nonce_length = 0;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004605
Gilles Peskine449bd832023-01-11 14:50:10 +01004606 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004607 status = PSA_ERROR_BAD_STATE;
4608 goto exit;
4609 }
4610
Gilles Peskine449bd832023-01-11 14:50:10 +01004611 if (operation->nonce_set || !operation->is_encrypt) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004612 status = PSA_ERROR_BAD_STATE;
4613 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004614 }
4615
Paul Elliotte193ea82021-10-01 13:00:16 +01004616 /* For CCM, this size may not be correct according to the PSA
4617 * specification. The PSA Crypto 1.0.1 specification states:
4618 *
4619 * CCM encodes the plaintext length pLen in L octets, with L the smallest
4620 * integer >= 2 where pLen < 2^(8L). The nonce length is then 15 - L bytes.
4621 *
4622 * However this restriction that L has to be the smallest integer is not
4623 * applied in practice, and it is not implementable here since the
4624 * plaintext length may or may not be known at this time. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004625 required_nonce_size = PSA_AEAD_NONCE_LENGTH(operation->key_type,
4626 operation->alg);
4627 if (nonce_size < required_nonce_size) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004628 status = PSA_ERROR_BUFFER_TOO_SMALL;
4629 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004630 }
4631
Gilles Peskine449bd832023-01-11 14:50:10 +01004632 status = psa_generate_random(local_nonce, required_nonce_size);
4633 if (status != PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004634 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004635 }
Paul Elliott302ff6b2021-04-20 18:10:30 +01004636
Gilles Peskine449bd832023-01-11 14:50:10 +01004637 status = psa_aead_set_nonce(operation, local_nonce, required_nonce_size);
Paul Elliott302ff6b2021-04-20 18:10:30 +01004638
Paul Elliott39dc6b82021-05-11 19:16:09 +01004639exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004640 if (status == PSA_SUCCESS) {
4641 memcpy(nonce, local_nonce, required_nonce_size);
Paul Elliott39dc6b82021-05-11 19:16:09 +01004642 *nonce_length = required_nonce_size;
Gilles Peskine449bd832023-01-11 14:50:10 +01004643 } else {
4644 psa_aead_abort(operation);
Ronald Croncae59092021-11-26 18:53:58 +01004645 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01004646
Gilles Peskine449bd832023-01-11 14:50:10 +01004647 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004648}
4649
4650/* Set the nonce for a multipart authenticated encryption or decryption
4651 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004652psa_status_t psa_aead_set_nonce(psa_aead_operation_t *operation,
4653 const uint8_t *nonce,
4654 size_t nonce_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004655{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004656 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4657
Gilles Peskine449bd832023-01-11 14:50:10 +01004658 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004659 status = PSA_ERROR_BAD_STATE;
4660 goto exit;
4661 }
4662
Gilles Peskine449bd832023-01-11 14:50:10 +01004663 if (operation->nonce_set) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004664 status = PSA_ERROR_BAD_STATE;
4665 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004666 }
4667
Gilles Peskine449bd832023-01-11 14:50:10 +01004668 status = psa_aead_check_nonce_length(operation->alg, nonce_length);
4669 if (status != PSA_SUCCESS) {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004670 status = PSA_ERROR_INVALID_ARGUMENT;
4671 goto exit;
Paul Elliott4ed1ed12021-09-27 18:09:28 +01004672 }
Paul Elliott1a98aca2021-05-20 18:24:07 +01004673
Gilles Peskine449bd832023-01-11 14:50:10 +01004674 status = psa_driver_wrapper_aead_set_nonce(operation, nonce,
4675 nonce_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004676
Paul Elliott39dc6b82021-05-11 19:16:09 +01004677exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004678 if (status == PSA_SUCCESS) {
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004679 operation->nonce_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004680 } else {
4681 psa_aead_abort(operation);
4682 }
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004683
Gilles Peskine449bd832023-01-11 14:50:10 +01004684 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004685}
4686
4687/* Declare the lengths of the message and additional data for multipart AEAD. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004688psa_status_t psa_aead_set_lengths(psa_aead_operation_t *operation,
4689 size_t ad_length,
4690 size_t plaintext_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004691{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004692 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4693
Gilles Peskine449bd832023-01-11 14:50:10 +01004694 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004695 status = PSA_ERROR_BAD_STATE;
4696 goto exit;
4697 }
4698
Gilles Peskine449bd832023-01-11 14:50:10 +01004699 if (operation->lengths_set || operation->ad_started ||
4700 operation->body_started) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004701 status = PSA_ERROR_BAD_STATE;
4702 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004703 }
4704
Gilles Peskine449bd832023-01-11 14:50:10 +01004705 switch (operation->alg) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004706#if defined(PSA_WANT_ALG_GCM)
4707 case PSA_ALG_GCM:
4708 /* Lengths can only be too large for GCM if size_t is bigger than 32
Gilles Peskine449bd832023-01-11 14:50:10 +01004709 * bits. Without the guard this code will generate warnings on 32bit
4710 * builds. */
Paul Elliott325d3742021-09-27 17:56:28 +01004711#if SIZE_MAX > UINT32_MAX
Gilles Peskine449bd832023-01-11 14:50:10 +01004712 if (((uint64_t) ad_length) >> 61 != 0 ||
4713 ((uint64_t) plaintext_length) > 0xFFFFFFFE0ull) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004714 status = PSA_ERROR_INVALID_ARGUMENT;
4715 goto exit;
4716 }
Paul Elliott325d3742021-09-27 17:56:28 +01004717#endif
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004718 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004719#endif /* PSA_WANT_ALG_GCM */
4720#if defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004721 case PSA_ALG_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01004722 if (ad_length > 0xFF00) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004723 status = PSA_ERROR_INVALID_ARGUMENT;
4724 goto exit;
4725 }
4726 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004727#endif /* PSA_WANT_ALG_CCM */
4728#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004729 case PSA_ALG_CHACHA20_POLY1305:
4730 /* No length restrictions for ChaChaPoly. */
4731 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004732#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004733 default:
4734 break;
4735 }
Paul Elliott325d3742021-09-27 17:56:28 +01004736
Gilles Peskine449bd832023-01-11 14:50:10 +01004737 status = psa_driver_wrapper_aead_set_lengths(operation, ad_length,
4738 plaintext_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004739
Paul Elliott39dc6b82021-05-11 19:16:09 +01004740exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004741 if (status == PSA_SUCCESS) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01004742 operation->ad_remaining = ad_length;
4743 operation->body_remaining = plaintext_length;
Paul Elliott39dc6b82021-05-11 19:16:09 +01004744 operation->lengths_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004745 } else {
4746 psa_aead_abort(operation);
Paul Elliottee4ffe02021-05-20 17:25:06 +01004747 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01004748
Gilles Peskine449bd832023-01-11 14:50:10 +01004749 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004750}
Paul Elliott3d7d52c2021-09-01 10:33:14 +01004751
4752/* Pass additional data to an active multipart AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004753psa_status_t psa_aead_update_ad(psa_aead_operation_t *operation,
4754 const uint8_t *input,
4755 size_t input_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004756{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004757 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4758
Gilles Peskine449bd832023-01-11 14:50:10 +01004759 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004760 status = PSA_ERROR_BAD_STATE;
4761 goto exit;
4762 }
4763
Gilles Peskine449bd832023-01-11 14:50:10 +01004764 if (!operation->nonce_set || operation->body_started) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004765 status = PSA_ERROR_BAD_STATE;
4766 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004767 }
4768
Gilles Peskine449bd832023-01-11 14:50:10 +01004769 if (operation->lengths_set) {
4770 if (operation->ad_remaining < input_length) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01004771 status = PSA_ERROR_INVALID_ARGUMENT;
4772 goto exit;
4773 }
4774
4775 operation->ad_remaining -= input_length;
4776 }
Paul Elliotte193ea82021-10-01 13:00:16 +01004777#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004778 else if (operation->alg == PSA_ALG_CCM) {
Paul Elliotte193ea82021-10-01 13:00:16 +01004779 status = PSA_ERROR_BAD_STATE;
4780 goto exit;
4781 }
4782#endif /* PSA_WANT_ALG_CCM */
Paul Elliottee4ffe02021-05-20 17:25:06 +01004783
Gilles Peskine449bd832023-01-11 14:50:10 +01004784 status = psa_driver_wrapper_aead_update_ad(operation, input,
4785 input_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004786
Paul Elliott39dc6b82021-05-11 19:16:09 +01004787exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004788 if (status == PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004789 operation->ad_started = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004790 } else {
4791 psa_aead_abort(operation);
4792 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01004793
Gilles Peskine449bd832023-01-11 14:50:10 +01004794 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004795}
4796
4797/* Encrypt or decrypt a message fragment in an active multipart AEAD
4798 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004799psa_status_t psa_aead_update(psa_aead_operation_t *operation,
4800 const uint8_t *input,
4801 size_t input_length,
4802 uint8_t *output,
4803 size_t output_size,
4804 size_t *output_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004805{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004806 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004807
4808 *output_length = 0;
4809
Gilles Peskine449bd832023-01-11 14:50:10 +01004810 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004811 status = PSA_ERROR_BAD_STATE;
4812 goto exit;
4813 }
4814
Gilles Peskine449bd832023-01-11 14:50:10 +01004815 if (!operation->nonce_set) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004816 status = PSA_ERROR_BAD_STATE;
4817 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004818 }
4819
Gilles Peskine449bd832023-01-11 14:50:10 +01004820 if (operation->lengths_set) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01004821 /* Additional data length was supplied, but not all the additional
4822 data was supplied.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004823 if (operation->ad_remaining != 0) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01004824 status = PSA_ERROR_INVALID_ARGUMENT;
4825 goto exit;
4826 }
4827
4828 /* Too much data provided. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004829 if (operation->body_remaining < input_length) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01004830 status = PSA_ERROR_INVALID_ARGUMENT;
4831 goto exit;
4832 }
4833
4834 operation->body_remaining -= input_length;
4835 }
Paul Elliotte193ea82021-10-01 13:00:16 +01004836#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004837 else if (operation->alg == PSA_ALG_CCM) {
Paul Elliotte193ea82021-10-01 13:00:16 +01004838 status = PSA_ERROR_BAD_STATE;
4839 goto exit;
4840 }
4841#endif /* PSA_WANT_ALG_CCM */
Paul Elliottee4ffe02021-05-20 17:25:06 +01004842
Gilles Peskine449bd832023-01-11 14:50:10 +01004843 status = psa_driver_wrapper_aead_update(operation, input, input_length,
4844 output, output_size,
4845 output_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004846
Paul Elliott39dc6b82021-05-11 19:16:09 +01004847exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004848 if (status == PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004849 operation->body_started = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004850 } else {
4851 psa_aead_abort(operation);
4852 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01004853
Gilles Peskine449bd832023-01-11 14:50:10 +01004854 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004855}
4856
Gilles Peskine449bd832023-01-11 14:50:10 +01004857static psa_status_t psa_aead_final_checks(const psa_aead_operation_t *operation)
Paul Elliottad53dcc2021-06-23 08:50:14 +01004858{
Gilles Peskine449bd832023-01-11 14:50:10 +01004859 if (operation->id == 0 || !operation->nonce_set) {
4860 return PSA_ERROR_BAD_STATE;
4861 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01004862
Gilles Peskine449bd832023-01-11 14:50:10 +01004863 if (operation->lengths_set && (operation->ad_remaining != 0 ||
4864 operation->body_remaining != 0)) {
4865 return PSA_ERROR_INVALID_ARGUMENT;
4866 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01004867
Gilles Peskine449bd832023-01-11 14:50:10 +01004868 return PSA_SUCCESS;
Paul Elliottad53dcc2021-06-23 08:50:14 +01004869}
4870
Paul Elliott302ff6b2021-04-20 18:10:30 +01004871/* Finish encrypting a message in a multipart AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004872psa_status_t psa_aead_finish(psa_aead_operation_t *operation,
4873 uint8_t *ciphertext,
4874 size_t ciphertext_size,
4875 size_t *ciphertext_length,
4876 uint8_t *tag,
4877 size_t tag_size,
4878 size_t *tag_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004879{
Paul Elliott39dc6b82021-05-11 19:16:09 +01004880 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4881
Paul Elliott302ff6b2021-04-20 18:10:30 +01004882 *ciphertext_length = 0;
Paul Elliottf88a5652021-06-22 17:53:45 +01004883 *tag_length = tag_size;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004884
Gilles Peskine449bd832023-01-11 14:50:10 +01004885 status = psa_aead_final_checks(operation);
4886 if (status != PSA_SUCCESS) {
Paul Elliottad53dcc2021-06-23 08:50:14 +01004887 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004888 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01004889
Gilles Peskine449bd832023-01-11 14:50:10 +01004890 if (!operation->is_encrypt) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004891 status = PSA_ERROR_BAD_STATE;
4892 goto exit;
4893 }
4894
Gilles Peskine449bd832023-01-11 14:50:10 +01004895 status = psa_driver_wrapper_aead_finish(operation, ciphertext,
4896 ciphertext_size,
4897 ciphertext_length,
4898 tag, tag_size, tag_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004899
Paul Elliott39dc6b82021-05-11 19:16:09 +01004900exit:
Paul Elliottdc42ca82023-02-24 18:11:59 +00004901
4902
Paul Elliottf47b0952021-05-21 18:02:33 +01004903 /* In case the operation fails and the user fails to check for failure or
Paul Elliott4c916e82021-09-19 18:34:50 +01004904 * the zero tag size, make sure the tag is set to something implausible.
4905 * Even if the operation succeeds, make sure we clear the rest of the
4906 * buffer to prevent potential leakage of anything previously placed in
4907 * the same buffer.*/
Paul Elliottdc42ca82023-02-24 18:11:59 +00004908 psa_wipe_tag_output_buffer(tag, status, tag_size, *tag_length);
Paul Elliottf47b0952021-05-21 18:02:33 +01004909
Gilles Peskine449bd832023-01-11 14:50:10 +01004910 psa_aead_abort(operation);
Paul Elliott39dc6b82021-05-11 19:16:09 +01004911
Gilles Peskine449bd832023-01-11 14:50:10 +01004912 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004913}
4914
4915/* Finish authenticating and decrypting a message in a multipart AEAD
4916 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004917psa_status_t psa_aead_verify(psa_aead_operation_t *operation,
4918 uint8_t *plaintext,
4919 size_t plaintext_size,
4920 size_t *plaintext_length,
4921 const uint8_t *tag,
4922 size_t tag_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004923{
Paul Elliott39dc6b82021-05-11 19:16:09 +01004924 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4925
Paul Elliott302ff6b2021-04-20 18:10:30 +01004926 *plaintext_length = 0;
4927
Gilles Peskine449bd832023-01-11 14:50:10 +01004928 status = psa_aead_final_checks(operation);
4929 if (status != PSA_SUCCESS) {
Paul Elliottad53dcc2021-06-23 08:50:14 +01004930 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004931 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01004932
Gilles Peskine449bd832023-01-11 14:50:10 +01004933 if (operation->is_encrypt) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004934 status = PSA_ERROR_BAD_STATE;
4935 goto exit;
4936 }
4937
Gilles Peskine449bd832023-01-11 14:50:10 +01004938 status = psa_driver_wrapper_aead_verify(operation, plaintext,
4939 plaintext_size,
4940 plaintext_length,
4941 tag, tag_length);
Paul Elliott39dc6b82021-05-11 19:16:09 +01004942
4943exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004944 psa_aead_abort(operation);
Paul Elliott39dc6b82021-05-11 19:16:09 +01004945
Gilles Peskine449bd832023-01-11 14:50:10 +01004946 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004947}
4948
4949/* Abort an AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004950psa_status_t psa_aead_abort(psa_aead_operation_t *operation)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004951{
4952 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4953
Gilles Peskine449bd832023-01-11 14:50:10 +01004954 if (operation->id == 0) {
Paul Elliott302ff6b2021-04-20 18:10:30 +01004955 /* The object has (apparently) been initialized but it is not (yet)
4956 * in use. It's ok to call abort on such an object, and there's
4957 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004958 return PSA_SUCCESS;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004959 }
4960
Gilles Peskine449bd832023-01-11 14:50:10 +01004961 status = psa_driver_wrapper_aead_abort(operation);
Paul Elliott302ff6b2021-04-20 18:10:30 +01004962
Gilles Peskine449bd832023-01-11 14:50:10 +01004963 memset(operation, 0, sizeof(*operation));
Paul Elliott302ff6b2021-04-20 18:10:30 +01004964
Gilles Peskine449bd832023-01-11 14:50:10 +01004965 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004966}
4967
Gilles Peskinee59236f2018-01-27 23:32:46 +01004968/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02004969/* Generators */
4970/****************************************************************/
4971
Przemek Stekiel69c46792022-06-10 12:59:51 +02004972#if defined(BUILTIN_ALG_ANY_HKDF) || \
John Durkop07cc04a2020-11-16 22:08:34 -08004973 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
Andrzej Kurek08d34b82022-07-29 10:00:16 -04004974 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) || \
Kusumit Ghoderaoaf0b5342023-05-03 11:58:46 +05304975 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS) || \
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05304976 defined(PSA_HAVE_SOFT_PBKDF2)
John Durkop07cc04a2020-11-16 22:08:34 -08004977#define AT_LEAST_ONE_BUILTIN_KDF
Steven Cooreman094a77e2021-05-06 17:58:36 +02004978#endif /* At least one builtin KDF */
4979
Przemek Stekiel69c46792022-06-10 12:59:51 +02004980#if defined(BUILTIN_ALG_ANY_HKDF) || \
Steven Cooreman094a77e2021-05-06 17:58:36 +02004981 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4982 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4983static psa_status_t psa_key_derivation_start_hmac(
4984 psa_mac_operation_t *operation,
4985 psa_algorithm_t hash_alg,
4986 const uint8_t *hmac_key,
Gilles Peskine449bd832023-01-11 14:50:10 +01004987 size_t hmac_key_length)
Steven Cooreman094a77e2021-05-06 17:58:36 +02004988{
4989 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4990 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01004991 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
4992 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(hmac_key_length));
4993 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_HASH);
Steven Cooreman094a77e2021-05-06 17:58:36 +02004994
Steven Cooreman72f736a2021-05-07 14:14:37 +02004995 operation->is_sign = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004996 operation->mac_size = PSA_HASH_LENGTH(hash_alg);
Steven Cooreman72f736a2021-05-07 14:14:37 +02004997
Gilles Peskine449bd832023-01-11 14:50:10 +01004998 status = psa_driver_wrapper_mac_sign_setup(operation,
4999 &attributes,
5000 hmac_key, hmac_key_length,
5001 PSA_ALG_HMAC(hash_alg));
Steven Cooreman094a77e2021-05-06 17:58:36 +02005002
Gilles Peskine449bd832023-01-11 14:50:10 +01005003 psa_reset_key_attributes(&attributes);
5004 return status;
Steven Cooreman094a77e2021-05-06 17:58:36 +02005005}
5006#endif /* KDF algorithms reliant on HMAC */
John Durkop07cc04a2020-11-16 22:08:34 -08005007
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005008#define HKDF_STATE_INIT 0 /* no input yet */
5009#define HKDF_STATE_STARTED 1 /* got salt */
5010#define HKDF_STATE_KEYED 2 /* got key */
5011#define HKDF_STATE_OUTPUT 3 /* output started */
5012
Gilles Peskinecbe66502019-05-16 16:59:18 +02005013static psa_algorithm_t psa_key_derivation_get_kdf_alg(
Gilles Peskine449bd832023-01-11 14:50:10 +01005014 const psa_key_derivation_operation_t *operation)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005015{
Gilles Peskine449bd832023-01-11 14:50:10 +01005016 if (PSA_ALG_IS_KEY_AGREEMENT(operation->alg)) {
5017 return PSA_ALG_KEY_AGREEMENT_GET_KDF(operation->alg);
5018 } else {
5019 return operation->alg;
5020 }
Gilles Peskine969c5d62019-01-16 15:53:06 +01005021}
5022
Gilles Peskine449bd832023-01-11 14:50:10 +01005023psa_status_t psa_key_derivation_abort(psa_key_derivation_operation_t *operation)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005024{
5025 psa_status_t status = PSA_SUCCESS;
Gilles Peskine449bd832023-01-11 14:50:10 +01005026 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
5027 if (kdf_alg == 0) {
Gilles Peskineeab56e42018-07-12 17:12:33 +02005028 /* The object has (apparently) been initialized but it is not
5029 * in use. It's ok to call abort on such an object, and there's
5030 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005031 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02005032#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01005033 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
5034 mbedtls_free(operation->ctx.hkdf.info);
5035 status = psa_mac_abort(&operation->ctx.hkdf.hmac);
5036 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02005037#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08005038#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5039 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005040 if (PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
5041 /* TLS-1.2 PSK-to-MS KDF uses the same core as TLS-1.2 PRF */
5042 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
5043 if (operation->ctx.tls12_prf.secret != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005044 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.secret,
Gilles Peskine449bd832023-01-11 14:50:10 +01005045 operation->ctx.tls12_prf.secret_length);
Steven Cooremana6df6042021-04-29 19:32:25 +02005046 }
5047
Gilles Peskine449bd832023-01-11 14:50:10 +01005048 if (operation->ctx.tls12_prf.seed != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005049 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.seed,
Gilles Peskine449bd832023-01-11 14:50:10 +01005050 operation->ctx.tls12_prf.seed_length);
Janos Follath6a1d2622019-06-11 10:37:28 +01005051 }
5052
Gilles Peskine449bd832023-01-11 14:50:10 +01005053 if (operation->ctx.tls12_prf.label != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005054 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.label,
Gilles Peskine449bd832023-01-11 14:50:10 +01005055 operation->ctx.tls12_prf.label_length);
Janos Follath6a1d2622019-06-11 10:37:28 +01005056 }
Przemek Stekiel6c764412022-11-22 14:05:12 +01005057#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005058 if (operation->ctx.tls12_prf.other_secret != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005059 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.other_secret,
Gilles Peskine449bd832023-01-11 14:50:10 +01005060 operation->ctx.tls12_prf.other_secret_length);
Przemek Stekiele3ee2212022-04-07 14:29:56 +02005061 }
Przemek Stekiel6c764412022-11-22 14:05:12 +01005062#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Steven Cooremana6df6042021-04-29 19:32:25 +02005063 status = PSA_SUCCESS;
Janos Follath6a1d2622019-06-11 10:37:28 +01005064
5065 /* We leave the fields Ai and output_block to be erased safely by the
5066 * mbedtls_platform_zeroize() in the end of this function. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005067 } else
John Durkop07cc04a2020-11-16 22:08:34 -08005068#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
5069 * defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005070#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005071 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
5072 mbedtls_platform_zeroize(operation->ctx.tls12_ecjpake_to_pms.data,
5073 sizeof(operation->ctx.tls12_ecjpake_to_pms.data));
5074 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005075#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS) */
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305076#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05305077 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305078 if (operation->ctx.pbkdf2.salt != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005079 mbedtls_zeroize_and_free(operation->ctx.pbkdf2.salt,
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305080 operation->ctx.pbkdf2.salt_length);
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305081 }
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305082
5083 status = PSA_SUCCESS;
5084 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305085#endif /* defined(PSA_HAVE_SOFT_PBKDF2) */
Gilles Peskineeab56e42018-07-12 17:12:33 +02005086 {
5087 status = PSA_ERROR_BAD_STATE;
5088 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005089 mbedtls_platform_zeroize(operation, sizeof(*operation));
5090 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005091}
5092
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005093psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskine449bd832023-01-11 14:50:10 +01005094 size_t *capacity)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005095{
Gilles Peskine449bd832023-01-11 14:50:10 +01005096 if (operation->alg == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005097 /* This is a blank key derivation operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005098 return PSA_ERROR_BAD_STATE;
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005099 }
5100
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005101 *capacity = operation->capacity;
Gilles Peskine449bd832023-01-11 14:50:10 +01005102 return PSA_SUCCESS;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005103}
5104
Gilles Peskine449bd832023-01-11 14:50:10 +01005105psa_status_t psa_key_derivation_set_capacity(psa_key_derivation_operation_t *operation,
5106 size_t capacity)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005107{
Gilles Peskine449bd832023-01-11 14:50:10 +01005108 if (operation->alg == 0) {
5109 return PSA_ERROR_BAD_STATE;
5110 }
5111 if (capacity > operation->capacity) {
5112 return PSA_ERROR_INVALID_ARGUMENT;
5113 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005114 operation->capacity = capacity;
Gilles Peskine449bd832023-01-11 14:50:10 +01005115 return PSA_SUCCESS;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005116}
5117
Przemek Stekiel69c46792022-06-10 12:59:51 +02005118#if defined(BUILTIN_ALG_ANY_HKDF)
Przemek Stekiel03d948c2022-05-19 11:45:20 +02005119/* Read some bytes from an HKDF-based operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005120static psa_status_t psa_key_derivation_hkdf_read(psa_hkdf_key_derivation_t *hkdf,
5121 psa_algorithm_t kdf_alg,
5122 uint8_t *output,
5123 size_t output_length)
Gilles Peskinebef7f142018-07-12 17:22:21 +02005124{
Gilles Peskine449bd832023-01-11 14:50:10 +01005125 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
5126 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Steven Cooremand1ed1d92021-04-29 19:11:25 +02005127 size_t hmac_output_length;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005128 psa_status_t status;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005129#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01005130 const uint8_t last_block = PSA_ALG_IS_HKDF_EXTRACT(kdf_alg) ? 0 : 0xff;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005131#else
5132 const uint8_t last_block = 0xff;
5133#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskinebef7f142018-07-12 17:22:21 +02005134
Gilles Peskine449bd832023-01-11 14:50:10 +01005135 if (hkdf->state < HKDF_STATE_KEYED ||
5136 (!hkdf->info_set
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005137#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01005138 && !PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005139#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01005140 )) {
5141 return PSA_ERROR_BAD_STATE;
5142 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005143 hkdf->state = HKDF_STATE_OUTPUT;
5144
Gilles Peskine449bd832023-01-11 14:50:10 +01005145 while (output_length != 0) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005146 /* Copy what remains of the current block */
5147 uint8_t n = hash_length - hkdf->offset_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005148 if (n > output_length) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005149 n = (uint8_t) output_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01005150 }
5151 memcpy(output, hkdf->output_block + hkdf->offset_in_block, n);
Gilles Peskinebef7f142018-07-12 17:22:21 +02005152 output += n;
5153 output_length -= n;
5154 hkdf->offset_in_block += n;
Gilles Peskine449bd832023-01-11 14:50:10 +01005155 if (output_length == 0) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005156 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01005157 }
Przemek Stekiel03d948c2022-05-19 11:45:20 +02005158 /* We can't be wanting more output after the last block, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005159 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005160 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02005161 * object was corrupted or if this function is called directly
5162 * inside the library. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005163 if (hkdf->block_number == last_block) {
5164 return PSA_ERROR_BAD_STATE;
5165 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02005166
5167 /* We need a new block */
5168 ++hkdf->block_number;
5169 hkdf->offset_in_block = 0;
Steven Cooremand1ed1d92021-04-29 19:11:25 +02005170
Gilles Peskine449bd832023-01-11 14:50:10 +01005171 status = psa_key_derivation_start_hmac(&hkdf->hmac,
5172 hash_alg,
5173 hkdf->prk,
5174 hash_length);
5175 if (status != PSA_SUCCESS) {
5176 return status;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005177 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005178
5179 if (hkdf->block_number != 1) {
5180 status = psa_mac_update(&hkdf->hmac,
5181 hkdf->output_block,
5182 hash_length);
5183 if (status != PSA_SUCCESS) {
5184 return status;
5185 }
5186 }
5187 status = psa_mac_update(&hkdf->hmac,
5188 hkdf->info,
5189 hkdf->info_length);
5190 if (status != PSA_SUCCESS) {
5191 return status;
5192 }
5193 status = psa_mac_update(&hkdf->hmac,
5194 &hkdf->block_number, 1);
5195 if (status != PSA_SUCCESS) {
5196 return status;
5197 }
5198 status = psa_mac_sign_finish(&hkdf->hmac,
5199 hkdf->output_block,
5200 sizeof(hkdf->output_block),
5201 &hmac_output_length);
5202 if (status != PSA_SUCCESS) {
5203 return status;
5204 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02005205 }
5206
Gilles Peskine449bd832023-01-11 14:50:10 +01005207 return PSA_SUCCESS;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005208}
Przemek Stekiel69c46792022-06-10 12:59:51 +02005209#endif /* BUILTIN_ALG_ANY_HKDF */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005210
John Durkop07cc04a2020-11-16 22:08:34 -08005211#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5212 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follath7742fee2019-06-17 12:58:10 +01005213static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
5214 psa_tls12_prf_key_derivation_t *tls12_prf,
Gilles Peskine449bd832023-01-11 14:50:10 +01005215 psa_algorithm_t alg)
Janos Follath7742fee2019-06-17 12:58:10 +01005216{
Gilles Peskine449bd832023-01-11 14:50:10 +01005217 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(alg);
5218 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Steven Cooremana6df6042021-04-29 19:32:25 +02005219 psa_mac_operation_t hmac = PSA_MAC_OPERATION_INIT;
5220 size_t hmac_output_length;
Janos Follathea29bfb2019-06-19 12:21:20 +01005221 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005222
Janos Follath7742fee2019-06-17 12:58:10 +01005223 /* We can't be wanting more output after block 0xff, otherwise
5224 * the capacity check in psa_key_derivation_output_bytes() would have
5225 * prevented this call. It could happen only if the operation
5226 * object was corrupted or if this function is called directly
5227 * inside the library. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005228 if (tls12_prf->block_number == 0xff) {
5229 return PSA_ERROR_CORRUPTION_DETECTED;
5230 }
Janos Follath7742fee2019-06-17 12:58:10 +01005231
5232 /* We need a new block */
5233 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01005234 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01005235
5236 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
5237 *
5238 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
5239 *
5240 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
5241 * HMAC_hash(secret, A(2) + seed) +
5242 * HMAC_hash(secret, A(3) + seed) + ...
5243 *
5244 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01005245 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01005246 *
Janos Follathea29bfb2019-06-19 12:21:20 +01005247 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01005248 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01005249 * is currently extracted as `output_block` and where i is
5250 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01005251 */
5252
Gilles Peskine449bd832023-01-11 14:50:10 +01005253 status = psa_key_derivation_start_hmac(&hmac,
5254 hash_alg,
5255 tls12_prf->secret,
5256 tls12_prf->secret_length);
5257 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005258 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005259 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005260
5261 /* Calculate A(i) where i = tls12_prf->block_number. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005262 if (tls12_prf->block_number == 1) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005263 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
5264 * the variable seed and in this instance means it in the context of the
5265 * P_hash function, where seed = label + seed.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01005266 status = psa_mac_update(&hmac,
5267 tls12_prf->label,
5268 tls12_prf->label_length);
5269 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005270 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005271 }
5272 status = psa_mac_update(&hmac,
5273 tls12_prf->seed,
5274 tls12_prf->seed_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 } else {
Janos Follathea29bfb2019-06-19 12:21:20 +01005279 /* A(i) = HMAC_hash(secret, A(i-1)) */
Gilles Peskine449bd832023-01-11 14:50:10 +01005280 status = psa_mac_update(&hmac, tls12_prf->Ai, hash_length);
5281 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005282 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005283 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005284 }
5285
Gilles Peskine449bd832023-01-11 14:50:10 +01005286 status = psa_mac_sign_finish(&hmac,
5287 tls12_prf->Ai, hash_length,
5288 &hmac_output_length);
5289 if (hmac_output_length != hash_length) {
Steven Cooremana6df6042021-04-29 19:32:25 +02005290 status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01005291 }
5292 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005293 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005294 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005295
5296 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
Gilles Peskine449bd832023-01-11 14:50:10 +01005297 status = psa_key_derivation_start_hmac(&hmac,
5298 hash_alg,
5299 tls12_prf->secret,
5300 tls12_prf->secret_length);
5301 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005302 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005303 }
5304 status = psa_mac_update(&hmac, tls12_prf->Ai, hash_length);
5305 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005306 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005307 }
5308 status = psa_mac_update(&hmac, tls12_prf->label, tls12_prf->label_length);
5309 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005310 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005311 }
5312 status = psa_mac_update(&hmac, tls12_prf->seed, tls12_prf->seed_length);
5313 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005314 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005315 }
5316 status = psa_mac_sign_finish(&hmac,
5317 tls12_prf->output_block, hash_length,
5318 &hmac_output_length);
5319 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005320 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005321 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005322
Janos Follath7742fee2019-06-17 12:58:10 +01005323
5324cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01005325 cleanup_status = psa_mac_abort(&hmac);
5326 if (status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005327 status = cleanup_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01005328 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005329
Gilles Peskine449bd832023-01-11 14:50:10 +01005330 return status;
Janos Follath7742fee2019-06-17 12:58:10 +01005331}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005332
Janos Follath844eb0e2019-06-19 12:10:49 +01005333static psa_status_t psa_key_derivation_tls12_prf_read(
5334 psa_tls12_prf_key_derivation_t *tls12_prf,
5335 psa_algorithm_t alg,
5336 uint8_t *output,
Gilles Peskine449bd832023-01-11 14:50:10 +01005337 size_t output_length)
Janos Follath844eb0e2019-06-19 12:10:49 +01005338{
Gilles Peskine449bd832023-01-11 14:50:10 +01005339 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH(alg);
5340 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Janos Follath844eb0e2019-06-19 12:10:49 +01005341 psa_status_t status;
5342 uint8_t offset, length;
5343
Gilles Peskine449bd832023-01-11 14:50:10 +01005344 switch (tls12_prf->state) {
Gilles Peskineb1edaec2021-06-11 22:41:46 +02005345 case PSA_TLS12_PRF_STATE_LABEL_SET:
5346 tls12_prf->state = PSA_TLS12_PRF_STATE_OUTPUT;
5347 break;
5348 case PSA_TLS12_PRF_STATE_OUTPUT:
5349 break;
5350 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005351 return PSA_ERROR_BAD_STATE;
Gilles Peskineb1edaec2021-06-11 22:41:46 +02005352 }
5353
Gilles Peskine449bd832023-01-11 14:50:10 +01005354 while (output_length != 0) {
Janos Follath844eb0e2019-06-19 12:10:49 +01005355 /* Check if we have fully processed the current block. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005356 if (tls12_prf->left_in_block == 0) {
5357 status = psa_key_derivation_tls12_prf_generate_next_block(tls12_prf,
5358 alg);
5359 if (status != PSA_SUCCESS) {
5360 return status;
5361 }
Janos Follath844eb0e2019-06-19 12:10:49 +01005362
5363 continue;
5364 }
5365
Gilles Peskine449bd832023-01-11 14:50:10 +01005366 if (tls12_prf->left_in_block > output_length) {
Janos Follath844eb0e2019-06-19 12:10:49 +01005367 length = (uint8_t) output_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01005368 } else {
Janos Follath844eb0e2019-06-19 12:10:49 +01005369 length = tls12_prf->left_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005370 }
Janos Follath844eb0e2019-06-19 12:10:49 +01005371
5372 offset = hash_length - tls12_prf->left_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005373 memcpy(output, tls12_prf->output_block + offset, length);
Janos Follath844eb0e2019-06-19 12:10:49 +01005374 output += length;
5375 output_length -= length;
5376 tls12_prf->left_in_block -= length;
5377 }
5378
Gilles Peskine449bd832023-01-11 14:50:10 +01005379 return PSA_SUCCESS;
Janos Follath844eb0e2019-06-19 12:10:49 +01005380}
John Durkop07cc04a2020-11-16 22:08:34 -08005381#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
5382 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskinebef7f142018-07-12 17:22:21 +02005383
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005384#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
5385static psa_status_t psa_key_derivation_tls12_ecjpake_to_pms_read(
5386 psa_tls12_ecjpake_to_pms_t *ecjpake,
5387 uint8_t *output,
Gilles Peskine449bd832023-01-11 14:50:10 +01005388 size_t output_length)
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005389{
5390 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Andrzej Kurek5603efd2022-09-26 10:49:16 -04005391 size_t output_size = 0;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005392
Gilles Peskine449bd832023-01-11 14:50:10 +01005393 if (output_length != 32) {
5394 return PSA_ERROR_INVALID_ARGUMENT;
5395 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005396
Gilles Peskine449bd832023-01-11 14:50:10 +01005397 status = psa_hash_compute(PSA_ALG_SHA_256, ecjpake->data,
5398 PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE, output, output_length,
5399 &output_size);
5400 if (status != PSA_SUCCESS) {
5401 return status;
5402 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005403
Gilles Peskine449bd832023-01-11 14:50:10 +01005404 if (output_size != output_length) {
5405 return PSA_ERROR_GENERIC_ERROR;
5406 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005407
Gilles Peskine449bd832023-01-11 14:50:10 +01005408 return PSA_SUCCESS;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005409}
5410#endif
5411
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305412#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305413static psa_status_t psa_key_derivation_pbkdf2_generate_block(
5414 psa_pbkdf2_key_derivation_t *pbkdf2,
5415 psa_algorithm_t prf_alg,
5416 uint8_t prf_output_length,
5417 psa_key_attributes_t *attributes)
5418{
5419 psa_status_t status;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305420 psa_mac_operation_t mac_operation = PSA_MAC_OPERATION_INIT;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305421 size_t mac_output_length;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305422 uint8_t U_i[PSA_MAC_MAX_SIZE];
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305423 uint8_t *U_accumulator = pbkdf2->output_block;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305424 uint64_t i;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305425 uint8_t block_counter[4];
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305426
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305427 mac_operation.is_sign = 1;
5428 mac_operation.mac_size = prf_output_length;
5429 MBEDTLS_PUT_UINT32_BE(pbkdf2->block_number, block_counter, 0);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305430
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305431 status = psa_driver_wrapper_mac_sign_setup(&mac_operation,
5432 attributes,
5433 pbkdf2->password,
5434 pbkdf2->password_length,
5435 prf_alg);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305436 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305437 goto cleanup;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305438 }
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305439 status = psa_mac_update(&mac_operation, pbkdf2->salt, pbkdf2->salt_length);
5440 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305441 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305442 }
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305443 status = psa_mac_update(&mac_operation, block_counter, sizeof(block_counter));
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305444 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305445 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305446 }
5447 status = psa_mac_sign_finish(&mac_operation, U_i, sizeof(U_i),
5448 &mac_output_length);
5449 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305450 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305451 }
5452
5453 if (mac_output_length != prf_output_length) {
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305454 status = PSA_ERROR_CORRUPTION_DETECTED;
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305455 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305456 }
5457
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305458 memcpy(U_accumulator, U_i, prf_output_length);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305459
5460 for (i = 1; i < pbkdf2->input_cost; i++) {
Kusumit Ghoderao4536bb62023-06-22 15:42:59 +05305461 /* We are passing prf_output_length as mac_size because the driver
5462 * function directly sets mac_output_length as mac_size upon success.
Kusumit Ghoderao5f3345a2023-07-27 21:21:38 +05305463 * See https://github.com/Mbed-TLS/mbedtls/issues/7801 */
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305464 status = psa_driver_wrapper_mac_compute(attributes,
5465 pbkdf2->password,
5466 pbkdf2->password_length,
5467 prf_alg, U_i, prf_output_length,
Kusumit Ghoderao4536bb62023-06-22 15:42:59 +05305468 U_i, prf_output_length,
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305469 &mac_output_length);
5470 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305471 goto cleanup;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305472 }
5473
Kusumit Ghoderao109ee3d2023-06-08 16:36:45 +05305474 mbedtls_xor(U_accumulator, U_accumulator, U_i, prf_output_length);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305475 }
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305476
5477cleanup:
5478 /* Zeroise buffers to clear sensitive data from memory. */
5479 mbedtls_platform_zeroize(U_i, PSA_MAC_MAX_SIZE);
5480 return status;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305481}
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05305482
5483static psa_status_t psa_key_derivation_pbkdf2_read(
5484 psa_pbkdf2_key_derivation_t *pbkdf2,
5485 psa_algorithm_t kdf_alg,
5486 uint8_t *output,
5487 size_t output_length)
5488{
5489 psa_status_t status;
5490 psa_algorithm_t prf_alg;
5491 uint8_t prf_output_length;
5492 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
5493 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(pbkdf2->password_length));
5494 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
5495
5496 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
5497 prf_alg = PSA_ALG_HMAC(PSA_ALG_PBKDF2_HMAC_GET_HASH(kdf_alg));
5498 prf_output_length = PSA_HASH_LENGTH(prf_alg);
5499 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
Kusumit Ghoderaoa2520a52023-06-22 15:42:19 +05305500 } else if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
5501 prf_alg = PSA_ALG_CMAC;
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05305502 prf_output_length = PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC);
Kusumit Ghoderaoa2520a52023-06-22 15:42:19 +05305503 psa_set_key_type(&attributes, PSA_KEY_TYPE_AES);
Kusumit Ghoderaod9ec1af2023-06-08 20:19:51 +05305504 } else {
5505 return PSA_ERROR_INVALID_ARGUMENT;
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05305506 }
5507
5508 switch (pbkdf2->state) {
5509 case PSA_PBKDF2_STATE_PASSWORD_SET:
5510 /* Initially we need a new block so bytes_used is equal to block size*/
5511 pbkdf2->bytes_used = prf_output_length;
5512 pbkdf2->state = PSA_PBKDF2_STATE_OUTPUT;
5513 break;
5514 case PSA_PBKDF2_STATE_OUTPUT:
5515 break;
5516 default:
5517 return PSA_ERROR_BAD_STATE;
5518 }
5519
5520 while (output_length != 0) {
5521 uint8_t n = prf_output_length - pbkdf2->bytes_used;
5522 if (n > output_length) {
5523 n = (uint8_t) output_length;
5524 }
5525 memcpy(output, pbkdf2->output_block + pbkdf2->bytes_used, n);
5526 output += n;
5527 output_length -= n;
5528 pbkdf2->bytes_used += n;
5529
5530 if (output_length == 0) {
5531 break;
5532 }
5533
5534 /* We need a new block */
5535 pbkdf2->bytes_used = 0;
5536 pbkdf2->block_number++;
5537
5538 status = psa_key_derivation_pbkdf2_generate_block(pbkdf2, prf_alg,
5539 prf_output_length,
5540 &attributes);
5541 if (status != PSA_SUCCESS) {
5542 return status;
5543 }
5544 }
5545
5546 return PSA_SUCCESS;
5547}
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305548#endif /* PSA_HAVE_SOFT_PBKDF2 */
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305549
Janos Follath6c6c8fc2019-06-17 12:38:20 +01005550psa_status_t psa_key_derivation_output_bytes(
5551 psa_key_derivation_operation_t *operation,
5552 uint8_t *output,
Gilles Peskine449bd832023-01-11 14:50:10 +01005553 size_t output_length)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005554{
5555 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01005556 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
Gilles Peskineeab56e42018-07-12 17:12:33 +02005557
Gilles Peskine449bd832023-01-11 14:50:10 +01005558 if (operation->alg == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005559 /* This is a blank operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005560 return PSA_ERROR_BAD_STATE;
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005561 }
5562
Gilles Peskine449bd832023-01-11 14:50:10 +01005563 if (output_length > operation->capacity) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005564 operation->capacity = 0;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005565 /* Go through the error path to wipe all confidential data now
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005566 * that the operation object is useless. */
David Saadab4ecc272019-02-14 13:48:10 +02005567 status = PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005568 goto exit;
5569 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005570 if (output_length == 0 && operation->capacity == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005571 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005572 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02005573 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
5574 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005575 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02005576 * output_length > 0. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005577 return PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005578 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005579 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005580
Przemek Stekiel69c46792022-06-10 12:59:51 +02005581#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01005582 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
5583 status = psa_key_derivation_hkdf_read(&operation->ctx.hkdf, kdf_alg,
5584 output, output_length);
5585 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02005586#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08005587#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5588 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005589 if (PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
5590 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
5591 status = psa_key_derivation_tls12_prf_read(&operation->ctx.tls12_prf,
5592 kdf_alg, output,
5593 output_length);
5594 } else
John Durkop07cc04a2020-11-16 22:08:34 -08005595#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
5596 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005597#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005598 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005599 status = psa_key_derivation_tls12_ecjpake_to_pms_read(
Gilles Peskine449bd832023-01-11 14:50:10 +01005600 &operation->ctx.tls12_ecjpake_to_pms, output, output_length);
5601 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005602#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305603#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05305604 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05305605 status = psa_key_derivation_pbkdf2_read(&operation->ctx.pbkdf2, kdf_alg,
5606 output, output_length);
Kusumit Ghoderao056f0c52023-05-03 15:58:34 +05305607 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305608#endif /* PSA_HAVE_SOFT_PBKDF2 */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005609
Gilles Peskineeab56e42018-07-12 17:12:33 +02005610 {
Steven Cooreman74afe472021-02-10 17:19:22 +01005611 (void) kdf_alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01005612 return PSA_ERROR_BAD_STATE;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005613 }
5614
5615exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005616 if (status != PSA_SUCCESS) {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005617 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005618 * This allows us to differentiate between exhausted operations and
5619 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
5620 * operations. */
5621 psa_algorithm_t alg = operation->alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01005622 psa_key_derivation_abort(operation);
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005623 operation->alg = alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01005624 memset(output, '!', output_length);
Gilles Peskineeab56e42018-07-12 17:12:33 +02005625 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005626 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005627}
5628
David Brown7807bf72021-02-09 16:28:23 -07005629#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01005630static void psa_des_set_key_parity(uint8_t *data, size_t data_size)
Gilles Peskine08542d82018-07-19 17:05:42 +02005631{
Gilles Peskine449bd832023-01-11 14:50:10 +01005632 if (data_size >= 8) {
5633 mbedtls_des_key_set_parity(data);
5634 }
5635 if (data_size >= 16) {
5636 mbedtls_des_key_set_parity(data + 8);
5637 }
5638 if (data_size >= 24) {
5639 mbedtls_des_key_set_parity(data + 16);
5640 }
Gilles Peskine08542d82018-07-19 17:05:42 +02005641}
David Brown7807bf72021-02-09 16:28:23 -07005642#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine08542d82018-07-19 17:05:42 +02005643
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005644/*
Gilles Peskine449bd832023-01-11 14:50:10 +01005645 * ECC keys on a Weierstrass elliptic curve require the generation
5646 * of a private key which is an integer
5647 * in the range [1, N - 1], where N is the boundary of the private key domain:
5648 * N is the prime p for Diffie-Hellman, or the order of the
5649 * curve’s base point for ECC.
5650 *
5651 * Let m be the bit size of N, such that 2^m > N >= 2^(m-1).
5652 * This function generates the private key using the following process:
5653 *
5654 * 1. Draw a byte string of length ceiling(m/8) bytes.
5655 * 2. If m is not a multiple of 8, set the most significant
5656 * (8 * ceiling(m/8) - m) bits of the first byte in the string to zero.
5657 * 3. Convert the string to integer k by decoding it as a big-endian byte string.
5658 * 4. If k > N - 2, discard the result and return to step 1.
5659 * 5. Output k + 1 as the private key.
5660 *
5661 * This method allows compliance to NIST standards, specifically the methods titled
5662 * Key-Pair Generation by Testing Candidates in the following publications:
5663 * - NIST Special Publication 800-56A: Recommendation for Pair-Wise Key-Establishment
5664 * Schemes Using Discrete Logarithm Cryptography [SP800-56A] §5.6.1.1.4 for
5665 * Diffie-Hellman keys.
5666 *
5667 * - [SP800-56A] §5.6.1.2.2 or FIPS Publication 186-4: Digital Signature
5668 * Standard (DSS) [FIPS186-4] §B.4.2 for elliptic curve keys.
5669 *
5670 * Note: Function allocates memory for *data buffer, so given *data should be
5671 * always NULL.
5672 */
Valerio Setti86587ab2023-06-27 13:09:30 +02005673#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE)
5674#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE)
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01005675static psa_status_t psa_generate_derived_ecc_key_weierstrass_helper(
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005676 psa_key_slot_t *slot,
5677 size_t bits,
5678 psa_key_derivation_operation_t *operation,
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005679 uint8_t **data
5680 )
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005681{
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005682 unsigned key_out_of_range = 1;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005683 mbedtls_mpi k;
5684 mbedtls_mpi diff_N_2;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005685 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Przemek Stekiela81aed22022-03-01 15:13:30 +01005686 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01005687 size_t m;
5688 size_t m_bytes;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005689
Gilles Peskine449bd832023-01-11 14:50:10 +01005690 mbedtls_mpi_init(&k);
5691 mbedtls_mpi_init(&diff_N_2);
Przemyslaw Stekiel1dfd1222021-11-18 13:35:00 +01005692
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005693 psa_ecc_family_t curve = PSA_KEY_TYPE_ECC_GET_FAMILY(
Gilles Peskine449bd832023-01-11 14:50:10 +01005694 slot->attr.type);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005695 mbedtls_ecp_group_id grp_id =
Gilles Peskine449bd832023-01-11 14:50:10 +01005696 mbedtls_ecc_group_of_psa(curve, bits, 0);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005697
Gilles Peskine449bd832023-01-11 14:50:10 +01005698 if (grp_id == MBEDTLS_ECP_DP_NONE) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005699 ret = MBEDTLS_ERR_ASN1_INVALID_DATA;
Przemyslaw Stekiel871a3362021-12-02 08:46:39 +01005700 goto cleanup;
5701 }
5702
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005703 mbedtls_ecp_group ecp_group;
Gilles Peskine449bd832023-01-11 14:50:10 +01005704 mbedtls_ecp_group_init(&ecp_group);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005705
Gilles Peskine449bd832023-01-11 14:50:10 +01005706 MBEDTLS_MPI_CHK(mbedtls_ecp_group_load(&ecp_group, grp_id));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005707
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005708 /* N is the boundary of the private key domain (ecp_group.N). */
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005709 /* Let m be the bit size of N. */
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01005710 m = ecp_group.nbits;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005711
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01005712 m_bytes = PSA_BITS_TO_BYTES(m);
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005713
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005714 /* Calculate N - 2 - it will be needed later. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005715 MBEDTLS_MPI_CHK(mbedtls_mpi_sub_int(&diff_N_2, &ecp_group.N, 2));
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005716
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005717 /* Note: This function is always called with *data == NULL and it
5718 * allocates memory for the data buffer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005719 *data = mbedtls_calloc(1, m_bytes);
5720 if (*data == NULL) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005721 ret = MBEDTLS_ERR_ASN1_ALLOC_FAILED;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005722 goto cleanup;
5723 }
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005724
Gilles Peskine449bd832023-01-11 14:50:10 +01005725 while (key_out_of_range) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005726 /* 1. Draw a byte string of length ceiling(m/8) bytes. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005727 if ((status = psa_key_derivation_output_bytes(operation, *data, m_bytes)) != 0) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005728 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005729 }
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005730
5731 /* 2. If m is not a multiple of 8 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005732 if (m % 8 != 0) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005733 /* Set the most significant
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005734 * (8 * ceiling(m/8) - m) bits of the first byte in
5735 * the string to zero.
5736 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005737 uint8_t clear_bit_mask = (1 << (m % 8)) - 1;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005738 (*data)[0] &= clear_bit_mask;
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005739 }
5740
5741 /* 3. Convert the string to integer k by decoding it as a
Gilles Peskine449bd832023-01-11 14:50:10 +01005742 * big-endian byte string.
5743 */
5744 MBEDTLS_MPI_CHK(mbedtls_mpi_read_binary(&k, *data, m_bytes));
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005745
5746 /* 4. If k > N - 2, discard the result and return to step 1.
Gilles Peskine449bd832023-01-11 14:50:10 +01005747 * Result of comparison is returned. When it indicates error
5748 * then this function is called again.
5749 */
5750 MBEDTLS_MPI_CHK(mbedtls_mpi_lt_mpi_ct(&diff_N_2, &k, &key_out_of_range));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005751 }
5752
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005753 /* 5. Output k + 1 as the private key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005754 MBEDTLS_MPI_CHK(mbedtls_mpi_add_int(&k, &k, 1));
5755 MBEDTLS_MPI_CHK(mbedtls_mpi_write_binary(&k, *data, m_bytes));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005756cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01005757 if (ret != 0) {
5758 status = mbedtls_to_psa_error(ret);
5759 }
5760 if (status != PSA_SUCCESS) {
5761 mbedtls_free(*data);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005762 *data = NULL;
5763 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005764 mbedtls_mpi_free(&k);
5765 mbedtls_mpi_free(&diff_N_2);
5766 return status;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005767}
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005768
5769/* ECC keys on a Montgomery elliptic curve draws a byte string whose length
5770 * is determined by the curve, and sets the mandatory bits accordingly. That is:
5771 *
5772 * - Curve25519 (PSA_ECC_FAMILY_MONTGOMERY, 255 bits):
5773 * draw a 32-byte string and process it as specified in
5774 * Elliptic Curves for Security [RFC7748] §5.
5775 *
5776 * - Curve448 (PSA_ECC_FAMILY_MONTGOMERY, 448 bits):
5777 * draw a 56-byte string and process it as specified in [RFC7748] §5.
5778 *
5779 * Note: Function allocates memory for *data buffer, so given *data should be
5780 * always NULL.
5781 */
5782
5783static psa_status_t psa_generate_derived_ecc_key_montgomery_helper(
5784 size_t bits,
5785 psa_key_derivation_operation_t *operation,
5786 uint8_t **data
5787 )
5788{
5789 size_t output_length;
Przemek Stekiela81aed22022-03-01 15:13:30 +01005790 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005791
Gilles Peskine449bd832023-01-11 14:50:10 +01005792 switch (bits) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005793 case 255:
5794 output_length = 32;
5795 break;
5796 case 448:
5797 output_length = 56;
5798 break;
5799 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005800 return PSA_ERROR_INVALID_ARGUMENT;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005801 break;
5802 }
5803
Gilles Peskine449bd832023-01-11 14:50:10 +01005804 *data = mbedtls_calloc(1, output_length);
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005805
Gilles Peskine449bd832023-01-11 14:50:10 +01005806 if (*data == NULL) {
5807 return PSA_ERROR_INSUFFICIENT_MEMORY;
5808 }
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005809
Gilles Peskine449bd832023-01-11 14:50:10 +01005810 status = psa_key_derivation_output_bytes(operation, *data, output_length);
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005811
Gilles Peskine449bd832023-01-11 14:50:10 +01005812 if (status != PSA_SUCCESS) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005813 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01005814 }
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005815
Gilles Peskine449bd832023-01-11 14:50:10 +01005816 switch (bits) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005817 case 255:
5818 (*data)[0] &= 248;
5819 (*data)[31] &= 127;
5820 (*data)[31] |= 64;
5821 break;
5822 case 448:
5823 (*data)[0] &= 252;
5824 (*data)[55] |= 128;
5825 break;
5826 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005827 return PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005828 break;
5829 }
5830
5831 return status;
5832}
Valerio Setti86587ab2023-06-27 13:09:30 +02005833#else /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE */
5834static psa_status_t psa_generate_derived_ecc_key_weierstrass_helper(
5835 psa_key_slot_t *slot, size_t bits,
5836 psa_key_derivation_operation_t *operation, uint8_t **data)
5837{
5838 (void) slot;
5839 (void) bits;
5840 (void) operation;
5841 (void) data;
5842 return PSA_ERROR_NOT_SUPPORTED;
5843}
5844
5845static psa_status_t psa_generate_derived_ecc_key_montgomery_helper(
5846 size_t bits, psa_key_derivation_operation_t *operation, uint8_t **data)
5847{
5848 (void) bits;
5849 (void) operation;
5850 (void) data;
5851 return PSA_ERROR_NOT_SUPPORTED;
5852}
5853#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE */
5854#endif /* PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE */
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005855
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01005856static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005857 psa_key_slot_t *slot,
5858 size_t bits,
Gilles Peskine449bd832023-01-11 14:50:10 +01005859 psa_key_derivation_operation_t *operation)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005860{
5861 uint8_t *data = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01005862 size_t bytes = PSA_BITS_TO_BYTES(bits);
Archanad8a83dc2021-06-14 10:04:16 +05305863 size_t storage_size = bytes;
Przemek Stekiela81aed22022-03-01 15:13:30 +01005864 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01005865 psa_key_attributes_t attributes;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005866
Gilles Peskine449bd832023-01-11 14:50:10 +01005867 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(slot->attr.type)) {
5868 return PSA_ERROR_INVALID_ARGUMENT;
5869 }
Gilles Peskineeab56e42018-07-12 17:12:33 +02005870
Valerio Setti8ffdb5d2023-06-20 13:14:08 +02005871#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE) || \
Valerio Settidd24f292023-06-26 12:21:17 +02005872 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE)
Gilles Peskine449bd832023-01-11 14:50:10 +01005873 if (PSA_KEY_TYPE_IS_ECC(slot->attr.type)) {
5874 psa_ecc_family_t curve = PSA_KEY_TYPE_ECC_GET_FAMILY(slot->attr.type);
5875 if (PSA_ECC_FAMILY_IS_WEIERSTRASS(curve)) {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01005876 /* Weierstrass elliptic curve */
Gilles Peskine449bd832023-01-11 14:50:10 +01005877 status = psa_generate_derived_ecc_key_weierstrass_helper(slot, bits, operation, &data);
5878 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005879 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005880 }
5881 } else {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01005882 /* Montgomery elliptic curve */
Gilles Peskine449bd832023-01-11 14:50:10 +01005883 status = psa_generate_derived_ecc_key_montgomery_helper(bits, operation, &data);
5884 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01005885 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005886 }
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01005887 }
Przemyslaw Stekiel1dfd1222021-11-18 13:35:00 +01005888 } else
Valerio Setti8ffdb5d2023-06-20 13:14:08 +02005889#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE) ||
Valerio Settidd24f292023-06-26 12:21:17 +02005890 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE) */
Gilles Peskine449bd832023-01-11 14:50:10 +01005891 if (key_type_is_raw_bytes(slot->attr.type)) {
5892 if (bits % 8 != 0) {
5893 return PSA_ERROR_INVALID_ARGUMENT;
5894 }
5895 data = mbedtls_calloc(1, bytes);
5896 if (data == NULL) {
5897 return PSA_ERROR_INSUFFICIENT_MEMORY;
5898 }
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01005899
Gilles Peskine449bd832023-01-11 14:50:10 +01005900 status = psa_key_derivation_output_bytes(operation, data, bytes);
5901 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01005902 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005903 }
David Brown12ca5032021-02-11 11:02:00 -07005904#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01005905 if (slot->attr.type == PSA_KEY_TYPE_DES) {
5906 psa_des_set_key_parity(data, bytes);
5907 }
Przemek Stekielf110dc02022-03-01 14:48:05 +01005908#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES) */
Gilles Peskine449bd832023-01-11 14:50:10 +01005909 } else {
5910 return PSA_ERROR_NOT_SUPPORTED;
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01005911 }
Ronald Crondd04d422020-11-28 15:14:42 +01005912
Ronald Cronbf33c932020-11-28 18:06:53 +01005913 slot->attr.bits = (psa_key_bits_t) bits;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01005914 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01005915 .core = slot->attr
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01005916 };
5917
Gilles Peskine449bd832023-01-11 14:50:10 +01005918 if (psa_key_lifetime_is_external(attributes.core.lifetime)) {
5919 status = psa_driver_wrapper_get_key_buffer_size(&attributes,
5920 &storage_size);
5921 if (status != PSA_SUCCESS) {
Archanad8a83dc2021-06-14 10:04:16 +05305922 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005923 }
Archanad8a83dc2021-06-14 10:04:16 +05305924 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005925 status = psa_allocate_buffer_to_slot(slot, storage_size);
5926 if (status != PSA_SUCCESS) {
Archanad8a83dc2021-06-14 10:04:16 +05305927 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005928 }
Archanad8a83dc2021-06-14 10:04:16 +05305929
Gilles Peskine449bd832023-01-11 14:50:10 +01005930 status = psa_driver_wrapper_import_key(&attributes,
5931 data, bytes,
5932 slot->key.data,
5933 slot->key.bytes,
5934 &slot->key.bytes, &bits);
5935 if (bits != slot->attr.bits) {
Ronald Cronbf33c932020-11-28 18:06:53 +01005936 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine449bd832023-01-11 14:50:10 +01005937 }
Gilles Peskineeab56e42018-07-12 17:12:33 +02005938
5939exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005940 mbedtls_free(data);
5941 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005942}
5943
Gilles Peskine449bd832023-01-11 14:50:10 +01005944psa_status_t psa_key_derivation_output_key(const psa_key_attributes_t *attributes,
5945 psa_key_derivation_operation_t *operation,
5946 mbedtls_svc_key_id_t *key)
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005947{
5948 psa_status_t status;
5949 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02005950 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine0f84d622019-09-12 19:03:13 +02005951
Ronald Cron81709fc2020-11-14 12:10:32 +01005952 *key = MBEDTLS_SVC_KEY_ID_INIT;
5953
Gilles Peskine0f84d622019-09-12 19:03:13 +02005954 /* Reject any attempt to create a zero-length key so that we don't
5955 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005956 if (psa_get_key_bits(attributes) == 0) {
5957 return PSA_ERROR_INVALID_ARGUMENT;
5958 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02005959
Gilles Peskine449bd832023-01-11 14:50:10 +01005960 if (operation->alg == PSA_ALG_NONE) {
5961 return PSA_ERROR_BAD_STATE;
5962 }
Dave Rodgmand69da6c2021-11-16 10:32:48 +00005963
Gilles Peskine449bd832023-01-11 14:50:10 +01005964 if (!operation->can_output_key) {
5965 return PSA_ERROR_NOT_PERMITTED;
5966 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02005967
Gilles Peskine449bd832023-01-11 14:50:10 +01005968 status = psa_start_key_creation(PSA_KEY_CREATION_DERIVE, attributes,
5969 &slot, &driver);
Gilles Peskinef4ee6622019-07-24 13:44:30 +02005970#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005971 if (driver != NULL) {
Gilles Peskinef4ee6622019-07-24 13:44:30 +02005972 /* Deriving a key in a secure element is not implemented yet. */
5973 status = PSA_ERROR_NOT_SUPPORTED;
5974 }
5975#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine449bd832023-01-11 14:50:10 +01005976 if (status == PSA_SUCCESS) {
5977 status = psa_generate_derived_key_internal(slot,
5978 attributes->core.bits,
5979 operation);
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005980 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005981 if (status == PSA_SUCCESS) {
5982 status = psa_finish_key_creation(slot, driver, key);
5983 }
5984 if (status != PSA_SUCCESS) {
5985 psa_fail_key_creation(slot, driver);
5986 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02005987
Gilles Peskine449bd832023-01-11 14:50:10 +01005988 return status;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005989}
5990
Gilles Peskineeab56e42018-07-12 17:12:33 +02005991
5992
5993/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02005994/* Key derivation */
5995/****************************************************************/
5996
Steven Cooreman932ffb72021-02-15 12:14:32 +01005997#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01005998static int is_kdf_alg_supported(psa_algorithm_t kdf_alg)
Gilles Peskine9efde4f2021-04-29 21:10:00 +02005999{
6000#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006001 if (PSA_ALG_IS_HKDF(kdf_alg)) {
6002 return 1;
6003 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006004#endif
Przemek Stekielb57a44b2022-06-06 08:33:45 +02006005#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006006 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6007 return 1;
6008 }
Przemek Stekielb57a44b2022-06-06 08:33:45 +02006009#endif
6010#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006011 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
6012 return 1;
6013 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006014#endif
6015#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006016 if (PSA_ALG_IS_TLS12_PRF(kdf_alg)) {
6017 return 1;
6018 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006019#endif
6020#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006021 if (PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
6022 return 1;
6023 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006024#endif
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006025#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006026 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
6027 return 1;
6028 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006029#endif
Kusumit Ghoderaod132cac2023-05-03 12:00:27 +05306030#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
6031 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
6032 return 1;
6033 }
6034#endif
Kusumit Ghoderao2cd64962023-06-22 15:38:57 +05306035#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128)
6036 if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
6037 return 1;
6038 }
6039#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006040 return 0;
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006041}
6042
Gilles Peskine449bd832023-01-11 14:50:10 +01006043static psa_status_t psa_hash_try_support(psa_algorithm_t alg)
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006044{
6045 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01006046 psa_status_t status = psa_hash_setup(&operation, alg);
6047 psa_hash_abort(&operation);
6048 return status;
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006049}
6050
Gilles Peskine969c5d62019-01-16 15:53:06 +01006051static psa_status_t psa_key_derivation_setup_kdf(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006052 psa_key_derivation_operation_t *operation,
Gilles Peskine449bd832023-01-11 14:50:10 +01006053 psa_algorithm_t kdf_alg)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006054{
Janos Follath5fe19732019-06-20 15:09:30 +01006055 /* Make sure that operation->ctx is properly zero-initialised. (Macro
6056 * initialisers for this union leave some bytes unspecified.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01006057 memset(&operation->ctx, 0, sizeof(operation->ctx));
Janos Follath5fe19732019-06-20 15:09:30 +01006058
Gilles Peskine969c5d62019-01-16 15:53:06 +01006059 /* Make sure that kdf_alg is a supported key derivation algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006060 if (!is_kdf_alg_supported(kdf_alg)) {
6061 return PSA_ERROR_NOT_SUPPORTED;
6062 }
John Durkop07cc04a2020-11-16 22:08:34 -08006063
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006064 /* All currently supported key derivation algorithms (apart from
Kusumit Ghoderao2cd64962023-06-22 15:38:57 +05306065 * ecjpake to pms and pbkdf2_aes_cmac_128) are based on a hash algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006066 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
6067 size_t hash_size = PSA_HASH_LENGTH(hash_alg);
Kusumit Ghoderao2cd64962023-06-22 15:38:57 +05306068 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
6069 hash_size = PSA_HASH_LENGTH(PSA_ALG_SHA_256);
6070 } else if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306071 hash_size = PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC);
Kusumit Ghoderao2cd64962023-06-22 15:38:57 +05306072 } else {
Gilles Peskine449bd832023-01-11 14:50:10 +01006073 if (hash_size == 0) {
6074 return PSA_ERROR_NOT_SUPPORTED;
6075 }
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006076
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006077 /* Make sure that hash_alg is a supported hash algorithm. Otherwise
6078 * we might fail later, which is somewhat unfriendly and potentially
6079 * risk-prone. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006080 psa_status_t status = psa_hash_try_support(hash_alg);
6081 if (status != PSA_SUCCESS) {
6082 return status;
6083 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006084 }
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006085
Gilles Peskine449bd832023-01-11 14:50:10 +01006086 if ((PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
6087 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) &&
6088 !(hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384)) {
6089 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006090 }
Andrzej Kurek77638292022-09-16 12:24:52 -04006091#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT) || \
Andrzej Kurekb510cd22022-09-26 10:50:22 -04006092 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006093 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg) ||
6094 (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS)) {
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006095 operation->capacity = hash_size;
Gilles Peskine449bd832023-01-11 14:50:10 +01006096 } else
Andrzej Kurekb510cd22022-09-26 10:50:22 -04006097#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT ||
6098 MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Gilles Peskine449bd832023-01-11 14:50:10 +01006099 operation->capacity = 255 * hash_size;
6100 return PSA_SUCCESS;
Gilles Peskine969c5d62019-01-16 15:53:06 +01006101}
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006102
Gilles Peskine449bd832023-01-11 14:50:10 +01006103static psa_status_t psa_key_agreement_try_support(psa_algorithm_t alg)
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006104{
6105#if defined(PSA_WANT_ALG_ECDH)
Gilles Peskine449bd832023-01-11 14:50:10 +01006106 if (alg == PSA_ALG_ECDH) {
6107 return PSA_SUCCESS;
6108 }
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006109#endif
Przemek Stekielfb3dd542022-12-01 14:59:15 +01006110#if defined(PSA_WANT_ALG_FFDH)
6111 if (alg == PSA_ALG_FFDH) {
6112 return PSA_SUCCESS;
6113 }
6114#endif
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006115 (void) alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01006116 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006117}
Gilles Peskinebb3814c2022-12-16 01:12:12 +01006118
6119static int psa_key_derivation_allows_free_form_secret_input(
6120 psa_algorithm_t kdf_alg)
6121{
6122#if defined(PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS)
6123 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
6124 return 0;
6125 }
6126#endif
6127 (void) kdf_alg;
6128 return 1;
6129}
John Durkop07cc04a2020-11-16 22:08:34 -08006130#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01006131
Gilles Peskine449bd832023-01-11 14:50:10 +01006132psa_status_t psa_key_derivation_setup(psa_key_derivation_operation_t *operation,
6133 psa_algorithm_t alg)
Gilles Peskine969c5d62019-01-16 15:53:06 +01006134{
6135 psa_status_t status;
6136
Gilles Peskine449bd832023-01-11 14:50:10 +01006137 if (operation->alg != 0) {
6138 return PSA_ERROR_BAD_STATE;
Gilles Peskine969c5d62019-01-16 15:53:06 +01006139 }
Gilles Peskine969c5d62019-01-16 15:53:06 +01006140
Gilles Peskine449bd832023-01-11 14:50:10 +01006141 if (PSA_ALG_IS_RAW_KEY_AGREEMENT(alg)) {
6142 return PSA_ERROR_INVALID_ARGUMENT;
6143 } else if (PSA_ALG_IS_KEY_AGREEMENT(alg)) {
6144#if defined(AT_LEAST_ONE_BUILTIN_KDF)
6145 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF(alg);
6146 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE(alg);
6147 status = psa_key_agreement_try_support(ka_alg);
6148 if (status != PSA_SUCCESS) {
6149 return status;
6150 }
Gilles Peskinebb3814c2022-12-16 01:12:12 +01006151 if (!psa_key_derivation_allows_free_form_secret_input(kdf_alg)) {
6152 return PSA_ERROR_INVALID_ARGUMENT;
6153 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006154 status = psa_key_derivation_setup_kdf(operation, kdf_alg);
6155#else
6156 return PSA_ERROR_NOT_SUPPORTED;
6157#endif /* AT_LEAST_ONE_BUILTIN_KDF */
6158 } else if (PSA_ALG_IS_KEY_DERIVATION(alg)) {
6159#if defined(AT_LEAST_ONE_BUILTIN_KDF)
6160 status = psa_key_derivation_setup_kdf(operation, alg);
6161#else
6162 return PSA_ERROR_NOT_SUPPORTED;
6163#endif /* AT_LEAST_ONE_BUILTIN_KDF */
6164 } else {
6165 return PSA_ERROR_INVALID_ARGUMENT;
6166 }
6167
6168 if (status == PSA_SUCCESS) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006169 operation->alg = alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01006170 }
6171 return status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006172}
6173
Przemek Stekiel69c46792022-06-10 12:59:51 +02006174#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006175static psa_status_t psa_hkdf_input(psa_hkdf_key_derivation_t *hkdf,
6176 psa_algorithm_t kdf_alg,
6177 psa_key_derivation_step_t step,
6178 const uint8_t *data,
6179 size_t data_length)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006180{
Gilles Peskine449bd832023-01-11 14:50:10 +01006181 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006182 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006183 switch (step) {
Gilles Peskine03410b52019-05-16 16:05:19 +02006184 case PSA_KEY_DERIVATION_INPUT_SALT:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006185#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006186 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
6187 return PSA_ERROR_INVALID_ARGUMENT;
6188 }
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006189#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND */
Gilles Peskine449bd832023-01-11 14:50:10 +01006190 if (hkdf->state != HKDF_STATE_INIT) {
6191 return PSA_ERROR_BAD_STATE;
6192 } else {
6193 status = psa_key_derivation_start_hmac(&hkdf->hmac,
6194 hash_alg,
6195 data, data_length);
6196 if (status != PSA_SUCCESS) {
6197 return status;
6198 }
Steven Cooremand1ed1d92021-04-29 19:11:25 +02006199 hkdf->state = HKDF_STATE_STARTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01006200 return PSA_SUCCESS;
Steven Cooremand1ed1d92021-04-29 19:11:25 +02006201 }
Gilles Peskine03410b52019-05-16 16:05:19 +02006202 case PSA_KEY_DERIVATION_INPUT_SECRET:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006203#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006204 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
Przemek Stekiel2fb0dcd2022-05-19 10:34:37 +02006205 /* We shouldn't be in different state as HKDF_EXPAND only allows
6206 * two inputs: SECRET (this case) and INFO which does not modify
6207 * the state. It could happen only if the hkdf
6208 * object was corrupted. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006209 if (hkdf->state != HKDF_STATE_INIT) {
6210 return PSA_ERROR_BAD_STATE;
6211 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006212
Przemek Stekiel2fb0dcd2022-05-19 10:34:37 +02006213 /* Allow only input that fits expected prk size */
Gilles Peskine449bd832023-01-11 14:50:10 +01006214 if (data_length != PSA_HASH_LENGTH(hash_alg)) {
6215 return PSA_ERROR_INVALID_ARGUMENT;
6216 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006217
Gilles Peskine449bd832023-01-11 14:50:10 +01006218 memcpy(hkdf->prk, data, data_length);
6219 } else
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006220#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND */
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006221 {
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006222 /* HKDF: If no salt was provided, use an empty salt.
6223 * HKDF-EXTRACT: salt is mandatory. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006224 if (hkdf->state == HKDF_STATE_INIT) {
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006225#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006226 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6227 return PSA_ERROR_BAD_STATE;
6228 }
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006229#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01006230 status = psa_key_derivation_start_hmac(&hkdf->hmac,
6231 hash_alg,
6232 NULL, 0);
6233 if (status != PSA_SUCCESS) {
6234 return status;
6235 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006236 hkdf->state = HKDF_STATE_STARTED;
6237 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006238 if (hkdf->state != HKDF_STATE_STARTED) {
6239 return PSA_ERROR_BAD_STATE;
6240 }
6241 status = psa_mac_update(&hkdf->hmac,
6242 data, data_length);
6243 if (status != PSA_SUCCESS) {
6244 return status;
6245 }
6246 status = psa_mac_sign_finish(&hkdf->hmac,
6247 hkdf->prk,
6248 sizeof(hkdf->prk),
6249 &data_length);
6250 if (status != PSA_SUCCESS) {
6251 return status;
6252 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006253 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006254
Gilles Peskine2b522db2019-04-12 15:11:49 +02006255 hkdf->state = HKDF_STATE_KEYED;
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006256 hkdf->block_number = 0;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006257#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006258 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006259 /* The only block of output is the PRK. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006260 memcpy(hkdf->output_block, hkdf->prk, PSA_HASH_LENGTH(hash_alg));
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006261 hkdf->offset_in_block = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01006262 } else
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006263#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006264 {
6265 /* Block 0 is empty, and the next block will be
6266 * generated by psa_key_derivation_hkdf_read(). */
Gilles Peskine449bd832023-01-11 14:50:10 +01006267 hkdf->offset_in_block = PSA_HASH_LENGTH(hash_alg);
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006268 }
6269
Gilles Peskine449bd832023-01-11 14:50:10 +01006270 return PSA_SUCCESS;
Gilles Peskine03410b52019-05-16 16:05:19 +02006271 case PSA_KEY_DERIVATION_INPUT_INFO:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006272#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006273 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6274 return PSA_ERROR_INVALID_ARGUMENT;
6275 }
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006276#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Przemek Stekielcde3f782022-06-03 16:12:27 +02006277#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006278 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg) &&
6279 hkdf->state == HKDF_STATE_INIT) {
6280 return PSA_ERROR_BAD_STATE;
6281 }
Przemek Stekielcde3f782022-06-03 16:12:27 +02006282#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01006283 if (hkdf->state == HKDF_STATE_OUTPUT) {
6284 return PSA_ERROR_BAD_STATE;
6285 }
6286 if (hkdf->info_set) {
6287 return PSA_ERROR_BAD_STATE;
6288 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006289 hkdf->info_length = data_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01006290 if (data_length != 0) {
6291 hkdf->info = mbedtls_calloc(1, data_length);
6292 if (hkdf->info == NULL) {
6293 return PSA_ERROR_INSUFFICIENT_MEMORY;
6294 }
6295 memcpy(hkdf->info, data, data_length);
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006296 }
6297 hkdf->info_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01006298 return PSA_SUCCESS;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006299 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006300 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006301 }
6302}
Przemek Stekiel69c46792022-06-10 12:59:51 +02006303#endif /* BUILTIN_ALG_ANY_HKDF */
Janos Follathb03233e2019-06-11 15:30:30 +01006304
John Durkop07cc04a2020-11-16 22:08:34 -08006305#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
6306 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006307static psa_status_t psa_tls12_prf_set_seed(psa_tls12_prf_key_derivation_t *prf,
6308 const uint8_t *data,
6309 size_t data_length)
Janos Follathf08e2652019-06-13 09:05:41 +01006310{
Gilles Peskine449bd832023-01-11 14:50:10 +01006311 if (prf->state != PSA_TLS12_PRF_STATE_INIT) {
6312 return PSA_ERROR_BAD_STATE;
6313 }
Janos Follathf08e2652019-06-13 09:05:41 +01006314
Gilles Peskine449bd832023-01-11 14:50:10 +01006315 if (data_length != 0) {
6316 prf->seed = mbedtls_calloc(1, data_length);
6317 if (prf->seed == NULL) {
6318 return PSA_ERROR_INSUFFICIENT_MEMORY;
6319 }
Janos Follathf08e2652019-06-13 09:05:41 +01006320
Gilles Peskine449bd832023-01-11 14:50:10 +01006321 memcpy(prf->seed, data, data_length);
Janos Follathd6dce9f2019-07-04 09:11:38 +01006322 prf->seed_length = data_length;
6323 }
Janos Follathf08e2652019-06-13 09:05:41 +01006324
Gilles Peskine43f958b2020-12-13 14:55:14 +01006325 prf->state = PSA_TLS12_PRF_STATE_SEED_SET;
Janos Follathf08e2652019-06-13 09:05:41 +01006326
Gilles Peskine449bd832023-01-11 14:50:10 +01006327 return PSA_SUCCESS;
Janos Follathf08e2652019-06-13 09:05:41 +01006328}
6329
Gilles Peskine449bd832023-01-11 14:50:10 +01006330static psa_status_t psa_tls12_prf_set_key(psa_tls12_prf_key_derivation_t *prf,
6331 const uint8_t *data,
6332 size_t data_length)
Janos Follath81550542019-06-13 14:26:34 +01006333{
Gilles Peskine449bd832023-01-11 14:50:10 +01006334 if (prf->state != PSA_TLS12_PRF_STATE_SEED_SET &&
6335 prf->state != PSA_TLS12_PRF_STATE_OTHER_KEY_SET) {
6336 return PSA_ERROR_BAD_STATE;
6337 }
Janos Follath81550542019-06-13 14:26:34 +01006338
Gilles Peskine449bd832023-01-11 14:50:10 +01006339 if (data_length != 0) {
6340 prf->secret = mbedtls_calloc(1, data_length);
6341 if (prf->secret == NULL) {
6342 return PSA_ERROR_INSUFFICIENT_MEMORY;
6343 }
Steven Cooremana6df6042021-04-29 19:32:25 +02006344
Gilles Peskine449bd832023-01-11 14:50:10 +01006345 memcpy(prf->secret, data, data_length);
Steven Cooremana6df6042021-04-29 19:32:25 +02006346 prf->secret_length = data_length;
6347 }
Janos Follath81550542019-06-13 14:26:34 +01006348
Gilles Peskine43f958b2020-12-13 14:55:14 +01006349 prf->state = PSA_TLS12_PRF_STATE_KEY_SET;
Janos Follath81550542019-06-13 14:26:34 +01006350
Gilles Peskine449bd832023-01-11 14:50:10 +01006351 return PSA_SUCCESS;
Janos Follath81550542019-06-13 14:26:34 +01006352}
6353
Gilles Peskine449bd832023-01-11 14:50:10 +01006354static psa_status_t psa_tls12_prf_set_label(psa_tls12_prf_key_derivation_t *prf,
6355 const uint8_t *data,
6356 size_t data_length)
Janos Follath63028dd2019-06-13 09:15:47 +01006357{
Gilles Peskine449bd832023-01-11 14:50:10 +01006358 if (prf->state != PSA_TLS12_PRF_STATE_KEY_SET) {
6359 return PSA_ERROR_BAD_STATE;
6360 }
Janos Follath63028dd2019-06-13 09:15:47 +01006361
Gilles Peskine449bd832023-01-11 14:50:10 +01006362 if (data_length != 0) {
6363 prf->label = mbedtls_calloc(1, data_length);
6364 if (prf->label == NULL) {
6365 return PSA_ERROR_INSUFFICIENT_MEMORY;
6366 }
Janos Follath63028dd2019-06-13 09:15:47 +01006367
Gilles Peskine449bd832023-01-11 14:50:10 +01006368 memcpy(prf->label, data, data_length);
Janos Follathd6dce9f2019-07-04 09:11:38 +01006369 prf->label_length = data_length;
6370 }
Janos Follath63028dd2019-06-13 09:15:47 +01006371
Gilles Peskine43f958b2020-12-13 14:55:14 +01006372 prf->state = PSA_TLS12_PRF_STATE_LABEL_SET;
Janos Follath63028dd2019-06-13 09:15:47 +01006373
Gilles Peskine449bd832023-01-11 14:50:10 +01006374 return PSA_SUCCESS;
Janos Follath63028dd2019-06-13 09:15:47 +01006375}
6376
Gilles Peskine449bd832023-01-11 14:50:10 +01006377static psa_status_t psa_tls12_prf_input(psa_tls12_prf_key_derivation_t *prf,
6378 psa_key_derivation_step_t step,
6379 const uint8_t *data,
6380 size_t data_length)
Janos Follathb03233e2019-06-11 15:30:30 +01006381{
Gilles Peskine449bd832023-01-11 14:50:10 +01006382 switch (step) {
Janos Follathf08e2652019-06-13 09:05:41 +01006383 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskine449bd832023-01-11 14:50:10 +01006384 return psa_tls12_prf_set_seed(prf, data, data_length);
Janos Follath81550542019-06-13 14:26:34 +01006385 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006386 return psa_tls12_prf_set_key(prf, data, data_length);
Janos Follath63028dd2019-06-13 09:15:47 +01006387 case PSA_KEY_DERIVATION_INPUT_LABEL:
Gilles Peskine449bd832023-01-11 14:50:10 +01006388 return psa_tls12_prf_set_label(prf, data, data_length);
Janos Follathb03233e2019-06-11 15:30:30 +01006389 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006390 return PSA_ERROR_INVALID_ARGUMENT;
Janos Follathb03233e2019-06-11 15:30:30 +01006391 }
6392}
John Durkop07cc04a2020-11-16 22:08:34 -08006393#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
6394 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
6395
6396#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
6397static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
6398 psa_tls12_prf_key_derivation_t *prf,
John Durkop07cc04a2020-11-16 22:08:34 -08006399 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006400 size_t data_length)
John Durkop07cc04a2020-11-16 22:08:34 -08006401{
6402 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006403 const size_t pms_len = (prf->state == PSA_TLS12_PRF_STATE_OTHER_KEY_SET ?
6404 4 + data_length + prf->other_secret_length :
6405 4 + 2 * data_length);
John Durkop07cc04a2020-11-16 22:08:34 -08006406
Gilles Peskine449bd832023-01-11 14:50:10 +01006407 if (data_length > PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE) {
6408 return PSA_ERROR_INVALID_ARGUMENT;
6409 }
John Durkop07cc04a2020-11-16 22:08:34 -08006410
Gilles Peskine449bd832023-01-11 14:50:10 +01006411 uint8_t *pms = mbedtls_calloc(1, pms_len);
6412 if (pms == NULL) {
6413 return PSA_ERROR_INSUFFICIENT_MEMORY;
6414 }
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02006415 uint8_t *cur = pms;
6416
6417 /* pure-PSK:
6418 * Quoting RFC 4279, Section 2:
John Durkop07cc04a2020-11-16 22:08:34 -08006419 *
6420 * The premaster secret is formed as follows: if the PSK is N octets
6421 * long, concatenate a uint16 with the value N, N zero octets, a second
6422 * uint16 with the value N, and the PSK itself.
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02006423 *
6424 * mixed-PSK:
6425 * In a DHE-PSK, RSA-PSK, ECDHE-PSK the premaster secret is formed as
6426 * follows: concatenate a uint16 with the length of the other secret,
6427 * the other secret itself, uint16 with the length of PSK, and the
6428 * PSK itself.
6429 * For details please check:
6430 * - RFC 4279, Section 4 for the definition of RSA-PSK,
6431 * - RFC 4279, Section 3 for the definition of DHE-PSK,
6432 * - RFC 5489 for the definition of ECDHE-PSK.
John Durkop07cc04a2020-11-16 22:08:34 -08006433 */
6434
Gilles Peskine449bd832023-01-11 14:50:10 +01006435 if (prf->state == PSA_TLS12_PRF_STATE_OTHER_KEY_SET) {
6436 *cur++ = MBEDTLS_BYTE_1(prf->other_secret_length);
6437 *cur++ = MBEDTLS_BYTE_0(prf->other_secret_length);
6438 if (prf->other_secret_length != 0) {
6439 memcpy(cur, prf->other_secret, prf->other_secret_length);
6440 mbedtls_platform_zeroize(prf->other_secret, prf->other_secret_length);
Przemek Stekiel2503f7e2022-04-12 12:08:01 +02006441 cur += prf->other_secret_length;
6442 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006443 } else {
6444 *cur++ = MBEDTLS_BYTE_1(data_length);
6445 *cur++ = MBEDTLS_BYTE_0(data_length);
6446 memset(cur, 0, data_length);
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02006447 cur += data_length;
6448 }
6449
Gilles Peskine449bd832023-01-11 14:50:10 +01006450 *cur++ = MBEDTLS_BYTE_1(data_length);
6451 *cur++ = MBEDTLS_BYTE_0(data_length);
6452 memcpy(cur, data, data_length);
John Durkop07cc04a2020-11-16 22:08:34 -08006453 cur += data_length;
6454
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00006455 status = psa_tls12_prf_set_key(prf, pms, (size_t) (cur - pms));
John Durkop07cc04a2020-11-16 22:08:34 -08006456
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01006457 mbedtls_zeroize_and_free(pms, pms_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01006458 return status;
John Durkop07cc04a2020-11-16 22:08:34 -08006459}
Janos Follath6660f0e2019-06-17 08:44:03 +01006460
Przemek Stekiele47201b2022-04-19 13:53:28 +02006461static psa_status_t psa_tls12_prf_psk_to_ms_set_other_key(
6462 psa_tls12_prf_key_derivation_t *prf,
6463 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006464 size_t data_length)
Przemek Stekiele47201b2022-04-19 13:53:28 +02006465{
Gilles Peskine449bd832023-01-11 14:50:10 +01006466 if (prf->state != PSA_TLS12_PRF_STATE_SEED_SET) {
6467 return PSA_ERROR_BAD_STATE;
Przemek Stekiele47201b2022-04-19 13:53:28 +02006468 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006469
6470 if (data_length != 0) {
6471 prf->other_secret = mbedtls_calloc(1, data_length);
6472 if (prf->other_secret == NULL) {
6473 return PSA_ERROR_INSUFFICIENT_MEMORY;
6474 }
6475
6476 memcpy(prf->other_secret, data, data_length);
6477 prf->other_secret_length = data_length;
6478 } else {
Przemek Stekiele47201b2022-04-19 13:53:28 +02006479 prf->other_secret_length = 0;
6480 }
6481
6482 prf->state = PSA_TLS12_PRF_STATE_OTHER_KEY_SET;
6483
Gilles Peskine449bd832023-01-11 14:50:10 +01006484 return PSA_SUCCESS;
Przemek Stekiele47201b2022-04-19 13:53:28 +02006485}
6486
Janos Follath6660f0e2019-06-17 08:44:03 +01006487static psa_status_t psa_tls12_prf_psk_to_ms_input(
6488 psa_tls12_prf_key_derivation_t *prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01006489 psa_key_derivation_step_t step,
6490 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006491 size_t data_length)
Janos Follath6660f0e2019-06-17 08:44:03 +01006492{
Gilles Peskine449bd832023-01-11 14:50:10 +01006493 switch (step) {
Przemek Stekiele47201b2022-04-19 13:53:28 +02006494 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006495 return psa_tls12_prf_psk_to_ms_set_key(prf,
6496 data, data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02006497 break;
6498 case PSA_KEY_DERIVATION_INPUT_OTHER_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006499 return psa_tls12_prf_psk_to_ms_set_other_key(prf,
6500 data,
6501 data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02006502 break;
6503 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006504 return psa_tls12_prf_input(prf, step, data, data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02006505 break;
Janos Follath6660f0e2019-06-17 08:44:03 +01006506
Przemek Stekiele47201b2022-04-19 13:53:28 +02006507 }
Janos Follath6660f0e2019-06-17 08:44:03 +01006508}
John Durkop07cc04a2020-11-16 22:08:34 -08006509#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006510
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006511#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
6512static psa_status_t psa_tls12_ecjpake_to_pms_input(
6513 psa_tls12_ecjpake_to_pms_t *ecjpake,
Andrzej Kurek702776f2022-09-16 06:22:44 -04006514 psa_key_derivation_step_t step,
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006515 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006516 size_t data_length)
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006517{
Gilles Peskine449bd832023-01-11 14:50:10 +01006518 if (data_length != PSA_TLS12_ECJPAKE_TO_PMS_INPUT_SIZE ||
6519 step != PSA_KEY_DERIVATION_INPUT_SECRET) {
6520 return PSA_ERROR_INVALID_ARGUMENT;
Andrzej Kurek5603efd2022-09-26 10:49:16 -04006521 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006522
6523 /* Check if the passed point is in an uncompressed form */
Gilles Peskine449bd832023-01-11 14:50:10 +01006524 if (data[0] != 0x04) {
6525 return PSA_ERROR_INVALID_ARGUMENT;
6526 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006527
6528 /* Only K.X has to be extracted - bytes 1 to 32 inclusive. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006529 memcpy(ecjpake->data, data + 1, PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE);
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006530
Gilles Peskine449bd832023-01-11 14:50:10 +01006531 return PSA_SUCCESS;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006532}
6533#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306534
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306535#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306536static psa_status_t psa_pbkdf2_set_input_cost(
6537 psa_pbkdf2_key_derivation_t *pbkdf2,
6538 psa_key_derivation_step_t step,
6539 uint64_t data)
6540{
6541 if (step != PSA_KEY_DERIVATION_INPUT_COST) {
6542 return PSA_ERROR_INVALID_ARGUMENT;
6543 }
6544
6545 if (pbkdf2->state != PSA_PBKDF2_STATE_INIT) {
6546 return PSA_ERROR_BAD_STATE;
6547 }
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05306548
Kusumit Ghoderaoe66a8ad2023-05-24 12:30:43 +05306549 if (data > PSA_VENDOR_PBKDF2_MAX_ITERATIONS) {
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05306550 return PSA_ERROR_NOT_SUPPORTED;
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306551 }
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05306552
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306553 if (data == 0) {
6554 return PSA_ERROR_INVALID_ARGUMENT;
6555 }
Kusumit Ghoderaoe66a8ad2023-05-24 12:30:43 +05306556
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306557 pbkdf2->input_cost = data;
6558 pbkdf2->state = PSA_PBKDF2_STATE_INPUT_COST_SET;
6559
6560 return PSA_SUCCESS;
6561}
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306562
6563static psa_status_t psa_pbkdf2_set_salt(psa_pbkdf2_key_derivation_t *pbkdf2,
6564 const uint8_t *data,
6565 size_t data_length)
6566{
Gilles Peskineead17662023-08-20 22:02:51 +02006567 if (pbkdf2->state == PSA_PBKDF2_STATE_INPUT_COST_SET) {
6568 pbkdf2->state = PSA_PBKDF2_STATE_SALT_SET;
6569 } else if (pbkdf2->state == PSA_PBKDF2_STATE_SALT_SET) {
6570 /* Appending to existing salt. No state change. */
6571 } else {
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306572 return PSA_ERROR_BAD_STATE;
6573 }
6574
Gilles Peskineca57d782023-07-20 19:08:06 +02006575 if (data_length == 0) {
Gilles Peskineead17662023-08-20 22:02:51 +02006576 /* Appending an empty string, nothing to do. */
6577 } else {
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306578 uint8_t *next_salt;
Kusumit Ghoderaob538bb72023-05-24 12:32:14 +05306579
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306580 next_salt = mbedtls_calloc(1, data_length + pbkdf2->salt_length);
6581 if (next_salt == NULL) {
Kusumit Ghoderaod0422f32023-05-08 15:56:19 +05306582 return PSA_ERROR_INSUFFICIENT_MEMORY;
6583 }
6584
Gilles Peskineead17662023-08-20 22:02:51 +02006585 if (pbkdf2->salt_length != 0) {
6586 memcpy(next_salt, pbkdf2->salt, pbkdf2->salt_length);
6587 }
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306588 memcpy(next_salt + pbkdf2->salt_length, data, data_length);
Kusumit Ghoderaod0422f32023-05-08 15:56:19 +05306589 pbkdf2->salt_length += data_length;
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306590 mbedtls_free(pbkdf2->salt);
6591 pbkdf2->salt = next_salt;
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306592 }
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306593 return PSA_SUCCESS;
6594}
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306595
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05306596#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306597static psa_status_t psa_pbkdf2_hmac_set_password(psa_algorithm_t hash_alg,
Kusumit Ghoderaoaac9a582023-05-24 14:19:17 +05306598 const uint8_t *input,
6599 size_t input_len,
6600 uint8_t *output,
Kusumit Ghoderao91f99f52023-05-24 22:21:48 +05306601 size_t *output_len)
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306602{
6603 psa_status_t status = PSA_SUCCESS;
6604 if (input_len > PSA_HASH_BLOCK_LENGTH(hash_alg)) {
6605 status = psa_hash_compute(hash_alg, input, input_len, output,
Kusumit Ghoderao91f99f52023-05-24 22:21:48 +05306606 PSA_HMAC_MAX_HASH_BLOCK_SIZE, output_len);
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306607 } else {
6608 memcpy(output, input, input_len);
Kusumit Ghoderao91f99f52023-05-24 22:21:48 +05306609 *output_len = PSA_HASH_BLOCK_LENGTH(hash_alg);
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306610 }
6611 return status;
6612}
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05306613#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC */
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306614
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05306615#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128)
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306616static psa_status_t psa_pbkdf2_cmac_set_password(const uint8_t *input,
6617 size_t input_len,
6618 uint8_t *output,
6619 size_t *output_len)
6620{
6621 psa_status_t status = PSA_SUCCESS;
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306622 if (input_len != PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC)) {
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306623 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Kusumit Ghoderao3fde8fe2023-06-27 10:41:43 +05306624 uint8_t zeros[16] = { 0 };
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306625 psa_set_key_type(&attributes, PSA_KEY_TYPE_AES);
6626 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(sizeof(zeros)));
6627 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306628 /* Passing PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC) as
Kusumit Ghoderao5f3345a2023-07-27 21:21:38 +05306629 * mac_size as the driver function sets mac_output_length = mac_size
6630 * on success. See https://github.com/Mbed-TLS/mbedtls/issues/7801 */
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306631 status = psa_driver_wrapper_mac_compute(&attributes,
6632 zeros, sizeof(zeros),
6633 PSA_ALG_CMAC, input, input_len,
6634 output,
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306635 PSA_MAC_LENGTH(PSA_KEY_TYPE_AES,
6636 128U,
6637 PSA_ALG_CMAC),
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306638 output_len);
6639 } else {
6640 memcpy(output, input, input_len);
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306641 *output_len = PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC);
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306642 }
6643 return status;
6644}
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05306645#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128 */
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306646
6647static psa_status_t psa_pbkdf2_set_password(psa_pbkdf2_key_derivation_t *pbkdf2,
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306648 psa_algorithm_t kdf_alg,
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306649 const uint8_t *data,
6650 size_t data_length)
6651{
Kusumit Ghoderaoaac9a582023-05-24 14:19:17 +05306652 psa_status_t status = PSA_SUCCESS;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306653 if (pbkdf2->state != PSA_PBKDF2_STATE_SALT_SET) {
6654 return PSA_ERROR_BAD_STATE;
6655 }
6656
Kusumit Ghoderaof3e696d2023-07-28 13:30:50 +05306657#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306658 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
6659 psa_algorithm_t hash_alg = PSA_ALG_PBKDF2_HMAC_GET_HASH(kdf_alg);
6660 status = psa_pbkdf2_hmac_set_password(hash_alg, data, data_length,
6661 pbkdf2->password,
6662 &pbkdf2->password_length);
Kusumit Ghoderaof3e696d2023-07-28 13:30:50 +05306663 } else
6664#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC */
6665#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128)
6666 if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306667 status = psa_pbkdf2_cmac_set_password(data, data_length,
6668 pbkdf2->password,
6669 &pbkdf2->password_length);
Kusumit Ghoderaof3e696d2023-07-28 13:30:50 +05306670 } else
6671#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128 */
6672 {
6673 return PSA_ERROR_INVALID_ARGUMENT;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306674 }
6675
6676 pbkdf2->state = PSA_PBKDF2_STATE_PASSWORD_SET;
6677
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306678 return status;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306679}
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05306680
6681static psa_status_t psa_pbkdf2_input(psa_pbkdf2_key_derivation_t *pbkdf2,
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306682 psa_algorithm_t kdf_alg,
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05306683 psa_key_derivation_step_t step,
6684 const uint8_t *data,
6685 size_t data_length)
6686{
6687 switch (step) {
6688 case PSA_KEY_DERIVATION_INPUT_SALT:
6689 return psa_pbkdf2_set_salt(pbkdf2, data, data_length);
6690 case PSA_KEY_DERIVATION_INPUT_PASSWORD:
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306691 return psa_pbkdf2_set_password(pbkdf2, kdf_alg, data, data_length);
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05306692 default:
6693 return PSA_ERROR_INVALID_ARGUMENT;
6694 }
6695}
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306696#endif /* PSA_HAVE_SOFT_PBKDF2 */
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306697
Gilles Peskineb8965192019-09-24 16:21:10 +02006698/** Check whether the given key type is acceptable for the given
6699 * input step of a key derivation.
6700 *
6701 * Secret inputs must have the type #PSA_KEY_TYPE_DERIVE.
6702 * Non-secret inputs must have the type #PSA_KEY_TYPE_RAW_DATA.
6703 * Both secret and non-secret inputs can alternatively have the type
6704 * #PSA_KEY_TYPE_NONE, which is never the type of a key object, meaning
6705 * that the input was passed as a buffer rather than via a key object.
6706 */
Gilles Peskine224b0d62019-09-23 18:13:17 +02006707static int psa_key_derivation_check_input_type(
6708 psa_key_derivation_step_t step,
Gilles Peskine449bd832023-01-11 14:50:10 +01006709 psa_key_type_t key_type)
Gilles Peskine224b0d62019-09-23 18:13:17 +02006710{
Gilles Peskine449bd832023-01-11 14:50:10 +01006711 switch (step) {
Gilles Peskine224b0d62019-09-23 18:13:17 +02006712 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006713 if (key_type == PSA_KEY_TYPE_DERIVE) {
6714 return PSA_SUCCESS;
6715 }
6716 if (key_type == PSA_KEY_TYPE_NONE) {
6717 return PSA_SUCCESS;
6718 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02006719 break;
Przemek Stekiela7695a22022-04-07 15:39:01 +02006720 case PSA_KEY_DERIVATION_INPUT_OTHER_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006721 if (key_type == PSA_KEY_TYPE_DERIVE) {
6722 return PSA_SUCCESS;
6723 }
6724 if (key_type == PSA_KEY_TYPE_NONE) {
6725 return PSA_SUCCESS;
6726 }
Przemek Stekiela7695a22022-04-07 15:39:01 +02006727 break;
Gilles Peskine224b0d62019-09-23 18:13:17 +02006728 case PSA_KEY_DERIVATION_INPUT_LABEL:
6729 case PSA_KEY_DERIVATION_INPUT_SALT:
6730 case PSA_KEY_DERIVATION_INPUT_INFO:
6731 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskine449bd832023-01-11 14:50:10 +01006732 if (key_type == PSA_KEY_TYPE_RAW_DATA) {
6733 return PSA_SUCCESS;
6734 }
6735 if (key_type == PSA_KEY_TYPE_NONE) {
6736 return PSA_SUCCESS;
6737 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02006738 break;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306739 case PSA_KEY_DERIVATION_INPUT_PASSWORD:
6740 if (key_type == PSA_KEY_TYPE_PASSWORD) {
6741 return PSA_SUCCESS;
6742 }
6743 if (key_type == PSA_KEY_TYPE_DERIVE) {
6744 return PSA_SUCCESS;
6745 }
6746 if (key_type == PSA_KEY_TYPE_NONE) {
6747 return PSA_SUCCESS;
6748 }
6749 break;
Gilles Peskine224b0d62019-09-23 18:13:17 +02006750 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006751 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine224b0d62019-09-23 18:13:17 +02006752}
6753
Janos Follathb80a94e2019-06-12 15:54:46 +01006754static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006755 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01006756 psa_key_derivation_step_t step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02006757 psa_key_type_t key_type,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01006758 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006759 size_t data_length)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006760{
Gilles Peskine46d7faf2019-09-23 19:22:55 +02006761 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006762 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
Gilles Peskine46d7faf2019-09-23 19:22:55 +02006763
Gilles Peskine449bd832023-01-11 14:50:10 +01006764 status = psa_key_derivation_check_input_type(step, key_type);
6765 if (status != PSA_SUCCESS) {
Gilles Peskine224b0d62019-09-23 18:13:17 +02006766 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006767 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02006768
Przemek Stekiel69c46792022-06-10 12:59:51 +02006769#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006770 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
6771 status = psa_hkdf_input(&operation->ctx.hkdf, kdf_alg,
6772 step, data, data_length);
6773 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02006774#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08006775#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006776 if (PSA_ALG_IS_TLS12_PRF(kdf_alg)) {
6777 status = psa_tls12_prf_input(&operation->ctx.tls12_prf,
6778 step, data, data_length);
6779 } else
John Durkop07cc04a2020-11-16 22:08:34 -08006780#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF */
6781#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006782 if (PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
6783 status = psa_tls12_prf_psk_to_ms_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_PSK_TO_MS */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006787#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006788 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006789 status = psa_tls12_ecjpake_to_pms_input(
Gilles Peskine449bd832023-01-11 14:50:10 +01006790 &operation->ctx.tls12_ecjpake_to_pms, step, data, data_length);
6791 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006792#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306793#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05306794 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306795 status = psa_pbkdf2_input(&operation->ctx.pbkdf2, kdf_alg,
6796 step, data, data_length);
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05306797 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306798#endif /* PSA_HAVE_SOFT_PBKDF2 */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006799 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006800 /* This can't happen unless the operation object was not initialized */
Steven Cooreman74afe472021-02-10 17:19:22 +01006801 (void) data;
6802 (void) data_length;
6803 (void) kdf_alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01006804 return PSA_ERROR_BAD_STATE;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006805 }
6806
Gilles Peskine224b0d62019-09-23 18:13:17 +02006807exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01006808 if (status != PSA_SUCCESS) {
6809 psa_key_derivation_abort(operation);
6810 }
6811 return status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006812}
6813
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05306814static psa_status_t psa_key_derivation_input_integer_internal(
6815 psa_key_derivation_operation_t *operation,
6816 psa_key_derivation_step_t step,
6817 uint64_t value)
6818{
6819 psa_status_t status;
6820 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
6821
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306822#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05306823 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306824 status = psa_pbkdf2_set_input_cost(
6825 &operation->ctx.pbkdf2, step, value);
6826 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306827#endif /* PSA_HAVE_SOFT_PBKDF2 */
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05306828 {
Kusumit Ghoderao3a18dee2023-04-07 16:16:27 +05306829 (void) step;
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05306830 (void) value;
6831 (void) kdf_alg;
Kusumit Ghoderaoa14ae5a2023-04-19 14:16:26 +05306832 status = PSA_ERROR_INVALID_ARGUMENT;
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05306833 }
6834
6835 if (status != PSA_SUCCESS) {
6836 psa_key_derivation_abort(operation);
6837 }
6838 return status;
6839}
6840
Janos Follath51f4a0f2019-06-14 11:35:55 +01006841psa_status_t psa_key_derivation_input_bytes(
6842 psa_key_derivation_operation_t *operation,
6843 psa_key_derivation_step_t step,
6844 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006845 size_t data_length)
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01006846{
Gilles Peskine449bd832023-01-11 14:50:10 +01006847 return psa_key_derivation_input_internal(operation, step,
6848 PSA_KEY_TYPE_NONE,
6849 data, data_length);
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01006850}
6851
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05306852psa_status_t psa_key_derivation_input_integer(
6853 psa_key_derivation_operation_t *operation,
6854 psa_key_derivation_step_t step,
6855 uint64_t value)
6856{
6857 return psa_key_derivation_input_integer_internal(operation, step, value);
6858}
6859
Janos Follath51f4a0f2019-06-14 11:35:55 +01006860psa_status_t psa_key_derivation_input_key(
6861 psa_key_derivation_operation_t *operation,
6862 psa_key_derivation_step_t step,
Gilles Peskine449bd832023-01-11 14:50:10 +01006863 mbedtls_svc_key_id_t key)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006864{
Ronald Cronf95a2b12020-10-22 15:24:49 +02006865 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01006866 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006867 psa_key_slot_t *slot;
Gilles Peskine178c9aa2019-09-24 18:21:06 +02006868
Ronald Cron5c522922020-11-14 16:35:34 +01006869 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01006870 key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg);
6871 if (status != PSA_SUCCESS) {
6872 psa_key_derivation_abort(operation);
6873 return status;
Gilles Peskine593773d2019-09-23 18:17:40 +02006874 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02006875
Kusumit Ghoderao3128c5d2023-05-03 12:27:57 +05306876 /* Passing a key object as a SECRET or PASSWORD input unlocks the
6877 * permission to output to a key object. */
6878 if (step == PSA_KEY_DERIVATION_INPUT_SECRET ||
6879 step == PSA_KEY_DERIVATION_INPUT_PASSWORD) {
Gilles Peskine178c9aa2019-09-24 18:21:06 +02006880 operation->can_output_key = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01006881 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02006882
Gilles Peskine449bd832023-01-11 14:50:10 +01006883 status = psa_key_derivation_input_internal(operation,
6884 step, slot->attr.type,
6885 slot->key.data,
6886 slot->key.bytes);
Ronald Cronf95a2b12020-10-22 15:24:49 +02006887
Gilles Peskine449bd832023-01-11 14:50:10 +01006888 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02006889
Gilles Peskine449bd832023-01-11 14:50:10 +01006890 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006891}
Gilles Peskineea0fb492018-07-12 17:17:20 +02006892
6893
6894
6895/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02006896/* Key agreement */
6897/****************************************************************/
6898
Gilles Peskine449bd832023-01-11 14:50:10 +01006899psa_status_t psa_key_agreement_raw_builtin(const psa_key_attributes_t *attributes,
6900 const uint8_t *key_buffer,
6901 size_t key_buffer_size,
6902 psa_algorithm_t alg,
6903 const uint8_t *peer_key,
6904 size_t peer_key_length,
6905 uint8_t *shared_secret,
6906 size_t shared_secret_size,
6907 size_t *shared_secret_length)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02006908{
Gilles Peskine449bd832023-01-11 14:50:10 +01006909 switch (alg) {
John Durkop6ba40d12020-11-10 08:50:04 -08006910#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskine0216fe12019-04-11 21:23:21 +02006911 case PSA_ALG_ECDH:
Gilles Peskine449bd832023-01-11 14:50:10 +01006912 return mbedtls_psa_key_agreement_ecdh(attributes, key_buffer,
6913 key_buffer_size, alg,
6914 peer_key, peer_key_length,
6915 shared_secret,
6916 shared_secret_size,
6917 shared_secret_length);
Gilles Peskine01d718c2018-09-18 12:01:02 +02006918#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Przemek Stekielfb3dd542022-12-01 14:59:15 +01006919
6920#if defined(MBEDTLS_PSA_BUILTIN_ALG_FFDH)
6921 case PSA_ALG_FFDH:
Przemek Stekiel152bb462023-06-01 11:52:39 +02006922 return mbedtls_psa_ffdh_key_agreement(attributes,
Przemek Stekiel359f4622022-12-05 14:11:55 +01006923 peer_key,
6924 peer_key_length,
6925 key_buffer,
6926 key_buffer_size,
6927 shared_secret,
6928 shared_secret_size,
6929 shared_secret_length);
Przemek Stekielfb3dd542022-12-01 14:59:15 +01006930#endif /* MBEDTLS_PSA_BUILTIN_ALG_FFDH */
6931
Gilles Peskine01d718c2018-09-18 12:01:02 +02006932 default:
Aditya Deshpande17845b82022-10-13 17:21:01 +01006933 (void) attributes;
6934 (void) key_buffer;
6935 (void) key_buffer_size;
Gilles Peskine93f85002018-11-16 16:43:31 +01006936 (void) peer_key;
6937 (void) peer_key_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02006938 (void) shared_secret;
6939 (void) shared_secret_size;
6940 (void) shared_secret_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01006941 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine01d718c2018-09-18 12:01:02 +02006942 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02006943}
Gilles Peskine01d718c2018-09-18 12:01:02 +02006944
Aditya Deshpande17845b82022-10-13 17:21:01 +01006945/** Internal function for raw key agreement
6946 * Calls the driver wrapper which will hand off key agreement task
Aditya Deshpande40c05cc2022-10-14 16:41:40 +01006947 * to the driver's implementation if a driver is present.
6948 * Fallback specified in the driver wrapper is built-in raw key agreement
Aditya Deshpande17845b82022-10-13 17:21:01 +01006949 * (psa_key_agreement_raw_builtin).
6950 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006951static psa_status_t psa_key_agreement_raw_internal(psa_algorithm_t alg,
6952 psa_key_slot_t *private_key,
6953 const uint8_t *peer_key,
6954 size_t peer_key_length,
6955 uint8_t *shared_secret,
6956 size_t shared_secret_size,
6957 size_t *shared_secret_length)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006958{
Gilles Peskine449bd832023-01-11 14:50:10 +01006959 if (!PSA_ALG_IS_RAW_KEY_AGREEMENT(alg)) {
6960 return PSA_ERROR_NOT_SUPPORTED;
6961 }
Aditya Deshpande17845b82022-10-13 17:21:01 +01006962
6963 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01006964 .core = private_key->attr
Aditya Deshpande17845b82022-10-13 17:21:01 +01006965 };
6966
Gilles Peskine449bd832023-01-11 14:50:10 +01006967 return psa_driver_wrapper_key_agreement(&attributes,
6968 private_key->key.data,
6969 private_key->key.bytes, alg,
6970 peer_key, peer_key_length,
6971 shared_secret,
6972 shared_secret_size,
6973 shared_secret_length);
Gilles Peskine0216fe12019-04-11 21:23:21 +02006974}
6975
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02006976/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine01d718c2018-09-18 12:01:02 +02006977 * to potentially free embedded data structures and wipe confidential data.
6978 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006979static psa_status_t psa_key_agreement_internal(psa_key_derivation_operation_t *operation,
6980 psa_key_derivation_step_t step,
6981 psa_key_slot_t *private_key,
6982 const uint8_t *peer_key,
6983 size_t peer_key_length)
Gilles Peskine01d718c2018-09-18 12:01:02 +02006984{
6985 psa_status_t status;
Aditya Deshpande2f7fd762022-11-22 11:10:34 +00006986 uint8_t shared_secret[PSA_RAW_KEY_AGREEMENT_OUTPUT_MAX_SIZE];
Gilles Peskine01d718c2018-09-18 12:01:02 +02006987 size_t shared_secret_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01006988 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE(operation->alg);
Gilles Peskine01d718c2018-09-18 12:01:02 +02006989
6990 /* Step 1: run the secret agreement algorithm to generate the shared
6991 * secret. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006992 status = psa_key_agreement_raw_internal(ka_alg,
6993 private_key,
6994 peer_key, peer_key_length,
6995 shared_secret,
6996 sizeof(shared_secret),
6997 &shared_secret_length);
6998 if (status != PSA_SUCCESS) {
Gilles Peskine12313cd2018-06-20 00:20:32 +02006999 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007000 }
Gilles Peskine12313cd2018-06-20 00:20:32 +02007001
Gilles Peskineb0b255c2018-07-06 17:01:38 +02007002 /* Step 2: set up the key derivation to generate key material from
Gilles Peskine224b0d62019-09-23 18:13:17 +02007003 * the shared secret. A shared secret is permitted wherever a key
7004 * of type DERIVE is permitted. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007005 status = psa_key_derivation_input_internal(operation, step,
7006 PSA_KEY_TYPE_DERIVE,
7007 shared_secret,
7008 shared_secret_length);
Gilles Peskine12313cd2018-06-20 00:20:32 +02007009exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007010 mbedtls_platform_zeroize(shared_secret, shared_secret_length);
7011 return status;
Gilles Peskine12313cd2018-06-20 00:20:32 +02007012}
7013
Gilles Peskine449bd832023-01-11 14:50:10 +01007014psa_status_t psa_key_derivation_key_agreement(psa_key_derivation_operation_t *operation,
7015 psa_key_derivation_step_t step,
7016 mbedtls_svc_key_id_t private_key,
7017 const uint8_t *peer_key,
7018 size_t peer_key_length)
Gilles Peskine12313cd2018-06-20 00:20:32 +02007019{
Ronald Cronf95a2b12020-10-22 15:24:49 +02007020 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01007021 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01007022 psa_key_slot_t *slot;
Ronald Cronf95a2b12020-10-22 15:24:49 +02007023
Gilles Peskine449bd832023-01-11 14:50:10 +01007024 if (!PSA_ALG_IS_KEY_AGREEMENT(operation->alg)) {
7025 return PSA_ERROR_INVALID_ARGUMENT;
7026 }
Ronald Cron5c522922020-11-14 16:35:34 +01007027 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01007028 private_key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg);
7029 if (status != PSA_SUCCESS) {
7030 return status;
7031 }
7032 status = psa_key_agreement_internal(operation, step,
7033 slot,
7034 peer_key, peer_key_length);
7035 if (status != PSA_SUCCESS) {
7036 psa_key_derivation_abort(operation);
7037 } else {
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007038 /* If a private key has been added as SECRET, we allow the derived
7039 * key material to be used as a key in PSA Crypto. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007040 if (step == PSA_KEY_DERIVATION_INPUT_SECRET) {
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007041 operation->can_output_key = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01007042 }
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007043 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007044
Gilles Peskine449bd832023-01-11 14:50:10 +01007045 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007046
Gilles Peskine449bd832023-01-11 14:50:10 +01007047 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskineaf3baab2018-06-27 22:55:52 +02007048}
7049
Gilles Peskine449bd832023-01-11 14:50:10 +01007050psa_status_t psa_raw_key_agreement(psa_algorithm_t alg,
7051 mbedtls_svc_key_id_t private_key,
7052 const uint8_t *peer_key,
7053 size_t peer_key_length,
7054 uint8_t *output,
7055 size_t output_size,
7056 size_t *output_length)
Gilles Peskine0216fe12019-04-11 21:23:21 +02007057{
Ronald Cronf95a2b12020-10-22 15:24:49 +02007058 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01007059 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +02007060 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007061 size_t expected_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02007062
Gilles Peskine449bd832023-01-11 14:50:10 +01007063 if (!PSA_ALG_IS_KEY_AGREEMENT(alg)) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007064 status = PSA_ERROR_INVALID_ARGUMENT;
7065 goto exit;
7066 }
Ronald Cron5c522922020-11-14 16:35:34 +01007067 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01007068 private_key, &slot, PSA_KEY_USAGE_DERIVE, alg);
7069 if (status != PSA_SUCCESS) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007070 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007071 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02007072
Gilles Peskine3e561302022-04-14 00:17:15 +02007073 /* PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() is in general an upper bound
7074 * for the output size. The PSA specification only guarantees that this
7075 * function works if output_size >= PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE(...),
7076 * but it might be nice to allow smaller buffers if the output fits.
7077 * At the time of writing this comment, with only ECDH implemented,
7078 * PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() is exact so the point is moot.
7079 * If FFDH is implemented, PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() can easily
7080 * be exact for it as well. */
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007081 expected_length =
Gilles Peskine449bd832023-01-11 14:50:10 +01007082 PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE(slot->attr.type, slot->attr.bits);
7083 if (output_size < expected_length) {
Gilles Peskine3e561302022-04-14 00:17:15 +02007084 status = PSA_ERROR_BUFFER_TOO_SMALL;
7085 goto exit;
7086 }
7087
Gilles Peskine449bd832023-01-11 14:50:10 +01007088 status = psa_key_agreement_raw_internal(alg, slot,
7089 peer_key, peer_key_length,
7090 output, output_size,
7091 output_length);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007092
7093exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007094 if (status != PSA_SUCCESS) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007095 /* If an error happens and is not handled properly, the output
7096 * may be used as a key to protect sensitive data. Arrange for such
7097 * a key to be random, which is likely to result in decryption or
7098 * verification errors. This is better than filling the buffer with
7099 * some constant data such as zeros, which would result in the data
7100 * being protected with a reproducible, easily knowable key.
7101 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007102 psa_generate_random(output, output_size);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007103 *output_length = output_size;
7104 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007105
Gilles Peskine449bd832023-01-11 14:50:10 +01007106 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007107
Gilles Peskine449bd832023-01-11 14:50:10 +01007108 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine0216fe12019-04-11 21:23:21 +02007109}
Gilles Peskine86a440b2018-11-12 18:39:40 +01007110
7111
Gilles Peskine30524eb2020-11-13 17:02:26 +01007112
Gilles Peskine86a440b2018-11-12 18:39:40 +01007113/****************************************************************/
7114/* Random generation */
Gilles Peskine53d991e2018-07-12 01:14:59 +02007115/****************************************************************/
Gilles Peskine12313cd2018-06-20 00:20:32 +02007116
Gilles Peskine672a7712023-04-28 21:00:28 +02007117#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
7118#include "entropy_poll.h"
7119#endif
7120
Gilles Peskine30524eb2020-11-13 17:02:26 +01007121/** Initialize the PSA random generator.
7122 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007123static void mbedtls_psa_random_init(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01007124{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007125#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine449bd832023-01-11 14:50:10 +01007126 memset(rng, 0, sizeof(*rng));
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007127#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
7128
Gilles Peskine30524eb2020-11-13 17:02:26 +01007129 /* Set default configuration if
7130 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007131 if (rng->entropy_init == NULL) {
Gilles Peskine30524eb2020-11-13 17:02:26 +01007132 rng->entropy_init = mbedtls_entropy_init;
Gilles Peskine449bd832023-01-11 14:50:10 +01007133 }
7134 if (rng->entropy_free == NULL) {
Gilles Peskine30524eb2020-11-13 17:02:26 +01007135 rng->entropy_free = mbedtls_entropy_free;
Gilles Peskine449bd832023-01-11 14:50:10 +01007136 }
Gilles Peskine30524eb2020-11-13 17:02:26 +01007137
Gilles Peskine449bd832023-01-11 14:50:10 +01007138 rng->entropy_init(&rng->entropy);
Gilles Peskine30524eb2020-11-13 17:02:26 +01007139#if defined(MBEDTLS_PSA_INJECT_ENTROPY) && \
7140 defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
7141 /* The PSA entropy injection feature depends on using NV seed as an entropy
7142 * source. Add NV seed as an entropy source for PSA entropy injection. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007143 mbedtls_entropy_add_source(&rng->entropy,
7144 mbedtls_nv_seed_poll, NULL,
7145 MBEDTLS_ENTROPY_BLOCK_SIZE,
7146 MBEDTLS_ENTROPY_SOURCE_STRONG);
Gilles Peskine30524eb2020-11-13 17:02:26 +01007147#endif
7148
Gilles Peskine449bd832023-01-11 14:50:10 +01007149 mbedtls_psa_drbg_init(MBEDTLS_PSA_RANDOM_STATE);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007150#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007151}
7152
7153/** Deinitialize the PSA random generator.
7154 */
Valerio Setti83e0de82023-11-24 12:13:05 +01007155static void mbedtls_psa_random_free(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01007156{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007157#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Valerio Setti83e0de82023-11-24 12:13:05 +01007158 memset(rng, 0, sizeof(*rng));
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007159#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Valerio Setti83e0de82023-11-24 12:13:05 +01007160 mbedtls_psa_drbg_free(MBEDTLS_PSA_RANDOM_STATE);
7161 rng->entropy_free(&rng->entropy);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007162#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007163}
7164
7165/** Seed the PSA random generator.
7166 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007167static psa_status_t mbedtls_psa_random_seed(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01007168{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007169#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
7170 /* Do nothing: the external RNG seeds itself. */
7171 (void) rng;
Gilles Peskine449bd832023-01-11 14:50:10 +01007172 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007173#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007174 const unsigned char drbg_seed[] = "PSA";
Gilles Peskine449bd832023-01-11 14:50:10 +01007175 int ret = mbedtls_psa_drbg_seed(&rng->entropy,
7176 drbg_seed, sizeof(drbg_seed) - 1);
7177 return mbedtls_to_psa_error(ret);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007178#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007179}
7180
Gilles Peskine449bd832023-01-11 14:50:10 +01007181psa_status_t psa_generate_random(uint8_t *output,
7182 size_t output_size)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007183{
Gilles Peskinee59236f2018-01-27 23:32:46 +01007184 GUARD_MODULE_INITIALIZED;
7185
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007186#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
7187
7188 size_t output_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007189 psa_status_t status = mbedtls_psa_external_get_random(&global_data.rng,
7190 output, output_size,
7191 &output_length);
7192 if (status != PSA_SUCCESS) {
7193 return status;
7194 }
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007195 /* Breaking up a request into smaller chunks is currently not supported
Tom Cosgrove1797b052022-12-04 17:19:59 +00007196 * for the external RNG interface. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007197 if (output_length != output_size) {
7198 return PSA_ERROR_INSUFFICIENT_ENTROPY;
7199 }
7200 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007201
7202#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
7203
Gilles Peskine449bd832023-01-11 14:50:10 +01007204 while (output_size > 0) {
Gilles Peskine71ddab92021-01-04 21:01:07 +01007205 size_t request_size =
Gilles Peskine449bd832023-01-11 14:50:10 +01007206 (output_size > MBEDTLS_PSA_RANDOM_MAX_REQUEST ?
7207 MBEDTLS_PSA_RANDOM_MAX_REQUEST :
7208 output_size);
7209 int ret = mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE,
7210 output, request_size);
7211 if (ret != 0) {
7212 return mbedtls_to_psa_error(ret);
7213 }
Gilles Peskine71ddab92021-01-04 21:01:07 +01007214 output_size -= request_size;
7215 output += request_size;
Gilles Peskinef181eca2019-08-07 13:49:00 +02007216 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007217 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007218#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskinee59236f2018-01-27 23:32:46 +01007219}
7220
Gilles Peskine8814fc42020-12-14 15:33:44 +01007221/* Wrapper function allowing the classic API to use the PSA RNG.
Gilles Peskine9c3e0602021-01-05 16:03:55 +01007222 *
7223 * `mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE, ...)` calls
7224 * `psa_generate_random(...)`. The state parameter is ignored since the
7225 * PSA API doesn't support passing an explicit state.
7226 *
7227 * In the non-external case, psa_generate_random() calls an
7228 * `mbedtls_xxx_drbg_random` function which has exactly the same signature
7229 * and semantics as mbedtls_psa_get_random(). As an optimization,
7230 * instead of doing this back-and-forth between the PSA API and the
7231 * classic API, psa_crypto_random_impl.h defines `mbedtls_psa_get_random`
7232 * as a constant function pointer to `mbedtls_xxx_drbg_random`.
Gilles Peskine8814fc42020-12-14 15:33:44 +01007233 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007234#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
7235int mbedtls_psa_get_random(void *p_rng,
7236 unsigned char *output,
7237 size_t output_size)
Gilles Peskine8814fc42020-12-14 15:33:44 +01007238{
Gilles Peskine9c3e0602021-01-05 16:03:55 +01007239 /* This function takes a pointer to the RNG state because that's what
7240 * classic mbedtls functions using an RNG expect. The PSA RNG manages
7241 * its own state internally and doesn't let the caller access that state.
7242 * So we just ignore the state parameter, and in practice we'll pass
7243 * NULL. */
Gilles Peskine8814fc42020-12-14 15:33:44 +01007244 (void) p_rng;
Gilles Peskine449bd832023-01-11 14:50:10 +01007245 psa_status_t status = psa_generate_random(output, output_size);
7246 if (status == PSA_SUCCESS) {
7247 return 0;
7248 } else {
7249 return MBEDTLS_ERR_ENTROPY_SOURCE_FAILED;
7250 }
Gilles Peskine8814fc42020-12-14 15:33:44 +01007251}
7252#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
7253
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01007254#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
Gilles Peskine449bd832023-01-11 14:50:10 +01007255psa_status_t mbedtls_psa_inject_entropy(const uint8_t *seed,
7256 size_t seed_size)
Netanel Gonen2bcd3122018-11-19 11:53:02 +02007257{
Gilles Peskine449bd832023-01-11 14:50:10 +01007258 if (global_data.initialized) {
7259 return PSA_ERROR_NOT_PERMITTED;
7260 }
Netanel Gonen21f37cb2018-11-19 11:53:55 +02007261
Gilles Peskine449bd832023-01-11 14:50:10 +01007262 if (((seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM) ||
7263 (seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE)) ||
7264 (seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE)) {
7265 return PSA_ERROR_INVALID_ARGUMENT;
7266 }
Netanel Gonen21f37cb2018-11-19 11:53:55 +02007267
Gilles Peskine449bd832023-01-11 14:50:10 +01007268 return mbedtls_psa_storage_inject_entropy(seed, seed_size);
Netanel Gonen2bcd3122018-11-19 11:53:02 +02007269}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01007270#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02007271
Ronald Cron3772afe2021-02-08 16:10:05 +01007272/** Validate the key type and size for key generation
Ronald Cron01b2aba2020-10-05 09:42:02 +02007273 *
Ronald Cron3772afe2021-02-08 16:10:05 +01007274 * \param type The key type
7275 * \param bits The number of bits of the key
Ronald Cron01b2aba2020-10-05 09:42:02 +02007276 *
7277 * \retval #PSA_SUCCESS
Ronald Cron3772afe2021-02-08 16:10:05 +01007278 * The key type and size are valid.
Ronald Cron01b2aba2020-10-05 09:42:02 +02007279 * \retval #PSA_ERROR_INVALID_ARGUMENT
7280 * The size in bits of the key is not valid.
7281 * \retval #PSA_ERROR_NOT_SUPPORTED
7282 * The type and/or the size in bits of the key or the combination of
7283 * the two is not supported.
7284 */
Ronald Cron3772afe2021-02-08 16:10:05 +01007285static psa_status_t psa_validate_key_type_and_size_for_key_generation(
Gilles Peskine449bd832023-01-11 14:50:10 +01007286 psa_key_type_t type, size_t bits)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007287{
Ronald Cronf3bb7612020-10-02 20:11:59 +02007288 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007289
Gilles Peskine449bd832023-01-11 14:50:10 +01007290 if (key_type_is_raw_bytes(type)) {
7291 status = psa_validate_unstructured_key_bit_size(type, bits);
7292 if (status != PSA_SUCCESS) {
7293 return status;
7294 }
7295 } else
Valerio Settif6d4dfb2023-07-10 10:55:12 +02007296#if defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007297 if (PSA_KEY_TYPE_IS_RSA(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
7298 if (bits > PSA_VENDOR_RSA_MAX_KEY_BITS) {
7299 return PSA_ERROR_NOT_SUPPORTED;
7300 }
Waleed Elmelegyd7bdbbe2023-07-20 16:26:58 +00007301 if (bits < PSA_VENDOR_RSA_GENERATE_MIN_KEY_BITS) {
Waleed Elmelegyab570712023-07-05 16:40:58 +00007302 return PSA_ERROR_NOT_SUPPORTED;
7303 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +02007304
Ronald Cron01b2aba2020-10-05 09:42:02 +02007305 /* Accept only byte-aligned keys, for the same reasons as
7306 * in psa_import_rsa_key(). */
Gilles Peskine449bd832023-01-11 14:50:10 +01007307 if (bits % 8 != 0) {
7308 return PSA_ERROR_NOT_SUPPORTED;
7309 }
7310 } else
Valerio Settif6d4dfb2023-07-10 10:55:12 +02007311#endif /* defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02007312
Valerio Setti6a9d0ee2023-06-21 10:07:21 +02007313#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007314 if (PSA_KEY_TYPE_IS_ECC(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
Ronald Crond81ab562021-02-16 09:01:16 +01007315 /* To avoid empty block, return successfully here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007316 return PSA_SUCCESS;
7317 } else
Valerio Setti6a9d0ee2023-06-21 10:07:21 +02007318#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_GENERATE) */
Przemek Stekielfedd1342022-12-01 15:00:02 +01007319
Valerio Settia55f0422023-07-10 15:34:41 +02007320#if defined(PSA_WANT_KEY_TYPE_DH_KEY_PAIR_GENERATE)
Przemek Stekielfedd1342022-12-01 15:00:02 +01007321 if (PSA_KEY_TYPE_IS_DH(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
Przemek Stekield1cf1ba2023-04-27 12:04:21 +02007322 if (psa_is_dh_key_size_valid(bits) == 0) {
Przemek Stekielfedd1342022-12-01 15:00:02 +01007323 return PSA_ERROR_NOT_SUPPORTED;
7324 }
7325 } else
Valerio Settia55f0422023-07-10 15:34:41 +02007326#endif /* defined(PSA_WANT_KEY_TYPE_DH_KEY_PAIR_GENERATE) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02007327 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007328 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007329 }
7330
Gilles Peskine449bd832023-01-11 14:50:10 +01007331 return PSA_SUCCESS;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007332}
7333
Ronald Cron55ed0592020-10-05 10:30:40 +02007334psa_status_t psa_generate_key_internal(
Ronald Cron2a38a6b2020-10-02 20:02:04 +02007335 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01007336 uint8_t *key_buffer, size_t key_buffer_size, size_t *key_buffer_length)
Ronald Cron01b2aba2020-10-05 09:42:02 +02007337{
7338 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2a38a6b2020-10-02 20:02:04 +02007339 psa_key_type_t type = attributes->core.type;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007340
Gilles Peskine449bd832023-01-11 14:50:10 +01007341 if ((attributes->domain_parameters == NULL) &&
7342 (attributes->domain_parameters_size != 0)) {
7343 return PSA_ERROR_INVALID_ARGUMENT;
7344 }
Ronald Cron01b2aba2020-10-05 09:42:02 +02007345
Gilles Peskine449bd832023-01-11 14:50:10 +01007346 if (key_type_is_raw_bytes(type)) {
7347 status = psa_generate_random(key_buffer, key_buffer_size);
7348 if (status != PSA_SUCCESS) {
7349 return status;
7350 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +02007351
David Brown12ca5032021-02-11 11:02:00 -07007352#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01007353 if (type == PSA_KEY_TYPE_DES) {
7354 psa_des_set_key_parity(key_buffer, key_buffer_size);
7355 }
David Brown8107e312021-02-12 08:08:46 -07007356#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine449bd832023-01-11 14:50:10 +01007357 } else
Gilles Peskinee59236f2018-01-27 23:32:46 +01007358
Valerio Setti76df8c12023-07-11 14:11:28 +02007359#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007360 if (type == PSA_KEY_TYPE_RSA_KEY_PAIR) {
7361 return mbedtls_psa_rsa_generate_key(attributes,
7362 key_buffer,
7363 key_buffer_size,
7364 key_buffer_length);
7365 } else
Valerio Setti76df8c12023-07-11 14:11:28 +02007366#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_GENERATE) */
Gilles Peskinee59236f2018-01-27 23:32:46 +01007367
Valerio Settibfeaf5b2023-06-20 13:27:46 +02007368#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007369 if (PSA_KEY_TYPE_IS_ECC(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
7370 return mbedtls_psa_ecp_generate_key(attributes,
7371 key_buffer,
7372 key_buffer_size,
7373 key_buffer_length);
7374 } else
Valerio Settibfeaf5b2023-06-20 13:27:46 +02007375#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_GENERATE) */
Przemek Stekielfedd1342022-12-01 15:00:02 +01007376
Valerio Settia55f0422023-07-10 15:34:41 +02007377#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_GENERATE)
Przemek Stekielfedd1342022-12-01 15:00:02 +01007378 if (PSA_KEY_TYPE_IS_DH(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
7379 return mbedtls_psa_ffdh_generate_key(attributes,
7380 key_buffer,
7381 key_buffer_size,
7382 key_buffer_length);
7383 } else
Valerio Settia55f0422023-07-10 15:34:41 +02007384#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_GENERATE) */
Steven Cooreman29149862020-08-05 15:43:42 +02007385 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007386 (void) key_buffer_length;
7387 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman29149862020-08-05 15:43:42 +02007388 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01007389
Gilles Peskine449bd832023-01-11 14:50:10 +01007390 return PSA_SUCCESS;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02007391}
Darryl Green0c6575a2018-11-07 16:05:30 +00007392
Gilles Peskine449bd832023-01-11 14:50:10 +01007393psa_status_t psa_generate_key(const psa_key_attributes_t *attributes,
7394 mbedtls_svc_key_id_t *key)
Gilles Peskineff5f0e72019-04-18 12:53:30 +02007395{
7396 psa_status_t status;
7397 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02007398 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cron2b56bc82020-10-05 10:02:26 +02007399 size_t key_buffer_size;
Gilles Peskine11792082019-08-06 18:36:36 +02007400
Ronald Cron81709fc2020-11-14 12:10:32 +01007401 *key = MBEDTLS_SVC_KEY_ID_INIT;
7402
Gilles Peskine0f84d622019-09-12 19:03:13 +02007403 /* Reject any attempt to create a zero-length key so that we don't
7404 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007405 if (psa_get_key_bits(attributes) == 0) {
7406 return PSA_ERROR_INVALID_ARGUMENT;
7407 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02007408
Przemyslaw Stekielc0fe8202021-10-07 11:08:56 +02007409 /* Reject any attempt to create a public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007410 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(attributes->core.type)) {
7411 return PSA_ERROR_INVALID_ARGUMENT;
7412 }
Przemyslaw Stekielc0fe8202021-10-07 11:08:56 +02007413
Gilles Peskine449bd832023-01-11 14:50:10 +01007414 status = psa_start_key_creation(PSA_KEY_CREATION_GENERATE, attributes,
7415 &slot, &driver);
7416 if (status != PSA_SUCCESS) {
Gilles Peskine11792082019-08-06 18:36:36 +02007417 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007418 }
Gilles Peskine11792082019-08-06 18:36:36 +02007419
Ronald Cron977c2472020-10-13 08:32:21 +02007420 /* In the case of a transparent key or an opaque key stored in local
Archana449608b2021-09-08 15:36:05 +05307421 * storage ( thus not in the case of generating a key in a secure element
7422 * with storage ( MBEDTLS_PSA_CRYPTO_SE_C ) ),we have to allocate a
7423 * buffer to hold the generated key material. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007424 if (slot->key.data == NULL) {
7425 if (PSA_KEY_LIFETIME_GET_LOCATION(attributes->core.lifetime) ==
7426 PSA_KEY_LOCATION_LOCAL_STORAGE) {
Ronald Cron3772afe2021-02-08 16:10:05 +01007427 status = psa_validate_key_type_and_size_for_key_generation(
Gilles Peskine449bd832023-01-11 14:50:10 +01007428 attributes->core.type, attributes->core.bits);
7429 if (status != PSA_SUCCESS) {
Ronald Cron3772afe2021-02-08 16:10:05 +01007430 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007431 }
Ronald Cron3772afe2021-02-08 16:10:05 +01007432
7433 key_buffer_size = PSA_EXPORT_KEY_OUTPUT_SIZE(
Gilles Peskine449bd832023-01-11 14:50:10 +01007434 attributes->core.type,
7435 attributes->core.bits);
7436 } else {
Ronald Cron977c2472020-10-13 08:32:21 +02007437 status = psa_driver_wrapper_get_key_buffer_size(
Gilles Peskine449bd832023-01-11 14:50:10 +01007438 attributes, &key_buffer_size);
7439 if (status != PSA_SUCCESS) {
Ronald Cron3772afe2021-02-08 16:10:05 +01007440 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007441 }
Ronald Cron977c2472020-10-13 08:32:21 +02007442 }
Ronald Cron977c2472020-10-13 08:32:21 +02007443
Gilles Peskine449bd832023-01-11 14:50:10 +01007444 status = psa_allocate_buffer_to_slot(slot, key_buffer_size);
7445 if (status != PSA_SUCCESS) {
Ronald Cron977c2472020-10-13 08:32:21 +02007446 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007447 }
Ronald Cron977c2472020-10-13 08:32:21 +02007448 }
7449
Gilles Peskine449bd832023-01-11 14:50:10 +01007450 status = psa_driver_wrapper_generate_key(attributes,
7451 slot->key.data, slot->key.bytes, &slot->key.bytes);
Gilles Peskine11792082019-08-06 18:36:36 +02007452
Gilles Peskine449bd832023-01-11 14:50:10 +01007453 if (status != PSA_SUCCESS) {
7454 psa_remove_key_data_from_memory(slot);
7455 }
Ronald Cron2b56bc82020-10-05 10:02:26 +02007456
Gilles Peskine11792082019-08-06 18:36:36 +02007457exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007458 if (status == PSA_SUCCESS) {
7459 status = psa_finish_key_creation(slot, driver, key);
7460 }
7461 if (status != PSA_SUCCESS) {
7462 psa_fail_key_creation(slot, driver);
7463 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007464
Gilles Peskine449bd832023-01-11 14:50:10 +01007465 return status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007466}
7467
Gilles Peskinee59236f2018-01-27 23:32:46 +01007468/****************************************************************/
7469/* Module setup */
7470/****************************************************************/
7471
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007472#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine5e769522018-11-20 21:59:56 +01007473psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
Gilles Peskine449bd832023-01-11 14:50:10 +01007474 void (* entropy_init)(mbedtls_entropy_context *ctx),
7475 void (* entropy_free)(mbedtls_entropy_context *ctx))
Gilles Peskine5e769522018-11-20 21:59:56 +01007476{
Gilles Peskine449bd832023-01-11 14:50:10 +01007477 if (global_data.rng_state != RNG_NOT_INITIALIZED) {
7478 return PSA_ERROR_BAD_STATE;
7479 }
Gilles Peskine30524eb2020-11-13 17:02:26 +01007480 global_data.rng.entropy_init = entropy_init;
7481 global_data.rng.entropy_free = entropy_free;
Gilles Peskine449bd832023-01-11 14:50:10 +01007482 return PSA_SUCCESS;
Gilles Peskine5e769522018-11-20 21:59:56 +01007483}
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007484#endif /* !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) */
Gilles Peskine5e769522018-11-20 21:59:56 +01007485
Gilles Peskine449bd832023-01-11 14:50:10 +01007486void mbedtls_psa_crypto_free(void)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007487{
Gilles Peskine449bd832023-01-11 14:50:10 +01007488 psa_wipe_all_key_slots();
Valerio Setti83e0de82023-11-24 12:13:05 +01007489 if (global_data.rng_state != RNG_NOT_INITIALIZED) {
7490 mbedtls_psa_random_free(&global_data.rng);
7491 }
Gilles Peskinec6b69072018-11-20 21:42:52 +01007492 /* Wipe all remaining data, including configuration.
7493 * In particular, this sets all state indicator to the value
7494 * indicating "uninitialized". */
Gilles Peskine449bd832023-01-11 14:50:10 +01007495 mbedtls_platform_zeroize(&global_data, sizeof(global_data));
Ronald Cron9ba76912021-04-10 16:57:30 +02007496
7497 /* Terminate drivers */
Gilles Peskine449bd832023-01-11 14:50:10 +01007498 psa_driver_wrapper_free();
Gilles Peskinee59236f2018-01-27 23:32:46 +01007499}
7500
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007501#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
7502/** Recover a transaction that was interrupted by a power failure.
7503 *
7504 * This function is called during initialization, before psa_crypto_init()
7505 * returns. If this function returns a failure status, the initialization
7506 * fails.
7507 */
7508static psa_status_t psa_crypto_recover_transaction(
Gilles Peskine449bd832023-01-11 14:50:10 +01007509 const psa_crypto_transaction_t *transaction)
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007510{
Gilles Peskine449bd832023-01-11 14:50:10 +01007511 switch (transaction->unknown.type) {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007512 case PSA_CRYPTO_TRANSACTION_CREATE_KEY:
7513 case PSA_CRYPTO_TRANSACTION_DESTROY_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01007514 /* TODO - fall through to the failure case until this
7515 * is implemented.
7516 * https://github.com/ARMmbed/mbed-crypto/issues/218
7517 */
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007518 default:
7519 /* We found an unsupported transaction in the storage.
7520 * We don't know what state the storage is in. Give up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007521 return PSA_ERROR_DATA_INVALID;
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007522 }
7523}
7524#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
7525
Gilles Peskine449bd832023-01-11 14:50:10 +01007526psa_status_t psa_crypto_init(void)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007527{
Gilles Peskine66fb1262018-12-10 16:29:04 +01007528 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007529
Gilles Peskinec6b69072018-11-20 21:42:52 +01007530 /* Double initialization is explicitly allowed. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007531 if (global_data.initialized != 0) {
7532 return PSA_SUCCESS;
7533 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01007534
Manuel Pégourié-Gonnard7abdf7e2023-03-09 11:17:43 +01007535 /* Init drivers */
7536 status = psa_driver_wrapper_init();
7537 if (status != PSA_SUCCESS) {
7538 goto exit;
7539 }
7540 global_data.drivers_initialized = 1;
7541
Valerio Setti402cfba2023-11-13 10:24:32 +01007542 status = psa_initialize_key_slots();
7543 if (status != PSA_SUCCESS) {
7544 goto exit;
7545 }
7546
Gilles Peskine30524eb2020-11-13 17:02:26 +01007547 /* Initialize and seed the random generator. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007548 mbedtls_psa_random_init(&global_data.rng);
Gilles Peskinec6b69072018-11-20 21:42:52 +01007549 global_data.rng_state = RNG_INITIALIZED;
Gilles Peskine449bd832023-01-11 14:50:10 +01007550 status = mbedtls_psa_random_seed(&global_data.rng);
7551 if (status != PSA_SUCCESS) {
Gilles Peskinee59236f2018-01-27 23:32:46 +01007552 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007553 }
Gilles Peskinec6b69072018-11-20 21:42:52 +01007554 global_data.rng_state = RNG_SEEDED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007555
Gilles Peskine4b734222019-07-24 15:56:31 +02007556#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007557 status = psa_crypto_load_transaction();
7558 if (status == PSA_SUCCESS) {
7559 status = psa_crypto_recover_transaction(&psa_crypto_transaction);
7560 if (status != PSA_SUCCESS) {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007561 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007562 }
7563 status = psa_crypto_stop_transaction();
7564 } else if (status == PSA_ERROR_DOES_NOT_EXIST) {
Gilles Peskinefc762652019-07-22 19:30:34 +02007565 /* There's no transaction to complete. It's all good. */
7566 status = PSA_SUCCESS;
7567 }
Gilles Peskine4b734222019-07-24 15:56:31 +02007568#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
Gilles Peskinefc762652019-07-22 19:30:34 +02007569
Gilles Peskinec6b69072018-11-20 21:42:52 +01007570 /* All done. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01007571 global_data.initialized = 1;
7572
7573exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007574 if (status != PSA_SUCCESS) {
7575 mbedtls_psa_crypto_free();
7576 }
7577 return status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007578}
7579
Yanray Wangffc3c482023-07-11 12:01:04 +08007580#if defined(PSA_WANT_ALG_SOME_PAKE)
Przemek Stekielca8d2b22023-01-17 16:21:33 +01007581psa_status_t psa_crypto_driver_pake_get_password_len(
7582 const psa_crypto_driver_pake_inputs_t *inputs,
7583 size_t *password_len)
7584{
7585 if (inputs->password_len == 0) {
7586 return PSA_ERROR_BAD_STATE;
7587 }
7588
7589 *password_len = inputs->password_len;
7590
7591 return PSA_SUCCESS;
7592}
7593
7594psa_status_t psa_crypto_driver_pake_get_password(
7595 const psa_crypto_driver_pake_inputs_t *inputs,
7596 uint8_t *buffer, size_t buffer_size, size_t *buffer_length)
7597{
7598 if (inputs->password_len == 0) {
7599 return PSA_ERROR_BAD_STATE;
7600 }
7601
7602 if (buffer_size < inputs->password_len) {
7603 return PSA_ERROR_BUFFER_TOO_SMALL;
7604 }
7605
7606 memcpy(buffer, inputs->password, inputs->password_len);
7607 *buffer_length = inputs->password_len;
7608
7609 return PSA_SUCCESS;
7610}
7611
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007612psa_status_t psa_crypto_driver_pake_get_user_len(
7613 const psa_crypto_driver_pake_inputs_t *inputs,
7614 size_t *user_len)
7615{
7616 if (inputs->user_len == 0) {
7617 return PSA_ERROR_BAD_STATE;
7618 }
7619
7620 *user_len = inputs->user_len;
7621
7622 return PSA_SUCCESS;
7623}
7624
7625psa_status_t psa_crypto_driver_pake_get_user(
7626 const psa_crypto_driver_pake_inputs_t *inputs,
Przemek Stekielc0e62502023-03-14 11:49:36 +01007627 uint8_t *user_id, size_t user_id_size, size_t *user_id_len)
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007628{
7629 if (inputs->user_len == 0) {
7630 return PSA_ERROR_BAD_STATE;
7631 }
7632
Przemek Stekielc0e62502023-03-14 11:49:36 +01007633 if (user_id_size < inputs->user_len) {
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007634 return PSA_ERROR_BUFFER_TOO_SMALL;
7635 }
7636
Przemek Stekielc0e62502023-03-14 11:49:36 +01007637 memcpy(user_id, inputs->user, inputs->user_len);
7638 *user_id_len = inputs->user_len;
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007639
7640 return PSA_SUCCESS;
7641}
7642
7643psa_status_t psa_crypto_driver_pake_get_peer_len(
7644 const psa_crypto_driver_pake_inputs_t *inputs,
7645 size_t *peer_len)
7646{
7647 if (inputs->peer_len == 0) {
7648 return PSA_ERROR_BAD_STATE;
7649 }
7650
7651 *peer_len = inputs->peer_len;
7652
7653 return PSA_SUCCESS;
7654}
7655
7656psa_status_t psa_crypto_driver_pake_get_peer(
7657 const psa_crypto_driver_pake_inputs_t *inputs,
Przemek Stekielc0e62502023-03-14 11:49:36 +01007658 uint8_t *peer_id, size_t peer_id_size, size_t *peer_id_length)
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007659{
7660 if (inputs->peer_len == 0) {
7661 return PSA_ERROR_BAD_STATE;
7662 }
7663
Przemek Stekielc0e62502023-03-14 11:49:36 +01007664 if (peer_id_size < inputs->peer_len) {
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007665 return PSA_ERROR_BUFFER_TOO_SMALL;
7666 }
7667
Przemek Stekielc0e62502023-03-14 11:49:36 +01007668 memcpy(peer_id, inputs->peer, inputs->peer_len);
7669 *peer_id_length = inputs->peer_len;
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007670
7671 return PSA_SUCCESS;
7672}
7673
Przemek Stekielca8d2b22023-01-17 16:21:33 +01007674psa_status_t psa_crypto_driver_pake_get_cipher_suite(
7675 const psa_crypto_driver_pake_inputs_t *inputs,
7676 psa_pake_cipher_suite_t *cipher_suite)
7677{
7678 if (inputs->cipher_suite.algorithm == PSA_ALG_NONE) {
7679 return PSA_ERROR_BAD_STATE;
7680 }
7681
7682 *cipher_suite = inputs->cipher_suite;
7683
7684 return PSA_SUCCESS;
7685}
7686
Neil Armstronga7d08c32022-06-01 18:21:20 +02007687psa_status_t psa_pake_setup(
7688 psa_pake_operation_t *operation,
7689 const psa_pake_cipher_suite_t *cipher_suite)
7690{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007691 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007692
Przemek Stekiel1c3cfb42023-01-26 10:35:02 +01007693 if (operation->stage != PSA_PAKE_OPERATION_STAGE_SETUP) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007694 status = PSA_ERROR_BAD_STATE;
7695 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007696 }
7697
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01007698 if (PSA_ALG_IS_PAKE(cipher_suite->algorithm) == 0 ||
Przemek Stekiel51eac532022-12-07 11:04:51 +01007699 PSA_ALG_IS_HASH(cipher_suite->hash) == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007700 status = PSA_ERROR_INVALID_ARGUMENT;
7701 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007702 }
7703
Przemek Stekiel51eac532022-12-07 11:04:51 +01007704 memset(&operation->data.inputs, 0, sizeof(operation->data.inputs));
7705
Przemek Stekiele12ed362022-12-21 12:54:46 +01007706 operation->alg = cipher_suite->algorithm;
Przemek Stekiel656b2592023-03-22 13:15:33 +01007707 operation->primitive = PSA_PAKE_PRIMITIVE(cipher_suite->type,
7708 cipher_suite->family, cipher_suite->bits);
Przemek Stekiel51eac532022-12-07 11:04:51 +01007709 operation->data.inputs.cipher_suite = *cipher_suite;
7710
Przemek Stekiel4aa99402023-02-27 13:00:57 +01007711#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01007712 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01007713 psa_jpake_computation_stage_t *computation_stage =
Przemek Stekieldde6a912023-01-26 08:46:37 +01007714 &operation->computation_stage.jpake;
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01007715
David Horstmann16f01512023-06-14 17:21:07 +01007716 memset(computation_stage, 0, sizeof(*computation_stage));
David Horstmanne7f21e62023-05-12 18:17:21 +01007717 computation_stage->step = PSA_PAKE_STEP_KEY_SHARE;
Przemek Stekiel80a88492023-02-20 13:32:22 +01007718 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007719#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01007720 {
7721 status = PSA_ERROR_NOT_SUPPORTED;
7722 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01007723 }
7724
Przemek Stekiel1c3cfb42023-01-26 10:35:02 +01007725 operation->stage = PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS;
7726
Przemek Stekiel51eac532022-12-07 11:04:51 +01007727 return PSA_SUCCESS;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007728exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007729 psa_pake_abort(operation);
7730 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02007731}
7732
7733psa_status_t psa_pake_set_password_key(
7734 psa_pake_operation_t *operation,
7735 mbedtls_svc_key_id_t password)
7736{
Neil Armstrong5ae60962022-09-15 11:29:46 +02007737 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel6c764412022-11-22 14:05:12 +01007738 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
7739 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007740 psa_key_attributes_t attributes;
7741 psa_key_type_t type;
Neil Armstrong5ae60962022-09-15 11:29:46 +02007742
Przemek Stekiel51eac532022-12-07 11:04:51 +01007743 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007744 status = PSA_ERROR_BAD_STATE;
7745 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007746 }
7747
Przemek Stekiel6c764412022-11-22 14:05:12 +01007748 status = psa_get_and_lock_key_slot_with_policy(password, &slot,
7749 PSA_KEY_USAGE_DERIVE,
Przemek Stekield5d28a22023-01-26 10:46:05 +01007750 operation->alg);
Neil Armstrong5ae60962022-09-15 11:29:46 +02007751 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007752 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02007753 }
7754
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007755 attributes = (psa_key_attributes_t) {
Przemek Stekiel6c764412022-11-22 14:05:12 +01007756 .core = slot->attr
7757 };
Neil Armstrong5ae60962022-09-15 11:29:46 +02007758
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007759 type = psa_get_key_type(&attributes);
Neil Armstrong5ae60962022-09-15 11:29:46 +02007760
Przemek Stekiel51eac532022-12-07 11:04:51 +01007761 if (type != PSA_KEY_TYPE_PASSWORD &&
7762 type != PSA_KEY_TYPE_PASSWORD_HASH) {
7763 status = PSA_ERROR_INVALID_ARGUMENT;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007764 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007765 }
7766
Przemek Stekiel51eac532022-12-07 11:04:51 +01007767 operation->data.inputs.password = mbedtls_calloc(1, slot->key.bytes);
7768 if (operation->data.inputs.password == NULL) {
Przemek Stekiele12ed362022-12-21 12:54:46 +01007769 status = PSA_ERROR_INSUFFICIENT_MEMORY;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007770 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007771 }
7772
7773 memcpy(operation->data.inputs.password, slot->key.data, slot->key.bytes);
7774 operation->data.inputs.password_len = slot->key.bytes;
Przemek Stekiel9dd24402023-01-26 15:06:09 +01007775 operation->data.inputs.attributes = attributes;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007776exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007777 if (status != PSA_SUCCESS) {
7778 psa_pake_abort(operation);
7779 }
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007780 unlock_status = psa_unlock_key_slot(slot);
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007781 return (status == PSA_SUCCESS) ? unlock_status : status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02007782}
7783
7784psa_status_t psa_pake_set_user(
7785 psa_pake_operation_t *operation,
7786 const uint8_t *user_id,
7787 size_t user_id_len)
7788{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007789 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007790
7791 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007792 status = PSA_ERROR_BAD_STATE;
7793 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02007794 }
7795
Przemek Stekiel51eac532022-12-07 11:04:51 +01007796 if (user_id_len == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007797 status = PSA_ERROR_INVALID_ARGUMENT;
7798 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02007799 }
7800
Przemek Stekielf309d6b2023-03-10 09:54:45 +01007801 if (operation->data.inputs.user_len != 0) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007802 status = PSA_ERROR_BAD_STATE;
7803 goto exit;
7804 }
7805
Przemek Stekielf309d6b2023-03-10 09:54:45 +01007806 operation->data.inputs.user = mbedtls_calloc(1, user_id_len);
7807 if (operation->data.inputs.user == NULL) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007808 status = PSA_ERROR_INSUFFICIENT_MEMORY;
7809 goto exit;
7810 }
7811
Przemek Stekielf309d6b2023-03-10 09:54:45 +01007812 memcpy(operation->data.inputs.user, user_id, user_id_len);
7813 operation->data.inputs.user_len = user_id_len;
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007814
7815 return PSA_SUCCESS;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007816exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007817 psa_pake_abort(operation);
7818 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02007819}
7820
7821psa_status_t psa_pake_set_peer(
7822 psa_pake_operation_t *operation,
7823 const uint8_t *peer_id,
7824 size_t peer_id_len)
7825{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007826 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007827
7828 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007829 status = PSA_ERROR_BAD_STATE;
7830 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02007831 }
7832
Przemek Stekiel51eac532022-12-07 11:04:51 +01007833 if (peer_id_len == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007834 status = PSA_ERROR_INVALID_ARGUMENT;
7835 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02007836 }
7837
Przemek Stekielf309d6b2023-03-10 09:54:45 +01007838 if (operation->data.inputs.peer_len != 0) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007839 status = PSA_ERROR_BAD_STATE;
7840 goto exit;
7841 }
7842
Przemek Stekielf309d6b2023-03-10 09:54:45 +01007843 operation->data.inputs.peer = mbedtls_calloc(1, peer_id_len);
7844 if (operation->data.inputs.peer == NULL) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007845 status = PSA_ERROR_INSUFFICIENT_MEMORY;
7846 goto exit;
7847 }
7848
Przemek Stekielf309d6b2023-03-10 09:54:45 +01007849 memcpy(operation->data.inputs.peer, peer_id, peer_id_len);
7850 operation->data.inputs.peer_len = peer_id_len;
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007851
7852 return PSA_SUCCESS;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007853exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007854 psa_pake_abort(operation);
7855 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02007856}
7857
7858psa_status_t psa_pake_set_role(
7859 psa_pake_operation_t *operation,
7860 psa_pake_role_t role)
7861{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007862 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007863
Przemek Stekiel51eac532022-12-07 11:04:51 +01007864 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007865 status = PSA_ERROR_BAD_STATE;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007866 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007867 }
7868
Przemek Stekiel09104b82023-03-06 14:11:51 +01007869 switch (operation->alg) {
7870#if defined(PSA_WANT_ALG_JPAKE)
7871 case PSA_ALG_JPAKE:
7872 if (role == PSA_PAKE_ROLE_NONE) {
7873 return PSA_SUCCESS;
7874 }
7875 status = PSA_ERROR_INVALID_ARGUMENT;
7876 break;
7877#endif
7878 default:
7879 (void) role;
7880 status = PSA_ERROR_NOT_SUPPORTED;
7881 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02007882 }
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007883exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007884 psa_pake_abort(operation);
7885 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02007886}
7887
David Horstmanne7f21e62023-05-12 18:17:21 +01007888/* Auxiliary function to convert core computation stage to single driver step. */
Przemek Stekiel4aa99402023-02-27 13:00:57 +01007889#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiel251e86a2023-02-17 14:30:50 +01007890static psa_crypto_driver_pake_step_t convert_jpake_computation_stage_to_driver_step(
Przemek Stekieldde6a912023-01-26 08:46:37 +01007891 psa_jpake_computation_stage_t *stage)
Przemek Stekielb09c4872023-01-17 12:05:38 +01007892{
David Horstmann74a3d8c2023-06-14 18:28:19 +01007893 psa_crypto_driver_pake_step_t key_share_step;
David Horstmann5da95602023-06-08 15:37:12 +01007894 if (stage->round == PSA_JPAKE_FIRST) {
David Horstmanne7f21e62023-05-12 18:17:21 +01007895 int is_x1;
David Horstmann74a3d8c2023-06-14 18:28:19 +01007896
David Horstmann024e5c52023-06-14 15:48:21 +01007897 if (stage->io_mode == PSA_JPAKE_OUTPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01007898 is_x1 = (stage->outputs < 1);
7899 } else {
7900 is_x1 = (stage->inputs < 1);
7901 }
7902
David Horstmann74a3d8c2023-06-14 18:28:19 +01007903 key_share_step = is_x1 ?
7904 PSA_JPAKE_X1_STEP_KEY_SHARE :
7905 PSA_JPAKE_X2_STEP_KEY_SHARE;
David Horstmann5da95602023-06-08 15:37:12 +01007906 } else if (stage->round == PSA_JPAKE_SECOND) {
David Horstmann74a3d8c2023-06-14 18:28:19 +01007907 key_share_step = (stage->io_mode == PSA_JPAKE_OUTPUT) ?
7908 PSA_JPAKE_X2S_STEP_KEY_SHARE :
7909 PSA_JPAKE_X4S_STEP_KEY_SHARE;
7910 } else {
7911 return PSA_JPAKE_STEP_INVALID;
Przemek Stekielb09c4872023-01-17 12:05:38 +01007912 }
Agathiyan Bragadeesh387bfa52023-07-17 17:01:33 +01007913 return (psa_crypto_driver_pake_step_t) (key_share_step + stage->step - PSA_PAKE_STEP_KEY_SHARE);
Przemek Stekielb09c4872023-01-17 12:05:38 +01007914}
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007915#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekielb09c4872023-01-17 12:05:38 +01007916
Przemek Stekiel2797d372022-12-22 11:19:22 +01007917static psa_status_t psa_pake_complete_inputs(
7918 psa_pake_operation_t *operation)
7919{
Przemek Stekiel2797d372022-12-22 11:19:22 +01007920 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel18620a32023-01-17 16:34:52 +01007921 /* Create copy of the inputs on stack as inputs share memory
7922 with the driver context which will be setup by the driver. */
7923 psa_crypto_driver_pake_inputs_t inputs = operation->data.inputs;
Przemek Stekiel2797d372022-12-22 11:19:22 +01007924
Przemek Stekielfde11282023-03-13 16:06:09 +01007925 if (inputs.password_len == 0) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01007926 return PSA_ERROR_BAD_STATE;
7927 }
7928
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007929 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekielfde11282023-03-13 16:06:09 +01007930 if (inputs.user_len == 0 || inputs.peer_len == 0) {
7931 return PSA_ERROR_BAD_STATE;
7932 }
Przemek Stekieldff21d32023-02-14 20:09:10 +01007933 }
7934
Przemek Stekiel18620a32023-01-17 16:34:52 +01007935 /* Clear driver context */
7936 mbedtls_platform_zeroize(&operation->data, sizeof(operation->data));
7937
7938 status = psa_driver_wrapper_pake_setup(operation, &inputs);
Przemek Stekiel2797d372022-12-22 11:19:22 +01007939
7940 /* Driver is responsible for creating its own copy of the password. */
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01007941 mbedtls_zeroize_and_free(inputs.password, inputs.password_len);
Przemek Stekiel2797d372022-12-22 11:19:22 +01007942
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007943 /* User and peer are translated to role. */
7944 mbedtls_free(inputs.user);
7945 mbedtls_free(inputs.peer);
7946
Przemek Stekiel2797d372022-12-22 11:19:22 +01007947 if (status == PSA_SUCCESS) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01007948#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiel2797d372022-12-22 11:19:22 +01007949 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekield93de322023-02-24 08:39:04 +01007950 operation->stage = PSA_PAKE_OPERATION_STAGE_COMPUTATION;
Przemek Stekiel80a88492023-02-20 13:32:22 +01007951 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007952#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01007953 {
7954 status = PSA_ERROR_NOT_SUPPORTED;
Przemek Stekiel2797d372022-12-22 11:19:22 +01007955 }
Przemek Stekiel2797d372022-12-22 11:19:22 +01007956 }
Przemek Stekiel2797d372022-12-22 11:19:22 +01007957 return status;
7958}
7959
Przemek Stekiel4aa99402023-02-27 13:00:57 +01007960#if defined(PSA_WANT_ALG_JPAKE)
David Horstmanne7f21e62023-05-12 18:17:21 +01007961static psa_status_t psa_jpake_prologue(
Przemek Stekiele12ed362022-12-21 12:54:46 +01007962 psa_pake_operation_t *operation,
David Horstmanne7f21e62023-05-12 18:17:21 +01007963 psa_pake_step_t step,
David Horstmann00ad6bf2023-06-14 15:44:24 +01007964 psa_jpake_io_mode_t io_mode)
Przemek Stekiele12ed362022-12-21 12:54:46 +01007965{
Przemek Stekiele12ed362022-12-21 12:54:46 +01007966 if (step != PSA_PAKE_STEP_KEY_SHARE &&
7967 step != PSA_PAKE_STEP_ZK_PUBLIC &&
7968 step != PSA_PAKE_STEP_ZK_PROOF) {
7969 return PSA_ERROR_INVALID_ARGUMENT;
7970 }
7971
Przemek Stekiel5eff1032023-02-21 19:10:36 +01007972 psa_jpake_computation_stage_t *computation_stage =
7973 &operation->computation_stage.jpake;
Przemek Stekiele12ed362022-12-21 12:54:46 +01007974
David Horstmann5da95602023-06-08 15:37:12 +01007975 if (computation_stage->round != PSA_JPAKE_FIRST &&
7976 computation_stage->round != PSA_JPAKE_SECOND) {
Przemek Stekiel5eff1032023-02-21 19:10:36 +01007977 return PSA_ERROR_BAD_STATE;
7978 }
7979
David Horstmanne7f21e62023-05-12 18:17:21 +01007980 /* Check that the step we are given is the one we were expecting */
7981 if (step != computation_stage->step) {
Przemek Stekiel5eff1032023-02-21 19:10:36 +01007982 return PSA_ERROR_BAD_STATE;
7983 }
7984
David Horstmanne7f21e62023-05-12 18:17:21 +01007985 if (step == PSA_PAKE_STEP_KEY_SHARE &&
7986 computation_stage->inputs == 0 &&
7987 computation_stage->outputs == 0) {
7988 /* Start of the round, so function decides whether we are inputting
7989 * or outputting */
David Horstmann024e5c52023-06-14 15:48:21 +01007990 computation_stage->io_mode = io_mode;
7991 } else if (computation_stage->io_mode != io_mode) {
David Horstmanne7f21e62023-05-12 18:17:21 +01007992 /* Middle of the round so the mode we are in must match the function
7993 * called by the user */
7994 return PSA_ERROR_BAD_STATE;
Przemek Stekiele12ed362022-12-21 12:54:46 +01007995 }
7996
7997 return PSA_SUCCESS;
7998}
7999
David Horstmanne7f21e62023-05-12 18:17:21 +01008000static psa_status_t psa_jpake_epilogue(
8001 psa_pake_operation_t *operation,
David Horstmann00ad6bf2023-06-14 15:44:24 +01008002 psa_jpake_io_mode_t io_mode)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008003{
David Horstmanne7f21e62023-05-12 18:17:21 +01008004 psa_jpake_computation_stage_t *stage =
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008005 &operation->computation_stage.jpake;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008006
David Horstmanne7f21e62023-05-12 18:17:21 +01008007 if (stage->step == PSA_PAKE_STEP_ZK_PROOF) {
8008 /* End of an input/output */
David Horstmann00ad6bf2023-06-14 15:44:24 +01008009 if (io_mode == PSA_JPAKE_INPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008010 stage->inputs++;
David Horstmann246ec5a2023-06-27 10:33:06 +01008011 if (stage->inputs == PSA_JPAKE_EXPECTED_INPUTS(stage->round)) {
David Horstmann024e5c52023-06-14 15:48:21 +01008012 stage->io_mode = PSA_JPAKE_OUTPUT;
David Horstmanne7f21e62023-05-12 18:17:21 +01008013 }
8014 }
David Horstmann00ad6bf2023-06-14 15:44:24 +01008015 if (io_mode == PSA_JPAKE_OUTPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008016 stage->outputs++;
David Horstmann246ec5a2023-06-27 10:33:06 +01008017 if (stage->outputs == PSA_JPAKE_EXPECTED_OUTPUTS(stage->round)) {
David Horstmann024e5c52023-06-14 15:48:21 +01008018 stage->io_mode = PSA_JPAKE_INPUT;
David Horstmanne7f21e62023-05-12 18:17:21 +01008019 }
8020 }
David Horstmann246ec5a2023-06-27 10:33:06 +01008021 if (stage->inputs == PSA_JPAKE_EXPECTED_INPUTS(stage->round) &&
8022 stage->outputs == PSA_JPAKE_EXPECTED_OUTPUTS(stage->round)) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008023 /* End of a round, move to the next round */
8024 stage->inputs = 0;
8025 stage->outputs = 0;
8026 stage->round++;
8027 }
8028 stage->step = PSA_PAKE_STEP_KEY_SHARE;
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008029 } else {
David Horstmanne7f21e62023-05-12 18:17:21 +01008030 stage->step++;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008031 }
Przemek Stekiele12ed362022-12-21 12:54:46 +01008032 return PSA_SUCCESS;
8033}
David Horstmanne7f21e62023-05-12 18:17:21 +01008034
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008035#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008036
Neil Armstronga7d08c32022-06-01 18:21:20 +02008037psa_status_t psa_pake_output(
8038 psa_pake_operation_t *operation,
8039 psa_pake_step_t step,
8040 uint8_t *output,
8041 size_t output_size,
8042 size_t *output_length)
8043{
Przemek Stekiel51eac532022-12-07 11:04:51 +01008044 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008045 psa_crypto_driver_pake_step_t driver_step = PSA_JPAKE_STEP_INVALID;
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008046 *output_length = 0;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008047
8048 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01008049 status = psa_pake_complete_inputs(operation);
8050 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008051 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008052 }
8053 }
8054
8055 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008056 status = PSA_ERROR_BAD_STATE;
8057 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008058 }
8059
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008060 if (output_size == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008061 status = PSA_ERROR_INVALID_ARGUMENT;
8062 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008063 }
8064
Przemek Stekiele12ed362022-12-21 12:54:46 +01008065 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008066#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008067 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008068 status = psa_jpake_prologue(operation, step, PSA_JPAKE_OUTPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008069 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008070 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008071 }
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008072 driver_step = convert_jpake_computation_stage_to_driver_step(
8073 &operation->computation_stage.jpake);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008074 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008075#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008076 default:
Przemek Stekiel80a88492023-02-20 13:32:22 +01008077 (void) step;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008078 status = PSA_ERROR_NOT_SUPPORTED;
8079 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008080 }
8081
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008082 status = psa_driver_wrapper_pake_output(operation, driver_step,
8083 output, output_size, output_length);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008084
8085 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008086 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008087 }
8088
8089 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008090#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008091 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008092 status = psa_jpake_epilogue(operation, PSA_JPAKE_OUTPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008093 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008094 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008095 }
8096 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008097#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008098 default:
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008099 status = PSA_ERROR_NOT_SUPPORTED;
8100 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008101 }
8102
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008103 return PSA_SUCCESS;
8104exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008105 psa_pake_abort(operation);
8106 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008107}
8108
8109psa_status_t psa_pake_input(
8110 psa_pake_operation_t *operation,
8111 psa_pake_step_t step,
8112 const uint8_t *input,
8113 size_t input_length)
8114{
Przemek Stekiel51eac532022-12-07 11:04:51 +01008115 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008116 psa_crypto_driver_pake_step_t driver_step = PSA_JPAKE_STEP_INVALID;
Przemek Stekiel256c75d2023-03-23 14:09:34 +01008117 const size_t max_input_length = (size_t) PSA_PAKE_INPUT_SIZE(operation->alg,
8118 operation->primitive,
8119 step);
Przemek Stekiel51eac532022-12-07 11:04:51 +01008120
8121 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01008122 status = psa_pake_complete_inputs(operation);
8123 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008124 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008125 }
8126 }
8127
8128 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008129 status = PSA_ERROR_BAD_STATE;
8130 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008131 }
8132
Przemek Stekiel256c75d2023-03-23 14:09:34 +01008133 if (input_length == 0 || input_length > max_input_length) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008134 status = PSA_ERROR_INVALID_ARGUMENT;
8135 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008136 }
8137
Przemek Stekiele12ed362022-12-21 12:54:46 +01008138 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008139#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008140 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008141 status = psa_jpake_prologue(operation, step, PSA_JPAKE_INPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008142 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008143 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008144 }
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008145 driver_step = convert_jpake_computation_stage_to_driver_step(
8146 &operation->computation_stage.jpake);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008147 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008148#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008149 default:
Przemek Stekiel80a88492023-02-20 13:32:22 +01008150 (void) step;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008151 status = PSA_ERROR_NOT_SUPPORTED;
8152 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008153 }
8154
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008155 status = psa_driver_wrapper_pake_input(operation, driver_step,
8156 input, input_length);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008157
8158 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008159 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008160 }
8161
8162 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008163#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008164 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008165 status = psa_jpake_epilogue(operation, PSA_JPAKE_INPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008166 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008167 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008168 }
8169 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008170#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008171 default:
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008172 status = PSA_ERROR_NOT_SUPPORTED;
8173 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008174 }
8175
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008176 return PSA_SUCCESS;
8177exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008178 psa_pake_abort(operation);
8179 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008180}
8181
8182psa_status_t psa_pake_get_implicit_key(
8183 psa_pake_operation_t *operation,
8184 psa_key_derivation_operation_t *output)
8185{
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008186 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008187 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel251e86a2023-02-17 14:30:50 +01008188 uint8_t shared_key[MBEDTLS_PSA_JPAKE_BUFFER_SIZE];
Przemek Stekiel0c781802022-11-29 14:53:13 +01008189 size_t shared_key_len = 0;
8190
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008191 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008192 status = PSA_ERROR_BAD_STATE;
8193 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008194 }
8195
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008196#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008197 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008198 psa_jpake_computation_stage_t *computation_stage =
Przemek Stekiel083745e2023-02-23 17:28:23 +01008199 &operation->computation_stage.jpake;
David Horstmann5da95602023-06-08 15:37:12 +01008200 if (computation_stage->round != PSA_JPAKE_FINISHED) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008201 status = PSA_ERROR_BAD_STATE;
8202 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008203 }
Przemek Stekiel80a88492023-02-20 13:32:22 +01008204 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008205#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01008206 {
8207 status = PSA_ERROR_NOT_SUPPORTED;
8208 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008209 }
8210
Przemek Stekiel0c781802022-11-29 14:53:13 +01008211 status = psa_driver_wrapper_pake_get_implicit_key(operation,
8212 shared_key,
Przemek Stekiel6b648622023-02-19 22:55:33 +01008213 sizeof(shared_key),
Przemek Stekiel0c781802022-11-29 14:53:13 +01008214 &shared_key_len);
8215
8216 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008217 goto exit;
Przemek Stekiel0c781802022-11-29 14:53:13 +01008218 }
8219
8220 status = psa_key_derivation_input_bytes(output,
8221 PSA_KEY_DERIVATION_INPUT_SECRET,
8222 shared_key,
8223 shared_key_len);
8224
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008225 mbedtls_platform_zeroize(shared_key, sizeof(shared_key));
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008226exit:
8227 abort_status = psa_pake_abort(operation);
8228 return status == PSA_SUCCESS ? abort_status : status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008229}
8230
8231psa_status_t psa_pake_abort(
8232 psa_pake_operation_t *operation)
8233{
Przemek Stekield69dca92023-01-31 19:59:20 +01008234 psa_status_t status = PSA_SUCCESS;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008235
Przemek Stekield69dca92023-01-31 19:59:20 +01008236 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008237 status = psa_driver_wrapper_pake_abort(operation);
Neil Armstrong5ae60962022-09-15 11:29:46 +02008238 }
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008239
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008240 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
8241 if (operation->data.inputs.password != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01008242 mbedtls_zeroize_and_free(operation->data.inputs.password,
Przemek Stekielaa183422023-03-06 14:21:44 +01008243 operation->data.inputs.password_len);
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008244 }
8245 if (operation->data.inputs.user != NULL) {
8246 mbedtls_free(operation->data.inputs.user);
8247 }
8248 if (operation->data.inputs.peer != NULL) {
8249 mbedtls_free(operation->data.inputs.peer);
8250 }
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008251 }
Przemek Stekield69dca92023-01-31 19:59:20 +01008252 memset(operation, 0, sizeof(psa_pake_operation_t));
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008253
Przemek Stekield69dca92023-01-31 19:59:20 +01008254 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008255}
Tom Cosgrove6d62fac2023-05-10 14:40:05 +01008256#endif /* PSA_WANT_ALG_SOME_PAKE */
Neil Armstronga7d08c32022-06-01 18:21:20 +02008257
Gilles Peskinee59236f2018-01-27 23:32:46 +01008258#endif /* MBEDTLS_PSA_CRYPTO_C */